setsuzoku 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fc8faec9ca8af63095c8bcb40750b05286261e2d55c3e5b0e72716254de0d8d
-  data.tar.gz: e4f78c16811e13234dfccb2b60bf2158bcd25cf586e7c770b5c67643ec681344
+  metadata.gz: 4233d295eb8e38d96442e9727a7325cf1b7673f41fd1575af095a4c89563213c
+  data.tar.gz: a25508116b564e0fdc9aaa007b56a72404b8f7116d7fe7506e008337717a649c
 SHA512:
-  metadata.gz: 280622a422f80f84bc13dd5b83e87be5b756d393645741d8b0b155b45713fad63bb55e62147cb2a4f34e963241c6f56ad66018c412141f927c5679f0ea514bd4
-  data.tar.gz: b106bffe570548d00faf98b7d19695b759bbeff0dd9c807848b5147a049ff2d5836688fb67d4a362398c1844eaaff648605f5775b660770453a287a662348433
+  metadata.gz: a2257bb847f9e182885aa367ac5c886517460b57f9e84fd4f043678f1767da72c6d39fc32bc5c0a9efd92b57f0e582ff1b08d9ba4b7f008959bd20b55e1eddcd
+  data.tar.gz: e5bd652f32e76a02e2c34e6afbec22920afc44ec9c96503d2a78b00ef5da62c1e87f013a9919ee20ce9c0788b82473f93164e770ecc3abda86ee65cee1a1ba00

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    setsuzoku (0.13.1)
+    setsuzoku (0.14.0)
       activesupport (>= 5.0, < 7)
       faraday (~> 0.11)
       nokogiri (~> 1.10)
@@ -10,29 +10,31 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.4.2)
-    faraday (0.17.3)
+    faraday (0.17.4)
       multipart-post (>= 1.2, < 3)
     hashdiff (1.0.1)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
+    mini_portile2 (2.5.3)
+    minitest (5.14.4)
     multipart-post (2.1.1)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.11.7)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     public_suffix (4.0.5)
+    racc (1.5.2)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -50,16 +52,15 @@ GEM
     safe_yaml (1.0.5)
     sorbet (0.5.5675)
       sorbet-static (= 0.5.5675)
-    sorbet-runtime (0.5.5937)
+    sorbet-runtime (0.5.6466)
     sorbet-static (0.5.5675-universal-darwin-14)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     webmock (3.8.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/lib/setsuzoku/service/web_service/auth_strategies/strategy_can_use_tokens.rb

@@ -144,31 +144,20 @@ module Setsuzoku
 
             return false unless resp.success
 
-            attrs = self.credential.token_attributes_to_assign(resp)
-            attrs[:status] = if attrs[:token]
-                               'active'
-                             else
-                               'error'
-                             end
-
-            # Assign any additional attributes the plugin's credential needs to know about.
-            # E.g. the extension for a phone_number.
-            plugin_attrs = self.credential.additional_attributes_to_assign(resp) if self.plugin.respond_to?(:credential_fields_to_update)
-            attrs.merge!(plugin_attrs) if plugin_attrs
-
-            # Only save Setsuzoku known fields, and any additional attributes the plugin specifies
-            # in credential_fields_to_update.
-            if self.credential.respond_to?(:"update_columns")
-              # we issue an update_columns instead of a save/update_attributes
-              # so as to only mutate these attributes
-              # and not any other fields that may have been set for the credential
-              save = self.credential.update_columns(attrs)
-              self.credential.touch if save && self.credential.respond_to?(:"touch")
-              save
-            else
-              true
-            end
+            self.credential.set_token!(resp)
           end
+
+          #
+          # set_token!
+          sig { abstract.params(resp: Setsuzoku::ApiResponse, attrs: T::Hash[Symbol, T.untyped]).void }
+          #
+          # Persist relevant token and response data after authentication.
+          #
+          # @param resp [Setsuzoku::ApiResponse] the successful response for an authentication token.
+          # @param attrs [Hash] additional attrs that can be set by a specific credential implementation.
+          #
+          # @return [void]
+          def set_token!(resp, attrs); end
         end
       end
     end

data/lib/setsuzoku/service/web_service/credentials/o_auth_credential.rb

@@ -54,26 +54,6 @@ module Setsuzoku
           sig { abstract.returns(T.nilable(String)) }
           def redirect_url; end
 
-          # The token, refresh_token, and expires_at to assign for an OAuth token request.
-          #
-          # @param resp [Hash] the response hash from the external api call for a token.
-          #
-          # @return [Hash] the attributes to assign to the credential.
-          sig{ overridable.params(resp: Setsuzoku::ApiResponse).returns(T::Hash[Symbol, T.untyped]) }
-          def token_attributes_to_assign(resp)
-            attrs = {
-                token: resp.data[:access_token],
-                refresh_token: resp.data[:refresh_token]
-            }
-
-            expires_in = resp.data[:expires_in]
-            if expires_in && (expires_in.is_a?(Integer) || expires_in.match(/^\d+$/))
-              attrs[:expires_on] = expires_in.to_i.seconds.from_now
-            end
-
-            attrs
-          end
-
           # Stub an o_auth_credential-like instance.
           #
           # @return [Struct] a stubbed o_auth_credential-like struct.

data/lib/setsuzoku/service/web_service/credentials/uses_credential_token.rb

@@ -51,16 +51,16 @@ module Setsuzoku
           #
           # @return [Datetime] the time to set for the current token's expiry.
           sig{ abstract.params(val: DateTime).returns(T.nilable(DateTime)) }
-          def expires_on=(val);
+          def expires_on=(val); end
 
-          # The token fields to bet set for the custom credential.
+          # Alternatively, a credential can manually handle what to do with a token response.
+          # For instance, storing multiple tokens as sub-resources
           #
           # @param resp [Hash] the response hash from the external api call for a token.
           #
           # @return [Hash] the attributes to assign to the credential.
-          sig{ abstract.params(resp: T::Hash[Symbol, T.untyped]).returns(T::Hash[Symbol, T.untyped]) }
-          def token_attributes_to_assign(resp); end
-          end
+          sig{ abstract.params(resp: T::Hash[Symbol, T.untyped]).void }
+          def set_token!; end
         end
       end
     end

data/lib/setsuzoku/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Setsuzoku
-  VERSION = '0.13.1'
+  VERSION = '0.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: setsuzoku
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Luke Stadtler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler