workato-connector-sdk 1.2.0 → 1.3.1

data/lib/workato/extension/string.rb

@@ -15,9 +15,15 @@ module Workato
           r[k] = v
         end
       end
-      TO_COUNTRY_METHODS = %w[alpha2 alpha3 name number].freeze
-      TO_CURRENCY_METHODS = %w[code name symbol].freeze
-      TO_STATE_METHODS = %w[code name].freeze
+
+      def binary?
+        warn <<~WARNING
+          WARNING: Ambiguous use of `String#binary?' method.
+          For correct behavior of `binary?` method use explicit Workato::Types::UnicodeString for input strings and Workato::Types::Binary for input binaries
+          See: https://www.rubydoc.info/gems/workato-connector-sdk/Workato/Types
+        WARNING
+        encoding == Encoding::ASCII_8BIT
+      end
 
       def is_int? # rubocop:disable Naming/PredicateName
         present? && (self !~ /\D/)
@@ -92,6 +98,10 @@ module Workato
         end.join(' ')
       end
 
+      def +(other)
+        super(other&.to_s)
+      end
+
       def to_hex
         unpack('H*')[0]
       end
@@ -103,7 +113,7 @@ module Workato
       alias encode_hex to_hex
 
       def decode_hex
-        Extension::Binary.new([self].pack('H*'))
+        Types::Binary.new([self].pack('H*'))
       end
 
       def encode_base64
@@ -111,7 +121,7 @@ module Workato
       end
 
       def decode_base64
-        Extension::Binary.new(Base64.decode64(self))
+        Types::Binary.new(Base64.decode64(self))
       end
 
       def encode_urlsafe_base64
@@ -127,27 +137,27 @@ module Workato
       end
 
       def decode_urlsafe_base64
-        Extension::Binary.new(Base64.urlsafe_decode64(self))
+        Types::Binary.new(Base64.urlsafe_decode64(self))
       end
 
       def encode_sha256
-        Extension::Binary.new(::Digest::SHA256.digest(self))
+        Types::Binary.new(::Digest::SHA256.digest(self))
       end
 
       def hmac_sha256(key)
         digest = ::OpenSSL::Digest.new('sha256')
-        Extension::Binary.new(::OpenSSL::HMAC.digest(digest, key, self))
+        Types::Binary.new(::OpenSSL::HMAC.digest(digest, key, self))
       end
 
       def hmac_sha512(key)
         digest = ::OpenSSL::Digest.new('sha512')
-        Extension::Binary.new(::OpenSSL::HMAC.digest(digest, key, self))
+        Types::Binary.new(::OpenSSL::HMAC.digest(digest, key, self))
       end
 
       def rsa_sha256(key)
         digest = ::OpenSSL::Digest.new('sha256')
         private_key = ::OpenSSL::PKey::RSA.new(key)
-        Workato::Extension::Binary.new(private_key.sign(digest, self))
+        Types::Binary.new(private_key.sign(digest, self))
       end
 
       def md5_hexdigest
@@ -155,120 +165,22 @@ module Workato
       end
 
       def sha1
-        Extension::Binary.new(::Digest::SHA1.digest(self))
+        Types::Binary.new(::Digest::SHA1.digest(self))
       end
 
       def hmac_sha1(key)
         digest = ::OpenSSL::Digest.new('sha1')
-        Extension::Binary.new(::OpenSSL::HMAC.digest(digest, key, self))
+        Types::Binary.new(::OpenSSL::HMAC.digest(digest, key, self))
       end
 
       def hmac_md5(key)
         digest = ::OpenSSL::Digest.new('md5')
-        Extension::Binary.new(::OpenSSL::HMAC.digest(digest, key, self))
+        Types::Binary.new(::OpenSSL::HMAC.digest(digest, key, self))
       end
 
       def from_xml
         Workato::Utilities::Xml.parse_xml_to_hash(self)
       end
-
-      TO_COUNTRY_METHODS.each do |suffix|
-        define_method("to_country_#{suffix}") do
-          to_country.try(suffix)
-        end
-      end
-
-      TO_CURRENCY_METHODS.each do |suffix|
-        define_method("to_currency_#{suffix}") do
-          to_currency_obj.try(suffix)
-        end
-      end
-
-      TO_STATE_METHODS.each do |suffix|
-        define_method("to_state_#{suffix}") do |country_name = 'US'|
-          to_state(country_name).try(:[], suffix)
-        end
-      end
-
-      protected
-
-      def to_country
-        TO_COUNTRY_METHODS.transform_find do |attr|
-          ISO3166::Country.send("find_country_by_#{attr}", self)
-        end
-      end
-
-      def to_currency_obj
-        ISO4217::Currency.from_code(self) || to_country.try(:currency)
-      end
-
-      def to_state(country_name = 'US')
-        country_name = country_name.presence || 'US'
-        country = country_name.to_country
-        return nil if country.blank?
-
-        state = upcase
-        country.states.transform_find do |code, data|
-          name = data['name'].upcase
-          other_names = Array(data['names']).map(&:upcase)
-          if code == state || name == state || other_names.include?(state)
-            {
-              code: code,
-              name: name
-            }.with_indifferent_access
-          end
-        end
-      end
-    end
-
-    class Binary < ::String
-      TITLE_LENGTH = 16
-      SUMMARY_LENGTH = 128
-
-      def initialize(str)
-        super(str)
-        force_encoding(Encoding::ASCII_8BIT)
-      end
-
-      def to_s
-        self
-      end
-
-      def to_json(_options = nil)
-        summary
-      end
-
-      def binary?
-        true
-      end
-
-      def base64
-        Base64.strict_encode64(self)
-      end
-
-      def as_string(encoding)
-        ::String.new(self, encoding: encoding).encode(encoding, invalid: :replace, undef: :replace)
-      end
-
-      def as_utf8
-        as_string('utf-8')
-      end
-
-      def sha1
-        Binary.new(::Digest::SHA1.digest(self))
-      end
-
-      private
-
-      def summary
-        if length.positive?
-          left = "0x#{byteslice(0, SUMMARY_LENGTH).unpack1('H*')}"
-          right = bytesize > SUMMARY_LENGTH ? "…(#{bytesize - SUMMARY_LENGTH} bytes more)" : ''
-          "#{left}#{right}"
-        else
-          ''
-        end
-      end
     end
   end
 end

data/lib/workato/testing/vcr_encrypted_cassette_serializer.rb

@@ -1,6 +1,8 @@
 # typed: true
 # frozen_string_literal: true
 
+require_relative '../extension/metadata_fix_wrap_kw_args'
+
 module Workato
   module Testing
     class VCREncryptedCassetteSerializer < ActiveSupport::EncryptedFile

data/lib/workato/testing/vcr_multipart_body_matcher.rb

@@ -5,6 +5,7 @@ module Workato
   module Testing
     class VCRMultipartBodyMatcher
       MULTIPART_HEADER_MATCHER = %r{^multipart/form-data; boundary=(.+)$}.freeze
+      private_constant :MULTIPART_HEADER_MATCHER
 
       class << self
         def call(request1, request2)

data/lib/workato/types/binary.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Workato
+  module Types
+    # Explicit wrapper for binary data
+    #
+    # Workato runtime always converts a String to {Workato::Types::UnicodeString} and
+    # binary data to {Workato::Types::Binary} before execute an action.
+    #
+    # == Call action or trigger by name
+    #
+    # SDK emulator applies trigger's or action's input/output schema and normalize string when invoke them by name.
+    # If you call an operation like this, then emulator passes input with
+    # {Workato::Types::UnicodeString} or {Workato::Types::Binary} to the operation
+    #
+    # CLI
+    #   workato exec 'actions.test_action'
+    #   workato exec 'triggers.test_poll_trigger'
+    #
+    # RSpec
+    #   connector.actions.test_action.invoke(input)
+    #   connector.triggers.test_poll_trigger.invoke(input)
+    #
+    # == Direct call to execute or poll block
+    #
+    # Schema is not applied when call an action's execute block directly. For example
+    #
+    # CLI
+    #   workato exec 'actions.test_action.execute'
+    #
+    # RSpec
+    #   connector.actions.test_action.execute(settings, input, input_schema, output_schema)
+    #
+    # In that case if action's code relies on methods of {Workato::Types::UnicodeString} or {Workato::Types::Binary}
+    # then this explicit wrapper should be used for correct behavior.
+    #
+    # @example
+    #   input = {
+    #     file_content: Workato::Types::Binary.new(File.read('/path/to/file.bin', 'wb')),
+    #     file_name: Workato::Types::UnicodeString.new("Hello World!")
+    #   }
+    #
+    #   connector.actions.upload(settings, input)
+    #
+    # @see Workato::Types::UnicodeString
+    class Binary < ::String
+      TITLE_LENGTH = 16
+      SUMMARY_LENGTH = 128
+
+      def initialize(str)
+        super(str)
+        force_encoding(Encoding::ASCII_8BIT)
+      end
+
+      def to_s
+        self
+      end
+
+      def to_json(_options = nil)
+        summary
+      end
+
+      # Returns true for binary data
+      #
+      # @return [Boolean]
+      def binary?
+        true
+      end
+
+      def base64
+        Base64.strict_encode64(self)
+      end
+
+      def as_string(encoding)
+        ::String.new(self, encoding: encoding).encode(encoding, invalid: :replace, undef: :replace)
+      end
+
+      def as_utf8
+        as_string('utf-8')
+      end
+
+      def sha1
+        Binary.new(::Digest::SHA1.digest(self))
+      end
+
+      private
+
+      def summary
+        if length.positive?
+          left = "0x#{byteslice(0, SUMMARY_LENGTH).unpack1('H*')}"
+          right = bytesize > SUMMARY_LENGTH ? "…(#{bytesize - SUMMARY_LENGTH} bytes more)" : ''
+          "#{left}#{right}"
+        else
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/workato/types/unicode_string.rb

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+module Workato
+  module Types
+    # Explicit wrapper for unicode strings.
+    #
+    # Workato runtime always converts a String to {Workato::Types::UnicodeString} and
+    # binary data to {Workato::Types::Binary} before execute an action.
+    #
+    # == Call action or trigger by name
+    #
+    # SDK emulator applies trigger's or action's input/output schema and normalize string when invoke them by name.
+    # If you call an operation like this, then emulator passes input with
+    # {Workato::Types::UnicodeString} or {Workato::Types::Binary} to the operation
+    #
+    # CLI
+    #   workato exec 'actions.test_action'
+    #   workato exec 'triggers.test_poll_trigger'
+    #
+    # RSpec
+    #   connector.actions.test_action.invoke(input)
+    #   connector.triggers.test_poll_trigger.invoke(input)
+    #
+    # == Direct call to execute or poll block
+    #
+    # Schema is not applied when call an action's execute block directly. For example
+    #
+    # CLI
+    #   workato exec 'actions.test_action.execute'
+    #
+    # RSpec
+    #   connector.actions.test_action.execute(settings, input, input_schema, output_schema)
+    #
+    # In that case if action's code relies on methods of {Workato::Types::UnicodeString} or {Workato::Types::Binary}
+    # then this explicit wrapper should be used for correct behavior.
+    #
+    # @example
+    #   input = {
+    #     file_content: Workato::Types::Binary.new(File.read('/path/to/file.bin', 'wb')),
+    #     file_name: Workato::Types::UnicodeString.new("Hello World!")
+    #   }
+    #
+    #   connector.actions.upload(settings, input)
+    #
+    # @see Workato::Types::Binary
+    class UnicodeString < ::String
+      # @param str Ruby string
+      def initialize(str)
+        super(str, **{})
+        encode!('UTF-8')
+      end
+
+      # Returns false for unicode strings
+      #
+      # @return [Boolean]
+      def binary?
+        false
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workato-connector-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Pavel Abolmasov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,47 +39,33 @@ 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
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: currencies
+  name: charlock_holmes
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.7.7
 - !ruby/object:Gem::Dependency
   name: em-http-request
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +156,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.10.10
+        version: 1.13.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.10.10
+        version: 1.13.10
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -318,34 +304,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -380,14 +338,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -408,14 +366,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -438,8 +396,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - LICENSE.md
 - README.md
+- VERSION
 - exe/workato
 - lib/workato-connector-sdk.rb
 - lib/workato/cli/edit_command.rb
@@ -458,17 +418,20 @@ files:
 - lib/workato/connector/sdk/block_invocation_refinements.rb
 - lib/workato/connector/sdk/connection.rb
 - lib/workato/connector/sdk/connector.rb
+- lib/workato/connector/sdk/core.rb
 - lib/workato/connector/sdk/dsl.rb
 - 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/csv_package.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/reinvoke_after.rb
+- lib/workato/connector/sdk/dsl/stream_package.rb
 - lib/workato/connector/sdk/dsl/time.rb
-- lib/workato/connector/sdk/dsl/workato_code_lib.rb
+- lib/workato/connector/sdk/dsl/workato_package.rb
 - lib/workato/connector/sdk/dsl/workato_schema.rb
 - lib/workato/connector/sdk/errors.rb
 - lib/workato/connector/sdk/lookup_tables.rb
@@ -485,8 +448,9 @@ files:
 - lib/workato/connector/sdk/schema/field/object.rb
 - lib/workato/connector/sdk/schema/field/string.rb
 - lib/workato/connector/sdk/schema/type/time.rb
-- lib/workato/connector/sdk/schema/type/unicode_string.rb
 - lib/workato/connector/sdk/settings.rb
+- lib/workato/connector/sdk/stream.rb
+- lib/workato/connector/sdk/streams.rb
 - lib/workato/connector/sdk/summarize.rb
 - lib/workato/connector/sdk/trigger.rb
 - lib/workato/connector/sdk/version.rb
@@ -495,12 +459,17 @@ files:
 - lib/workato/extension/case_sensitive_headers.rb
 - lib/workato/extension/content_encoding_decoder.rb
 - lib/workato/extension/currency.rb
+- lib/workato/extension/currency/countries.rb
+- lib/workato/extension/currency/countries.yml
+- lib/workato/extension/currency/currencies.rb
+- lib/workato/extension/currency/currencies.yml
 - 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/metadata_fix_wrap_kw_args.rb
 - lib/workato/extension/nil_class.rb
 - lib/workato/extension/object.rb
 - lib/workato/extension/phone.rb
@@ -509,6 +478,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/types/binary.rb
+- lib/workato/types/unicode_string.rb
 - lib/workato/utilities/encoding.rb
 - lib/workato/utilities/xml.rb
 - lib/workato/web/app.rb
@@ -530,6 +501,7 @@ 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
+  rubygems_mfa_required: 'true'
 post_install_message: |2+
 
   If you updated from workato-connector-sdk prior 1.2.0 your tests could be broken.
@@ -544,7 +516,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: 2.7.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="