workato-connector-sdk 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: b81c1b9e954ad72d48fdf3a32fa33cb3de02a3115d00e14868226234c98f32ee
-  data.tar.gz: 22b5572360e2dfd03938acc98857fdd9c8e0bb9d097af83aaf871404bb3312ff
+SHA1:
+  metadata.gz: 1b501416ca8344b57fb05ebc9b48b3f1b19a4f4e
+  data.tar.gz: 47666c7e297ead213ca1228c38d3ed15dfbd699d
 SHA512:
-  metadata.gz: d9d2044bf8f7959198c2a5ee791661dd4be30a5474b74dc6c40ea8b359b99e8d1acfd965b44727c27194e5a8efab8f3d50f6703370ef0a4a00868034d1ca80d9
-  data.tar.gz: a40cbb8272f22247b29be7b15be2708f1339329e771fd2a994ac9e174ddb67c2bba0e0a0474fe5a68fcd457220d884b0e56f50321b9611f436136202881d17f7
+  metadata.gz: 266afec14bd2e2b5dcb4104df330d9cb8f96bac11a1d8d6e9199ca3bbd0576c35ff35475ef7b661610cdeef9292d36c4091cd744cac095a8d067a42dc2ccd7da
+  data.tar.gz: c1c1437158f46a43ab50102ce55d2846f76310d417fc130ca8d6aae1c0e34b7d962f26687929466cb94eb1859e5ab82d596c5eab736dd08e87ff0ae2dfdeeef7

data/README.md

@@ -39,6 +39,7 @@ Commands:
   workato generate <SUBCOMMAND>  # Generates code from template
   workato help [COMMAND]         # Describe available commands or one specific command
   workato new <CONNECTOR_PATH>   # Inits new connector folder
+  workato oauth2                 # Implements OAuth Authorization Code flow
   workato push                   # Upload and release connector's code
 
 Options:
@@ -224,6 +225,7 @@ Commands:
   workato generate <SUBCOMMAND>  # Generates code from template
   workato help [COMMAND]         # Describe available commands or one specific command
   workato new <CONNECTOR_PATH>   # Inits new connector folder
+  workato oauth2                 # Implements OAuth Authorization Code flow
   workato push                   # Upload and release connector's code
 
 Options:
@@ -259,7 +261,6 @@ Edit encrypted file, e.g. settings.yaml.enc
 ### 3.3 workato exec
 ```
 workato help exec
-
 Usage:
   workato exec <PATH>
 
@@ -270,6 +271,7 @@ Options:
   -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
@@ -279,8 +281,11 @@ Options:
       [--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
-      [--debug], [--no-debug]
-      [--verbose], [--no-verbose]
+      [--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.
@@ -358,7 +363,31 @@ Please select default HTTP mocking behavior suitable for your project?
 
 - `simple` means your HTTP requests will be stored in plain text.
 
-### 3.6 workato push
+### 3.6 workato oauth2
+```
+workato help oauth2
+
+Usage:
+  workato oauth2
+
+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
+      [--port=PORT]                # Listen requests on specific port
+                                   # Default: 45555
+      [--ip=IP]                    # Listen requests on specific interface
+                                   # Default: 127.0.0.1
+      [--https], [--no-https]      # Start HTTPS server using self-signed certificate
+      [--verbose], [--no-verbose]  
+
+Implements OAuth Authorization Code flow
+```
+
+Use this to implement the OAuth2 Authorization code grant flow for applicable connectors. Applicable connectors are ones where the connection hash has `type: 'oauth2`. For more information, check out our guide on our [main docs site](https://docs.workato.com/developing-connectors/sdk/guides/authentication/oauth/auth-code.html#how-to-guide-oauth-2-0-authorization-code-variant).
+
+### 3.7 workato push
 ```
 workato help push
 
@@ -490,7 +519,7 @@ workato exec test #Output of the test: lambda function should be shown
 > *Note*: You may also see a intermediary command from the Gem asking if you'd like to refresh your access tokens. This is done when HTTP requests are made which have a response that triggers the `refresh_on` block. Selecting yes would cause the Gem to update your settings file with the latest auth credentials.
 
 ### 4.3 Example: Testing your connection on CLI - OAuth 2 - auth code grant flows
-For auth code grant flows, the Workato Gem doesn't simulate the browser popup so you'll need to supply the access token and refresh tokens directly!
+For auth code grant flows, the Workato Gem allows you to simulate the OAuth2 flow using the `workato oauth2` command.
 
 ```ruby
 {
@@ -574,27 +603,24 @@ For auth code grant flows, the Workato Gem doesn't simulate the browser popup so
 and a `settings.yaml.enc` or `settings.yaml` file with the following details
 
 ```yaml
-My Valid Connection:
-  access_token: "valid_access_token"
-  refresh_token: "valid_refresh_token"
-  user_key: "valid_user_key"
-  client_id: "valid_client_id"
-  client_secret: "valid_client_secret"
-Invalid Access Token:
-  access_token: "invalid_access_token"
-  refresh_token: "valid_refresh_token"
-  user_key: "valid_user_key"
-  client_id: "valid_client_id"
-  client_secret: "valid_client_secret"
+client_id: valid_client_id
+client_secret: valid_client_secret
 ```
 
-You can now run the following commands to verify that the `test:` lambda function you have defined is working:
+You can now run the following commands to go through the OAuth2 Authorization code flow which includes a browser popup.
 ```bash
-workato exec test  --connection='My Valid Connection' #Output of the test: lambda function should be shown
-workato exec test  --connection='Invalid Access Token' --verbose #You should see a see a set of request where the test is tried, access token receives 401 and the sequence to refresh the gem using the refresh key is used! This allows you to test how your connector refreshes a connection.
+workato oauth2 
 ```
 
-> *Note*: `--verbose` can be used to details everything, including the HTTP requests. You may also see a intermediary command from the Gem asking if you'd like to refresh your access tokens. This is done when HTTP requests are made which have a response that triggers the `refresh_on` block. Selecting yes would cause the Gem to update your settings file with the latest auth credentials.
+https://user-images.githubusercontent.com/25265275/137942408-812fa6ad-353f-4ea2-bf37-f804e2ff7b04.mov
+
+
+> *Note*: `--verbose` can be used to detail everything, including the HTTP requests.
+
+
+Now after you've successfully gone through the flow, you may be use the same `workato exec test` command to verify you're applying your token properly in your requests! Depending on when you received your token, you may also see a intermediary command from the Gem asking if you'd like to refresh your access tokens (if it has expired). This is done when HTTP requests are made which have a response that triggers the `refresh_on` block. Selecting "Yes" would cause the Gem to update your settings file with the latest auth credentials.
+
+Take note, you may also use `workato exec` to execute lambdas in your `authorization` hash like `acquire` and `refresh`. **That said, we highlight recommend you use `workato exec test` and `workato oauth2` which handle the updating of your `settings.yaml` file automatically.**
 
 ### Example: Testing a sample action on CLI
 Continuing from the previous example, let's take a look at a simple action and invoke the individual lambda functions.
@@ -633,7 +659,7 @@ Continuing from the previous example, let's take a look at a simple action and i
       end,
       
       
-      execute: lambda do |connection, input, input_schema, output_schema|
+      execute: lambda do |connection, input, input_schema, output_schema, closure|
         get("/api/v2/customers",input)
       end,
       

data/lib/workato/cli/exec_command.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'thor'
-require 'ruby-progressbar'
 
 module Workato
   module CLI
@@ -55,10 +54,14 @@ module Workato
           extended_output_schema: from_json(options[:extended_output_schema]).presence || [],
           config_fields: from_json(options[:config_fields]),
           closure: from_json(options[:closure], parse_json_times: true).presence,
+          continue: from_json(options[:continue], parse_json_times: true),
           payload: from_json(options[:webhook_payload]),
           params: from_json(options[:webhook_params]),
           headers: from_json(options[:webhook_headers]),
           webhook_url: options[:webhook_url],
+          oauth2_code: options[:oauth2_code],
+          redirect_url: options[:redirect_url],
+          refresh_token: options[:refresh_token],
           recipe_id: SecureRandom.uuid
         }
       end
@@ -149,6 +152,8 @@ module Workato
       def with_progress
         return yield unless verbose?
 
+        require 'ruby-progressbar'
+
         say('')
 
         old_stdout = $stdout

data/lib/workato/cli/main.rb

@@ -6,6 +6,7 @@ require_relative './exec_command'
 require_relative './edit_command'
 require_relative './generate_command'
 require_relative './push_command'
+require_relative './oauth2_command'
 require_relative './generators/connector_generator'
 require_relative './generators/master_key_generator'
 
@@ -42,6 +43,7 @@ module Workato
                           "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'
