KnockRails3 2.1.1

data/test/dummy/test/models/admin_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class AdminTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/dummy/test/models/user_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class UserTest < ActiveSupport::TestCase
+end

data/test/dummy/test/models/vendor_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class VendorTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/fixtures/admins.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+one:
+  email: admin.one@example.net
+  password_digest: <%= BCrypt::Password.create('secret', cost: 4) %>

data/test/fixtures/composite_name_entities.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+one:
+  email: composite_name_entity.one@example.net
+  password_digest: <%= BCrypt::Password.create('secret', cost: 4) %>

data/test/fixtures/users.yml

@@ -0,0 +1,9 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+one:
+  email: one@example.net
+  password_digest: <%= BCrypt::Password.create('secret', cost: 4) %>
+
+two:
+  email: two@example.net
+  password_digest: <%= BCrypt::Password.create('secret', cost: 4) %>

data/test/fixtures/v1_users.yml

@@ -0,0 +1,6 @@
+
+one:
+  email: v1user@example.net
+  password_digest: <%= BCrypt::Password.create('secret', cost: 4) %>
+  created_at: <%= Time.now.utc %>
+  updated_at: <%= Time.now.utc %>

data/test/fixtures/vendors.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+one:
+  email: vendor.one@example.net
+  password_digest: <%= BCrypt::Password.create('secret', cost: 4) %>

data/test/generators/install_generator_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  tests KnockRails3::InstallGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  test "Assert all files are properly created" do
+    run_generator
+    assert_file "config/initializers/KnockRails3.rb"
+  end
+end

data/test/generators/token_controller_generator_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+
+class TokenControllerGeneratorTest < Rails::Generators::TestCase
+  include GeneratorsTestHelper
+
+  tests KnockRails3::TokenControllerGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+
+  setup :prepare_destination
+  setup :copy_routes
+
+  test "assert all files are properly created" do
+    run_generator ['User']
+    assert_file "app/controllers/user_token_controller.rb"
+
+    run_generator ['Admin']
+    assert_file "app/controllers/user_token_controller.rb"
+
+    run_generator ['AdminUser']
+    assert_file "app/controllers/admin_user_token_controller.rb"
+
+    require File.join(destination_root, "app/controllers/admin_user_token_controller.rb")
+    assert Object.const_defined?('AdminUserTokenController'), 'uninitialized constant AdminUserTokenController'
+
+    run_generator ['user_admin']
+    assert_file "app/controllers/user_admin_token_controller.rb"
+
+    require File.join(destination_root, "app/controllers/user_admin_token_controller.rb")
+    assert Object.const_defined?('UserAdminTokenController'), 'uninitialized constant UserAdminTokenController'
+  end
+end

data/test/knock_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class KnockRails3Test < ActiveSupport::TestCase
+  test 'setup block yields self' do
+    KnockRails3.setup do |config|
+      assert_equal KnockRails3, config
+    end
+  end
+end

data/test/model/knock/auth_token_test.rb

@@ -0,0 +1,123 @@
+require 'test_helper'
+require 'jwt'
+require 'timecop'
+
+module KnockRails3
+  class AuthTokenTest < ActiveSupport::TestCase
+    setup do
+      key = KnockRails3.token_secret_signature_key.call
+      @token = JWT.encode({sub: '1'}, key, 'HS256')
+    end
+
+    test "verify algorithm" do
+      KnockRails3.token_signature_algorithm = 'RS256'
+
+      assert_raises(JWT::IncorrectAlgorithm) {
+        AuthToken.new(token: @token)
+      }
+    end
+
+    test "decode RSA encoded tokens" do
+      rsa_private = OpenSSL::PKey::RSA.generate 2048
+      KnockRails3.token_public_key = rsa_private.public_key
+      KnockRails3.token_signature_algorithm = 'RS256'
+
+      token = JWT.encode({sub: "1"}, rsa_private, 'RS256')
+
+      assert_nothing_raised { AuthToken.new(token: token) }
+    end
+
+    test "encode tokens with RSA" do
+      rsa_private = OpenSSL::PKey::RSA.generate 2048
+      KnockRails3.token_secret_signature_key = -> { rsa_private }
+      KnockRails3.token_signature_algorithm = 'RS256'
+
+      token = AuthToken.new(payload: {sub: '1'}).token
+
+      payload, header = JWT.decode token, rsa_private.public_key, true
+      assert_equal payload['sub'], '1'
+      assert_equal header['alg'], 'RS256'
+    end
+
+    test "verify audience when token_audience is present" do
+      KnockRails3.token_audience = -> { 'bar' }
+
+      assert_raises(JWT::InvalidAudError) {
+        AuthToken.new token: @token
+      }
+    end
+
+    test "validate expiration claim by default" do
+      token = AuthToken.new(payload: {sub: 'foo'}).token
+      Timecop.travel(25.hours.from_now) do
+        assert_raises(JWT::ExpiredSignature) {
+          AuthToken.new(token: token)
+        }
+      end
+    end
+
+    test "does not validate expiration claim with a nil token_lifetime" do
+      KnockRails3.token_lifetime = nil
+
+      token = AuthToken.new(payload: {sub: 'foo'}).token
+      Timecop.travel(10.years.from_now) do
+        assert_not AuthToken.new(token: token).payload.has_key?('exp')
+      end
+    end
+
+    test "validate aud when verify_options[:verify_aud] is true" do
+      verify_options = {
+          verify_aud: true
+      }
+      KnockRails3.token_audience = -> { 'bar' }
+      key = KnockRails3.token_secret_signature_key.call
+      assert_raises(JWT::InvalidAudError) {
+        AuthToken.new token: @token, verify_options: verify_options
+      }
+    end
+
+    test "does not validate aud when verify_options[:verify_aud] is false" do
+      verify_options = {
+          verify_aud: false
+      }
+      KnockRails3.token_audience = -> { 'bar' }
+      key = KnockRails3.token_secret_signature_key.call
+      assert_not AuthToken.new(token: @token, verify_options: verify_options).payload.has_key?('aud')
+    end
+
+    test "validate expiration when verify_options[:verify_expiration] is true" do
+      verify_options = {
+          verify_expiration: true
+      }
+      token = AuthToken.new(payload: {sub: 'foo'}).token
+      Timecop.travel(25.hours.from_now) do
+        assert_raises(JWT::ExpiredSignature) {
+          AuthToken.new(token: token, verify_options: verify_options)
+        }
+      end
+    end
+
+    test "does not validate expiration when verify_options[:verify_expiration] is false" do
+      verify_options = {
+          verify_expiration: false
+      }
+      token = AuthToken.new(payload: {sub: 'foo'}).token
+      Timecop.travel(25.hours.from_now) do
+        assert AuthToken.new(token: token, verify_options: verify_options).payload.has_key?('exp')
+      end
+    end
+
+    test "KnockRails3::AuthToken has all payloads" do
+      KnockRails3.token_lifetime = 7.days
+      payload = KnockRails3::AuthToken.new(payload: { sub: 'foo' }).payload
+      assert payload.has_key?(:sub)
+      assert payload.has_key?(:exp)
+    end
+
+    test "is serializable" do
+      auth_token = AuthToken.new token: @token
+
+      assert_equal("{\"jwt\":\"#{@token}\"}", auth_token.to_json)
+    end
+  end
+end

data/test/support/generators_test_helper.rb

