workato-connector-sdk 1.2.0 → 1.3.1

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

@@ -32,14 +32,16 @@ module Workato
 
       class Connection
         extend T::Sig
+        include MonitorMixin
 
         using BlockInvocationRefinements
 
+        # @api private
         sig { returns(HashWithIndifferentAccess) }
         attr_reader :source
 
-        cattr_accessor :on_settings_update
-        cattr_accessor :multi_auth_selected_fallback
+        class_attribute :on_settings_update, instance_predicate: false
+        class_attribute :multi_auth_selected_fallback, instance_predicate: false
 
         sig do
           params(
@@ -49,28 +51,35 @@ module Workato
           ).void
         end
         def initialize(connection: {}, methods: {}, settings: {})
+          super()
           @methods_source = T.let(HashWithIndifferentAccess.wrap(methods), HashWithIndifferentAccess)
           @source = T.let(HashWithIndifferentAccess.wrap(connection), HashWithIndifferentAccess)
           @settings = T.let(settings, SorbetTypes::SettingsHash)
         end
 
+        # @api private
         sig { returns(SorbetTypes::SettingsHash) }
         def settings!
           @settings
         end
 
+        # @api private
         sig { returns(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
-          @settings.with_indifferent_access
+          synchronize do
+            @settings.with_indifferent_access
+          end
         end
 
+        # @api private
         sig { params(settings: SorbetTypes::SettingsHash).returns(SorbetTypes::SettingsHash) }
         def merge_settings!(settings)
           @settings.merge!(settings)
         end
 
+        # @api private
         sig { returns(T::Boolean) }
         def authorization?
           source[:authorization].present?
@@ -93,16 +102,18 @@ module Workato
           return unless source[:base_uri]
 
           merge_settings!(settings) if settings
-          Dsl::WithDsl.execute(self, self.settings, &source[:base_uri])
+          global_dsl_context.execute(self.settings, &source['base_uri'])
         end
 
+        # @api private
         sig do
           params(
             message: String,
+            settings_before: SorbetTypes::SettingsHash,
             refresher: T.proc.returns(T.nilable(SorbetTypes::SettingsHash))
           ).returns(T::Boolean)
         end
-        def update_settings!(message, &refresher)
+        def update_settings!(message, settings_before, &refresher)
           updater = lambda do
             new_settings = refresher.call
             next unless new_settings
@@ -110,16 +121,18 @@ module Workato
             settings.merge(new_settings)
           end
 
-          new_settings = if on_settings_update
-                           on_settings_update.call(message, &updater)
-                         else
-                           updater.call
-                         end
-          return false unless new_settings
+          synchronize do
+            new_settings = if on_settings_update
+                             T.must(on_settings_update).call(message, settings_before, updater)
+                           else
+                             updater.call
+                           end
+            return false unless new_settings
 
-          merge_settings!(new_settings)
+            merge_settings!(new_settings)
 
-          true
+            true
+          end
         end
 
         private
@@ -127,6 +140,11 @@ module Workato
         sig { returns(HashWithIndifferentAccess) }
         attr_reader :methods_source
 
+        sig { returns(Dsl::WithDsl) }
+        def global_dsl_context
+          Dsl::WithDsl.new(self)
+        end
+
         class Authorization
           extend T::Sig
 
@@ -175,7 +193,7 @@ module Workato
             client_id = source[:client_id]
 
             if client_id.is_a?(Proc)
-              Dsl::WithDsl.execute(@connection, @connection.settings, &client_id)
+              global_dsl_context.execute(@connection.settings, &client_id)
             else
               client_id
             end
@@ -187,7 +205,7 @@ module Workato
             client_secret_source = source[:client_secret]
 
             if client_secret_source.is_a?(Proc)
-              Dsl::WithDsl.execute(@connection, @connection.settings, &client_secret_source)
+              global_dsl_context.execute(@connection.settings, &client_secret_source)
             else
               client_secret_source
             end
@@ -198,7 +216,7 @@ module Workato
             @connection.merge_settings!(settings) if settings
             return unless source[:authorization_url]
 
-            Dsl::WithDsl.execute(@connection, @connection.settings, &source[:authorization_url])
+            global_dsl_context.execute(@connection.settings, &source[:authorization_url])
           end
 
           sig { params(settings: T.nilable(SorbetTypes::SettingsHash)).returns(T.nilable(String)) }
@@ -206,7 +224,7 @@ module Workato
             @connection.merge_settings!(settings) if settings
             return unless source[:token_url]
 
-            Dsl::WithDsl.execute(@connection, @connection.settings, &source[:token_url])
+            global_dsl_context.execute(@connection.settings, &source[:token_url])
           end
 
           sig do
@@ -249,12 +267,13 @@ module Workato
 
             refresh_on = self.refresh_on
             refresh_on.blank? || refresh_on.any? do |pattern|
-              pattern.is_a?(::Integer) && pattern == http_code ||
+              (pattern.is_a?(::Integer) && pattern == http_code) ||
                 pattern === exception&.to_s ||
                 pattern === http_body
             end
           end
 
+          # @api private
           sig { params(settings: HashWithIndifferentAccess).returns(T.nilable(HashWithIndifferentAccess)) }
           def refresh!(settings)
             if oauth2?
@@ -288,6 +307,7 @@ module Workato
             end
           end
 
+          # @api private
           sig { returns(HashWithIndifferentAccess) }
           def source
             return @source unless multi?
@@ -341,7 +361,7 @@ module Workato
           def refresh_oauth2_token_using_token_url(settings)
             if settings[:refresh_token].blank?
               raise NotImplementedError, 'refresh_token is empty. ' \
-                                       'Use workato oauth2 command to acquire access_token and refresh_token'
+                                         'Use workato oauth2 command to acquire access_token and refresh_token'
             end
 
             response = RestClient::Request.execute(
@@ -363,9 +383,12 @@ module Workato
               refresh_token: tokens['refresh_token'].presence || settings[:refresh_token]
             }.with_indifferent_access
           end
-        end
 
-        private_constant :Authorization
+          sig { returns(Dsl::WithDsl) }
+          def global_dsl_context
+            Dsl::WithDsl.new(@connection)
+          end
+        end
       end
     end
   end

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

@@ -13,6 +13,7 @@ module Workato
       class Connector
         extend T::Sig
 
+        # @api private
         sig { returns(HashWithIndifferentAccess) }
         attr_reader :source
 
@@ -29,11 +30,6 @@ module Workato
           @methods_source = T.let(HashWithIndifferentAccess.wrap(@source[:methods]), HashWithIndifferentAccess)
         end
 
-        sig { params(path: String, params: T::Hash[Symbol, T.untyped]).returns(T.untyped) }
-        def invoke(path, params = {})
-          InvokePath.new(path: path, connector: self, params: params).call
-        end
-
         sig { returns(T.nilable(String)) }
         def title
           @source[:title]
@@ -46,7 +42,8 @@ module Workato
             actions: source[:actions].presence || {},
             methods: methods_source,
             object_definitions: object_definitions,
-            connection: connection
+            connection: connection,
+            streams: streams
           )
         end
 
@@ -55,7 +52,8 @@ module Workato
           @methods = T.let(@methods, T.nilable(MethodsProxy))
           @methods ||= MethodsProxy.new(
             methods: methods_source,
-            connection: connection
+            connection: connection,
+            streams: streams
           )
         end
 
@@ -79,7 +77,8 @@ module Workato
             triggers: source[:triggers].presence || {},
             methods: methods_source,
             connection: connection,
-            object_definitions: object_definitions
+            object_definitions: object_definitions,
+            streams: streams
           )
         end
 
@@ -113,8 +112,34 @@ module Workato
           )
         end
 
+        sig { returns(Streams) }
+        def streams
+          @streams = T.let(@streams, T.nilable(Streams))
+          @streams ||= Streams.new(
+            streams: streams_sources,
+            methods: methods_source,
+            connection: connection
+          )
+        end
+
         private
 
+        sig { returns(HashWithIndifferentAccess) }
+        def streams_sources
+          @streams_sources = T.let(@streams_sources, T.nilable(HashWithIndifferentAccess))
+          return @streams_sources if @streams_sources
+
+          @streams_sources = HashWithIndifferentAccess.new
+          @streams_sources.merge!(source[:streams].presence || {})
+          (source[:actions] || {}).values.map do |action|
+            @streams_sources.merge!(action[:streams] || {})
+          end
+          (source[:trigger] || {}).values.map do |trigger|
+            @streams_sources.merge!(trigger[:streams] || {})
+          end
+          @streams_sources
+        end
+
         sig { returns(HashWithIndifferentAccess) }
         attr_reader :methods_source
 
@@ -133,18 +158,20 @@ module Workato
             actions: HashWithIndifferentAccess,
             object_definitions: ObjectDefinitions,
             methods: HashWithIndifferentAccess,
-            connection: Connection
+            connection: Connection,
+            streams: Streams
           ).void
         end
-        def initialize(actions:, object_definitions:, methods:, connection:)
+        def initialize(actions:, object_definitions:, methods:, connection:, streams:)
           @methods = methods
           @connection = connection
           @object_definitions = object_definitions
+          @streams = streams
           @actions = T.let({}, T::Hash[T.any(Symbol, String), Action])
           define_action_methods(actions)
         end
 
-        sig { params(action: T.any(Symbol, String)).returns(T.untyped) }
+        sig { params(action: T.any(Symbol, String)).returns(Action) }
         def [](action)
           public_send(action)
         end
@@ -157,6 +184,9 @@ module Workato
         sig { returns(Connection) }
         attr_reader :connection
 
+        sig { returns(Streams) }
+        attr_reader :streams
+
         sig { returns(ObjectDefinitions) }
         attr_reader :object_definitions
 
@@ -168,7 +198,8 @@ module Workato
                 action: definition,
                 object_definitions: object_definitions,
                 methods: methods,
-                connection: connection
+                connection: connection,
+                streams: streams
               )
               return @actions[action] if input_.nil?
 
@@ -178,18 +209,22 @@ module Workato
         end
       end
 
+      private_constant :ActionsProxy
+
       class MethodsProxy
         extend T::Sig
 
         sig do
           params(
             methods: HashWithIndifferentAccess,
-            connection: Connection
+            connection: Connection,
+            streams: Streams
           ).void
         end
-        def initialize(methods:, connection:)
+        def initialize(methods:, connection:, streams:)
           @methods = methods
           @connection = connection
+          @streams = streams
           @actions = T.let({}, T::Hash[T.any(Symbol, String), Action])
           define_action_methods
         end
@@ -202,6 +237,9 @@ module Workato
         sig { returns(Connection) }
         attr_reader :connection
 
+        sig { returns(Streams) }
+        attr_reader :streams
+
         sig { void }
         def define_action_methods
           methods.each do |method, _definition|
@@ -211,7 +249,8 @@ module Workato
                   execute: -> { T.unsafe(self).call(method, *args) }
                 },
                 methods: methods,
-                connection: connection
+                connection: connection,
+                streams: streams
               )
               T.must(@actions[method]).execute
             end
@@ -219,6 +258,8 @@ module Workato
         end
       end
 
+      private_constant :MethodsProxy
+
       class PickListsProxy
         extend T::Sig
 
@@ -270,6 +311,8 @@ module Workato
         end
       end
 
+      private_constant :PickListsProxy
+
       class TriggersProxy
         extend T::Sig
 
@@ -278,17 +321,24 @@ module Workato
             triggers: HashWithIndifferentAccess,
             object_definitions: ObjectDefinitions,
             methods: HashWithIndifferentAccess,
-            connection: Connection
+            connection: Connection,
+            streams: Streams
           ).void
         end
-        def initialize(triggers:, object_definitions:, methods:, connection:)
+        def initialize(triggers:, object_definitions:, methods:, connection:, streams:)
           @methods = methods
           @connection = connection
           @object_definitions = object_definitions
+          @streams = streams
           @triggers = T.let({}, T::Hash[T.any(Symbol, String), Trigger])
           define_trigger_methods(triggers)
         end
 
+        sig { params(trigger: T.any(Symbol, String)).returns(Trigger) }
+        def [](trigger)
+          public_send(trigger)
+        end
+
         private
 
         sig { returns(HashWithIndifferentAccess) }
@@ -297,6 +347,9 @@ module Workato
         sig { returns(Connection) }
         attr_reader :connection
 
+        sig { returns(Streams) }
+        attr_reader :streams
+
         sig { returns(ObjectDefinitions) }
         attr_reader :object_definitions
 
@@ -308,7 +361,8 @@ module Workato
                 trigger: definition,
                 object_definitions: object_definitions,
                 methods: methods,
-                connection: connection
+                connection: connection,
+                streams: streams
               )
 
               return @triggers[trigger] if input_.nil?
@@ -319,64 +373,7 @@ module Workato
         end
       end
 
-      class InvokePath
-        extend T::Sig
-
-        sig do
-          params(
-            path: String,
-            connector: Connector,
-            params: T::Hash[Symbol, T.untyped]
-          ).void
-        end
-        def initialize(path:, connector:, params:)
-          @path = T.let(path, String)
-          @connector = T.let(connector, Connector)
-          @params = T.let(params, T::Hash[Symbol, T.untyped])
-        end
-
-        sig { returns(T.untyped) }
-        def call
-          invoke_path
-        end
-
-        private
-
-        sig { returns(String) }
-        attr_reader :path
-
-        sig { returns(Connector) }
-        attr_reader :connector
-
-        sig { returns(T::Hash[Symbol, T.untyped]) }
-        attr_reader :params
-
-        sig { returns(T.untyped) }
-        def invoke_path
-          methods = path.split('.')
-          method = methods.pop
-          raise ArgumentError, 'path is not found' unless method
-
-          object = methods.inject(connector) { |obj, m| obj.public_send(m) }
-          output = invoke_method(object, method)
-          if output.respond_to?(:invoke)
-            invoke_method(output, :invoke)
-          else
-            output
-          end
-        end
-
-        sig { params(object: T.untyped, method: T.any(Symbol, String)).returns(T.untyped) }
-        def invoke_method(object, method)
-          parameters = object.method(method).parameters.reject { |p| p[0] == :block }.map(&:second)
-          args = params.values_at(*parameters)
-          if parameters.last == :args
-            args = args.take(args.length - 1) + Array.wrap(args.last).flatten(1)
-          end
-          object.public_send(method, *args)
-        end
-      end
-      private_constant :InvokePath
+      private_constant :TriggersProxy
     end
   end
 end

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

