grape-tokeeo 0.0.2.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 023c95fb8b0466a6552a05c247573a65ab5613aa
-  data.tar.gz: 13216ac3c5c6fc28378594c5267d5f33a5490c53
+  metadata.gz: 6010c1196dfba1e2600d0083cd3a71011629bb9e
+  data.tar.gz: 3c335c1ad5a6f42436f26a79dd91b613499d0870
 SHA512:
-  metadata.gz: d712dd1c2fb783c5c63b4e1c424e94c4393da3509448dad4b6d606f553db6e61551acc5d253515c9c8d99f7d6fd3d9e1316c458f9d9864eb15ad451aacae0c6c
-  data.tar.gz: a66ed07c494c914b1a318ceb2327408373b695a70c709638b29d3652b9123cd226e80a8c5ac41a71ccb69caae5f9e13cbb7b141d827fa023e39c0e6eef9c681a
+  metadata.gz: 8de57a3ecbab2999b7c4cf6e35ba486c438405421c7b67cc7f8b1778cb6ceefdac5a8b8672496a2a107b3049906e645dc253c6b59b9a1d0653f997bd59685ef8
+  data.tar.gz: 14ab13e6818e42ef870dca034e13e7bdfbc66067cbd6ffeafec38fd33c004b8251382f755b4d0c501ddc760a92276b6ad749ea61174d422ccd53ca2a565ca456

data/.travis.yml

@@ -3,7 +3,10 @@ cache: bundler
 
 rvm:
   - 2.1.2
-  
+
+services:
+  - mongodb
+
 script: 'bundle exec rspec'
 
 notifications:

data/README.md

