workato-connector-sdk 1.3.4 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9685f9ff505890441b060e537a1ecd932d1411eb340f88d467a099d86e0f2477
-  data.tar.gz: 04121dee1b0d2e9b64749e73269552631db9137e54cd6942438e4a1e039260c6
+  metadata.gz: 187eed4920526bb473b0a180df102f7efae2670486ce494d3bd2cb63014583a2
+  data.tar.gz: ec8bee19f0db62e579a2dfc4284527e21f62009a2e3a24ccdee0b1895c3a715d
 SHA512:
-  metadata.gz: 43c8e6dd0d6ccdbda9ddfa0c78dcd16923fe4700d6edda779a91d6b095158813caa491cc25585c3df6729864414b959009fe60d12489dbfbbf5c50e22a33c67a
-  data.tar.gz: 29bdd436e52361927397e37bdde770d244feee557c6038f426c73ba12b29aa231222655128acd3179c96c53cc327c9152bab019c38372b138cc485ef89835abc
+  metadata.gz: da690f559eb1147232cea5818d3bb1d697ae30a7daff2ddd115ec0f53ba648372f477b2052e534aae8ab8b539d8cb07346dd04ada2362e59956853a68e2dbd07
+  data.tar.gz: 9fc5327fbc5dc9b4cf58102afaeec169557e36d39085e12a6522c63309d4481d87096e67820205cca6df6403bdaed76095d966289b56d4dbc3f8a9b0a70eaecb

data/VERSION

@@ -1 +1 @@
-1.3.4
+1.3.6

data/lib/workato/cli/exec_command.rb

@@ -3,7 +3,7 @@
 
 require 'thor'
 require 'active_support/json'
-require_relative './multi_auth_selected_fallback'
+require_relative 'multi_auth_selected_fallback'
 
 Method.prepend(T::CompatibilityPatches::MethodExtensions)
 

data/lib/workato/cli/main.rb

@@ -3,14 +3,14 @@
 
 require 'thor'
 require 'workato/connector/sdk'
-require_relative './exec_command'
-require_relative './edit_command'
-require_relative './schema_command'
-require_relative './generate_command'
-require_relative './push_command'
-require_relative './oauth2_command'
-require_relative './generators/connector_generator'
-require_relative './generators/master_key_generator'
+require_relative 'exec_command'
+require_relative 'edit_command'
+require_relative 'schema_command'
+require_relative 'generate_command'
+require_relative 'push_command'
+require_relative 'oauth2_command'
+require_relative 'generators/connector_generator'
+require_relative 'generators/master_key_generator'
 
 module Workato
   module CLI

data/lib/workato/cli/oauth2_command.rb

@@ -4,7 +4,7 @@
 require 'thor'
 require 'securerandom'
 require 'workato/web/app'
-require_relative './multi_auth_selected_fallback'
+require_relative 'multi_auth_selected_fallback'
 
 module Workato
   module CLI

data/lib/workato/connector/sdk/action.rb

@@ -1,8 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative './operation'
-require_relative './block_invocation_refinements'
+require_relative 'operation'
+require_relative 'block_invocation_refinements'
 
 module Workato
   module Connector

data/lib/workato/connector/sdk/connection.rb

@@ -1,9 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative './block_invocation_refinements'
-
-using Workato::Extension::HashWithIndifferentAccess
+require_relative 'block_invocation_refinements'
 
 module Workato
   module Connector
@@ -13,19 +11,29 @@ module Workato
           T.any(
             # oauth2
             [
-              HashWithIndifferentAccess, # tokens
+              ActiveSupport::HashWithIndifferentAccess, # tokens
               T.untyped, # resource_owner_id
-              T.nilable(HashWithIndifferentAccess) # settings
+              T.nilable(ActiveSupport::HashWithIndifferentAccess) # settings
             ],
             [
-              HashWithIndifferentAccess, # tokens
+              ActiveSupport::HashWithIndifferentAccess, # tokens
               T.untyped # resource_owner_id
             ],
             [
-              HashWithIndifferentAccess # tokens
+              ActiveSupport::HashWithIndifferentAccess # tokens
             ],
             # custom_auth
-            HashWithIndifferentAccess
+            ActiveSupport::HashWithIndifferentAccess
+          )
+        end
+
+        RefreshOutput = T.type_alias do
+          T.any(
+            [
+              ActiveSupport::HashWithIndifferentAccess,
+              T.nilable(String)
+            ],
+            ActiveSupport::HashWithIndifferentAccess
           )
         end
       end
@@ -37,7 +45,7 @@ module Workato
         using BlockInvocationRefinements
 
         # @api private
-        sig { returns(HashWithIndifferentAccess) }
+        sig { returns(ActiveSupport::HashWithIndifferentAccess) }
         attr_reader :source
 
         class_attribute :on_settings_update, instance_predicate: false
@@ -52,8 +60,14 @@ module Workato
         end
         def initialize(connection: {}, methods: {}, settings: {})
           super()
-          @methods_source = T.let(HashWithIndifferentAccess.wrap(methods), HashWithIndifferentAccess)
-          @source = T.let(HashWithIndifferentAccess.wrap(connection), HashWithIndifferentAccess)
+          @methods_source = T.let(
+            Utilities::HashWithIndifferentAccess.wrap(methods),
+            ActiveSupport::HashWithIndifferentAccess
+          )
+          @source = T.let(
+            Utilities::HashWithIndifferentAccess.wrap(connection),
+            ActiveSupport::HashWithIndifferentAccess
+          )
           @settings = T.let(settings, SorbetTypes::SettingsHash)
         end
 
@@ -64,7 +78,7 @@ module Workato
         end
 
         # @api private
-        sig { returns(HashWithIndifferentAccess) }
+        sig { returns(ActiveSupport::HashWithIndifferentAccess) }
         def settings
           # we can't freeze or memoise because some developers modify it for storing something temporary in it.
           # always return a new copy
@@ -89,11 +103,13 @@ module Workato
         def authorization
           raise ::NotImplementedError, 'define authorization: before use' if source[:authorization].blank?
 
-          @authorization = T.let(@authorization, T.nilable(Authorization))
-          @authorization ||= Authorization.new(
-            connection: self,
-            authorization: source[:authorization],
-            methods: methods_source
+          @authorization ||= T.let(
+            Authorization.new(
+              connection: self,
+              authorization: source[:authorization],
+              methods: methods_source
+            ),
+            T.nilable(Authorization)
           )
         end
 
@@ -137,7 +153,7 @@ module Workato
 
         private
 
-        sig { returns(HashWithIndifferentAccess) }
+        sig { returns(ActiveSupport::HashWithIndifferentAccess) }
         attr_reader :methods_source
 
         sig { returns(Dsl::WithDsl) }
@@ -151,15 +167,15 @@ module Workato
           sig do
             params(
               connection: Connection,
-              authorization: HashWithIndifferentAccess,
-              methods: HashWithIndifferentAccess
+              authorization: ActiveSupport::HashWithIndifferentAccess,
+              methods: ActiveSupport::HashWithIndifferentAccess
             ).void
           end
           def initialize(connection:, authorization:, methods:)
             @connection = T.let(connection, Connection)
-            @connection_source = T.let(connection.source, HashWithIndifferentAccess)
-            @source = T.let(authorization, HashWithIndifferentAccess)
-            @methods_source = T.let(methods, HashWithIndifferentAccess)
+            @connection_source = T.let(connection.source, ActiveSupport::HashWithIndifferentAccess)
+            @source = T.let(authorization, ActiveSupport::HashWithIndifferentAccess)
+            @methods_source = T.let(methods, ActiveSupport::HashWithIndifferentAccess)
           end
 
           sig { returns(String) }
@@ -243,7 +259,7 @@ module Workato
               connection: Connection.new(
                 connection: connection_source.merge(
                   authorization: source.merge(
-                    apply: nil # only skip apply authorization for re-authorization request
+                    apply: nil # only skip apply authorization for re-authorization request, but don't skip detect_on
                   )
                 ),
                 methods: methods_source,
@@ -255,6 +271,11 @@ module Workato
             end
           end
 
+          sig { returns(T::Boolean) }
+          def reauthorizable?
+            oauth2? || source[:acquire].present?
+          end
+
           sig do
             params(
               http_code: T.nilable(Integer),
@@ -263,7 +284,7 @@ module Workato
             ).returns(T::Boolean)
           end
           def refresh?(http_code, http_body, exception)
-            return false unless oauth2? || source[:acquire].present?
+            return false unless reauthorizable?
 
             refresh_on = self.refresh_on
             refresh_on.blank? || refresh_on.any? do |pattern|
@@ -274,12 +295,16 @@ module Workato
           end
 
           # @api private
-          sig { params(settings: HashWithIndifferentAccess).returns(T.nilable(HashWithIndifferentAccess)) }
+          sig do
+            params(
+              settings: ActiveSupport::HashWithIndifferentAccess
+            ).returns(T.nilable(ActiveSupport::HashWithIndifferentAccess))
+          end
           def refresh!(settings)
             if oauth2?
               refresh_oauth2_token(settings)
             elsif source[:acquire].present?
-              T.cast(acquire(settings), T.nilable(HashWithIndifferentAccess))
+              T.cast(acquire(settings), T.nilable(ActiveSupport::HashWithIndifferentAccess))
             end
           end
 
@@ -287,9 +312,7 @@ module Workato
             params(
               settings: T.nilable(SorbetTypes::SettingsHash),
               refresh_token: T.nilable(String)
-            ).returns(
-              T.any([HashWithIndifferentAccess, T.nilable(String)], HashWithIndifferentAccess)
-            )
+            ).returns(SorbetTypes::RefreshOutput)
           end
           def refresh(settings = nil, refresh_token = nil)
             @connection.merge_settings!(settings) if settings
@@ -308,7 +331,7 @@ module Workato
           end
 
           # @api private
-          sig { returns(HashWithIndifferentAccess) }
+          sig { returns(ActiveSupport::HashWithIndifferentAccess) }
           def source
             return @source unless multi?
 
@@ -331,13 +354,17 @@ module Workato
 
           private
 
-          sig { returns(HashWithIndifferentAccess) }
+          sig { returns(ActiveSupport::HashWithIndifferentAccess) }
           attr_reader :connection_source
 
-          sig { returns(HashWithIndifferentAccess) }
+          sig { returns(ActiveSupport::HashWithIndifferentAccess) }
           attr_reader :methods_source
 
-          sig { params(settings: HashWithIndifferentAccess).returns(HashWithIndifferentAccess) }
+          sig do
+            params(
+              settings: ActiveSupport::HashWithIndifferentAccess
+            ).returns(ActiveSupport::HashWithIndifferentAccess)
+          end
           def refresh_oauth2_token(settings)
             if source[:refresh].present?
               refresh_oauth2_token_using_refresh(settings)
@@ -348,16 +375,24 @@ module Workato
             end
           end
 
-          sig { params(settings: HashWithIndifferentAccess).returns(HashWithIndifferentAccess) }
+          sig do
+            params(
+              settings: ActiveSupport::HashWithIndifferentAccess
+            ).returns(ActiveSupport::HashWithIndifferentAccess)
+          end
           def refresh_oauth2_token_using_refresh(settings)
             new_tokens, new_settings = refresh(settings, settings[:refresh_token])
-            new_tokens = HashWithIndifferentAccess.wrap(new_tokens)
+            new_tokens = Utilities::HashWithIndifferentAccess.wrap(new_tokens)
             return new_tokens unless new_settings
 
             new_tokens.merge(new_settings)
           end
 
-          sig { params(settings: HashWithIndifferentAccess).returns(HashWithIndifferentAccess) }
+          sig do
+            params(
+              settings: ActiveSupport::HashWithIndifferentAccess
+            ).returns(ActiveSupport::HashWithIndifferentAccess)
+          end
           def refresh_oauth2_token_using_token_url(settings)
             if settings[:refresh_token].blank?
               raise NotImplementedError, 'refresh_token is empty. ' \

data/lib/workato/connector/sdk/connector.rb

@@ -1,20 +1,20 @@
 # typed: strict
 # frozen_string_literal: true
 
-using Workato::Extension::HashWithIndifferentAccess
-
 module Workato
   module Connector
     module Sdk
       module SorbetTypes
-        SourceHash = T.type_alias { T.any(HashWithIndifferentAccess, T::Hash[T.any(Symbol, String), T.untyped]) }
+        SourceHash = T.type_alias do
+          T.any(ActiveSupport::HashWithIndifferentAccess, T::Hash[T.any(Symbol, String), T.untyped])
+        end
       end
 
       class Connector
         extend T::Sig
 
         # @api private
-        sig { returns(HashWithIndifferentAccess) }
+        sig { returns(ActiveSupport::HashWithIndifferentAccess) }
         attr_reader :source
 
         sig { params(path_to_source_code: String, settings: SorbetTypes::SettingsHash).returns(Connector) }
@@ -24,10 +24,22 @@ module Workato
 
         sig { params(definition: SorbetTypes::SourceHash, settings: SorbetTypes::SettingsHash).void }
         def initialize(definition, settings = {})
-          @source = T.let(HashWithIndifferentAccess.wrap(definition), HashWithIndifferentAccess)
-          @settings = T.let(HashWithIndifferentAccess.wrap(settings), HashWithIndifferentAccess)
-          @connection_source = T.let(HashWithIndifferentAccess.wrap(@source[:connection]), HashWithIndifferentAccess)
-          @methods_source = T.let(HashWithIndifferentAccess.wrap(@source[:methods]), HashWithIndifferentAccess)
+          @source = T.let(
+            Utilities::HashWithIndifferentAccess.wrap(definition),
+            ActiveSupport::HashWithIndifferentAccess
+          )
+          @settings = T.let(
+            Utilities::HashWithIndifferentAccess.wrap(settings),
+            ActiveSupport::HashWithIndifferentAccess
+          )
+          @connection_source = T.let(
+            Utilities::HashWithIndifferentAccess.wrap(@source[:connection]),
+            ActiveSupport::HashWithIndifferentAccess
+          )
+          @methods_source = T.let(
+            Utilities::HashWithIndifferentAccess.wrap(@source[:methods]),
+            ActiveSupport::HashWithIndifferentAccess
+          )
         end
 
         sig { returns(T.nilable(String)) }
@@ -37,23 +49,27 @@ module Workato
 
         sig { returns(ActionsProxy) }
         def actions
-          @actions = T.let(@actions, T.nilable(ActionsProxy))
-          @actions ||= ActionsProxy.new(
-            actions: source[:actions].presence || {},
-            methods: methods_source,
-            object_definitions: object_definitions,
-            connection: connection,
-            streams: streams
+          @actions ||= T.let(
+            ActionsProxy.new(
+              actions: source[:actions].presence || {},
+              methods: methods_source,
+              object_definitions: object_definitions,
+              connection: connection,
+              streams: streams
+            ),
+            T.nilable(ActionsProxy)
           )
         end
 
         sig { returns(MethodsProxy) }
         def methods
-          @methods = T.let(@methods, T.nilable(MethodsProxy))
-          @methods ||= MethodsProxy.new(
-            methods: methods_source,
-            connection: connection,
-            streams: streams
+          @methods ||= T.let(
+            MethodsProxy.new(
+              methods: methods_source,
+              connection: connection,
+              streams: streams
+            ),
+            T.nilable(MethodsProxy)
           )
         end
 
@@ -72,64 +88,74 @@ module Workato
 
         sig { returns(TriggersProxy) }
         def triggers
-          @triggers = T.let(@triggers, T.nilable(TriggersProxy))
-          @triggers ||= TriggersProxy.new(
-            triggers: source[:triggers].presence || {},
-            methods: methods_source,
-            connection: connection,
-            object_definitions: object_definitions,
-            streams: streams
+          @triggers ||= T.let(
+            TriggersProxy.new(
+              triggers: source[:triggers].presence || {},
+              methods: methods_source,
+              connection: connection,
+              object_definitions: object_definitions,
+              streams: streams
+            ),
+            T.nilable(TriggersProxy)
           )
         end
 
         sig { returns(ObjectDefinitions) }
         def object_definitions
-          @object_definitions = T.let(@object_definitions, T.nilable(ObjectDefinitions))
-          @object_definitions ||= ObjectDefinitions.new(
-            object_definitions: source[:object_definitions].presence || {},
-            methods: methods_source,
-            connection: connection
+          @object_definitions ||= T.let(
+            ObjectDefinitions.new(
+              object_definitions: source[:object_definitions].presence || {},
+              methods: methods_source,
+              connection: connection
+            ),
+            T.nilable(ObjectDefinitions)
           )
         end
 
         sig { returns(PickListsProxy) }
         def pick_lists
-          @pick_lists = T.let(@pick_lists, T.nilable(PickListsProxy))
-          @pick_lists ||= PickListsProxy.new(
-            pick_lists: source[:pick_lists].presence || {},
-            methods: methods_source,
-            connection: connection
+          @pick_lists ||= T.let(
+            PickListsProxy.new(
+              pick_lists: source[:pick_lists].presence || {},
+              methods: methods_source,
+              connection: connection
+            ),
+            T.nilable(PickListsProxy)
           )
         end
 
         sig { returns(Connection) }
         def connection
-          @connection = T.let(@connection, T.nilable(Connection))
-          @connection ||= Connection.new(
-            methods: methods_source,
-            connection: connection_source,
-            settings: settings
+          @connection ||= T.let(
+            Connection.new(
+              methods: methods_source,
+              connection: connection_source,
+              settings: settings
+            ),
+            T.nilable(Connection)
           )
         end
 
         sig { returns(Streams) }
         def streams
-          @streams = T.let(@streams, T.nilable(Streams))
-          @streams ||= Streams.new(
-            streams: streams_sources,
-            methods: methods_source,
-            connection: connection
+          @streams ||= T.let(
+            Streams.new(
+              streams: streams_sources,
+              methods: methods_source,
+              connection: connection
+            ),
+            T.nilable(Streams)
           )
         end
 
         private
 
-        sig { returns(HashWithIndifferentAccess) }
+        sig { returns(ActiveSupport::HashWithIndifferentAccess) }
         def streams_sources
-          @streams_sources = T.let(@streams_sources, T.nilable(HashWithIndifferentAccess))
+          @streams_sources = T.let(@streams_sources, T.nilable(ActiveSupport::HashWithIndifferentAccess))
           return @streams_sources if @streams_sources
 
-          @streams_sources = HashWithIndifferentAccess.new
+          @streams_sources = ActiveSupport::HashWithIndifferentAccess.new
           @streams_sources.merge!(source[:streams].presence || {})
           (source[:actions] || {}).values.map do |action|
             @streams_sources.merge!(action[:streams] || {})
@@ -140,10 +166,10 @@ module Workato
           @streams_sources
         end
 
-        sig { returns(HashWithIndifferentAccess) }
+        sig { returns(ActiveSupport::HashWithIndifferentAccess) }
         attr_reader :methods_source
 
-        sig { returns(HashWithIndifferentAccess) }
+        sig { returns(ActiveSupport::HashWithIndifferentAccess) }
         attr_reader :connection_source
 
         sig { returns(SorbetTypes::SettingsHash) }
@@ -155,9 +181,9 @@ module Workato
 
         sig do
           params(
-            actions: HashWithIndifferentAccess,
+            actions: ActiveSupport::HashWithIndifferentAccess,
             object_definitions: ObjectDefinitions,
-            methods: HashWithIndifferentAccess,
+            methods: ActiveSupport::HashWithIndifferentAccess,
             connection: Connection,
             streams: Streams
           ).void
@@ -178,7 +204,7 @@ module Workato
 
         private
 
-        sig { returns(HashWithIndifferentAccess) }
+        sig { returns(ActiveSupport::HashWithIndifferentAccess) }
         attr_reader :methods
 
         sig { returns(Connection) }
@@ -190,7 +216,7 @@ module Workato
         sig { returns(ObjectDefinitions) }
         attr_reader :object_definitions
 
-        sig { params(actions_source: HashWithIndifferentAccess).void }
+        sig { params(actions_source: ActiveSupport::HashWithIndifferentAccess).void }
         def define_action_methods(actions_source)
           actions_source.each do |action, definition|
             define_singleton_method(action) do |input_ = nil|
@@ -216,7 +242,7 @@ module Workato
 
         sig do
           params(
-            methods: HashWithIndifferentAccess,
+            methods: ActiveSupport::HashWithIndifferentAccess,
             connection: Connection,
             streams: Streams
           ).void
@@ -231,7 +257,7 @@ module Workato
 
         private
 
-        sig { returns(HashWithIndifferentAccess) }
+        sig { returns(ActiveSupport::HashWithIndifferentAccess) }
         attr_reader :methods
 
         sig { returns(Connection) }
@@ -265,8 +291,8 @@ module Workato
 
         sig do
           params(
-            pick_lists: HashWithIndifferentAccess,
-            methods: HashWithIndifferentAccess,
+            pick_lists: ActiveSupport::HashWithIndifferentAccess,
+            methods: ActiveSupport::HashWithIndifferentAccess,
             connection: Connection
           ).void
         end
@@ -279,13 +305,13 @@ module Workato
 
         private
 
-        sig { returns(HashWithIndifferentAccess) }
+        sig { returns(ActiveSupport::HashWithIndifferentAccess) }
         attr_reader :methods
 
         sig { returns(Connection) }
         attr_reader :connection
 
-        sig { params(pick_lists_source: HashWithIndifferentAccess).void }
+        sig { params(pick_lists_source: ActiveSupport::HashWithIndifferentAccess).void }
         def define_action_methods(pick_lists_source)
           pick_lists_source.each do |pick_list, pick_list_proc|
             define_singleton_method(pick_list) do |settings = nil, args = {}|
@@ -318,9 +344,9 @@ module Workato
 
         sig do
           params(
-            triggers: HashWithIndifferentAccess,
+            triggers: ActiveSupport::HashWithIndifferentAccess,
             object_definitions: ObjectDefinitions,
-            methods: HashWithIndifferentAccess,
+            methods: ActiveSupport::HashWithIndifferentAccess,
             connection: Connection,
             streams: Streams
           ).void
@@ -341,7 +367,7 @@ module Workato
 
         private
 
-        sig { returns(HashWithIndifferentAccess) }
+        sig { returns(ActiveSupport::HashWithIndifferentAccess) }
         attr_reader :methods
 
         sig { returns(Connection) }
@@ -353,7 +379,7 @@ module Workato
         sig { returns(ObjectDefinitions) }
         attr_reader :object_definitions
 
-        sig { params(triggers_source: HashWithIndifferentAccess).void }
+        sig { params(triggers_source: ActiveSupport::HashWithIndifferentAccess).void }
         def define_trigger_methods(triggers_source)
           triggers_source.each do |trigger, definition|
             define_singleton_method(trigger) do |input_ = nil, payload = {}, headers = {}, params = {}|

data/lib/workato/connector/sdk/core.rb

@@ -42,21 +42,21 @@ module Workato
   end
 end
 
-require_relative '../../extension/hash_with_indifferent_access'
-
-require_relative './errors'
-require_relative './account_properties'
-require_relative './operation'
-require_relative './connection'
-require_relative './stream'
-require_relative './streams'
-require_relative './action'
-require_relative './lookup_tables'
-require_relative './object_definitions'
-require_relative './request'
-require_relative './settings'
-require_relative './summarize'
-require_relative './trigger'
-require_relative './version'
-require_relative './workato_schemas'
-require_relative './connector'
+require 'workato/utilities/hash_with_indifferent_access'
+
+require_relative 'errors'
+require_relative 'account_properties'
+require_relative 'operation'
+require_relative 'connection'
+require_relative 'stream'
+require_relative 'streams'
+require_relative 'action'
+require_relative 'lookup_tables'
+require_relative 'object_definitions'
+require_relative 'request'
+require_relative 'settings'
+require_relative 'summarize'
+require_relative 'trigger'
+require_relative 'version'
+require_relative 'workato_schemas'
+require_relative 'connector'