workato-connector-sdk 1.0.1 → 1.1.0

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'delegate'
@@ -8,24 +9,25 @@ require 'net/http'
 require 'net/http/digest_auth'
 
 require_relative './block_invocation_refinements'
+require_relative './../../utilities/encoding'
 
 module Workato
   module Connector
     module Sdk
       class Request < SimpleDelegator
+        extend T::Sig
+
         using BlockInvocationRefinements
 
-        def initialize(uri, method: 'GET', settings: {}, connection: nil, action: nil)
+        def initialize(uri, method: 'GET', connection: nil, action: nil)
           super(nil)
           @uri = uri
           @method = method
-          @settings = settings
-          @authorization = connection&.authorization
-          @base_uri = connection&.base_uri(settings)
+          @connection = connection
+          @base_uri = connection&.base_uri(connection&.settings || {})
           @action = action
           @headers = {}
           @case_sensitive_headers = {}
-          @params = {}.with_indifferent_access
           @render_request = ->(payload) { payload }
           @parse_response = ->(payload) { payload }
           @after_response = ->(_response_code, parsed_response, _response_headers) { parsed_response }
@@ -56,7 +58,7 @@ module Workato
               detect_error!(response.body)
               parsed_response = @parse_response.call(response)
               detect_error!(parsed_response)
-              within_action_context(response.code, parsed_response, response.headers, &@after_response)
+              apply_after_response(response.code, parsed_response, response.headers)
             end
           )
         rescue RestClient::Exception => e
@@ -79,7 +81,12 @@ module Workato
         end
 
         def params(params)
-          @params.merge!(params)
+          if params.is_a?(Hash)
+            @params ||= HashWithIndifferentAccess.new
+            @params.merge!(params)
+          else
+            @params = params
+          end
           self
         end
 
@@ -140,13 +147,17 @@ module Workato
 
         def request_format_json
           @content_type_header = :json
-          @render_request = ->(payload) { ActiveSupport::JSON.encode(payload) if payload }
+          @render_request = lambda_with_error_wrap(JSONRequestFormatError) do |payload|
+            ActiveSupport::JSON.encode(payload) if payload
+          end
           self
         end
 
         def response_format_json
           @accept_header = :json
-          @parse_response = ->(payload) { ActiveSupport::JSON.decode(payload.presence || '{}') }
+          @parse_response = lambda_with_error_wrap(JSONResponseFormatError) do |payload|
+            ActiveSupport::JSON.decode(payload.presence || '{}')
+          end
           self
         end
 
@@ -156,17 +167,19 @@ module Workato
 
         def request_format_xml(root_element_name, namespaces = {})
           @content_type_header = :xml
-          @render_request = Kernel.lambda { |payload|
+          @render_request = lambda_with_error_wrap(XMLRequestFormatError) do |payload|
             next unless payload
 
             Gyoku.xml({ root_element_name => payload.merge(namespaces).deep_symbolize_keys }, key_converter: :none)
-          }
+          end
           self
         end
 
         def response_format_xml(strip_response_namespaces: false)
           @accept_header = :xml
-          @parse_response = ->(payload) { Xml.parse_xml_to_hash(payload, strip_namespaces: strip_response_namespaces) }
+          @parse_response = lambda_with_error_wrap(XMLResponseFormatError) do |payload|
+            Xml.parse_xml_to_hash(payload, strip_namespaces: strip_response_namespaces)
+          end
           self
         end
 
@@ -177,7 +190,7 @@ module Workato
         end
 
         def response_format_raw
-          @parse_response = Kernel.lambda do |payload|
+          @parse_response = lambda_with_error_wrap(RAWResponseFormatError) do |payload|
             payload.body.force_encoding(::Encoding::BINARY)
             payload.body.valid_encoding? ? payload.body : payload.body.force_encoding(::Encoding::BINARY)
           end
@@ -187,7 +200,7 @@ module Workato
         def request_format_multipart_form
           @content_type_header = nil
 
-          @render_request = Kernel.lambda do |payload|
+          @render_request = lambda_with_error_wrap(MultipartFormRequestFormatError) do |payload|
             payload&.each_with_object({}) do |(name, (value, content_type, original_filename)), rendered|
               rendered[name] = if content_type.present?
                                  Part.new(name, content_type, original_filename || ::File.basename(name), value.to_s)
@@ -202,7 +215,7 @@ module Workato
 
         def request_format_www_form_urlencoded
           @content_type_header = 'application/x-www-form-urlencoded'
-          @render_request = Kernel.lambda { |payload| payload.to_param }
+          @render_request = lambda_with_error_wrap(WWWFormURLEncodedRequestFormatError, &:to_param)
           self
         end
 
@@ -226,6 +239,8 @@ module Workato
             OpenSSL::X509::Certificate.new(intermediate)
           end
           self
+        rescue OpenSSL::OpenSSLError => e
+          Kernel.raise(RequestTLSCertificateFormatError, e)
         end
 
         def tls_server_certs(certificates:, strict: true)
@@ -235,6 +250,16 @@ module Workato
             @ssl_cert_store.add_cert(OpenSSL::X509::Certificate.new(certificate))
           end
           self
+        rescue OpenSSL::OpenSSLError => e
+          Kernel.raise(RequestTLSCertificateFormatError, e)
+        end
+
+        def puts(*args)
+          ::Kernel.puts(*args)
+        end
+
+        def try(*args, &block)
+          execute!.try(*args, &block)
         end
 
         private
@@ -289,14 +314,14 @@ module Workato
                   URI.parse(@uri)
                 end
 
-          return uri.to_s unless @params.any? || @user || @password
+          return uri.to_s unless @params || @user || @password
 
           unless @digest_auth
             uri.user = URI.encode_www_form_component(@user) if @user
             uri.password = URI.encode_www_form_component(@password) if @password
           end
 
-          return uri.to_s unless @params.any?
+          return uri.to_s unless @params
 
           query = uri.query.to_s.split('&').select(&:present?).join('&').presence
           params = @params.to_param.presence
@@ -321,9 +346,9 @@ module Workato
         end
 
         def detect_error!(response)
-          return unless @authorization
+          return unless authorized?
 
-          error_patterns = @authorization.detect_on
+          error_patterns = connection.authorization.detect_on
           return unless error_patterns.any? { |pattern| pattern === response rescue false }
 
           Kernel.raise(CustomRequestError, response.to_s)
@@ -354,39 +379,76 @@ module Workato
           )
         end
 
+        def apply_after_response(code, parsed_response, headers)
+          encoded_headers = (headers || {}).each_with_object(HashWithIndifferentAccess.new) do |(k, v), h|
+            h[k] = Workato::Utilities::Encoding.force_best_encoding!(v.to_s)
+          end
+          within_action_context(code, parsed_response, encoded_headers, &@after_response)
+        end
+
         def within_action_context(*args, &block)
           (@action || self).instance_exec(*args, &block)
         end
 
+        sig { returns(T::Boolean) }
+        def authorized?
+          !!@connection&.authorization?
+        end
+
         def authorized
-          return yield unless @authorization
+          return yield unless authorized?
 
-          apply = @authorization.source[:apply] || @authorization.source[:credentials]
+          apply = connection.authorization.source[:apply] || connection.authorization.source[:credentials]
           return yield unless apply
 
           first = true
           begin
-            settings = @settings.with_indifferent_access
-            if /oauth2/i =~ @authorization.type
+            settings = connection.settings
+            if /oauth2/i =~ connection.authorization.type
               instance_exec(settings, settings[:access_token], @auth_type, &apply)
             else
               instance_exec(settings, @auth_type, &apply)
             end
             yield
-          rescue StandardError => e
+          rescue RestClient::Exception, CustomRequestError => e
             Kernel.raise e unless first
-            Kernel.raise e unless @action&.refresh_authorization!(
-              e.try(:http_code),
-              e.try(:http_body),
-              e.message,
-              @settings
-            )
+            Kernel.raise e unless refresh_authorization!(e.try(:http_code), e.try(:http_body), e.message)
 
             first = false
             retry
           end
         end
 
+        sig do
+          params(
+            http_code: T.nilable(Integer),
+            http_body: T.nilable(String),
+            exception: T.nilable(String)
+          ).returns(T::Boolean)
+        end
+        def refresh_authorization!(http_code, http_body, exception)
+          return false unless connection.authorization.refresh?(http_code, http_body, exception)
+
+          connection.update_settings!("Refresh token triggered on response \"#{exception}\"") do
+            connection.authorization.refresh!(connection.settings)
+          end
+        end
+
+        sig { returns(Connection) }
+        def connection
+          T.must(@connection)
+        end
+
+        def lambda_with_error_wrap(error_type, &block)
+          Kernel.lambda do |payload|
+            begin
+              block.call(payload)
+            rescue StandardError => e
+              Kernel.raise error_type.new(e)
+            end
+          end
+        end
+
         class Part < StringIO
           def initialize(path, content_type, original_filename, *args)
             super(*args)
@@ -395,7 +457,9 @@ module Workato
             @original_filename = original_filename
           end
 
-          attr_reader :path, :content_type, :original_filename
+          attr_reader :path
+          attr_reader :content_type
+          attr_reader :original_filename
         end
       end
     end

data/lib/workato/connector/sdk/schema/field/array.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative './convertors'

data/lib/workato/connector/sdk/schema/field/convertors.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Workato

data/lib/workato/connector/sdk/schema/field/date.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative './convertors'

data/lib/workato/connector/sdk/schema/field/date_time.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative './convertors'

data/lib/workato/connector/sdk/schema/field/integer.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative './convertors'

data/lib/workato/connector/sdk/schema/field/number.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative './convertors'

data/lib/workato/connector/sdk/schema/field/object.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative './convertors'

data/lib/workato/connector/sdk/schema/field/string.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative './convertors'

data/lib/workato/connector/sdk/schema/type/time.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'time'

data/lib/workato/connector/sdk/schema/type/unicode_string.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Workato

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Workato

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'active_support/encrypted_configuration'
@@ -5,6 +6,10 @@ require 'active_support/encrypted_configuration'
 module Workato
   module Connector
     module Sdk
+      module SorbetTypes
+        SettingsHash = T.type_alias { T.any(HashWithIndifferentAccess, T::Hash[T.any(Symbol, String), T.untyped]) }
+      end
+
       class Settings
         class << self
           def from_file(path = DEFAULT_SETTINGS_PATH, name = nil)
@@ -68,10 +73,10 @@ module Workato
 
         private
 
-        attr_reader :key_path,
-                    :name,
-                    :path,
-                    :encrypted
+        attr_reader :key_path
+        attr_reader :name
+        attr_reader :path
+        attr_reader :encrypted
 
         def read_plain_file
           all_settings = File.open(path) do |f|

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

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Workato
@@ -29,8 +30,8 @@ module Workato
 
         private
 
-        attr_reader :data,
-                    :paths
+        attr_reader :data
+        attr_reader :paths
 
         def above_summarization_limit?(candidate)
           candidate.is_a?(::Array) && candidate.length > ARRAY_SUMMARIZATION_LIMIT ||

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

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 require 'securerandom'
@@ -5,19 +6,55 @@ require 'securerandom'
 module Workato
   module Connector
     module Sdk
+      module SorbetTypes
+        WebhookSubscribeOutputHash = T.type_alias { T::Hash[T.any(String, Symbol), T.untyped] }
+
+        WebhookNotificationPayload = T.type_alias { T.untyped }
+
+        TriggerEventHash = T.type_alias { T::Hash[T.untyped, T.untyped] }
+
+        WebhookNotificationOutputHash = T.type_alias { T.any(T::Array[TriggerEventHash], TriggerEventHash) }
+
+        PollOutputHash = T.type_alias do
+          {
+            'events' => T::Array[TriggerEventHash],
+            'can_poll_more' => T.nilable(T::Boolean),
+            'next_poll' => T.untyped
+          }
+        end
+      end
+
       class Trigger < Operation
         using BlockInvocationRefinements
 
