workato-connector-sdk 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b49034b5762b2b44d0987d72eb74327e379284347b793714149d85d354a5bb57
-  data.tar.gz: 1be17d19381fe42689ef4a157a56eca0fb8c61a9c0e90e981e5a373305ed771f
+  metadata.gz: 0e0a739fc6bc5fe15228d209dc24ac4858c3815b4252b5f6d9abd9ae0644b15d
+  data.tar.gz: d4089c8dc7f6c8f9bd171730797a7b82eeb3192883d4b5883a5998985a20001a
 SHA512:
-  metadata.gz: 5bcc365d25ec713df12b75d9d6d5fb8a6a73266b94cf012829e4a2c98af955f1fcfa7b0d0f7e69861a4ee6cb54af24ed8952bbb590553e93a37fcf2933c69459
-  data.tar.gz: 1da6193b9a1b04e3d3e2c6fb34fcd0eeec7666908c61df5c7ec386381ba8f33207b50b8ffc1e9d581fecb599fc423f84f9f79867120322356aa4d645b9b7da5e
+  metadata.gz: f6a00086288382c03c024f351e69ca79749d6ef41a833141140274926bec885a7382ce505e9b4981c05a465efa2f1c97cb30697906b8ba6c63d02709dedc9de7
+  data.tar.gz: b5b289bf86ac5970420e20762609256a6280f00a76ae604fcff206f65f40abb517f22c2207f93f1d439b250e4d725e4a5a91865904bf32c93459c52c932e70b3

data/README.md

@@ -13,7 +13,7 @@ This guide below showcases how you can do the following things:
 
 ## Prerequisites
 1. Install [RVM ("Ruby Version Manager")](http://rvm.io/) or a Ruby manager of your choice. You can find more at [here](https://www.ruby-lang.org/en/documentation/installation/)
-2. Choose between Ruby versions `2.4.10` `2.5.X` or `2.7.X`. Our preferred version is `2.7.X`.
+2. Choose between Ruby versions `2.7.X`, `3.0.X`, `3.1.X`. Our preferred version is `2.7.6`.
 3. Verify you're running a valid ruby version. Do this by running either `ruby -v` or the commands within your version manager. i.e., `rvm current` if you have installed RVM.
 4. For Windows you need tzinfo-data gem installed as well. `gem install tzinfo-data`
 5. SDK depends on `charlock_holmes` gem. Check [gem's documentation](https://github.com/brianmario/charlock_holmes#installing) if you have troubles when install this dependency. Additional [details for Windows](https://github.com/brianmario/charlock_holmes/issues/84#issuecomment-652877605)
@@ -1124,7 +1124,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.4.10', '2.5', '2.7']
+        ruby-version: ['2.7', '3.0', '3.1']
 
     steps:
     - uses: actions/checkout@v2

data/VERSION

@@ -0,0 +1 @@
+1.3.0

data/lib/workato/cli/edit_command.rb

@@ -3,6 +3,8 @@
 
 require 'active_support/encrypted_configuration'
 
+require_relative '../extension/metadata_fix_wrap_kw_args'
+
 module Workato
   module CLI
     class EditCommand
@@ -23,7 +25,7 @@ module Workato
 
         catch_editing_exceptions do
           encrypted_config.change do |tmp_path|
-            system("#{ENV['EDITOR']} #{tmp_path}")
+            system("#{ENV.fetch('EDITOR', nil)} #{tmp_path}")
           end
         end
 

data/lib/workato/cli/exec_command.rb

@@ -1,9 +1,12 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require 'thor'
+require 'active_support/json'
 require_relative './multi_auth_selected_fallback'
 
+Method.prepend(T::CompatibilityPatches::MethodExtensions)
+
 module Workato
   module CLI
     class ExecCommand
@@ -21,7 +24,7 @@ module Workato
         load_from_default_files
         inspect_params(params)
         output = with_progress { execute_path }
-        show_output(output)
+        show_output(output.as_json)
         output
       end
 
@@ -65,8 +68,12 @@ module Workato
           oauth2_code: options[:oauth2_code],
           redirect_url: options[:redirect_url],
           refresh_token: options[:refresh_token],
+          from: options[:from].to_i,
+          frame_size: options[:frame_size]&.to_i || Workato::Connector::Sdk::Stream::DEFAULT_FRAME_SIZE,
           recipe_id: Workato::Connector::Sdk::Operation.recipe_id!
-        }
+        }.tap do |h|
+          h[:to] = h[:from] + h[:frame_size] - 1
+        end
       end
 
       def connector
