zaikio-oauth_client 0.3.7 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70df4bc301aecf7787f230307e05d94a5df5e68bc53c631bd4923e007f1c4882
-  data.tar.gz: e19b1250fed256fd761c47b08d7b436311547559834b6939202d0bf2b4d35f92
+  metadata.gz: eb774c96ee88f324e6da5b8ece141a110f306d5a38506ab33bb1c44b4fa6ca16
+  data.tar.gz: 6bf71d03fac23bca3c96fe38c7b7ad84d0f609dc98a4cc673ab44e83dfff001f
 SHA512:
-  metadata.gz: 621cbc8f24b5db20feebc5398cba2a444cab5a2d9652e44ed53675b889b7033df68410302885781aa7714626ed3f325384e9f6ca80fd21025b2490f6310d4060
-  data.tar.gz: 728955826c11c5f9d955ad03f1d2c3d9631f023d07aa84fbe9f06583392fb87a9d5850e3195381100aacf4262d94dec725018e3aa9783e862a5a546486aa7ae5
+  metadata.gz: 878a92cd495fb07fa942a0e100862586a42c262bafdd9afa64d9cee76efd2b3a85d833b4c92bda916f66afa97c6c7cfe9090ddee2cdf9834a7deae3c22bb0bc3
+  data.tar.gz: 72084e3c353aeed81b6dbc7cee0eb2ae44ab5140c5a55319dc4933e35944881d66a98fa329230d3a3b902e98701f1dc9de6e05539e9b1f8917720c5056f21a3c

data/README.md

@@ -26,6 +26,8 @@ This will create the tables:
 
 ### 2. Mount routes
 
+Add this to `config/routes.rb`:
+
 ```rb
 mount Zaikio::OAuthClient::Engine => "/zaikio"
 ```
@@ -65,6 +67,28 @@ Zaikio::OAuthClient.configure do |config|
 end
 ```
 
+
+### 4. Clean up outdated access tokens (recommended)
+
+To avoid keeping all expired oath and refresh tokens in your database, we recommend to implement their scheduled deletion. We recommend therefore to use a schedule gems such as [sidekiq](https://github.com/mperham/sidekiq) and [sidekiq-scheduler](https://github.com/moove-it/sidekiq-scheduler).
+
+Simply add the following to your Gemfile:
+
+```rb
+gem "sidekiq"
+gem "sidekiq-scheduler"
+```
+Then run `bundle install`.
+
+Configure sidekiq scheduler in `config/sidekiq.yml`:
+```yaml
+:schedule:
+  cleanup_acces_tokens_job:
+    cron: '0 3 * * *'               # This will delete all expired tokens every day at 3am.
+    class: 'Zaikio::CleanupAccessTokensJob'
+```
+
+
 ## Usage
 
 ### OAuth Flow
@@ -210,7 +234,7 @@ If you use the provided OAuth credentials from above and test this against the S
 
 **Make sure you have the dummy app running locally to validate your changes.**
 
-Make your changes and adjust `version.rb`.
+Make your changes and adjust `version.rb`. Please make sure to update `CHANGELOG.md`.
 
 **To push a new release:**
 

data/app/jobs/zaikio/cleanup_access_tokens_job.rb

@@ -0,0 +1,7 @@
+module Zaikio
+  class CleanupAccessTokensJob < ApplicationJob
+    def perform
+      Zaikio::AccessToken.with_invalid_refresh_token.delete_all
+    end
+  end
+end

data/app/models/zaikio/access_token.rb

@@ -26,21 +26,24 @@ module Zaikio
     # Scopes
     scope :valid, lambda {
       where("expires_at > :now", now: Time.current)
-        .where.not(id: Zaikio::JWTAuth.blacklisted_token_ids)
+        .where.not(id: Zaikio::JWTAuth.revoked_token_ids)
+    }
+    scope :with_invalid_refresh_token, lambda {
+      where("created_at <= ?", Time.current - Zaikio::AccessToken.refresh_token_valid_for)
     }
     scope :valid_refresh, lambda {
       where("expires_at <= :now AND created_at > :created_at_max",
             now: Time.current,
             created_at_max: Time.current - refresh_token_valid_for)
         .where("refresh_token IS NOT NULL")
-        .where.not(id: Zaikio::JWTAuth.blacklisted_token_ids)
+        .where.not(id: Zaikio::JWTAuth.revoked_token_ids)
     }
     scope :by_bearer, lambda { |bearer_type: "Person", bearer_id:, scopes: []|
       where(bearer_type: bearer_type, bearer_id: bearer_id)
         .where("scopes @> ARRAY[?]::varchar[]", scopes)
     }
     scope :usable, lambda { |options|
-      by_bearer(options).valid.or(by_bearer(options).valid_refresh)
+      by_bearer(**options).valid.or(by_bearer(**options).valid_refresh)
                         .order(expires_at: :desc)
     }
 

data/lib/zaikio/oauth_client/configuration.rb

@@ -5,11 +5,11 @@ module Zaikio
   module OAuthClient
     class Configuration
       HOSTS = {
-        development: "http://directory.zaikio.test",
-        test: "http://directory.zaikio.test",
-        staging: "https://directory.staging.zaikio.com",
-        sandbox: "https://directory.sandbox.zaikio.com",
-        production: "https://directory.zaikio.com"
+        development: "http://hub.zaikio.test",
+        test: "http://hub.zaikio.test",
+        staging: "https://hub.staging.zaikio.com",
+        sandbox: "https://hub.sandbox.zaikio.com",
+        production: "https://hub.zaikio.com"
       }.freeze
 
       attr_accessor :host

data/lib/zaikio/oauth_client/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module OAuthClient
-    VERSION = "0.3.7".freeze
+    VERSION = "0.4.2".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-oauth_client
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.2
 platform: ruby
 authors:
 - Zaikio GmbH
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2021-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,16 +42,22 @@ dependencies:
   name: zaikio-jwt_auth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.1
+    - - "<"
+      - !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.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +104,7 @@ files:
 - app/controllers/zaikio/oauth_client/sessions_controller.rb
 - app/helpers/zaikio/application_helper.rb
 - app/jobs/zaikio/application_job.rb
+- app/jobs/zaikio/cleanup_access_tokens_job.rb
 - app/models/zaikio/access_token.rb
 - config/initializers/inflections.rb
 - config/locales/en.yml
@@ -112,11 +119,12 @@ files:
 - lib/zaikio/oauth_client/engine.rb
 - lib/zaikio/oauth_client/test_helper.rb
 - lib/zaikio/oauth_client/version.rb
-homepage: https://crispymtn.com
+homepage: https://www.zaikio.com
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/zaikio/zaikio-oauth_client/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -131,8 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Zaikio Platform Connectivity
 test_files: []