fix: minor refactorings

spawnfest · Oct 29, 2023 · c9b41c0 · c9b41c0
1 parent f6ddfd8
commit c9b41c0
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 21 deletions.
diff --git a/lib/ex_ucan.ex b/lib/ex_ucan.ex
@@ -2,18 +2,18 @@ defmodule ExUcan do
   @moduledoc """
   Documentation for `ExUcan`.
   """
-  alias ExUcan.Keymaterial.Ed25519.Keypair
-  alias ExUcan.Core.Token
   alias ExUcan.Core.Structs.Ucan
+  alias ExUcan.Core.Token
+  alias ExUcan.Keymaterial.Ed25519.Keypair
 
   @doc """
   Creates a default keypair with EdDSA algorithm
 
   This keypair can be later used for create UCAN tokens
   Keypair generated with different algorithms like RSA will be coming soon..
   """
-  @spec create_default_keypair() :: Keypair.t()
-  def create_default_keypair() do
+  @spec create_default_keypair :: Keypair.t()
+  def create_default_keypair do
     Keypair.create()
   end
 

diff --git a/lib/ex_ucan/builder.ex b/lib/ex_ucan/builder.ex
@@ -2,10 +2,10 @@ defmodule ExUcan.Builder do
   @moduledoc """
   Builder functions for UCAN tokens
   """
+  alias ExUcan.Core.Capability
   alias ExUcan.Core.Structs.UcanPayload
   alias ExUcan.Core.Token
   alias ExUcan.Keymaterial.Ed25519.Keypair
-  alias ExUcan.Core.Capability
 
   @type t :: %__MODULE__{
           issuer: Keypair,
@@ -38,8 +38,8 @@ defmodule ExUcan.Builder do
     - `with_lifetime` or `with_expiration`.
     To finalise the builder, call its `build` or `build_parts` method.
   """
-  @spec default() :: __MODULE__.t()
-  def default() do
+  @spec default :: __MODULE__.t()
+  def default do
     %__MODULE__{
       issuer: nil,
       audience: nil,

diff --git a/lib/ex_ucan/core/token.ex b/lib/ex_ucan/core/token.ex
@@ -2,14 +2,14 @@ defmodule ExUcan.Core.Token do
   @moduledoc """
   Creates and manages UCAN tokens
   """
-  alias ExUcan.Keymaterial.Ed25519.Keypair
-  alias ExUcan.Core.Utils
   alias ExUcan.Builder
-  alias ExUcan.Keymaterial.Ed25519.Crypto
-  alias ExUcan.Core.Structs.UcanHeader
-  alias ExUcan.Keymaterial
   alias ExUcan.Core.Structs.Ucan
+  alias ExUcan.Core.Structs.UcanHeader
   alias ExUcan.Core.Structs.UcanPayload
+  alias ExUcan.Core.Utils
+  alias ExUcan.Keymaterial
+  alias ExUcan.Keymaterial.Ed25519.Crypto
+  alias ExUcan.Keymaterial.Ed25519.Keypair
 
   @token_type "JWT"
   @version %{major: 0, minor: 10, patch: 0}

diff --git a/lib/ex_ucan/core/utils.ex b/lib/ex_ucan/core/utils.ex
@@ -4,7 +4,15 @@ defmodule ExUcan.Core.Utils do
   """
   @chars "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
 
-  # TODO: docs
+  @doc """
+  Generate random string to use as a nonce
+
+  ## Examples
+      iex> ExUcan.Core.Utils.generate_nonce() |> String.length
+      6
+      iex> ExUcan.Core.Utils.generate_nonce(10) |> String.length
+      10
+  """
   def generate_nonce(len \\ 6)
 
   def generate_nonce(len) do

diff --git a/lib/ex_ucan/keymaterial/ed25519/keypair.ex b/lib/ex_ucan/keymaterial/ed25519/keypair.ex
@@ -27,8 +27,8 @@ defmodule ExUcan.Keymaterial.Ed25519.Keypair do
 
   This keypair can be later used for create UCAN tokens
   """
-  @spec create() :: __MODULE__.t()
-  def create() do
+  @spec create :: __MODULE__.t()
+  def create do
     {pub, priv} = :crypto.generate_key(:eddsa, :ed25519)
 
     %__MODULE__{

diff --git a/test/builder_test.exs b/test/builder_test.exs
@@ -1,7 +1,7 @@
 defmodule BuilderTest do
+  alias ExUcan.Builder
   alias ExUcan.Core.Capability
   alias ExUcan.Core.Structs.UcanPayload
-  alias ExUcan.Builder
   use ExUnit.Case
 
   setup do

diff --git a/test/ex_ucan_test.exs b/test/ex_ucan_test.exs
@@ -1,8 +1,10 @@
 defmodule ExUcanTest do
   alias ExUcan.Builder
+  alias ExUcan.Core.Utils
   alias ExUcan.Keymaterial.Ed25519.Keypair
   use ExUnit.Case
   doctest ExUcan
+  doctest Utils
 
   setup do
     keypair = ExUcan.create_default_keypair()
@@ -26,7 +28,7 @@ defmodule ExUcanTest do
       |> ExUcan.sign(meta.keypair)
       |> ExUcan.encode()
 
-      assert :ok = ExUcan.validate_token(token)
+    assert :ok = ExUcan.validate_token(token)
   end
 
   @tag :exucan
@@ -40,7 +42,7 @@ defmodule ExUcanTest do
       |> ExUcan.sign(meta.keypair)
       |> ExUcan.encode()
 
-      assert {:error, "Ucan token is already expired"} = ExUcan.validate_token(token)
+    assert {:error, "Ucan token is already expired"} = ExUcan.validate_token(token)
   end
 
   @tag :exucan
@@ -50,11 +52,11 @@ defmodule ExUcanTest do
       |> Builder.issued_by(meta.keypair)
       |> Builder.for_audience("did:key:z6MkwDK3M4PxU1FqcSt4quXghquH1MoWXGzTrNkNWTSy2NLD")
       |> Builder.with_expiration((DateTime.utc_now() |> DateTime.to_unix()) + 86_400)
-      |> Builder.not_before((DateTime.utc_now() |> DateTime.to_unix()) + (div(86400, 2)))
+      |> Builder.not_before((DateTime.utc_now() |> DateTime.to_unix()) + div(86_400, 2))
       |> Builder.build!()
       |> ExUcan.sign(meta.keypair)
       |> ExUcan.encode()
 
-      assert {:error, "Ucan token is not yet active"} = ExUcan.validate_token(token)
+    assert {:error, "Ucan token is not yet active"} = ExUcan.validate_token(token)
   end
 end
diff --git a/test/keymaterial/keypair_test.exs b/test/keymaterial/keypair_test.exs
@@ -1,6 +1,6 @@
 defmodule Keymaterial.KeypairTest do
-  alias ExUcan.Keymaterial.Ed25519.Keypair
   alias ExUcan.Keymaterial
+  alias ExUcan.Keymaterial.Ed25519.Keypair
   use ExUnit.Case
 
   test "creating edDSA keypair" do