feat: adapt library to remote needs

- Cleanup of not needed adapters like:
  - Legacy FCM
  - ADM (Amazon)
- Fix deprecation warning
- Catch `{:error, reason}` on `DispatcherWorker.handle_info\1`
- Add a quick way to setup test environment variables

.env.test.example

@@ -0,0 +1,10 @@
+export FCM_PROJECT_ID="your-firebase-project-id"
+export FCM_SERVICE_ACCOUNT_JSON=$(cat /path/to/service/account/json)
+
+export APNS_KEY_UNENCRYPTED=$(cat /path/to/apns/key-unencrypted.p8)
+export APNS_KEY_IDENTIFIER="your-apple-key-identifier"
+export APNS_TEAM_ID="your-apple-team-id"
+export APNS_TOPIC="com.your.project.topic"
+
+export VALID_APNS_TOKEN="a-valid-apple-device-token"
+export VALID_GCM_REG_ID="a-valid-android-device-token"

.github/workflows/ci.yml

@@ -31,8 +31,8 @@ jobs:
       - name: Set up Elixir
         uses: erlef/setup-beam@v1
         with:
-          elixir-version: "1.14.3"
-          otp-version: "24.3"
+          elixir-version: "1.15.5"
+          otp-version: "26.02"
       - name: Restore dependencies cache
         uses: actions/cache@v3
         with:
@@ -53,8 +53,8 @@ jobs:
       - name: Set up Elixir
         uses: erlef/setup-beam@v1
         with:
-          elixir-version: "1.14.3"
-          otp-version: "24.3"
+          elixir-version: "1.15.5"
+          otp-version: "26.0.2"
       - name: Restore dependencies cache
         uses: actions/cache@v3
         with:
@@ -65,17 +65,12 @@ jobs:
         run: mix deps.get
       - name: Run tests
         env:
-          ADM_OAUTH2_CLIENT_ID: ${{ secrets.ADM_OAUTH2_CLIENT_ID }}
-          ADM_OAUTH2_CLIENT_SECRET: ${{ secrets.ADM_OAUTH2_CLIENT_SECRET }}
-          APNS_AUTH_KEY_P8: ${{ secrets.APNS_AUTH_KEY_P8 }}
-          APNS_CERT: ${{ secrets.APNS_CERT }}
-          APNS_JWT_KEY_IDENTIFIER: ${{ secrets.APNS_JWT_KEY_IDENTIFIER }}
-          APNS_JWT_TEAM_ID: ${{ secrets.APNS_JWT_TEAM_ID }}
+          APNS_KEY_IDENTIFIER: ${{ secrets.APNS_KEY_IDENTIFIER }}
+          APNS_TEAM_ID: ${{ secrets.APNS_TEAM_ID }}
           APNS_KEY_UNENCRYPTED: ${{ secrets.APNS_KEY_UNENCRYPTED }}
-          APNS_TOPIC: ${{ secrets.APNS_TOPIC }}
-          FCM_PROJECT: ${{ secrets.FCM_PROJECT }}
+          APNS_TOPIC: ${{ vars.APNS_TOPIC }}
+          FCM_PROJECT_ID: ${{ secrets.FCM_PROJECT_ID }}
           FCM_SERVICE_ACCOUNT_JSON: ${{ secrets.FCM_SERVICE_ACCOUNT_JSON }}
-          GCM_KEY: ${{ secrets.GCM_KEY }}
-          VALID_APNS_TOKEN: ${{ secrets.VALID_APNS_TOKEN }}
-          VALID_GCM_REG_ID: ${{ secrets.VALID_GCM_REG_ID }}
+          VALID_APNS_TOKEN: ${{ vars.VALID_APNS_TOKEN }}
+          VALID_GCM_REG_ID: ${{ vars.VALID_GCM_REG_ID }}
         run: mix test

.gitignore

@@ -43,3 +43,5 @@ scratchpad.txt
 .idea
 pigeon.iml
 .envrc
+
+.env.test

README.md

@@ -51,6 +51,12 @@ Unit tests can be run with `mix test` or `mix coveralls.html`. Environment varia
 various credentials. See [config/test.exs](https://github.com/codedge-llc/pigeon/blob/master/config/test.exs)
 for the full list.
 
+```sh
+cp .env.test.example .env.test
+# Update the environment values with your project ones
+source .env.test
+```
+
 ### Formatting
 
 This project uses Elixir's `mix format` and [Prettier](https://prettier.io) for formatting.

config/test.exs

@@ -8,31 +8,23 @@ config :pigeon, :test,
   valid_apns_token: System.get_env("VALID_APNS_TOKEN"),
   valid_fcm_reg_id: System.get_env("VALID_GCM_REG_ID")
 
-config :pigeon, PigeonTest.ADM,
-  adapter: Pigeon.ADM,
-  client_id: System.get_env("ADM_OAUTH2_CLIENT_ID"),
-  client_secret: System.get_env("ADM_OAUTH2_CLIENT_SECRET")
-
 config :pigeon, PigeonTest.APNS,
   adapter: Pigeon.APNS,
-  cert: System.get_env("APNS_CERT"),
   key: System.get_env("APNS_KEY_UNENCRYPTED"),
-  mode: :dev
+  key_identifier: System.get_env("APNS_KEY_IDENTIFIER"),
+  team_id: System.get_env("APNS_TEAM_ID"),
+  mode: :prod
 
 config :pigeon, PigeonTest.APNS.JWT,
   adapter: Pigeon.APNS,
-  key: System.get_env("APNS_AUTH_KEY_P8"),
-  key_identifier: System.get_env("APNS_JWT_KEY_IDENTIFIER"),
-  team_id: System.get_env("APNS_JWT_TEAM_ID"),
-  mode: :dev
-
-config :pigeon, PigeonTest.LegacyFCM,
-  adapter: Pigeon.LegacyFCM,
-  key: System.get_env("GCM_KEY")
+  key: System.get_env("APNS_KEY_UNENCRYPTED"),
+  key_identifier: System.get_env("APNS_KEY_IDENTIFIER"),
+  team_id: System.get_env("APNS_TEAM_ID"),
+  mode: :prod
 
 config :pigeon, PigeonTest.FCM,
   adapter: Pigeon.FCM,
-  project_id: System.get_env("FCM_PROJECT"),
+  project_id: System.get_env("FCM_PROJECT_ID"),
   service_account_json: System.get_env("FCM_SERVICE_ACCOUNT_JSON")
 
 config :pigeon, PigeonTest.Sandbox, adapter: Pigeon.Sandbox

lib/pigeon/adapter.ex

@@ -48,7 +48,8 @@ defmodule Pigeon.Adapter do
   @doc """
   Invoked to handle all other messages.
   """
-  @callback handle_info(term, term) :: {:noreply, term}
+  @callback handle_info(term, term) ::
+              {:noreply, term} | {:stop, reason :: term}
 
   @doc """
   Invoked to handle push notifications.