workato-connector-sdk 1.2.0 → 1.3.0

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

@@ -0,0 +1,84 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Workato
+  module Connector
+    module Sdk
+      module Dsl
+        module ReinvokeAfter
+          extend T::Sig
+
+          sig do
+            params(
+              continue: T::Hash[T.untyped, T.untyped],
+              temp_output: T.nilable(T::Hash[T.untyped, T.untyped])
+            ).void
+          end
+          def checkpoint!(continue:, temp_output: nil)
+            # no-op
+          end
+
+          sig do
+            params(
+              seconds: T.any(Integer, Float),
+              continue: T::Hash[T.untyped, T.untyped],
+              temp_output: T.nilable(T::Hash[T.untyped, T.untyped])
+            ).void
+          end
+          def reinvoke_after(seconds:, continue:, temp_output: nil) # rubocop:disable Lint/UnusedMethodArgument
+            Kernel.throw REINVOKE_AFTER_SIGNAL, ReinvokeParams.new(
+              seconds: seconds,
+              continue: continue
+            )
+          end
+
+          private
+
+          MAX_REINVOKES = 5
+          private_constant :MAX_REINVOKES
+
+          REINVOKE_AFTER_SIGNAL = :reinvoke_after
+          private_constant :REINVOKE_AFTER_SIGNAL
+
+          class ReinvokeParams < T::Struct
+            prop :seconds, T.any(Float, Integer)
+            prop :continue, T::Hash[T.untyped, T.untyped]
+          end
+          private_constant :ReinvokeParams
+
+          sig { params(continue: T::Hash[T.any(Symbol, String), T.untyped], _blk: Proc).returns(T.untyped) }
+          def loop_reinvoke_after(continue, &_blk)
+            reinvokes_remaining = T.let(reinvoke_limit, Integer)
+
+            Kernel.loop do
+              reinvoke_after = Kernel.catch(REINVOKE_AFTER_SIGNAL) do
+                return yield(continue)
+              end
+
+              if reinvokes_remaining.zero?
+                Kernel.raise "Max number of reinvokes on SDK Gem reached. Current limit is #{reinvoke_limit}"
+              end
+
+              reinvokes_remaining -= 1
+
+              reinvoke_after = T.cast(reinvoke_after, ReinvokeParams)
+              reinvoke_sleep(reinvoke_after.seconds)
+              continue = reinvoke_after.continue
+            end
+          end
+
+          sig { params(seconds: T.any(Float, Integer)).void }
+          def reinvoke_sleep(seconds)
+            Kernel.sleep((ENV['WAIT_REINVOKE_AFTER'].presence || seconds).to_f)
+          end
+
+          sig { returns(Integer) }
+          def reinvoke_limit
+            @reinvoke_limit = T.let(@reinvoke_limit, T.nilable(Integer))
+            @reinvoke_limit ||= (ENV['MAX_REINVOKES'].presence || MAX_REINVOKES).to_i
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Workato
+  module Connector
+    module Sdk
+      module Dsl
+        class StreamPackage
+          extend T::Sig
+
+          sig { params(streams: Streams, connection: Connection).void }
+          def initialize(streams:, connection:)
+            @streams = streams
+            @connection = connection
+          end
+
+          sig do
+            params(
+              stream: T.any(Stream::Proxy, String, T::Hash[T.untyped, T.untyped]),
+              from: T.nilable(Integer),
+              frame_size: T.nilable(Integer),
+              blk: SorbetTypes::StreamInProc
+            ).returns(T.untyped)
+          end
+          def in(stream, from: nil, frame_size: nil, &blk)
+            if stream.is_a?(Hash) && stream[:__stream__] && stream[:chunks].nil?
+              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
+          end
+
+          sig { params(stream_name: String, input: SorbetTypes::StreamInputHash).returns(Stream::Proxy) }
+          def out(stream_name, input = {})
+            Stream::Proxy.new(input: input, name: stream_name, stream: streams[stream_name])
+          end
+
+          private
+
+          T::Sig::WithoutRuntime.sig { params(symbol: T.any(String, Symbol), _args: T.untyped).void }
+          def method_missing(symbol, *_args)
+            raise UndefinedStdLibMethodError.new(symbol.to_s, 'workato.stream')
+          end
+
+          T::Sig::WithoutRuntime.sig { params(_args: T.untyped).returns(T::Boolean) }
+          def respond_to_missing?(*_args)
+            false
+          end
+
+          sig { returns(Connection) }
+          attr_reader :connection
+
+          sig { returns(Streams) }
+          attr_reader :streams
+        end
+      end
+    end
+  end
+end

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

