zaikio-jwt_auth 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5246d95da7085c56dce3719ba3bdba4c102c3b4dd01c941cacb5de5d9e813eb0
-  data.tar.gz: 354e97d2ef3972049e103fa0afea9e047f9990ab816ca8b7afec7c3671e0d90b
+  metadata.gz: c782ad558e422167c59f3c29dfdd9533d97153a17f05955a12eb127e32d55a68
+  data.tar.gz: 063fc86f98d24d70e496f324ccc87ec32f71f61ba50c91a70708ca20afe8b1c7
 SHA512:
-  metadata.gz: 8025ca7934fac9df869afde1fd23287208fb9edbd1970e3d065d9591062a1557a435f6cb0d7d8147d8f8f2fdbb476ae00dead2d89bb232951489de785df0e248
-  data.tar.gz: 89431f5cdf4ad50dff018a35530fb95d97d2a9a91a1908566b8d9de187dff65f1203bfb76a7eef79fcc3fca116f336ab194c18b8bd583d830098481678a53aa8
+  metadata.gz: 4b24750a7edda299537d85f6bf852a85aaba442f77a18d6c9998d3ef491fa1b329b843b23ddc7b2b6f309ab3abac2c94e0448eef2c7370a9a59014e8823add84
+  data.tar.gz: 8b39b2cdaa531bb985b59a374584e6ba2d0167213f9e70185be84462843044478026bc74b8d24e972cd840e1a4402a8ff5390245948fd0b3393ebb1ccc31baa7

data/README.md

@@ -28,7 +28,9 @@ $ gem install zaikio-jwt_auth
 Zaikio::JWTAuth.configure do |config|
   config.environment = :sandbox # or production
   config.app_name = "test_app" # Your Zaikio App-Name
-  config.redis = Redis.new
+
+  # Enable caching Hub API responses for e.g. revoked tokens
+  config.cache = Rails.cache
 end
 ```
 
@@ -63,6 +65,24 @@ end
 
 By convention, `authorize_by_jwt_scopes` automatically maps all CRUD actions in a controller. Requests for `show` and `index` with a read or read_write scope are allowed. All other actions like `create`, `update` and `destroy` are accepted if the scope is a write or read_write scope. Therefore it is strongly recommended to always create standard Rails resources. If a custom action is required, you will need to authorize yourself using the `after_jwt_auth`.
 
+Both of these behaviours are automatically inherited by child classes, for example:
+
+```ruby
+class API::ChildController < API::ResourcesController
+end
+
+API::ChildController.authorize_by_jwt_subject_type
+#=> "Organization"
+```
+
+You can always override the behaviour in children if needed:
+
+```ruby
+class API::ChildController < API::ResourcesController
+  authorize_by_jwt_subject_type nil
+end
+```
+
 #### Modifying required scopes
 If you nonetheless want to change the required scopes for CRUD routes, you can use the `type` option which accepts the following values: `:read`, `:write`, `:read_write`
 
@@ -165,6 +185,13 @@ rescue JWT::DecodeError, JWT::ExpiredSignature
 end
 ```
 
+### Using a different cache backend
+
+This client supports any implementation of
+[`ActiveSupport::Cache::Store`](https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html),
+but you can also write your own client that supports these methods: `#read(key)`,
+`#write(key, value)`, `#delete(key)`
+
 ## Contributing
 
 **Make sure you have the dummy app running locally to validate your changes.**

data/lib/zaikio/jwt_auth/configuration.rb

@@ -11,7 +11,7 @@ module Zaikio
         production: "https://hub.zaikio.com"
       }.freeze
 
-      attr_accessor :app_name, :redis, :host
+      attr_accessor :app_name, :cache, :host
       attr_reader :environment
       attr_writer :logger, :revoked_token_ids, :keys
 

data/lib/zaikio/jwt_auth/directory_cache.rb

@@ -16,7 +16,7 @@ module Zaikio
 
       class << self
         def fetch(directory_path, options = {})
-          cache = Zaikio::JWTAuth.configuration.redis.get("zaikio::jwt_auth::#{directory_path}")
+          cache = Zaikio::JWTAuth.configuration.cache.read("zaikio::jwt_auth::#{directory_path}")
 
           json = Oj.load(cache) if cache
 
@@ -31,14 +31,14 @@ module Zaikio
         def update(directory_path, options = {})
           data = fetch(directory_path, options)
           data = yield(data)
-          Zaikio::JWTAuth.configuration.redis.set("zaikio::jwt_auth::#{directory_path}", {
+          Zaikio::JWTAuth.configuration.cache.write("zaikio::jwt_auth::#{directory_path}", {
             fetched_at: Time.now.to_i,
             data: data
           }.to_json)
         end
 
         def reset(directory_path)
-          Zaikio::JWTAuth.configuration.redis.del("zaikio::jwt_auth::#{directory_path}")
+          Zaikio::JWTAuth.configuration.cache.delete("zaikio::jwt_auth::#{directory_path}")
         end
 
         private
@@ -49,28 +49,34 @@ module Zaikio
 
         def reload_or_enqueue(directory_path)
           data = fetch_from_directory(directory_path)
-          Zaikio::JWTAuth.configuration.redis.set("zaikio::jwt_auth::#{directory_path}", {
+          Zaikio::JWTAuth.configuration.cache.write("zaikio::jwt_auth::#{directory_path}", {
             fetched_at: Time.now.to_i,
             data: data
           }.to_json)
 
           data
         rescue Errno::ECONNREFUSED, Net::ReadTimeout, BadResponseError
-          Zaikio::JWTAuth.configuration.logger.info("Error updating DirectoryCache(#{directory_path}), enqueueing job to update")
+          Zaikio::JWTAuth.configuration.logger
+                         .info("Error updating DirectoryCache(#{directory_path}), enqueueing job to update")
           UpdateJob.set(wait: 10.seconds).perform_later(directory_path)
           nil
         end
 
         def fetch_from_directory(directory_path)
-          uri = URI("#{Zaikio::JWTAuth.configuration.host}/#{directory_path}")
-          http = Net::HTTP.new(uri.host, uri.port)
-          http.use_ssl = uri.scheme == "https"
-          response = http.request(Net::HTTP::Get.new(uri.request_uri))
+          response = make_http_request(directory_path)
+
           raise BadResponseError unless (200..299).cover?(response.code.to_i)
           raise BadResponseError unless response["content-type"].to_s.include?("application/json")
 
           Oj.load(response.body)
         end
+
+        def make_http_request(directory_path)
+          uri = URI("#{Zaikio::JWTAuth.configuration.host}/#{directory_path}")
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = uri.scheme == "https"
+          http.request(Net::HTTP::Get.new(uri.request_uri))
+        end
       end
     end
   end

data/lib/zaikio/jwt_auth/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module JWTAuth
-    VERSION = "1.0.0".freeze
+    VERSION = "2.0.0".freeze
   end
 end

data/lib/zaikio/jwt_auth.rb

@@ -45,7 +45,7 @@ module Zaikio
     end
 
     def self.mocked_jwt_payload
-      @mocked_jwt_payload
+      instance_variable_defined?(:@mocked_jwt_payload) && @mocked_jwt_payload
     end
 
     def self.mocked_jwt_payload=(payload)
@@ -67,8 +67,12 @@ module Zaikio
     end
 
     module ClassMethods
-      def authorize_by_jwt_subject_type(type = nil)
-        @authorize_by_jwt_subject_type ||= type
+      def authorize_by_jwt_subject_type(type = :_not_given_)
+        if type != :_not_given_
+          @authorize_by_jwt_subject_type = type
+        elsif instance_variable_defined?(:@authorize_by_jwt_subject_type)
+          @authorize_by_jwt_subject_type
+        end
       end
 
       def authorize_by_jwt_scopes(scopes = nil, options = {})
@@ -78,6 +82,13 @@ module Zaikio
 
         @authorize_by_jwt_scopes
       end
+
+      def inherited(child)
+        super(child)
+
+        child.instance_variable_set(:@authorize_by_jwt_subject_type, @authorize_by_jwt_subject_type)
+        child.instance_variable_set(:@authorize_by_jwt_scopes, @authorize_by_jwt_scopes)
+      end
     end
 
     module InstanceMethods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-jwt_auth
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - crispymtn
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2022-04-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.11
 signing_key: 
 specification_version: 4
 summary: JWT-Based authentication and authorization with zaikio