knock_knock 0.1.1.pre.preview1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d4bf4e3ad03c136e8975a450464a1f0d4627dbe07deddbb3a09e58adecfda5f
+  data.tar.gz: a68fde0d3b770805f7c48114c1a4a1af584453d88a8710aab683c601b9617a61
+SHA512:
+  metadata.gz: df1263298dc157f4a2d2d7ad50fafb03b74a43c1e4f2ba77e6997d01dc895d72ca745a39d89fd4c651d0022361ef45f2f2f016d8e10436b3b59775a826344702
+  data.tar.gz: b3e424c276398b12a7a3334cc2f4cd7a53653da65f5b65b1b417904a3d8cee542ea7589613db3d633e4752f5e91e6fe8d88590f6aa86997c4a73d63316099a09

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Mayurifag
+
+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,21 @@
+# gem knock_knock
+
+lalala work in progress im gonna write something here.
+
+```ruby
+gem 'knock_knock', github: 'Mayurifag/knock_knock'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## TODO:
+
+[] Readme and gemspec summaries etc +badges +ci beautify
+[] changelog
+[] COC

data/Rakefile

@@ -0,0 +1,33 @@
+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 = "KnockKnock"
+  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 << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/knock_knock/application_controller.rb

@@ -0,0 +1,11 @@
+module KnockKnock
+  class ApplicationController < ActionController::API
+    rescue_from KnockKnock.not_found_exception_class_name, with: :record_invaild
+
+    private
+
+    def record_invaild
+      render json: "Record invalid", status: :unprocessable_entity
+    end
+  end
+end

data/app/controllers/knock_knock/auth_token_controller.rb

@@ -0,0 +1,48 @@
+require_dependency "knock_knock/application_controller"
+
+module KnockKnock
+  class AuthTokenController < ApplicationController
+    before_action :authenticate
+
+    def create
+      render json: auth_token, status: :created
+    end
+
+    private
+
+    def authenticate
+      unless entity&.authenticate(auth_params[:password])
+        raise KnockKnock.not_found_exception_class
+      end
+    end
+
+    def auth_token
+      if entity.respond_to? :to_token_payload
+        AuthToken.new payload: entity.to_token_payload
+      else
+        AuthToken.new payload: {sub: entity.id}
+      end
+    end
+
+    def entity
+      @entity ||=
+        if entity_class.respond_to? :from_token_request
+          entity_class.from_token_request request
+        else
+          entity_class.find_by email: auth_params[:email]
+        end
+    end
+
+    def entity_class
+      entity_name.constantize
+    end
+
+    def entity_name
+      self.class.name.scan(/\w+/).last.split("TokenController").first
+    end
+
+    def auth_params
+      params.permit :email, :password
+    end
+  end
+end

data/app/models/knock_knock/application_record.rb

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

data/app/models/knock_knock/auth_token.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_dependency "jwt"
+
+module KnockKnock
+  class AuthToken
+    attr_reader :token, :payload
+
+    def initialize(payload: {}, token: nil, verify_options: {})
+      if token.present?
+        @payload, _ = JWT.decode(token.to_s, decode_key, true, Claims.to_decode.merge(verify_options))
+        @token = token
+      else
+        @payload = Claims.to_encode.merge(payload)
+        @token = JWT.encode @payload, secret_key, KnockKnock.token_signature_algorithm
+      end
+    end
+
+    def entity_for(entity_class)
+      if entity_class.respond_to? :from_token_payload
+        entity_class.from_token_payload @payload
+      else
+        entity_class.find @payload["sub"]
+      end
+    end
+
+    def to_json(_options = {})
+      {jwt: @token}.to_json
+    end
+
+    private
+
+    def secret_key
+      KnockKnock.token_secret_signature_key.call
+    end
+
+    def decode_key
+      KnockKnock.token_public_key || secret_key
+    end
+  end
+end

data/app/models/knock_knock/claims.rb

@@ -0,0 +1,39 @@
+module KnockKnock
+  class Claims
+    class << self
+      def to_encode
+        claims = {}
+        claims[:exp] = token_lifetime if verify_lifetime?
+        claims[:aud] = token_audience if verify_audience?
+        claims
+      end
+
+      def to_decode
+        {
+          algorithm: KnockKnock.token_signature_algorithm,
+          aud: token_audience,
+          verify_aud: verify_audience?,
+          verify_expiration: verify_lifetime?,
+        }
+      end
+
+      private
+
+      def token_lifetime
+        KnockKnock.token_lifetime.from_now.to_i if verify_lifetime?
+      end
+
+      def verify_lifetime?
+        KnockKnock.token_lifetime.present?
+      end
+
+      def token_audience
+        verify_audience? && KnockKnock.token_audience.call
+      end
+
+      def verify_audience?
+        KnockKnock.token_audience.present?
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+KnockKnock::Engine.routes.draw do
+  post :auth_token, to: "auth_token#create"
+end

data/lib/generators/knock_knock/install_generator.rb

@@ -0,0 +1,20 @@
+require_dependency "rails/generators"
+
+module KnockKnock
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    desc "Creates a KnockKnock initializer."
+
+    TEMPLATE_FILENAME = "knock_knock.rb".freeze
+
+    def copy_initializer
+      template TEMPLATE_FILENAME, app_controller_filepath
+    end
+
+    private
+
+    def app_controller_filepath
+      "config/initializers/#{TEMPLATE_FILENAME}"
+    end
+  end
+end

data/lib/generators/knock_knock/templates/entity_token_controller.rb.erb

@@ -0,0 +1,2 @@
+class <%= entity_name.camelize %>TokenController < KnockKnock::AuthTokenController
+end

data/lib/generators/knock_knock/templates/knock_knock.rb

@@ -0,0 +1,57 @@
+KnockKnock.setup do |config|
+  ## Expiration claim
+  ## ----------------
+  ##
+  ## How long before a token is expired. If nil is provided, token will
+  ## last forever.
+  ##
+  ## Default:
+  # config.token_lifetime = 1.day
+
+  ## Audience claim
+  ## --------------
+  ##
+  ## Configure the audience claim to identify the recipients that the token
+  ## is intended for.
+  ##
+  ## Default:
+  # config.token_audience = nil
+
+  ## If using Auth0, uncomment the line below
+  # config.token_audience = -> { Rails.application.secrets.auth0_client_id }
+
+  ## Signature algorithm
+  ## -------------------
+  ##
+  ## Configure the algorithm used to encode the token
+  ##
+  ## Default:
+  # config.token_signature_algorithm = 'HS256'
+
+  ## Signature key
+  ## -------------
+  ##
+  ## Configure the key used to sign tokens.
+  ##
+  ## Default:
+  # config.token_secret_signature_key = -> { Rails.application.credentials.fetch(:secret_key_base) }
+
+  ## If using Auth0, uncomment the line below
+  # config.token_secret_signature_key = -> { JWT.base64url_decode Rails.application.secrets.auth0_client_secret }
+
+  ## Public key
+  ## ----------
+  ##
+  ## Configure the public key used to decode tokens, if required.
+  ##
+  ## Default:
+  # config.token_public_key = nil
+
+  ## Exception Class
+  ## ---------------
+  ##
+  ## Configure the exception to be used when user cannot be found.
+  ##
+  ## Default:
+  # config.not_found_exception_class_name = 'ActiveRecord::RecordNotFound'
+end

data/lib/generators/knock_knock/token_controller_generator.rb

@@ -0,0 +1,35 @@
+require_dependency "rails/generators"
+
+module KnockKnock
+  # Creates a Knockknock token controller for the given entity
+  # and add the corresponding routes.
+  class TokenControllerGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    argument :entity_name, type: :string
+
+    TEMPLATE_FILENAME = "entity_token_controller.rb.erb".freeze
+
+    desc <<-DESC
+      Creates a Knockknock token controller for the given entity and add the
+      corresponding routes.
+    DESC
+
+    def copy_controller_file
+      template TEMPLATE_FILENAME, app_controller_filepath
+    end
+
+    def add_route
+      route "post :#{undescored_name}_token, to: '#{undescored_name}_token#create'"
+    end
+
+    private
+
+    def undescored_name
+      @undescored_name ||= entity_name.underscore
+    end
+
+    def app_controller_filepath
+      "app/controllers/#{undescored_name}_token_controller.rb"
+    end
+  end
+end

data/lib/knock_knock.rb

@@ -0,0 +1,32 @@
+require "knock_knock/engine"
+require_dependency 'knock_knock/authenticable'
+
+module KnockKnock
+  mattr_accessor :token_lifetime
+  self.token_lifetime = 1.day
+
+  mattr_accessor :token_audience
+  self.token_audience = nil
+
+  mattr_accessor :token_signature_algorithm
+  self.token_signature_algorithm = "HS256"
+
+  mattr_accessor :token_secret_signature_key
+  self.token_secret_signature_key = -> { Rails.application.secrets.secret_key_base }
+
+  mattr_accessor :token_public_key
+  self.token_public_key = nil
+
+  mattr_accessor :not_found_exception_class_name
+  self.not_found_exception_class_name = "ActiveRecord::RecordNotFound"
+
+  def self.not_found_exception_class
+    not_found_exception_class_name.to_s.constantize
+  end
+
+  # Default way to setup KnockKnock. Run `rails generate knock_knock:install` to create
+  # a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+  end
+end

data/lib/knock_knock/authenticable.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module KnockKnock::Authenticable
+  def authenticate_for(entity_class)
+    getter_name = "current_#{entity_class.to_s.parameterize.underscore}"
+    define_current_entity_getter(entity_class, getter_name)
+    public_send(getter_name)
+  end
+
+  private
+
+  def token
+    params[:token] || token_from_request_headers
+  end
+
+  def method_missing(method, *args)
+    prefix, entity_name = method.to_s.split("_", 2)
+    case prefix
+    when "authenticate"
+      unauthorized_entity(entity_name) unless authenticate_entity(entity_name)
+    when "current"
+      authenticate_entity(entity_name)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    method_name.to_s.start_with?("authenticate_") || super
+  end
+
+  def authenticate_entity(entity_name)
+    if token
+      entity_class = entity_name.camelize.constantize
+      send(:authenticate_for, entity_class)
+    end
+  end
+
+  def unauthorized_entity(_entity_name)
+    head(:unauthorized)
+  end
+
+  def token_from_request_headers
+    request.headers["Authorization"]&.split&.last
+  end
+
+  def define_current_entity_getter(entity_class, getter_name)
+    unless respond_to?(getter_name)
+      memoization_var_name = "@_#{getter_name}"
+      self.class.send(:define_method, getter_name) do
+        unless instance_variable_defined?(memoization_var_name)
+          current =
+            begin
+              KnockKnock::AuthToken.new(token: token).entity_for(entity_class)
+            rescue KnockKnock.not_found_exception_class, JWT::DecodeError, JWT::EncodeError
+              nil
+            end
+          instance_variable_set(memoization_var_name, current)
+        end
+        instance_variable_get(memoization_var_name)
+      end
+    end
+  end
+end

data/lib/knock_knock/engine.rb

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

data/lib/knock_knock/version.rb

@@ -0,0 +1,3 @@
+module KnockKnock
+  VERSION = "0.1.1-preview1"
+end

data/lib/tasks/knock_knock_tasks.rake

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: knock_knock
+version: !ruby/object:Gem::Version
+  version: 0.1.1.pre.preview1
+platform: ruby
+authors:
+- Mayurifag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !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: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Description of KnockKnock.
+email:
+- farazeus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/knock_knock/application_controller.rb
+- app/controllers/knock_knock/auth_token_controller.rb
+- app/models/knock_knock/application_record.rb
+- app/models/knock_knock/auth_token.rb
+- app/models/knock_knock/claims.rb
+- config/routes.rb
+- lib/generators/knock_knock/install_generator.rb
+- lib/generators/knock_knock/templates/entity_token_controller.rb.erb
+- lib/generators/knock_knock/templates/knock_knock.rb
+- lib/generators/knock_knock/token_controller_generator.rb
+- lib/knock_knock.rb
+- lib/knock_knock/authenticable.rb
+- lib/knock_knock/engine.rb
+- lib/knock_knock/version.rb
+- lib/tasks/knock_knock_tasks.rake
+homepage: https://github.com/Mayurifag/knock_knock
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Summary of KnockKnock.
+test_files: []