@@ -18,17 +18,3 @@ module Workato
     end
   end
 end
-
-begin
-  if ENV['TZ'].present? && ENV['TZ'] != 'UTC'
-    warn "WARNING: TZ environment variable is set to '#{ENV['TZ']}'. Set TZ=UTC for consistency with Workato platform'"
-  else
-    ENV['TZ'] = 'UTC'
-  end
-  ::Time.zone = Workato::Connector::Sdk::DEFAULT_TIME_ZONE
-rescue TZInfo::DataSourceNotFound
-  puts ''
-  puts "tzinfo-data is not present. Please install gem 'tzinfo-data' by 'gem install tzinfo-data'"
-  puts ''
-  exit!
-end

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

@@ -0,0 +1,146 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'jwt'
+require_relative './csv_package'
+require_relative './stream_package'
+
+using Workato::Extension::HashWithIndifferentAccess
+
+module Workato
+  module Connector
+    module Sdk
+      module Dsl
+        class WorkatoPackage
+          JWT_ALGORITHMS = %w[RS256 RS384 RS512].freeze
+          JWT_RSA_KEY_MIN_LENGTH = 2048
+
+          VERIFY_RCA_ALGORITHMS = %w[SHA SHA1 SHA224 SHA256 SHA384 SHA512].freeze
+
+          def initialize(streams:, connection:)
+            @streams = streams
+            @connection = connection
+          end
+
+          def jwt_encode_rs256(payload, key, header_fields = {})
+            jwt_encode(payload, key, 'RS256', header_fields)
+          end
+
+          def jwt_encode(payload, key, algorithm, header_fields = {})
+            algorithm = algorithm.to_s.upcase
+            unless JWT_ALGORITHMS.include?(algorithm)
+              raise "Unsupported signing method. Supports only #{JWT_ALGORITHMS.join(', ')}. Got: '#{algorithm}'"
+            end
+
+            rsa_private = OpenSSL::PKey::RSA.new(key)
+            if rsa_private.n.num_bits < JWT_RSA_KEY_MIN_LENGTH
+              raise "A RSA key of size #{JWT_RSA_KEY_MIN_LENGTH} bits or larger MUST be used with JWT."
+            end
+
+            header_fields = HashWithIndifferentAccess.wrap(header_fields).except(:typ, :alg)
+            ::JWT.encode(payload, rsa_private, algorithm, header_fields)
+          end
+
+          def verify_rsa(payload, certificate, signature, algorithm = 'SHA256')
+            algorithm = algorithm.to_s.upcase
+            unless VERIFY_RCA_ALGORITHMS.include?(algorithm)
+              raise "Unsupported signing method. Supports only #{VERIFY_RCA_ALGORITHMS.join(', ')}. Got: '#{algorithm}'"
+            end
+
+            cert = OpenSSL::X509::Certificate.new(certificate)
+            digest = OpenSSL::Digest.new(algorithm)
+            cert.public_key.verify(digest, signature, payload)
+          rescue OpenSSL::PKey::PKeyError
+            raise 'An error occurred during signature verification. Check arguments'
+          rescue OpenSSL::X509::CertificateError
+            raise 'Invalid certificate format'
+          end
+
+          def parse_yaml(yaml)
+            ::Psych.safe_load(yaml)
+          rescue ::Psych::DisallowedClass => e
+            raise e.message
+          end
+
+          def render_yaml(obj)
+            ::Psych.dump(obj)
+          end
+
+          def parse_json(source)
+            JSON.parse(source)
+          rescue JSON::ParserError => e
+            raise JSONResponseFormatError, e
+          end
+
+          def uuid
+            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}"
+            end
+
+            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)
+              raise 'Incorrect key size for AES'
+            end
+
+            cipher = ::OpenSSL::Cipher.new("AES-#{key_size}-CBC")
+            cipher.encrypt
+            cipher.key = key
+            cipher.iv = init_vector if init_vector.present?
+            Types::Binary.new(cipher.update(string) + cipher.final)
+          end
+
+          def aes_cbc_decrypt(string, key, init_vector = nil)
+            key_size = key.bytesize * 8
+            unless ALLOWED_KEY_SIZES.include?(key_size)
+              raise 'Incorrect key size for AES'
+            end
+
+            cipher = ::OpenSSL::Cipher.new("AES-#{key_size}-CBC")
+            cipher.decrypt
+            cipher.key = key
+            cipher.iv = init_vector if init_vector.present?
+            Types::Binary.new(cipher.update(string) + cipher.final)
+          end
+
+          def pbkdf2_hmac_sha1(string, salt, iterations = 1000, key_len = 16)
+            Types::Binary.new(::OpenSSL::PKCS5.pbkdf2_hmac_sha1(string, salt, iterations, key_len))
+          end
+
+          def csv
+            @csv ||= CsvPackage.new
+          end
+
+          def stream
+            @stream ||= StreamPackage.new(streams: streams, connection: connection)
+          end
+
+          private
+
+          def method_missing(symbol, *_args)
+            raise UndefinedStdLibMethodError.new(symbol.to_s, 'workato')
+          end
+
+          def respond_to_missing?(*)
+            false
+          end
+
+          attr_reader :streams
+
+          attr_reader :connection
+        end
+      end
+    end
+  end
+end

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

