workato-connector-sdk 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4348a5f43c1aca0d39967b9b90c04b17d158a74c
-  data.tar.gz: befa5442c5eca5641824e0e426cbec67c6a2dc77
+SHA256:
+  metadata.gz: 053e48199f2b1406ef47a84fb43d7b7d0cc74d74ce0f1f1b650c01fc422bc683
+  data.tar.gz: e2155ca61c45230234b105ff0f4ab033205c86b49b35838d88e8a8e473a957b3
 SHA512:
-  metadata.gz: d74275e1a04b3a90059971dc048256ef3f720bbf09db590678353cc920e133ec4627a7870c5832663f1f793e9b8e47d2cfa19f3cdab81bd7c5abf2f0021c5db3
-  data.tar.gz: ebbf0c161b5fcb932db95dac377408ab01b237bc1541a27e2e19c2b2cf9e2dbea60934a2cd1b37ebd56955c1d531e91656342d14904dbcdf66109fe99f7fe14f
+  metadata.gz: 4d34393bda1fc5eef5e138c7e742a2a05a7c1ced8fb5a4a8969a1770473c4534cf015c7096cf17a18eb69c669301ca8761ff51a88b3ee8a04ad4550467a23588
+  data.tar.gz: b293f65e21f45ef2bab573d687cd12cd77981a7375bec619ce45561ead9e96f895f633e65910dad7226213daacb38b95453c890b96e7b7a957b5085e5055ff94

data/lib/workato/cli/exec_command.rb

@@ -89,7 +89,10 @@ module Workato
             $stdout.pause if verbose?
             say('')
             say(message)
+
             new_settings = refresher.call
+            break unless new_settings
+
             loop do
               answer = ask('Updated settings file with new connection attributes? (Yes or No)').to_s.downcase
               break new_settings if %w[n no].include?(answer)

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

@@ -202,6 +202,8 @@ module Workato
             ).returns(T::Boolean)
           end
           def refresh?(http_code, http_body, exception)
+            return false unless /oauth2/i =~ type || source[:acquire].present?
+
             refresh_on = self.refresh_on
             refresh_on.blank? || refresh_on.any? do |pattern|
               pattern.is_a?(::Integer) && pattern == http_code ||

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

@@ -7,9 +7,12 @@ module Workato
       module Dsl
         module Call
           def call(method, *args)
-            raise InvalidDefinitionError, "method '#{method}' does not exists" unless @_methods[method]
+            method_proc = @_methods[method]
 
-            instance_exec(*args, &@_methods[method])
+            raise UndefinedMethodError, method unless method_proc
+            raise UnexpectedMethodDefinitionError.new(method, method_proc) unless method_proc.is_a?(Proc)
+
+            instance_exec(*args, &method_proc)
           end
         end
       end

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

@@ -6,12 +6,51 @@ module Workato
     module Sdk
       InvalidDefinitionError = Class.new(StandardError)
 
-      InvalidSchemaError = Class.new(StandardError)
+      class UnexpectedMethodDefinitionError < InvalidDefinitionError
+        attr_reader :name
+        attr_reader :definition
+
+        def initialize(name, definition)
+          super("Expected lambda for method '#{name}' definition, got: #{definition.class.name}")
+          @name = name
+          @definition = definition
+        end
+      end
+
+      class UndefinedMethodError < InvalidDefinitionError
+        attr_reader :name
+
+        def initialize(name)
+          super("Method '#{name}' does not exists")
+          @name = name
+        end
+      end
+
+      InvalidSchemaError = Class.new(InvalidDefinitionError)
 
       CustomRequestError = Class.new(StandardError)
 
       RuntimeError = Class.new(StandardError)
 
+      class UnresolvedObjectDefinitionError < StandardError
+        attr_reader :name
+
+        def initialize(name)
+          super("Cannot find object definition for '#{name}'")
+          @name = name
+        end
+      end
+
+      class CircleReferenceObjectDefinitionError < StandardError
+        attr_reader :name
+
+        def initialize(name, backtrace = [])
+          super("Infinite recursion occurred in object definition for '#{name}'")
+          set_backtrace(backtrace)
+          @name = name
+        end
+      end
+
       class RequestError < StandardError
         attr_reader :method
         attr_reader :code
@@ -41,6 +80,24 @@ module Workato
           super(message)
         end
       end
+
+      RequestTLSCertificateFormatError = Class.new(StandardError)
+
+      RequestPayloadFormatError = Class.new(StandardError)
+
+      JSONRequestFormatError = Class.new(RequestPayloadFormatError)
+
+      JSONResponseFormatError = Class.new(RequestPayloadFormatError)
+
+      XMLRequestFormatError = Class.new(RequestPayloadFormatError)
+
+      XMLResponseFormatError = Class.new(RequestPayloadFormatError)
+
+      WWWFormURLEncodedRequestFormatError = Class.new(RequestPayloadFormatError)
+
+      MultipartFormRequestFormatError = Class.new(RequestPayloadFormatError)
+
+      RAWResponseFormatError = Class.new(RequestPayloadFormatError)
     end
   end
 end

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

@@ -18,16 +18,22 @@ module Workato
 
         def lazy(settings = nil, config_fields = {})
           DupHashWithIndifferentAccess.new do |object_definitions, name|
-            fields_proc = object_definitions_source[name][:fields]
-            object_definitions[name] = Action.new(
-              action: {
-                execute: lambda do |connection, input|
-                  instance_exec(connection, input, object_definitions, &fields_proc)
-                end
-              },
-              methods: methods_source,
-              connection: connection
-            ).execute(settings, config_fields)
+            fields_proc = object_definitions_source.dig(name, :fields)
+            raise Workato::Connector::Sdk::UnresolvedObjectDefinitionError, name unless fields_proc
+
+            begin
+              object_definitions[name] = Action.new(
+                action: {
+                  execute: lambda do |connection, input|
+                    instance_exec(connection, input, object_definitions, &fields_proc)
+                  end
+                },
+                methods: methods_source,
+                connection: connection
+              ).execute(settings, config_fields)
+            rescue SystemStackError => e
+              raise Workato::Connector::Sdk::CircleReferenceObjectDefinitionError.new(name, e.backtrace)
+            end
           end
         end
 

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

@@ -9,6 +9,7 @@ require 'net/http'
 require 'net/http/digest_auth'
 
 require_relative './block_invocation_refinements'
+require_relative './../../utilities/encoding'
 
 module Workato
   module Connector
@@ -27,7 +28,6 @@ module Workato
           @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 }
@@ -58,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
@@ -81,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
 
@@ -142,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
 
@@ -158,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
 
@@ -179,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
@@ -189,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)
@@ -204,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
 
@@ -228,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)
@@ -237,12 +250,18 @@ 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
 
         attr_reader :method
@@ -295,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
@@ -360,6 +379,13 @@ 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
@@ -384,7 +410,7 @@ module Workato
               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 refresh_authorization!(e.try(:http_code), e.try(:http_body), e.message)
 
@@ -413,6 +439,16 @@ module Workato
           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)

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

@@ -8,6 +8,20 @@ module Workato
     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
@@ -38,7 +52,7 @@ module Workato
             extended_input_schema: SorbetTypes::OperationSchema,
             extended_output_schema: SorbetTypes::OperationSchema
           ).returns(
-            HashWithIndifferentAccess
+            SorbetTypes::PollOutputHash
           )
         end
         def poll_page(settings = nil, input = {}, closure = nil, extended_input_schema = [],
@@ -52,7 +66,10 @@ 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
@@ -65,11 +82,11 @@ module Workato
             extended_input_schema: SorbetTypes::OperationSchema,
             extended_output_schema: SorbetTypes::OperationSchema
           ).returns(
-            HashWithIndifferentAccess
+            SorbetTypes::PollOutputHash
           )
         end
         def poll(settings = nil, input = {}, closure = nil, extended_input_schema = [], extended_output_schema = [])
-          events = T.let([], T::Array[T::Hash[T.any(String, Symbol), T.untyped]])
+          events = T.let([], T::Array[SorbetTypes::TriggerEventHash])
 
           loop do
             output = poll_page(settings, input, closure, extended_input_schema, extended_output_schema)
@@ -80,13 +97,13 @@ 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::OperationInputHash).returns(T.untyped) }
+        sig { params(input: SorbetTypes::TriggerEventHash).returns(T.untyped) }
         def dedup(input = {})
           trigger[:dedup].call(input)
         end
@@ -94,7 +111,7 @@ module Workato
         sig do
           params(
             input: SorbetTypes::OperationInputHash,
-            payload: T::Hash[T.any(String, Symbol), T.untyped],
+            payload: SorbetTypes::WebhookNotificationPayload,
             extended_input_schema: SorbetTypes::OperationSchema,
             extended_output_schema: SorbetTypes::OperationSchema,
             headers: T::Hash[T.any(String, Symbol), T.untyped],
@@ -102,7 +119,7 @@ module Workato
             settings: T.nilable(SorbetTypes::SettingsHash),
             webhook_subscribe_output: SorbetTypes::WebhookSubscribeOutputHash
           ).returns(
-            HashWithIndifferentAccess
+            SorbetTypes::WebhookNotificationOutputHash
           )
         end
         def webhook_notification(
@@ -116,10 +133,10 @@ module Workato
           webhook_subscribe_output = {}
         )
           connection.merge_settings!(settings) if settings
-          Dsl::WithDsl.execute(
+          output = Dsl::WithDsl.execute(
             connection,
             input.with_indifferent_access,
-            payload.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,
@@ -127,7 +144,12 @@ module Workato
             connection.settings,
             webhook_subscribe_output.with_indifferent_access,
             &trigger[:webhook_notification]
-          ).with_indifferent_access
+          )
+          if output.is_a?(::Array)
+            output.map! { |event| ::Hash.try_convert(event) || event }
+          else
+            ::Hash.try_convert(output) || output
+          end
         end
 
         sig do
@@ -169,7 +191,7 @@ module Workato
             params: T::Hash[T.any(String, Symbol), T.untyped],
             webhook_subscribe_output: SorbetTypes::WebhookSubscribeOutputHash
           ).returns(
-            T::Hash[T.any(String, Symbol), T.untyped]
+            T.any(SorbetTypes::WebhookNotificationOutputHash, SorbetTypes::PollOutputHash)
           )
         end
         def invoke(input = {}, payload = {}, headers = {}, params = {}, webhook_subscribe_output = {})

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

@@ -4,7 +4,7 @@
 module Workato
   module Connector
     module Sdk
-      VERSION = '1.0.3'
+      VERSION = '1.1.0'
     end
   end
 end

data/lib/workato/extension/currency.rb

@@ -5,7 +5,7 @@ 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/phone.rb

@@ -5,7 +5,7 @@ module Workato
   module Extension
     module Phone
       def to_phone(options = {})
-        ActiveSupport::NumberHelper::NumberToPhoneConverter(self, options).to_s
+        ActiveSupport::NumberHelper::NumberToPhoneConverter.convert(self, options).to_s
       end
     end
   end

data/lib/workato/extension/string.rb

@@ -1,6 +1,8 @@
 # typed: false
 # frozen_string_literal: true
 
+require 'rails-html-sanitizer'
+
 module Workato
   module Extension
     module String
@@ -36,7 +38,8 @@ module Workato
       end
 
       def strip_tags
-        Loofah::Helpers.strip_tags(self)
+        @html_full_sanitizer ||= Rails::Html::Sanitizer.full_sanitizer.new
+        @html_full_sanitizer.sanitize(self)
       end
 
       def to_time(form = :local, format: nil)

data/lib/workato/utilities/encoding.rb

@@ -0,0 +1,57 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'charlock_holmes'
+
+module Workato
+  module Utilities
+    module Encoding
+      class << self
+        # this function finds first possible encoding that allows to perform correct encoding operations
+        # if no encoding is found it preserves initial and replaces bad symbols with ?
+        def force_best_encoding!(string)
+          original_encoding = string.encoding
+
+          possible_encodings(string).each do |encoding|
+            return string.force_encoding(::Encoding::ASCII_8BIT) if encoding.nil? # for binary
+            next unless string.force_encoding(encoding).valid_encoding?
+
+            begin
+              # try encode to utf
+              string.encode(::Encoding::UTF_8)
+              return string
+            rescue ::Encoding::UndefinedConversionError
+              next
+            end
+          end
+          if original_encoding == ::Encoding::BINARY
+            string.force_encoding(::Encoding::BINARY)
+          else
+            string
+              .encode!(::Encoding::UTF_8, invalid: :replace, undef: :replace, replace: '?')
+              .encode!(original_encoding, invalid: :replace, undef: :replace, replace: '?')
+          end
+        end
+
+        private
+
+        def possible_encodings(string)
+          encoding_candidates = CharlockHolmes::EncodingDetector.detect_all(string).sort! do |a, b|
+            confidence_a, encoding_a = a.values_at(:confidence, :ruby_encoding)
+            confidence_b, encoding_b = b.values_at(:confidence, :ruby_encoding)
+            # If equal and one binary, prefer non-binary.
+            if confidence_a == confidence_b
+              if encoding_a == 'binary'
+                confidence_b += 100
+              elsif encoding_b == 'binary'
+                confidence_a += 100
+              end
+            end
+            confidence_b <=> confidence_a
+          end
+          encoding_candidates.map { |candidate| candidate[:ruby_encoding] }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workato-connector-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Pavel Abolmasov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.2.4
+- !ruby/object:Gem::Dependency
+  name: charlock_holmes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.7
 - !ruby/object:Gem::Dependency
   name: countries
   requirement: !ruby/object:Gem::Requirement
@@ -136,20 +150,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: loofah
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.16.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.16.0
 - !ruby/object:Gem::Dependency
   name: net-http-digest_auth
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rails-html-sanitizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.3
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -491,6 +505,7 @@ files:
 - lib/workato/extension/time.rb
 - lib/workato/testing/vcr_encrypted_cassette_serializer.rb
 - lib/workato/testing/vcr_multipart_body_matcher.rb
+- lib/workato/utilities/encoding.rb
 - lib/workato/web/app.rb
 - templates/.rspec.erb
 - templates/Gemfile.erb
@@ -525,8 +540,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.14.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Gem for running adapter's code outside Workato infrastructure