Update documentation and typespecs (#6)

Author: jaeyson

.github/workflows/ci.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches: ["main"]
   pull_request:
+    branches: ["main"]
 
 jobs:
   # https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## major.minor.patch (yyyy.mm.dd)
 
+## 0.4.0 (2024.12.17)
+
+### Changed
+
+* Typespecs for each functions
+
 ## 0.3.0 (2024.12.15)
 
 ### Changed

README.md

@@ -21,7 +21,7 @@ by adding `open_api_typesense` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:open_api_typesense, "~> 0.3"}
+    {:open_api_typesense, "~> 0.4"}
 
     # Or from GitHub repository, if you want the latest greatest from main branch
     {:open_api_typesense, git: "https://github.com/jaeyson/open_api_typesense.git"}

lib/open_api_typesense/client.ex

@@ -111,10 +111,18 @@ defmodule OpenApiTypesense.Client do
         query: URI.encode_query(opts[:opts] || [])
       }
 
+    encoded_body =
+      if opts[:request] do
+        [content_type] = opts[:request]
+        parse_content_type(content_type, opts[:body])
+      else
+        Jason.encode_to_iodata!(opts[:body])
+      end
+
     {_req, resp} =
       [
         method: opts[:method] || :get,
-        body: opts[:body],
+        body: encoded_body,
         url: url,
         retry: retry,
         max_retries: max_retries,
@@ -130,6 +138,23 @@ defmodule OpenApiTypesense.Client do
     parse_resp(resp, opts[:response])
   end
 
+  defp parse_content_type({"application/octet-stream", {:string, :generic}}, body) do
+    Enum.map_join(body, "\n", &Jason.encode_to_iodata!/1)
+  end
+
+  defp parse_content_type({"application/json", _}, body) do
+    Jason.encode_to_iodata!(body)
+  end
+
+  # defp parse_content_type({"application/json", {mod, :t}}, body) do
+  #   # Checks if map keys are atom or string
+  #   if Enum.all?(Map.keys(body), &is_atom/1) do
+  #       Jason.encode_to_iodata!(struct(mod, body))
+  #   else
+  #     Jason.encode_to_iodata!(body)
+  #   end
+  # end
+
   defp parse_resp(%Req.TransportError{} = error, _opts_resp) do
     {:error, Exception.message(error)}
   end

lib/open_api_typesense/connection.ex

@@ -43,7 +43,7 @@ defmodule OpenApiTypesense.Connection do
   @doc since: "0.2.0"
   @spec new(connection :: t() | map()) :: %__MODULE__{}
 
-  def new(connection \\ defaults())
+  def new, do: new(defaults())
 
   def new(connection) when is_map(connection) do
     missing_fields = Enum.sort(required_fields() -- Map.keys(connection))