@@ -94,9 +101,10 @@ module Workato
           end
         end
 
-        Workato::Connector::Sdk::Connection.on_settings_update = lambda do |message, &refresher|
+        Workato::Connector::Sdk::Connection.on_settings_update = lambda do |message, _settings_before, refresher|
           new_settings = refresher.call
           break unless new_settings
+          break new_settings if @settings == new_settings
 
           with_user_interaction do
             loop do
@@ -105,6 +113,7 @@ module Workato
               break new_settings if %w[n no].include?(answer)
               next unless %w[y yes].include?(answer)
 
+              @settings.merge!(new_settings)
               settings_store.update(new_settings)
               break new_settings
             end
@@ -135,11 +144,11 @@ module Workato
       end
 
       def execute_path
-        connector.invoke(path, params)
+        InvokePath.new(path: path, connector: connector, params: params).call
       rescue Workato::Connector::Sdk::InvalidMultiAuthDefinition => e
-        raise "#{e.message}. Please ensure:\n"\
+        raise "#{e.message}. Please ensure:\n" \
               "- 'selected' block is defined and returns value from 'options' list\n" \
-              "- settings file contains value expected by 'selected' block\n\n"\
+              "- settings file contains value expected by 'selected' block\n\n" \
               'See more: https://docs.workato.com/developing-connectors/sdk/guides/authentication/multi_auth.html'
       rescue Exception => e # rubocop:disable Lint/RescueException
         raise DebugExceptionError, e if options[:debug]
@@ -149,9 +158,7 @@ module Workato
 
       def show_output(output)
         if options[:output].present?
-          File.open(options[:output], 'w') do |f|
-            f.write(JSON.dump(output))
-          end
+          File.write(options[:output], JSON.dump(output))
         elsif options[:output].nil?
           say('OUTPUT') if verbose?
           jj output
@@ -214,6 +221,65 @@ module Workato
         alias puts log
         alias print log
       end
+
+      class InvokePath
+        extend T::Sig
+
+        sig do
+          params(
+            path: String,
+            connector: Workato::Connector::Sdk::Connector,
+            params: T::Hash[Symbol, T.untyped]
+          ).void
+        end
+        def initialize(path:, connector:, params:)
+          @path = T.let(path, String)
+          @connector = T.let(connector, Workato::Connector::Sdk::Connector)
+          @params = T.let(params, T::Hash[Symbol, T.untyped])
+        end
+
+        sig { returns(T.untyped) }
+        def call
+          invoke_path
+        end
+
+        private
+
+        sig { returns(String) }
+        attr_reader :path
+
+        sig { returns(Workato::Connector::Sdk::Connector) }
+        attr_reader :connector
+
+        sig { returns(T::Hash[Symbol, T.untyped]) }
+        attr_reader :params
+
+        sig { returns(T.untyped) }
+        def invoke_path
+          methods = path.split('.')
+          method = methods.pop
+          raise ArgumentError, 'path is not found' unless method
+
+          object = methods.inject(connector) { |obj, m| obj.public_send(m) }
+          output = invoke_method(object, method)
+          if output.respond_to?(:invoke)
+            invoke_method(output, :invoke)
+          else
+            output
+          end
+        end
+
+        sig { params(object: T.untyped, method: T.any(Symbol, String)).returns(T.untyped) }
+        def invoke_method(object, method)
+          parameters = object.method(method).parameters.reject { |p| p[0] == :block }.map(&:second)
+          args = params.values_at(*parameters)
+          if parameters.last == :args
+            args = args.take(args.length - 1) + Array.wrap(args.last).flatten(1)
+          end
+          object.public_send(method, *args)
+        end
+      end
+      private_constant :InvokePath
     end
   end
 end

data/lib/workato/cli/generate_command.rb

@@ -51,7 +51,7 @@ module Workato
                     default: 'comma'
       method_option :api_email,
                     type: :string,
-                    desc: 'Email for accessing Workato API or '\
+                    desc: 'Email for accessing Workato API or ' \
                           "set #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} environment variable"
       method_option :api_token,
                     type: :string,
@@ -125,7 +125,7 @@ module Workato
       end
 
       def sanitized_filename(name)
-        name.downcase.gsub(/[^0-9A-z.\-]/, '_')
+        name.downcase.gsub(/[^0-9A-z.-]/, '_')
       end
     end
   end

data/lib/workato/cli/main.rb

@@ -34,14 +34,14 @@ module Workato
       method_option :connector, type: :string, aliases: '-c', desc: 'Path to connector source code',
                                 lazy_default: Workato::Connector::Sdk::DEFAULT_CONNECTOR_PATH
       method_option :settings, type: :string, aliases: '-s',
-                               desc: 'Path to plain or encrypted file with connection configs, '\
+                               desc: 'Path to plain or encrypted file with connection configs, ' \
                                      'passwords, tokens, secrets etc',
                                lazy_default: Workato::Connector::Sdk::DEFAULT_ENCRYPTED_SETTINGS_PATH
       method_option :connection, type: :string, aliases: '-n',
                                  desc: 'Connection name if settings file contains multiple settings'
       method_option :key, type: :string, aliases: '-k',
                           lazy_default: Workato::Connector::Sdk::DEFAULT_MASTER_KEY_PATH,
-                          desc: "Path to file with encrypt/decrypt key.\n"\
+                          desc: "Path to file with encrypt/decrypt key.\n" \
                                 "NOTE: key from #{Workato::Connector::Sdk::DEFAULT_MASTER_KEY_ENV} has higher priority"
       method_option :input, type: :string, aliases: '-i', desc: 'Path to file with input JSON'
       method_option :closure, type: :string, desc: 'Path to file with next poll closure JSON'
@@ -61,6 +61,8 @@ module Workato
       method_option :oauth2_code, type: :string, desc: 'OAuth2 code exchange to tokens pair'
       method_option :redirect_url, type: :string, desc: 'OAuth2 callback url'
       method_option :refresh_token, type: :string, desc: 'OAuth2 refresh token'
+      method_option :from, type: :numeric, desc: 'Stream byte offset to read from'
+      method_option :frame_size, type: :numeric, desc: 'Stream chunk read size in bytes. Should be positive'
 
       method_option :debug, type: :boolean
 
@@ -75,7 +77,7 @@ module Workato
 
       method_option :key, type: :string, aliases: '-k',
                           lazy_default: Workato::Connector::Sdk::DEFAULT_MASTER_KEY_PATH,
-                          desc: "Path to file with encrypt/decrypt key.\n"\
+                          desc: "Path to file with encrypt/decrypt key.\n" \
                                 "NOTE: key from #{Workato::Connector::Sdk::DEFAULT_MASTER_KEY_ENV} has higher priority"
 
       def edit(path)
@@ -127,19 +129,19 @@ module Workato
                     lazy_default: Workato::Connector::Sdk::DEFAULT_CONNECTOR_PATH
       method_option :api_email,
                     type: :string,
-                    desc: "Email for accessing Workato API.\n"\
-                          "If present overrides value from #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} "\
+                    desc: "Email for accessing Workato API.\n" \
+                          "If present overrides value from #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} " \
                           'environment variable.'
       method_option :api_token,
                     type: :string,
                     desc: "Token for accessing Workato API.\n" \
-                          "If present overrides value from #{Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV} "\
+                          "If present overrides value from #{Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV} " \
                           'environment variable.'
       method_option :environment,
                     type: :string,
-                    desc: "Data center specific URL to push connector code.\n"\
-                          "If present overrides value from #{Workato::Connector::Sdk::WORKATO_BASE_URL_ENV} "\
-                          "environment variable.\n"\
+                    desc: "Data center specific URL to push connector code.\n" \
+                          "If present overrides value from #{Workato::Connector::Sdk::WORKATO_BASE_URL_ENV} " \
+                          "environment variable.\n" \
                           "Examples: 'https://app.workato.com', 'https://app.eu.workato.com'"
       method_option :folder,
                     type: :string,
@@ -171,7 +173,7 @@ module Workato
                     type: :string,
                     aliases: '-k',
                     lazy_default: Workato::Connector::Sdk::DEFAULT_MASTER_KEY_PATH,
