add moar tests

Author: jaeyson

.credo.exs

@@ -94,7 +94,7 @@
           #
           ## Readability Checks
           #
-          {Credo.Check.Readability.AliasOrder, []},
+          # {Credo.Check.Readability.AliasOrder, []},
           {Credo.Check.Readability.FunctionNames, []},
           {Credo.Check.Readability.LargeNumbers, []},
           {Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 120]},

.github/workflows/ci.yml

@@ -20,6 +20,11 @@ jobs:
   test:
     runs-on: ubuntu-latest
 
+    env:
+      MIX_ENV: test
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      LATEST_TYPESENSE: '27.1'
+
     strategy:
       matrix:
         include:
@@ -48,10 +53,6 @@ jobs:
           elixir: '1.17'
           lint: true
 
-    env:
-      MIX_ENV: test
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
     services:
       typesense:
         image: typesense/typesense:${{ matrix.typesense }}
@@ -68,7 +69,10 @@ jobs:
           -v /tmp/typesense-data:/data \
           typesense/typesense:${{ matrix.typesense}} \
           --api-key=xyz \
-          --data-dir /data \
+          --data-dir=/data \
+          --enable-search-analytics=true \
+          --analytics-dir=/analytics-data  \
+          --analytics-flush-interval=60 \
           --enable-cors
 
       - name: Curl Typesense
@@ -86,9 +90,9 @@ jobs:
           path: |
             deps
             _build
-          key: ${{ runner.os }}-mix-typesense-${{ matrix.typesense}}-${{ matrix.otp}}-${{ matrix.elixir}}-${{ hashFiles('**/mix.lock') }}
+          key: ${{ runner.os }}-typesense-${{ matrix.typesense}}-${{ matrix.otp}}-${{ matrix.elixir}}-mix-${{ hashFiles('**/mix.lock') }}
           restore-keys: |
-            ${{ runner.os }}-mix-typesense-${{ matrix.typesense}}
+            ${{ runner.os }}-typesense-${{ matrix.typesense}}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-
 
       - name: Install Dependencies
         run: |
@@ -115,12 +119,13 @@ jobs:
         run: mix credo --all --strict
         if: ${{ matrix.lint }}
 
-      - name: Check format files
-        run: mix format --check-formatted
-        if: ${{ matrix.lint }}
+      # - name: Check format files
+      #   run: mix format --check-formatted
+      #   if: ${{ matrix.lint }}
 
       - name: Run tests
-        run: mix test
+        run: mix test --only ${{ matrix.typesense }} --trace
 
       - name: Post test coverage to Coveralls
         run: mix coveralls.github
+        if: ${{ matrix.typesense == env.LATEST_TYPESENSE }} 

README.md

@@ -1,8 +1,32 @@
 # OpenApiTypesense
 
