version update

Author: ryansurf

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cli-surf"
-version = "2.3.1"
+version = "2.4.0"
 description = "Command-line surf report tool"
 license = "MIT"
 authors = ["ryansurf <your@email.com>"] # TODO: email

src/gpt.py

@@ -13,7 +13,6 @@
 
 
 class Llm(ABC):
-
     def __init__(self, model):
         self.model = model
         self.client: Any = None
@@ -22,7 +21,9 @@ def call_llm(self, surf_summary, gpt_prompt) -> str | None:
         try:
             response = self.client.chat.completions.create(
                 model=self.model,
-                messages=[{"role": "user", "content": surf_summary + gpt_prompt}],
+                messages=[
+                    {"role": "user", "content": surf_summary + gpt_prompt}
+                ],
             )
             return response.choices[0].message.content
         except Exception as e:

tests/test_gpt.py

@@ -18,51 +18,61 @@ def _make_chat_response(content):
     return response
 
 
-def test_simple_gpt_returns_model_content(mocker):
-    """simple_gpt returns the text content from the g4f response."""
+def test_free_gpt_returns_model_content(mocker):
+    """FreeGpt.call_llm returns the text content from the g4f response."""
     mock_client = Mock()
     mock_client.chat.completions.create.return_value = _make_chat_response(
         "Great surf day!"
     )
     mocker.patch("src.gpt.Client", return_value=mock_client)
 
-    result = gpt.simple_gpt("surf is 4ft", "what board should I ride?")
+    result = gpt.FreeGpt("gpt-3.5-turbo").call_llm(
+        "surf is 4ft", "what board should I ride?"
+    )
 
     assert result == "Great surf day!"
     mock_client.chat.completions.create.assert_called_once()
 
 
-def test_simple_gpt_returns_fallback_on_exception(mocker):
-    """simple_gpt returns the error string when the g4f client raises."""
-    mocker.patch("src.gpt.Client", side_effect=Exception("API down"))
+def test_free_gpt_returns_fallback_on_exception(mocker):
+    """FreeGpt.call_llm returns the error string when the client raises."""
+    mock_client = Mock()
+    mock_client.chat.completions.create.side_effect = Exception("API down")
+    mocker.patch("src.gpt.Client", return_value=mock_client)
 
-    result = gpt.simple_gpt("surf is 4ft", "what board?")
+    result = gpt.FreeGpt("gpt-3.5-turbo").call_llm(
+        "surf is 4ft", "what board?"
+    )
 
     assert result == "Unable to generate GPT response."
 
 
-def test_openai_gpt_returns_model_content(mocker):
-    """openai_gpt returns the text content from the OpenAI response."""
+def test_openai_llm_returns_model_content(mocker):
+    """OpenAILlm.call_llm returns the text content from the OpenAI response."""
     mock_client = Mock()
     mock_client.chat.completions.create.return_value = _make_chat_response(
         "Bring your longboard."
     )
     mocker.patch("src.gpt.OpenAI", return_value=mock_client)
 
-    result = gpt.openai_gpt(
-        "surf is 2ft", "recommend a board", "sk-testkey", "gpt-4"
+    result = gpt.OpenAILlm("sk-testkey", "gpt-4").call_llm(
+        "surf is 2ft", "recommend a board"
     )
 
     assert result == "Bring your longboard."
     mock_client.chat.completions.create.assert_called_once()
 
 
-def test_openai_gpt_returns_fallback_on_exception(mocker):
-    """openai_gpt returns the error string when the OpenAI client raises."""
-    mocker.patch("src.gpt.OpenAI", side_effect=Exception("quota exceeded"))
+def test_openai_llm_returns_fallback_on_exception(mocker):
+    """OpenAILlm.call_llm returns the error string when the client raises."""
+    mock_client = Mock()
+    mock_client.chat.completions.create.side_effect = Exception(
+        "quota exceeded"
+    )
+    mocker.patch("src.gpt.OpenAI", return_value=mock_client)
 
-    result = gpt.openai_gpt(
-        "surf is 2ft", "recommend a board", "sk-key", "gpt-4"
+    result = gpt.OpenAILlm("sk-key", "gpt-4").call_llm(
+        "surf is 2ft", "recommend a board"
     )
 
     assert result == "Unable to generate GPT response."

tests/test_helper.py

@@ -426,19 +426,19 @@ def test_set_location_unpacks_dict():
 
 
 def test_print_gpt_uses_openai_when_key_is_long_enough(mocker):
-    """print_gpt calls openai_gpt when the API key is at least 5 chars."""
+    """print_gpt uses OpenAILlm when the API key is at least 5 chars."""
     surf_data = {
         "Location": "Santa Cruz",
         "Height": "3",
         "Swell Direction": "270",
         "Period": "12",
         "Unit": "ft",
     }
-    mock_openai = mocker.patch(
-        "src.helper.gpt.openai_gpt", return_value="openai response"
-    )
+    mock_llm = mocker.MagicMock()
+    mock_llm.call_llm.return_value = "openai response"
+    mocker.patch("src.helper.gpt.OpenAILlm", return_value=mock_llm)
     result = helper.print_gpt(
         surf_data, "any prompt", ("sk-validkey", "gpt-4")
     )
     assert result == "openai response"
-    mock_openai.assert_called_once()
+    mock_llm.call_llm.assert_called_once()