CI and docs housekeeping (#40)

List of changes:
- add changelog link to hex module view
- bump actions/checkout and actions/cache
- bump ex_doc and related deps
- improve test coverage
- remove deprecated code since we're on OTP 24
- set minimal Elixir requirement to 1.13
- support Elixir 1.19/OTP 28 in CI matrix

Author: kianmeng

.github/workflows/main.yml

@@ -8,29 +8,29 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     env:
       MIX_ENV: test
     strategy:
       fail-fast: false
       matrix:
         include:
           - pair:
-              elixir: 1.12.0
-              otp: 22.3
+              elixir: "1.13"
+              otp: "24"
           - pair:
-              elixir: 1.14.1
-              otp: 25.1
+              elixir: "1.19"
+              otp: "28"
             lint: lint
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
 
       - uses: erlef/setup-beam@v1
         with:
           otp-version: ${{matrix.pair.otp}}
           elixir-version: ${{matrix.pair.elixir}}
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: |
             deps

lib/nimble_totp.ex

@@ -258,12 +258,7 @@ defmodule NimbleTOTP do
     hmac_sha(secret, moving_factor)
   end
 
-  # TODO: Remove me when we require OTP 22.1
-  if Code.ensure_loaded?(:crypto) and function_exported?(:crypto, :mac, 4) do
-    defp hmac_sha(key, data), do: :crypto.mac(:hmac, :sha, key, data)
-  else
-    defp hmac_sha(key, data), do: :crypto.hmac(:sha, key, data)
-  end
+  defp hmac_sha(key, data), do: :crypto.mac(:hmac, :sha, key, data)
 
   defp hmac_truncate(hmac) do
     <<_::19-binary, _::4, offset::4>> = hmac

mix.exs

@@ -8,7 +8,7 @@ defmodule NimbleTOTP.MixProject do
     [
       app: :nimble_totp,
       version: @version,
-      elixir: "~> 1.12",
+      elixir: "~> 1.13",
       start_permanent: Mix.env() == :prod,
       deps: deps(),
 
@@ -30,14 +30,17 @@ defmodule NimbleTOTP.MixProject do
 
   defp deps do
     [
-      {:ex_doc, ">= 0.19.0", only: :docs}
+      {:ex_doc, ">= 0.0.0", only: :docs}
     ]
   end
 
   defp package do
     [
       licenses: ["Apache-2.0"],
-      links: %{"GitHub" => @repo_url}
+      links: %{
+        "GitHub" => @repo_url,
+        "Changelog" => "#{@repo_url}/blob/main/CHANGELOG.md"
+      }
     ]
   end
 

mix.lock

@@ -1,8 +1,8 @@
 %{
-  "earmark_parser": {:hex, :earmark_parser, "1.4.41", "ab34711c9dc6212dda44fcd20ecb87ac3f3fce6f0ca2f28d4a00e4154f8cd599", [:mix], [], "hexpm", "a81a04c7e34b6617c2792e291b5a2e57ab316365c2644ddc553bb9ed863ebefa"},
-  "ex_doc": {:hex, :ex_doc, "0.34.2", "13eedf3844ccdce25cfd837b99bea9ad92c4e511233199440488d217c92571e8", [:mix], [{:earmark_parser, "~> 1.4.39", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "5ce5f16b41208a50106afed3de6a2ed34f4acfd65715b82a0b84b49d995f95c1"},
-  "makeup": {:hex, :makeup, "1.2.0", "b92e9476c62534bd0e5ea9b9fcf36536ca929b6842549832c71d2533cdbe72f7", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "a7af3614f63cbfde2bbe5823cb3e5369317feca391c3a1f96dab8b6b8b09fdf9"},
-  "makeup_elixir": {:hex, :makeup_elixir, "1.0.0", "74bb8348c9b3a51d5c589bf5aebb0466a84b33274150e3b6ece1da45584afc82", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "49159b7d7d999e836bedaf09dcf35ca18b312230cf901b725a64f3f42e407983"},
-  "makeup_erlang": {:hex, :makeup_erlang, "1.0.1", "c7f58c120b2b5aa5fd80d540a89fdf866ed42f1f3994e4fe189abebeab610839", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "8a89a1eeccc2d798d6ea15496a6e4870b75e014d1af514b1b71fa33134f57814"},
-  "nimble_parsec": {:hex, :nimble_parsec, "1.4.0", "51f9b613ea62cfa97b25ccc2c1b4216e81df970acd8e16e8d1bdc58fef21370d", [:mix], [], "hexpm", "9c565862810fb383e9838c1dd2d7d2c437b3d13b267414ba6af33e50d2d1cf28"},
+  "earmark_parser": {:hex, :earmark_parser, "1.4.44", "f20830dd6b5c77afe2b063777ddbbff09f9759396500cdbe7523efd58d7a339c", [:mix], [], "hexpm", "4778ac752b4701a5599215f7030989c989ffdc4f6df457c5f36938cc2d2a2750"},
+  "ex_doc": {:hex, :ex_doc, "0.39.1", "e19d356a1ba1e8f8cfc79ce1c3f83884b6abfcb79329d435d4bbb3e97ccc286e", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "8abf0ed3e3ca87c0847dfc4168ceab5bedfe881692f1b7c45f4a11b232806865"},
+  "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
+  "makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},
+  "makeup_erlang": {:hex, :makeup_erlang, "1.0.2", "03e1804074b3aa64d5fad7aa64601ed0fb395337b982d9bcf04029d68d51b6a7", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "af33ff7ef368d5893e4a267933e7744e46ce3cf1f61e2dccf53a111ed3aa3727"},
+  "nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
 }

test/nimble_totp_test.exs

@@ -44,6 +44,34 @@ defmodule NimbleTOTPTest do
              extra=extra%20value\
              """
     end
+
+    test "Generate the uri with extra params (deprecated, with digits option)" do
+      secret = Base.decode32!("PTEPUGZ7DUWTBGMW4WLKB6U63MGKKMCA")
+      app = "Bytepack App"
+
+      assert NimbleTOTP.otpauth_uri("#{app}:user@test.com", secret, issuer: app, digits: 8) == """
+             otpauth://totp/Bytepack%20App:user@test.com?\
+             secret=PTEPUGZ7DUWTBGMW4WLKB6U63MGKKMCA&\
+             issuer=Bytepack%20App&\
+             digits=8\
+             """
+    end
+
+    test "raises error if issuer contains a colon (otpauth_uri/4)" do
+      secret = Base.decode32!("PTEPUGZ7DUWTBGMW4WLKB6U63MGKKMCA")
+
+      assert_raise ArgumentError, "issuer cannot have :", fn ->
+        NimbleTOTP.otpauth_uri("Acme:Inc", "alice", secret, [])
+      end
+    end
+
+    test "raises error if account contains a colon (otpauth_uri/4)" do
+      secret = Base.decode32!("PTEPUGZ7DUWTBGMW4WLKB6U63MGKKMCA")
+
+      assert_raise ArgumentError, "account cannot have :", fn ->
+        NimbleTOTP.otpauth_uri("Acme", "alice:corp", secret, [])
+      end
+    end
   end
 
   describe "secret" do
@@ -204,6 +232,11 @@ defmodule NimbleTOTPTest do
         NimbleTOTP.verification_code(secret, time: time, digits: 11)
       end
     end
+
+    test "returns false if the otp is not a binary" do
+      secret = NimbleTOTP.secret()
+      refute NimbleTOTP.valid?(secret, 123_456, time: System.os_time(:second))
+    end
   end
 
   defp to_unix(naive_datetime),