@@ -1,6 +1,7 @@
 [![Build Status](https://travis-ci.org/wawandco/grape-tokeeo.svg?branch=master)](https://travis-ci.org/wawandco/grape-tokeeo)
 [![Code Climate](https://codeclimate.com/github/wawandco/grape-tokeeo/badges/gpa.svg)](https://codeclimate.com/github/wawandco/grape-tokeeo)
 [![Test Coverage](https://codeclimate.com/github/wawandco/grape-tokeeo/badges/coverage.svg)](https://codeclimate.com/github/wawandco/grape-tokeeo)
+[![Gem Version](https://badge.fury.io/rb/grape-tokeeo.svg)](http://badge.fury.io/rb/grape-tokeeo)
 
 # Grape::Tokeeo
 
@@ -40,7 +41,7 @@ And we don't want to expose :something publicly, grape-tokkeo helps us by allowi
 
 ```ruby
 class MyApi::API < Grape::API
-  validate_token is: 'S0METHINGWEWANTTOSHAREONLYWITHCLIENT'
+  ensure_token is: 'S0METHINGWEWANTTOSHAREONLYWITHCLIENT'
 
   get :something do
     {content: 'secret content'}
@@ -53,7 +54,7 @@ In case we call the API without passing *X-Api-Token* with the 'S0METHINGWEWANTT
 this options also accepts a list of tokens inside the /is:/ option. like this.
 ```ruby
 class MyApi::API < Grape::API
-  validate_token is: ['TOKENA','TOKENB']
+  ensure_token is: ['TOKENA','TOKENB']
 
   get :something do
     {content: 'secret content'}
@@ -64,11 +65,11 @@ end
 
 ### Token on model
 
-In case we want to ensure the token exists in a model we can use the following syntax for the *validate_token* method:
+In case we want to ensure the token exists in a model we can use the following syntax for the *ensure_token* method:
 
 ```ruby
 class MyApi::API < Grape::API
-  validate_token in: SecureTokenHolder, field: :token
+  ensure_token in: SecureTokenHolder, field: :token
 
   get :something do
     {content: 'secret content'}
@@ -78,13 +79,15 @@ end
 
 Again this should ensure the token exist by looking on the SecureTokenHolder model table for a record with the column 'token' with the same value as 'X-Api-Token'.
 
+Starting from version 0.0.3 grape-tokeeo supports *ActiveRecord* , *MongoMapper* , *Mongoid* and *DataMapper* ORM libraries to handle this feature.
+
 ### Token validated against a block passed
 
-There may be some cases where you would like to do the validation by yourself or the validation logic is not simple as verifying against the model attribute, in that case we could pass a block to the *validate_token_in* method like:
+There may be some cases where you would like to do the validation by yourself or the validation logic is not simple as verifying against the model attribute, in that case we could pass a block to the *ensure_token_with* method like:
 
 ```ruby
 class MyApi::API < Grape::API
-  validate_token_with do |token|
+  ensure_token_with do |token|
     SomeComplexOperationHolder.validate token
   end
 
@@ -102,10 +105,24 @@ You can also define your custom validation error message by passing the /invalid
 
 ```ruby
 class MyApi::API < Grape::API
-  validate_token is: ['TOKENA','TOKENB'], invalid_message: "Look 'ma its working"
+  ensure_token is: ['TOKENA','TOKENB'], invalid_message: "Look 'ma its working"
 
   get :something do
     {content: 'secret content'}
   end
 end
 ```
+
+### Custom missing token message
+
+By default 'Token was not passed' message is defined when API token is missing in the request. You can customize this message by passing the *missing_message* option to the method:
+
+```ruby
+class MyApi::API < Grape::API
+  ensure_token is: 'TOKENA', missing_message: 'API token is missing!'
+
+  get :something do
+   {content: 'secret content'}
+  end
+end
+```

data/grape-tokeeo.gemspec

@@ -27,8 +27,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'database_cleaner', '~> 1.3'
   spec.add_development_dependency "rack-test", '~> 0'
   spec.add_development_dependency "codeclimate-test-reporter", '~> 0'
-
+  spec.add_development_dependency "dm-sqlite-adapter", '~> 1.2'
+  spec.add_development_dependency "dm-core", '~> 1.2'
+  spec.add_development_dependency "dm-migrations", '~> 1.2'
+  spec.add_development_dependency "bson_ext", '~> 1.0'
+  spec.add_development_dependency "mongo_mapper", '~> 0.11'
 
   spec.add_runtime_dependency "grape", '~> 0.9'
   spec.add_runtime_dependency "activerecord", '~> 4'
+  spec.add_runtime_dependency "orm_adapter", '~> 0.5.0'
 end

data/lib/grape/tokeeo.rb

@@ -6,13 +6,23 @@ module Grape
     include Grape::Tokeeo
 
     class << self
-      def validate_token( options={} )
+      def ensure_token(options={})
         Grape::Tokeeo.build_preshared_token_security(options, self) if options[:is].present?
         Grape::Tokeeo.build_model_token_security(options, self) if options[:in].present?
       end
 
+      def ensure_token_with(options={}, &block)
+        Grape::Tokeeo.define_before_for(self, options, &block)
+      end
+
+      def validate_token(options={} )
+        warn "[DEPRECATED] 'validate_token' is deprecated, use 'ensure_token' instead"
+        ensure_token(options)
+      end
+
       def validate_token_with(options={}, &block)
-        Grape::Tokeeo.secure_with( self, options, &block)
+        warn "[DEPRECATED] 'validate_token_with' is deprecated, use 'ensure_token_with' instead"
+        ensure_token_with(options, &block)
       end
     end
   end
@@ -29,6 +39,11 @@ module Grape
         invalid_message_to_use ||= DEFAULT_INVALID_MESSAGE
       end
 
+      def message_for_missing_token( options= {})
+        missing_message_to_use = options[:missing_message]
+        missing_message_to_use ||= DEFAULT_MISSING_MESSAGE
+      end
+
       def header_to_verify( options={} )
         header_to_use = options[:header]
         header_to_use ||= DEFAULT_HEADER
@@ -39,42 +54,50 @@ module Grape
         token ||= request.env[key]
       end
 
-      def build_preshared_token_security(options, api_instance)
+      def header_token( options, request )
+        header_key = Grape::Tokeeo.header_to_verify(options)
+        token = Grape::Tokeeo.header_for( header_key, request )
+      end
+
+      def define_before_for(api_instance, options, &block)
         api_instance.before do
-          header_key = Grape::Tokeeo.header_to_verify(options)
-          token = Grape::Tokeeo.header_for( header_key, request )
-          preshared_token = options[:is]
+          token = Grape::Tokeeo.header_token(options, request)
+          error!( Grape::Tokeeo.message_for_missing_token(options), 401) unless token.present?
+          error!( Grape::Tokeeo.message_for_invalid_token(options), 401) unless yield(token)
+        end
+      end
 
-          error!(DEFAULT_MISSING_MESSAGE, 401) unless token.present?
+      def verification_passed?( options, token)
+        preshared_token = options[:is]
+        preshared_token.is_a?(Array) ?  preshared_token.include?(token) : token == preshared_token
+      end
 
-          verification_passed = preshared_token.is_a?(Array) ?  preshared_token.include?(token) : token == preshared_token
-          error!( Grape::Tokeeo.message_for_invalid_token(options) , 401) unless verification_passed
+      def build_preshared_token_security(options, api_instance)
+        define_before_for(api_instance, options) do |token|
+          Grape::Tokeeo.verification_passed?(options, token)
         end
       end
 
-      def build_model_token_security(options, api_instance)
+      def use_supported_orm? (clazz)
+        supported =   clazz < ActiveRecord::Base            if defined?(ActiveRecord::Base)
+        supported ||= clazz < DataMapper::Resource          if defined?(DataMapper::Resource)
+        supported ||= clazz < MongoMapper::Document         if defined?(MongoMapper::Document)
+        supported ||= clazz < MongoMapper::EmbeddedDocument if defined?(MongoMapper::EmbeddedDocument)
+        supported ||= clazz < Mongoid::Document             if defined?(Mongoid::Document)
+        supported
+      end
+
+      def found_in_model? (options, token)
         clazz = options[:in]
         field = options[:field]
 
-        raise Error("#{clazz} is not an ActiveRecord::Base subclass") unless clazz < ActiveRecord::Base
-
-        api_instance.before do
-          header = Grape::Tokeeo.header_to_verify(options)
-          token = env[header]
-          found = clazz.find_by("#{field.to_s}" => token )
-
-          error!(DEFAULT_MISSING_MESSAGE, 401) unless token.present?
-          error!( Grape::Tokeeo.message_for_invalid_token(options), 401) unless found.present?
-        end
+        raise Error("#{clazz} does not use any of the orm library supported") unless Grape::Tokeeo.use_supported_orm?(clazz)
+        clazz.to_adapter.find_first("#{field.to_s}" => token)
       end
 
-      def secure_with(api_instance, options, &block )
-        api_instance.before do
-          header = Grape::Tokeeo.header_to_verify(options)
-          token = env[header]
-
-          error!( DEFAULT_MISSING_MESSAGE, 401) unless token.present?
-          error!( Grape::Tokeeo.message_for_invalid_token(options), 401) unless yield(token)
+      def build_model_token_security(options, api_instance)
+        define_before_for(api_instance, options) do |token|
+          Grape::Tokeeo.found_in_model?(options, token)
         end
       end
     end

data/lib/grape/tokeeo/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Tokeeo
-    VERSION = "0.0.2.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/factories/user_factory.rb

@@ -1,7 +1,18 @@
 FactoryGirl.define do
-  factory :user do |user|
-    sequence(:name) { |n| "name_#{n}" }
-    sequence(:email) { |n| "email_#{n}@test.com" }
-    token "#{SecureRandom.uuid}"
+
+  sequence(:name)  { |n| "name_#{n}" }
+  sequence(:email) { |n| "email_#{n}@test.com" }
+  sequence(:token)  { |n| "#{SecureRandom.uuid}"}
+
+  factory :user_active_record, class: User do |user|
+    name; email; token
+  end
+
+  factory :user_data_mapper, class: UserDataMapper do
+    name; email; token
+  end
+
+  factory :user_mongo_mapper, class: UserMongoMapper do
+    name; email; token
   end
 end

data/spec/lib/grape/tokeeo_spec.rb

@@ -7,7 +7,7 @@ describe Grape::Tokeeo do
     APIExample.new
   end
 
-  ['preshared', 'preshared_header', 'preshared_with_list', 'block', 'model'].each do |feature|
+  ['preshared', 'preshared_header', 'preshared_with_list', 'block', 'model_active_record'].each do |feature|
     context "##{feature} token" do
       it "should return 401 if X-Api-Token is not passed" do
         get "#{feature}/something"
@@ -52,11 +52,26 @@ describe Grape::Tokeeo do
     end
   end
 
-  context "valid model one" do
-    it "should return 200 if X-Api-Token is the same as the value user has defined" do
-      create(:user, token: 'S0METHINGWEWANTTOSHAREONLYWITHCLIENT')
-      get 'model/something', {}, {"X-Api-Token" => 'S0METHINGWEWANTTOSHAREONLYWITHCLIENT'}
-      expect(last_response.status).to eq(200)
+  {
+   'model_active_record' => :user_active_record,
+   'model_data_mapper'   => :user_data_mapper,
+   'model_mongo_mapper'  => :user_mongo_mapper
+   }.each do |resource, factory|
+
+    context "valid model one using #{resource}" do
+      it "should return 200 if X-Api-Token is the same as the value user has defined" do
+        create(factory, token: 'S0METHINGWEWANTTOSHAREONLYWITHCLIENT')
+        get "#{resource}/something", {}, {"X-Api-Token" => 'S0METHINGWEWANTTOSHAREONLYWITHCLIENT'}
+        expect(last_response.status).to eq(200)
+      end
+    end
+  end
+
+  context "valid wrong model" do
+    it "should raise error" do
+      expect {
+        get "wrong_model/something", {}, {"X-Api-Token" => 'S0METHINGWEWANTTOSHAREONLYWITHCLIENT'}
+      }.to raise_error
     end
   end
 
@@ -83,7 +98,7 @@ describe Grape::Tokeeo do
 
   context "valid model one" do
     it "should return 200 if X-My-Api-Header is the same as the value user has defined" do
-      create(:user, token: 'S0METHINGWEWANTTOSHAREONLYWITHCLIENT')
+      create(:user_active_record, token: 'S0METHINGWEWANTTOSHAREONLYWITHCLIENT')
       get 'model_header/something', {}, {"X-My-Api-Header" => 'S0METHINGWEWANTTOSHAREONLYWITHCLIENT'}
       expect(last_response.status).to eq(200)
     end
@@ -95,4 +110,11 @@ describe Grape::Tokeeo do
       expect(last_response.status).to eq(200)
     end
   end
+
+  context "custom token is missing message" do
+    it "should return token is missing message if X-Api-Token is not passed" do
+      get 'missing_token_message/something'
+      expect(JSON.parse(last_response.body)['error']).to eq('API token is missing')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -8,6 +8,10 @@ require 'active_record'
 require 'database_cleaner'
 require 'factory_girl'
 require "rack/test"
+require "dm-core"
+require "dm-migrations"
+require "mongo_mapper"
+require "orm_adapter"
 
 ENV["RAILS_ENV"] = "test"
 
@@ -21,11 +25,24 @@ RSpec.configure do |config|
 
   load File.dirname(__FILE__) + '/support/schema.rb'
 
+  # Initialize MongoMapper access.
+  MongoMapper.connection = Mongo::Connection.new('localhost', 27017)
+  MongoMapper.database = "test"
+
+  # Initialize Mongoid configuration.
+
+  # Initialize support with DataMapper
+  DataMapper.setup(:default, 'sqlite::memory:')
+
 
   Dir["#{File.dirname(__FILE__)}/support/models/*.rb"].each {|f| require f}
   Dir["#{File.dirname(__FILE__)}/factories/*.rb"].each {|f| require f }
   Dir["#{File.dirname(__FILE__)}/support/*.rb"].each{ |f| require f }
 
+  # Finalize models declaration for DataMapper
+  DataMapper.finalize
+  DataMapper.auto_migrate!
+
   # methods or matchers
   require 'rspec/expectations'
   config.include RSpec::Matchers

data/spec/support/examples/api_example.rb

@@ -68,8 +68,22 @@ class APIExample < Grape::API
     end
   end
 
-  resource :model do
-    validate_token in: User, field: :token
+  {:model_active_record => User,
+   :model_data_mapper   => UserDataMapper,
+   :model_mongo_mapper  => UserMongoMapper
+  }.each do |resource_name, model|
+
+    resource "#{resource_name}" do
+      validate_token in: model, field: :token
+
+      get :something do
+        {content: 'secret content'}
+      end
+    end
+  end
+
+  resource :wrong_model do
+    validate_token in: Object, field: :token
 
     get :something do
       {content: 'secret content'}
@@ -83,9 +97,11 @@ class APIExample < Grape::API
       {content: 'secret content'}
     end
   end
-  # validate_token in: User, field: :auth_token
-  # validate_token with: do |token|
-  #
-  # end
 
+  resource :missing_token_message do
+    validate_token is: 'AAA', missing_message: 'API token is missing'
+    get :something do
+      {content: 'secret content'}
+    end
+  end
 end

data/spec/support/models/user.rb

@@ -1,4 +1,3 @@
 class User < ActiveRecord::Base
   validates_presence_of :name
-  
 end

data/spec/support/models/user_data_mapper.rb

@@ -0,0 +1,8 @@
+class UserDataMapper
+  include DataMapper::Resource
+
+  property :id,    Serial
+  property :name,  String
+  property :email, String
+  property :token, String
+end

data/spec/support/models/user_mongo_mapper.rb

@@ -0,0 +1,7 @@
+class UserMongoMapper
+  include MongoMapper::Document
+
+  key :name,  String
+  key :email, String
+  key :token, String
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-tokeeo
 version: !ruby/object:Gem::Version
-  version: 0.0.2.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Antonio Pagano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dm-sqlite-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: dm-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: dm-migrations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +234,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: orm_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 description: " Grape resources provides simple API token auth for grape in three different
   flavours."
 email:
@@ -187,6 +271,8 @@ files:
 - spec/spec_helper.rb
 - spec/support/examples/api_example.rb
 - spec/support/models/user.rb
+- spec/support/models/user_data_mapper.rb
+- spec/support/models/user_mongo_mapper.rb
 - spec/support/schema.rb
 homepage: https://github.com/wawandco/grape-tokeeo
 licenses:
@@ -219,4 +305,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/examples/api_example.rb
 - spec/support/models/user.rb
+- spec/support/models/user_data_mapper.rb
+- spec/support/models/user_mongo_mapper.rb
 - spec/support/schema.rb