+[![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)
+[![Typesense badge](https://img.shields.io/badge/Typesense-v27.1-darkblue)](https://typesense.org/docs/27.1/api)
+[![Coverage Status](https://coveralls.io/repos/github/jaeyson/open_api_typesense/badge.svg?branch=main)](https://coveralls.io/github/jaeyson/open_api_typesense?branch=main)
+
 ## 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
 

config/config.exs

@@ -13,6 +13,8 @@ if Mix.env() == :dev do
     default: [
       output: [
         base_module: OpenApiTypesense,
+        processor: OpenAPI.Processor,
+        renderer: OpenAPI.Renderer,
         location: "lib/open_api_typesense",
         operation_subdirectory: "operations/",
         schema_subdirectory: "schemas/"

coveralls.json

@@ -1,6 +1,7 @@
 {
   "skip_files": [
     "test",
-    "deps"
+    "deps",
+    "lib/open_api_typesense/schemas"
   ]
 }

docker-compose.yml

@@ -1,14 +1,22 @@
 services:
   typesense:
-    image: docker.io/typesense/typesense:27.1
+    # image: docker.io/typesense/typesense:27.1
+    image: docker.io/typesense/typesense:0.25.2
+    # image: docker.io/typesense/typesense:26.0
     container_name: typesense
     restart: on-failure
     ports:
       - 8107:8107 # internal status
       - 8108:8108 # typesense server
     volumes:
       - ./typesense-data:/data
-    command: "--data-dir /data --api-key=xyz --enable-cors"
+    command: |
+      --data-dir=/data
+      --api-key=xyz
+      --enable-search-analytics=true
+      --analytics-dir=/analytics-data 
+      --analytics-flush-interval=60
+      --enable-cors
   typesense_dashboard:
     image: ghcr.io/bfritscher/typesense-dashboard:1.9.3
     container_name: typesense_dashboard

lib/open_api_typesense/client.ex

@@ -107,7 +107,7 @@ defmodule OpenApiTypesense.Client do
         host: conn.host,
         port: conn.port,
         path: opts[:url],
-        query: URI.encode_query(opts[:opts] || %{})
+        query: URI.encode_query(opts[:query] || %{})
       }
 
     {_req, resp} =
@@ -144,6 +144,12 @@ defmodule OpenApiTypesense.Client do
     parse_values(code, values, resp.body)
   end
 
+  defp parse_values(code, :map, body) when is_map(body) do
+    status = if code in 200..299, do: :ok, else: :error
+
+    {status, body}
+  end
+
   defp parse_values(code, values, body) when is_list(values) do
     status = if code in 200..299, do: :ok, else: :error
 

lib/open_api_typesense/operations/analytics.ex

@@ -3,6 +3,8 @@ defmodule OpenApiTypesense.Analytics do
   Provides API endpoints related to analytics
   """
 
+  alias OpenApiTypesense.Connection
+
   @default_client OpenApiTypesense.Client
 
   @doc """
@@ -62,13 +64,13 @@ defmodule OpenApiTypesense.Analytics do
 
   Permanently deletes an analytics rule, given it's name
   """
-  @spec delete_analytics_rule(String.t(), keyword) ::
+  @spec delete_analytics_rule(Connection.t(), String.t(), keyword) ::
           {:ok, OpenApiTypesense.AnalyticsRuleDeleteResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def delete_analytics_rule(ruleName, opts \\ []) do
+  def delete_analytics_rule(conn \\ Connection.new(), ruleName, opts \\ []) do
     client = opts[:client] || @default_client
 
-    client.request(%{
+    client.request(conn, %{
       args: [ruleName: ruleName],
       call: {OpenApiTypesense.Analytics, :delete_analytics_rule},
       url: "/analytics/rules/#{ruleName}",
@@ -86,13 +88,13 @@ defmodule OpenApiTypesense.Analytics do
 
   Retrieve the details of an analytics rule, given it's name
   """
-  @spec retrieve_analytics_rule(String.t(), keyword) ::
+  @spec retrieve_analytics_rule(Connection.t(), String.t(), keyword) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def retrieve_analytics_rule(ruleName, opts \\ []) do
+  def retrieve_analytics_rule(conn \\ Connection.new(), ruleName, opts \\ []) do
     client = opts[:client] || @default_client
 
-    client.request(%{
+    client.request(conn, %{
       args: [ruleName: ruleName],
       call: {OpenApiTypesense.Analytics, :retrieve_analytics_rule},
       url: "/analytics/rules/#{ruleName}",
@@ -110,12 +112,12 @@ defmodule OpenApiTypesense.Analytics do
 
   Retrieve the details of all analytics rules
   """
-  @spec retrieve_analytics_rules(keyword) ::
+  @spec retrieve_analytics_rules(Connection.t(), keyword) ::
           {:ok, OpenApiTypesense.AnalyticsRulesRetrieveSchema.t()} | :error
-  def retrieve_analytics_rules(opts \\ []) do
+  def retrieve_analytics_rules(conn \\ Connection.new(), opts \\ []) do
     client = opts[:client] || @default_client
 
-    client.request(%{
+    client.request(conn, %{
       args: [],
       call: {OpenApiTypesense.Analytics, :retrieve_analytics_rules},
       url: "/analytics/rules",

lib/open_api_typesense/operations/collections.ex

@@ -37,12 +37,12 @@ defmodule OpenApiTypesense.Collections do
   @doc """
   Delete an alias
   """
-  @spec delete_alias(String.t(), keyword) ::
+  @spec delete_alias(Connection.t(), String.t(), keyword) ::
           {:ok, OpenApiTypesense.CollectionAlias.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
-  def delete_alias(aliasName, opts \\ []) do
+  def delete_alias(conn \\ Connection.new(), aliasName, opts \\ []) do
     client = opts[:client] || @default_client
 
-    client.request(%{
+    client.request(conn, %{
       args: [aliasName: aliasName],
       call: {OpenApiTypesense.Collections, :delete_alias},
       url: "/aliases/#{aliasName}",
@@ -171,13 +171,18 @@ 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) ::
+  @spec update_collection(
+          Connection.t(),
+          String.t(),
+          OpenApiTypesense.CollectionUpdateSchema.t(),
+          keyword
+        ) ::
           {:ok, OpenApiTypesense.CollectionUpdateSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
-  def update_collection(collectionName, body, opts \\ []) do
+  def update_collection(conn \\ Connection.new(), collectionName, body, opts \\ []) do
     client = opts[:client] || @default_client
 
-    client.request(%{
+    client.request(conn, %{
       args: [collectionName: collectionName, body: body],
       call: {OpenApiTypesense.Collections, :update_collection},
       url: "/collections/#{collectionName}",
@@ -198,12 +203,17 @@ 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) ::
+  @spec upsert_alias(
+          Connection.t(),
+          String.t(),
+          OpenApiTypesense.CollectionAliasSchema.t(),
+          keyword
+        ) ::
           {:ok, OpenApiTypesense.CollectionAlias.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
-  def upsert_alias(aliasName, body, opts \\ []) do
+  def upsert_alias(conn \\ Connection.new(), aliasName, body, opts \\ []) do
     client = opts[:client] || @default_client
 
-    client.request(%{
+    client.request(conn, %{
       args: [aliasName: aliasName, body: body],
       call: {OpenApiTypesense.Collections, :upsert_alias},
       url: "/aliases/#{aliasName}",

lib/open_api_typesense/operations/curation.ex

@@ -3,6 +3,8 @@ defmodule OpenApiTypesense.Curation do
   Provides API endpoints related to curation
   """
 
+  alias OpenApiTypesense.Connection
+
   @default_client OpenApiTypesense.Client
 
   @doc """
@@ -30,12 +32,12 @@ defmodule OpenApiTypesense.Curation do
   @doc """
   List all collection overrides
   """
-  @spec get_search_overrides(String.t(), keyword) ::
+  @spec get_search_overrides(Connection.t(), String.t(), keyword) ::
           {:ok, OpenApiTypesense.SearchOverridesResponse.t()} | :error
-  def get_search_overrides(collectionName, opts \\ []) do
+  def get_search_overrides(conn \\ Connection.new(), collectionName, opts \\ []) do
     client = opts[:client] || @default_client
 
-    client.request(%{
+    client.request(conn, %{
       args: [collectionName: collectionName],
       call: {OpenApiTypesense.Curation, :get_search_overrides},
       url: "/collections/#{collectionName}/overrides",