workato-connector-sdk 1.0.3 → 1.2.0

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

@@ -3,6 +3,8 @@
 
 require 'active_support/encrypted_configuration'
 
+using Workato::Extension::HashWithIndifferentAccess
+
 module Workato
   module Connector
     module Sdk
@@ -98,13 +100,13 @@ module Workato
         end
 
         def read_encrypted_file
-          all_settings = encrypted_configuration.config.with_indifferent_access
+          all_settings = HashWithIndifferentAccess.wrap(encrypted_configuration.config)
 
           (name ? all_settings.fetch(name) : all_settings) || {}
         end
 
         def update_encrypted_file(new_settings)
-          all_settings = encrypted_configuration.config.with_indifferent_access
+          all_settings = HashWithIndifferentAccess.wrap(encrypted_configuration.config)
 
           merge_settings(all_settings, new_settings)
 

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

@@ -3,11 +3,27 @@
 
 require 'securerandom'
 
+using Workato::Extension::HashWithIndifferentAccess
+
 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
@@ -38,7 +54,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 +68,9 @@ 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[: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 +83,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 +98,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 +112,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 +120,7 @@ module Workato
             settings: T.nilable(SorbetTypes::SettingsHash),
             webhook_subscribe_output: SorbetTypes::WebhookSubscribeOutputHash
           ).returns(
-            HashWithIndifferentAccess
+            SorbetTypes::WebhookNotificationOutputHash
           )
         end
         def webhook_notification(
@@ -116,18 +134,23 @@ 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,
-            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,
+            HashWithIndifferentAccess.wrap(input),
+            payload,
+            Array.wrap(extended_input_schema).map { |i| HashWithIndifferentAccess.wrap(i) },
+            Array.wrap(extended_output_schema).map { |i| HashWithIndifferentAccess.wrap(i) },
+            HashWithIndifferentAccess.wrap(headers),
+            HashWithIndifferentAccess.wrap(params),
             connection.settings,
-            webhook_subscribe_output.with_indifferent_access,
+            HashWithIndifferentAccess.wrap(webhook_subscribe_output),
             &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
@@ -140,7 +163,7 @@ module Workato
             SorbetTypes::WebhookSubscribeOutputHash
           )
         end
