secretkeeper 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 84593075dabb8014b00ac2efb375f56c5fdbc7db
-  data.tar.gz: 9bf59fb59e734f7c4bbe77b93bbe4e8d991475ca
+SHA256:
+  metadata.gz: 4aaccaa792079587f03048814194318bda9674d49349d0b718198ae056695820
+  data.tar.gz: bbcadf0fcb47cd9a74a9cf8d2ea09877b2325df7ab6490fc1c01927f0db82cee
 SHA512:
-  metadata.gz: ce4af121133d3dd16483d845f601f769259528aee732d71101973dc06f73b4c9dde33c088ac9939df7bad2903b57331c5bc5fc3d950be34cfbb71ca49e9dde63
-  data.tar.gz: bb5a2be005753e563a499b46c0ba81792035c53cb1c06b07127381a80dae13e46dddf0ecfc1ac39273966d794d6fc6aaf808306838065032da71f89f8ecf0631
+  metadata.gz: 5ed5e626b3ed28f2965672f4cde83e154cb3d162caff25d08e258269ffdb730cc06ffd756b0c249f7b89a91ff930f4389e4cf65cdfb3a0c689d0d776f39eed9f
+  data.tar.gz: 61799d52dc349a0639d6677d88411a87a5bbbf343e22eeee747417933e2122a3128d4fa2f44a080ab5c1508c6315f2b0a3895b94ac1f34a9a684086ae0bf1495

data/README.md

@@ -1,10 +1,8 @@
 # Secretkeeper
