api_guard 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e4c4d5d2ef0490d9c1cfbb9bf408d09c5152fc3
-  data.tar.gz: 21f401a251b77bf72dfffccf92965f3ecd501f81
+  metadata.gz: e7fd3e30531e593d102344eae722507a2bb93397
+  data.tar.gz: 98bbbbd0ad3d8d3dc541483e79d8db46381da316
 SHA512:
-  metadata.gz: 19a27ce1e5ae8f87482e891895de91ce3e08fae8912392ef09f24b4e3763b3e9a1db2315578acb784b6097548fb2ec02e3a9ab8d1776f71c5b0eafaf466e42fa
-  data.tar.gz: c76a2d4620091808a89f903abbf65672b25cddcd8c7974c6e8fdccdb195da88d96258bab30f3f0221954bb371705c619828f3167878dd45b0bfc06cf25d55f30
+  metadata.gz: 867e07e76fb1957adb353d2f667e43ef10cad61ea360e917dc1e60d72f57c1cb05962af42d855ae5ccdacc88b0a16834487568b81e13aec04ae1fc087d78ff91
+  data.tar.gz: f57dae8c1baba2ad90c15a2001b4e139d10f44dccbbdc19ab6548b592d9d97ab681ae9efd9d72128ef03f2f1f9ed9feb185ff58b8cf7d5625d8d425dc33a61da

data/README.md

