workato-connector-sdk 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e0a739fc6bc5fe15228d209dc24ac4858c3815b4252b5f6d9abd9ae0644b15d
-  data.tar.gz: d4089c8dc7f6c8f9bd171730797a7b82eeb3192883d4b5883a5998985a20001a
+  metadata.gz: 2a456929ee155b6a048f547defcb4f3ccfcdd2172c1e0539ca601d8268bc0060
+  data.tar.gz: 588a1bae54828aa7fb750aaa53ca57336c14693478ac096b810b441008186fde
 SHA512:
-  metadata.gz: f6a00086288382c03c024f351e69ca79749d6ef41a833141140274926bec885a7382ce505e9b4981c05a465efa2f1c97cb30697906b8ba6c63d02709dedc9de7
-  data.tar.gz: b5b289bf86ac5970420e20762609256a6280f00a76ae604fcff206f65f40abb517f22c2207f93f1d439b250e4d725e4a5a91865904bf32c93459c52c932e70b3
+  metadata.gz: 5ab021777798644396d5d910c6d3c6f6ebf7ef23956ca7c3b5e79ec2d01d9f59776ea7afa4cbf8c9d501d18c4fc8142e1d4794e15bb3ade22692a3a95c94e4f4
+  data.tar.gz: e101977c93f1d878cd27c7170e143fbaf7f1221b52d80c489c5ca37915783662bd8571041bae0d4ad75094851ad74f00e6434c331da902d580e9e13098eb21a5

data/.yardopts

@@ -0,0 +1,8 @@
+--title "Workato Connector SDK Ruby"
+--main README.md
+--no-private
+--plugin sorbet
+--exclude lib/workato/cli/
+--exclude lib/workato/utilities/
+--exclude lib/workato/web/
+--exclude lib/workato/extension/

data/README.md

@@ -339,7 +339,6 @@ Options:
   [--col-sep=COL_SEP]      # Use separator for CSV converter
                            # Default: comma
                            # Possible values: comma, space, tab, colon, semicolon, pipe
-  [--api-email=API_EMAIL]  # Email for accessing Workato API or set WORKATO_API_EMAIL environment variable
   [--api-token=API_TOKEN]  # Token for accessing Workato API or set WORKATO_API_TOKEN environment variable
 ```
 
@@ -425,8 +424,6 @@ Options:
   -l, [--logo=LOGO]                # Path to connector logo: png or jpeg file
   -n, [--notes=NOTES]              # Release notes
   -c, [--connector=CONNECTOR]      # Path to connector source code
-      [--api-email=API_EMAIL]      # Email for accessing Workato API.
-                                   # If present overrides value from WORKATO_API_EMAIL environment variable.
       [--api-token=API_TOKEN]      # Token for accessing Workato API.
                                    # If present overrides value from WORKATO_API_TOKEN environment variable.
       [--environment=ENVIRONMENT]  # Data center specific URL to push connector code.
@@ -1139,7 +1136,6 @@ jobs:
       run: bundle exec rspec
     # - name: Push to DEV workspace # Use this to push to DEV. This can be enabled when a PR is merged.
     #   env: 
-    #     WORKATO_API_EMAIL: ${{ secrets.WORKATO_DEV_ENVIRONMENT_API_EMAIL}}
     #     WORKATO_API_TOKEN: ${{ secrets.WORKATO_DEV_ENVIRONMENT_API_TOKEN}} 
     #   run: workato push
 ```

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.3.1

data/lib/workato/cli/generate_command.rb

@@ -50,6 +50,7 @@ module Workato
                     enum: SchemaCommand::CSV_SEPARATORS,
                     default: 'comma'
       method_option :api_email,
+                    hide: true,
                     type: :string,
                     desc: 'Email for accessing Workato API or ' \
                           "set #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} environment variable"

data/lib/workato/cli/main.rb

@@ -128,6 +128,7 @@ module Workato
                     desc: 'Path to connector source code',
                     lazy_default: Workato::Connector::Sdk::DEFAULT_CONNECTOR_PATH
       method_option :api_email,
+                    hide: true,
                     type: :string,
                     desc: "Email for accessing Workato API.\n" \
                           "If present overrides value from #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} " \

data/lib/workato/cli/push_command.rb

@@ -5,6 +5,7 @@ require 'uri'
 require 'ruby-progressbar'
 require 'zip'
 require 'fileutils'
+require 'thor'
 
 module Workato
   module CLI
@@ -108,7 +109,7 @@ module Workato
         url = "#{api_base_url}#{API_IMPORT_PATH}/#{folder_id}"
         response = RestClient.post(
           url,
-          File.open(zip_file_path),
+          File.open(zip_file_path, 'rb'),
           auth_headers.merge(
             'Content-Type' => 'application/zip'
           )
@@ -185,10 +186,25 @@ module Workato
       end
 
       def auth_headers
-        {
-          'x-user-email' => api_email,
-          'x-user-token' => api_token
-        }
+        @auth_headers ||=
+          if api_email.present?
+            warn <<~WARNING
+              You are using old authorization schema with --api-email and --api-token which is less secure and deprecated.
+              We strongly recommend migrating over to API Clients for authentication to Workato APIs.
+
+              Learn more: https://docs.workato.com/developing-connectors/sdk/cli/reference/cli-commands.html#workato-push
+
+              If you use API Client token but still see this message, ensure you do not pass --api-email param nor have #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} environment variable set.
+            WARNING
+            {
+              'x-user-email' => api_email,
+              'x-user-token' => api_token
+            }
+          else
+            {
+              'Authorization' => "Bearer #{api_token}"
+            }
+          end
       end
 
       def folder_id

data/lib/workato/cli/schema_command.rb

@@ -68,10 +68,24 @@ module Workato
       end
 
       def auth_headers
-        {
-          'x-user-email' => api_email,
-          'x-user-token' => api_token
-        }
+        if api_email.present?
+          warn <<~WARNING
+            You are using old authorization schema with --api-email and --api-token which is less secure and deprecated.
+            We strongly recommend migrating over to API Clients for authentication to Workato APIs.
+
+            Learn more: https://docs.workato.com/developing-connectors/sdk/cli/reference/cli-commands.html#workato-generate-schema
+
+            If you use API Client token but still see this message, ensure you do not pass --api-email param nor have #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} environment variable set.
+          WARNING
+          {
+            'x-user-email' => api_email,
+            'x-user-token' => api_token
+          }
+        else
+          {
+            'Authorization' => "Bearer #{api_token}"
+          }
+        end
       end
 
       private_constant :API_GENERATE_SCHEMA_PATH

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

@@ -13,7 +13,7 @@ module Workato
 
         def self.from_yaml(path = DEFAULT_ACCOUNT_PROPERTIES_PATH)
           File.open(path) do |f|
-            instance.load_data(YAML.safe_load(ERB.new(f.read).result, [::Symbol]).to_hash)
+            instance.load_data(YAML.safe_load(ERB.new(f.read).result, permitted_classes: [::Symbol]).to_hash)
           end
         end
 

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

@@ -4,7 +4,8 @@
 module Workato
   module Connector
     module Sdk
-      # match proc's arguments, even if it's a lambda.
+      # Match proc's arguments, even if it's a lambda.
+      # @api private
       module BlockInvocationRefinements
         refine Proc do
           def call(*args, &block)

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

@@ -36,6 +36,7 @@ module Workato
 
         using BlockInvocationRefinements
 
+        # @api private
         sig { returns(HashWithIndifferentAccess) }
         attr_reader :source
 
@@ -56,11 +57,13 @@ module Workato
           @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.
@@ -70,11 +73,13 @@ module Workato
           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?
@@ -100,6 +105,7 @@ module Workato
           global_dsl_context.execute(self.settings, &source['base_uri'])
         end
 
+        # @api private
         sig do
           params(
             message: String,
@@ -267,6 +273,7 @@ module Workato
             end
           end
 
+          # @api private
           sig { params(settings: HashWithIndifferentAccess).returns(T.nilable(HashWithIndifferentAccess)) }
           def refresh!(settings)
             if oauth2?
@@ -300,6 +307,7 @@ module Workato
             end
           end
 
+          # @api private
           sig { returns(HashWithIndifferentAccess) }
           def source
             return @source unless multi?
@@ -381,8 +389,6 @@ module Workato
             Dsl::WithDsl.new(@connection)
           end
         end
-
-        private_constant :Authorization
       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
 
@@ -208,6 +209,8 @@ module Workato
         end
       end
 
+      private_constant :ActionsProxy
+
       class MethodsProxy
         extend T::Sig
 
@@ -255,6 +258,8 @@ module Workato
         end
       end
 
+      private_constant :MethodsProxy
+
       class PickListsProxy
         extend T::Sig
 
@@ -306,6 +311,8 @@ module Workato
         end
       end
 
+      private_constant :PickListsProxy
+
       class TriggersProxy
         extend T::Sig
 
@@ -365,6 +372,8 @@ module Workato
           end
         end
       end
+
+      private_constant :TriggersProxy
     end
   end
 end

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_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/error.rb

@@ -6,6 +6,8 @@ module Workato
     module Sdk
       module Dsl
         module Error
+          # @param message [String]
+          # @raise [Workato::Connector::Sdk::RuntimeError]
           def error(message)
             raise Sdk::RuntimeError, message
           end

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

@@ -38,6 +38,8 @@ module Workato
               T.unsafe(self).recipe_id.reverse
             end
           end
+
+          private_constant :ClassMethods
         end
       end
     end

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

@@ -8,8 +8,13 @@ module Workato
         # https://docs.workato.com/developing-connectors/sdk/sdk-reference/http.html#http-methods
         module HTTP
           PARALLEL_SUCCESS_INDEX = 0
+          private_constant :PARALLEL_SUCCESS_INDEX
+
           PARALLEL_RESULTS_INDEX = 1
+          private_constant :PARALLEL_RESULTS_INDEX
+
           PARALLEL_ERRORS_INDEX = 2
+          private_constant :PARALLEL_ERRORS_INDEX
 
           def get(url, params = {})
             http_request(url, method: 'GET').params(params).response_format_json
@@ -52,7 +57,7 @@ module Workato
               response = nil
               exception = nil
               begin
-                response = request.execute!
+                response = request.response!
               rescue StandardError => e
                 exception = e.to_s
               end

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

@@ -27,13 +27,7 @@ module Workato
               stream = out(stream[:name], stream[:input] || {})
             end
 
-            Stream::Reader.new(
-              stream: stream,
-              from: from,
-              frame_size: frame_size
-            ).each_chunk do |chunk, byte_from, byte_to, eof, next_from|
-              blk.call(chunk, byte_from, byte_to, eof, next_from)
-            end
+            Stream.each_chunk(stream: stream, from: from, frame_size: frame_size, &blk)
           end
 
           sig { params(stream_name: String, input: SorbetTypes::StreamInputHash).returns(Stream::Proxy) }

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

@@ -13,9 +13,19 @@ module Workato
       module Dsl
         class WorkatoPackage
           JWT_ALGORITHMS = %w[RS256 RS384 RS512].freeze
+          private_constant :JWT_ALGORITHMS
+
           JWT_RSA_KEY_MIN_LENGTH = 2048
+          private_constant :JWT_RSA_KEY_MIN_LENGTH
 
           VERIFY_RCA_ALGORITHMS = %w[SHA SHA1 SHA224 SHA256 SHA384 SHA512].freeze
+          private_constant :VERIFY_RCA_ALGORITHMS
+
+          RANDOM_SIZE = 32
+          private_constant :RANDOM_SIZE
+
+          ALLOWED_KEY_SIZES = [128, 192, 256].freeze
+          private_constant :ALLOWED_KEY_SIZES
 
           def initialize(streams:, connection:)
             @streams = streams
@@ -76,8 +86,6 @@ module Workato
             SecureRandom.uuid
           end
 
-          RANDOM_SIZE = 32
-
           def random_bytes(len)
             unless (len.is_a? ::Integer) && (len <= RANDOM_SIZE)
               raise "The requested length or random bytes sequence should be <= #{RANDOM_SIZE}"
@@ -86,8 +94,6 @@ module Workato
             Types::Binary.new(::OpenSSL::Random.random_bytes(len))
           end
 
-          ALLOWED_KEY_SIZES = [128, 192, 256].freeze
-
           def aes_cbc_encrypt(string, key, init_vector = nil)
             key_size = key.bytesize * 8
             unless ALLOWED_KEY_SIZES.include?(key_size)

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

@@ -25,9 +25,11 @@ module Workato
 
           abstract!
 
+          # @api private
           sig { abstract.returns(Streams) }
           def streams; end
 
+          # @api private
           sig { abstract.returns(Connection) }
           def connection; end
 

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require_relative './block_invocation_refinements'
@@ -6,31 +6,45 @@ require_relative './block_invocation_refinements'
 module Workato
   module Connector
     module Sdk
+      module SorbetTypes
+        ObjectDefinitionOutput = T.type_alias { T::Array[HashWithIndifferentAccess] }
+      end
+
       class ObjectDefinitions
+        extend T::Sig
+
         using BlockInvocationRefinements
 
+        sig do
+          params(
+            object_definitions: SorbetTypes::SourceHash,
+            connection: Connection,
+            methods: SorbetTypes::SourceHash
+          ).void
+        end
         def initialize(object_definitions:, connection:, methods:)
           @object_definitions_source = object_definitions
           @methods_source = methods
           @connection = connection
-          define_object_definition_methods(object_definitions)
+          @object_definitions = T.let({}, T::Hash[T.any(String, Symbol), ObjectDefinition])
+          define_object_definition_methods
         end
 
+        sig do
+          params(
+            settings: T.nilable(SorbetTypes::SettingsHash),
+            config_fields: SorbetTypes::OperationInputHash
+          ).returns(HashWithIndifferentAccess)
+        end
         def lazy(settings = nil, config_fields = {})
           DupHashWithIndifferentAccess.new do |object_definitions, name|
             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)
+              object_definitions[name] = create_operation.execute(settings, config_fields) do |connection, input|
+                instance_exec(connection, input, object_definitions, &fields_proc)
+              end
             rescue SystemStackError => e
               raise Workato::Connector::Sdk::CircleReferenceObjectDefinitionError.new(name, e.backtrace)
             end
@@ -39,40 +53,67 @@ module Workato
 
         private
 
+        sig { returns(SorbetTypes::SourceHash) }
         attr_reader :methods_source
+
+        sig { returns(Connection) }
         attr_reader :connection
-        attr_reader :settings
+
+        sig { returns(SorbetTypes::SourceHash) }
         attr_reader :object_definitions_source
 
-        def define_object_definition_methods(object_definitions)
-          object_definitions.each do |(object, _definition)|
+        sig { void }
+        def define_object_definition_methods
+          object_definitions_source.each do |(object, _definition)|
             define_singleton_method(object) do
-              @object_definitions ||= {}
               @object_definitions[object] ||= ObjectDefinition.new(name: object, object_definitions: self)
             end
           end
         end
 
+        sig { returns(Operation) }
+        def create_operation
+          Operation.new(methods: methods_source, connection: connection)
+        end
+
         class ObjectDefinition
+          extend T::Sig
+
+          sig { params(name: T.any(String, Symbol), object_definitions: ObjectDefinitions).void }
           def initialize(name:, object_definitions:)
-            @object_definitions = object_definitions
             @name = name
+            @object_definitions = object_definitions
           end
 
+          sig do
+            params(
+              settings: T.nilable(SorbetTypes::SettingsHash),
+              config_fields: SorbetTypes::OperationInputHash
+            ).returns(SorbetTypes::ObjectDefinitionOutput)
+          end
           def fields(settings = nil, config_fields = {})
             object_definitions_lazy_hash = @object_definitions.lazy(settings, config_fields)
             object_definitions_lazy_hash[@name]
           end
         end
 
+        private_constant :ObjectDefinition
+
         class DupHashWithIndifferentAccess < HashWithIndifferentAccess
+          extend T::Sig
+          extend T::Generic
+
+          K = type_member { { fixed: T.any(String, Symbol) } }
+          V = type_member { { fixed: T.untyped } }
+          Elem = type_member { { fixed: T.untyped } }
+
+          sig { params(name: K).returns(V) }
           def [](name)
             super.deep_dup
           end
         end
 
-        private_constant 'ObjectDefinition'
-        private_constant 'DupHashWithIndifferentAccess'
+        private_constant :DupHashWithIndifferentAccess
       end
     end
   end

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

@@ -225,7 +225,7 @@ module Workato
         def resolve_request(request_or_result)
           case request_or_result
           when Request
-            resolve_request(request_or_result.execute!)
+            resolve_request(request_or_result.response!)
           when ::Array
             request_or_result.each_with_index.inject(request_or_result) do |acc, (item, index)|
               response_item = resolve_request(item)

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

@@ -39,10 +39,10 @@ module Workato
         end
 
         def method_missing(...)
-          execute!.send(...)
+          response!.send(...)
         end
 
-        def execute!
+        def response!
           __getobj__ || __setobj__(response)
         rescue RestClient::Exceptions::Timeout => e
           Kernel.raise RequestTimeoutError, e
@@ -254,7 +254,7 @@ module Workato
         end
 
         def try(...)
-          execute!.try(...)
+          response!.try(...)
         end
 
         private
@@ -513,6 +513,8 @@ module Workato
           attr_reader :original_filename
         end
 
+        private_constant :Part
+
         class RestClientRequest < ::RestClient::Request
           def initialize(args)
             super
@@ -540,6 +542,7 @@ module Workato
             net
           end
         end
+
         private_constant :RestClientRequest
       end
     end

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

@@ -101,7 +101,7 @@ module Workato
             return Type::Time.from_date_time(value)
           when ::Date
             return value.to_date
-          when ::Numeric, ::TrueClass, ::FalseClass, Workato::Types::Binary, Type::UnicodeString,
+          when ::Numeric, ::TrueClass, ::FalseClass, Workato::Types::Binary, Workato::Types::UnicodeString,
             ::Array, ::Hash, Stream::Proxy
             return value
           when Extension::Array::ArrayWhere
@@ -111,7 +111,7 @@ module Workato
               return Workato::Types::Binary.new(value)
             end
 
-            return Type::UnicodeString.new(value)
+            return Workato::Types::UnicodeString.new(value)
           else
             if value.respond_to?(:to_time)
               return Type::Time.from_time(value.to_time)
@@ -127,6 +127,8 @@ module Workato
         end
       end
 
+      private_constant :Schema
+
       class Fields < ::Array
         def initialize(fields)
           ::Array.wrap(fields).each do |field|
@@ -232,4 +234,3 @@ require_relative './schema/field/object'
 require_relative './schema/field/string'
 
 require_relative './schema/type/time'
-require_relative './schema/type/unicode_string'

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

@@ -82,7 +82,7 @@ module Workato
 
         def read_plain_file
           all_settings = File.open(path) do |f|
-            YAML.safe_load(f.read, [::Symbol]).to_hash.with_indifferent_access
+            YAML.safe_load(f.read, permitted_classes: [::Symbol]).to_hash.with_indifferent_access
           end
 
           (name ? all_settings.fetch(name) : all_settings) || {}
@@ -144,6 +144,8 @@ module Workato
           raise MissingKeyError.new(key_path: key_path, env_key: env_key) if raise_if_missing_key
         end
       end
+
+      private_constant :FixedEncryptedConfiguration
     end
   end
 end

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

@@ -79,6 +79,22 @@ module Workato
           data
         end
 
+        class << self
+          extend T::Sig
+
+          sig do
+            params(
+              stream: T.any(Proxy, T::Hash[T.untyped, T.untyped], String),
+              from: T.nilable(Integer),
+              frame_size: T.nilable(Integer),
+              blk: SorbetTypes::StreamInProc
+            ).void
+          end
+          def each_chunk(stream:, from:, frame_size: nil, &blk)
+            Reader.new(stream: stream, from: from, frame_size: frame_size).each_chunk(&blk)
+          end
+        end
+
         class Reader
           extend T::Sig
 
@@ -153,6 +169,9 @@ module Workato
           end
         end
 
+        private_constant :Reader
+
+        # @api private
         class Proxy
           extend T::Sig
 
@@ -212,9 +231,9 @@ module Workato
         class Mock
           extend T::Sig
 
-          sig { params(chunks: T.untyped).void }
+          sig { params(chunks: T::Hash[T.any(Integer, String), T.untyped]).void }
           def initialize(chunks:)
-            @chunks = chunks
+            @chunks = T.let(chunks.transform_keys(&:to_i), T::Hash[Integer, T.untyped])
           end
 
           sig { params(from: Integer, frame_size: Integer, _blk: Reader::ProxyReadProc).void }

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

@@ -56,6 +56,7 @@ module Workato
         attr_reader :connection
       end
 
+      # @api private
       class ProhibitedStreams < Streams
         extend T::Sig
 

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

@@ -57,6 +57,8 @@ module Workato
           end
         end
       end
+
+      private_constant :Summarize
     end
   end
 end

data/lib/workato/connector/sdk.rb

@@ -8,6 +8,7 @@ require 'active_support/all'
 require 'active_support/json'
 
 require_relative '../types/binary'
+require_relative '../types/unicode_string'
 
 require_relative '../extension/array'
 require_relative '../extension/case_sensitive_headers'

data/lib/workato/extension/string.rb

@@ -16,6 +16,15 @@ module Workato
         end
       end
 
+      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/)
       end

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

@@ -2,6 +2,47 @@
 
 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
@@ -19,6 +60,9 @@ module Workato
         summary
       end
 
+      # Returns true for binary data
+      #
+      # @return [Boolean]
       def binary?
         true
       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.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Pavel Abolmasov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-26 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,20 +178,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: psych
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -410,6 +396,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - LICENSE.md
 - README.md
 - VERSION
@@ -461,7 +448,6 @@ 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
@@ -493,6 +479,7 @@ files:
 - 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

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

@@ -1,23 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Workato
-  module Connector
-    module Sdk
-      class Schema
-        module Type
-          class UnicodeString < ::String
-            def initialize(str)
-              super(str, **{})
-              encode!('UTF-8')
-            end
-
-            def binary?
-              false
-            end
-          end
-        end
-      end
-    end
-  end
-end