foobara-auth 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8974dadf886b62fb510f52275ee227a95d74e1fe57b3f8b1fff7242efa3b0949
-  data.tar.gz: 01df20b29400198bf1ffa231586a4f6472748d166598ab088a49b3c116ccb236
+  metadata.gz: 1aa9644452f2df69c840be3976c4ea0c9b4d7af09ae432a20c98bdb71f87393e
+  data.tar.gz: f28a748760a24e913af0f53d47be631aaaa93394e5747978f2cd22f42048bd3b
 SHA512:
-  metadata.gz: ebbbfd838051b025b66fd40cd324db2037de76a7ea86f72630269697e262071dc4551f0039d2646fffe7a774b38c798c38728d369790b208a7e61eab353566ca
-  data.tar.gz: 7c14f7e424f2ed8e803d94c402a74b971f4dd641cfabba5fc49b0a155d13f6ad6eb6b086582e4ac2f22dea8c76b7d81fb597a0c72ca0fc91f744f6564fb54d4f
+  metadata.gz: dad7b1b7193abe3753b6d7f592a1b2fcd5c7c9b229c5025dbc3ecffb645c97c195eb6199a410a9b49fd70e032c05349d298b3fd153a78bebee9862df5da64ff1
+  data.tar.gz: 04a75cf7418015a6399442c2b0cd6244cfd1410b747f49adaa2ca7cf5da03f8c511b4c8caa38bfdf4d849c1edfb5cb270a2edac685475d0185dd0917bee5394c

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.0.7] - 2025-03-31
+
+- Support creating a user with a specific user_id
+
+## [0.0.6] - 2025-03-31
+
+- Add Logout command
+- DRY up Login/RefreshLogin
+
 ## [0.0.5] - 2025-03-29
 
 - Fix bug duplicating refresh tokens

data/src/build_access_token.rb

@@ -0,0 +1,46 @@
+require "jwt"
+
+module Foobara
+  module Auth
+    class BuildAccessToken < Foobara::Command
+      inputs do
+        user Types::User, :allow_nil
+        token_ttl :integer, default: 30 * 60
+      end
+
+      result :string, :sensitive_exposed
+
+      def execute
+        determine_timestamps
+        generate_access_token
+
+        access_token
+      end
+
+      attr_accessor :access_token, :expires_at
+
+      def determine_timestamps
+        now = Time.now
+        self.expires_at = now + token_ttl
+      end
+
+      def generate_access_token
+        payload = { sub: user.id, exp: expires_at.to_i }
+
+        self.access_token = JWT.encode(payload, jwt_secret, "HS256")
+      end
+
+      def jwt_secret
+        jwt_secret_text = ENV.fetch("JWT_SECRET", nil)
+
+        unless jwt_secret_text
+          # :nocov:
+          raise "You must set the JWT_SECRET environment variable"
+          # :nocov:
+        end
+
+        jwt_secret_text
+      end
+    end
+  end
+end

data/src/create_refresh_token.rb

@@ -0,0 +1,51 @@
+require "securerandom"
+
+require_relative "create_token"
+
+module Foobara
+  module Auth
+    class CreateRefreshToken < Foobara::Command
+      depends_on CreateToken
+
+      inputs do
+        user Types::User
+        token_ttl :integer, default: 30 * 60
+      end
+
+      result :string, :sensitive_exposed
+
+      def execute
+        determine_timestamps
+        determine_token_group
+
+        generate_new_refresh_token
+        save_new_refresh_token_on_user
+
+        refresh_token_secret
+      end
+
+      attr_accessor :expires_at, :refresh_token_record, :token_group, :refresh_token_secret
+
+      def determine_timestamps
+        now = Time.now
+        self.expires_at = now + token_ttl
+      end
+
+      def determine_token_group
+        self.token_group = refresh_token_record&.token_group || SecureRandom.uuid
+      end
+
+      def generate_new_refresh_token
+        result = run_subcommand!(CreateToken, expires_at:, token_group:)
+
+        self.refresh_token_record = result[:token_record]
+        self.refresh_token_secret = result[:token_string]
+      end
+
+      def save_new_refresh_token_on_user
+        # TODO: maybe override #<< on these objects to dirty the entity??
+        user.refresh_tokens = [refresh_token_record, *user.refresh_tokens]
+      end
+    end
+  end
+end

data/src/create_user.rb

@@ -4,6 +4,7 @@ module Foobara
       inputs Types::User.attributes_for_create
 
       add_inputs do
+        user_id :integer, :allow_nil
         plaintext_password :string, :sensitive_exposed
       end
 
@@ -24,7 +25,13 @@ module Foobara
       attr_accessor :user
 
       def create_user
