zaikio-jwt_auth 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ed1625f0c3baa4a4ffaa294a558f4da335e647708aabe66e8a51924bbbd02d5
-  data.tar.gz: 4f5495c0aa6bda2d70cdbf560c3db957ffe65d8017d49d97dcc9c8139b6a69d0
+  metadata.gz: fd2758c610957007baf7499e46f22d286a5c61dceb5895270080f20af8e5a57d
+  data.tar.gz: 5c945887dca4cd07ebfc836a5cbadb81667a56dbed0c6f67152dba297d4399fd
 SHA512:
-  metadata.gz: 77d5cfcc03cd050812d8b01b0e6d8d0954198bb6a002f86c46fb304c515bb54f9661535d0d7d6ed5b67ebcc552cb4d1a61affb40959e57c576f5b602cb74c980
-  data.tar.gz: 30d094c7015d1c73f059282277ba528994db14f4b67525f05265240cd9bc7986a958b13e9cb34765b3e1e36b4c96d7f60dc349b04580bbf7ef56ebd7db48a2ee
+  metadata.gz: 73a3192d97b3f20caab44a96306258cd7b1b0240fb9e912726e3dfd536ef46183e0590a9cb513ed4be6afb66f4ee3c0a415153c4a7e7259a7bd569374e30eab4
+  data.tar.gz: bb9db302ba5caafeae825b25c244a91d213c1026d879c62ca2da230db6f29ade726121fcd0c0727c1e5625a84e2ed2cfb282a25ecaa827562efe6e6a9cb1a58f

data/README.md

@@ -49,7 +49,7 @@ end
 
 ### 4. Update Revoked Access Tokens by Webhook
 
-This gem automatically registers a webhook, if you have properly setup [Zaikio::Webhooks](https://github.com/crispymtn/zaikio-webhooks).
+This gem automatically registers a webhook, if you have properly setup [Zaikio::Webhooks](https://github.com/zaikio/zaikio-webhooks).
 
 
 ### 5. Add more restrictions to your resources:
@@ -118,3 +118,32 @@ class API::ResourcesController < API::ApplicationController
   authorize_by_jwt_scopes 'resources', unless: -> { params[:skip] == '1' }
 end
 ```
+
+### Usage outside a Rails controller
+
+If you need to access a JWT outside the normal Rails controllers (e.g. in a Rack
+middleware), there's a static helper method `.extract` which you can use:
+
+```ruby
+class MyRackMiddleware < Rack::Middleware
+  def call(env)
+    token = Zaikio::JWTAuth.extract(env["HTTP_AUTHORIZATION"])
+    puts token.subject_type #=> "Organization"
+    ...
+```
+
+This function expects to receive the string in the format `"Bearer $token"`.
+
+## Contributing
+
+**Make sure you have the dummy app running locally to validate your changes.**
+
+- Make your changes and submit a pull request for them
+- Make sure to update `CHANGELOG.md`
+
+To release a new version of the gem:
+- Update the version in `lib/zaikio/jwt_auth/version.rb`
+- Update `CHANGELOG.md` to include the new version and its release date
+- Commit and push your changes
+- Create a [new release on GitHub](https://github.com/zaikio/zaikio-jwt_auth/releases/new)
+- CircleCI will build the Gem package and push it Rubygems for you

data/lib/zaikio/jwt_auth.rb

@@ -52,6 +52,20 @@ module Zaikio
       @mocked_jwt_payload = payload
     end
 
+    HEADER_FORMAT = /\ABearer (.+)\z/.freeze
+
+    def self.extract(authorization_header_string)
+      return TokenData.new(Zaikio::JWTAuth.mocked_jwt_payload) if Zaikio::JWTAuth.mocked_jwt_payload
+
+      return if authorization_header_string.blank?
+
+      return unless (token = authorization_header_string[HEADER_FORMAT, 1])
+
+      payload, = JWT.decode(token, nil, true, algorithms: ["RS256"], jwks: JWK.loader)
+
+      TokenData.new(payload)
+    end
+
     module ClassMethods
       def authorize_by_jwt_subject_type(type = nil)
         @authorize_by_jwt_subject_type ||= type
@@ -68,9 +82,8 @@ module Zaikio
 
     module InstanceMethods
       def authenticate_by_jwt
-        render_error("no_jwt_passed", status: :unauthorized) && return unless jwt_from_auth_header
-
-        token_data = TokenData.new(jwt_payload)
+        token_data = Zaikio::JWTAuth.extract(request.headers["Authorization"])
+        return render_error("no_jwt_passed", status: :unauthorized) unless token_data
 
         return if show_error_if_token_is_revoked(token_data)
 
@@ -98,21 +111,6 @@ module Zaikio
 
       private
 
-      def jwt_from_auth_header
-        return true if Zaikio::JWTAuth.mocked_jwt_payload
-
-        auth_header = request.headers["Authorization"]
-        auth_header.split("Bearer ").last if /Bearer/.match?(auth_header)
-      end
-
-      def jwt_payload
-        return Zaikio::JWTAuth.mocked_jwt_payload if Zaikio::JWTAuth.mocked_jwt_payload
-
-        payload, = JWT.decode(jwt_from_auth_header, nil, true, algorithms: ["RS256"], jwks: JWK.loader)
-
-        payload
-      end
-
       def show_error_if_authorize_by_jwt_scopes_fails(token_data)
         return if token_data.scope_by_configurations?(
           self.class.authorize_by_jwt_scopes,

data/lib/zaikio/jwt_auth/configuration.rb

@@ -18,6 +18,7 @@ module Zaikio
       def initialize
         @environment = :sandbox
         @revoked_token_ids = nil
+        @keys = nil
       end
 
       def logger
@@ -30,7 +31,7 @@ module Zaikio
       end
 
       def keys
-        defined?(@keys) && @keys.is_a?(Proc) ? @keys.call : @keys
+        @keys.is_a?(Proc) ? @keys.call : @keys
       end
 
       def revoked_token_ids

data/lib/zaikio/jwt_auth/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module JWTAuth
-    VERSION = "0.4.0".freeze
+    VERSION = "0.4.1".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-jwt_auth
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - crispymtn
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -78,10 +78,12 @@ files:
 - lib/zaikio/jwt_auth/test_helper.rb
 - lib/zaikio/jwt_auth/token_data.rb
 - lib/zaikio/jwt_auth/version.rb
-homepage: https://www.zaikio.com/
+homepage: https://github.com/zaikio/zaikio-jwt_auth
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/zaikio/zaikio-jwt_auth/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/zaikio/zaikio-jwt_auth
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -97,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: JWT-Based authentication and authorization with zaikio