@@ -5,10 +5,11 @@ require_relative './block_invocation_refinements'
 
 require_relative './dsl/http'
 require_relative './dsl/call'
+require_relative './dsl/reinvoke_after'
 require_relative './dsl/error'
 require_relative './dsl/account_property'
 require_relative './dsl/lookup_table'
-require_relative './dsl/workato_code_lib'
+require_relative './dsl/workato_package'
 require_relative './dsl/workato_schema'
 require_relative './dsl/time'
 require_relative './dsl/aws'
@@ -19,12 +20,29 @@ module Workato
     module Sdk
       module Dsl
         module Global
+          extend T::Sig
+          extend T::Helpers
+
+          abstract!
+
+          sig { abstract.returns(Streams) }
+          def streams; end
+
+          sig { abstract.returns(Connection) }
+          def connection; end
+
           include Time
           include AccountProperty
           include LookupTable
-          include WorkatoCodeLib
           include WorkatoSchema
-          include AWS
+
+          delegate :parse_json,
+                   :uuid,
+                   to: :workato
+
+          def workato
+            @workato ||= WorkatoPackage.new(streams: streams, connection: connection)
+          end
 
           def sleep(seconds)
             ::Kernel.sleep(seconds.presence || 0)
@@ -33,6 +51,39 @@ module Workato
           def puts(*args)
             T.unsafe(::Kernel).puts(*args)
           end
+
+          def encrypt(text, key)
+            ::Kernel.require('ruby_rncryptor')
+
+            enc_text = ::RubyRNCryptor.encrypt(text, key)
+            ::Base64.strict_encode64(enc_text)
+          end
+
+          def decrypt(text, key)
+            ::Kernel.require('ruby_rncryptor')
+
+            text = ::Base64.decode64(text)
+            dec_text = ::RubyRNCryptor.decrypt(text, key)
+            Workato::Types::Binary.new(dec_text)
+          rescue Exception => e # rubocop:disable Lint/RescueException
+            message = e.message.to_s
+            case message
+            when /Password may be incorrect/
+              ::Kernel.raise 'invalid/corrupt input or key'
+            when /RubyRNCryptor only decrypts version/
+              ::Kernel.raise 'invalid/corrupt input'
+            else
+              ::Kernel.raise
+            end
+          end
+
+          def blank; end
+
+          def clear; end
+
+          def null; end
+
+          def skip; end
         end
 
         class WithDsl
@@ -42,21 +93,23 @@ module Workato
 
           using BlockInvocationRefinements
 
-          sig { params(connection: Connection, args: T.untyped, block: T.untyped).returns(T.untyped) }
-          def execute(connection, *args, &block)
+          sig { params(connection: Connection, streams: Streams).void }
+          def initialize(connection = Connection.new, streams = ProhibitedStreams.new)
             @connection = connection
-            T.unsafe(self).instance_exec(*args, &block)
+            @streams = streams
           end
 
-          sig { params(connection: Connection, args: T.untyped, block: T.untyped).returns(T.untyped) }
-          def self.execute(connection, *args, &block)
-            T.unsafe(WithDsl.new).execute(connection, *args, &block)
+          def execute(...)
+            T.unsafe(self).instance_exec(...)
           end
 
           private
 
-          sig { returns(Connection) }
+          sig { override.returns(Connection) }
           attr_reader :connection
+
+          sig { override.returns(Streams) }
+          attr_reader :streams
         end
       end
     end

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

@@ -4,7 +4,13 @@
 module Workato
   module Connector
     module Sdk