-        def initialize(trigger:, connection: {}, methods: {}, settings: {}, object_definitions: nil)
+        sig do
+          params(
+            trigger: SorbetTypes::SourceHash,
+            methods: SorbetTypes::SourceHash,
+            connection: Connection,
+            object_definitions: T.nilable(ObjectDefinitions)
+          ).void
+        end
+        def initialize(trigger:, methods: {}, connection: Connection.new, object_definitions: nil)
           super(
             operation: trigger,
             connection: connection,
             methods: methods,
-            settings: settings,
             object_definitions: object_definitions
           )
         end
 
+        sig do
+          params(
+            settings: T.nilable(SorbetTypes::SettingsHash),
+            input: SorbetTypes::OperationInputHash,
+            closure: T.untyped,
+            extended_input_schema: SorbetTypes::OperationSchema,
+            extended_output_schema: SorbetTypes::OperationSchema
+          ).returns(
+            SorbetTypes::PollOutputHash
+          )
+        end
         def poll_page(settings = nil, input = {}, closure = nil, extended_input_schema = [],
                       extended_output_schema = [])
           poll_proc = trigger[:poll]
@@ -29,13 +66,27 @@ module Workato
           ) do |connection, payload, eis, eos|
             instance_exec(connection, payload[:input], payload[:closure], eis, eos, &poll_proc)
           end
-          output[:events] = ::Array.wrap(output[:events]).reverse!.uniq(&trigger[:dedup])
+          output.with_indifferent_access
+          output[:events] = Array.wrap(output[:events])
+                                 .reverse!
+                                 .map! { |event| ::Hash.try_convert(event) || event }
           output[:next_poll] = output[:next_poll].presence || closure
           output
         end
 
+        sig do
+          params(
+            settings: T.nilable(SorbetTypes::SettingsHash),
+            input: SorbetTypes::OperationInputHash,
+            closure: T.untyped,
+            extended_input_schema: SorbetTypes::OperationSchema,
+            extended_output_schema: SorbetTypes::OperationSchema
+          ).returns(
+            SorbetTypes::PollOutputHash
+          )
+        end
         def poll(settings = nil, input = {}, closure = nil, extended_input_schema = [], extended_output_schema = [])
-          events = []
+          events = T.let([], T::Array[SorbetTypes::TriggerEventHash])
 
           loop do
             output = poll_page(settings, input, closure, extended_input_schema, extended_output_schema)
@@ -46,16 +97,31 @@ module Workato
           end
 
           {
-            events: events.uniq(&trigger[:dedup]),
+            events: events,
             can_poll_more: false,
             next_poll: closure
           }.with_indifferent_access
         end
 
+        sig { params(input: SorbetTypes::TriggerEventHash).returns(T.untyped) }
         def dedup(input = {})
           trigger[:dedup].call(input)
         end
 
+        sig do
+          params(
+            input: SorbetTypes::OperationInputHash,
+            payload: SorbetTypes::WebhookNotificationPayload,
+            extended_input_schema: SorbetTypes::OperationSchema,
+            extended_output_schema: SorbetTypes::OperationSchema,
+            headers: T::Hash[T.any(String, Symbol), T.untyped],
+            params: T::Hash[T.any(String, Symbol), T.untyped],
+            settings: T.nilable(SorbetTypes::SettingsHash),
+            webhook_subscribe_output: SorbetTypes::WebhookSubscribeOutputHash
+          ).returns(
+            SorbetTypes::WebhookNotificationOutputHash
+          )
+        end
         def webhook_notification(
           input = {},
           payload = {},
@@ -66,19 +132,36 @@ module Workato
           settings = nil,
           webhook_subscribe_output = {}
         )