@@ -35,8 +35,12 @@ for cryptographic signing.
 * [Overriding defaults](#overriding-defaults)
     * [Controllers](#controllers)
     * [Routes](#routes)
+    * [Adding custom data in JWT token payload](#adding-custom-data-in-jwt-token-payload)
+    * [Override finding resource](#override-finding-resource)
     * [Customizing / translating response messages using I18n](#customizing--translating-response-messages-using-i18n)
 * [Testing](#testing)
+* [Wiki](https://github.com/Gokul595/api_guard/wiki)
+    * [Using API Guard with Devise](https://github.com/Gokul595/api_guard/wiki/Using-API-Guard-with-Devise)
 * [Contributing](#contributing)
 * [License](#license)
 
@@ -64,20 +68,22 @@ Below steps are provided assuming the model in `User`.
 
 ### Creating User model
 
-Create a model for User with below command
+Create a model for User with below command.
 
 ```bash
 $ rails generate model user name:string email:string:uniq password_digest:string
 ```
 
-Then, run migration to create the `users` table
+Then, run migration to create the `users` table.
 
 ```bash
 $ rails db:migrate
 ```
 
 Add [has_secure_password](https://api.rubyonrails.org/classes/ActiveModel/SecurePassword/ClassMethods.html#method-i-has_secure_password) 
-in `User` model for password authentication
+in `User` model for password authentication. 
+
+> Refer [this Wiki](https://github.com/Gokul595/api_guard/wiki/Using-API-Guard-with-Devise#authentication) for configuring API Guard authentication to work with Devise instead of using `has_secure_password`.
 
 ```ruby
 class User < ApplicationRecord
@@ -87,7 +93,7 @@ end
 
 Then, add `bcrypt` gem in your Gemfile which is used by 
 [has_secure_password](https://api.rubyonrails.org/classes/ActiveModel/SecurePassword/ClassMethods.html#method-i-has_secure_password)
-for encrypting password and authentication
+for encrypting password and authentication.
 
 ```ruby
 gem 'bcrypt', '~> 3.1.7'
@@ -109,6 +115,8 @@ api_guard_routes for: 'users'
 
 This will generate default routes such as sign up, sign in, sign out, token refresh, password change for User.
 
+> Refer [this Wiki](https://github.com/Gokul595/api_guard/wiki/Using-API-Guard-with-Devise#routes) for configuring API Guard routes to work with Devise.
+
 ### Registration
 
 This will create an user and responds with access token, refresh token and access token expiry in the response header.
@@ -390,6 +398,10 @@ Override this by configuring `token_signing_secret`
 config.token_signing_secret = 'my_signing_secret'
 ```
 
+>**Note:** Avoid committing this token signing secret in your version control (GIT) and always keep this secure. As,
+>exposing this allow anyone to generate JWT access token and give full access to APIs. Better way is storing this value
+>in environment variable or in encrypted secrets (Rails 5.2+)
+
 ### Invalidate tokens on password change
 
 By default, API Guard will not invalidate old JWT access tokens on changing password. If you need, you can enable it by 
@@ -540,22 +552,74 @@ api_guard_routes for: 'users', only: [:authentication]
 
 >**Available controllers:** registration, authentication, tokens, passwords
 
-**Customizing the routes**
+**Customizing the route path:**
 
-To customize the default routes generated by API Guard you can use `api_guard_scope` in the routes.
+You can customize the path of the default routes of the API Guard using the `api_guard_scope` as below,
 
 ```ruby
 api_guard_routes for: 'users', except: [:registration]
 
 api_guard_scope 'users' do
-  post 'account/create' => 'users/registration#create'
-  delete 'account/delete' => 'users/registration#destroy'
+  post 'account/create' => 'api_guard/registration#create'
+  delete 'account/delete' => 'api_guard/registration#destroy'
 end
 ```
 
 Above configuration will replace default registration routes `users/sign_up` & `users/delete` with `account/create` & 
 `account/delete`
 
+### Adding custom data in JWT token payload
+
+You can add custom data in the JWT token payload in the format of Hash and use the data after decoding the token on 
+every request.
+
+To add custom data, you need to create an instance method `jwt_token_payload` in the resource model as below which 
+should return a Hash,
+
+```ruby
+class User < ApplicationRecord
+  def jwt_token_payload
+    { custom_key: 'value' }
+  end
+end
+```
+
+API Guard will add the hash returned by this method to the JWT token payload in addition to the default payload values. 
+This data (including default payload values) will be available in the instance variable `@decoded_token` on each request 
+if the token has been successfully decoded. You can access the values as below,
+
+```ruby
+@decoded_token[:custom_key]
+```
+
+### Override finding resource
+
+By default, API Guard will try to find the resource by it's `id`. If you wish to override this default behavior, you can
+do it by creating a method `find_resource_from_token` in the specific controller or in `ApplicationController` as you 
+need.
+
+**Adding custom logic in addition to the default logic:**
+```ruby
+def find_resource_from_token(resource_class)
+  user = super # This will call the actual method defined in API Guard
+  user if user&.active?
+end
+```
+
+**Using custom query to find the user from the token:**
+```ruby
+def find_resource_from_token(resource_class)
+  resource_id = @decoded_token[:"#{@resource_name}_id"]
+  resource_class.find_by(id: resource_id, status: 'active') if resource_id
+end
+```
+
+This method has an argument `resource_class` which is the class (model) of the current resource (`User`).
+This method should return a resource object to successfully authenticate the request or `nil` to respond with 401.
+
+You can also use the [custom data](#adding-custom-data-in-jwt-token-payload) added in the JWT token payload using 
+`@decoded_token` instance variable and customize the logic as you need.
+
 ### Customizing / translating response messages using I18n
 
 API Guard uses [I18n](https://guides.rubyonrails.org/i18n.html) for success and error messages. You can create your own 
@@ -577,7 +641,7 @@ https://github.com/Gokul595/api_guard/blob/master/config/locales/en.yml
 API Guard comes with helper for creating JWT access token and refresh token for the resource which you can use it for 
 testing the controllers of your application.
 
-For using it include the helper in you test framework
+For using it, just include the helper in your test framework.
 
 **RSpec**
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,11 +16,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
 load 'rails/tasks/statistics.rake'
 
-
-
 require 'bundler/gem_tasks'
-

data/app/controllers/api_guard/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiGuard
   class ApplicationController < ActionController::Base
     skip_before_action :verify_authenticity_token, raise: false

data/app/controllers/api_guard/authentication_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_dependency 'api_guard/application_controller'
 
 module ApiGuard

data/app/controllers/api_guard/passwords_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_dependency 'api_guard/application_controller'
 
 module ApiGuard

data/app/controllers/api_guard/registration_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_dependency 'api_guard/application_controller'
 
 module ApiGuard

data/app/controllers/api_guard/tokens_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_dependency 'api_guard/application_controller'
 
 module ApiGuard

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ApiGuard::Engine.routes.draw do
   # Can't see anything here?
   # Goto 'lib/api_guard/route_mapper.rb'

data/lib/api_guard.rb

@@ -1,6 +1,8 @@
-require "api_guard/engine"
-require "api_guard/route_mapper"
-require "api_guard/modules"
+# frozen_string_literal: true
+
+require 'api_guard/engine'
+require 'api_guard/route_mapper'
+require 'api_guard/modules'
 
 module ApiGuard
   autoload :AppSecretKey, 'api_guard/app_secret_key'
@@ -24,14 +26,15 @@ module ApiGuard
   mattr_accessor :api_guard_associations
   self.api_guard_associations = {}
 
-  mattr_reader :mapped_resource
-  @@mapped_resource = {}
+  mattr_reader :mapped_resource do
+    {}
+  end
 
   def self.setup
     yield self
   end
 
   def self.map_resource(routes_for, class_name)
-    @@mapped_resource[routes_for.to_sym] = ApiGuard::ResourceMapper.new(routes_for, class_name)
+    mapped_resource[routes_for.to_sym] = ApiGuard::ResourceMapper.new(routes_for, class_name)
   end
 end

data/lib/api_guard/app_secret_key.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiGuard
   class AppSecretKey
     def initialize(application)

data/lib/api_guard/engine.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module ApiGuard
   class Engine < ::Rails::Engine
     isolate_namespace ApiGuard
 
     config.generators do |g|
       g.test_framework :rspec
-      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
     end
 
     # Use 'secret_key_base' from Rails secrets if 'token_signing_secret' is not configured

data/lib/api_guard/jwt_auth/authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiGuard
   module JwtAuth
     # Common module for API authentication
@@ -14,6 +16,10 @@ module ApiGuard
         end
       end
 
+      def respond_to_missing?(method_name, include_private = false)
+        method_name.to_s.start_with?('authenticate_and_set_') || super
+      end
+
       # Authenticate the JWT token and set resource
       def authenticate_and_set_resource(resource_name)
         @resource_name = resource_name
@@ -43,9 +49,19 @@ module ApiGuard
 
       # Returns whether the JWT token is issued after the last password change
       # Returns true if password hasn't changed by the user
-      def valid_issued_at?
+      def valid_issued_at?(resource)
         return true unless ApiGuard.invalidate_old_tokens_on_password_change
-        !current_resource.token_issued_at || @decoded_token[:iat] >= current_resource.token_issued_at.to_i
+
+        !resource.token_issued_at || @decoded_token[:iat] >= resource.token_issued_at.to_i
+      end
+
+      # Defines "current_{{resource_name}}" method and "@current_{{resource_name}}" instance variable
+      # that returns "resource" value
+      def define_current_resource_accessors(resource)
+        self.class.send(:define_method, "current_#{@resource_name}") do
+          instance_variable_get("@current_#{@resource_name}") ||
+            instance_variable_set("@current_#{@resource_name}", resource)
+        end
       end
 
       # Authenticate the resource with the '{{resource_name}}_id' in the decoded JWT token
@@ -54,17 +70,22 @@ module ApiGuard
       # Also, set "current_{{resource_name}}" method and "@current_{{resource_name}}" instance variable
       # for accessing the authenticated resource
       def authenticate_token
-        return unless decode_token && @decoded_token[:"#{@resource_name}_id"].present?
+        return unless decode_token
 
-        resource = @resource_name.classify.constantize.find_by(id: @decoded_token[:"#{@resource_name}_id"])
+        resource = find_resource_from_token(@resource_name.classify.constantize)
 
-        self.class.send(:define_method, "current_#{@resource_name}") do
-          instance_variable_get("@current_#{@resource_name}") || instance_variable_set("@current_#{@resource_name}", resource)
+        if resource && valid_issued_at?(resource) && !blacklisted?(resource)
+          define_current_resource_accessors(resource)
+        else
+          render_error(401, message: I18n.t('api_guard.access_token.invalid'))
         end
+      end
 
-        return if current_resource && valid_issued_at? && !blacklisted?
+      def find_resource_from_token(resource_class)
+        resource_id = @decoded_token[:"#{@resource_name}_id"]
+        return if resource_id.blank?
 
-        render_error(401, message: I18n.t('api_guard.access_token.invalid'))
+        resource_class.find_by(id: resource_id)
       end
 
       def current_resource

data/lib/api_guard/jwt_auth/blacklist_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiGuard
   module JwtAuth
     # Common module for token blacklisting functionality
@@ -16,10 +18,10 @@ module ApiGuard
       end
 
       # Returns whether the JWT token is blacklisted or not
-      def blacklisted?
-        return false unless token_blacklisting_enabled?(current_resource)
+      def blacklisted?(resource)
+        return false unless token_blacklisting_enabled?(resource)
 
-        blacklisted_tokens_for(current_resource).exists?(token: @token)
+        blacklisted_tokens_for(resource).exists?(token: @token)
       end
 
       # Blacklist the current JWT token from future access

data/lib/api_guard/jwt_auth/json_web_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwt'
 
 module ApiGuard
@@ -9,11 +11,11 @@ module ApiGuard
       end
 
       def token_expire_at
-        @expire_at ||= (current_time + ApiGuard.token_validity).to_i
+        @token_expire_at ||= (current_time + ApiGuard.token_validity).to_i
       end
 
       def token_issued_at
-        @issued_at ||= current_time.to_i
+        @token_issued_at ||= current_time.to_i
       end
 
       # Encode the payload with the secret key and return the JWT token
@@ -33,13 +35,16 @@ module ApiGuard
       #
       # This creates expired JWT token if the argument 'expired_token' is true which can be used for testing.
       def jwt_and_refresh_token(resource, resource_name, expired_token = false)
-        access_token = encode(
+        payload = {
           "#{resource_name}_id": resource.id,
           exp: expired_token ? token_issued_at : token_expire_at,
           iat: token_issued_at
-        )
+        }
+
+        # Add custom data in the JWT token payload
+        payload.merge!(resource.jwt_token_payload) if resource.respond_to?(:jwt_token_payload)
 
-        [access_token, new_refresh_token(resource)]
+        [encode(payload), new_refresh_token(resource)]
       end
 
       # Create tokens and set response headers

data/lib/api_guard/jwt_auth/refresh_jwt_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiGuard
   module JwtAuth
     # Common module for refresh token functionality

data/lib/api_guard/models/concerns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiGuard
   module Models
     module Concerns
@@ -5,19 +7,19 @@ module ApiGuard
 
       class_methods do
         def api_guard_associations(refresh_token: nil, blacklisted_token: nil)
-          return if ApiGuard.api_guard_associations[self.name]
+          return if ApiGuard.api_guard_associations[name]
 
-          ApiGuard.api_guard_associations[self.name] = {}
-          ApiGuard.api_guard_associations[self.name][:refresh_token] = refresh_token
-          ApiGuard.api_guard_associations[self.name][:blacklisted_token] = blacklisted_token
+          ApiGuard.api_guard_associations[name] = {}
+          ApiGuard.api_guard_associations[name][:refresh_token] = refresh_token
+          ApiGuard.api_guard_associations[name][:blacklisted_token] = blacklisted_token
         end
 
         def refresh_token_association
-          ApiGuard.api_guard_associations.dig(self.name, :refresh_token)
+          ApiGuard.api_guard_associations.dig(name, :refresh_token)
         end
 
         def blacklisted_token_association
-          ApiGuard.api_guard_associations.dig(self.name, :blacklisted_token)
+          ApiGuard.api_guard_associations.dig(name, :blacklisted_token)
         end
       end
     end

data/lib/api_guard/modules.rb

@@ -1,24 +1,26 @@
-require "api_guard/resource_mapper"
-require "api_guard/jwt_auth/json_web_token"
-require "api_guard/jwt_auth/authentication"
-require "api_guard/jwt_auth/refresh_jwt_token"
-require "api_guard/jwt_auth/blacklist_token"
-require "api_guard/response_formatters/renderer"
-require "api_guard/models/concerns"
+# frozen_string_literal: true
+
+require 'api_guard/resource_mapper'
+require 'api_guard/jwt_auth/json_web_token'
+require 'api_guard/jwt_auth/authentication'
+require 'api_guard/jwt_auth/refresh_jwt_token'
+require 'api_guard/jwt_auth/blacklist_token'
+require 'api_guard/response_formatters/renderer'
+require 'api_guard/models/concerns'
 
 module ApiGuard
   module Modules
-    ActiveSupport.on_load(:action_controller) {
+    ActiveSupport.on_load(:action_controller) do
       include ApiGuard::Resource
       include ApiGuard::JwtAuth::JsonWebToken
       include ApiGuard::JwtAuth::Authentication
       include ApiGuard::JwtAuth::RefreshJwtToken
       include ApiGuard::JwtAuth::BlacklistToken
       include ApiGuard::ResponseFormatters::Renderer
-    }
+    end
 
-    ActiveSupport.on_load(:active_record) {
+    ActiveSupport.on_load(:active_record) do
       include ApiGuard::Models::Concerns
-    }
+    end
   end
 end

data/lib/api_guard/resource_mapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiGuard
   class ResourceMapper
     attr_reader :resource_name, :resource_class, :resource_instance_name
@@ -19,7 +21,7 @@ module ApiGuard
     end
 
     def current_resource_mapping
-      request.env["api_guard.mapping"]
+      request.env['api_guard.mapping']
     end
 
     def resource_name

data/lib/api_guard/response_formatters/renderer.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module ApiGuard
   module ResponseFormatters
     module Renderer
       def render_success(data: nil, message: nil)
         resp_data = { status: I18n.t('api_guard.response.success') }
         resp_data[:message] = message if message
+        resp_data[:data] = message if data
 
         render json: resp_data, status: 200
       end

data/lib/api_guard/route_mapper.rb

@@ -1,81 +1,85 @@
+# frozen_string_literal: true
+
 # Referenced from devise gem:
 # https://github.com/plataformatec/devise/blob/master/lib/devise/rails/routes.rb
 #
 # Customizable API routes
-module ActionDispatch::Routing
-  class Mapper
-    def api_guard_routes(options = {})
-      routes_for = options.delete(:for).to_s || 'users'
-
-      controllers = default_controllers(options[:only], options[:except])
-      controller_options = options.delete(:controller)
-
-      options[:as] = options[:as] || routes_for.singularize
-      options[:path] = options[:path] || routes_for
-
-      api_guard_scope(routes_for) do |mapped_resource|
-        scope options do
-          generate_routes(mapped_resource, controller_options, controllers)
+module ActionDispatch
+  module Routing
+    class Mapper
+      def api_guard_routes(options = {})
+        routes_for = options.delete(:for).to_s || 'users'
+
+        controllers = default_controllers(options[:only], options[:except])
+        controller_options = options.delete(:controller)
+
+        options[:as] = options[:as] || routes_for.singularize
+        options[:path] = options[:path] || routes_for
+
+        api_guard_scope(routes_for) do |mapped_resource|
+          scope options do
+            generate_routes(mapped_resource, controller_options, controllers)
+          end
         end
       end
-    end
 
-    def api_guard_scope(routes_for)
-      mapped_resource = ApiGuard.mapped_resource[routes_for.to_sym].presence || ApiGuard.map_resource(routes_for, routes_for.classify)
+      def api_guard_scope(routes_for)
+        mapped_resource = ApiGuard.mapped_resource[routes_for.to_sym].presence ||
+                          ApiGuard.map_resource(routes_for, routes_for.classify)
 
-      constraint = lambda do |request|
-        request.env["api_guard.mapping"] = mapped_resource
-        true
-      end
+        constraint = lambda do |request|
+          request.env['api_guard.mapping'] = mapped_resource
+          true
+        end
 
-      constraints(constraint) do
-        yield(mapped_resource)
+        constraints(constraint) do
+          yield(mapped_resource)
+        end
       end
-    end
 
-    private
+      private
 
-    def default_controllers(only, except)
-      return only if only
-
-      controllers = %i[registration authentication tokens passwords]
-      except ? (controllers - except) : controllers
-    end
+      def default_controllers(only, except)
+        return only if only
 
-    def generate_routes(mapped_resource, options, controllers)
-      options ||= {}
+        controllers = %i[registration authentication tokens passwords]
+        except ? (controllers - except) : controllers
+      end
 
-      controllers -= %i[tokens] unless mapped_resource.resource_class.refresh_token_association
+      def generate_routes(mapped_resource, options, controllers)
+        options ||= {}
+        controllers -= %i[tokens] unless mapped_resource.resource_class.refresh_token_association
 
-      controllers.each do |controller|
-        send("#{controller.to_s}_routes", options[controller])
+        controllers.each do |controller|
+          send("#{controller}_routes", options[controller])
+        end
       end
-    end
 
-    def authentication_routes(controller_name = nil)
-      controller_name = controller_name || 'api_guard/authentication'
+      def authentication_routes(controller_name = nil)
+        controller_name ||= 'api_guard/authentication'
 
-      post 'sign_in' => "#{controller_name}#create"
-      delete 'sign_out' => "#{controller_name}#destroy"
-    end
+        post 'sign_in' => "#{controller_name}#create"
+        delete 'sign_out' => "#{controller_name}#destroy"
+      end
 
-    def registration_routes(controller_name = nil)
-      controller_name = controller_name || 'api_guard/registration'
+      def registration_routes(controller_name = nil)
+        controller_name ||= 'api_guard/registration'
 
-      post 'sign_up' => "#{controller_name}#create"
-      delete 'delete' => "#{controller_name}#destroy"
-    end
+        post 'sign_up' => "#{controller_name}#create"
+        delete 'delete' => "#{controller_name}#destroy"
+      end
 
-    def passwords_routes(controller_name = nil)
-      controller_name = controller_name || 'api_guard/passwords'
+      def passwords_routes(controller_name = nil)
+        controller_name ||= 'api_guard/passwords'
 
-      patch 'passwords' => "#{controller_name}#update"
-    end
+        patch 'passwords' => "#{controller_name}#update"
+      end
 
-    def tokens_routes(controller_name = nil)
-      controller_name = controller_name || 'api_guard/tokens'
+      def tokens_routes(controller_name = nil)
+        controller_name ||= 'api_guard/tokens'
 
-      post 'tokens' => "#{controller_name}#create"
+        post 'tokens' => "#{controller_name}#create"
+      end
     end
   end
 end

data/lib/api_guard/test/controller_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'api_guard/jwt_auth/json_web_token'
 require 'api_guard/jwt_auth/refresh_jwt_token'
 

data/lib/api_guard/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiGuard
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'
 end

data/lib/generators/api_guard/controllers/controllers_generator.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module ApiGuard
   class ControllersGenerator < Rails::Generators::Base
     CONTROLLERS = %i[registration authentication tokens passwords].freeze
 
     desc 'Generates API Guard controllers in app/controllers/'
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     argument :scope, required: true, desc: 'The scope to create controllers in, e.g. users, admins'
 
-    class_option :controllers, aliases: "-c", type: :array,
+    class_option :controllers, aliases: '-c', type: :array,
                                desc: "Specify the controllers to generate (#{CONTROLLERS.join(', ')})"
 
     def create_controllers

data/lib/generators/api_guard/initializer/initializer_generator.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ApiGuard
   class InitializerGenerator < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     desc 'Creates initializer for configuring API Guard'
 

data/lib/generators/api_guard/initializer/templates/initializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ApiGuard.setup do |config|
   # Validity of the JWT access token
   # Default: 1 day

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_guard
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gokul Murali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-14 00:00:00.000000000 Z
+date: 2020-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -31,65 +31,65 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: bcrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.5
+        version: 3.1.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.5
+        version: 3.1.11
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '4.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.13
+        version: 4.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '4.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.13
+        version: 4.8.2
 - !ruby/object:Gem::Dependency
-  name: bcrypt
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.11
+        version: 5.1.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.11
+        version: 5.1.5
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -111,25 +111,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.7.2
 - !ruby/object:Gem::Dependency
-  name: factory_bot_rails
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.8.2
+        version: 0.75.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.8.2
+        version: 0.75.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +144,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
 description: JWT authentication solution for Rails APIs
 email:
 - m.gokul595@gmail.com
@@ -165,8 +179,6 @@ files:
 - app/controllers/api_guard/passwords_controller.rb
 - app/controllers/api_guard/registration_controller.rb
 - app/controllers/api_guard/tokens_controller.rb
-- app/models/api_guard/application_record.rb
-- app/views/layouts/api_guard/application.html.erb
 - config/locales/en.yml
 - config/routes.rb
 - lib/api_guard.rb

data/app/models/api_guard/application_record.rb

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

data/app/views/layouts/api_guard/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>API Guard</title>
-  <%= stylesheet_link_tag    "api_guard/application", media: "all" %>
-  <%= javascript_include_tag "api_guard/application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>