-Short description and motivation.
-
-## Usage
-How to use my plugin.
+Token based authentication.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -26,5 +24,38 @@ Run the installation generator with:
 rails generate secretkeeper:install
 ```
 
+## Usage
+
+### Authorizing requests
+
+``` ruby
+class Api::BaseController < ActionController::API
+  before_action :secretkeeper_authorize!
+end
+```
+
+### Authenticating
+
+`config/initializers/secretkeeper.rb`:
+
+``` ruby
+Secretkeeper.reflect do |on|
+  on.resource_owner do |params|
+    User.authenticate!(params[:name], params[:password])
+  end
+end
+```
+
+### Routes
+
+The installation script will also automatically add the Secretkeeper routes into your app.
+
+``` ruby
+Rails.application.routes.draw do
+  secretkeeper
+end
+```
+
 ## License
+
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,5 +1,7 @@
-require "bundler/setup"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rspec/core/rake_task'
 
 # begin
 #   require 'bundler/setup'
@@ -17,11 +19,6 @@ require "rspec/core/rake_task"
 #   rdoc.rdoc_files.include('lib/**/*.rb')
 # end
 
-
-
-
-
-
 # require 'bundler/gem_tasks'
 
 # require 'rake/testtask'
@@ -32,10 +29,10 @@ require "rspec/core/rake_task"
 #   t.verbose = false
 # end
 
-desc "Default: run specs."
+desc 'Default: run specs.'
 task default: :spec
 
-desc "Run all specs"
+desc 'Run all specs'
 RSpec::Core::RakeTask.new(:spec) do |config|
   config.verbose = false
 end

data/app/controllers/secretkeeper/auth_controller.rb

@@ -1,41 +1,45 @@
+# frozen_string_literal: true
+
 module Secretkeeper
   class AuthController < ActionController::Metal
     include AbstractController::Rendering
-    include ActionController::Rendering
-    include ActionController::Renderers
     include ActionController::Head
+    include ActionController::Renderers
+    include ActionController::Rendering
 
     use_renderers :json
 
     def create_token
       resource_owner = Secretkeeper.reflection_resource_owner.call(params)
-      if resource_owner.present?
-        access_token = Secretkeeper::AccessToken.create(owner: resource_owner)
-        render json: {
-          access_token: access_token.token,
-          expires_in: access_token.expires_in,
-          refresh_token: access_token.refresh_token,
-          created_at: access_token.created_at.to_i
-        }, status: 201
-      else
-        head 401
-      end
+
+      return head 401 if resource_owner.nil?
+
+      @access_token = Secretkeeper::AccessToken.create(owner: resource_owner)
+      render json: success, status: 201
     end
 
     def refresh_token
-      token = Secretkeeper::AccessToken.find_by(refresh_token: params[:refresh_token])
-      if token.present? && token.refreshable?
-        token.revoke!
-        new_token = Secretkeeper::AccessToken.create(owner: token.owner)
-        render json: {
-          access_token: new_token.token,
-          expires_in: new_token.expires_in,
-          refresh_token: new_token.refresh_token,
-          created_at: DateTime.now.to_i
-        }
-      else
-        head 403
-      end
+      return head 403 unless old_token&.refreshable?
+
+      old_token.revoke!
+      @access_token = Secretkeeper::AccessToken.create(owner: old_token.owner)
+      render json: success
+    end
+
+    private
+
+    def success
+      {
+        access_token: @access_token.token,
+        expires_in: @access_token.expires_in,
+        refresh_token: @access_token.refresh_token,
+        created_at: @access_token.created_at.to_i
+      }
+    end
+
+    def old_token
+      @old_token ||=
+        Secretkeeper::AccessToken.find_by(refresh_token: params[:refresh_token])
     end
   end
 end

data/lib/generators/secretkeeper/install_generator.rb

@@ -1,28 +1,36 @@
-require "rails/generators/active_record"
+# frozen_string_literal: true
 
-class Secretkeeper::InstallGenerator < ::Rails::Generators::Base
-  include Rails::Generators::Migration
+require 'rails/generators/active_record'
 
-  source_root File.expand_path("../templates", __FILE__)
+module Secretkeeper
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
 
-  def install
-    copy_file "initializer.rb", "config/initializers/secretkeeper.rb"
-    migration_template(
-      "migration.rb",
-      "db/migrate/create_secretkeeper_tables.rb",
-      migration_version: migration_version
-    )
-    route "secretkeeper"
-  end
+    source_root File.expand_path('templates', __dir__)
 
-  def self.next_migration_number(dirname)
-    next_migration_number = current_migration_number(dirname) + 1
-    ActiveRecord::Migration.next_migration_number(next_migration_number)
-  end
+    def install
+      copy_file 'initializer.rb', 'config/initializers/secretkeeper.rb'
+      migration_template(
+        'migration.rb',
+        'db/migrate/create_secretkeeper_tables.rb',
+        migration_version: migration_version
+      )
+      route 'secretkeeper'
+    end
+
+    def self.next_migration_number(dirname)
+      next_migration_number = current_migration_number(dirname) + 1
+      ActiveRecord::Migration.next_migration_number(next_migration_number)
+    end
+
+    private
+
+    def migration_version
+      formatted_version if ::Rails.version >= '5.0.0'
+    end
 
-  def migration_version
-    if Rails.version >= "5.0.0"
-      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    def formatted_version
+      "[#{::Rails::VERSION::MAJOR}.#{::Rails::VERSION::MINOR}]"
     end
   end
 end

data/lib/generators/secretkeeper/templates/migration.rb

@@ -1,7 +1,7 @@
 class CreateSecretkeeperTables < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :secretkeeper_access_tokens do |t|
-      t.references :owner, polymorphic: true, index: true
+      t.references :owner, polymorphic: true, index: true, null: false
       t.string     :token, null: false, index: true, unique: true
       t.string     :refresh_token, null: false, index: true, unique: true
       t.integer    :expires_in

data/lib/secretkeeper.rb

@@ -1,4 +1,6 @@
-require "secretkeeper/config"
-require "secretkeeper/access_token"
-require "secretkeeper/engine"
-require "secretkeeper/rails/router"
+# frozen_string_literal: true
+
+require 'secretkeeper/rails/router'
+require 'secretkeeper/access_token'
+require 'secretkeeper/configuration'
+require 'secretkeeper/engine'

data/lib/secretkeeper/access_token.rb

@@ -1,23 +1,23 @@
+# frozen_string_literal: true
+
 module Secretkeeper
   class AccessToken < ::ActiveRecord::Base
-    self.table_name = "secretkeeper_access_tokens"
+    self.table_name = 'secretkeeper_access_tokens'
+
     belongs_to :owner, polymorphic: true
 
     def initialize(attributes = {})
-      access_token, refresh_token, expires_in = nil
       loop do
-        access_token = AccessToken.generate
-        refresh_token = AccessToken.generate
-        break unless AccessToken.exists?(token: access_token, refresh_token: refresh_token)
+        @access_token = AccessToken.generate
+        @r_token = AccessToken.generate
+        break unless token_exists?
       end
-      expires_in = Secretkeeper.configuration.access_token_expires_in
-      super((attributes || {}).merge({
-        token: access_token, refresh_token: refresh_token, expires_in: expires_in
-      }))
+      @token_expires_in = Secretkeeper.configuration.access_token_expires_in
+      super((attributes || {}).merge(token_params))
     end
 
     def revoke!
-      revoked_at.nil? && update_attribute(:revoked_at, DateTime.now)
+      revoked_at.nil? && update(revoked_at: Time.zone.now)
     end
 
     def accessible?
@@ -29,7 +29,7 @@ module Secretkeeper
     end
 
     def expired?
-      created_at + expires_in.seconds <= DateTime.now
+      created_at + expires_in.seconds <= Time.zone.now
     end
 
     def refreshable?
@@ -39,5 +39,21 @@ module Secretkeeper
     def self.generate
       SecureRandom.hex(32)
     end
+
+    private
+
+    attr_reader :access_token, :r_token, :token_expires_in
+
+    def token_exists?
+      AccessToken.exists?(token: access_token, refresh_token: r_token)
+    end
+
+    def token_params
+      {
+        token: access_token,
+        refresh_token: r_token,
+        expires_in: token_expires_in
+      }
+    end
   end
 end

data/lib/secretkeeper/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Secretkeeper
+  class << self
+    attr_reader :reflection_resource_owner
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reflect(&block)
+      class_eval(&block)
+    end
+
+    def resource_owner(&block)
+      @reflection_resource_owner = block
+    end
+  end
+
+  class Configuration
+    attr_accessor :access_token_expires_in
+  end
+end

data/lib/secretkeeper/engine.rb

@@ -1,8 +1,10 @@
-require "secretkeeper/rails/helpers"
+# frozen_string_literal: true
+
+require 'secretkeeper/rails/helpers'
 
 module Secretkeeper
   class Engine < ::Rails::Engine
-    initializer "secretkeeper.controller_helpers" do
+    initializer 'secretkeeper.controller_helpers' do
       ActiveSupport.on_load(:action_controller) do
         include Secretkeeper::Rails::Helpers
       end

data/lib/secretkeeper/rails/helpers.rb

@@ -1,17 +1,35 @@
+# frozen_string_literal: true
+
 module Secretkeeper
   module Rails
     module Helpers
       extend ActiveSupport::Concern
 
       def secretkeeper_authorize!
-        header = request.headers["Authorization"]
-        if header && header.start_with?("Bearer ")
-          token = Secretkeeper::AccessToken.find_by(token: header[7..-1])
-          if token.present? && token.accessible?
-            @resource_owner = token.owner
-            return true 
-          end
-        end
+        return secretkeeper_render_error unless secretkeeper_token_acceptable?
+
+        @resource_owner = secretkeeper_access_token.owner
+      end
+
+      private
+
+      def secretkeeper_token_acceptable?
+        secretkeeper_auth_header_valid? &&
+          secretkeeper_access_token.owner.present?
+      end
+
+      def secretkeeper_auth_header_valid?
+        request.headers['Authorization']&.start_with?('Bearer ') &&
+          secretkeeper_access_token&.accessible?
+      end
+
+      def secretkeeper_access_token
+        @secretkeeper_access_token ||= Secretkeeper::AccessToken.find_by(
+          token: request.headers['Authorization'][7..-1]
+        )
+      end
+
+      def secretkeeper_render_error
         head 401
       end
     end

data/lib/secretkeeper/rails/router.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module ActionDispatch
   module Routing
     class Mapper
       def secretkeeper
-        resources :auth, module: "secretkeeper", only: [] do
+        resources :auth, module: 'secretkeeper', only: [] do
           collection do
             post :create_token
             post :refresh_token

data/lib/secretkeeper/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Secretkeeper
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secretkeeper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Igor Korepanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,62 +25,88 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
-  name: rspec-activemodel-mocks
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.9.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.9.4
 - !ruby/object:Gem::Dependency
-  name: factory_girl_rails
+  name: rspec-json_expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: generator_spec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.4
-description: 
+        version: '3.6'
+- !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'
+description: Token based authentication
 email:
 - secretkeeper.gem@gmail.com
 executables: []
@@ -96,7 +122,7 @@ files:
 - lib/generators/secretkeeper/templates/migration.rb
 - lib/secretkeeper.rb
 - lib/secretkeeper/access_token.rb
-- lib/secretkeeper/config.rb
+- lib/secretkeeper/configuration.rb
 - lib/secretkeeper/engine.rb
 - lib/secretkeeper/rails/helpers.rb
 - lib/secretkeeper/rails/router.rb
@@ -121,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Token based authentication

data/lib/secretkeeper/config.rb

@@ -1,30 +0,0 @@
-module Secretkeeper
-  class << self
-    attr_accessor :configuration
-    attr_accessor :reflection_resource_owner
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    yield(configuration)
-  end
-
-  def self.reflect(&block)
-    class_eval(&block)
-  end
-
-  def self.resource_owner(&block)
-    @reflection_resource_owner = block
-  end
-
-  class Configuration
-    attr_accessor :access_token_expires_in
-
-    def initialize
-      @access_token_expires_in = 1.hour
-    end
-  end
-end