model_token_auth 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a3527ddbe35d5c795b9d4de1d5a07f1f7e42dd24c3b65511ad9a481de22a4a6
-  data.tar.gz: f2c38cf208b737e3f79a3ee65ce4f6df542778c55f7baba2886465be6f38c3a6
+  metadata.gz: 6b3168a54dc4b80feef92939e9c1ec3445fd0598bdd6394933650c3b615087a0
+  data.tar.gz: 585c716460869964bef679d24c117bfadc5345a084bbf11feaa50b859cf4002d
 SHA512:
-  metadata.gz: 824f224bc51be881696672ce094905916b60d05246445627baaaee9ba86b1474e997f98693b4e04ae34ccc984d2962bb5f942d6ca06bf749d961e22602e7c24f
-  data.tar.gz: 40037a69c81623ba04223a4826a5adc929d4e528f4892108c599b7575bac0e3036e3862555a6f287b0d8288dcf83ef899a1901837763e09ebc4f22cdfb98ec7f
+  metadata.gz: 7c664b48be846dc4b15ad2b3ccc92ddaf0b10cdcfadf75c3b080ef970ef0f86e23e973ea704eac5d68872ef2fcdd30851935367669cd1fbba2f18510b7709914
+  data.tar.gz: 182fb2d03f4741e75e3953b0c8e00bb49e8482c4082df69c44921a951bdad8038e02849bbfeb5b55720efda1d4514c9fbbe8ce9bc1d856324a7e4946dbaa8920

data/README.md

@@ -1,8 +1,36 @@
 # ModelTokenAuth
 
-Generates tokens in models and authentication in the controllers.
+Plugin RoR that 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)
+[![Build Status](https://travis-ci.org/Kinedu/model_token_auth.svg?branch=develop)](https://travis-ci.org/Kinedu/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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'model_token_auth'
+```
+
+Then execute:
+
+```bash
+$ bundle
+```
+
+In the root directory:
+
+```bash
+$ rails generate access_token
+```
+
+Last command will generate a migration, then:
+
+```bash
+$ rake db:migrate
+```
+
+Once the migration finishes, the models will be ready to be authenticated.
 
 ## Usage
 
@@ -15,7 +43,8 @@ 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.
 
-To authenticate some token it'll need adding the header `X-Auth-Token` in the request with a token as a value.
+To authenticate some token it'll need adding the standard header `Authorization` in the request
+with a token as a value.
 
 ### Models
 
@@ -89,33 +118,103 @@ module Centers
 end
 ```
 
-## Installation
+## Rspec
 
-Add this line to your application's Gemfile:
+To facilitate the testing of the controllers:
+
+1.- Add a new folder with the name of ```support``` in the root of ```spec```.
+
+2.- Create a ruby file with the name of model_token_auth_helper (```model_token_auth_helper.rb```).
+
+3.- Copy the following code:
 
 ```ruby
-gem 'model_token_auth'
-```
+# => model_token_auth_helper.rb
 
-Then execute:
+module ModelTokenAuthHelper
 
-```bash
-$ bundle
+  # => skip authentication but still creates the
+  # instance variable #current_<model-name>.
+  #
+  def skip_authentication!(access_token)
+    subject.class.skip_before_action(:authenticate!, raise: false)
+    subject.send(:authenticate_entity, access_token)
+  end
+
+  # => add the 'Authorization' header with the
+  # value of the token that is passed to it,
+  # giving it the necessary format.
+  #
+  def add_authorization_header(token)
+    request.env['HTTP_AUTHORIZATION'] =
+      ActionController::HttpAuthentication::Token.encode_credentials(token)
+  end
+end
 ```
 
-In your project directory:
+4.- Require ModelTokenAuthHelper at top of the file ```spec_helper.rb``` and add the module to 
+the RSpec configuration:
 
-```bash
-$ rails generate access_token
-```
+```ruby
+# => spec_helper.rb
 
-This will generate a migration, then:
+require_relative 'support/model_token_auth_helper'
 
-```bash
-$ rake db:migrate
+RSpec.configure do |config|
+  ...
+
+  # => *
+  config.include ModelTokenAuthHelper, type: :controller
+end
 ```
 
-Once the migration finishes, the models will be ready to be authenticated.
+### ModelTokenAuthHelper Usage
+
+Here is described how to use the methods of the ModelTokenAuthHelper module that we created
+
+```ruby
+require 'rails_helper'
+
+RSpec.describe DummiesController do
+  describe 'controllers authentication' do
+
+    # => EXAMPLE 1
+    context '#authenticate!' do
+      before do
+
+        # You can use this method to add the
+        # necessary header and allow the control
+        # to do its magic
+        #
+        add_authorization_header(dummy.access_token.token)
+
+        get :index, format: :json
+      end
+
+      it { expect(response).to be_successful }
+
+      it { expect(subject.respond_to? :current_center).to be_truthy }
+    end
+
+    # => EXAMPLE 2
+    context 'skip #authenticate!' do
+      before do
+        # You can use this method to skip
+        # the #authenticate! method but still
+        # have access to the current_* variable
+        #
+        skip_authentication!(dummy.access_token)
+
+        get :index, format: :json
+      end
+
+      it { expect(response).to be_successful }
+
+      it { expect(subject.respond_to? :current_center).to be_truthy }
+    end
+  end
+end
+```
 
 ## Contributing
 
@@ -132,4 +231,5 @@ Make a 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/lib/model_token_auth/controllers_auth.rb

@@ -1,10 +1,10 @@
 module ModelTokenAuth
   module ControllersAuth
     def authenticate!
-      token = request.headers['HTTP_X_AUTH_TOKEN']
+      token = request.headers['HTTP_AUTHORIZATION']
 
       if token.present?
-        token_ = AccessToken.find_by_token(token)
+        token_ = AccessToken.find_by_token(parses_the_token(token))
 
         if token_&.entity_type?
           authenticate_entity(token_)
@@ -18,6 +18,7 @@ module ModelTokenAuth
 
     private
 
+    # => *
     def authenticate_entity(token)
       return false if token.entity_type.nil?
       entity = token.entity_type.tableize.singularize
@@ -25,5 +26,10 @@ module ModelTokenAuth
       self.class.send(:attr_reader, "current_#{entity}")
       instance_variable_set("@current_#{entity}", token.entity)
     end
+
+    # => *
+    def parses_the_token(token)
+      token.split.last.remove('token=').parameterize
+    end
   end
 end

data/lib/model_token_auth/version.rb

@@ -1,3 +1,3 @@
 module ModelTokenAuth
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_token_auth
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Armando Alejandre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,7 +108,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generates tokens in models and authentication in the controllers.
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Plugin RoR that generates tokens in models and authentication in the
+  controllers.
 email:
 - armando1339@gmail.com
 executables: []
@@ -130,10 +145,11 @@ files:
 - lib/model_token_auth/token_generator.rb
 - lib/model_token_auth/version.rb
 - lib/tasks/auth_api_tasks.rake
-homepage: https://github.com/armando1339/model_token_auth
+homepage: https://www.kinedu.com/
 licenses:
 - MIT
 metadata:
+  source_code_uri: https://github.com/Kinedu/model_token_auth
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -154,5 +170,5 @@ rubyforge_project:
 rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
-summary: Generates tokens in models and authentication in the controllers.
+summary: Plugin RoR that generates tokens in models and authentication in the controllers.
 test_files: []