@@ -0,0 +1,62 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'active_support'
+require 'active_support/core_ext/object/deep_dup'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/array/wrap'
+require 'active_support/core_ext/array/access'
+require 'active_support/core_ext/numeric/bytes'
+require 'active_support/core_ext/numeric/conversions'
+require 'active_support/core_ext/numeric/time'
+
+module Workato
+  module Connector
+    module Sdk
+      DEFAULT_MASTER_KEY_ENV = 'WORKATO_CONNECTOR_MASTER_KEY'
+      DEFAULT_MASTER_KEY_PATH = 'master.key'
+
+      DEFAULT_CONNECTOR_PATH = 'connector.rb'
+
+      DEFAULT_SETTINGS_PATH = 'settings.yaml'
+      DEFAULT_ENCRYPTED_SETTINGS_PATH = 'settings.yaml.enc'
+
+      DEFAULT_ACCOUNT_PROPERTIES_PATH = 'account_properties.yaml'
+      DEFAULT_ENCRYPTED_ACCOUNT_PROPERTIES_PATH = 'account_properties.yaml.enc'
+
+      DEFAULT_LOOKUP_TABLES_PATH = 'lookup_tables.yaml'
+
+      DEFAULT_TIME_ZONE = 'Pacific Time (US & Canada)'
+
+      DEFAULT_SCHEMAS_PATH = 'workato_schemas.json'
+
+      WORKATO_API_EMAIL_ENV = 'WORKATO_API_EMAIL'
+      WORKATO_API_TOKEN_ENV = 'WORKATO_API_TOKEN'
+
+      WORKATO_BASE_URL_ENV = 'WORKATO_BASE_URL'
+      DEFAULT_WORKATO_BASE_URL = 'https://app.workato.com'
+      WORKATO_BASE_URL = T.let(ENV.fetch(WORKATO_BASE_URL_ENV, DEFAULT_WORKATO_BASE_URL), String)
+    end
+  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'

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

@@ -12,15 +12,25 @@ module Workato
       module Dsl
         module AWS
           TEMP_CREDENTIALS_REFRESH_TIMEOUT = 60 # seconds
+          private_constant :TEMP_CREDENTIALS_REFRESH_TIMEOUT
 
           DUMMY_AWS_IAM_EXTERNAL_ID = 'dummy-aws-iam-external-id'
+          private_constant :DUMMY_AWS_IAM_EXTERNAL_ID
+
           DUMMY_AWS_WORKATO_ACCOUNT_ID = 'dummy-aws-workato-account-id'
+          private_constant :DUMMY_AWS_WORKATO_ACCOUNT_ID
+
+          AMAZON_ROLE_CLIENT_ID = ENV.fetch('AMAZON_ROLE_CLIENT_ID', nil)
+          private_constant :AMAZON_ROLE_CLIENT_ID
+
+          AMAZON_ROLE_CLIENT_KEY = ENV.fetch('AMAZON_ROLE_CLIENT_KEY', nil)
+          private_constant :AMAZON_ROLE_CLIENT_KEY
 
-          AMAZON_ROLE_CLIENT_ID = ENV['AMAZON_ROLE_CLIENT_ID']
-          AMAZON_ROLE_CLIENT_KEY = ENV['AMAZON_ROLE_CLIENT_KEY']
-          AMAZON_ROLE_CLIENT_SECRET = ENV['AMAZON_ROLE_CLIENT_SECRET']
+          AMAZON_ROLE_CLIENT_SECRET = ENV.fetch('AMAZON_ROLE_CLIENT_SECRET', nil)
+          private_constant :AMAZON_ROLE_CLIENT_SECRET
 
           WWW_FORM_CONTENT_TYPE = 'application/x-www-form-urlencoded; charset=utf-8'
+          private_constant :WWW_FORM_CONTENT_TYPE
 
           def aws
             @aws ||= Private.new(connection: connection)

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

@@ -6,7 +6,7 @@ module Workato
     module Sdk
       module Dsl
         module Call
-          def call(method, *args)
+          ruby2_keywords def call(method, *args)
             method_proc = @_methods[method]
 
             raise UndefinedMethodError, method unless method_proc