api_authentication_gem 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f9996a17bc8d09dc00047653aa84cc9968eef8466f80adb5aa97ad12140c9c4
-  data.tar.gz: 2630ecb1e1974b54becba0597d6d6e014b0ec75d10c15b4b5a82d70b1605e8fa
+  metadata.gz: 9c1a193db7381a68fbc0dcc8794b6d15fd3c929f06cf34be6f49fa3af6bc4c26
+  data.tar.gz: fe5471fe7547a0b680681d3656a26116a059d4627461ec775ff2611d374368e7
 SHA512:
-  metadata.gz: eae1e2f77c261de0287a6a16e31a5a7883687c83fb63d305818d157f814e82e72b9a49e9b42d10baee942bdbd32fa4218737e061d784a812140b597bb2f80856
-  data.tar.gz: e23c574d79bbe9ac96fd9e074ad44a02aa982d20da511b003b626ea186c5906ccaf86340044ab16ad25c631ec4eea47562a3c6b562fab511ce274d76130fb044
+  metadata.gz: '004594d70da880033ee0b743a0a74a2fa50f858e020e60bb3c49765d0cd7b8878c00506850c6ee910ccfcd1dbc89b940091b9689dc0c91129935bbfc05698eb9'
+  data.tar.gz: f92710c1a3b4ed520ff1ff9a8cf7cd48722f1a2fcf1460cd90c7ff9b5fb6643e700b1d29c62d448b139f691556cf4d93b28ca7ba1e980ee8bd488bbd3364a9a4

data/README.md

@@ -0,0 +1,70 @@
+# ApiAuthenticationGem
+
+A lightweight and easy-to-use Ruby gem that adds **user signup and login** functionality to your **Rails API** using **JWT authentication**.
+
+No need to write boilerplate authentication code again — just plug it in, and you're good to go!
+
+---
+
+## ✨ Features
+
+- ✅ User signup with email uniqueness and password validation (handled by the gem)
+- ✅ Login with JWT token generation
+- ✅ Easy integration with any Rails API
+- ✅ Customizable user model support
+
+---
+
+## 📦 Installation
+
+Add this line to your Rails application's `Gemfile`:
+gem 'api_authentication_gem'
+Then run:
+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
+    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
+    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
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_authentication_gem
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adarsh Mishra
@@ -45,6 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/api_authentication_gem.rb
 homepage: https://rubygems.org/gems/api_authentication_gem
 licenses: