devise-jwt 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b24df7ebbf3c2b63f47289067de5734aa630a636
-  data.tar.gz: f66bf39f7b53cb7ae65bb08dc4840b14ba19870e
+  metadata.gz: 30e463b1ff2eee31807c9e08ad02d39e18291a34
+  data.tar.gz: 8d425949dcc6fa52e7f1db7e44eb0743dec4e6f6
 SHA512:
-  metadata.gz: 4e5b4824161b7f5f7ca28b79ee25c09582fed204218b490382718ca0c9bb2255a73811db5ec73941b442d521dbc8d785e8f7a79c459c1529207b9893e0853c0e
-  data.tar.gz: 62efa5ebcf5fac31cda03a5ff112764c783b08b00fafb12a7600b0c8ad04922c9a409b8c444d4f4f6ae5527d099c9b1ad06905d0792265dc9f873928434117f8
+  metadata.gz: 8e3caeea62311d2731fcabe065cefc2d6e4435b146165dc796038e425832be22aa4f9d28b8f214363c7faa680771a5acdfebff44e391879172b20fa72ab9ae75
+  data.tar.gz: 0f15207820873a6644c2b491223b88f931cac592ae1ba6415350c0b0e048f93bdfbe8aabe1864f68503cee826668b6f93210d6d0f2c4209e3cee18853b8b09ac

data/CHANGELOG.md

@@ -4,7 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) 
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.2.0] - 2017-04-13
+## [0.3.0] - 2017-06-07
+### Fixed
+- Allow configuring request formats to take into account through
+  `request_formats` configuration option
+
+## [0.2.1] - 2017-04-13
 ### Fixed
 - Ignore expired token revocation
 

data/README.md

@@ -55,7 +55,7 @@ Currently, HS256 algorithm is the one in use.
 
 You have to tell which user models you want to be able to authenticate with JWT tokens. For them, the authentication process will be like this:
 
-- A user authenticates trough devise create session request (for example, using the standard `:database_authenticatable` module).
+- A user authenticates through devise create session request (for example, using the standard `:database_authenticatable` module).
 - If the authentication succeeds, a JWT token is dispatched to the client in the `Authorization` response header, with format `Bearer #{token}` (tokens are also dispatched on a successful sign up).
 - The client can use this token to authenticate following requests for the same user, providing it in the `Authorization` request header, also with format `Bearer #{token}`
 - When the client visits devise destroy session request, the token is revoked.
@@ -253,6 +253,28 @@ jwt.revocation_requests = [
 
 **Important**: You are encouraged to delimit your regular expression with `^` and `$` to avoid unintentional matches.
 
+#### request_formats
+
+Request formats that must be processed (in order to dispatch or revoke tokens).
+
+It must be a hash of devise scopes as keys and an array of request formats as
+values. When a scope is not present or if it has a nil item, requests without
+format will be taken into account.
+
+For example, with following configuration, `user` scope would dispatch and
+revoke tokens in `json` requests (as in `/users/sign_in.json`), while
+`admin_user` would do it in `xml` and with no format (as in
+`/admin_user/sign_in.xml` and `/admin_user/sign_in`).
+
+```ruby
+jwt.request_formats = {
+                        user: [:json],
+                        admin_user: [nil, :xml]
+                      }
+```
+
+By default, only requests without format are processed.
+
 ## Development
 
 There are docker and docker-compose files configured to create a development environment for this gem. So, if you use Docker you only need to run:

data/lib/devise/jwt.rb

@@ -42,6 +42,21 @@ module Devise
       forward_to_warden(:revocation_requests, value)
     end
 
+    # A hash of warden scopes as keys and an array of request formats that will
+    # be processed as values. When a scope is not present or if it has a nil
+    # item, requests without format will be taken into account.
+    #
+    # For example, with following configuration, `user` scope would dispatch and
+    # revoke tokens in `json` requests, while `admin_user` would do it in `xml`
+    # and with no format.
+    #
+    # @example
+    # {
+    #   user: [:json],
+    #   admin_user: [nil, :xml]
+    # }
+    setting :request_formats, {}
+
     def self.forward_to_warden(setting, value)
       Warden::JWTAuth.config.send("#{setting}=", value)
     end

data/lib/devise/jwt/defaults_generator.rb

@@ -62,36 +62,43 @@ module Devise
 
       def add_sign_in_request(inspector)
         return unless inspector.session?
-        defaults[:dispatch_requests] << sign_in_request(inspector)
+        defaults[:dispatch_requests].push(*sign_in_requests(inspector))
       end
 
       def add_registration_request(inspector)
         return unless inspector.registration?
-        defaults[:dispatch_requests] << registration_request(inspector)
+        defaults[:dispatch_requests].push(*registration_requests(inspector))
       end
 
       def add_revocation_requests(inspector)
         return unless inspector.session?
-        defaults[:revocation_requests] << sign_out_request(inspector)
+        defaults[:revocation_requests].push(*sign_out_requests(inspector))
       end
 
-      def sign_in_request(inspector)
-        request(inspector, :sign_in)
+      def sign_in_requests(inspector)
+        requests(inspector, :sign_in)
       end
 
-      def sign_out_request(inspector)
-        request(inspector, :sign_out)
+      def sign_out_requests(inspector)
+        requests(inspector, :sign_out)
       end
 
-      def registration_request(inspector)
-        request(inspector, :registration)
+      def registration_requests(inspector)
+        requests(inspector, :registration)
       end
 
-      # :reek:UtilityFunction
-      def request(inspector, name)
+      # :reek:FeatureEnvy
+      def requests(inspector, name)
         path = inspector.path(name)
         method = inspector.method(name)
-        [method, /^#{path}$/]
+        inspector.formats.map do |format|
+          request_for_format(path, method, format)
+        end
+      end
+
+      def request_for_format(path, method, format)
+        path_regexp = format ? /^#{path}.#{format}$/ : /^#{path}$/
+        [method, path_regexp]
       end
     end
   end

data/lib/devise/jwt/mapping_inspector.rb

@@ -44,6 +44,10 @@ module Devise
         end
       end
 
+      def formats
+        JWT.config.request_formats[scope] || default_formats
+      end
+
       private
 
       def path_parts(name)
@@ -64,6 +68,10 @@ module Devise
       def sign_out_via
         mapping.sign_out_via.to_s.upcase
       end
+
+      def default_formats
+        [nil]
+      end
     end
   end
 end

data/lib/devise/jwt/version.rb

@@ -2,6 +2,6 @@
 
 module Devise
   module JWT
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-jwt
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Marc Busqué
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise