api_authentication_gem 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ef82ce77c6130e40ba62ffa3eb29c4c0536de438168d59052f3e4ac0abcba90
-  data.tar.gz: a4d81cc6a0b0ad3b21130868b6b3cdebde7026680bb7403e67fa5fe873c432b0
+  metadata.gz: ec9f993dd7036eee23f50421a5ef5e197370ba2349abcacf95bcf0eb81b8370c
+  data.tar.gz: 52e9145805cd449d3e4ee0959a48b217e3bea0da412587fabe4c0e36db9ed89c
 SHA512:
-  metadata.gz: 8f4b52e667b8f7de5bea164d3bf201bfe4b69a098d0cbe40dcd82c0b971e952ffba32e91e89306d85c984c9cd11563138f5d5ea0366d1b42d3ac912b2638d4db
-  data.tar.gz: 8f4a182fb392ad8d2fe2289f96cbe2d25620a566295ad1a82aa857cec9702a1cf1a309bd8886bb5fdfd415c739025ff680e547bb13d049c75d5283b911bb0bda
+  metadata.gz: 452a6501dc344085c0e30e9550fe046b115b7c69c87a70fa49e74e3711211428ada98d69a119e3a0c913eb4c73a7ae82d19d9132b85dce8fab921d4f856b1c5d
+  data.tar.gz: 956f9e09e241360429e214e1b96e79ea2c0f9f775c0889df36a33c44d876c239ef5e26f60b68d9b04a54d683399c4fcadd8ed38bbf18bab10deb52f85b757016

data/README.md

@@ -12,59 +12,84 @@ No need to write boilerplate authentication code again — just plug it in, and
 - ✅ Login with JWT token generation
 - ✅ Easy integration with any Rails API
 - ✅ Customizable user model support
+- ✅ Configurable `secret_key` and `user_class`
+- ✅ Tested with RSpec
+- ✅ Rails-friendly design
 
 ---
 
 ## 📦 Installation
 
 Add this line to your Rails application's `Gemfile`:
-gem 'api_authentication_gem'
+`gem 'api_authentication_gem'`
 Then run:
-bundle install
+`bundle install`
 
 🛠 Setup in Your Rails API
-1. Generate the User Model (if not already created)
-rails generate model User email:string password_digest:string
-rails db:migrate
-
-2. Create a Controller to Handle Auth Actions
-
-class UsersController < ApplicationController
-  def signup
-    result = ApiAuthenticationGem::Auth.signup(
-      email: params[:email],
-      password: params[:password],
-      user_class: User
-    )
-
-    if result[:error]
-      render json: { error: result[:error] }, status: :unprocessable_entity
-    else
-      render json: { message: result[:message], user: result[:user] }, status: :created
+1. Add gem configs to your app:
+   ```ruby
+   # config/initializers/api_authentication_gem.rb
+
+    ApiAuthenticationGem.configure do |config|
+      config.secret_key = ENV["SECRET_KEY_BASE"] || "fallback-key" # Always set your secret_key via environment variable in production
+      config.user_class = "User"
     end
+   ```
+
+2. Generate the User Model (if not already created)
+   ```bash
+   rails generate model User email:string password_digest:string
+   rails db:migrate
+   ```
+
+Your User model must use has_secure_password:
+  ```ruby
+  class User < ApplicationRecord
+    has_secure_password
   end
+  ```
+No need to manually validate emails or handle password_digest — the gem takes care of it internally.
+
+3. Create a Controller to Handle Auth Actions
+
+  ```ruby
+  class UsersController < ApplicationController
+    def signup
+      result = ApiAuthenticationGem::Auth.signup(
+        email: params[:email],
+        password: params[:password]
+      )
+
+      if result[:error]
+        render json: { error: result[:error] }, status: :unprocessable_entity
+      else
+        render json: { message: result[:message], user: result[:user] }, status: :created
+      end
+    end
 
-  def login
-    result = ApiAuthenticationGem::Auth.login(
-      email: params[:email],
-      password: params[:password],
-      user_class: User
-    )
-
-    if result[:error]
-      render json: { error: result[:error] }, status: :unauthorized
-    else
-      render json: { token: result[:token] }, status: :ok
+    def login
+      result = ApiAuthenticationGem::Auth.login(
+        email: params[:email],
+        password: params[:password]
+      )
+
+      if result[:error]
+        render json: { error: result[:error] }, status: :unauthorized
+      else
+        render json: { token: result[:token] }, status: :ok
+      end
     end
   end
-end
+  ```
 
 
 3. Define Routes
 In your config/routes.rb file:
