active_registration 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 577eb04e3f980142f6288405a0115dd072b9e675810d429cb637f40192053067
+  data.tar.gz: 02d8d1944363101ac074fba10c5f4907b045c7c09e18ac480f4684c920acb752
+SHA512:
+  metadata.gz: 1faec3f65120b8f199c864bd8f39187f36c66e4ca3e90ce5d4909afe6c6ca9e6ae84ae853347b99d6dcdfdf7cdbbe33d287348c79f148468f44fa6099a13190d
+  data.tar.gz: 74af47d7e060a06eae18e68ced4c2b206d12f7bfaf760455aa8e71161ec49d64a8da345ab64cdcab32973294747034e500d99d996faaae2cb016ab74d9911850

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Salanoid
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# ActiveRegistration
+
+A drop-in Rails engine that adds secure user registration with email confirmation to your rails 8+ application, that uses Rails Authentication Generator.
+
+## Features
+
+- 🚀 Registration flow (sign up, email confirmation)
+- 📧 Email confirmation with token expiration
+- 🧩 Easy integration with existing User models (from Rails Autehntication Generator)
+- 🎨 Generated views for customization
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "active_registration"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install active_registration
+```
+
+Run the installation generator:
+
+```bash
+rails generate active_registration:install
+```
+
+Apply database migrations:
+```bash
+rails db:migrate
+```
+
+## Configuration
+### Development Environment
+
+Add `letter_opener` to preview emails:
+
+```ruby
+# Gemfile
+gem 'letter_opener', group: :development
+```
+
+Configure mailer settings:
+```ruby
+# config/environments/development.rb
+Rails.application.configure do
+  config.action_mailer.delivery_method = :letter_opener
+  config.action_mailer.default_url_options = { 
+    host: 'localhost', 
+    port: 3000 
+  }
+end
+```
+
+### Production Environment
+
+Configure your SMTP settings:
+
+```ruby
+# config/environments/production.rb
+config.action_mailer.delivery_method = :smtp
+config.action_mailer.smtp_settings = {
+  address:              'smtp.yourprovider.com',
+  port:                 587,
+  user_name:            ENV['SMTP_USER'],
+  password:             ENV['SMTP_PASSWORD'],
+  authentication:       :plain,
+  enable_starttls_auto: true
+}
+```
+
+## Contributing
+Fork the project
+
+Create your feature branch (git checkout -b feature/amazing-feature)
+
+Commit your changes (git commit -m 'Add some amazing feature')
+
+Push to the branch (git push origin feature/amazing-feature)
+
+Open a Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/lib/active_registration/engine.rb

@@ -0,0 +1,4 @@
+module ActiveRegistration
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/active_registration/user_extensions.rb

@@ -0,0 +1,29 @@
+module ActiveRegistration
+  module UserExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      validates :email_address, presence: true, uniqueness: true
+      before_create :generate_confirmation_token
+    end
+
+    def confirm!
+      update(confirmed_at: Time.current, confirmation_token: nil)
+    end
+
+    def confirmed?
+      confirmed_at.present?
+    end
+
+    def confirmation_period_valid?
+      confirmation_sent_at >= 24.hours.ago
+    end
+
+    private
+
+    def generate_confirmation_token
+      self.confirmation_token = SecureRandom.urlsafe_base64
+      self.confirmation_sent_at = Time.current
+    end
+  end
+end

data/lib/active_registration/version.rb

@@ -0,0 +1,3 @@
+module ActiveRegistration
+  VERSION = "0.1.0"
+end

data/lib/active_registration.rb

@@ -0,0 +1,6 @@
+require "active_registration/version"
+require "active_registration/engine"
+
+module ActiveRegistration
+  autoload :UserExtensions, "active_registration/user_extensions"
+end

data/lib/generators/active_registration/install_generator.rb

@@ -0,0 +1,48 @@
+module ActiveRegistration
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path("templates", __dir__)
+
+    def self.next_migration_number(dirname)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def copy_migration
+      migration_template "add_active_registration_fields_to_users.rb", "db/migrate/add_active_registration_fields_to_users.rb"
+    end
+
+    def generate_controller
+      copy_file "registrations_controller.rb", "app/controllers/registrations_controller.rb"
+    end
+
+    def generate_views
+      directory "views/registrations", "app/views/registrations"
+    end
+
+    def add_routes
+      # TODO implement edit and update in the future
+      # resource :registration, only: [:new, :create, :edit, :update] do
+      route <<~ROUTE
+        resource :registration, only: [:new, :create] do
+          get :confirm, on: :collection
+        end
+      ROUTE
+    end
+
+    def generate_mailer
+      copy_file "confirmation_mailer.rb", "app/mailers/confirmation_mailer.rb"
+      directory "views/confirmation_mailer", "app/views/confirmation_mailer"
+    end
+
+    def inject_user_extension
+      user_model_path = "app/models/user.rb"
+      return unless File.exist?(user_model_path)
+
+      inject_into_file user_model_path, after: "class User < ApplicationRecord\n" do
+        "  include ActiveRegistration::UserExtensions\n"
+      end
+    rescue Errno::ENOENT
+      say "User model not found. Add 'include ActiveRegistration::UserExtensions' to your User model.", :yellow
+    end
+  end
+end

data/lib/generators/active_registration/templates/add_active_registration_fields_to_users.rb

@@ -0,0 +1,8 @@
+class AddActiveRegistrationFieldsToUsers < ActiveRecord::Migration[7.0]
+  def change
+    add_column :users, :confirmation_token, :string
+    add_column :users, :confirmed_at, :datetime
+    add_column :users, :confirmation_sent_at, :datetime
+    add_index :users, :confirmation_token, unique: true
+  end
+end

data/lib/generators/active_registration/templates/confirmation_mailer.rb

@@ -0,0 +1,7 @@
+class ConfirmationMailer < ApplicationMailer
+  def confirmation_instructions(user)
+    @user = user
+    @confirmation_url = registration_confirm_url(token: @user.confirmation_token)
+    mail(to: @user.email_address, subject: "Confirm Your Email")
+  end
+end

data/lib/generators/active_registration/templates/registrations_controller.rb

@@ -0,0 +1,32 @@
+class RegistrationsController < ApplicationController
+  def new
+    @user = User.new
+  end
+
+  def create
+    @user = User.new(user_params)
+    if @user.save
+      ConfirmationMailer.confirmation_instructions(@user).deliver_later
+      redirect_to root_path, notice: "Confirmation email sent!"
+    else
+      render :new
+    end
+  end
+
+  def confirm
+    @user = User.find_by(confirmation_token: params[:token])
+
+    if @user&.confirmation_period_valid?
+      @user.confirm!
+      redirect_to root_path, notice: "Email confirmed!"
+    else
+      redirect_to root_path, alert: "Invalid or expired confirmation link"
+    end
+  end
+
+  private
+
+  def user_params
+    params.require(:user).permit(:email_address, :password, :password_confirmation)
+  end
+end

data/lib/generators/active_registration/templates/views/confirmation_mailer/confirmation_instructions.html.erb

@@ -0,0 +1,4 @@
+<h1>Confirm Your Email</h1>
+<%= link_to "Confirm Email", @confirmation_url %>
+Confirm your email:
+<%= @confirmation_url %>

data/lib/generators/active_registration/templates/views/registrations/new.html.erb

@@ -0,0 +1,6 @@
+<%= form_with model: @user, url: registration_path do |form| %>
+  <%= form.email_field :email_address %>
+  <%= form.password_field :password %>
+  <%= form.password_field :password_confirmation %>
+  <%= form.submit "Sign Up" %>
+<% end %>

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: active_registration
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Salanoid
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+description: "A drop-in Rails engine that adds secure user registration with email
+  confirmation to your rails 8+ application, that uses Rails Authentication Generator.\n\n"
+email:
+- salanoid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/active_registration.rb
+- lib/active_registration/engine.rb
+- lib/active_registration/user_extensions.rb
+- lib/active_registration/version.rb
+- lib/generators/active_registration/install_generator.rb
+- lib/generators/active_registration/templates/add_active_registration_fields_to_users.rb
+- lib/generators/active_registration/templates/confirmation_mailer.rb
+- lib/generators/active_registration/templates/registrations_controller.rb
+- lib/generators/active_registration/templates/views/confirmation_mailer/confirmation_instructions.html.erb
+- lib/generators/active_registration/templates/views/registrations/new.html.erb
+homepage: https://rubygems.org/gems/active_registration
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://rubygems.org/gems/active_registration
+  source_code_uri: https://github.com/Salanoid/active_registration
+  changelog_uri: https://github.com/Salanoid/active_registration/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: A simple gem that adds generators for sign up Rails Authentication Generator.
+test_files: []