rails_jwt 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51746f2546b2ae37fb83c84f163ab8f723a3e0b8fec3c013d53efb331d30ba4f
+  data.tar.gz: d612fe860c580023e383779a749e1e12ddd826b2e6cdd8d012d454c58fe55eb3
+SHA512:
+  metadata.gz: 2965fb423117528d9105140ff6b97abe841835bdd2a86eb88a9d7b17948abbb27ad24a16ab775544f57e0168da247a342724d7c6e4d0175e57731596a72c04b2
+  data.tar.gz: 8f8c347909be432951ad1be9181b736ca23ed02350e40bfd7aa7d442f3eee4068597b107f054d0a223ac42636471af58d683ce13964e74328175db6274e971fa

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Muhammad Aamir
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# RailsJwt
+Super easy way to add JWT support for Rails API projects.
+
+## Description
+This gem makes it super easy to add JWT support in your Rails project. Just a few of quick steps and you are good to go!
+
+## Usage
+
+### Requirements
+Your user model must have an `authenticate` method (that takes a password as its paramter) implemented. A common and quick way is to use [has_secure_password](https://api.rubyonrails.org/classes/ActiveModel/SecurePassword/ClassMethods.html#method-i-has_secure_password)
+
+Alternatively, you can implement your own `authenticate` method, for example, if you want to authenticate with an LDAP server.
+
+### Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_jwt'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Execute following to add configuration file in `config/initializers` folder:
+```bash
+$ rails g rails_jwt:install
+```
+
+Add following line in your routes.rb
+```ruby
+mount RailsJwt::Engine => "/auth"
+```
+
+Add the following in the controller you would to secure:
+```ruby
+include RailsJwt::Authentication
+before_action :authenticate_user
+```
+
+Or you can create a secure controller that you can inherit in the all of the controllers you would like to secure:
+```ruby
+class SecureController < ApplicationController
+    include RailsJwt::Authentication
+    before_action :authenticate_user
+end
+```
+
+### Authentication
+
+Send a POST request:
+```
+POST /auth/login HTTP/1.1
+Host: localhost:3000
+Content-Type: application/json
+
+{ "user_id": "test@abc.com", "password": "test"}
+```
+
+If authentication is successful, you will get a response like this:
+```
+{
+    "jwt": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOnsiaWQiOjF9LCJleHAiOjE2MTY4Mjg3NTZ9.gUmZaBjUM-FOM-_9T47ul4mM7c_YG8lF9l11MlGUmBM"
+}
+```
+
+Pass the returned token to the header of your subsequent API call:
+```
+GET /users HTTP/1.1
+Host: localhost:3000
+Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOnsiaWQiOjF9LCJ1c2VyX2lkIjoxLCJlbWFpbCI6Im1haWxAYWFtaXIucGsiLCJhY3RpdmUiOnRydWUsImV4cCI6MTYxNjc4MjU5M30.-lybW5musgaWS-g1mvTtgmeSM_oi1U7Xa_elh68Ph-c
+```
+
+## Configuration
+A number of configuration options are available in `initiliazers/rails_jwt.rb` file. By default user's email will be used as a login id, however that can be modified by changing relevant entry in `rails_jwt.rb` config file (`config.user_id_attr = :login_id`).
+
+### Custom payload
+By default the payload looks like following:
+```
+{
+ "sub": {
+  "id": 1
+ },
+ "exp": 1616823684
+}
+```
+
+In above payload `sub.id` is the unique id (primary key) of your user object that will be used to lookup the calling user. If you want to add more fields in the payload, you will need to add `jwt_payload` method in your user model:
+
+```ruby
+def jwt_payload
+    {email: self.email, active: self.active}
+end
+```
+
+Addition of above method will create a payload similar to the following:
+```
+{
+ "sub": {
+  "id": 1
+ },
+ "email": "test@abc.com",
+ "active": true,
+ "exp": 1616823952
+}
+```
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsJwt'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/rails_jwt/application_controller.rb

@@ -0,0 +1,5 @@
+module RailsJwt
+  class ApplicationController < ActionController::API
+    # protect_from_forgery with: :exception
+  end
+end

data/app/controllers/rails_jwt/authentication.rb

@@ -0,0 +1,34 @@
+require 'jwt'
+
+module RailsJwt::Authentication
+    def authenticate_user
+        begin
+            payload = jwt_payload
+
+            expiry_time = Time.at(payload["exp"])
+            if Time.now > expiry_time
+                render status: :unauthorized    
+            end
+            user = User.find(payload["sub"]["id"])
+            if !user.active
+                render status: :unauthorized
+            end
+
+        rescue ActiveRecord::RecordNotFound
+            render status: :unauthorized
+        rescue JWT::DecodeError
+            render status: :unauthorized
+        end
+    end
+
+    def current_user
+        payload = jwt_payload
+        User.find(payload["sub"]["id"])
+    end
+
+    private
+    def jwt_payload
+        token = request.headers['Authorization']&.split&.fetch(-1)
+        JWT.decode(token, Rails.application.secret_key_base)[0]
+    end
+end

data/app/controllers/rails_jwt/login_controller.rb

@@ -0,0 +1,28 @@
+require_dependency "rails_jwt/application_controller"
+require 'jwt'
+
+module RailsJwt
+    class LoginController < ApplicationController
+        def login
+            user = RailsJwt.user_class.send("find_by_#{RailsJwt.user_id_attr}", params[:user_id])
+
+            if user&.respond_to?(:active) && !user.active
+                render status: :unauthorized
+            elsif user&.authenticate(params[:password])
+                token = JWT.encode(create_jwt_payload(user), RailsJwt.token_signature_key.call, 'HS256')
+                render json: {jwt: token}
+            else
+                render status: :unauthorized
+            end
+        end
+
+        private
+        def create_jwt_payload(user)
+            payload = {sub: {id: user.id}}
+            if user.respond_to?(:jwt_payload)
+                payload.merge!(user.jwt_payload)
+            end
+            return (payload.merge!({exp: (Time.now + RailsJwt.token_lifetime).to_i}))
+        end
+    end
+end

data/app/jobs/rails_jwt/application_job.rb

@@ -0,0 +1,4 @@
+module RailsJwt
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/rails_jwt/application_mailer.rb

@@ -0,0 +1,6 @@
+module RailsJwt
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/rails_jwt/application_record.rb

@@ -0,0 +1,5 @@
+module RailsJwt
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+RailsJwt::Engine.routes.draw do
+    post 'login', to: 'login#login'
+end

data/lib/generators/rails_jwt/install/install_generator.rb

@@ -0,0 +1,7 @@
+class RailsJwt::InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def generate_config_file
+            copy_file "rails_jwt.rb", "config/initializers/rails_jwt.rb"
+    end
+end

data/lib/generators/rails_jwt/install/templates/rails_jwt.rb

@@ -0,0 +1,28 @@
+RailsJwt.setup do |config|
+
+    ## Expiration of token
+    ## -------------------
+    ## How long it will take before a token is expired. Default is nil, which means token is never expired
+    #
+    # config.token_lifetime = nil     # Never expires
+    # config.token_lifetime = 1.week   # Default
+
+
+    ## User class and  user id field
+    ## -----------------------------
+    ## Application User class. This is the model that represents the user being authenticated.
+    ##
+    # config.user_class = "User" # Default
+    ##
+    ## User ID attribute. This is the attribute of user class that will be used as a unique user id
+    ##
+    # config.user_id_attr = :email # Default
+
+
+    ## Token signature key
+    ## -------------------
+    ## The secrete key that will be used to sign the token
+    ##
+    # config.token_signature_key = -> {Rails.application.secret_key_base}  # Default
+
+end

data/lib/rails_jwt.rb

@@ -0,0 +1,17 @@
+require "rails_jwt/engine"
+
+module RailsJwt
+    mattr_writer   :user_class,             default: 'User'
+    mattr_accessor :user_id_attr,           default: 'email'
+    mattr_accessor :token_lifetime,         default: 1.week
+    mattr_accessor :token_signature_key,    default: -> {Rails.application.secret_key_base}
+
+    def self.user_class
+        return @@user_class.constantize
+    end
+
+    def self.setup
+        yield self
+    end
+
+end

data/lib/rails_jwt/engine.rb

@@ -0,0 +1,6 @@
+module RailsJwt
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsJwt
+    config.generators.api_only = true
+  end
+end

data/lib/rails_jwt/version.rb

@@ -0,0 +1,3 @@
+module RailsJwt
+    VERSION = '1.0.0'
+end

data/lib/tasks/rails_jwt_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_jwt do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: rails_jwt
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Muhammad Aamir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+description: This gem makes it super easy to add JWT support in your Rails project.
+  Just a few of quick steps and you are good to go!
+email:
+- mail@aamir.pk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/rails_jwt/application_controller.rb
+- app/controllers/rails_jwt/authentication.rb
+- app/controllers/rails_jwt/login_controller.rb
+- app/jobs/rails_jwt/application_job.rb
+- app/mailers/rails_jwt/application_mailer.rb
+- app/models/rails_jwt/application_record.rb
+- config/routes.rb
+- lib/generators/rails_jwt/install/install_generator.rb
+- lib/generators/rails_jwt/install/templates/rails_jwt.rb
+- lib/rails_jwt.rb
+- lib/rails_jwt/engine.rb
+- lib/rails_jwt/version.rb
+- lib/tasks/rails_jwt_tasks.rake
+homepage: https://github.com/aamir-pk/rails_jwt
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Super easy way to add JWT support for Rails API projects.
+test_files: []