avocado 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e32ef0766b1e70a3d4946f2d512acc59e5fe7d08e7166a751dbb3e5eacc35b41
-  data.tar.gz: a822265796d94d9e5d4174894f6a7dea7bf7d845d0ac78eb65686a4ecab7f3cd
+  metadata.gz: '04228885896e7d922d727e6497a22a933f3910c96afad40b69bd21d209ab4a3c'
+  data.tar.gz: 8a71cb118b5d97513f506d44ee5b2e01a0af5747d9e8151c9d866a589565d660
 SHA512:
-  metadata.gz: 4f3c42f3873e26eec8f11047b5fd5bbf885ccc4dd350aea52f872b3d869dd19917ff24c71a0989fbf1d7a547388a0ddd578ea0cb05eaacb12b8d6962cfb99af7
-  data.tar.gz: f3b23cc9b7df23daabe61e9143aea880bd4183b47126c5bea515df271896c42498513add9776eff8c73302f95c3f6097f5acbc9ff360f9c77508817bf1cb56c9
+  metadata.gz: 6ff80323ec0979cbfecaa008f7cca93a73c7e2e82df4ac5590caae93de5b3b903c9fc724ab8508c50d70299d118df94718d6c22d00b0f990798a0a3544091a7f
+  data.tar.gz: d39393b42cfc22511acecaceacce2dc345a65a1500fe3071c7b69f11876f479eb48d9d03beee052a0518b485da2ded599b6fe919454df7bb547a4e2d3ac67664

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [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
+- Normalize email value during save
+- Validate password format and length
+- Include a token generator for password recovery
+- Rename `Avocado::UserConcern` to `Avocado::User`
+
 ## [0.1.0] - 2023-07-14
 
 - Initial release

data/README.md

@@ -15,18 +15,31 @@ Without bundler, install the gem by executing:
 ## Usage
 
 If you have a `User` model in your application and are nervous about using Rails
-features directly, preferring to consume the features via a packaged gem, you
-can use the Rails `has_secure_password` feature in a more convoluted way, by
-adding the `Avocado::UserConcern` to your `User` model:
+features directly, preferring to consume the features via a packaged gem, add
+the `Avocado::User` to your `User` model:
 
 ```ruby
 class User < ApplicationRecord
-  include Avocado::UserConcern
+  include Avocado::User
 end
 ```
 
-Note that behind the scenes this is truly just calling `has_secure_password` for
-you and doing nothing else. It's sort of funny to do this.
+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 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
 

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Avocado
+  module User
+    extend ActiveSupport::Concern
+
+    included do
+      include UserEmail
+      include UserEmailAffirmation
+      include UserEmailVerification
+      include UserPassword
+      include UserPasswordReset
+    end
+  end
+end

data/lib/avocado/user_email.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Avocado
+  module UserEmail
+    extend ActiveSupport::Concern
+
+    included do
+      validates :email, presence: true, uniqueness: true, format: {with: URI::MailTo::EMAIL_REGEXP}
+
+      normalizes :email, with: ->(email) { email.downcase.strip }
+    end
+  end
+end

data/lib/avocado/{user_concern.rb → user_email_affirmation.rb}

@@ -3,11 +3,13 @@
 require "active_support/concern"
 
 module Avocado
-  module UserConcern
+  module UserEmailAffirmation
     extend ActiveSupport::Concern
 
+    TOKEN_EXPIRATION = 16.minutes
+
     included do
-      has_secure_password
+      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.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Avocado
+  module UserPassword
+    extend ActiveSupport::Concern
+
+    REQUIRED_FORMAT = /\A(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9]).*\z/x
+    REQUIRED_LENGTH = 8
+
+    included do
+      has_secure_password
+
+      validates :password, format: {with: REQUIRED_FORMAT}, length: {minimum: REQUIRED_LENGTH}, allow_nil: true
+    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.1.0"
+  VERSION = "0.3.0"
 end

data/lib/avocado.rb

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
 
 require_relative "avocado/version"
-require_relative "avocado/user_concern"
 
 module Avocado
   class Error < StandardError; end
+
+  autoload :Mailer, "avocado/mailer"
+  autoload :User, "avocado/user"
+  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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Jankowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -82,7 +82,13 @@ files:
 - Rakefile
 - config.ru
 - lib/avocado.rb
-- lib/avocado/user_concern.rb
+- lib/avocado/mailer.rb
+- lib/avocado/user.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