Overhaul: Bump elixir implementation and add comprehensive code coverage.

.github/workflows/main.yml

@@ -14,8 +14,7 @@ env:
 jobs:
   test:
     name: Test (Elixir ${{ matrix.elixir }}, OTP ${{ matrix.otp }})
-
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         # https://hexdocs.pm/elixir/compatibility-and-deprecations.html#compatibility-between-elixir-and-erlang-otp
@@ -83,6 +82,12 @@ jobs:
     - name: Run tests
       run: mix test
 
+    - name: Upload test results to Codecov
+      if: ${{ !cancelled() }}
+      uses: codecov/test-results-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+
     - name: Retrieve PLT Cache
       uses: actions/cache@v3
       if: matrix.dialyzer
@@ -103,3 +108,14 @@ jobs:
     - name: Run dialyzer
       if: matrix.dialyzer
       run: mix dialyzer --no-check --halt-exit-status
+
+    - name: Generate coverage report
+      run: mix coveralls.json
+
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        slug: workos/workos-elixir
+        files: ./cover/excoveralls.json
+        fail_ci_if_error: true

.gitignore

@@ -28,3 +28,6 @@ workos-*.tar
 # Dialyzer 
 /plts/*.plt
 /plts/*.plt.hash
+
+# Codecov token
+.secret

README.md

@@ -2,6 +2,8 @@
 
 > **Note:** this an experimental SDK and breaking changes may occur. We don't recommend using this in production since we can't guarantee its stability.
 
+[![codecov](https://codecov.io/gh/workos/workos-elixir/graph/badge.svg?token=D0XH6LBE1K)](https://codecov.io/gh/workos/workos-elixir)
+
 The WorkOS library for Elixir provides convenient access to the WorkOS API from applications written in Elixir.
 
 ## Documentation
@@ -12,7 +14,7 @@ See the [API Reference](https://workos.com/docs/reference/client-libraries) for
 
 Add this package to the list of dependencies in your `mix.exs` file:
 
-```ex
+```elixir
 def deps do
   [{:workos, "~> 1.1.0"}]
 end
@@ -22,17 +24,15 @@ end
 
 ### Configure WorkOS API key & client ID on your app config
 
-```ex
+```elixir
 config :workos, WorkOS.Client,
       api_key: "sk_example_123456789",
       client_id: "client_123456789"
 ```
 
-The only required config option is `:api_key` and `:client_id`. 
-
-By default, this library uses [Tesla](https://github.com/elixir-tesla/tesla) but it can be replaced via the `:client` option, according to the `WorkOS.Client` module behavior. 
+The only required config option is `:api_key` and `:client_id`.
 
-###
+By default, this library uses [Tesla](https://github.com/elixir-tesla/tesla) but it can be replaced via the `:client` option, according to the `WorkOS.Client` module behavior.
 
 ## SDK Versioning
 

lib/workos/castable.ex

@@ -1,6 +1,13 @@
 defmodule WorkOS.Castable do
-  @moduledoc false
+  @moduledoc """
+  Defines the Castable protocol for WorkOS SDK, used for casting API responses to Elixir structs.
 
+  This module provides the `cast/2` and `cast_list/2` functions, as well as the `impl` type used throughout the SDK for flexible casting.
+  """
+
+  @typedoc """
+  Represents a castable implementation. This can be a module, a tuple of modules, or :raw for raw maps.
+  """
   @type impl :: module() | {module(), module()} | :raw
   @type generic_map :: %{String.t() => any()}
 

lib/workos/client.ex

@@ -105,14 +105,25 @@ defmodule WorkOS.Client do
   defp handle_response(response, path, castable_module) do
     case response do
       {:ok, %{body: "", status: status}} when status in 200..299 ->
-        {:ok, Castable.cast(castable_module, %{})}
+        {:error, ""}
+
+      {:ok, %{body: body, status: status}} when status in 200..299 and is_map(body) ->
+        {:ok, WorkOS.Castable.cast(castable_module, body)}
 
       {:ok, %{body: body, status: status}} when status in 200..299 ->
-        {:ok, Castable.cast(castable_module, body)}
+        Logger.error("#{inspect(__MODULE__)} error when calling #{path}: #{inspect(body)}")
+        {:error, body}
+
+      {:ok, %{body: reason, status: :error}} when is_atom(reason) ->
+        Logger.error(
+          "#{inspect(__MODULE__)} client error when calling #{path}: #{inspect(reason)}"
+        )
+
+        {:error, :client_error}
 
       {:ok, %{body: body}} when is_map(body) ->
         Logger.error("#{inspect(__MODULE__)} error when calling #{path}: #{inspect(body)}")
-        {:error, Castable.cast(WorkOS.Error, body)}
+        {:error, WorkOS.Castable.cast(WorkOS.Error, body)}
 
       {:ok, %{body: body}} when is_binary(body) ->
         Logger.error("#{inspect(__MODULE__)} error when calling #{path}: #{body}")

lib/workos/organizations.ex

@@ -2,7 +2,34 @@ defmodule WorkOS.Organizations do
   @moduledoc """
   Manage Organizations in WorkOS.
 
-  @see https://workos.com/docs/reference/organization
+  Provides functions to list, create, update, retrieve, and delete organizations via the WorkOS API.
+
+  See the [WorkOS Organizations API Reference](https://workos.com/docs/reference/organization) for more details.
+
+  ## Example Usage
+
+  ```elixir
+  # List organizations
+  {:ok, %WorkOS.List{data: organizations}} = WorkOS.Organizations.list_organizations()
+
+  # Create an organization
+  {:ok, organization} = WorkOS.Organizations.create_organization(%{
+    name: "Test Organization",
+    domains: ["example.com"]
+  })
+
+  # Get an organization by ID
+  {:ok, organization} = WorkOS.Organizations.get_organization("org_01EHT88Z8J8795GZNQ4ZP1J81T")
+
+  # Update an organization
+  {:ok, updated_org} = WorkOS.Organizations.update_organization(
+    "org_01EHT88Z8J8795GZNQ4ZP1J81T",
+    %{name: "New Name", domains: ["newdomain.com"]}
+  )
+
+  # Delete an organization
+  {:ok, _} = WorkOS.Organizations.delete_organization("org_01EHT88Z8J8795GZNQ4ZP1J81T")
+  ```
   """
 
   alias WorkOS.Empty
@@ -82,27 +109,35 @@ defmodule WorkOS.Organizations do
 
     * `:name` - A descriptive name for the Organization. This field does not need to be unique. (required)
     * `:domains` - The domains of the Organization.
-    * `:allow_profiles_outside_organization` - Whether the Connections within this Organization should allow Profiles that do not have a domain that is present in the set of the Organization’s User Email Domains.
+    * `:allow_profiles_outside_organization` - Whether the Connections within this Organization should allow Profiles that do not have a domain that is present in the set of the Organization's User Email Domains.
     * `:idempotency_key` - A unique string as the value. Each subsequent request matching this unique string will return the same response.
 
   """
-  @spec create_organization(map()) :: WorkOS.Client.response(Organization.t())
+  @spec create_organization(map()) :: WorkOS.Client.response(Organization.t()) | {:error, atom()}
   @spec create_organization(WorkOS.Client.t(), map()) ::
-          WorkOS.Client.response(Organization.t())
-  def create_organization(client \\ WorkOS.client(), opts) when is_map_key(opts, :name) do
-    WorkOS.Client.post(
-      client,
-      Organization,
-      "/organizations",
-      %{
-        name: opts[:name],
-        domains: opts[:domains],
-        allow_profiles_outside_organization: opts[:allow_profiles_outside_organization]
-      },
-      headers: [
-        {"Idempotency-Key", opts[:idempotency_key]}
-      ]
-    )
+          WorkOS.Client.response(Organization.t()) | {:error, atom()}
+  def create_organization(opts) when is_map(opts) do
+    create_organization(WorkOS.client(), opts)
+  end
+
+  def create_organization(client, opts) when is_map(opts) do
+    if Map.has_key?(opts, :name) do
+      WorkOS.Client.post(
+        client,
+        Organization,
+        "/organizations",
+        %{
+          name: opts[:name],
+          domains: opts[:domains],
+          allow_profiles_outside_organization: opts[:allow_profiles_outside_organization]
+        },
+        headers: [
+          {"Idempotency-Key", opts[:idempotency_key]}
+        ]
+      )
+    else
+      {:error, :missing_name}
+    end
   end
 
   @doc """
@@ -113,18 +148,26 @@ defmodule WorkOS.Organizations do
     * `:organization` - Unique identifier of the Organization. (required)
     * `:name` - A descriptive name for the Organization. This field does not need to be unique. (required)
     * `:domains` - The domains of the Organization.
-    * `:allow_profiles_outside_organization` - Whether the Connections within this Organization should allow Profiles that do not have a domain that is present in the set of the Organization’s User Email Domains.
+    * `:allow_profiles_outside_organization` - Whether the Connections within this Organization should allow Profiles that do not have a domain that is present in the set of the Organization's User Email Domains.
 
   """
-  @spec update_organization(String.t(), map()) :: WorkOS.Client.response(Organization.t())
+  @spec update_organization(String.t(), map()) ::
+          WorkOS.Client.response(Organization.t()) | {:error, atom()}
   @spec update_organization(WorkOS.Client.t(), String.t(), map()) ::
-          WorkOS.Client.response(Organization.t())
-  def update_organization(client \\ WorkOS.client(), organization_id, opts)
-      when is_map_key(opts, :name) do
-    WorkOS.Client.put(client, Organization, "/organizations/#{organization_id}", %{
-      name: opts[:name],
-      domains: opts[:domains],
-      allow_profiles_outside_organization: !!opts[:allow_profiles_outside_organization]
-    })
+          WorkOS.Client.response(Organization.t()) | {:error, atom()}
+  def update_organization(organization_id, opts) when is_map(opts) do
+    update_organization(WorkOS.client(), organization_id, opts)
+  end
+
+  def update_organization(client, organization_id, opts) when is_map(opts) do
+    if Map.has_key?(opts, :name) do
+      WorkOS.Client.put(client, Organization, "/organizations/#{organization_id}", %{
+        name: opts[:name],
+        domains: opts[:domains],
+        allow_profiles_outside_organization: !!opts[:allow_profiles_outside_organization]
+      })
+    else
+      {:error, :missing_name}
+    end
   end
 end

lib/workos/sso.ex

@@ -64,11 +64,15 @@ defmodule WorkOS.SSO do
   @spec delete_connection(String.t()) :: WorkOS.Client.response(nil)
   @spec delete_connection(WorkOS.Client.t(), String.t()) :: WorkOS.Client.response(nil)
   def delete_connection(client \\ WorkOS.client(), connection_id) do
-    WorkOS.Client.delete(client, Empty, "/connections/:id", %{},
-      opts: [
-        path_params: [id: connection_id]
-      ]
-    )
+    if is_nil(connection_id) or connection_id in ["", nil] do
+      {:error, :invalid_connection_id}
+    else
+      WorkOS.Client.delete(client, Empty, "/connections/:id", %{},
+        opts: [
+          path_params: [id: connection_id]
+        ]
+      )
+    end
   end
 
   @doc """
@@ -77,11 +81,15 @@ defmodule WorkOS.SSO do
   @spec get_connection(String.t()) :: WorkOS.Client.response(Connection.t())
   @spec get_connection(WorkOS.Client.t(), String.t()) :: WorkOS.Client.response(Connection.t())
   def get_connection(client \\ WorkOS.client(), connection_id) do
-    WorkOS.Client.get(client, Connection, "/connections/:id",
-      opts: [
-        path_params: [id: connection_id]
-      ]
-    )
+    if is_nil(connection_id) or connection_id in ["", nil] do
+      {:error, :invalid_connection_id}
+    else
+      WorkOS.Client.get(client, Connection, "/connections/:id",
+        opts: [
+          path_params: [id: connection_id]
+        ]
+      )
+    end
   end
 
   @doc """

lib/workos/user_management/multi_factor/sms.ex

@@ -17,9 +17,9 @@ defmodule WorkOS.UserManagement.MultiFactor.SMS do
   ]
 
   @impl true
-  def cast(map) do
+  def cast(params) do
     %__MODULE__{
-      phone_number: map["phone_number"]
+      phone_number: params["phone_number"]
     }
   end
 end

lib/workos/user_management/multi_factor/totp.ex

@@ -29,13 +29,13 @@ defmodule WorkOS.UserManagement.MultiFactor.TOTP do
   ]
 
   @impl true
-  def cast(map) do
+  def cast(params) do
     %__MODULE__{
-      issuer: map["issuer"],
-      user: map["user"],
-      secret: map["secret"],
-      qr_code: map["qr_code"],
-      uri: map["uri"]
+      issuer: params["issuer"],
+      user: params["user"],
+      secret: params["secret"],
+      qr_code: params["qr_code"],
+      uri: params["uri"]
     }
   end
 end

lib/workos/user_management/organization_membership.ex

@@ -28,14 +28,13 @@ defmodule WorkOS.UserManagement.OrganizationMembership do
     :created_at
   ]
 
-  @impl true
-  def cast(map) do
+  def cast(params) do
     %__MODULE__{
-      id: map["id"],
-      user_id: map["user_id"],
-      organization_id: map["organization_id"],
-      updated_at: map["updated_at"],
-      created_at: map["created_at"]
+      id: params["id"],
+      user_id: params["user_id"],
+      organization_id: params["organization_id"],
+      updated_at: params["updated_at"],
+      created_at: params["created_at"]
     }
   end
 end

lib/workos/user_management/reset_password.ex

@@ -5,8 +5,6 @@ defmodule WorkOS.UserManagement.ResetPassword do
 
   alias WorkOS.UserManagement.User
 
-  @behaviour WorkOS.Castable
-
   @type t() :: %__MODULE__{
           user: User.t()
         }
@@ -18,10 +16,9 @@ defmodule WorkOS.UserManagement.ResetPassword do
     :user
   ]
 
-  @impl true
-  def cast(map) do
+  def cast(params) do
     %__MODULE__{
-      user: map["user"]
+      user: params["user"]
     }
   end
 end