workato-connector-sdk 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 053e48199f2b1406ef47a84fb43d7b7d0cc74d74ce0f1f1b650c01fc422bc683
-  data.tar.gz: e2155ca61c45230234b105ff0f4ab033205c86b49b35838d88e8a8e473a957b3
+  metadata.gz: 0e0a739fc6bc5fe15228d209dc24ac4858c3815b4252b5f6d9abd9ae0644b15d
+  data.tar.gz: d4089c8dc7f6c8f9bd171730797a7b82eeb3192883d4b5883a5998985a20001a
 SHA512:
-  metadata.gz: 4d34393bda1fc5eef5e138c7e742a2a05a7c1ced8fb5a4a8969a1770473c4534cf015c7096cf17a18eb69c669301ca8761ff51a88b3ee8a04ad4550467a23588
-  data.tar.gz: b293f65e21f45ef2bab573d687cd12cd77981a7375bec619ce45561ead9e96f895f633e65910dad7226213daacb38b95453c890b96e7b7a957b5085e5055ff94
+  metadata.gz: f6a00086288382c03c024f351e69ca79749d6ef41a833141140274926bec885a7382ce505e9b4981c05a465efa2f1c97cb30697906b8ba6c63d02709dedc9de7
+  data.tar.gz: b5b289bf86ac5970420e20762609256a6280f00a76ae604fcff206f65f40abb517f22c2207f93f1d439b250e4d725e4a5a91865904bf32c93459c52c932e70b3

data/README.md

