grape_token_auth 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6211636ade2d82f854a1581aa553db28d969bae2
-  data.tar.gz: 67430fb3d2e77ab25f6adcf881e81549dd66de4f
+  metadata.gz: 9eb52d69bb4f5d993b5dabb72d6e69c1e6aab019
+  data.tar.gz: 92258e86affff9fc05ef494a80f242510f9802fa
 SHA512:
-  metadata.gz: 48cb9baa1072a05831fc280bc671cd81ba65e056439d499abcdb1ba6617132768fe14e37682d1e3debd2b8792026662b45baf165ccc07ca2ba1ecbf44d2653c0
-  data.tar.gz: 9b7f0fbd5cc1c06c7a323583130ea4ee580775f49bb0450e7dff27920c7a9fe2569ff21c2c4c50c24d4dfd2dab3a2c6878a22ca0105f16172922c06b6d820125
+  metadata.gz: 1903c2ca38a0b489c469805efef6c2b5a569eafc0838a76c72f65d2a4b440779f314f9101b52c006c03cf7dc417cdf485ccab7b623f4737eae94a3c16255e7f6
+  data.tar.gz: e5725e0048fe7549bf9054ec7ddaa309bd3ed94ef862d796a116abe131cbd6681d3832b63d5e0ffe35df6238e09c78ad6a0688f9becabd6a8143510aae3ab9ff

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.3.1

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+#Changelog
+
+## Current
+
+- Add frozen string comments for ruby 2.3
+- Fix several bugs around rails sign out and session
+- Fix insensitive_keys bug with devise compatability
+- Fix some compatability issues with Grape version 0.16
+
+
+## v0.1.0 Initial Release (2015-11-10)
+
+- Majority of devise_token_auth parity

data/README.md

@@ -1,5 +1,5 @@
 # GrapeTokenAuth
-[![Code Climate GPA][11]][12] [![Test Coverage][13]][14] [![Circle CI][15]][16]
+[![Gem Version][17]][18] [![Code Climate GPA][11]][12] [![Test Coverage][13]][14] [![Circle CI][15]][16]
 
 GrapeTokenAuth is a token authentication solution for grape. It is compatible
 with [ng-token-auth][1] (for _angular_) and [j-toker][2] (for _jQuery_), and is
@@ -79,7 +79,6 @@ In _rails_, you will need to setup warden as so:
 config.middleware.insert_after ActionDispatch::Flash, Warden::Manager do |manager|
   manager.failure_app = GrapeTokenAuth::UnauthorizedMiddleware
   manager.default_scope = :user