-        self.user = Types::User.create(inputs.except(:plaintext_password))
+        inputs = self.inputs.except(:user_id, :plaintext_password)
+
+        if user_id
+          inputs[:id] = user_id
+        end
+
+        self.user = Types::User.create(inputs)
       end
 
       def password_present?

data/src/login.rb

@@ -1,10 +1,3 @@
-require "jwt"
-require "securerandom"
-
-require_relative "create_token"
-require_relative "verify_password"
-require_relative "verify_token"
-
 module Foobara
   module Auth
     class Login < Foobara::Command
@@ -18,7 +11,7 @@ module Foobara
         message "No user id, email, or username given"
       end
 
-      depends_on CreateToken, VerifyPassword, FindUser
+      depends_on VerifyPassword, FindUser, BuildAccessToken, CreateRefreshToken
 
       inputs do
         user Types::User, :allow_nil
@@ -39,17 +32,13 @@ module Foobara
       def execute
         find_user_to_login
         verify_password
-        # TODO: DRY these 5 up
-        determine_timestamps
         generate_access_token
-        determine_token_group
         generate_new_refresh_token
-        save_new_refresh_token_on_user
 
         tokens
       end
 
-      attr_accessor :access_token, :new_refresh_token, :now, :expires_at, :token_group, :user_to_login
+      attr_accessor :access_token, :refresh_token_text, :user_to_login
 
       def find_user_to_login
         if user
@@ -83,46 +72,18 @@ module Foobara
         end
       end
 
-      def determine_timestamps
-        self.now = Time.now
-        self.expires_at = now + token_ttl
-      end
-
       def generate_access_token
-        payload = { sub: user_to_login.id, exp: expires_at.to_i }
-
-        self.access_token = JWT.encode(payload, jwt_secret, "HS256")
-      end
-
-      def jwt_secret
-        jwt_secret_text = ENV.fetch("JWT_SECRET", nil)
-
-        unless jwt_secret_text
-          # :nocov:
-          raise "You must set the JWT_SECRET environment variable"
-          # :nocov:
-        end
-
-        jwt_secret_text
-      end
-
-      def determine_token_group
-        self.token_group = SecureRandom.uuid
+        self.access_token = run_subcommand!(BuildAccessToken, user: user_to_login)
       end
 
       def generate_new_refresh_token
-        self.new_refresh_token = run_subcommand!(CreateToken, expires_at:, token_group:)
-      end
-
-      def save_new_refresh_token_on_user
-        # TODO: maybe override #<< on these objects to dirty the entity??
-        user_to_login.refresh_tokens = [new_refresh_token[:token_record], *user_to_login.refresh_tokens]
+        self.refresh_token_text = run_subcommand!(CreateRefreshToken, user: user_to_login)
       end
 
       def tokens
         {
           access_token:,
-          refresh_token: new_refresh_token[:token_string]
+          refresh_token: refresh_token_text
         }
       end
     end

data/src/logout.rb

@@ -0,0 +1,61 @@
+module Foobara
+  module Auth
+    class Logout < Foobara::Command
+      class InvalidRefreshTokenError < Foobara::RuntimeError
+        context refresh_token_id: :string
+        message "Invalid refresh token"
+      end
+
+      depends_on VerifyToken
+      depends_on_entity Types::Token
+      depends_on_entity Types::User
+
+      inputs do
+        refresh_token :string, :allow_nil
+      end
+
+      # TODO: support nil result type in typescript remote command generator
+      result :duck
+
+      def execute
+        if refresh_token?
+          determine_refresh_token_id_and_secret
+          load_refresh_token_record
+          verify_refresh_token
+          # Delete it instead maybe?
+          mark_refresh_token_as_used
+        end
+
+        nil
+      end
+
+      attr_accessor :refresh_token_record, :refresh_token_id, :refresh_token_secret
+
+      def refresh_token?
+        !!refresh_token
+      end
+
+      def determine_refresh_token_id_and_secret
+        self.refresh_token_id, self.refresh_token_secret = refresh_token.split("_")
+      end
+
+      def load_refresh_token_record
+        self.refresh_token_record = Types::Token.load(refresh_token_id)
+      end
+
+      def verify_refresh_token
+        valid = run_subcommand!(VerifyToken, token_string: refresh_token)
+
+        unless valid[:verified]
+          # :nocov:
+          add_runtime_error(InvalidRefreshTokenError.new(context: { refresh_token_id: }))
+          # :nocov:
+        end
+      end
+
+      def mark_refresh_token_as_used
+        refresh_token_record.use_up!
+      end
+    end
+  end
+end

