clavis 0.7.1

data/file_structure.md

@@ -0,0 +1,221 @@
+# Clavis - Proposed File Structure
+
+```
+clavis/
+├── .github/                       # GitHub workflows and templates
+├── bin/                           # Executable files
+│   ├── console                    # Interactive console for development
+│   └── setup                      # Setup script for development
+├── lib/                           # Main code directory
+│   ├── clavis.rb                  # Main entry point
+│   ├── clavis/                    # Core library files
+│   │   ├── version.rb             # Version information
+│   │   ├── configuration.rb       # Configuration management
+│   │   ├── errors.rb              # Custom error classes
+│   │   ├── engine.rb              # Rails engine definition
+│   │   ├── railtie.rb             # Rails integration
+│   │   ├── utils/                 # Utility modules
+│   │   │   ├── secure_token.rb    # Token generation utilities
+│   │   │   ├── uri_helper.rb      # URI manipulation utilities
+│   │   │   └── http_client.rb     # Faraday wrapper
+│   │   ├── models/                # Model-related code
+│   │   │   └── concerns/          # Model concerns
+│   │   │       └── oauth_authenticatable.rb  # User model concern
+│   │   ├── controllers/           # Controller-related code
+│   │   │   └── concerns/          # Controller concerns
+│   │   │       └── authentication.rb  # Authentication controller concern
+│   │   ├── providers/             # Provider implementations
+│   │   │   ├── base.rb            # Abstract provider base class
+│   │   │   ├── google.rb          # Google provider implementation
+│   │   │   ├── github.rb          # GitHub provider implementation
+│   │   │   ├── apple.rb           # Apple provider implementation
+│   │   │   ├── facebook.rb        # Facebook provider implementation
+│   │   │   └── microsoft.rb       # Microsoft provider implementation
+│   │   ├── view_helpers.rb        # View helper methods
+│   │   └── auth_hash.rb           # Auth hash standardization
+│   ├── generators/                # Generator classes
+│   │   └── clavis/                # Namespace for generators
+│   │       ├── install_generator.rb   # Main installation generator
+│   │       ├── controllers_generator.rb # Controller generator
+│   │       ├── views_generator.rb  # Views generator
+│   │       └── templates/          # Templates for generators
+│   │           ├── initializer.rb  # Initializer template
+│   │           ├── migration.rb    # Migration template
+│   │           ├── auth_controller.rb # Controller template
+│   │           ├── sessions_controller.rb # Example sessions controller
+│   │           └── views/          # View templates
+│   │               ├── auth/       # Auth controller views
+│   │               └── providers/  # Provider-specific partials
+│   │                   └── _button.html.erb # Button template
+│   └── assets/                    # Asset files
+│       ├── images/                # Image assets
+│       │   └── clavis/            # Namespace for images
+│       │       └── providers/     # Provider logos
+│       │           ├── google.svg # Google logo
+│       │           ├── github.svg # GitHub logo
+│       │           └── ...        # Other provider logos
+│       └── stylesheets/           # CSS/SCSS files
+│           └── clavis/            # Namespace for stylesheets
+│               ├── buttons.css    # Button styles
+│               └── providers.css  # Provider-specific styles
+├── spec/                          # RSpec tests
+│   ├── clavis_spec.rb             # Main spec file
+│   ├── spec_helper.rb             # Spec configuration
+│   ├── configuration_spec.rb      # Configuration tests
+│   ├── providers/                 # Provider tests
+│   │   ├── base_spec.rb           # Base provider tests
+│   │   ├── google_spec.rb         # Google provider tests
+│   │   └── ...                    # Other provider tests
+│   ├── controllers/               # Controller tests
+│   │   └── concerns/              # Controller concern tests
+│   │       └── authentication_spec.rb # Authentication concern tests
+│   ├── models/                    # Model tests
+│   │   └── concerns/              # Model concern tests
+│   │       └── oauth_authenticatable_spec.rb # User concern tests
+│   ├── view_helpers_spec.rb       # View helper tests
+│   ├── generators/                # Generator tests
+│   │   └── install_generator_spec.rb # Install generator tests
+│   ├── integration/               # Integration tests
+│   │   ├── authorization_flow_spec.rb # Authorization flow tests
+│   │   └── token_exchange_spec.rb # Token exchange tests
+│   └── fixtures/                  # Test fixtures
+│       └── auth_responses/        # Sample auth responses
+│           ├── google.json        # Google auth response
+│           └── ...                # Other provider responses
+├── .gitignore                     # Git ignore file
+├── .rspec                         # RSpec configuration
+├── .rubocop.yml                   # RuboCop configuration
+├── Gemfile                        # Gem dependencies
+├── LICENSE.txt                    # License file
+├── README.md                      # README file
+├── CHANGELOG.md                   # Changelog
+├── Rakefile                       # Rake tasks
+└── clavis.gemspec                 # Gem specification
+```
+
+## Architecture Overview
+
+The Clavis gem follows a modular, object-oriented architecture with clear separation of concerns:
+
+### Core Components
+
+1. **Configuration**
+   - Centralized configuration system
+   - Provider settings management
+   - Default option handling
+
+2. **Provider System**
+   - Abstract base class with common logic
+   - Individual provider implementations that extend the base
+   - Provider-specific quirks isolated to their respective classes
+
+3. **Authentication Flow**
+   - Clean separation between authorization and token exchange
+   - Standardized auth hash format across providers
+   - Secure token handling and validation
+
+4. **Rails Integration**
+   - Rails engine for routes and assets
+   - Controller concerns for authentication logic
+   - Model concerns for user management
+   - View helpers for UI components
+
+### Design Principles
+
+1. **Single Responsibility Principle**
+   - Each class has a singular, well-defined purpose
+   - Concerns are used to share behavior across classes
+
+2. **Open/Closed Principle**
+   - Core architecture is open for extension but closed for modification
+   - New providers can be added without changing existing code
+
+3. **Dependency Inversion**
+   - High-level modules don't depend on low-level implementations
+   - All components depend on abstractions
+
+4. **Composition Over Inheritance**
+   - Limit inheritance chains to where they make sense (providers)
+   - Use composition and concerns for shared functionality
+
+5. **Convention Over Configuration**
+   - Follow Rails conventions where appropriate
+   - Sensible defaults with clear override mechanisms
+
+## Key Class Relationships
+
+```
+Configuration ─┐
+               │
+Provider::Base ┼─── Provider::Google
+               │     Provider::GitHub
+               │     Provider::Apple
+               │     ...
+               │
+Controllers::Concerns::Authentication ───┐
+                                         ├─── ApplicationController
+Models::Concerns::OauthAuthenticatable ──┘
+```
+
+## Module Structure
+
+```ruby
+module Clavis
+  # Core functionality
+  class Configuration
+  end
+  
+  class Error < StandardError
+  end
+  
+  # Provider handling
+  module Providers
+    class Base
+    end
+    
+    class Google < Base
+    end
+    
+    # Other providers...
+  end
+  
+  # Rails integration
+  module Controllers
+    module Concerns
+      module Authentication
+      end
+    end
+  end
+  
+  module Models
+    module Concerns
+      module OauthAuthenticatable
+      end
+    end
+  end
+  
+  module ViewHelpers
+  end
+  
+  # Rails engine
+  class Engine < ::Rails::Engine
+  end
+end
+```
+
+## Testing Strategy
+
+1. **Unit Tests**
+   - Individual components tested in isolation
+   - Mocked dependencies
+   - Focus on correctness of logic
+
+2. **Integration Tests**
+   - End-to-end flows
+   - Provider interactions (with stubbed HTTP)
+   - Rails integration
+
+3. **Security Tests**
+   - Token validation
+   - CSRF protection
+   - State parameter security 

