workato-connector-sdk 0.5.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: d8d30836873d60dede61747b573f51864653aeabc2831f173663db68f42479c5
-  data.tar.gz: 19c2031601b7f63b317c42f081cf08044e3b75f3feefabc4f557f86b95f5e3c5
+SHA1:
+  metadata.gz: f52b011085690e264b4e2082fb2f13c1375e74fe
+  data.tar.gz: 190c0bc7e6264ab9524acdda484e07154dd0b2b8
 SHA512:
-  metadata.gz: e378b75932e66e5e9399870981d62473cdfe14f98facaebefc7de3faaf27e1382b17b6f019c45530f7130d9c81498ae3410bf2278ba67e29efd73fb6790e8c1e
-  data.tar.gz: 8d6a10d7e30515c7e6c86a9eb1cc2f88794d05bf42b0ccc2d3a24ac094134a8fd8a4cb3a7a8c321c2b786cc22a8825b26945a30b0d6eaa4de8d9451beefe3b42
+  metadata.gz: 29480d50f931dec0b0f18bf8f7c97f0a6029dd2656ba367ce0a3015a2a32e961bca9981083e01455d9c65cba2244dea5491b34d02e18a9cb8c4ac1a02f9a1d85
+  data.tar.gz: 1681f2fc8fc0eec6949361ae49ae26fdea3372eab98fb745e9d4a55d192b0e74a34d446655d2b5b08ede89d09cf748d4610ef86b08bab3210165de961004bbb6

data/README.md

@@ -265,27 +265,28 @@ Usage:
   workato exec <PATH>
 
 Options:
-  -c, [--connector=CONNECTOR]                            # Path to connector source code
-  -s, [--settings=SETTINGS]                              # Path to plain or encrypted file with connection configs, passwords, tokens, secrets etc
-  -n, [--connection=CONNECTION]                          # Connection name if settings file contains multiple settings
-  -k, [--key=KEY]                                        # Path to file with encrypt/decrypt key. NOTE: key from WORKATO_CONNECTOR_MASTER_KEY has higher priority
-  -i, [--input=INPUT]                                    # Path to file with input JSON
-      [--closure=CLOSURE]                                # Path to file with next poll closure JSON
-      [--continue=CONTINUE]                              # Path to file with next multistep action continue closure JSON
-  -a, [--args=ARGS]                                      # Path to file with method arguments JSON
-      [--extended-input-schema=EXTENDED_INPUT_SCHEMA]    # Path to file with extended input schema definition JSON
-      [--extended-output-schema=EXTENDED_OUTPUT_SCHEMA]  # Path to file with extended output schema definition JSON
-      [--config-fields=CONFIG_FIELDS]                    # Path to file with config fields JSON
-  -w, [--webhook-payload=WEBHOOK_PAYLOAD]                # Path to file with webhook payload JSON
-      [--webhook-params=WEBHOOK_PARAMS]                  # Path to file with webhook params JSON
-      [--webhook-headers=WEBHOOK_HEADERS]                # Path to file with webhook headers JSON
-      [--webhook-url=WEBHOOK_URL]                        # Webhook URL for automatic webhook subscription
-  -o, [--output=OUTPUT]                                  # Write output to JSON file
-      [--oauth2-code=OAUTH2_CODE]                        # OAuth2 code exchange to tokens pair
-      [--redirect-url=REDIRECT_URL]                      # OAuth2 callback url
-      [--refresh-token=REFRESH_TOKEN]                    # OAuth2 refresh token
-      [--debug], [--no-debug]                            
-      [--verbose], [--no-verbose]                        
+  -c, [--connector=CONNECTOR]                                # Path to connector source code
+  -s, [--settings=SETTINGS]                                  # Path to plain or encrypted file with connection configs, passwords, tokens, secrets etc
+  -n, [--connection=CONNECTION]                              # Connection name if settings file contains multiple settings
+  -k, [--key=KEY]                                            # Path to file with encrypt/decrypt key. NOTE: key from WORKATO_CONNECTOR_MASTER_KEY has higher priority
+  -i, [--input=INPUT]                                        # Path to file with input JSON
+      [--closure=CLOSURE]                                    # Path to file with next poll closure JSON
+      [--continue=CONTINUE]                                  # Path to file with next multistep action continue closure JSON
+  -a, [--args=ARGS]                                          # Path to file with method arguments JSON
+      [--extended-input-schema=EXTENDED_INPUT_SCHEMA]        # Path to file with extended input schema definition JSON
+      [--extended-output-schema=EXTENDED_OUTPUT_SCHEMA]      # Path to file with extended output schema definition JSON
+      [--config-fields=CONFIG_FIELDS]                        # Path to file with config fields JSON
+  -w, [--webhook-payload=WEBHOOK_PAYLOAD]                    # Path to file with webhook payload JSON
+      [--webhook-params=WEBHOOK_PARAMS]                      # Path to file with webhook params JSON
+      [--webhook-headers=WEBHOOK_HEADERS]                    # Path to file with webhook headers JSON
+      [--webhook-subscribe-output=WEBHOOK_SUBSCRIBE_OUTPUT]  # Path to file with webhook subscribe output JSON
+      [--webhook-url=WEBHOOK_URL]                            # Webhook URL for automatic webhook subscription
+  -o, [--output=OUTPUT]                                      # Write output to JSON file
+      [--oauth2-code=OAUTH2_CODE]                            # OAuth2 code exchange to tokens pair
+      [--redirect-url=REDIRECT_URL]                          # OAuth2 callback url
+      [--refresh-token=REFRESH_TOKEN]                        # OAuth2 refresh token
+      [--debug], [--no-debug]
+      [--verbose], [--no-verbose]                    
 
 Description:
   The 'workato exec' executes connector's lambda block at <PATH>. Lambda's parameters can be provided if needed, see options part.
@@ -319,7 +320,26 @@ Commands:
   workato generate test            # Generate empty test for connector
 ```
 
-**NOTE: `workato generate schema` is currently not implemented.**
+### 3.4.1 workato generate schema
+Use command to generate Workato Schema from a sample file. Supported inputs csv, json
+
+```
+workato generate help schema
+
+Usage:
+  workato generate schema
+
+Options:
+  [--json=JSON]            # Path to JSON sample file
+  [--csv=CSV]              # Path to CSV sample file
+  [--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
+```
+
+### 3.4.2 workato generate test
 
 - Use `workato generate test` to generate tests based on your connector.rb file.
 
@@ -400,8 +420,8 @@ 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 or set WORKATO_API_EMAIL env
-      [--api-token=API_TOKEN]      # Token for accessing Workato API or set WORKATO_API_TOKEN env
+      [--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
       [--environment=ENVIRONMENT]  # Server to push connector code to
                                    # Default: live
                                    # Possible values: preview, preview-eu, live, live-eu

data/lib/workato/cli/edit_command.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'active_support/encrypted_configuration'
@@ -33,9 +34,9 @@ module Workato
 
       private
 
-      attr_reader :key_path,
-                  :encrypted_file_path,
-                  :encrypted_config
+      attr_reader :key_path
+      attr_reader :encrypted_file_path
+      attr_reader :encrypted_config
 
       def ensure_encryption_key_present
         return if encrypted_config.key.present?

data/lib/workato/cli/exec_command.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'thor'
@@ -24,8 +25,8 @@ module Workato
 
       private
 
-      attr_reader :path,
-                  :options
+      attr_reader :path
+      attr_reader :options
 
       # rubocop:disable Style/GuardClause
       def load_from_default_files
@@ -46,11 +47,9 @@ module Workato
 
       def params
         @params ||= {
-          connector: connector,
           settings: settings,
           input: from_json(options[:input]),
-          output: from_json(options[:input]),
-          webhook_subscribe_output: from_json(options[:input]),
+          webhook_subscribe_output: from_json(options[:webhook_subscribe_output]),
           args: from_json(options[:args]).presence || [],
           extended_input_schema: from_json(options[:extended_input_schema]).presence || [],
           extended_output_schema: from_json(options[:extended_output_schema]).presence || [],
@@ -69,7 +68,7 @@ module Workato
       end
 
       def connector
-        Workato::Connector::Sdk::Connector.from_file(
+        @connector ||= Workato::Connector::Sdk::Connector.from_file(
           options[:connector] || Workato::Connector::Sdk::DEFAULT_CONNECTOR_PATH,
           settings
         )
@@ -85,16 +84,23 @@ module Workato
         )
         @settings = settings_store.read
 
-        Workato::Connector::Sdk::Operation.on_settings_updated = lambda do |message, new_settings|
-          $stdout.pause if verbose?
-          say('')
-          say(message)
-          loop do
-            answer = ask('Updated settings file with new connection attributes? (Yes or No)').to_s.downcase
-            break if %w[n no].include?(answer)
-            break settings_store.update(new_settings) if %w[y yes].include?(answer)
+        Workato::Connector::Sdk::Connection.on_settings_update = lambda do |message, &refresher|
+          begin
+            $stdout.pause if verbose?
+            say('')
+            say(message)
+            new_settings = refresher.call
+            loop do
+              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_store.update(new_settings)
+              break new_settings
+            end
+          ensure
+            $stdout.resume if verbose?
           end
-          $stdout.resume if verbose?
         end
 
         @settings
@@ -103,9 +109,9 @@ module Workato
       def from_json(path, parse_json_times: false)
         old_parse_json_times = ActiveSupport.parse_json_times
         ::ActiveSupport.parse_json_times = parse_json_times
-        result = path ? ::ActiveSupport::JSON.decode(File.read(path)) : {}
+        path ? ::ActiveSupport::JSON.decode(File.read(path)) : {}
+      ensure
         ::ActiveSupport.parse_json_times = old_parse_json_times
-        result
       end
 
       def inspect_params(params)
@@ -121,30 +127,13 @@ module Workato
       end
 
       def execute_path
-        methods = path.split('.')
-        method = methods.pop
-        object = methods.inject(params[:connector]) { |obj, m| obj.public_send(m) }
-        output = invoke_method(object, method)
-        if output.respond_to?(:invoke)
-          invoke_method(output, :invoke)
-        else
-          output
-        end
+        connector.invoke(path, params)
       rescue Exception => e # rubocop:disable Lint/RescueException
         raise DebugExceptionError, e if options[:debug]
 
         raise
       end
 
-      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
-
       def show_output(output)
         if options[:output].present?
           File.open(options[:output], 'w') do |f|

data/lib/workato/cli/generate_command.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Workato
@@ -45,17 +46,17 @@ module Workato
       method_option :csv, type: :string, desc: 'Path to CSV sample file'
       method_option :col_sep,
                     type: :string,
-                    desc: 'Use separator for CSV convertor',
+                    desc: 'Use separator for CSV converter',
                     enum: SchemaCommand::CSV_SEPARATORS,
                     default: 'comma'
       method_option :api_email,
                     type: :string,
                     desc: 'Email for accessing Workato API or '\
-                          "set #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} env"
+                          "set #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} environment variable"
       method_option :api_token,
                     type: :string,
                     desc: 'Token for accessing Workato API or ' \
-                          "set #{Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV} env"
+                          "set #{Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV} environment variable"
 
       long_desc <<~HELP
         The 'workato generate schema' command generates Workato Schema from a sample file.

data/lib/workato/cli/generators/connector_generator.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Workato

data/lib/workato/cli/generators/master_key_generator.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Workato

data/lib/workato/cli/main.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'thor'
@@ -54,6 +55,7 @@ module Workato
       method_option :webhook_payload, type: :string, aliases: '-w', desc: 'Path to file with webhook payload JSON'
       method_option :webhook_params, type: :string, desc: 'Path to file with webhook params JSON'
       method_option :webhook_headers, type: :string, desc: 'Path to file with webhook headers JSON'
+      method_option :webhook_subscribe_output, type: :string, desc: 'Path to file with webhook subscribe output JSON'
       method_option :webhook_url, type: :string, desc: 'Webhook URL for automatic webhook subscription'
       method_option :output, type: :string, aliases: '-o', desc: 'Write output to JSON file'
       method_option :oauth2_code, type: :string, desc: 'OAuth2 code exchange to tokens pair'
@@ -126,11 +128,11 @@ module Workato
       method_option :api_email,
                     type: :string,
                     desc: 'Email for accessing Workato API or '\
-                          "set #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} env"
+                          "set #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} environment variable"
       method_option :api_token,
                     type: :string,
                     desc: 'Token for accessing Workato API or ' \
-                          "set #{Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV} env"
+                          "set #{Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV} environment variable"
       method_option :environment,
                     type: :string,
                     enum: Workato::CLI::PushCommand::ENVIRONMENTS.keys,

data/lib/workato/cli/oauth2_command.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'securerandom'
@@ -55,11 +56,11 @@ module Workato
 
       private
 
-      attr_reader :https,
-                  :base_url,
-                  :redirect_url,
-                  :port,
-                  :options
+      attr_reader :https
+      attr_reader :base_url
+      attr_reader :redirect_url
+      attr_reader :port
+      attr_reader :options
 
       def verbose?
         !!options[:verbose]

data/lib/workato/cli/push_command.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'uri'
@@ -55,10 +56,10 @@ module Workato
 
       private
 
-      attr_reader :options,
-                  :api_token,
-                  :api_email,
-                  :api_base_url
+      attr_reader :options
+      attr_reader :api_token
+      attr_reader :api_email
+      attr_reader :api_base_url
 
       def verbose?
         @options[:verbose]

data/lib/workato/cli/schema_command.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Workato
@@ -31,9 +32,9 @@ module Workato
 
       private
 
-      attr_reader :options,
-                  :api_token,
-                  :api_email
+      attr_reader :options
+      attr_reader :api_token
+      attr_reader :api_email
 
       def verbose?
         @options[:verbose]

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'csv'

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

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 require_relative './operation'
@@ -7,27 +8,52 @@ module Workato
   module Connector
     module Sdk
       class Action < Operation
+        extend T::Sig
         using BlockInvocationRefinements
 
-        RETRY_DEFAULT_CODES = [429, 500, 502, 503, 504, 507].freeze
-        RETRY_DEFAULT_METHODS = %i[get head].freeze
-        RETRY_DELAY = 5.seconds
+        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
         MAX_RETRIES = 3
 
         MAX_REINVOKES = 5
 
-        def initialize(action:, connection: {}, methods: {}, settings: {}, object_definitions: nil)
+        sig do
+          params(
+            action: SorbetTypes::SourceHash,
+            methods: SorbetTypes::SourceHash,
+            connection: Connection,
+            object_definitions: T.nilable(ObjectDefinitions)
+          ).void
+        end
+        def initialize(action:, methods: {}, connection: Connection.new, object_definitions: nil)
           super(
             operation: action,
             connection: connection,
             methods: methods,
-            settings: settings,
             object_definitions: object_definitions
           )
 
+          @retries_left = T.let(0, Integer)
+          @retry_codes = T.let([], T::Array[Integer])
+          @retry_methods = T.let([], T::Array[String])
+          @retry_matchers = T.let([], T::Array[T.any(Symbol, String, Regexp)])
+
           initialize_retry
         end
 
+        sig do
+          params(
+            settings: T.nilable(SorbetTypes::SettingsHash),
+            input: SorbetTypes::OperationInputHash,
+            extended_input_schema: SorbetTypes::OperationSchema,
+            extended_output_schema: SorbetTypes::OperationSchema,
+            continue: T::Hash[T.any(Symbol, String), T.untyped],
+            block: T.nilable(SorbetTypes::OperationExecuteProc)
+          ).returns(
+            T.untyped
+          )
+        end
         def execute(settings = nil, input = {}, extended_input_schema = [], extended_output_schema = [], continue = {},
                     &block)
           raise InvalidDefinitionError, "'execute' block is required for action" unless block || action[:execute]
@@ -39,7 +65,7 @@ module Workato
 
             reinvoke_sleep if @reinvoke_after
 
-            @reinvoke_after = nil
+            reinvoke_reset
 
             result = super(
               settings,
@@ -52,15 +78,17 @@ module Workato
 
             break result unless @reinvoke_after
 
-            continue = @reinvoke_after[:continue]
+            continue = @reinvoke_after.continue
           end
         rescue RequestError => e
           raise e unless retry?(e)
 
           @retries_left -= 1
-          sleep(RETRY_DELAY) && retry
+          sleep(RETRY_DELAY)
+          retry
         end
 
+        sig { params(input: SorbetTypes::OperationInputHash).returns(T::Hash[T.any(String, Symbol), T.untyped]) }
         def invoke(input = {})
           extended_schema = extended_schema(nil, input)
           config_schema = Schema.new(schema: config_fields_schema)
@@ -72,63 +100,93 @@ 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
 
-        def reinvoke_after(seconds:, continue:, temp_output: nil)
+        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 = {
+          @reinvoke_after = ReinvokeAfter.new(
             seconds: seconds,
-            continue: continue,
-            temp_output: temp_output
-          }
+            continue: continue
+          )
         end
 
         private
 
+        sig { returns(T::Array[T.any(Symbol, String, Regexp, Integer)]) }
         def retry_on_response
           Array(action[:retry_on_response])
         end
 
+        sig { returns(T::Array[T.any(Symbol, String, Regexp, Integer)]) }
         def retry_on_request
           Array(action[:retry_on_request])
         end
 
+        sig { returns(T.nilable(Integer)) }
         def max_retries
           action[:max_retries]
         end
 
+        sig { void }
         def initialize_retry
-          @retries_left = 0
           return if retry_on_response.blank?
 
-          @retry_codes = []
-          @retry_matchers = []
           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
         end
 
+        sig { params(exception: RequestError).returns(T::Boolean) }
         def retry?(exception)
-          return unless @retries_left.positive?
-          return unless @retry_codes.include?(exception.code.to_i)
-          return unless @retry_matchers.empty? || @retry_matchers.any? do |m|
+          return false unless @retries_left.positive?
+          return false unless @retry_codes.include?(exception.code.to_i)
+          return false unless @retry_matchers.empty? || @retry_matchers.any? do |m|
             m === exception.message || m === exception.response
           end
 
           @retry_methods.include?(exception.method.to_s.downcase)
         end
 
+        sig { void }
         def reinvoke_sleep
-          sleep((ENV['WAIT_REINVOKE_AFTER'].presence || @reinvoke_after[:seconds]).to_f)
+          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))
+        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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Workato