+      method_option :continue, type: :string, desc: 'Path to file with next multistep action continue closure JSON'
       method_option :args, type: :string, aliases: '-a', desc: 'Path to file with method arguments JSON'
       method_option :extended_input_schema, type: :string,
                                             desc: 'Path to file with extended input schema definition JSON'
@@ -53,6 +55,9 @@ module Workato
       method_option :webhook_headers, type: :string, desc: 'Path to file with webhook headers 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'
+      method_option :redirect_url, type: :string, desc: 'OAuth2 callback url'
+      method_option :refresh_token, type: :string, desc: 'OAuth2 refresh token'
 
       method_option :debug, type: :boolean
 
@@ -139,6 +144,46 @@ module Workato
           options: options
         ).call
       end
+
+      desc 'oauth2', 'Implements OAuth Authorization Code flow'
+
+      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, 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. '\
+                          "NOTE: key from #{Workato::Connector::Sdk::DEFAULT_MASTER_KEY_ENV} has higher priority"
+      method_option :port,
+                    type: :string,
+                    desc: 'Listen requests on specific port',
+                    default: Workato::CLI::OAuth2Command::DEFAULT_PORT
+      method_option :ip,
+                    type: :string,
+                    desc: 'Listen requests on specific interface',
+                    default: Workato::CLI::OAuth2Command::DEFAULT_ADDRESS
+      method_option :https,
+                    type: :boolean,
+                    desc: 'Start HTTPS server using self-signed certificate'
+
+      def oauth2
+        OAuth2Command.new(
+          options: options
+        ).call
+      end
     end
   end
 end

data/lib/workato/cli/oauth2_command.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+require 'workato/web/app'
+
+module Workato
+  module CLI
+    class OAuth2Command
+      include Thor::Shell
+
+      AWAIT_CODE_TIMEOUT_INTERVAL = 180 # seconds
+      AWAIT_CODE_SLEEP_INTERVAL = 5 # seconds
+
+      DEFAULT_ADDRESS = '127.0.0.1'
+      DEFAULT_PORT = '45555'
+
+      def initialize(options: {})
+        @options = options
+        @port = options[:port] || DEFAULT_PORT
+        @https = options[:https].is_true?
+        @base_url = "#{https ? 'https' : 'http'}://localhost:#{port}"
+        @redirect_url = "#{base_url}#{Workato::Web::App::CALLBACK_PATH}"
+      end
+
+      def call
+        require_gems
+        start_webrick
+
+        say 'Local server is running. Allow following redirect_url in your OAuth2 provider:'
+        say "\n"
+        say redirect_url
+        say ''
+
+        say_status :success, "Open #{authorize_url} in browser"
+        Launchy.open(authorize_url) do |exception|
+          raise(Error, "Attempted to open #{authorize_url} and failed because #{exception}")
+        end
+
+        code = await_code
+        say_status :success, "Receive OAuth2 code=#{code}"
+
+        tokens = acquire_token(code)
+        say_status :success, 'Receive OAuth2 tokens'
+        jj tokens if verbose?
+
+        settings_store.update(tokens)
+        say_status :success, 'Update settings file'
+      rescue Timeout::Error
+        say "Have not received callback from OAuth2 provider in #{AWAIT_CODE_TIMEOUT_INTERVAL} seconds. Aborting!"
+      rescue Errno::EADDRINUSE
+        say "Port #{port} already in use. Try to use different port with --port=#{rand(10_000..65_664)}"
+      rescue StandardError => e
+        say e.message
+      ensure
+        stop_webrick
+      end
+
+      private
+
+      attr_reader :https,
+                  :base_url,
+                  :redirect_url,
+                  :port,
+                  :options
+
+      def verbose?
+        !!options[:verbose]
+      end
+
+      def require_gems
+        require 'oauth2'
+        require 'launchy'
+        require 'rack'
+      end
+
+      def start_webrick
+        @thread = Thread.start do
+          Rack::Handler::WEBrick.run(
+            Workato::Web::App.new,
+            {
+              Port: port,
+              BindAddress: options[:ip] || DEFAULT_ADDRESS,
+              SSLEnable: https,
+              SSLVerifyClient: OpenSSL::SSL::VERIFY_NONE,
+              SSLCertName: [%w[CN localhost]]
+            }.tap do |server_options|
+              unless verbose?
+                server_options[:AccessLog] = []
+                server_options[:Logger] = WEBrick::Log.new($stderr, 0)
+              end
+            end
+          )
+        end
+        @thread.abort_on_exception = true
+      end
+
+      def stop_webrick
+        Rack::Handler::WEBrick.shutdown
+        @thread.exit
+      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),
+          redirect_uri: redirect_url
+        )
+      end
+
+      def authorize_url
+        return @authorize_url if defined?(@authorize_url)
+
+        @authorize_url =
+          if (authorization_url = connector.connection.authorization.authorization_url(settings))
+            params = {
+              client_id: connector.connection.authorization.client_id(settings),
+              redirect_uri: redirect_url
+            }
+            uri = URI(authorization_url)
+            uri.query = params.with_indifferent_access.merge(Rack::Utils.parse_nested_query(uri.query || '')).to_param
+            uri.to_s
+          end
+      end
+
+      def settings_store
+        @settings_store ||= Workato::Connector::Sdk::Settings.new(
+          path: options[:settings],
+          name: options[:connection],
+          key_path: options[:key]
+        )
+      end
+
+      def settings
+        @settings ||= settings_store.read
+      end
+
+      def connector
+        @connector ||= Workato::Connector::Sdk::Connector.from_file(
+          options[:connector] || Workato::Connector::Sdk::DEFAULT_CONNECTOR_PATH
+        )
+      end
+
+      def await_code
+        code_uri = URI("#{base_url}#{Workato::Web::App::CODE_PATH}")
+
+        Timeout.timeout(AWAIT_CODE_TIMEOUT_INTERVAL) do
+          loop do
+            response = get(code_uri) rescue nil
+            break response if response.present?
+
+            sleep(AWAIT_CODE_SLEEP_INTERVAL)
+          end
+        end
+      end
+
+      def acquire_token(code)
+        if connector.source.dig(:connection, :authorization, :acquire)
+          tokens, _, extra_settings = connector.connection.authorization.acquire(settings, await_code, redirect_url)
+          tokens ||= {}
+          extra_settings ||= {}
+          extra_settings.merge(tokens)
+        else
+          client.auth_code.get_token(code).to_hash
+        end
+      end
+
+      def get(uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        if https
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+
+        request = Net::HTTP::Get.new(uri.request_uri)
+
+        response = http.request(request)
+        response.body
+      end
+    end
+  end
+end

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

@@ -14,6 +14,8 @@ module Workato
         RETRY_DELAY = 5.seconds
         MAX_RETRIES = 3
 
+        MAX_REINVOKES = 5
+
         def initialize(action:, connection: {}, methods: {}, settings: {}, object_definitions: nil)
           super(
             operation: action,
@@ -26,10 +28,32 @@ module Workato
           initialize_retry
         end
 
-        def execute(settings = nil, input = {}, extended_input_schema = [], extended_output_schema = [], &block)
+        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]
 
-          super(settings, input, extended_input_schema, extended_output_schema, &(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_after = nil
+
+            result = super(
+              settings,
+              input,
+              extended_input_schema,
+              extended_output_schema,
+              continue,
+              &(block || action[:execute])
+            )
+
+            break result unless @reinvoke_after
+
+            continue = @reinvoke_after[:continue]
+          end
         rescue RequestError => e
           raise e unless retry?(e)
 
@@ -38,11 +62,16 @@ module Workato
         end
 
         def checkpoint!(continue:, temp_output: nil)
-          raise NotImplementedError
+          # no-op
         end
 
         def reinvoke_after(seconds:, continue:, temp_output: nil)
-          raise NotImplementedError
+          @reinvokes_remaining = (@reinvokes_remaining ? @reinvokes_remaining - 1 : reinvoke_limit)
+          @reinvoke_after = {
+            seconds: seconds,
+            continue: continue,
+            temp_output: temp_output
+          }
         end
 
         private
@@ -81,6 +110,14 @@ module Workato
           @retry_methods.include?(exception.method.to_s.downcase)
         end
 
+        def reinvoke_sleep
+          sleep((ENV['WAIT_REINVOKE_AFTER'].presence || @reinvoke_after[:seconds]).to_f)
+        end
+
+        def reinvoke_limit
+          @reinvoke_limit ||= (ENV['MAX_REINVOKES'].presence || MAX_REINVOKES).to_i
+        end
+
         alias action operation
       end
     end

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

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require_relative './block_invocation_refinements'
+
+module Workato
+  module Connector
+    module Sdk
+      class Connection
+        using BlockInvocationRefinements
+
+        attr_reader :source
+
+        def initialize(connection: {}, methods: {}, settings: {})
+          @methods_source = methods.with_indifferent_access
+          @source = connection.with_indifferent_access
+          @settings = settings
+        end
+
+        def authorization
+          @authorization ||= Authorization.new(
+            connection: source,
+            methods: methods_source,
+            settings: @settings
+          )
+        end
+
+        def base_uri(settings = {})
+          source[:base_uri]&.call(settings.with_indifferent_access)
+        end
+
+        private
+
+        attr_reader :methods_source
+
+        class Authorization
+          attr_reader :source
+
+          def initialize(connection: {}, methods: {}, settings: {})
+            @connection_source = connection.with_indifferent_access
+            @source = (connection[:authorization] || {}).with_indifferent_access
+            @methods_source = methods.with_indifferent_access
+            @settings = settings
+          end
+
+          def token_url?
+            source[:token_url].present?
+          end
+
+          def acquire?
+            source[:acquire].present?
+          end
+
+          def refresh?
+            source[:refresh].present?
+          end
+
+          def type
+            source[:type]
+          end
+
+          def refresh_on
+            Array.wrap(source[:refresh_on]).compact
+          end
+
+          def detect_on
+            Array.wrap(source[:detect_on]).compact
+          end
+
+          def client_id(settings = {})
+            client_id = source[:client_id]
+
+            if client_id.is_a?(Proc)
+              Dsl::WithDsl.execute(settings.with_indifferent_access, &client_id)
+            else
+              client_id
+            end
+          end
+
+          def client_secret(settings = {})
+            client_secret_source = source[:client_secret]
+
+            if client_secret_source.is_a?(Proc)
+              Dsl::WithDsl.execute(settings.with_indifferent_access, &client_secret_source)
+            else
+              client_secret_source
+            end
+          end
+
+          def authorization_url(settings = {})
+            source[:authorization_url]&.call(settings.with_indifferent_access)
+          end
+
+          def token_url(settings = {})
+            source[:token_url]&.call(settings.with_indifferent_access)
+          end
+
+          def acquire(settings = {}, oauth2_code = nil, redirect_url = nil)
+            acquire_proc = source[:acquire]
+            raise InvalidDefinitionError, "Expect 'acquire' block" unless acquire_proc
+
+            Workato::Connector::Sdk::Operation.new(
+              connection: Connection.new(
+                connection: connection_source.merge(
+                  authorization: source.merge(
+                    apply: nil
+                  )
+                ),
+                methods: methods_source,
+                settings: @settings
+              ),
+              methods: methods_source,
+              settings: @settings
+            ).execute(settings, { auth_code: oauth2_code, redirect_url: redirect_url }) do |connection, input|
+              instance_exec(connection, input[:auth_code], input[:redirect_url], &acquire_proc)
+            end
+          end
+
+          def refresh(settings = {}, refresh_token = nil)
+            refresh_proc = source[:refresh]
+            raise InvalidDefinitionError, "Expect 'refresh' block" unless refresh_proc
+
+            Workato::Connector::Sdk::Operation.new(
+              connection: Connection.new(
+                methods: methods_source,
+                settings: @settings
+              ),
+              methods: methods_source,
+              settings: @settings
+            ).execute(settings, { refresh_token: refresh_token }) do |connection, input|
+              instance_exec(connection, input[:refresh_token], &refresh_proc)
+            end
+          end
+
+          private
+
+          attr_reader :connection_source,
+                      :methods_source
+        end
+
+        private_constant :Authorization
+      end
+    end
+  end
+end

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

@@ -24,9 +24,9 @@ module Workato
         def actions
           @actions ||= ActionsProxy.new(
             actions: source[:actions].presence || {},
-            object_definitions: object_definitions,
             methods: methods_source,
-            connection: connection_source,
+            object_definitions: object_definitions,
+            connection: connection,
             settings: settings
           )
         end
@@ -34,7 +34,7 @@ module Workato
         def methods
           @methods ||= MethodsProxy.new(
             methods: methods_source,
-            connection: connection_source,
+            connection: connection,
             settings: settings
           )
         end
@@ -45,7 +45,7 @@ module Workato
               execute: source[:test]
             },
             methods: methods_source,
-            connection: connection_source,
+            connection: connection,
             settings: send(:settings)
           ).execute(settings)
         end
@@ -53,9 +53,9 @@ module Workato
         def triggers
           @triggers ||= TriggersProxy.new(
             triggers: source[:triggers].presence || {},
-            object_definitions: object_definitions,
             methods: methods_source,
-            connection: connection_source,
+            connection: connection,
+            object_definitions: object_definitions,
             settings: settings
           )
         end
@@ -64,7 +64,7 @@ module Workato
           @object_definitions ||= ObjectDefinitions.new(
             object_definitions: source[:object_definitions].presence || {},
             methods: methods_source,
-            connection: connection_source,
+            connection: connection,
             settings: settings
           )
         end
@@ -72,6 +72,14 @@ module Workato
         def pick_lists
           @pick_lists ||= PickListsProxy.new(
             pick_lists: source[:pick_lists].presence || {},
+            methods: methods_source,
+            connection: connection,
+            settings: settings
+          )
+        end
+
+        def connection
+          @connection ||= Connection.new(
             methods: methods_source,
             connection: connection_source,
             settings: settings

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

@@ -10,23 +10,23 @@ module Workato
 
         def initialize(object_definitions:, connection:, methods:, settings:)
           @object_definitions_source = object_definitions
-          @methods = methods
+          @methods_source = methods
           @connection = connection
           @settings = settings
           define_object_definition_methods(object_definitions)
         end
 
         def lazy(settings = nil, config_fields = {})
-          object_definitions_lazy_hash = DupHashWithIndifferentAccess.new do |h, name|
-            fields_proc = @object_definitions_source[name][:fields]
-            h[name] = Action.new(
+          DupHashWithIndifferentAccess.new do |object_definitions, name|
+            fields_proc = object_definitions_source[name][:fields]
+            object_definitions[name] = Action.new(
               action: {
                 execute: lambda do |connection, input|
-                  instance_exec(connection, input, object_definitions_lazy_hash, &fields_proc)
+                  instance_exec(connection, input, object_definitions, &fields_proc)
                 end
               },
-              methods: @methods,
-              connection: @connection,
+              methods: methods_source,
+              connection: connection,
               settings: @settings
             ).execute(settings, config_fields)
           end
@@ -34,10 +34,10 @@ module Workato
 
         private
 
-        attr_reader :methods,
+        attr_reader :methods_source,
                     :connection,
-                    :objects,
-                    :settings
+                    :settings,
+                    :object_definitions_source
 
         def define_object_definition_methods(object_definitions)
           object_definitions.each do |(object, _definition)|

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

@@ -16,21 +16,23 @@ module Workato
 
         cattr_accessor :on_settings_updated
 
-        def initialize(operation:, connection: {}, methods: {}, settings: {}, object_definitions: nil)
+        def initialize(connection:, operation: {}, methods: {}, settings: {}, object_definitions: nil)
+          @connection = connection
           @settings = settings.with_indifferent_access
           @operation = operation.with_indifferent_access
-          @connection = connection.with_indifferent_access
           @_methods = methods.with_indifferent_access
           @object_definitions = object_definitions
         end
 
-        def execute(settings = nil, input = {}, extended_input_schema = [], extended_output_schema = [], &block)
+        def execute(settings = nil, input = {}, extended_input_schema = [], extended_output_schema = [], continue = {},
+                    &block)
           @settings = settings.with_indifferent_access if settings # is being used in request for refresh tokens
           request_or_result = instance_exec(
             @settings.with_indifferent_access, # a copy of settings hash is being used in executable blocks
             input.with_indifferent_access,
             Array.wrap(extended_input_schema).map(&:with_indifferent_access),
             Array.wrap(extended_output_schema).map(&:with_indifferent_access),
+            continue.with_indifferent_access,
             &block
           )
           resolve_request(request_or_result)
@@ -69,9 +71,9 @@ module Workato
         def refresh_authorization!(http_code, http_body, exception, settings = {})
           return unless refresh_auth?(http_code, http_body, exception)
 
-          new_settings = if /oauth2/i =~ connection[:authorization][:type]
+          new_settings = if /oauth2/i =~ connection.authorization.type
                            refresh_oauth2_token(settings)
-                         elsif connection[:authorization][:acquire]
+                         elsif connection.authorization.acquire?
                            acquire_token(settings)
                          end
           return unless new_settings
@@ -132,7 +134,7 @@ module Workato
         end
 
         def refresh_auth?(http_code, http_body, exception)
-          refresh_on = Array.wrap(connection[:authorization][:refresh_on]).compact
+          refresh_on = connection.authorization.refresh_on
           refresh_on.blank? || refresh_on.any? do |pattern|
             pattern.is_a?(::Integer) && pattern == http_code ||
               pattern === exception&.to_s ||
@@ -141,48 +143,26 @@ module Workato
         end
 
         def acquire_token(settings)
-          acquire = connection[:authorization][:acquire]
-          raise InvalidDefinitionError, "'acquire' block is required for authorization" unless acquire
-
-          Action.new(
-            action: {
-              execute: ->(connection) { instance_exec(connection, &acquire) }
-            },
-            connection: connection.merge(
-              authorization: connection[:authorization].merge(
-                apply: nil
-              )
-            ),
-            methods: @_methods
-          ).execute(settings)
+          connection.authorization.acquire(settings)
         end
 
         def refresh_oauth2_token_using_refresh(settings)
-          refresh = connection[:authorization][:refresh]
-          new_tokens, new_settings = Action.new(
-            action: {
-              execute: lambda do |connection|
-                instance_exec(connection, connection[:refresh_token], &refresh)
-              end
-            },
-            methods: @_methods
-          ).execute(settings)
-
+          new_tokens, new_settings = connection.authorization.refresh(settings, settings[:refresh_token])
           new_tokens.with_indifferent_access.merge(new_settings || {})
         end
 
         def refresh_oauth2_token_using_token_url(settings)
           if settings[:refresh_token].blank?
-            raise NotImplementedError, 'workato-connector-sdk does not support OAuth2 authorization process. '\
-                                       'Use Workato Debugger UI to acquire access_token and refresh_token'
+            raise NotImplementedError, 'refresh_token is empty. ' \
+                                       'Use workato oauth2 command to acquire access_token and refresh_token'
           end
 
           response = RestClient::Request.execute(
-            url: connection[:authorization][:token_url].call(settings),
+            url: connection.authorization.token_url(settings),
             method: :post,
             payload: {
-              client_id: connection[:authorization][:client_id].call(settings),
-              client_secret: connection[:authorization][:client_secret].call(settings),
+              client_id: connection.authorization.client_id(settings),
+              client_secret: connection.authorization.client_secret(settings),
               grant_type: :refresh_token,
               refresh_token: settings[:refresh_token]
             },
@@ -198,9 +178,9 @@ module Workato
         end
 
         def refresh_oauth2_token(settings)
-          if connection[:authorization][:refresh]
+          if connection.authorization.refresh?
             refresh_oauth2_token_using_refresh(settings)
-          elsif connection[:authorization][:token_url]
+          elsif connection.authorization.token_url?
             refresh_oauth2_token_using_token_url(settings)
           else
             raise InvalidDefinitionError, "'refresh' block or 'token_url' is required for refreshing the token"

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

@@ -15,13 +15,13 @@ module Workato
       class Request < SimpleDelegator
         using BlockInvocationRefinements
 
-        def initialize(uri, method: 'GET', connection: {}, settings: {}, action: nil)
+        def initialize(uri, method: 'GET', settings: {}, connection: nil, action: nil)
           super(nil)
           @uri = uri
-          @authorization = (connection[:authorization] || {}).with_indifferent_access
-          @settings = settings
-          @base_uri = connection[:base_uri]&.call(settings.with_indifferent_access)
           @method = method
+          @settings = settings
+          @authorization = connection&.authorization
+          @base_uri = connection&.base_uri(settings)
           @action = action
           @headers = {}
           @case_sensitive_headers = {}
@@ -321,7 +321,9 @@ module Workato
         end
 
         def detect_error!(response)
-          error_patterns = Array.wrap(@authorization[:detect_on])
+          return unless @authorization
+
+          error_patterns = @authorization.detect_on
           return unless error_patterns.any? { |pattern| pattern === response rescue false }
 
           Kernel.raise(CustomRequestError, response.to_s)
@@ -357,13 +359,15 @@ module Workato
         end
 
         def authorized
-          apply = @authorization[:apply] || @authorization[:credentials]
+          return yield unless @authorization
+
+          apply = @authorization.source[:apply] || @authorization.source[:credentials]
           return yield unless apply
 
           first = true
           begin
             settings = @settings.with_indifferent_access
-            if /oauth2/i =~ @authorization[:type]
+            if /oauth2/i =~ @authorization.type
               instance_exec(settings, settings[:access_token], @auth_type, &apply)
             else
               instance_exec(settings, @auth_type, &apply)

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

@@ -45,6 +45,8 @@ module Workato
             begin
               @encrypted = false
               read_plain_file
+            rescue KeyError
+              raise
             rescue StandardError
               @encrypted = true
               read_encrypted_file
@@ -76,7 +78,7 @@ module Workato
             YAML.safe_load(f.read, [::Symbol]).to_hash.with_indifferent_access
           end
 
-          name ? all_settings.fetch(name) : all_settings
+          (name ? all_settings.fetch(name) : all_settings) || {}
         end
 
         def update_plain_file(new_settings)
@@ -93,7 +95,7 @@ module Workato
         def read_encrypted_file
           all_settings = encrypted_configuration.config.with_indifferent_access
 
-          name ? all_settings.fetch(name) : all_settings
+          (name ? all_settings.fetch(name) : all_settings) || {}
         end
 
         def update_encrypted_file(new_settings)
@@ -106,7 +108,8 @@ module Workato
 
         def merge_settings(all_settings, new_settings)
           if name
-            all_settings[name] = new_settings
+            all_settings[name] ||= {}
+            all_settings[name].merge!(new_settings)
           else
             all_settings.merge!(new_settings)
           end

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

@@ -3,7 +3,7 @@
 module Workato
   module Connector
     module Sdk
-      VERSION = '0.1.2'
+      VERSION = '0.2.0'
     end
   end
 end

data/lib/workato/connector/sdk.rb

@@ -43,6 +43,7 @@ require_relative '../extension/time'
 
 require_relative './sdk/account_properties'
 require_relative './sdk/action'
+require_relative './sdk/connection'
 require_relative './sdk/connector'
 require_relative './sdk/dsl'
 require_relative './sdk/errors'

data/lib/workato/web/app.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Workato
+  module Web
+    class App
+      CODE_PATH = '/code'
+      CALLBACK_PATH = '/oauth/callback'
+
+      def call(env)
+        req = Rack::Request.new(env)
+        case req.path_info
+        when /#{CODE_PATH}/
+          [200, { 'Content-Type' => 'text/plain' }, [@code.to_s]]
+        when /#{CALLBACK_PATH}/
+          @code = req.params['code']
+          [200, { 'Content-Type' => 'text/plain' }, ['We stored response code. Now you can close the browser window']]
+        else
+          [404, { 'Content-Type' => 'text/plain' }, ['404: Not Found']]
+        end
+      end
+    end
+  end
+end

data/templates/spec/action_spec.rb.erb

@@ -11,7 +11,7 @@ RSpec.describe 'actions/<%= name %>', :vcr do
   let(:action) { connector.actions.<%= name %> }
 
   describe 'execute' do
-    subject(:output) { action.execute(settings, input, extended_input_schema, extended_output_schema) }
+    subject(:output) { action.execute(settings, input, extended_input_schema, extended_output_schema, continue) }
 
     pending 'add some examples'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workato-connector-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Pavel Abolmasov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: gyoku
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: loofah
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +150,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.10.10
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +234,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -294,11 +364,13 @@ files:
 - lib/workato/cli/generators/connector_generator.rb
 - lib/workato/cli/generators/master_key_generator.rb
 - lib/workato/cli/main.rb
+- lib/workato/cli/oauth2_command.rb
 - lib/workato/cli/push_command.rb
 - lib/workato/connector/sdk.rb
 - lib/workato/connector/sdk/account_properties.rb
 - lib/workato/connector/sdk/action.rb
 - lib/workato/connector/sdk/block_invocation_refinements.rb
+- lib/workato/connector/sdk/connection.rb
 - lib/workato/connector/sdk/connector.rb
 - lib/workato/connector/sdk/dsl.rb
 - lib/workato/connector/sdk/dsl/account_property.rb
@@ -336,6 +408,7 @@ files:
 - lib/workato/extension/time.rb
 - lib/workato/testing/vcr_encrypted_cassette_serializer.rb
 - lib/workato/testing/vcr_multipart_body_matcher.rb
+- lib/workato/web/app.rb
 - templates/.rspec.erb
 - templates/Gemfile.erb
 - templates/connector.rb.erb
@@ -369,7 +442,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubyforge_project:
+rubygems_version: 2.6.14.4
 signing_key:
 specification_version: 4
 summary: Gem for running adapter's code outside Workato infrastructure