data/gemfiles/rails_80.gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "bcrypt"
+gem "debug"
+gem "puma"
+gem "rails", "~> 8.0.0"
+gem "sqlite3", "~> 2.1"
+
+group :development, :test do
+  gem "generator_spec"
+  gem "ostruct"
+  gem "rspec-rails"
+end

data/gemfiles/rails_80.gemfile.lock

@@ -0,0 +1,286 @@
+PATH
+  remote: ..
+  specs:
+    clavis (0.5.0)
+      bigdecimal
+      faraday (~> 2.7)
+      jwt (~> 2.7)
+      mutex_m
+      rails (~> 8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+    actionmailer (8.0.2)
+      actionpack (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.0.2)
+      actionview (= 8.0.2)
+      activesupport (= 8.0.2)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.0.2)
+      actionpack (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.0.2)
+      activesupport (= 8.0.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.3.6)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
+      timeout (>= 0.4.0)
+    activestorage (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activesupport (= 8.0.2)
+      marcel (~> 1.0)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    builder (3.3.0)
+    capybara (3.40.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.11)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    crass (1.0.6)
+    date (3.4.1)
+    debug (1.10.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.6.0)
+    drb (2.2.1)
+    erubi (1.13.1)
+    faraday (2.12.2)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    generator_spec (0.10.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    hashie (5.0.0)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.10.2)
+    jwt (2.10.1)
+      base64
+    logger (1.6.6)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    matrix (0.4.2)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.8)
+    minitest (5.25.5)
+    mutex_m (0.3.0)
+    net-http (0.6.0)
+      uri
+    net-imap (0.5.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.4)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.18.4-arm64-darwin)
+      racc (~> 1.4)
+    omniauth (2.1.3)
+      hashie (>= 3.4.6)
+      rack (>= 2.2.3)
+      rack-protection
+    ostruct (0.6.1)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.3)
+      date
+      stringio
+    public_suffix (6.0.1)
+    puma (6.6.0)
+      nio4r (~> 2.0)
+    racc (1.8.1)
+    rack (3.1.12)
+    rack-protection (4.1.1)
+      base64 (>= 0.1.0)
+      logger (>= 1.6.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (8.0.2)
+      actioncable (= 8.0.2)
+      actionmailbox (= 8.0.2)
+      actionmailer (= 8.0.2)
+      actionpack (= 8.0.2)
+      actiontext (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activemodel (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      bundler (>= 1.15.0)
+      railties (= 8.0.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rake (13.2.1)
+    rdoc (6.12.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.10.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (7.1.1)
+      actionpack (>= 7.0)
+      activesupport (>= 7.0)
+      railties (>= 7.0)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.2)
+    securerandom (0.4.1)
+    sqlite3 (2.6.0)
+      mini_portile2 (~> 2.8.0)
+    sqlite3 (2.6.0-arm64-darwin)
+    stringio (3.1.5)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uri (1.0.3)
+    useragent (0.16.11)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.7.2)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  bigdecimal
+  capybara
+  clavis!
+  debug
+  generator_spec
+  mutex_m
+  omniauth (~> 2.0)
+  ostruct
+  puma
+  rails (~> 8.0.0)
+  rspec (~> 3.0)
+  rspec-rails
+  sqlite3 (~> 2.1)
+
+BUNDLED WITH
+   2.6.6