haz moar test

Author: jaeyson

.github/workflows/ci.yml

@@ -56,6 +56,9 @@ jobs:
       - name: Checkout repo
         uses: actions/checkout@v4
 
+      - name: Check for misspellings
+        uses: codespell-project/actions-codespell@v2
+
       - name: Start Typesense
         run: |
           docker run -d \
@@ -79,6 +82,15 @@ jobs:
           otp-version: ${{matrix.otp}}
           elixir-version: ${{matrix.elixir}}
 
+      - name: Install Dependencies
+        run: |
+          mix local.rebar --if-missing
+          mix local.hex --if-missing
+          mix deps.get
+
+      - name: Compile
+        run: mix compile
+
       - name: Cache dependencies/builds
         uses: actions/cache@v4
         with:
@@ -89,12 +101,6 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-typesense-${{ matrix.typesense}}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-
 
-      - name: Install Dependencies
-        run: |
-          mix local.rebar --if-missing
-          mix local.hex --if-missing
-          mix deps.get
-
       - name: Find unused dependencies
         run: mix deps.unlock --check-unused
         if: ${{ matrix.lint }}

README.md

@@ -1,5 +1,7 @@
 # OpenApiTypesense
 
+Restful client for Typesense with adherence to Open API spec 3 (formerly Swagger)
+
 [![Hex.pm](https://img.shields.io/hexpm/v/open_api_typesense)](https://hex.pm/packages/open_api_typesense)
 [![Hexdocs.pm](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/open_api_typesense)
 [![Hex.pm](https://img.shields.io/hexpm/l/open_api_typesense)](https://hexdocs.pm/open_api_typesense/license.html)
@@ -8,24 +10,6 @@
 
 ## TODO
 - Custom Http client adapter (currently [`Req`](https://hexdocs.pm/req))
-- Tests for each modules not completed yet.
-- Where to consume `opts`:
-```elixir
-  def take_snapshot(conn \\ Connection.new(), opts \\ []) do
-    client = opts[:client] || @default_client
-    query = Keyword.take(opts, [:snapshot_path])
-
-    client.request(conn, %{
-      args: [],
-      call: {OpenApiTypesense.Operations, :take_snapshot},
-      url: "/operations/snapshot",
-      method: :post,
-      query: query,
-      response: [{201, {OpenApiTypesense.SuccessStatus, :t}}],
-      opts: opts # <-- TODO
-    })
-  end
-```
 
 
 ## Installation

lib/open_api_typesense/operations/analytics.ex

@@ -12,14 +12,24 @@ defmodule OpenApiTypesense.Analytics do
 
   Sending events for analytics e.g rank search results based on popularity.
   """
+  @spec create_analytics_event(
+          OpenApiTypesense.AnalyticsEventCreateSchema.t(),
+          keyword
+        ) ::
+          {:ok, OpenApiTypesense.AnalyticsEventCreateResponse.t()}
+          | {:error, OpenApiTypesense.ApiResponse.t()}
+  def create_analytics_event(body, opts \\ []) do
+    create_analytics_event(Connection.new(), body, opts)
+  end
+
   @spec create_analytics_event(
           Connection.t(),
           OpenApiTypesense.AnalyticsEventCreateSchema.t(),
           keyword
         ) ::
           {:ok, OpenApiTypesense.AnalyticsEventCreateResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def create_analytics_event(conn \\ Connection.new(), body, opts \\ []) do
+  def create_analytics_event(conn, body, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -42,10 +52,17 @@ defmodule OpenApiTypesense.Analytics do
 
   When an analytics rule is created, we give it a name and describe the type, the source collections and the destination collection.
   """
+  @spec create_analytics_rule(OpenApiTypesense.AnalyticsRuleSchema.t(), keyword) ::
+          {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
+          | {:error, OpenApiTypesense.ApiResponse.t()}
+  def create_analytics_rule(body, opts \\ []) do
+    create_analytics_rule(Connection.new(), body, opts)
+  end
+
   @spec create_analytics_rule(Connection.t(), OpenApiTypesense.AnalyticsRuleSchema.t(), keyword) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def create_analytics_rule(conn \\ Connection.new(), body, opts \\ []) do
+  def create_analytics_rule(conn, body, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -68,10 +85,17 @@ defmodule OpenApiTypesense.Analytics do
 
   Permanently deletes an analytics rule, given it's name
   """
+  @spec delete_analytics_rule(String.t(), keyword) ::
+          {:ok, OpenApiTypesense.AnalyticsRuleDeleteResponse.t()}
+          | {:error, OpenApiTypesense.ApiResponse.t()}
+  def delete_analytics_rule(ruleName, opts \\ []) do
+    delete_analytics_rule(Connection.new(), ruleName, opts)
+  end
+
   @spec delete_analytics_rule(Connection.t(), String.t(), keyword) ::
           {:ok, OpenApiTypesense.AnalyticsRuleDeleteResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def delete_analytics_rule(conn \\ Connection.new(), ruleName, opts \\ []) do
+  def delete_analytics_rule(conn, ruleName, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -92,10 +116,17 @@ defmodule OpenApiTypesense.Analytics do
 
   Retrieve the details of an analytics rule, given it's name
   """
+  @spec retrieve_analytics_rule(String.t(), keyword) ::
+          {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
+          | {:error, OpenApiTypesense.ApiResponse.t()}
+  def retrieve_analytics_rule(ruleName, opts \\ []) do
+    retrieve_analytics_rule(Connection.new(), ruleName, opts)
+  end
+
   @spec retrieve_analytics_rule(Connection.t(), String.t(), keyword) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def retrieve_analytics_rule(conn \\ Connection.new(), ruleName, opts \\ []) do
+  def retrieve_analytics_rule(conn, ruleName, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -116,9 +147,15 @@ defmodule OpenApiTypesense.Analytics do
 
   Retrieve the details of all analytics rules
   """
+  @spec retrieve_analytics_rules(keyword) ::
+          {:ok, OpenApiTypesense.AnalyticsRulesRetrieveSchema.t()} | :error
+  def retrieve_analytics_rules(opts \\ []) do
+    retrieve_analytics_rules(Connection.new(), opts)
+  end
+
   @spec retrieve_analytics_rules(Connection.t(), keyword) ::
           {:ok, OpenApiTypesense.AnalyticsRulesRetrieveSchema.t()} | :error
-  def retrieve_analytics_rules(conn \\ Connection.new(), opts \\ []) do
+  def retrieve_analytics_rules(conn, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -136,6 +173,17 @@ defmodule OpenApiTypesense.Analytics do
 
   Upserts an analytics rule with the given name.
   """
+  @spec upsert_analytics_rule(
+          String.t(),
+          OpenApiTypesense.AnalyticsRuleUpsertSchema.t(),
+          keyword
+        ) ::
+          {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
+          | {:error, OpenApiTypesense.ApiResponse.t()}
+  def upsert_analytics_rule(ruleName, body, opts \\ []) do
+    upsert_analytics_rule(Connection.new(), ruleName, body, opts)
+  end
+
   @spec upsert_analytics_rule(
           Connection.t(),
           String.t(),
@@ -144,7 +192,7 @@ defmodule OpenApiTypesense.Analytics do
         ) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def upsert_analytics_rule(conn \\ Connection.new(), ruleName, body, opts \\ []) do
+  def upsert_analytics_rule(conn, ruleName, body, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{

lib/open_api_typesense/operations/collections.ex

@@ -12,10 +12,17 @@ defmodule OpenApiTypesense.Collections do
 
   When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection.
   """
+  @spec create_collection(OpenApiTypesense.CollectionSchema.t(), keyword) ::
+          {:ok, OpenApiTypesense.CollectionResponse.t()}
+          | {:error, OpenApiTypesense.ApiResponse.t()}
+  def create_collection(body, opts \\ []) do
+    create_collection(Connection.new(), body, opts)
+  end
+
   @spec create_collection(Connection.t(), OpenApiTypesense.CollectionSchema.t(), keyword) ::
           {:ok, OpenApiTypesense.CollectionResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def create_collection(conn \\ Connection.new(), body, opts \\ []) do
+  def create_collection(conn, body, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -37,9 +44,15 @@ defmodule OpenApiTypesense.Collections do
   @doc """
   Delete an alias
   """
+  @spec delete_alias(String.t(), keyword) ::
+          {:ok, OpenApiTypesense.CollectionAlias.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
+  def delete_alias(aliasName, opts \\ []) do
+    delete_alias(Connection.new(), aliasName, opts)
+  end
+
   @spec delete_alias(Connection.t(), String.t(), keyword) ::
           {:ok, OpenApiTypesense.CollectionAlias.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
-  def delete_alias(conn \\ Connection.new(), aliasName, opts \\ []) do
+  def delete_alias(conn, aliasName, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -60,10 +73,17 @@ defmodule OpenApiTypesense.Collections do
 
   Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies.
   """
+  @spec delete_collection(String.t(), keyword) ::
+          {:ok, OpenApiTypesense.CollectionResponse.t()}
+          | {:error, OpenApiTypesense.ApiResponse.t()}
+  def delete_collection(collectionName, opts \\ []) do
+    delete_collection(Connection.new(), collectionName, opts)
+  end
+
   @spec delete_collection(Connection.t(), String.t(), keyword) ::
           {:ok, OpenApiTypesense.CollectionResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def delete_collection(conn \\ Connection.new(), collectionName, opts \\ []) do
+  def delete_collection(conn, collectionName, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -84,9 +104,15 @@ defmodule OpenApiTypesense.Collections do
 
   Find out which collection an alias points to by fetching it
   """
+  @spec get_alias(String.t(), keyword) ::
+          {:ok, OpenApiTypesense.CollectionAlias.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
+  def get_alias(aliasName, opts \\ []) do
+    get_alias(Connection.new(), aliasName, opts)
+  end
+
   @spec get_alias(Connection.t(), String.t(), keyword) ::
           {:ok, OpenApiTypesense.CollectionAlias.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
-  def get_alias(conn \\ Connection.new(), aliasName, opts \\ []) do
+  def get_alias(conn, aliasName, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -107,9 +133,15 @@ defmodule OpenApiTypesense.Collections do
 
   List all aliases and the corresponding collections that they map to.
   """
+  @spec get_aliases(keyword) ::
+          {:ok, OpenApiTypesense.CollectionAliasesResponse.t()} | :error
+  def get_aliases(opts \\ []) do
+    get_aliases(Connection.new(), opts)
+  end
+
   @spec get_aliases(Connection.t(), keyword) ::
           {:ok, OpenApiTypesense.CollectionAliasesResponse.t()} | :error
-  def get_aliases(conn \\ Connection.new(), opts \\ []) do
+  def get_aliases(conn, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -127,10 +159,17 @@ defmodule OpenApiTypesense.Collections do
 
   Retrieve the details of a collection, given its name.
   """
+  @spec get_collection(String.t(), keyword) ::
+          {:ok, OpenApiTypesense.CollectionResponse.t()}
+          | {:error, OpenApiTypesense.ApiResponse.t()}
+  def get_collection(collectionName, opts \\ []) do
+    get_collection(Connection.new(), collectionName, opts)
+  end
+
   @spec get_collection(Connection.t(), String.t(), keyword) ::
           {:ok, OpenApiTypesense.CollectionResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def get_collection(conn \\ Connection.new(), collectionName, opts \\ []) do
+  def get_collection(conn, collectionName, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -151,9 +190,15 @@ defmodule OpenApiTypesense.Collections do
 
   Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.
   """
+  @spec get_collections(keyword) ::
+          {:ok, [OpenApiTypesense.CollectionResponse.t()]} | :error
+  def get_collections(opts \\ []) do
+    get_collections(Connection.new(), opts)
+  end
+
   @spec get_collections(Connection.t(), keyword) ::
           {:ok, [OpenApiTypesense.CollectionResponse.t()]} | :error
-  def get_collections(conn \\ Connection.new(), opts \\ []) do
+  def get_collections(conn, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -171,6 +216,17 @@ defmodule OpenApiTypesense.Collections do
 
   Update a collection's schema to modify the fields and their types.
   """
+  @spec update_collection(
+          String.t(),
+          OpenApiTypesense.CollectionUpdateSchema.t(),
+          keyword
+        ) ::
+          {:ok, OpenApiTypesense.CollectionUpdateSchema.t()}
+          | {:error, OpenApiTypesense.ApiResponse.t()}
+  def update_collection(collectionName, body, opts \\ []) do
+    update_collection(Connection.new(), collectionName, body, opts)
+  end
+
   @spec update_collection(
           Connection.t(),
           String.t(),
@@ -179,7 +235,7 @@ defmodule OpenApiTypesense.Collections do
         ) ::
           {:ok, OpenApiTypesense.CollectionUpdateSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def update_collection(conn \\ Connection.new(), collectionName, body, opts \\ []) do
+  def update_collection(conn, collectionName, body, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{
@@ -203,14 +259,24 @@ defmodule OpenApiTypesense.Collections do
 
   Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you're familiar with symbolic links on Linux, it's very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code.
   """
+  @spec upsert_alias(
+          String.t(),
+          OpenApiTypesense.CollectionAliasSchema.t(),
+          keyword
+        ) ::
+          {:ok, OpenApiTypesense.CollectionAlias.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
+  def upsert_alias(aliasName, body, opts \\ []) do
+    upsert_alias(Connection.new(), aliasName, body, opts)
+  end
+
   @spec upsert_alias(
           Connection.t(),
           String.t(),
           OpenApiTypesense.CollectionAliasSchema.t(),
           keyword
         ) ::
           {:ok, OpenApiTypesense.CollectionAlias.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
-  def upsert_alias(conn \\ Connection.new(), aliasName, body, opts \\ []) do
+  def upsert_alias(conn, aliasName, body, opts) do
     client = opts[:client] || @default_client
 
     client.request(conn, %{