data/src/refresh_login.rb

@@ -1,9 +1,3 @@
-require "jwt"
-require "securerandom"
-
-require_relative "create_token"
-require_relative "verify_token"
-
 module Foobara
   module Auth
     class RefreshLogin < Foobara::Command
@@ -17,13 +11,12 @@ module Foobara
         message "This refresh token is not owned by this user"
       end
 
-      depends_on CreateToken, VerifyToken
+      depends_on CreateRefreshToken, VerifyToken, BuildAccessToken
       depends_on_entities Types::Token
 
       inputs do
         refresh_token :string, :required, :sensitive
-        # Can we get these TTLs off of the refresh token?
-        token_ttl :integer, default: 30 * 60
+        access_token_ttl :integer, default: 30 * 60
         refresh_token_ttl :integer, default: 7 * 24 * 60 * 60
       end
 
@@ -38,18 +31,15 @@ module Foobara
         verify_refresh_token
         # Delete it instead maybe?
         mark_refresh_token_as_used
-        determine_timestamps
-        determine_token_group
 
         generate_access_token
         generate_new_refresh_token
-        save_new_refresh_token_on_user
 
         tokens
       end
 
-      attr_accessor :access_token, :new_refresh_token, :now, :expires_at, :refresh_token_record,
-                    :refresh_token_id, :refresh_token_secret, :token_group
+      attr_accessor :access_token, :new_refresh_token, :expires_at, :refresh_token_record,
+                    :refresh_token_id, :refresh_token_secret
 
       def determine_refresh_token_id_and_secret
         self.refresh_token_id, self.refresh_token_secret = refresh_token.split("_")
@@ -71,55 +61,22 @@ module Foobara
         refresh_token_record.use_up!
       end
 
-      def determine_timestamps
-        self.now = Time.now
-        self.expires_at = now + token_ttl
-      end
-
       def generate_access_token
-        payload = {
-          user_id: user.id,
-          username: user.username,
-          exp: expires_at.to_i
-        }
-
-        self.access_token = JWT.encode(payload, jwt_secret, "HS256")
+        self.access_token = run_subcommand!(BuildAccessToken, user:, token_ttl: access_token_ttl)
       end
 
       def user
         @user ||= Types::User.that_owns(refresh_token_record, "refresh_tokens")
       end
 
-      def jwt_secret
-        jwt_secret_text = ENV.fetch("JWT_SECRET", nil)
-
-        unless jwt_secret_text
-          # :nocov:
-          raise "You must set the JWT_SECRET environment variable"
-          # :nocov:
-        end
-
-        jwt_secret_text
-      end
-
-      def determine_token_group
-        self.token_group = refresh_token_record&.token_group || SecureRandom.uuid
-      end
-
       def generate_new_refresh_token
-        self.new_refresh_token = run_subcommand!(CreateToken, expires_at:, token_group:)
-      end
-
-      def save_new_refresh_token_on_user
-        # TODO: maybe override #<< on these objects to dirty the entity??
-        # TODO: DRY this up!!
-        user.refresh_tokens = [new_refresh_token[:token_record], *user.refresh_tokens]
+        self.new_refresh_token = run_subcommand!(CreateRefreshToken, user:, token_ttl: refresh_token_ttl)
       end
 
       def tokens
         {
           access_token:,
-          refresh_token: new_refresh_token[:token_string]
+          refresh_token: new_refresh_token
         }
       end
     end

data/src/register.rb

@@ -6,6 +6,7 @@ module Foobara
       depends_on CreateUser, SetPassword
 
       inputs do
+        user_id :integer, :allow_nil
         username :string, :required
         email :email, :allow_nil
         plaintext_password :string, :allow_nil, :sensitive_exposed
@@ -26,7 +27,13 @@ module Foobara
       attr_accessor :user
 
       def create_user
-        self.user = run_subcommand!(CreateUser, username:, email:)
+        inputs = { username:, email: }
+
+        if user_id
+          inputs[:user_id] = user_id
+        end
+
+        self.user = run_subcommand!(CreateUser, inputs)
       end
 
       def password?

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara-auth
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-03-30 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: argon2
@@ -64,13 +64,16 @@ files:
 - README.md
 - lib/foobara/auth.rb
 - src/approve_token.rb
+- src/build_access_token.rb
 - src/build_secret.rb
 - src/create_api_key.rb
+- src/create_refresh_token.rb
 - src/create_role.rb
 - src/create_token.rb
 - src/create_user.rb
 - src/find_user.rb
 - src/login.rb
+- src/logout.rb
 - src/refresh_login.rb
 - src/register.rb
 - src/set_password.rb