-        def webhook_subscribe(webhook_url = '', settings = nil, input = {}, recipe_id = SecureRandom.uuid)
+        def webhook_subscribe(webhook_url = '', settings = nil, input = {}, recipe_id = recipe_id!)
           webhook_subscribe_proc = trigger[:webhook_subscribe]
           execute(settings, { input: input, webhook_url: webhook_url, recipe_id: recipe_id }) do |connection, payload|
             instance_exec(
@@ -169,7 +192,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.2.0'
     end
   end
 end

data/lib/workato/connector/sdk.rb

@@ -39,11 +39,13 @@ require 'active_support/all'
 require 'active_support/json'
 require_relative '../extension/array'
 require_relative '../extension/case_sensitive_headers'
+require_relative '../extension/content_encoding_decoder'
 require_relative '../extension/currency'
 require_relative '../extension/date'
 require_relative '../extension/enumerable'
 require_relative '../extension/extra_chain_cert'
 require_relative '../extension/hash'
+require_relative '../extension/hash_with_indifferent_access'
 require_relative '../extension/integer'
 require_relative '../extension/nil_class'
 require_relative '../extension/object'
@@ -52,12 +54,12 @@ require_relative '../extension/string'
 require_relative '../extension/symbol'
 require_relative '../extension/time'
 
+require_relative './sdk/errors'
 require_relative './sdk/account_properties'
 require_relative './sdk/action'
 require_relative './sdk/connection'
 require_relative './sdk/connector'
 require_relative './sdk/dsl'
-require_relative './sdk/errors'
 require_relative './sdk/lookup_tables'
 require_relative './sdk/object_definitions'
 require_relative './sdk/operation'
@@ -67,4 +69,3 @@ require_relative './sdk/summarize'
 require_relative './sdk/trigger'
 require_relative './sdk/version'
 require_relative './sdk/workato_schemas'
-require_relative './sdk/xml'

data/lib/workato/extension/case_sensitive_headers.rb

@@ -22,31 +22,6 @@ module Workato
 
       ::Net::HTTPHeader.prepend Net::HTTPHeader
       ::Net::HTTPGenericRequest.prepend Net::HTTPHeader
-
-      module RestClient
-        module Request
-          attr_accessor :case_sensitive_headers
-
-          def processed_headers
-            return @processed_headers if case_sensitive_headers.blank?
-            return case_sensitive_headers if @processed_headers.blank?
-
-            @processed_headers.merge(case_sensitive_headers)
-          end
-
-          def execute(&block)
-            # With 2.0.0+, net/http accepts URI objects in requests and handles wrapping
-            # IPv6 addresses in [] for use in the Host request header.
-            net_http_request = net_http_request_class(method).new(uri, processed_headers)
-            net_http_request.case_sensitive_headers = case_sensitive_headers
-            transmit(uri, net_http_request, payload, &block)
-          ensure
-            payload&.close
-          end
-        end
-      end
-
-      ::RestClient::Request.prepend RestClient::Request
     end
   end
 end

data/lib/workato/extension/content_encoding_decoder.rb

@@ -0,0 +1,67 @@
+# typed: false
+# frozen_string_literal: true
+
+module Workato
+  module Extension
+    module ContentEncodingDecoder
+      module RestClient
+        module Response
+          def create(body, net_http_res, request, start_time)
+            body = decode_content_encoding(net_http_res, body)
+            super(body, net_http_res, request, start_time)
+          end
+
+          private
+
+          def decode_content_encoding(response, body)
+            content_encoding = response['content-encoding']
+
+            case content_encoding&.downcase
+            when 'deflate', 'gzip', 'x-gzip'
+              response.delete 'content-encoding'
+              return body if body.blank?
+
+              deflate_string(body).force_encoding(Encoding.default_external)
+            when 'none', 'identity'
+              response.delete 'content-encoding'
+              body
+            else
+              body
+            end
+          end
+
+          def deflate_string(body)
+            # Decodes all deflate, gzip or x-gzip
+            zstream = Zlib::Inflate.new(Zlib::MAX_WBITS + 32)
+
+            zstream.inflate(body) + zstream.finish
+          rescue Zlib::DataError
+            # No luck with Zlib decompression. Let's try with raw deflate,
+            # like some broken web servers do. This part isn't compatible with Net::HTTP content-decoding
+            zstream.close
+
+            zstream = Zlib::Inflate.new(-Zlib::MAX_WBITS)
+            zstream.inflate(body) + zstream.finish
+          ensure
+            zstream.close
+          end
+        end
+      end
+
+      ::RestClient::Response.singleton_class.prepend(RestClient::Response)
+
+      ::RestClient::Request.prepend(
+        Module.new do
+          def default_headers
+            # Should pass this header to be compatible with rest-client 2.0.2 version
+            # and rely on decode_content_encoding patch
+            # since net/http does not decompress response body if Content-Range is specified
+            # (see https://github.com/ruby/ruby/blob/27f6ad737b13062339df0a0c80449cf0dbc92ba5/lib/net/http/response.rb#L254)
+            # while the previous version of rest-client does.
+            super.tap { |headers| headers[:accept_encoding] = 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3' }
+          end
+        end
+      )
+    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/extra_chain_cert.rb

@@ -22,20 +22,6 @@ module Workato
       end
 
       ::Net::HTTP.include Net::HTTP
-
-      module RestClient
-        module Request
-          attr_accessor :extra_chain_cert
-
-          def net_http_object(hostname, port)
-            net = super(hostname, port)
-            net.extra_chain_cert = extra_chain_cert if extra_chain_cert
-            net
-          end
-        end
-      end
-
-      ::RestClient::Request.prepend RestClient::Request
     end
   end
 end

data/lib/workato/extension/hash_with_indifferent_access.rb

@@ -0,0 +1,19 @@
+# typed: false
+# frozen_string_literal: true
+
+require 'active_support/hash_with_indifferent_access'
+
+module Workato
+  module Extension
+    module HashWithIndifferentAccess
+      refine ::ActiveSupport::HashWithIndifferentAccess.singleton_class do
+        def wrap(value)
+          return ::ActiveSupport::HashWithIndifferentAccess.new unless value
+          return value if value.is_a?(ActiveSupport::HashWithIndifferentAccess)
+
+          value.with_indifferent_access
+        end
+      end
+    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,9 @@
 # typed: false
 # frozen_string_literal: true
 
+require 'rails-html-sanitizer'
+require 'workato/utilities/xml'
+
 module Workato
   module Extension
     module String
@@ -36,7 +39,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)
@@ -165,7 +169,7 @@ module Workato
       end
 
       def from_xml
-        Connector::Sdk::Xml.parse_xml_to_hash self
+        Workato::Utilities::Xml.parse_xml_to_hash(self)
       end
 
       TO_COUNTRY_METHODS.each do |suffix|

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

data/lib/workato/{connector/sdk → utilities}/xml.rb

@@ -4,10 +4,10 @@
 require 'nokogiri'
 
 module Workato
-  module Connector
-    module Sdk
-      module Xml
-        def self.parse_xml_to_hash(payload, strip_namespaces: false)
+  module Utilities
+    module Xml
+      class << self
+        def parse_xml_to_hash(payload, strip_namespaces: false)
           parse_options = Nokogiri::XML::ParseOptions.new.nonet
           lazy_reader = Nokogiri::XML::Reader(payload, nil, nil, parse_options).to_enum.lazy
           lazy_reader.each_with_object([{}]) do |node, ancestors|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workato-connector-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Pavel Abolmasov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2022-11-07 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,20 +206,34 @@ 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
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -434,6 +448,7 @@ files:
 - lib/workato/cli/generators/connector_generator.rb
 - lib/workato/cli/generators/master_key_generator.rb
 - lib/workato/cli/main.rb
+- lib/workato/cli/multi_auth_selected_fallback.rb
 - lib/workato/cli/oauth2_command.rb
 - lib/workato/cli/push_command.rb
 - lib/workato/cli/schema_command.rb
@@ -447,7 +462,9 @@ files:
 - lib/workato/connector/sdk/dsl/account_property.rb
 - lib/workato/connector/sdk/dsl/aws.rb
 - lib/workato/connector/sdk/dsl/call.rb
+- lib/workato/connector/sdk/dsl/csv.rb
 - lib/workato/connector/sdk/dsl/error.rb
+- lib/workato/connector/sdk/dsl/execution_context.rb
 - lib/workato/connector/sdk/dsl/http.rb
 - lib/workato/connector/sdk/dsl/lookup_table.rb
 - lib/workato/connector/sdk/dsl/time.rb
@@ -474,14 +491,15 @@ files:
 - lib/workato/connector/sdk/trigger.rb
 - lib/workato/connector/sdk/version.rb
 - lib/workato/connector/sdk/workato_schemas.rb
-- lib/workato/connector/sdk/xml.rb
 - lib/workato/extension/array.rb
 - lib/workato/extension/case_sensitive_headers.rb
+- lib/workato/extension/content_encoding_decoder.rb
 - lib/workato/extension/currency.rb
 - lib/workato/extension/date.rb
 - lib/workato/extension/enumerable.rb
 - lib/workato/extension/extra_chain_cert.rb
 - lib/workato/extension/hash.rb
+- lib/workato/extension/hash_with_indifferent_access.rb
 - lib/workato/extension/integer.rb
 - lib/workato/extension/nil_class.rb
 - lib/workato/extension/object.rb
@@ -491,6 +509,8 @@ 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/utilities/xml.rb
 - lib/workato/web/app.rb
 - templates/.rspec.erb
 - templates/Gemfile.erb
@@ -510,7 +530,13 @@ metadata:
   documentation_uri: https://docs.workato.com/developing-connectors/sdk/cli.html
   homepage_uri: https://www.workato.com/
   source_code_uri: https://github.com/workato/workato-connector-sdk
-post_install_message:
+post_install_message: |2+
+
+  If you updated from workato-connector-sdk prior 1.2.0 your tests could be broken.
+
+  For more details see here:
+  https://github.com/workato/workato-connector-sdk/releases/tag/v1.2.0
+
 rdoc_options: []
 require_paths:
 - lib
@@ -525,9 +551,9 @@ 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
 test_files: []
+...