-                    desc: "Path to file with encrypt/decrypt key.\n"\
+                    desc: "Path to file with encrypt/decrypt key.\n" \
                           "NOTE: key from #{Workato::Connector::Sdk::DEFAULT_MASTER_KEY_ENV} has higher priority"
       method_option :port,
                     type: :string,
@@ -191,6 +193,11 @@ module Workato
         ).call
       end
 
+      desc 'version', 'Shows gem version'
+      def version
+        puts Workato::Connector::Sdk::VERSION
+      end
+
       class << self
         def print_options(shell, options, group_name = nil)
           return if options.empty?

data/lib/workato/cli/oauth2_command.rb

@@ -105,14 +105,14 @@ module Workato
 
       def ensure_oauth2_type
         unless connector.connection.authorization.oauth2?
-          raise 'Authorization type is not OAuth2. '\
-                'For multi-auth connector ensure correct auth type was used. '\
+          raise 'Authorization type is not OAuth2. ' \
+                'For multi-auth connector ensure correct auth type was used. ' \
                 "Expected: 'oauth2', got: '#{connector.connection.authorization.type}''"
         end
       rescue Workato::Connector::Sdk::InvalidMultiAuthDefinition => e
-        raise "#{e.message}. Please ensure:\n"\
+        raise "#{e.message}. Please ensure:\n" \
               "- 'selected' block is defined and returns value from 'options' list\n" \
-              "- settings file contains value expected by 'selected' block\n\n"\
+              "- settings file contains value expected by 'selected' block\n\n" \
               'See more: https://docs.workato.com/developing-connectors/sdk/guides/authentication/multi_auth.html'
       end
 

data/lib/workato/cli/push_command.rb

@@ -35,8 +35,8 @@ module Workato
         @api_base_url = ENVIRONMENTS.fetch(options[:environment]) do
           options[:environment].presence || Workato::Connector::Sdk::WORKATO_BASE_URL
         end
-        @api_email = options[:api_email] || ENV[Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV]
-        @api_token = options[:api_token] || ENV[Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV]
+        @api_email = options[:api_email] || ENV.fetch(Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV, nil)
+        @api_token = options[:api_token] || ENV.fetch(Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV, nil)
         @folder_id = options[:folder]
       end
 

data/lib/workato/cli/schema_command.rb

@@ -12,8 +12,8 @@ module Workato
       API_GENERATE_SCHEMA_PATH = '/api/sdk/generate_schema'
 
       def initialize(options:)
-        @api_email = options[:api_email] || ENV[Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV]
-        @api_token = options[:api_token] || ENV[Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV]
+        @api_email = options[:api_email] || ENV.fetch(Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV, nil)
+        @api_token = options[:api_token] || ENV.fetch(Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV, nil)
         @options = options
       end
 

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

@@ -29,9 +29,9 @@ module Workato
         end
 
         def self.from_csv(path = './account_properties.csv')
-          props = CSV.foreach(path, headers: true, return_headers: false).map do |row|
+          props = CSV.foreach(path, headers: true, return_headers: false).to_h do |row|
             [row[0], row[1]]
-          end.to_h
+          end
           instance.load_data(props)
         end
 

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

@@ -11,29 +11,34 @@ module Workato
         extend T::Sig
         using BlockInvocationRefinements
 
+        include Dsl::ReinvokeAfter
+
         RETRY_DEFAULT_CODES = T.let([429, 500, 502, 503, 504, 507].freeze, T::Array[Integer])
         RETRY_DEFAULT_METHODS = T.let(%i[get head].freeze, T::Array[Symbol])
         RETRY_DELAY = T.let(5, Integer) # seconds
+        RETRY_DELAY_EXP_BASE = T.let(2, Integer)
         MAX_RETRIES = 3
 
-        MAX_REINVOKES = 5
-
         sig do
           params(
             action: SorbetTypes::SourceHash,
             methods: SorbetTypes::SourceHash,
             connection: Connection,
-            object_definitions: T.nilable(ObjectDefinitions)
+            object_definitions: T.nilable(ObjectDefinitions),
+            streams: Streams
           ).void
         end
-        def initialize(action:, methods: {}, connection: Connection.new, object_definitions: nil)
+        def initialize(action:, methods: {}, connection: Connection.new, object_definitions: nil,
+                       streams: ProhibitedStreams.new)
           super(
             operation: action,
             connection: connection,
             methods: methods,
-            object_definitions: object_definitions
+            object_definitions: object_definitions,
+            streams: streams
           )
 
