verify_it 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a41100a91ec8bb6febdc4f760c8b1e2217353e9f606fe95efeae2b8e4ddac027
-  data.tar.gz: 2afcdf2a1588b1e74510a7f1a3c24f61f679a47f9e9ed5e488d98e43f5971f3c
+  metadata.gz: ede88092d9b66d9853d5f03713b719f1bc664eefdfe0cc245140494110bda8a8
+  data.tar.gz: 1da02a88fc2c6262c6386eaac4f63184dad9bfebbd9bb694762a0e050f416aa3
 SHA512:
-  metadata.gz: df9fbe710460044df86b666b7b04258d09ec05afba41eaffb6db80de641a3b6989a224dd67e3aa38a6a4c4a76b52fc98ff99e8fe08b10dd9a5756b5f28542e33
-  data.tar.gz: 88497353ebc57ab8076b38c16d499f7f05052cbdc61f2e2423eb61eecbb555b454adfcebac341add0e3180d879b0856273b7e2a973ba128443d69d5e9f7b9217
+  metadata.gz: 584f310188b429e0e6d77b9ca6c89cd0042b97bae8809b4ae8fad8699863666184fbbdf059c77eaabc5610d37d9355fffbbf9cd238056a06acc83626955f955e
+  data.tar.gz: 41394cf8edff07829dab5beecd3a4d723e8aaa1b89a6e8910095a77f1af3335a1f9988a56c92d5d77585aec2f23e4d683ca1f9ded3e494a2a0f938fc18417e41

data/README.md

@@ -1,6 +1,7 @@
 # VerifyIt
 
-A production-grade, storage-agnostic verification system for Ruby applications. VerifyIt provides a flexible framework for implementing SMS, email, and other verification workflows with built-in rate limiting and multiple storage backends.
+A storage-agnostic verification system for Ruby applications.
+VerifyIt provides a flexible framework for implementing SMS and email verifications with built-in rate limiting and multiple storage backends.
 
 ## Features
 
@@ -10,7 +11,7 @@ A production-grade, storage-agnostic verification system for Ruby applications.
 - **Thread-Safe**: Designed for concurrent access
 - **Test Mode**: Expose codes for testing without delivery
 - **Rails Optional**: Works standalone or with Rails
-- **Zero Runtime Dependencies**: Only ActiveSupport required
+- **Little Runtime Dependencies**: Only ActiveSupport required
 
 ## Installation
 
@@ -51,9 +52,66 @@ If you selected Database storage, run the migration:
 rails db:migrate
 ```
 
-## Quick Start
+# Quick Start
 
-### Basic Configuration
+## Rails Integration
+
+VerifyIt automatically integrates with Rails when detected.
+
+### Model Integration
+
+```ruby
+class User < ApplicationRecord
+  include VerifyIt::Verifiable
+  
+  verifies :phone_number, channel: :sms
+  verifies :email, channel: :email
+end
+
+# Usage
+user = User.find(params[:id])
+
+# Send code (no context needed)
+result = user.send_sms_code
+
+# Send with custom message template
+result = user.send_sms_code(context: { 
+  message_template: "Your #{user.company_name} verification code is: %{code}"
+})
+
+# Send with tracking metadata
+result = user.send_email_code(context: { 
+  ip: request.ip,
+  user_agent: request.user_agent,
+  action: 'password_reset'
+})
+
+# Verify code
+result = user.verify_sms_code(params[:code])
+
+# Cleanup
+user.cleanup_sms_verification
+```
+
+### Rails Configuration
+
+Create an initializer `config/initializers/verify_it.rb`:
+
+```ruby
+VerifyIt.configure do |config|
+  config.storage = :redis
+  config.redis_client = Redis.new(url: ENV['REDIS_URL'])
+  
+  config.sms_sender = ->(to:, code:, context:) {
+    TwilioService.send_sms(to: to, body: "Your code is: #{code}")
+  }
+  
+  config.test_mode = Rails.env.test?
+  config.bypass_delivery = Rails.env.test?
+end
+```
+
+## Plain Ruby Configuration
 
 ```ruby
 require 'verify_it'
@@ -180,7 +238,7 @@ config.storage = :database
 Requires running the migration:
 
 ```bash
-rails generate verify_it:install
+bundle exec verify_it install
 rails db:migrate
 ```
 
@@ -243,63 +301,6 @@ config.test_mode = true           # Includes code in Result object
 config.bypass_delivery = true     # Skip actual delivery
 ```
 
-## Rails Integration
-
-VerifyIt automatically integrates with Rails when detected.
-
-### Model Integration
-
-```ruby
-class User < ApplicationRecord
-  include VerifyIt::Verifiable
-  
-  verifies :phone_number, channel: :sms
-  verifies :email, channel: :email
-end
-
-# Usage
-user = User.find(params[:id])
-
-# Send code (no context needed)
-result = user.send_sms_code
-
-# Send with custom message template
-result = user.send_sms_code(context: { 
-  message_template: "Your #{user.company_name} verification code is: %{code}"
-})
-
-# Send with tracking metadata
-result = user.send_email_code(context: { 
-  ip: request.ip,
-  user_agent: request.user_agent,
-  action: 'password_reset'
-})
-
-# Verify code
-result = user.verify_sms_code(params[:code])
-
-# Cleanup
-user.cleanup_sms_verification
-```
-
-### Rails Configuration
-
-Create an initializer `config/initializers/verify_it.rb`:
-
-```ruby
-VerifyIt.configure do |config|
-  config.storage = :redis
-  config.redis_client = Redis.new(url: ENV['REDIS_URL'])
-  
-  config.sms_sender = ->(to:, code:, context:) {
-    TwilioService.send_sms(to: to, body: "Your code is: #{code}")
-  }
-  
-  config.test_mode = Rails.env.test?
-  config.bypass_delivery = Rails.env.test?
-end
-```
-
 ## Result Object API
 
 All operations return a `VerifyIt::Result` object:

data/lib/verify_it/cli.rb

@@ -37,6 +37,7 @@ module VerifyIt
       puts "=" * 50
       puts
 
+      load_rails_environment
       check_rails_environment
 
       storage_type = prompt_storage_type
@@ -57,6 +58,11 @@ module VerifyIt
       end
     end
 
+    def load_rails_environment
+      env_file = File.join(Dir.pwd, "config", "environment.rb")
+      require env_file if File.exist?(env_file)
+    end
+
     def check_rails_environment
       unless defined?(Rails)
         puts "Error: Rails environment not detected."

data/lib/verify_it/templates/initializer.rb.erb

@@ -1,79 +1,32 @@
 # frozen_string_literal: true
 
 VerifyIt.configure do |config|
-<% if storage_type == "memory" %>
-  # Memory storage (for development/testing only)
-  config.storage = :memory
-<% elsif storage_type == "redis" %>
-  # Redis storage (recommended for production)
+<% if storage_type == "redis" %>
   config.storage = :redis
-  config.redis_client = Redis.new(
-    url: ENV.fetch("REDIS_URL", "redis://localhost:6379/0")
-  )
+  config.redis_client = Redis.new(url: ENV.fetch("REDIS_URL", "redis://localhost:6379/0"))
 <% elsif storage_type == "database" %>
-  # Database storage (uses ActiveRecord)
   config.storage = :database
+<% else %>
+  # config.storage = :memory  # default
 <% end %>
 
-  # Code settings
-  config.code_length = 6
-  config.code_ttl = 300              # 5 minutes
-  config.code_format = :numeric      # :numeric, :alphanumeric, or :alpha
-
-  # Rate limiting
-  config.max_send_attempts = 3
-  config.max_verification_attempts = 5
-  config.max_identifier_changes = 5
-  config.rate_limit_window = 3600    # 1 hour
-
-  # Delivery channels
-  config.delivery_channel = :sms     # :sms or :email
-
-  # SMS delivery (configure with your provider)
-  config.sms_sender = ->(to:, code:, context:) {
-    # Example with Twilio:
-    # twilio_client = Twilio::REST::Client.new(
-    #   ENV['TWILIO_ACCOUNT_SID'],
-    #   ENV['TWILIO_AUTH_TOKEN']
-    # )
-    # twilio_client.messages.create(
-    #   to: to,
-    #   from: ENV['TWILIO_PHONE_NUMBER'],
-    #   body: "Your verification code is: #{code}"
-    # )
-
-    # For development, just log it:
-    Rails.logger.info("SMS to #{to}: Your verification code is #{code}")
-  }
-
-  # Email delivery (configure with your mailer)
+  # Required: configure your delivery channel(s)
   config.email_sender = ->(to:, code:, context:) {
-    # Example with ActionMailer:
     # VerificationMailer.send_code(to, code, context).deliver_now
-
-    # For development, just log it:
-    Rails.logger.info("Email to #{to}: Your verification code is #{code}")
   }
 
-  # Lifecycle callbacks (optional)
-  # config.on_send = ->(record:, identifier:, channel:) {
-  #   Rails.logger.info("Verification sent to #{identifier} via #{channel}")
-  # }
-
-  # config.on_verify_success = ->(record:, identifier:) {
-  #   Rails.logger.info("Verification successful for #{identifier}")
-  # }
-
-  # config.on_verify_failure = ->(record:, identifier:, attempts:) {
-  #   Rails.logger.warn("Verification failed for #{identifier} (#{attempts} attempts)")
-  # }
-
-  # Namespace (for multi-tenant apps)
-  # config.namespace = ->(record) {
-  #   record.respond_to?(:organization_id) ? "org:#{record.organization_id}" : nil
-  # }
+  config.sms_sender = ->(to:, code:, context:) {
+    # e.g. Twilio, Vonage, etc.
+  }
 
-  # Test mode (expose codes for testing)
-  config.test_mode = Rails.env.test?
-  config.bypass_delivery = Rails.env.test?
+  # Optional overrides (sensible defaults are set automatically):
+  # config.code_length = 6
+  # config.code_ttl = 300
+  # config.code_format = :numeric
+  # config.max_send_attempts = 3
+  # config.max_verification_attempts = 5
+  # config.delivery_channel = :email
+  # config.on_send = ->(record:, identifier:, channel:) {}
+  # config.on_verify_success = ->(record:, identifier:) {}
+  # config.on_verify_failure = ->(record:, identifier:, attempts:) {}
 end

data/lib/verify_it/verifiable.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/concern"
+
 module VerifyIt
   module Verifiable
     extend ActiveSupport::Concern
@@ -11,11 +13,6 @@ module VerifyIt
           raise ArgumentError, "Invalid channel: #{channel}. Must be :sms or :email"
         end
 
-        # Validate attribute exists (check at definition time)
-        unless method_defined?(attribute) || private_method_defined?(attribute)
-          raise ArgumentError, "Attribute :#{attribute} does not respond to #{name}"
-        end
-
         # Check for method conflicts
         send_method = "send_#{channel}_code"
         verify_method = "verify_#{channel}_code"

data/lib/verify_it/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: verify_it
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeremias Ramirez
@@ -135,8 +135,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-description: VerifyIt is a storage-agnostic, delivery-agnostic verification library
-  supporting Redis, database, and memory backends with configurable rate limiting.
+description: A storage-agnostic verification system for Ruby applications. VerifyIt
+  provides a flexible framework for implementing SMS and email verifications with
+  built-in rate limiting and multiple storage backends.
 email:
 - iguanadejere4@googlemail.com
 executables:
@@ -181,7 +182,6 @@ homepage: https://github.com/JeremasPosta/verify_it
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/JeremasPosta/verify_it
   source_code_uri: https://github.com/JeremasPosta/verify_it
   changelog_uri: https://github.com/JeremasPosta/verify_it/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/JeremasPosta/verify_it/issues