@@ -0,0 +1,9 @@
+module GeneratorsTestHelper
+  def copy_routes
+    routes = File.expand_path("../../dummy/config/routes.rb", __FILE__)
+    destination = File.join(destination_root, "config")
+
+    FileUtils.mkdir_p(destination)
+    FileUtils.cp routes, destination
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,45 @@
+require 'simplecov'
+
+SimpleCov.start
+
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../../test/dummy/config/environment.rb",  __FILE__)
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]
+ActiveRecord::Migrator.migrations_paths << File.expand_path('../../db/migrate', __FILE__)
+require "rails/test_help"
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.respond_to?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+  ActiveSupport::TestCase.fixtures :all
+end
+
+module KnockRails3
+  class MyCustomException < StandardError
+  end
+end
+
+# Make sure KnockRails3 global configuration is reset before every tests
+# to avoid order dependent failures.
+class ActiveSupport::TestCase
+  setup :reset_KnockRails3_configuration
+
+  private
+
+  def reset_KnockRails3_configuration
+    KnockRails3.token_signature_algorithm = 'HS256'
+    KnockRails3.token_secret_signature_key = -> { Rails.application.secrets.secret_key_base }
+    KnockRails3.token_public_key = nil
+    KnockRails3.token_audience = nil
+    KnockRails3.token_lifetime = 1.day
+  end
+end

metadata

@@ -0,0 +1,292 @@
+--- !ruby/object:Gem::Specification
+name: KnockRails3
+version: !ruby/object:Gem::Version
+  version: 2.1.1
+platform: ruby
+authors:
+- Hussein
+- Rudy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.22.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.22.1
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Authentication solution for Rails 3 based on JWT
+email:
+- engineering@lynks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/controllers/knock_rails3/application_controller.rb
+- app/controllers/knock_rails3/auth_token_controller.rb
+- app/model/knock_rails3/auth_token.rb
+- config/routes.rb
+- lib/KnockRails3.rb
+- lib/generators/knock_rails3/install_generator.rb
+- lib/generators/knock_rails3/token_controller_generator.rb
+- lib/generators/templates/entity_token_controller.rb.erb
+- lib/generators/templates/knock_rails3.rb
+- lib/knock_rails3/authenticable.rb
+- lib/knock_rails3/engine.rb
+- lib/knock_rails3/version.rb
+- lib/tasks/KnockRails3_tasks.rake
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/admin_protected_controller.rb
+- test/dummy/app/controllers/admin_token_controller.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/composite_name_entity_protected_controller.rb
+- test/dummy/app/controllers/current_users_controller.rb
+- test/dummy/app/controllers/custom_unauthorized_entity_controller.rb
+- test/dummy/app/controllers/guest_protected_controller.rb
+- test/dummy/app/controllers/protected_resources_controller.rb
+- test/dummy/app/controllers/v1/test_namespaced_controller.rb
+- test/dummy/app/controllers/vendor_protected_controller.rb
+- test/dummy/app/controllers/vendor_token_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/models/admin.rb
+- test/dummy/app/models/composite_name_entity.rb
+- test/dummy/app/models/guest.rb
+- test/dummy/app/models/user.rb
+- test/dummy/app/models/v1/user.rb
+- test/dummy/app/models/vendor.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/bin/setup
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/knock.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/config/secrets.yml
+- test/dummy/db/migrate/20150713101607_create_users.rb
+- test/dummy/db/migrate/20160519075733_create_admins.rb
+- test/dummy/db/migrate/20160522051816_create_vendors.rb
+- test/dummy/db/migrate/20160522181712_create_composite_name_entities.rb
+- test/dummy/db/migrate/20161127203222_create_v1_users.rb
+- test/dummy/db/schema.rb
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/dummy/test/controllers/admin_protected_controller_test.rb
+- test/dummy/test/controllers/admin_token_controller_test.rb
+- test/dummy/test/controllers/composite_name_entity_protected_controller_test.rb
+- test/dummy/test/controllers/current_users_controller_test.rb
+- test/dummy/test/controllers/custom_unauthorized_entity_controller_test.rb
+- test/dummy/test/controllers/guest_protected_controller_test.rb
+- test/dummy/test/controllers/protected_resources_controller_test.rb
+- test/dummy/test/controllers/v1/test_namespaced_controller_test.rb
+- test/dummy/test/controllers/vendor_protected_controller_test.rb
+- test/dummy/test/controllers/vendor_token_controller_test.rb
+- test/dummy/test/models/admin_test.rb
+- test/dummy/test/models/user_test.rb
+- test/dummy/test/models/vendor_test.rb
+- test/fixtures/admins.yml
+- test/fixtures/composite_name_entities.yml
+- test/fixtures/users.yml
+- test/fixtures/v1_users.yml
+- test/fixtures/vendors.yml
+- test/generators/install_generator_test.rb
+- test/generators/token_controller_generator_test.rb
+- test/knock_test.rb
+- test/model/knock/auth_token_test.rb
+- test/support/generators_test_helper.rb
+- test/test_helper.rb
+homepage: https://github.com/Lynks/Knock-rails3
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Seamless JWT authentication for Rails 3 API.
+test_files:
+- test/support/generators_test_helper.rb
+- test/test_helper.rb
+- test/model/knock/auth_token_test.rb
+- test/dummy/README.rdoc
+- test/dummy/public/500.html
+- test/dummy/public/422.html
+- test/dummy/public/404.html
+- test/dummy/public/favicon.ico
+- test/dummy/app/controllers/guest_protected_controller.rb
+- test/dummy/app/controllers/composite_name_entity_protected_controller.rb
+- test/dummy/app/controllers/v1/test_namespaced_controller.rb
+- test/dummy/app/controllers/admin_protected_controller.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/vendor_token_controller.rb
+- test/dummy/app/controllers/admin_token_controller.rb
+- test/dummy/app/controllers/vendor_protected_controller.rb
+- test/dummy/app/controllers/current_users_controller.rb
+- test/dummy/app/controllers/protected_resources_controller.rb
+- test/dummy/app/controllers/custom_unauthorized_entity_controller.rb
+- test/dummy/app/models/composite_name_entity.rb
+- test/dummy/app/models/admin.rb
+- test/dummy/app/models/user.rb
+- test/dummy/app/models/v1/user.rb
+- test/dummy/app/models/guest.rb
+- test/dummy/app/models/vendor.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/test/controllers/guest_protected_controller_test.rb
+- test/dummy/test/controllers/vendor_token_controller_test.rb
+- test/dummy/test/controllers/protected_resources_controller_test.rb
+- test/dummy/test/controllers/composite_name_entity_protected_controller_test.rb
+- test/dummy/test/controllers/v1/test_namespaced_controller_test.rb
+- test/dummy/test/controllers/admin_token_controller_test.rb
+- test/dummy/test/controllers/vendor_protected_controller_test.rb
+- test/dummy/test/controllers/current_users_controller_test.rb
+- test/dummy/test/controllers/admin_protected_controller_test.rb
+- test/dummy/test/controllers/custom_unauthorized_entity_controller_test.rb
+- test/dummy/test/models/user_test.rb
+- test/dummy/test/models/vendor_test.rb
+- test/dummy/test/models/admin_test.rb
+- test/dummy/db/schema.rb
+- test/dummy/db/migrate/20160519075733_create_admins.rb
+- test/dummy/db/migrate/20160522051816_create_vendors.rb
+- test/dummy/db/migrate/20150713101607_create_users.rb
+- test/dummy/db/migrate/20160522181712_create_composite_name_entities.rb
+- test/dummy/db/migrate/20161127203222_create_v1_users.rb
+- test/dummy/config.ru
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/secrets.yml
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/knock.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/database.yml
+- test/dummy/config/application.rb
+- test/dummy/Rakefile
+- test/dummy/bin/rails
+- test/dummy/bin/bundle
+- test/dummy/bin/rake
+- test/dummy/bin/setup
+- test/knock_test.rb
+- test/generators/install_generator_test.rb
+- test/generators/token_controller_generator_test.rb
+- test/fixtures/composite_name_entities.yml
+- test/fixtures/v1_users.yml
+- test/fixtures/users.yml
+- test/fixtures/vendors.yml
+- test/fixtures/admins.yml