-          Dsl::WithDsl.execute(
+          connection.merge_settings!(settings) if settings
+          output = Dsl::WithDsl.execute(
+            connection,
             input.with_indifferent_access,
-            payload.with_indifferent_access,
-            extended_input_schema.map(&:with_indifferent_access),
-            extended_output_schema.map(&:with_indifferent_access),
+            payload,
+            Array.wrap(extended_input_schema).map(&:with_indifferent_access),
+            Array.wrap(extended_output_schema).map(&:with_indifferent_access),
             headers.with_indifferent_access,
             params.with_indifferent_access,
-            (settings || @settings).with_indifferent_access,
+            connection.settings,
             webhook_subscribe_output.with_indifferent_access,
             &trigger[:webhook_notification]
           )
+          if output.is_a?(::Array)
+            output.map! { |event| ::Hash.try_convert(event) || event }
+          else
+            ::Hash.try_convert(output) || output
+          end
         end
 
+        sig do
+          params(
+            webhook_url: String,
+            settings: T.nilable(SorbetTypes::SettingsHash),
+            input: SorbetTypes::OperationInputHash,
+            recipe_id: String
+          ).returns(
+            SorbetTypes::WebhookSubscribeOutputHash
+          )
+        end
         def webhook_subscribe(webhook_url = '', settings = nil, input = {}, recipe_id = SecureRandom.uuid)
           webhook_subscribe_proc = trigger[:webhook_subscribe]
           execute(settings, { input: input, webhook_url: webhook_url, recipe_id: recipe_id }) do |connection, payload|
@@ -92,6 +175,7 @@ module Workato
           end
         end
 
+        sig { params(webhook_subscribe_output: SorbetTypes::WebhookSubscribeOutputHash).returns(T.untyped) }
         def webhook_unsubscribe(webhook_subscribe_output = {})
           webhook_unsubscribe_proc = trigger[:webhook_unsubscribe]
           execute(nil, webhook_subscribe_output) do |_connection, input|
@@ -99,6 +183,17 @@ module Workato
           end
         end
 
+        sig do
+          params(
+            input: SorbetTypes::OperationInputHash,
+            payload: T::Hash[T.any(String, Symbol), T.untyped],
+            headers: T::Hash[T.any(String, Symbol), T.untyped],
+            params: T::Hash[T.any(String, Symbol), T.untyped],
+            webhook_subscribe_output: SorbetTypes::WebhookSubscribeOutputHash
+          ).returns(
+            T.any(SorbetTypes::WebhookNotificationOutputHash, SorbetTypes::PollOutputHash)
+          )
+        end
         def invoke(input = {}, payload = {}, headers = {}, params = {}, webhook_subscribe_output = {})
           extended_schema = extended_schema(nil, input)
           config_schema = Schema.new(schema: config_fields_schema)
@@ -132,6 +227,7 @@ module Workato
 
         alias trigger operation
 
+        sig { returns(T::Boolean) }
         def webhook_notification?
           trigger[:webhook_notification].present?
         end

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

@@ -1,9 +1,10 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Workato
   module Connector
     module Sdk
-      VERSION = '1.0.1'
+      VERSION = '1.1.0'
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'json'

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

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'nokogiri'

data/lib/workato/connector/sdk.rb

@@ -1,5 +1,9 @@
+# typed: strict
 # frozen_string_literal: true
 
+require 'sorbet-runtime'
+::Method.prepend(T::CompatibilityPatches::MethodExtensions)
+
 module Workato
   module Connector
     module Sdk
@@ -22,6 +26,10 @@ module Workato
 
       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

data/lib/workato/extension/array.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Workato

data/lib/workato/extension/case_sensitive_headers.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'rest-client'

data/lib/workato/extension/currency.rb

@@ -1,10 +1,11 @@
+# typed: false
 # frozen_string_literal: true
 
 module Workato
   module Extension
     module Currency
       def to_currency(options = {})
-        ActiveSupport::NumberHelper::NumberToCurrencyConverter(self, options)
+        ActiveSupport::NumberHelper::NumberToCurrencyConverter.convert(self, options)
       end
     end
   end

data/lib/workato/extension/date.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Workato

data/lib/workato/extension/enumerable.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Enumerable