model_token_auth 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49db6e46e41db1431294c4880f1c1a51a5589191c2ae25bd01aababcf7ea2742
+  data.tar.gz: a02df76c08d5238272631117ad313e528f4f80f61988a091ebb8c6d277cf6325
+SHA512:
+  metadata.gz: c454c6a9641ad6ddcfa7b9f365258716f5e8c6ccf2049265395b96df71a856974438d7592d0261ccf7e79eb194613c52b99c9f3aebe4b5ba3171afbc8436f88a
+  data.tar.gz: 3a873df663303028922811a5edf323e90465bfc97ec50c2f2ce3a871d5116b4304d6eb69c03f80f195b7e610e77f91af28dae6d5b975c5a476a21a0f88449426

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 
+
+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,120 @@
+# ModelTokenAuth
+
+Generates tokens in models and authentication in the controllers.
+
+[![Build Status](https://travis-ci.org/armando1339/model_token_auth.svg?branch=develop)](https://travis-ci.org/armando1339/model_token_auth) [![Coverage Status](https://coveralls.io/repos/github/armando1339/model_token_auth/badge.svg?branch=develop)](https://coveralls.io/github/armando1339/model_token_auth?branch=develop)
+
+## Usage
+
+This plugin handles Token API authentication for models. In models in which
+`#acts_as_model_authenticable` method is called, the instances will be able generating
+a token by calling the methods `#save`, `#create` and `#create!`of ActiveRecord. The
+token is generated in an associated model called AccessToken.
+
+The plugin also handles authentication in the controllers by inserting a generic
+`#authenticate!` method in ActionController::Base or ActionController::API that
+will verify the existence of the token and creates the `current_*` method by adding
+a header `X-Auth-Token` in the request with a token as a value.
+
+### Models
+
+Make models authenticatables.
+
+```ruby
+# example
+
+class Center < ActiveRecord::Base
+  acts_as_model_authenticable
+end
+```
+
+Then.
+
+```ruby
+# create new record
+center = Center.create!
+
+# verify token existence
+center.access_token
+
+# => #<AccessToken:0x00007fca2b1ff430
+#  id: 31,
+#  token: "e897f48950a5c946cd22c4d0c41ad3d3",
+#  entity_type: "Center",
+#  entity_id: 26,
+#  created_at: Fri, 12 Apr 2019 16:42:52 UTC +00:00,
+#  updated_at: Fri, 12 Apr 2019 16:42:52 UTC +00:00>
+```
+
+### Controllers
+
+Allow controllers to handle token authentication
+
+```ruby
+# example ActionController::Base
+
+class ApplicationController < ActionController::Base
+  acts_as_controller_authenticable
+end
+
+# for API only
+
+class ApplicationController < ActionController::API
+  acts_as_controller_authenticable
+end
+```
+
+Then.
+
+```ruby
+# open a scope for centers
+
+module Centers
+  class DummiesController < ApplicationController
+    before_action :authenticate!
+
+    # using current_* generated
+    def show
+      @current = current_center
+    end
+
+    # another example
+    def index
+      @dummies = current_center.dummies
+    end
+
+    ...
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'model_token_auth', '~> 1.0.0'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Contributing
+
+Bug report or pull request are welcome.
+
+Make a pull request:
+
+- Fork it
+- Create your feature branch (git checkout -b my-new-feature)
+- Commit your changes (git commit -am 'Add some feature')
+- Push to the branch (git push origin HEAD)
+- Create new Pull Request
+
+Please write tests if necessary.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+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    = 'ModelTokenAuth'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/generators/access_token/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate access_token_migration Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/access_token/access_token_generator.rb

@@ -0,0 +1,25 @@
+class AccessTokenGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('templates', __dir__)
+
+  def migration
+    migration_template(
+      'migration.rb',
+      'db/migrate/create_access_tokens.rb'
+    )
+  end
+
+  def rails5_and_up?
+    Rails::VERSION::MAJOR >= 5
+  end
+
+  def migration_version
+    if rails5_and_up?
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    end
+  end
+
+  def self.next_migration_number(dir)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+end

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

@@ -0,0 +1,9 @@
+class CreateAccessTokens < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :access_tokens do |t|
+      t.string :token
+      t.references :entity, polymorphic: true, index: true
+      t.timestamps
+    end
+  end
+end

data/lib/model_token_auth/access_tokens_config.rb

@@ -0,0 +1,28 @@
+module ModelTokenAuth
+  module AccessTokensConfig
+    extend ActiveSupport::Concern
+
+    included do
+      
+      # => callbacks
+      after_initialize :assign_token, if: :new_record?
+
+      # => associations
+      belongs_to :entity, polymorphic: true, optional: true
+
+      # => validations
+      validates_presence_of :token
+      validates_uniqueness_of :token, scope: :entity_type, if: :entity_type?
+    end
+
+    private
+
+    def assign_token
+      5.times.each do
+        send(:token=, SecureRandom.hex(16))
+
+        return true unless self.class.find_by_token(token)
+      end
+    end
+  end
+end

data/lib/model_token_auth/acts_as_controllers_authenticable.rb

@@ -0,0 +1,13 @@
+require 'model_token_auth/controllers_auth'
+
+module ModelTokenAuth
+  module ActsAsControllersAuthenticable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_controller_authenticable
+        include ModelTokenAuth::ControllersAuth
+      end
+    end
+  end
+end

data/lib/model_token_auth/acts_as_model_authenticable.rb

@@ -0,0 +1,13 @@
+require 'model_token_auth/token_generator'
+
+module ModelTokenAuth
+  module ActsAsModelAuthenticable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_model_authenticable
+        include ModelTokenAuth::TokenGenerator
+      end
+    end
+  end
+end

data/lib/model_token_auth/controllers_auth.rb

@@ -0,0 +1,29 @@
+module ModelTokenAuth
+  module ControllersAuth
+    def authenticate!
+      token = request.headers['HTTP_X_AUTH_TOKEN']
+
+      if token.present?
+        token_ = AccessToken.find_by_token(token)
+
+        if token_&.entity_type?
+          authenticate_entity(token_)
+        else
+          head :unauthorized
+        end
+      else
+        head :bad_request
+      end
+    end
+
+    private
+
+    def authenticate_entity(token)
+      return false if token.entity_type.nil?
+      entity = token.entity_type.tableize.singularize
+
+      self.class.send(:attr_reader, "current_#{entity}")
+      instance_variable_set("@current_#{entity}", token.entity)
+    end
+  end
+end

data/lib/model_token_auth/railtie.rb

@@ -0,0 +1,4 @@
+module ModelTokenAuth
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/model_token_auth/token_generator.rb

@@ -0,0 +1,31 @@
+module ModelTokenAuth
+  module TokenGenerator
+    extend ActiveSupport::Concern
+
+    included do
+      
+      # => callbacks
+      before_validation :build_access_token, on: :create
+
+      # => associations
+      has_one :access_token, as: :entity
+
+      # => validations
+      validates_associated :access_token
+    end
+
+    def access_token
+      if super.nil?
+        raise NoDefinedToken
+      else
+        super
+      end
+    end
+
+    class ::NoDefinedToken < Exception
+      def message
+        'there is not defined token' 
+      end
+    end
+  end
+end

data/lib/model_token_auth/version.rb

@@ -0,0 +1,3 @@
+module ModelTokenAuth
+  VERSION = '1.0.1'
+end

data/lib/model_token_auth.rb

@@ -0,0 +1,22 @@
+require "model_token_auth/railtie"
+require 'model_token_auth/access_tokens_config'
+require 'model_token_auth/acts_as_model_authenticable'
+require 'model_token_auth/acts_as_controllers_authenticable'
+
+module ModelTokenAuth; end
+
+class AccessToken < ActiveRecord::Base
+  include ModelTokenAuth::AccessTokensConfig
+end
+
+ActiveRecord::Base.include(
+  ModelTokenAuth::ActsAsModelAuthenticable
+)
+
+ActionController::Base.include(
+  ModelTokenAuth::ActsAsControllersAuthenticable
+) if ActionController::Base
+
+ActionController::API.include(
+  ModelTokenAuth::ActsAsControllersAuthenticable
+) if ActionController::API

data/lib/tasks/auth_api_tasks.rake

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

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: model_token_auth
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Armando Alejandre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: pg
+  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: rspec-rails
+  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: shoulda-matchers
+  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: shoulda-callback-matchers
+  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: coveralls
+  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: Generates tokens in models and authentication in the controllers.
+email:
+- armando1339@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/access_token/USAGE
+- lib/generators/access_token/access_token_generator.rb
+- lib/generators/access_token/templates/migration.rb
+- lib/model_token_auth.rb
+- lib/model_token_auth/access_tokens_config.rb
+- lib/model_token_auth/acts_as_controllers_authenticable.rb
+- lib/model_token_auth/acts_as_model_authenticable.rb
+- lib/model_token_auth/controllers_auth.rb
+- lib/model_token_auth/railtie.rb
+- lib/model_token_auth/token_generator.rb
+- lib/model_token_auth/version.rb
+- lib/tasks/auth_api_tasks.rake
+homepage: 
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Generates tokens in models and authentication in the controllers.
+test_files: []