-      InvalidDefinitionError = Class.new(StandardError)
+      Error = Class.new(StandardError)
+
+      DetectOnUnauthorizedRequestError = Class.new(Error)
+
+      RuntimeError = Class.new(Error)
+
+      InvalidDefinitionError = Class.new(Error)
 
       class UnexpectedMethodDefinitionError < InvalidDefinitionError
         attr_reader :name
@@ -28,8 +34,6 @@ module Workato
 
       InvalidSchemaError = Class.new(InvalidDefinitionError)
 
-      CustomRequestError = Class.new(StandardError)
-
       InvalidMultiAuthDefinition = Class.new(InvalidDefinitionError)
 
       class UnresolvedMultiAuthOptionError < InvalidMultiAuthDefinition
@@ -41,9 +45,7 @@ module Workato
         end
       end
 
-      RuntimeError = Class.new(StandardError)
-
-      class UnresolvedObjectDefinitionError < StandardError
+      class UnresolvedObjectDefinitionError < InvalidDefinitionError
         attr_reader :name
 
         def initialize(name)
@@ -52,7 +54,7 @@ module Workato
         end
       end
 
-      class CircleReferenceObjectDefinitionError < StandardError
+      class CircleReferenceObjectDefinitionError < InvalidDefinitionError
         attr_reader :name
 
         def initialize(name, backtrace = [])
@@ -62,7 +64,11 @@ module Workato
         end
       end
 
-      class RequestError < StandardError
+      RequestError = Class.new(RuntimeError)
+
+      RequestTimeoutError = Class.new(RequestError)
+
+      class RequestFailedError < RequestError
         attr_reader :method
         attr_reader :code
         attr_reader :response
@@ -81,7 +87,7 @@ module Workato
         end
       end
 
-      class MissingRequiredInput < StandardError
+      class MissingRequiredInput < RuntimeError
         def initialize(label, toggle_label)
           message = if toggle_label && label != toggle_label
                       "Either '#{label}' or '#{toggle_label}' must be present"
@@ -92,9 +98,9 @@ module Workato
         end
       end
 
-      RequestTLSCertificateFormatError = Class.new(StandardError)
+      RequestTLSCertificateFormatError = Class.new(RequestError)
 
-      RequestPayloadFormatError = Class.new(StandardError)
+      RequestPayloadFormatError = Class.new(RequestError)
 
       JSONRequestFormatError = Class.new(RequestPayloadFormatError)
 
@@ -109,6 +115,17 @@ module Workato
       MultipartFormRequestFormatError = Class.new(RequestPayloadFormatError)
 
       RAWResponseFormatError = Class.new(RequestPayloadFormatError)
+
+      class UndefinedStdLibMethodError < RuntimeError
+        attr_reader :name
+        attr_reader :package
+
+        def initialize(name, package)
+          @name = name
+          @package = package
+          super("Undefined method '#{name}' for \"#{package}\" namespace")
+        end
+      end
     end
   end
 end

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

@@ -44,6 +44,7 @@ module Workato
         extend T::Sig
 
         include Dsl::Global
+        include Dsl::AWS
         include Dsl::HTTP
         include Dsl::Call
         include Dsl::Error
@@ -51,18 +52,24 @@ module Workato
 
         using BlockInvocationRefinements
 
+        sig { override.returns(Streams) }
+        attr_reader :streams
+
         sig do
           params(
             operation: SorbetTypes::SourceHash,
             methods: SorbetTypes::SourceHash,
             connection: Connection,
+            streams: Streams,
             object_definitions: T.nilable(ObjectDefinitions)
           ).void
         end
-        def initialize(operation: {}, methods: {}, connection: Connection.new, object_definitions: nil)
+        def initialize(operation: {}, methods: {}, connection: Connection.new, streams: ProhibitedStreams.new,
+                       object_definitions: nil)
           @operation = T.let(HashWithIndifferentAccess.wrap(operation), HashWithIndifferentAccess)
           @_methods = T.let(HashWithIndifferentAccess.wrap(methods), HashWithIndifferentAccess)
           @connection = T.let(connection, Connection)
+          @streams = T.let(streams, Streams)
           @object_definitions = T.let(object_definitions, T.nilable(ObjectDefinitions))
         end
 
@@ -262,7 +269,7 @@ module Workato
         sig { returns(HashWithIndifferentAccess) }
         attr_reader :operation
 
-        sig { returns(Connection) }
+        sig { override.returns(Connection) }
         attr_reader :connection
       end
     end