pass test for coverage posting

Author: jaeyson

.github/dependabot.yml

@@ -12,3 +12,9 @@ updates:
     labels:
       - "hex"
       - "dependencies"
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

README.md

@@ -2,11 +2,13 @@
 
 Restful client for Typesense with adherence to Open API spec 3 (formerly Swagger)
 
+[![Dependabot](https://img.shields.io/badge/Dependabot-enabled-green)](https://github.com/jaeyson/open_api_typesense/pulls/app%2Fdependabot)
 [![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)
+[![CI Status](https://github.com/jaeyson/open_api_typesense/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/jaeyson/open_api_typesense/actions/workflows/ci.yml)
 
 ## TODO
 - Custom Http client adapter (currently [`Req`](https://hexdocs.pm/req))

lib/open_api_typesense/client.ex

@@ -46,8 +46,7 @@ defmodule OpenApiTypesense.Client do
 
   > #### On using this function {: .info}
   > Functions e.g. `OpenApiTypesense.Health.health` don't need to explicitly pass
-  > a `connection` unless you want to use custom `connection`. See [`README`](/README.md) for
-  > more details or `OpenApiTypesense.Connection` module.
+  > a `connection` unless you want to use custom `connection`. See [`README`](/README.md) for more details or `OpenApiTypesense.Connection` module.
 
   ## Options
 

lib/open_api_typesense/connection.ex

@@ -27,19 +27,17 @@ defmodule OpenApiTypesense.Connection do
   ## Examples
 
       iex> alias OpenApiTypesense.Connection
-
-      iex> conn = Connection.new()
+      ...> Connection.new()
       %OpenApiTypesense.Connection{
         host: "localhost",
         port: 8108,
         scheme: "http",
-        ...
+        api_key: "xyz"
       }
 
-      iex> Connection.new(%{})
-      ** (ArgumentError) Missing required fields: [:port, :scheme, :host, :api_key]
-          (open_api_typesense 0.2.0) lib/open_api_typesense/connection.ex:56: OpenApiTypesense.Connection.new/1
-      iex:2: (file)
+      iex> alias OpenApiTypesense.Connection
+      ...> Connection.new(%{})
+      ** (ArgumentError) Missing required fields: [:api_key, :host, :port, :scheme]
 
   """
   @doc since: "0.2.0"
@@ -48,7 +46,7 @@ defmodule OpenApiTypesense.Connection do
   def new(connection \\ defaults())
 
   def new(connection) when is_map(connection) do
-    missing_fields = required_fields() -- Map.keys(connection)
+    missing_fields = Enum.sort(required_fields() -- Map.keys(connection))
 
     if missing_fields == [] do
       struct(__MODULE__, connection)
@@ -61,7 +59,7 @@ defmodule OpenApiTypesense.Connection do
     raise ArgumentError, "Expected a map for connection options"
   end
 
-  @spec required_fields :: map()
+  @spec required_fields :: list(atom())
   defp required_fields do
     struct(__MODULE__, %{}) |> Map.drop([:__struct__]) |> Map.keys()
   end

…t/open_api_typesense_connection_test.exs test/connection_test.exstest/open_api_typesense_connection_test.exs renamed to test/connection_test.exs test/open_api_typesense_connection_test.exs renamed to test/connection_test.exs

@@ -1,5 +1,6 @@
-defmodule OpenApiTypesense.ConnectionTest do
+defmodule ConnectionTest do
   use ExUnit.Case, async: true
+  doctest OpenApiTypesense.Connection
 
   alias OpenApiTypesense.Connection
 
@@ -32,7 +33,7 @@ defmodule OpenApiTypesense.ConnectionTest do
   end
 
   test "new/1 with empty map raises ArgumentError" do
-    msg = "Missing required fields: [:port, :scheme, :host, :api_key]"
+    msg = "Missing required fields: [:api_key, :host, :port, :scheme]"
     assert_raise ArgumentError, msg, fn -> Connection.new(%{}) end
   end