api_guard 0.2.2 → 0.5.2

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.2.2'
+  VERSION = '0.5.2'
 end

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

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 module ApiGuard
   class ControllersGenerator < Rails::Generators::Base
-    CONTROLLERS = %i[registration authentication tokens passwords]
+    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"
+    argument :scope, required: true, desc: 'The scope to create controllers in, e.g. users, admins'
 
-    class_option :controllers, aliases: "-c", type: :array,
-                 desc: "Specify the controllers to generate (#{CONTROLLERS.join(', ')})"
+    class_option :controllers, aliases: '-c', type: :array,
+                               desc: "Specify the controllers to generate (#{CONTROLLERS.join(', ')})"
 
     def create_controllers
       @controller_scope = scope.camelize
       controllers = options[:controllers] || CONTROLLERS
 
       controllers.each do |controller_name|
-        template "#{controller_name}_controller.rb", "app/controllers/#{scope}/#{controller_name}_controller.rb"
+        template "#{controller_name}_controller.rb",
+                 "app/controllers/#{scope}/#{controller_name}_controller.rb"
       end
     end
   end

data/lib/generators/api_guard/controllers/templates/authentication_controller.rb

@@ -6,22 +6,22 @@ module <%= @controller_scope %>
     # def create
     #   if resource.authenticate(params[:password])
     #     create_token_and_set_header(resource, resource_name)
-    #     render_success(data: resource)
+    #     render_success(message: I18n.t('api_guard.authentication.signed_in'))
     #   else
-    #     render_error(422, message: 'Invalid login credentials')
+    #     render_error(422, message: I18n.t('api_guard.authentication.invalid_login_credentials'))
     #   end
     # end
 
     # def destroy
     #   blacklist_token
-    #   render_success(message: 'Signed out successfully')
+    #   render_success(message: I18n.t('api_guard.authentication.signed_out'))
     # end
 
     # private
 
     # def find_resource
     #   self.resource = resource_class.find_by(email: params[:email].downcase.strip) if params[:email].present?
-    #   render_error(422, message: 'Invalid login credentials') unless resource
+    #   render_error(422, message: I18n.t('api_guard.authentication.invalid_login_credentials')) unless resource
     # end
   end
 end

data/lib/generators/api_guard/controllers/templates/passwords_controller.rb

@@ -6,11 +6,11 @@ module <%= @controller_scope %>
     #   invalidate_old_jwt_tokens(current_resource)
     #
     #   if current_resource.update_attributes(password_params)
-    #     blacklist_token
+    #     blacklist_token unless ApiGuard.invalidate_old_tokens_on_password_change
     #     destroy_all_refresh_tokens(current_resource)
     #
     #     create_token_and_set_header(current_resource, resource_name)
-    #     render_success(data: current_resource)
+    #     render_success(message: I18n.t('api_guard.password.changed'))
     #   else
     #     render_error(422, object: current_resource)
     #   end
@@ -19,7 +19,7 @@ module <%= @controller_scope %>
     # private
 
     # def password_params
-    #   params.require(resource_name.to_sym).permit(:password, :password_confirmation)
+    #   params.permit(:password, :password_confirmation)
     # end
   end
 end

data/lib/generators/api_guard/controllers/templates/registration_controller.rb

@@ -6,7 +6,7 @@ module <%= @controller_scope %>
     #   init_resource(sign_up_params)
     #   if resource.save
     #     create_token_and_set_header(resource, resource_name)
-    #     render_success(data: resource, message: "#{resource_name.capitalize} created successfully")
+    #     render_success(message: I18n.t('api_guard.registration.signed_up'))
     #   else
     #     render_error(422, object: resource)
     #   end
@@ -14,13 +14,13 @@ module <%= @controller_scope %>
 
     # def destroy
     #   current_resource.destroy
-    #   render_success(message: "#{resource_name.capitalize} destroyed successfully")
+    #   render_success(message: I18n.t('api_guard.registration.account_deleted'))
     # end
 
     # private
 
     # def sign_up_params
-    #   params.require(resource_name.to_sym).permit(:email, :password, :password_confirmation)
+    #   params.permit(:email, :password, :password_confirmation)
     # end
   end
 end

data/lib/generators/api_guard/controllers/templates/tokens_controller.rb

@@ -4,9 +4,12 @@ module <%= @controller_scope %>
     # before_action :find_refresh_token, only: [:create]
 
     # def create
-    #   @refresh_token.destroy
     #   create_token_and_set_header(current_resource, resource_name)
-    #   render_success(data: current_resource)
+    #
+    #   @refresh_token.destroy
+    #   blacklist_token if ApiGuard.blacklist_token_after_refreshing
+    #
+    #   render_success(message: I18n.t('api_guard.access_token.refreshed'))
     # end
 
     # private
@@ -16,9 +19,9 @@ module <%= @controller_scope %>
     #
     #   if refresh_token_from_header
     #     @refresh_token = find_refresh_token_of(current_resource, refresh_token_from_header)
-    #     return render_error(401, message: 'Invalid refresh token') unless @refresh_token
+    #     return render_error(401, message: I18n.t('api_guard.refresh_token.invalid')) unless @refresh_token
     #   else
-    #     render_error(401, message: 'Refresh token is missing in the request')
+    #     render_error(401, message: I18n.t('api_guard.refresh_token.missing'))
     #   end
     # end
   end

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,17 +1,19 @@
+# frozen_string_literal: true
+
 ApiGuard.setup do |config|
   # Validity of the JWT access token
   # Default: 1 day
-  config.token_validity = 1.day
+  # config.token_validity = 1.day
 
   # Secret key for signing (encoding & decoding) the JWT access token
   # Default: 'secret_key_base' from Rails secrets
-  config.token_signing_secret = Rails.application.secrets.secret_key_base
+  # config.token_signing_secret = 'my_signing_secret'
 
   # Invalidate old tokens on changing the password
   # Default: false
-  config.invalidate_old_tokens_on_password_change = false
+  # config.invalidate_old_tokens_on_password_change = false
 
   # Blacklist JWT access token after refreshing
   # Default: false
-  config.blacklist_token_after_refreshing = false
+  # config.blacklist_token_after_refreshing = false
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_guard
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.5.2
 platform: ruby
 authors:
 - Gokul Murali
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2021-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -16,140 +16,126 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: bcrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.1.5
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.1.5
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.13
+        version: '6.1'
   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
+        version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: bcrypt
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.11
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.11
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.7.2
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.7.2
+        version: '4.0'
 - !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
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.16'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
-    - - ">="
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '1.4'
 description: JWT authentication solution for Rails APIs
 email:
 - m.gokul595@gmail.com
@@ -165,8 +151,7 @@ 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
 - lib/api_guard/app_secret_key.rb
@@ -195,7 +180,7 @@ homepage: https://github.com/Gokul595/api_guard
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,16 +188,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Rails API authentication made easy
 test_files: []

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>