+          @retry_delay_factor = T.let(1, Integer)
           @retries_left = T.let(0, Integer)
           @retry_codes = T.let([], T::Array[Integer])
           @retry_methods = T.let([], T::Array[String])
@@ -58,33 +63,21 @@ module Workato
                     &block)
           raise InvalidDefinitionError, "'execute' block is required for action" unless block || action[:execute]
 
-          loop do
-            if @reinvokes_remaining&.zero?
-              raise "Max number of reinvokes on SDK Gem reached. Current limit is #{reinvoke_limit}"
-            end
-
-            reinvoke_sleep if @reinvoke_after
-
-            reinvoke_reset
-
-            result = super(
+          loop_reinvoke_after(continue) do |next_continue|
+            return super(
               settings,
               input,
               extended_input_schema,
               extended_output_schema,
-              continue,
+              next_continue,
               &(block || action[:execute])
             )
-
-            break result unless @reinvoke_after
-
-            continue = @reinvoke_after.continue
           end
-        rescue RequestError => e
+        rescue RequestFailedError => e
           raise e unless retry?(e)
 
           @retries_left -= 1
-          sleep(RETRY_DELAY)
+          retry_sleep
           retry
         end
 
@@ -100,32 +93,6 @@ module Workato
           apply_output_schema(output, output_schema)
         end
 
-        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: Integer,
-            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
-          @reinvokes_remaining = T.let(@reinvokes_remaining, T.nilable(Integer))
-          @reinvokes_remaining = (@reinvokes_remaining ? @reinvokes_remaining - 1 : reinvoke_limit)
-          @reinvoke_after = ReinvokeAfter.new(
-            seconds: seconds,
-            continue: continue
-          )
-        end
-
         private
 
         sig { returns(T::Array[T.any(Symbol, String, Regexp, Integer)]) }
@@ -150,10 +117,10 @@ module Workato
           retry_on_response.each { |m| m.is_a?(::Integer) ? @retry_codes << m : @retry_matchers << m }
           @retry_codes = RETRY_DEFAULT_CODES if @retry_codes.empty?
           @retry_methods = (retry_on_request.presence || RETRY_DEFAULT_METHODS).map(&:to_s).map(&:downcase)
-          @retries_left = [[max_retries.is_a?(::Integer) && max_retries || MAX_RETRIES, MAX_RETRIES].min, 0].max
+          @retries_left = [[(max_retries.is_a?(::Integer) && max_retries) || MAX_RETRIES, MAX_RETRIES].min, 0].max
         end
 
-        sig { params(exception: RequestError).returns(T::Boolean) }
+        sig { params(exception: RequestFailedError).returns(T::Boolean) }
         def retry?(exception)
           return false unless @retries_left.positive?
           return false unless @retry_codes.include?(exception.code.to_i)
@@ -165,28 +132,11 @@ module Workato
         end
 
         sig { void }
-        def reinvoke_sleep
-          sleep((ENV['WAIT_REINVOKE_AFTER'].presence || T.must(@reinvoke_after).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
-
-        sig { void }
-        def reinvoke_reset
-          @reinvoke_after = T.let(nil, T.nilable(ReinvokeAfter))
+        def retry_sleep
+          sleep(@retry_delay_factor * RETRY_DELAY)
+          @retry_delay_factor *= RETRY_DELAY_EXP_BASE
         end
 
-        class ReinvokeAfter < T::Struct
-          prop :seconds, T.any(Float, Integer)
-          prop :continue, T::Hash[T.untyped, T.untyped]
-        end
-
-        private_constant :ReinvokeAfter
-
         alias action operation
       end
     end

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

@@ -6,25 +6,17 @@ module Workato
     module Sdk
       # match proc's arguments, even if it's a lambda.
       module BlockInvocationRefinements
-        module CallRefinement
+        refine Proc do
           def call(*args, &block)
             super(*args.take(parameters.length), &block)
           end
         end
 
-        refine Proc do
-          prepend CallRefinement
-        end
-
-        module InstanceExecRefinement
+        refine BasicObject do
           def instance_exec(*args, &block)
             super(*args.take(block.parameters.length), &block)
           end
         end
-
-        refine BasicObject do
-          prepend InstanceExecRefinement
-        end
       end
     end
   end