propel_authentication 0.1.1

data/lib/generators/propel_auth/install_generator.rb

@@ -0,0 +1,486 @@
+require 'rails/generators/base'
+require 'rails/generators/active_record'
+require_relative 'unpack_generator'
+##
+# PropelAuth installer that provides JWT-based authentication for Rails applications
+#
+# This creates a COMPLETELY STANDALONE authentication system with no gem dependencies.
+# Usage:
+#   rails generate propel_auth:install    # Full standalone system (runtime + generators)
+#
+# This generator:
+# 1. Installs all runtime code (models, controllers, views, tests, etc.)
+# 2. Automatically extracts generator logic to lib/generators/propel_auth/
+# 3. Creates a system that requires NO gem dependencies
+# 
+# After installation, you can remove 'propel_auth' from your Gemfile completely.
+# All code is in your application and fully customizable.
+#
+# Like Rails' built-in generators (action_text:install, devise:install),
+# this generator is designed to be run once per application.
+#
+module PropelAuth
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+    include Rails::Generators::Migration
+
+    def self.next_migration_number(dir)
+      ActiveRecord::Generators::Base.next_migration_number(dir)
+    end
+
+    desc "Generate JWT-based authentication system with complete test coverage"
+    
+    class_option :api_version, type: :string, default: nil,
+                 desc: "Generate API versioned routes with specified version (e.g., --api-version=v2 creates /api/v2/auth/*)"
+    
+    def copy_jwt_initializer
+      copy_file "propel_auth.rb", "config/initializers/propel_auth.rb"
+    end
+
+    def copy_propel_auth_runtime
+      copy_file "lib/propel_auth.rb", "lib/propel_auth.rb"
+    end
+
+    def copy_authentication_models
+      copy_file "user.rb", "app/models/user.rb"
+      copy_file "organization.rb", "app/models/organization.rb"  
+      copy_file "agency.rb", "app/models/agency.rb"
+      copy_file "agent.rb", "app/models/agent.rb"
+      copy_file "invitation.rb", "app/models/invitation.rb"
+    end
+
+    def copy_authentication_concerns
+      copy_file "authenticatable.rb", "app/models/concerns/authenticatable.rb"
+      copy_file "concerns/lockable.rb", "app/models/concerns/lockable.rb"
+      copy_file "concerns/recoverable.rb", "app/models/concerns/recoverable.rb"
+      copy_file "concerns/confirmable.rb", "app/models/concerns/confirmable.rb"
+      copy_file "concerns/propel_authentication.rb", "app/controllers/concerns/propel_authentication.rb"
+      copy_file "concerns/rack_session_disable.rb", "app/controllers/concerns/rack_session_disable.rb"
+    end
+
+    def copy_jwt_controllers
+      if api_versioned?
+        template "auth/base_tokens_controller.rb.tt", "app/controllers/api/auth/base_tokens_controller.rb"
+        template "auth/base_passwords_controller.rb.tt", "app/controllers/api/auth/base_passwords_controller.rb"
+        create_versioned_controller(api_version, 'tokens', controller_directory)
+        create_versioned_controller(api_version, 'passwords', controller_directory)
+      else
+        template "tokens_controller.rb.tt", "#{controller_directory}/tokens_controller.rb"
+        template "auth/passwords_controller.rb.tt", "#{controller_directory}/passwords_controller.rb"
+      end
+    end
+
+    def copy_email_infrastructure
+      copy_file "auth_mailer.rb", "app/mailers/auth_mailer.rb"
+      copy_file "services/auth_notification_service.rb", "app/services/auth_notification_service.rb"
+      copy_file "config/environments/development_email.rb", "config/environments/development_email.rb"
+      
+      # Email view templates
+      %w[password_reset account_unlock user_invitation email_confirmation].each do |template|
+        copy_file "views/auth_mailer/#{template}.html.erb", "app/views/auth_mailer/#{template}.html.erb"
+        copy_file "views/auth_mailer/#{template}.text.erb", "app/views/auth_mailer/#{template}.text.erb"
+      end
+    end
+
+    def copy_authentication_tests
+      template "user_test.rb.tt", "test/models/user_test.rb"
+      template "test/controllers/auth/tokens_controller_test.rb.tt", "test/controllers/auth/tokens_controller_test.rb"
+      template "test/mailers/auth_mailer_test.rb.tt", "test/mailers/auth_mailer_test.rb"
+      copy_file "test/mailers/previews/auth_mailer_preview.rb", "test/mailers/previews/auth_mailer_preview.rb"
+    end
+
+    def copy_concern_tests
+      template "test/concerns/propel_authentication_test.rb.tt", "test/concerns/propel_authentication_test.rb"
+      template "test/concerns/lockable_test.rb.tt", "test/concerns/lockable_test.rb"
+      template "test/concerns/recoverable_test.rb.tt", "test/concerns/recoverable_test.rb"
+      template "test/concerns/confirmable_test.rb.tt", "test/concerns/confirmable_test.rb"
+      template "test/controllers/auth/lockable_integration_test.rb.tt", "test/controllers/auth/lockable_integration_test.rb"
+      template "test/controllers/auth/password_reset_integration_test.rb.tt", "test/controllers/auth/password_reset_integration_test.rb"
+    end
+
+    def copy_test_fixtures
+      create_file "test/fixtures/organizations.yml", organizations_fixture
+      create_file "test/fixtures/users.yml", users_fixture
+      create_file "test/fixtures/agencies.yml", agencies_fixture
+      create_file "test/fixtures/agents.yml", agents_fixture
+      create_file "test/fixtures/invitations.yml", invitations_fixture
+    end
+
+    def add_authentication_gems
+      add_gem_if_missing('bcrypt', '~> 3.1.20')
+      add_gem_if_missing('jwt', '~> 2.7')
+      add_gem_if_missing('letter_opener', '~> 1.8', group: :development)
+    end
+
+    def add_authentication_routes
+      route generate_routes_content
+    end
+    
+    def copy_authentication_migrations
+      %w[organizations users agencies agents invitations].each do |table|
+        unless migration_exists?("create_#{table}")
+          migration_template "db/migrate/create_#{table}.rb", "db/migrate/create_#{table}.rb"
+        end
+      end
+    end
+
+    def copy_database_seeds
+      copy_file "db/seeds.rb", "db/seeds.rb"
+    end
+
+    def extract_generator_for_customization
+      generator_path = "lib/generators/propel_auth"
+      
+      if File.exist?(generator_path)
+        say ""
+        say "📦 Generator logic already extracted at #{generator_path}/", :blue
+        say "💡 Skipping extraction to preserve your customizations", :cyan
+      else
+        say ""
+        say "📦 Extracting generator logic for full customization...", :blue
+        
+        # Automatically run the unpack generator to extract generator logic
+        invoke PropelAuth::UnpackGenerator, [], { force: false }
+        
+        say ""
+        say "✅ Generator logic extracted to lib/generators/propel_auth/", :green
+        say "💡 Your application is now completely standalone - no gem dependency needed for generators!", :cyan
+        say "🗑️  You can now remove 'propel_auth' from your Gemfile", :yellow
+      end
+    end
+
+    def show_setup_complete_message
+      say "\n🚀 JWT Authentication System Generated Successfully!", :green
+      
+      say "\n📦 System Status: Completely standalone - no gem dependency!", :green
+      say "\nNext steps:", :yellow
+      say "• Run: rails db:migrate", :blue
+      say "• Run: rails test", :blue
+      say "• Optional: Remove 'propel_auth' from Gemfile (system is fully extracted)", :cyan
+      
+      if api_versioned?
+        say "• Routes: /#{api_namespace}/auth/*", :blue
+        say "• Controllers: #{controller_namespace}::*", :blue
+      else
+        say "• Routes: /auth/*", :blue
+        say "• Controllers: Auth::*", :blue
+      end
+      
+      say "\n🎨 Customization:", :bold
+      say "• Generator logic: lib/generators/propel_auth/install_generator.rb", :blue
+      say "• Templates: lib/generators/propel_auth/templates/", :blue
+      say "• Modify any part of the system - it's all yours now!", :cyan
+      
+      say "\n🗑️  To uninstall: rails destroy propel_auth:install", :yellow
+    end
+
+    private
+
+    # Helper methods for API versioning
+    def api_versioned?
+      options[:api_version].present?
+    end
+    
+    def api_version
+      options[:api_version] || 'v1'
+    end
+    
+    def api_namespace
+      "api/#{api_version}"
+    end
+    
+    def api_namespace_parts
+      api_namespace.split('/')
+    end
+    
+    def controller_namespace
+      if api_versioned?
+        api_namespace_parts.map(&:camelize).join('::') + '::Auth'
+      else
+        'Auth'
+      end
+    end
+    
+    def controller_directory
+      if api_versioned?
+        "app/controllers/#{api_namespace}/auth"
+      else
+        "app/controllers/auth"
+      end
+    end
+
+    def api_only_app?
+      # Check if this is a Rails API-only application
+      Rails.application.config.respond_to?(:api_only) && Rails.application.config.api_only
+    end
+
+    # Path helper methods for tests
+    def login_path_helper
+      if api_versioned?
+        "'/#{api_namespace}/auth/login'"
+      else
+        "'/auth/login'"
+      end
+    end
+
+    def me_path_helper
+      if api_versioned?
+        "'/#{api_namespace}/auth/me'"
+      else
+        "'/auth/me'"
+      end
+    end
+
+    def logout_path_helper
+      if api_versioned?
+        "'/#{api_namespace}/auth/logout'"
+      else
+        "'/auth/logout'"
+      end
+    end
+
+    def unlock_path_helper
+      if api_versioned?
+        "'/#{api_namespace}/auth/unlock'"
+      else
+        "'/auth/unlock'"
+      end
+    end
+
+    def password_reset_path_helper
+      if api_versioned?
+        "'/#{api_namespace}/auth/reset'"
+      else
+        "'/auth/reset'"
+      end
+    end
+
+    def reset_path_helper
+      password_reset_path_helper
+    end
+
+    def add_gem_if_missing(gem_name, version_requirement = nil, options = {})
+      gemfile_path = File.join(destination_root, 'Gemfile')
+      return unless File.exist?(gemfile_path)
+      
+      gemfile_content = File.read(gemfile_path)
+      
+      # Check if gem is already present (handles various quote styles and spacing)
+      gem_pattern = /gem\s+['"]#{Regexp.escape(gem_name)}['"](?:\s*,\s*['"][^'"]*['"])?/
+      
+      if gemfile_content.match?(gem_pattern)
+        say_status :exists, "gem '#{gem_name}' already in Gemfile", :blue
+        return
+      end
+      
+      # Add the gem using Rails' built-in method
+      if version_requirement && options.any?
+        gem gem_name, version_requirement, options
+      elsif version_requirement
+        gem gem_name, version_requirement
+      else
+        gem gem_name
+      end
+      
+      say_status :gemfile, "gem '#{gem_name}' #{version_requirement}", :green
+    end
+
+    def migration_exists?(migration_name)
+      Dir.glob("#{destination_root}/db/migrate/*_#{migration_name}.rb").any?
+    end
+
+    def generate_routes_content
+      if api_versioned?
+        route_lines = ["# JWT Authentication routes for #{api_namespace}"]
+        
+        # Build nested namespace opening
+        api_namespace_parts.each_with_index do |part, index|
+          indent = "  " * index
+          route_lines << "#{indent}namespace :#{part} do"
+        end
+        
+        # Add auth namespace and routes
+        auth_indent = "  " * api_namespace_parts.length
+        route_lines << "#{auth_indent}namespace :auth do"
+        route_lines << "#{auth_indent}  post 'login', to: 'tokens#create'"
+        route_lines << "#{auth_indent}  get 'me', to: 'tokens#me'"
+        route_lines << "#{auth_indent}  delete 'logout', to: 'tokens#destroy'"
+        route_lines << "#{auth_indent}  post 'unlock', to: 'tokens#unlock'"
+        route_lines << "#{auth_indent}  post 'reset', to: 'passwords#create'"
+        route_lines << "#{auth_indent}  get 'reset', to: 'passwords#show'"
+        route_lines << "#{auth_indent}  patch 'reset', to: 'passwords#update'"
+        route_lines << "#{auth_indent}end"
+        
+        # Build nested namespace closing
+        api_namespace_parts.length.times do |index|
+          indent = "  " * (api_namespace_parts.length - 1 - index)
+          route_lines << "#{indent}end"
+        end
+        
+        route_lines.join("\n")
+      else
+        <<~ROUTES
+          # JWT Authentication routes
+          namespace :auth do
+            post 'login', to: 'tokens#create'
+            get 'me', to: 'tokens#me'
+            delete 'logout', to: 'tokens#destroy'
+            post 'unlock', to: 'tokens#unlock'
+            post 'reset', to: 'passwords#create'
+            get 'reset', to: 'passwords#show'
+            patch 'reset', to: 'passwords#update'
+          end
+        ROUTES
+      end
+    end
+
+    def create_versioned_controller(version, controller_type, directory)
+      case controller_type
+      when 'tokens'
+        controller_content = <<~RUBY
+          # Generated versioned controller for API #{version}
+          class Api::#{version.camelize}::Auth::TokensController < Api::Auth::BaseTokensController
+          end
+        RUBY
+      when 'passwords'
+        controller_content = <<~RUBY
+          # Generated versioned controller for API #{version}
+          class Api::#{version.camelize}::Auth::PasswordsController < Api::Auth::BasePasswordsController
+          end
+        RUBY
+      end
+      
+      create_file "#{directory}/#{controller_type}_controller.rb", controller_content
+    end
+
+    # Fixture content methods
+    def organizations_fixture
+      <<~FIXTURE
+        acme_org:
+          name: "Acme Corporation"
+          website: "https://acme-corp.com"
+          time_zone: "UTC"
+          meta: {}
+          settings: {}
+          created_at: <%= 30.days.ago %>
+          updated_at: <%= 1.day.ago %>
+
+        tech_startup:
+          name: "Tech Startup Inc"
+          website: "https://techstartup.io"
+          time_zone: "America/New_York"
+          meta: {}
+          settings: {}
+          created_at: <%= 15.days.ago %>
+          updated_at: <%= 2.days.ago %>
+      FIXTURE
+    end
+
+    def users_fixture
+      <<~FIXTURE
+        john_user:
+          email_address: "john@example.com"
+          username: "john_doe"
+          first_name: "John"
+          last_name: "Doe"
+          password_digest: "<%= BCrypt::Password.create('password123') %>"
+          organization: acme_org
+          status: "active"
+          confirmed_at: null
+          confirmation_token: "<%= SecureRandom.hex(32) %>"
+          confirmation_sent_at: <%= 1.hour.ago %>
+          created_at: <%= 7.days.ago %>
+          updated_at: <%= 1.day.ago %>
+
+        jane_user:
+          email_address: "jane@example.com"
+          username: "jane_smith"
+          first_name: "Jane"
+          last_name: "Smith"
+          password_digest: "<%= BCrypt::Password.create('password123') %>"
+          organization: tech_startup
+          status: "active"
+          confirmed_at: null
+          failed_login_attempts: 0
+          locked_at: null
+          created_at: <%= 5.days.ago %>
+          updated_at: <%= 1.day.ago %>
+
+        confirmed_user:
+          email_address: "confirmed@example.com"
+          username: "confirmed_user"
+          first_name: "Confirmed"
+          last_name: "User"
+          password_digest: "<%= BCrypt::Password.create('password123') %>"
+          organization: acme_org
+          status: "active"
+          confirmed_at: <%= 7.days.ago %>
+          created_at: <%= 14.days.ago %>
+          updated_at: <%= 1.day.ago %>
+
+        locked_user:
+          email_address: "locked@example.com"
+          username: "locked_user"
+          first_name: "Locked"
+          last_name: "User"
+          password_digest: "<%= BCrypt::Password.create('password123') %>"
+          organization: acme_org
+          status: "active"
+          confirmed_at: <%= 10.days.ago %>
+          failed_login_attempts: 5
+          locked_at: <%= 1.hour.ago %>
+          created_at: <%= 20.days.ago %>
+          updated_at: <%= 1.hour.ago %>
+
+        expired_confirmation_user:
+          email_address: "expired@example.com"
+          username: "expired_user"
+          first_name: "Expired"
+          last_name: "User"
+          password_digest: "<%= BCrypt::Password.create('password123') %>"
+          organization: tech_startup
+          status: "active"
+          confirmed_at: null
+          confirmation_token: "<%= SecureRandom.hex(32) %>"
+          confirmation_sent_at: <%= 25.hours.ago %>
+          created_at: <%= 30.days.ago %>
+          updated_at: <%= 25.hours.ago %>
+      FIXTURE
+    end
+
+    def agencies_fixture
+      <<~FIXTURE
+        marketing_agency:
+          name: "Marketing Solutions"
+          organization: acme_org
+          created_at: <%= 10.days.ago %>
+          updated_at: <%= 2.days.ago %>
+      FIXTURE
+    end
+
+    def agents_fixture
+      <<~FIXTURE
+        marketing_agent:
+          user: john_user
+          agency: marketing_agency
+          role: "manager"
+          created_at: <%= 8.days.ago %>
+          updated_at: <%= 1.day.ago %>
+      FIXTURE
+    end
+
+    def invitations_fixture
+      <<~FIXTURE
+        pending_invitation:
+          email_address: "newuser@example.com"
+          first_name: "New"
+          last_name: "User"
+          organization: acme_org
+          inviter: john_user
+          status: "pending"
+          created_at: <%= 3.days.ago %>
+          updated_at: <%= 3.days.ago %>
+      FIXTURE
+    end
+  end
+end