@@ -13,9 +13,10 @@ 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)
    
 ```bash
 ruby -v
@@ -1123,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,12 +1,17 @@
-# 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
       include Thor::Shell
+      include MultiAuthSelectedFallback
 
       DebugExceptionError = Class.new(StandardError)
 
@@ -19,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
 
@@ -63,8 +68,12 @@ module Workato
           oauth2_code: options[:oauth2_code],
           redirect_url: options[:redirect_url],
           refresh_token: options[:refresh_token],
-          recipe_id: SecureRandom.uuid
-        }
+          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
@@ -84,25 +93,30 @@ module Workato
         )
         @settings = settings_store.read
 
-        Workato::Connector::Sdk::Connection.on_settings_update = lambda do |message, &refresher|
-          begin
-            $stdout.pause if verbose?
-            say('')
-            say(message)
+        Workato::Connector::Sdk::Connection.multi_auth_selected_fallback = lambda do |options|
+          next @selected_auth_type if @selected_auth_type
+
+          with_user_interaction do
+            @selected_auth_type = multi_auth_selected_fallback(options)
+          end
+        end
 
-            new_settings = refresher.call
-            break unless new_settings
+        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
+              say(message)
               answer = ask('Updated settings file with new connection attributes? (Yes or No)').to_s.downcase
               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
-          ensure
-            $stdout.resume if verbose?
           end
         end
 
@@ -130,7 +144,12 @@ 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" \
+              "- 'selected' block is defined and returns value from 'options' list\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]
 
@@ -139,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
@@ -181,6 +198,16 @@ module Workato
         output
       end
 
+      def with_user_interaction
+        $stdout.pause if verbose?
+        say('')
+
+        yield
+      ensure
+        say('')
+        $stdout.resume if verbose?
+      end
+
       class ProgressLogger < SimpleDelegator
         def initialize(progress)
           super($stdout)
@@ -194,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/multi_auth_selected_fallback.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Workato
+  module CLI
+    module MultiAuthSelectedFallback
+      private
+
+      def multi_auth_selected_fallback(options)
+        say('Please select current auth type for multi-auth connector:')
+        options = options.keys
+        options.each_with_index do |option, idx|
+          say "[#{idx + 1}] #{option}"
+        end
+        say '[q] <exit>'
+        say('')
+
+        multi_auth_selected_fallback = loop do
+          answer = ask('Your choice:').to_s.downcase
+          break if answer == 'q'
+          next unless /\d+/ =~ answer && options[answer.to_i - 1]
+
+          break options[answer.to_i - 1]
+        end
+        return unless multi_auth_selected_fallback
+
+        say('')
+        say('Put selected auth type in your settings file to avoid this message in future')
+
+        multi_auth_selected_fallback
+      end
+    end
+  end
+end

data/lib/workato/cli/oauth2_command.rb

@@ -3,11 +3,13 @@
 
 require 'securerandom'
 require 'workato/web/app'
+require_relative './multi_auth_selected_fallback'
 
 module Workato
   module CLI
     class OAuth2Command
       include Thor::Shell
+      include MultiAuthSelectedFallback
 
       AWAIT_CODE_TIMEOUT_INTERVAL = 180 # seconds
       AWAIT_CODE_SLEEP_INTERVAL = 5 # seconds
@@ -24,6 +26,7 @@ module Workato
       end
 
       def call
+        ensure_oauth2_type
         require_gems
         start_webrick
 
@@ -94,16 +97,31 @@ module Workato
       end
 
       def stop_webrick
+        return unless @thread
+
         Rack::Handler::WEBrick.shutdown
         @thread.exit
       end
 
+      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. ' \
+                "Expected: 'oauth2', got: '#{connector.connection.authorization.type}''"
+        end
+      rescue Workato::Connector::Sdk::InvalidMultiAuthDefinition => e
+        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" \
+              'See more: https://docs.workato.com/developing-connectors/sdk/guides/authentication/multi_auth.html'
+      end
+
       def client
         @client ||= OAuth2::Client.new(
-          connector.connection.authorization.client_id(settings),
-          connector.connection.authorization.client_secret(settings),
-          site: connector.connection.base_uri(settings),
-          token_url: connector.connection.authorization.token_url(settings),
+          connector.connection.authorization.client_id,
+          connector.connection.authorization.client_secret,
+          site: connector.connection.base_uri,
+          token_url: connector.connection.authorization.token_url,
           redirect_uri: redirect_url
         )
       end
@@ -112,14 +130,14 @@ module Workato
         return @authorize_url if defined?(@authorize_url)
 
         @authorize_url =
-          if (authorization_url = connector.connection.authorization.authorization_url(settings))
+          if (authorization_url = connector.connection.authorization.authorization_url)
             params = {
               state: SecureRandom.hex(8),
-              client_id: connector.connection.authorization.client_id(settings),
+              client_id: connector.connection.authorization.client_id,
               redirect_uri: redirect_url
-            }
+            }.with_indifferent_access
             uri = URI(authorization_url)
-            uri.query = params.with_indifferent_access.merge(Rack::Utils.parse_nested_query(uri.query || '')).to_param
+            uri.query = params.merge(Rack::Utils.parse_nested_query(uri.query || '')).to_param
             uri.to_s
           end
       end
@@ -133,12 +151,25 @@ module Workato
       end
 
       def settings
-        @settings ||= settings_store.read
+        return @settings if defined?(@settings)
+
+        @settings = settings_store.read
+
+        Workato::Connector::Sdk::Connection.multi_auth_selected_fallback = lambda do |options|
+          next @selected_auth_type if @selected_auth_type
+
+          with_user_interaction do
+            @selected_auth_type = multi_auth_selected_fallback(options)
+          end
+        end
+
+        @settings
       end
 
       def connector
         @connector ||= Workato::Connector::Sdk::Connector.from_file(
-          options[:connector] || Workato::Connector::Sdk::DEFAULT_CONNECTOR_PATH
+          options[:connector] || Workato::Connector::Sdk::DEFAULT_CONNECTOR_PATH,
+          settings
         )
       end
 
@@ -156,8 +187,8 @@ module Workato
       end
 
       def acquire_token(code)
-        if connector.source.dig(:connection, :authorization, :acquire)
-          tokens, _, extra_settings = connector.connection.authorization.acquire(settings, await_code, redirect_url)
+        if connector.connection.authorization.source[:acquire]
+          tokens, _, extra_settings = connector.connection.authorization.acquire(nil, code, redirect_url)
           tokens ||= {}
           extra_settings ||= {}
           extra_settings.merge(tokens)
@@ -178,6 +209,13 @@ module Workato
         response = http.request(request)
         response.body
       end
+
+      def with_user_interaction
+        say('')
+        yield
+      ensure
+        say('')
+      end
     end
   end
 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