-  GrapeTokenAuth.configure_warden(manager)
 end
 ```
 
@@ -145,7 +144,7 @@ class TestApp < Grape::API
   # ...
 
   mount_registration(to: '/auth', for: :user)
-  mount_session(to: '/auth', for: :user)
+  mount_sessions(to: '/auth', for: :user)
   mount_token_validation(to: '/auth', for: :user)
   mount_confirmation(to: '/auth', for: :user)
 
@@ -244,6 +243,8 @@ To run tests, you will need postgres to be setup and configured correctly.  Run
 [14]: https://codeclimate.com/github/mcordell/grape_token_auth/coverage
 [15]: https://circleci.com/gh/mcordell/grape_token_auth.svg?style=svg
 [16]: https://circleci.com/gh/mcordell/grape_token_auth
+[17]: https://badge.fury.io/rb/grape_token_auth.svg
+[18]: https://badge.fury.io/rb/grape_token_auth
 [contributing]: https://github.com/mcordell/grape_token_auth/blob/master/CONTRIBUTING.md
 [gta-wiki]: https://github.com/mcordell/grape_token_auth/wiki
 [demo-repo]: https://github.com/mcordell/grape_token_auth_demo

data/lib/grape_token_auth.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'bcrypt'
 require 'forwardable'
 require 'grape'
@@ -7,6 +8,9 @@ require 'grape_token_auth/mail/message_base'
 require 'grape_token_auth/omniauth/omniauth_html_base'
 require 'grape_token_auth/resource/resource_crud_base'
 
+require 'grape_token_auth/apis/registration/endpoint_definer'
+require 'grape_token_auth/apis/registration/helpers'
+
 require 'grape_token_auth/api_helpers'
 require 'grape_token_auth/apis/confirmation_api'
 require 'grape_token_auth/apis/omniauth_api'

data/lib/grape_token_auth/api_helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   module ApiHelpers
     def self.included(base)

data/lib/grape_token_auth/apis/confirmation_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   # Module that contains the majority of the email confirming functionality.
   # This module can be included in a Grape::API class that defines a
@@ -10,7 +11,7 @@ module GrapeTokenAuth
           base.resource_scope)
         resource = resource_class.confirm_by_token(params[:confirmation_token])
 
-        if resource.persisted?
+        if resource && resource.persisted?
           token = Token.new
 
           resource.tokens[token.client_id] = {

data/lib/grape_token_auth/apis/omniauth_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   # Module that contains the majority of the OmniAuth functionality. This module
   # can be included in a Grape::API class that defines a resource_scope and
@@ -6,7 +7,14 @@ module GrapeTokenAuth
     def self.included(base)
       base.helpers do
         def auth_hash
-          @auth_hash ||= request.env['rack.session'].delete('gta.omniauth.auth')
+          @auth_hash ||= begin
+            hash = request.env['rack.session'].delete('gta.omniauth.auth')
+
+            # While using Grape on Rails, #session is an ActionDispatch::Request::Session class,
+            # which does not preserve OmniAuth::AuthHash class @ 'gta.omniauth.auth' key,
+            # converting it to Hash. Restoring
+            hash.kind_of?(::OmniAuth::AuthHash) ? hash : ::OmniAuth::AuthHash.new(hash)
+          end
         end
 
         def omniauth_params
@@ -106,8 +114,10 @@ module GrapeTokenAuth
     helpers do
       def redirect_route_from_api(api, provider)
         prefix = api.routes.find do |r|
-          %r{/:provider/callback}.match(r.route_path)
-        end.route_path.split(%r{/:provider})[0]
+          minor = /0\.(\d\d).\d+/.match(Grape::VERSION)[1].to_i
+          path = minor >= 16 ? r.origin : r.path
+          %r{/:provider/callback}.match(path)
+        end.path.split(%r{/:provider})[0]
         Pathname.new(prefix).join(provider, 'callback.json').to_s
       end
 

data/lib/grape_token_auth/apis/password_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   # Module that contains the majority of the password reseting functionality.
   # This module can be included in a Grape::API class that defines a
@@ -32,7 +33,7 @@ module GrapeTokenAuth
         redirect_url ||= GrapeTokenAuth.configuration.default_password_reset_url
         throw_unauthorized('Missing redirect url.') unless redirect_url
         resource = ResourceFinder.find(base.resource_scope, params)
-        edit_path = routes[0].route_path.gsub(/\(.*\)/, '') + "/edit"
+        edit_path = routes[0].path.gsub(/\(.*\)/, '') + "/edit"
         if resource
           resource.send_reset_password_instructions(
             provider: 'email',

data/lib/grape_token_auth/apis/registration/endpoint_definer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module GrapeTokenAuth
+  module Registration
+    class EndpointDefiner
+      def self.define_endpoints(api)
+        define_post(api)
+        define_delete(api)
+        define_put(api)
+      end
+
+      def self.define_post(api)
+        api.post '/' do
+          return present empty_params_error if empty_params_error
+          return present invalid_redirect_error if invalid_redirect_error
+          present_create(params, api.resource_scope)
+        end
+      end
+
+      def self.define_delete(api)
+        api.delete do
+          user = find_resource(env, api.resource_scope)
+          return present bad_request(['resource not found.'], 404) unless user
+          user.delete
+          status 200
+        end
+      end
+
+      def self.define_put(api)
+        api.put do
+          return present empty_params_error if empty_params_error
+          resource = find_resource(env, api.resource_scope)
+          return present no_resource unless resource
+          present_update(params, resource, api.resource_scope)
+        end
+      end
+    end
+  end
+end

data/lib/grape_token_auth/apis/registration/helpers.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+module GrapeTokenAuth
+  module Registration
+    module Helpers
+      def bad_request(messages, code = 422)
+        status(code)
+        { 'status' => 'error', 'error' => messages.join(',') }
+      end
+
+      def invalid_redirect_error
+        white_list = GrapeTokenAuth.configuration.redirect_whitelist
+        return unless white_list
+        url_valid = white_list.include?(params['confirm_success_url'])
+        errors = ['redirect url is not in whitelist']
+        bad_request(errors, 403) unless url_valid
+      end
+
+      def present_update(params, resource, scope)
+        updater = ResourceUpdater.new(resource, params, nil, scope)
+        if updater.update!
+          present_success(updater.resource)
+        else
+          present bad_request(updater.errors, 403)
+        end
+      end
+
+      def present_create(params, scope)
+        creator = ResourceCreator.new(params, nil, scope)
+        if creator.create!
+          present_success(creator.resource)
+        else
+          present bad_request(creator.errors, 403)
+        end
+      end
+
+      def empty_params_error
+        if params.empty?
+          errors = ['email, password, password_confirmation \
+                    params are required']
+          bad_request errors, 422
+        else
+          false
+        end
+      end
+
+      def no_resource
+        bad_request(['resource not found.'], 404)
+      end
+
+      def find_resource(env, mapping)
+        token_authorizer = TokenAuthorizer.new(AuthorizerData.from_env(env))
+        token_authorizer.find_resource(mapping)
+      end
+
+      def present_success(resource)
+        status 200
+        present(data: resource)
+      end
+    end
+  end
+end

data/lib/grape_token_auth/apis/registration_api.rb

@@ -1,76 +1,11 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   module RegistrationAPICore
     def self.included(base)
       base.helpers do
-        def bad_request(messages, code = 422)
-          status(code)
-          { 'status' => 'error', 'error' => messages.join(',') }
-        end
-
-        def validate_redirect_url!
-          white_list = GrapeTokenAuth.configuration.redirect_whitelist
-          return unless white_list
-          url_valid = white_list.include?(params['confirm_success_url'])
-          errors = ['redirect url is not in whitelist']
-          bad_request(errors, 403) unless url_valid
-        end
-
-        def validate_not_empty!
-          if params.empty?
-            errors = ['email, password, password_confirmation \
-                      params are required']
-            bad_request errors, 422
-          else
-            false
-          end
-        end
-
-        def find_resource(env, mapping)
-          token_authorizer = TokenAuthorizer.new(AuthorizerData.from_env(env))
-          token_authorizer.find_resource(mapping)
-        end
-      end
-
-      base.post '/' do
-        empty_params_error = validate_not_empty!
-        return present(empty_params_error) if empty_params_error
-        redirect_error = validate_redirect_url!
-        return present(redirect_error) if redirect_error
-        mapping = base.resource_scope
-        configuration = GrapeTokenAuth.configuration
-        creator = ResourceCreator.new(params, configuration, mapping)
-        if creator.create!
-          status 200
-          present(data: creator.resource)
-        else
-          present bad_request(creator.errors, 403)
-        end
-      end
-
-      base.delete do
-        user = find_resource(env, base.resource_scope)
-        return present bad_request(['resource not found.'], 404) unless user
-        user.delete
-        status 200
-      end
-
-      base.put do
-        empty_params_error = validate_not_empty!
-        return present(empty_params_error) if empty_params_error
-        resource = find_resource(env, base.resource_scope)
-        return present bad_request(['resource not found.'], 404) unless resource
-
-        updater = ResourceUpdater.new(resource,
-                                      params,
-                                      GrapeTokenAuth.configuration,
-                                      base.resource_scope)
-        if updater.update!
-          status 200
-          present(data: updater.resource)
-        else
-          present bad_request(updater.errors, 403)
-        end
+        include GrapeTokenAuth::Registration::Helpers
       end
+      GrapeTokenAuth::Registration::EndpointDefiner.define_endpoints(base)
 
       base.format :json
     end

data/lib/grape_token_auth/apis/session_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   module SessionsAPICore
     def self.included(base)
@@ -26,10 +27,7 @@ module GrapeTokenAuth
         data = AuthorizerData.load_from_env_or_create(env)
         env['rack.session'] ||= {}
         data.store_resource(resource, base.resource_scope)
-        auth_header = AuthenticationHeader.new(data, start_time)
-        auth_header.headers.each do |key, value|
-          header key.to_s, value.to_s
-        end
+        data.authed_with_token = false
         status 200
         present data: resource
       end
@@ -39,7 +37,10 @@ module GrapeTokenAuth
         resource = find_resource(data, base.resource_scope)
 
         if resource
-          resource.tokens.delete(env[Configuration::CLIENT_KEY])
+          # Rails prepends 'CLIENT' header with 'HTTP_' prefix, so to make sure we address to
+          # proper header, better use normalized version stored at <tt>data</tt>
+          # See more: http://stackoverflow.com/a/26936364/1592582
+          resource.tokens.delete(data.client_id)
           data.skip_auth_headers = true
           resource.save
           status 200

data/lib/grape_token_auth/apis/token_validation_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   # Contains the major functionality of TokenValidation
   module TokenValidationAPICore

data/lib/grape_token_auth/authentication_header.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class AuthenticationHeader
     extend Forwardable

data/lib/grape_token_auth/authorizer_data.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class AuthorizerData
     RACK_ENV_KEY = 'gta.auth_data'

data/lib/grape_token_auth/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class Configuration
     ACCESS_TOKEN_KEY = 'access-token'

data/lib/grape_token_auth/exceptions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   # Error when an undefined scope was attempted to be used
   class ScopeUndefinedError < StandardError

data/lib/grape_token_auth/key_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'thread_safe'
 require 'openssl'
 require 'securerandom'

data/lib/grape_token_auth/lookup_token.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   # Look up tokens are a type of token that allows searching by that token. This
   # is useful in use cases such as confirmation tokens. These type of tokens are

data/lib/grape_token_auth/mail/mail.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   module Mail
     DEFAULT_MESSAGES = {

data/lib/grape_token_auth/mail/message_base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   module Mail
     class MessageBase

data/lib/grape_token_auth/mail/messages/confirmation/confirmation_email.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   module Mail
     class ConfirmationEmail < MessageBase

data/lib/grape_token_auth/mail/messages/password_reset/password_reset_email.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   module Mail
     class PasswordResetEmail < MessageBase

data/lib/grape_token_auth/mail/smtp_mailer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   module Mail
     class SMTPMailer

data/lib/grape_token_auth/middleware.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class Middleware
     def initialize(app, _options)

data/lib/grape_token_auth/mount_helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   module MountHelpers
     def self.included(base)

data/lib/grape_token_auth/omniauth/omniauth_failure_html.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class OmniAuthFailureHTML < OmniAuthHTMLBase
     FAILURE_MESSAGE = 'authFailure'

data/lib/grape_token_auth/omniauth/omniauth_html_base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'erb'
 require 'json'
 

data/lib/grape_token_auth/omniauth/omniauth_resource.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class OmniAuthResource
     extend Forwardable

data/lib/grape_token_auth/omniauth/omniauth_success_html.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class OmniAuthSuccessHTML < OmniAuthHTMLBase
     extend Forwardable

data/lib/grape_token_auth/orm_integrations/active_record_token_auth.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   module ActiveRecord
     module TokenAuth
@@ -15,6 +16,15 @@ module GrapeTokenAuth
         base.before_update :synchronize_email_and_uid
 
         class << base
+          def case_insensitive_keys
+            @case_insensitive_keys ||
+              if Object.const_defined?(:Devise)
+                Object.const_get(:Devise).case_insensitive_keys
+              else
+                [:email]
+              end
+          end
+
           def exists_in_column?(column, value)
             where(column => value).count > 0
           end
@@ -59,7 +69,7 @@ module GrapeTokenAuth
 
           attr_writer :reset_token_lifespan
           attr_writer :confirmation_token_lifespan
-          attr_accessor :case_insensitive_keys
+          attr_writer :case_insensitive_keys
         end
       end
 
@@ -81,8 +91,8 @@ module GrapeTokenAuth
       def password_confirmation_matches
         return if password.present? && password_confirmation.present? &&
                   password == password_confirmation
-        errors.add(:password_confirmation,
-                   'password confirmation does not match')
+        errors.add(:base,
+                   'password and password confirmation do not match')
       end
 
       def create_new_auth_token(client_id = nil)
@@ -192,7 +202,7 @@ module GrapeTokenAuth
 
       def build_auth_url(url, params)
         url = URI(url)
-        expiry = tokens[params[:client_id]][:expiry]
+        expiry = tokens[params[:client_id]].with_indifferent_access[:expiry]
         url.query = params.merge(uid: uid, expiry: expiry).to_query
         url.to_s
       end

data/lib/grape_token_auth/resource/resource_creator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class ResourceCreator < ResourceCrudBase
     def create!

data/lib/grape_token_auth/resource/resource_crud_base.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class ResourceCrudBase
     attr_reader :resource, :errors, :scope
 
-    def initialize(params, configuration, scope = :user)
-      @configuration = configuration
+    def initialize(params, configuration = nil, scope = :user)
+      @configuration = configuration || GrapeTokenAuth.configuration
       @params = params
       @errors = []
       @scope = scope

data/lib/grape_token_auth/resource/resource_finder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class ResourceFinder
     def initialize(scope, params)

data/lib/grape_token_auth/resource/resource_updater.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class ResourceUpdater < ResourceCrudBase
     def initialize(resource, params, configuration, scope = :user)

data/lib/grape_token_auth/token.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class Token
     attr_reader :token, :client_id, :expiry

data/lib/grape_token_auth/token_authentication.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   module TokenAuthentication
     def self.included(base)

data/lib/grape_token_auth/token_authorizer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class TokenAuthorizer
     attr_reader :data

data/lib/grape_token_auth/unauthorized_middleware.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class UnauthorizedMiddleware
     def self.call(env)

data/lib/grape_token_auth/utility.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GrapeTokenAuth
   class Utility
     def self.find_with_indifference(hash, key)

data/lib/grape_token_auth/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape_token_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Cordell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-10 00:00:00.000000000 Z
+date: 2016-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -259,6 +259,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -275,6 +276,8 @@ files:
 - lib/grape_token_auth/apis/confirmation_api.rb
 - lib/grape_token_auth/apis/omniauth_api.rb
 - lib/grape_token_auth/apis/password_api.rb
+- lib/grape_token_auth/apis/registration/endpoint_definer.rb
+- lib/grape_token_auth/apis/registration/helpers.rb
 - lib/grape_token_auth/apis/registration_api.rb
 - lib/grape_token_auth/apis/session_api.rb
 - lib/grape_token_auth/apis/token_validation_api.rb
@@ -331,9 +334,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Token auth for grape apps
 test_files: []
-has_rdoc: