rails_jwt_auth_generators 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a147f93e0c05451471cd4b443affcf90e6b9ee93d030432d44a00efcecdde795
-  data.tar.gz: aa55a3f14074d34a9e40ed903b13cab4fd960f017faaa7f9a5970fff581da59d
+  metadata.gz: 44f98c84018593164941b864aba84068138f6ab389f879db2f3f89fb2add657f
+  data.tar.gz: 10c26c421a4d06306c587f89584b8d09a7f2417bf80b9d69c7f5d51488062472
 SHA512:
-  metadata.gz: ddc5d1b264f270a460c3f7520276bbf61a2d5a6bfc83e46a966e04c486fa3cbf3136558f1592dabc68979a0b6638bec7756ef915c80d554de6eda976546be919
-  data.tar.gz: 56a823c1e5fd07bb613de731da8a451d0aef83975503d9ed7ba9633495ddb88d0e7dbd24bc4ea04fe102a3f974dc82937a8fa207d3735f74a5d97e5a14ac927e
+  metadata.gz: 0ea8461a2ccfd12bf17fd9f8f3d494a8b94c2f84edb392b3b4f11c05101508ede708859cff36b2b3431dc36381a98bc7e4a9ad5b4f8d118b7df81e1a4ac2b4c2
+  data.tar.gz: d29182a3511aab7835dc959726cd818a31ca30063d70b11a47df257f72b936020d9601b97f79ded63745657a369eebaa7874d312579ee12fca185c279992bfdc

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_jwt_auth_generators.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/README.md

@@ -1,39 +1,153 @@
-# RailsJwtAuthGenerators
+# Rails JWT Auth Generators
 
-TODO: Delete this and the text below, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/rails_jwt_auth_generators.svg)](https://badge.fury.io/rb/rails_jwt_auth_generators)
+[![Build Status](https://github.com/Zeyad-Hassan-1/rails_jwt_auth_generators/actions/workflows/main.yml/badge.svg)](https://github.com/Zeyad-Hassan-1/rails_jwt_auth_generators/actions)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_jwt_auth_generators`. To experiment with that code, run `bin/console` for an interactive prompt.
+Rails JWT Auth Generators is a Ruby gem that provides Rails generators to quickly scaffold JWT-based authentication boilerplate for Rails APIs. It includes concerns, controllers, and user models to streamline the process of setting up authentication in your Rails application.
+
+## Features
+
+- Generates a `JsonWebToken` concern for encoding and decoding JWTs.
+- Creates an `AuthenticationController` for handling login requests.
+- Scaffolds a `UsersController` for managing user resources.
+- Generates a `User` model with secure password handling.
+- Compatible with Rails 6.0 and above.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem 'rails_jwt_auth_generators'
+```plaintext
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+And then execute:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+bundle install
+```plaintext
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Or install it yourself as:
+
+```bash
+gem install rails_jwt_auth_generators
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+To generate the JWT authentication boilerplate, run the following command:
+
+```bash
+rails generate auth:jwt
+```
+
+This will create the following files in your Rails application:
+
+- `app/controllers/concerns/json_web_token.rb`
+- `app/controllers/authentication_controller.rb`
+- `app/controllers/users_controller.rb`
+- `app/models/user.rb`
+
+### Example Workflow
+
+1. **Setup User Model**: Ensure your database has a `users` table with the necessary fields (`username`, `email`, `password_digest`).
+
+2. **Authentication**: Use the `AuthenticationController` to handle login requests. It will return a JWT token upon successful authentication.
+
+3. **Authorization**: Use the `JsonWebToken` concern to decode and verify tokens in your application.
+
+4. **User Management**: Use the `UsersController` to manage user resources.
+
+## Generated Files
+
+### JsonWebToken Concern
+
+Handles JWT encoding and decoding.
+
+```ruby
+module JsonWebToken
+  SECRET_KEY = Rails.application.secret_key_base
+
+  def jwt_encode(payload, exp = 7.days.from_now)
+    payload[:exp] = exp.to_i
+    JWT.encode(payload, SECRET_KEY)
+  end
+
+  def jwt_decode(token)
+    decoded = JWT.decode(token, SECRET_KEY)[0]
+    HashWithIndifferentAccess.new(decoded)
+  end
+end
+```
+
+### AuthenticationController
+
+Handles user login and token generation.
+
+```ruby
+class AuthenticationController < ApplicationController
+  def login
+    @user = User.find_by_email(params[:email])
+    if @user&.authenticate(params[:password])
+      token = jwt_encode(user_id: @user.id)
+      render json: { token: token }, status: :ok
+    else
+      render json: { error: 'unauthorized' }, status: :unauthorized
+    end
+  end
+end
+```
+
+### UsersController
+
+Manages user resources.
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    @user = User.new(user_params)
+    if @user.save
+      render json: @user, status: :created
+    else
+      render json: { errors: @user.errors.full_messages }, status: :unprocessable_entity
+    end
+  end
+end
+```
+
+### User Model
+
+Defines the user with secure password handling.
+
+```ruby
+class User < ApplicationRecord
+  has_secure_password
+  validates :email, :username, presence: true
+end
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run:
+
+```bash
+bundle exec rake install
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_jwt_auth_generators. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rails_jwt_auth_generators/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at [https://github.com/Zeyad-Hassan-1/rails_jwt_auth_generators](https://github.com/Zeyad-Hassan-1/rails_jwt_auth_generators). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
 
 ## Code of Conduct
 
-Everyone interacting in the RailsJwtAuthGenerators project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rails_jwt_auth_generators/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RailsJwtAuthGenerators project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+```
+
+Similar code found with 2 license types

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails_jwt_auth_generators"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_jwt_auth_generators/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_jwt_auth_generators
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Zeyad-Hassan-1
@@ -14,16 +14,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 description: Generates JWT auth concerns, controllers, and user models for Rails APIs
 email:
 - studying.zezo@gmail.com
@@ -31,12 +37,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/generators/auth/jwt_generator.rb
 - lib/generators/auth/templates/authentication_controller.rb
 - lib/generators/auth/templates/json_web_token.rb
@@ -44,7 +52,6 @@ files:
 - lib/generators/auth/templates/users_controller.rb
 - lib/rails_jwt_auth_generators.rb
 - lib/rails_jwt_auth_generators/version.rb
-- sig/rails_jwt_auth_generators.rbs
 homepage: https://github.com/Zeyad-Hassan-1/rails_jwt_auth_generators
 licenses:
 - MIT

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/sig/rails_jwt_auth_generators.rbs

@@ -1,4 +0,0 @@
-module RailsJwtAuthGenerators
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end