-Rails.application.routes.draw do
-  post 'signup', to: 'users#signup'
-  post 'login', to: 'users#login'
-end
+  ```ruby
+    Rails.application.routes.draw do
+      post 'signup', to: 'users#signup'
+      post 'login', to: 'users#login'
+    end
+  ```
 
 

data/lib/api_authentication_gem/auth.rb

@@ -0,0 +1,36 @@
+require "jwt"
+module ApiAuthenticationGem
+  class Auth
+    def self.signup(email:, password:)
+      user_class = ApiAuthenticationGem.configuration.user_class.constantize
+      user = user_class.create!(email: email, password: password)
+      token = generate_token(user.id)
+      { token: token, user: user }
+    end
+    
+    def self.login(email:, password:)
+      user_class = ApiAuthenticationGem.configuration.user_class.constantize
+      user = user_class.find_by(email: email)
+      return nil unless user&.authenticate(password)
+    
+      token = generate_token(user.id)
+      { token: token, user: user }
+    end
+    
+
+    # Decode the JWT token and retrieve the payload
+    def self.decode(token)
+      decoded = JWT.decode(token, ApiAuthenticationGem.configuration.secret_key, true, algorithm: 'HS256')
+      decoded.first # The payload is in the first element
+    rescue JWT::DecodeError => e
+      nil # If the token is invalid, return nil
+    end
+
+    private
+
+    def self.generate_token(user_id)
+      payload = { user_id: user_id }
+      JWT.encode(payload, ApiAuthenticationGem.configuration.secret_key)
+    end
+  end
+end

data/lib/api_authentication_gem/configuration.rb

@@ -0,0 +1,11 @@
+module ApiAuthenticationGem
+  class Configuration
+    attr_accessor :secret_key, :user_class
+
+    def initialize
+      @secret_key = ENV["API_AUTH_SECRET_KEY"] || "your-default-secret-key"
+      @user_class = "User" # Default to 'User' model
+    end
+  end
+end
+

data/lib/api_authentication_gem/version.rb

@@ -0,0 +1,3 @@
+module ApiAuthenticationGem
+  VERSION = "0.1.4"
+end

data/lib/api_authentication_gem.rb

@@ -1,36 +1,13 @@
-require "jwt"
-require "bcrypt"
+require "api_authentication_gem/version"
+require "api_authentication_gem/configuration"
+require "api_authentication_gem/auth"
 
 module ApiAuthenticationGem
-  class Auth
-    SECRET_KEY = "your$ecretK3y"
-
-    def self.signup(email:, password:, user_class:)
-      return { error: "Email is required" } unless email
-      return { error: "Password must be at least 5 characters long" } if password.nil? || password.length < 5
-
-      return { error: "Email already exists" } if user_class.find_by(email: email)
-
-      password_digest = BCrypt::Password.create(password)
-      user = user_class.create(email: email, password_digest: password_digest)
-
-      { message: "User created", user: user }
-    end
-
-    def self.login(email:, password:, user_class:)
-      user = user_class.find_by(email: email)
-
-      return { error: "Invalid email or password" } unless user
-      return { error: "Invalid email or password" } unless BCrypt::Password.new(user.password_digest) == password
-
-      token = JWT.encode({ user_id: user.id, exp: Time.now.to_i + 3600 }, SECRET_KEY, 'HS256')
-      { token: token }
-    end
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
 
-    def self.decode_token(token)
-      JWT.decode(token, SECRET_KEY, true, { algorithm: 'HS256' })[0]
-    rescue
-      nil
-    end
+  def self.configure
+    yield(configuration)
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: api_authentication_gem
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Adarsh Mishra
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -38,6 +37,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Reusable gem for authentication with user-defined models. For detailed
   usage, visit: https://github.com/Adarsh-07-Mishra/api_authentication_gem/blob/main/README.md'
 email:
@@ -48,11 +75,13 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/api_authentication_gem.rb
+- lib/api_authentication_gem/auth.rb
+- lib/api_authentication_gem/configuration.rb
+- lib/api_authentication_gem/version.rb
 homepage: https://github.com/Adarsh-07-Mishra/api_authentication_gem
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -67,8 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key: 
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Provides JWT-based signup and login for APIs
 test_files: []