avocado 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b2bf2a8946882c7f2c799f8f545f34d3d34c6d3a64a932258350e57b32fdabe
-  data.tar.gz: 0f2430fff76f6912de3b1f09d08ab9b12858fa245e278e5542341eddfe116314
+  metadata.gz: '04228885896e7d922d727e6497a22a933f3910c96afad40b69bd21d209ab4a3c'
+  data.tar.gz: 8a71cb118b5d97513f506d44ee5b2e01a0af5747d9e8151c9d866a589565d660
 SHA512:
-  metadata.gz: 547b8e2c1e35508a75828c4f735b021c1022fe6e9e70f4a41c33dbb2d823592ff86d65732475c72fb3ee5cac0a3bed3f74c1fc12521b4344cc743313b6ed922c
-  data.tar.gz: 016be93303ef00a75c3e7a63e2a1d030f2955eb7eaf92d80ab03fed4704da6fecc5b194d6a73e567e524087063dd2b1e947799fd5f0f338eba20a6f25f585831
+  metadata.gz: 6ff80323ec0979cbfecaa008f7cca93a73c7e2e82df4ac5590caae93de5b3b903c9fc724ab8508c50d70299d118df94718d6c22d00b0f990798a0a3544091a7f
+  data.tar.gz: d39393b42cfc22511acecaceacce2dc345a65a1500fe3071c7b69f11876f479eb48d9d03beee052a0518b485da2ded599b6fe919454df7bb547a4e2d3ac67664

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.3.0] - 2023-07-17
+
+- Add an `Avocado::Mailer` which generates each of the signed ids
+- Rename `password_recovery` to `password_reset`
+
 ## [0.2.0] - 2023-07-15
 
 - Validate presence, uniqueness, and format on `email` attribute

data/README.md

@@ -29,11 +29,18 @@ This will do a few things behind the scenes:
 - Use the built-in `has_secure_password` to generate relevant password methods
 - Add some basic validations for the `email` and `password` fields on `User`
 - Normalize email values when records are saved
-- Provide a token generator for password recovery
+- Provide signed token generators for `password_reset`, `email_verification`,
+  and `email_affirmation`
 
 It's sort of funny to do this because you genuinely just could have put this
 stuff right in your app, and yet here we are making gems instead!
 
+There is an `Avocado::Mailer` which can be included in a mailer class and
+provides some basic mailers.
+
+The `spec/internal` app within this repo has some example usage of both model
+and mailer.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/avocado/mailer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Avocado
+  module Mailer
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_user
+      before_action :set_signed_id
+
+      default to: -> { @user.email }
+    end
+
+    def email_affirmation
+      mail
+    end
+
+    def email_verification
+      mail
+    end
+
+    def password_reset
+      mail
+    end
+
+    private
+
+    def set_user
+      @user = params[:user]
+    end
+
+    def set_signed_id
+      @signed_id = @user.generate_token_for(action_name.to_sym)
+    end
+  end
+end

data/lib/avocado/user.rb

@@ -7,8 +7,11 @@ module Avocado
     extend ActiveSupport::Concern
 
     included do
-      include UserEmailConcern
-      include UserPasswordConcern
+      include UserEmail
+      include UserEmailAffirmation
+      include UserEmailVerification
+      include UserPassword
+      include UserPasswordReset
     end
   end
 end

data/lib/avocado/{user_email_concern.rb → user_email.rb}

@@ -3,7 +3,7 @@
 require "active_support/concern"
 
 module Avocado
-  module UserEmailConcern
+  module UserEmail
     extend ActiveSupport::Concern
 
     included do

data/lib/avocado/user_email_affirmation.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Avocado
+  module UserEmailAffirmation
+    extend ActiveSupport::Concern
+
+    TOKEN_EXPIRATION = 16.minutes
+
+    included do
+      generates_token_for :email_affirmation, expires_in: TOKEN_EXPIRATION
+    end
+  end
+end

data/lib/avocado/user_email_verification.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Avocado
+  module UserEmailVerification
+    extend ActiveSupport::Concern
+
+    TOKEN_EXPIRATION = 2_048.minutes
+
+    included do
+      generates_token_for :email_verification, expires_in: TOKEN_EXPIRATION do
+        email
+      end
+    end
+  end
+end

data/lib/avocado/{user_password_concern.rb → user_password.rb}

@@ -3,27 +3,16 @@
 require "active_support/concern"
 
 module Avocado
-  module UserPasswordConcern
+  module UserPassword
     extend ActiveSupport::Concern
 
     REQUIRED_FORMAT = /\A(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9]).*\z/x
     REQUIRED_LENGTH = 8
-    TOKEN_EXPIRATION = 64.minutes
 
     included do
       has_secure_password
 
       validates :password, format: {with: REQUIRED_FORMAT}, length: {minimum: REQUIRED_LENGTH}, allow_nil: true
-
-      generates_token_for :password_recovery, expires_in: TOKEN_EXPIRATION do
-        password_digest_salt
-      end
-    end
-
-    private
-
-    def password_digest_salt
-      BCrypt::Password.new(password_digest).salt[-10..]
     end
   end
 end

data/lib/avocado/user_password_reset.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Avocado
+  module UserPasswordReset
+    extend ActiveSupport::Concern
+
+    TOKEN_EXPIRATION = 64.minutes
+
+    included do
+      generates_token_for :password_reset, expires_in: TOKEN_EXPIRATION do
+        password_digest_salt
+      end
+    end
+
+    private
+
+    def password_digest_salt
+      password_from_digest.salt[-10..]
+    end
+
+    def password_from_digest
+      BCrypt::Password.new(password_digest)
+    end
+  end
+end

data/lib/avocado/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Avocado
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/avocado.rb

@@ -5,7 +5,11 @@ require_relative "avocado/version"
 module Avocado
   class Error < StandardError; end
 
+  autoload :Mailer, "avocado/mailer"
   autoload :User, "avocado/user"
-  autoload :UserEmailConcern, "avocado/user_email_concern"
-  autoload :UserPasswordConcern, "avocado/user_password_concern"
+  autoload :UserEmail, "avocado/user_email"
+  autoload :UserEmailAffirmation, "avocado/user_email_affirmation"
+  autoload :UserEmailVerification, "avocado/user_email_verification"
+  autoload :UserPassword, "avocado/user_password"
+  autoload :UserPasswordReset, "avocado/user_password_reset"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avocado
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Jankowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-15 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -82,9 +82,13 @@ files:
 - Rakefile
 - config.ru
 - lib/avocado.rb
+- lib/avocado/mailer.rb
 - lib/avocado/user.rb
-- lib/avocado/user_email_concern.rb
-- lib/avocado/user_password_concern.rb
+- lib/avocado/user_email.rb
+- lib/avocado/user_email_affirmation.rb
+- lib/avocado/user_email_verification.rb
+- lib/avocado/user_password.rb
+- lib/avocado/user_password_reset.rb
 - lib/avocado/version.rb
 - sig/avocado.rbs
 homepage: https://github.com/unicorngroomers/avocado