workato-connector-sdk 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f52b011085690e264b4e2082fb2f13c1375e74fe
-  data.tar.gz: 190c0bc7e6264ab9524acdda484e07154dd0b2b8
+  metadata.gz: 4348a5f43c1aca0d39967b9b90c04b17d158a74c
+  data.tar.gz: befa5442c5eca5641824e0e426cbec67c6a2dc77
 SHA512:
-  metadata.gz: 29480d50f931dec0b0f18bf8f7c97f0a6029dd2656ba367ce0a3015a2a32e961bca9981083e01455d9c65cba2244dea5491b34d02e18a9cb8c4ac1a02f9a1d85
-  data.tar.gz: 1681f2fc8fc0eec6949361ae49ae26fdea3372eab98fb745e9d4a55d192b0e74a34d446655d2b5b08ede89d09cf748d4610ef86b08bab3210165de961004bbb6
+  metadata.gz: d74275e1a04b3a90059971dc048256ef3f720bbf09db590678353cc920e133ec4627a7870c5832663f1f793e9b8e47d2cfa19f3cdab81bd7c5abf2f0021c5db3
+  data.tar.gz: ebbf0c161b5fcb932db95dac377408ab01b237bc1541a27e2e19c2b2cf9e2dbea60934a2cd1b37ebd56955c1d531e91656342d14904dbcdf66109fe99f7fe14f

data/README.md

@@ -248,8 +248,9 @@ Usage:
   workato edit <PATH>
 
 Options:
-  -k, [--key=KEY]                  # Path to file with encrypt/decrypt key. NOTE: key from WORKATO_CONNECTOR_MASTER_KEY has higher priority
-      [--verbose], [--no-verbose]  
+  -k, [--key=KEY]                  # Path to file with encrypt/decrypt key.
+                                   # NOTE: key from WORKATO_CONNECTOR_MASTER_KEY has higher priority
+      [--verbose], [--no-verbose]
 
 Edit encrypted file, e.g. settings.yaml.enc
 ```
@@ -261,6 +262,7 @@ Edit encrypted file, e.g. settings.yaml.enc
 ### 3.3 workato exec
 ```
 workato help exec
+
 Usage:
   workato exec <PATH>
 
@@ -268,7 +270,8 @@ 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
+  -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
@@ -286,7 +289,7 @@ Options:
       [--redirect-url=REDIRECT_URL]                          # OAuth2 callback url
       [--refresh-token=REFRESH_TOKEN]                        # OAuth2 refresh token
       [--debug], [--no-debug]
-      [--verbose], [--no-verbose]                    
+      [--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.
@@ -394,13 +397,14 @@ 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
+  -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]  
+      [--verbose], [--no-verbose]
 
 Implements OAuth Authorization Code flow
 ```
@@ -420,11 +424,13 @@ 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 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
+      [--api-email=API_EMAIL]      # Email for accessing Workato API.
+                                   # If present overrides value from WORKATO_API_EMAIL environment variable.
+      [--api-token=API_TOKEN]      # Token for accessing Workato API.
+                                   # If present overrides value from WORKATO_API_TOKEN environment variable.
+      [--environment=ENVIRONMENT]  # Data center specific URL to push connector code.
+                                   # If present overrides value from WORKATO_BASE_URL environment variable.
+                                   # Examples: 'https://app.workato.com', 'https://app.eu.workato.com'
       [--folder=FOLDER]            # Folder ID if you what to push to folder other than Home
       [--verbose], [--no-verbose]
 

data/lib/workato/cli/main.rb

@@ -41,8 +41,8 @@ module Workato
                                  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"
+                          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'
       method_option :continue, type: :string, desc: 'Path to file with next multistep action continue closure JSON'
@@ -75,7 +75,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. '\
+                          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,17 +127,20 @@ module Workato
                     lazy_default: Workato::Connector::Sdk::DEFAULT_CONNECTOR_PATH
       method_option :api_email,
                     type: :string,
-                    desc: 'Email for accessing Workato API or '\
-                          "set #{Workato::Connector::Sdk::WORKATO_API_EMAIL_ENV} environment variable"
+                    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 or ' \
-                          "set #{Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV} environment variable"
+                    desc: "Token for accessing Workato API.\n" \
+                          "If present overrides value from #{Workato::Connector::Sdk::WORKATO_API_TOKEN_ENV} "\
+                          'environment variable.'
       method_option :environment,
                     type: :string,
-                    enum: Workato::CLI::PushCommand::ENVIRONMENTS.keys,
-                    default: 'live',
-                    desc: 'Server to push connector code to'
+                    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,
                     desc: 'Folder ID if you what to push to folder other than Home'
@@ -168,7 +171,7 @@ module Workato
                     type: :string,
                     aliases: '-k',
                     lazy_default: Workato::Connector::Sdk::DEFAULT_MASTER_KEY_PATH,
-                    desc: 'Path to file with encrypt/decrypt key. '\
+                    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,
@@ -187,6 +190,35 @@ module Workato
           options: options
         ).call
       end
+
+      class << self
+        def print_options(shell, options, group_name = nil)
+          return if options.empty?
+
+          list = []
+          padding = options.map { |o| o.aliases.size }.max.to_i * 4
+
+          options.each do |option|
+            next if option.hide
+
+            description = []
+            description_lines = option.description ? option.description.split("\n") : []
+            first_line = description_lines.shift
+            description << [option.usage(padding), first_line ? "# #{first_line}" : '']
+            description_lines.each do |line|
+              description << ['', "# #{line}"]
+            end
+
+            list.concat(description)
+            list << ['', "# Default: #{option.default}"] if option.show_default?
+            list << ['', "# Possible values: #{option.enum.join(', ')}"] if option.enum
+          end
+
+          shell.say(group_name ? "#{group_name} options:" : 'Options:')
+          shell.print_table(list, indent: 2)
+          shell.say ''
+        end
+      end
     end
   end
 end

data/lib/workato/cli/push_command.rb

@@ -32,7 +32,9 @@ module Workato
 
       def initialize(options:)
         @options = options
-        @api_base_url = ENVIRONMENTS.fetch(options[:environment])
+        @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]
         @folder_id = options[:folder]

data/lib/workato/cli/schema_command.rb

@@ -9,7 +9,6 @@ module Workato
       SAMPLE_TO_SCHEMA_SUPPORT_TYPES = %w[csv json].freeze
       CSV_SEPARATORS = %w[comma space tab colon semicolon pipe].freeze
 
-      WORKATO_BASE_URL = ENV['WORKATO_BASE_URL'] || 'https://app.workato.com'
       API_GENERATE_SCHEMA_PATH = '/api/sdk/generate_schema'
 
       def initialize(options:)
@@ -53,7 +52,7 @@ module Workato
       end
 
       def sample_to_schema(sample)
-        url = "#{WORKATO_BASE_URL}#{API_GENERATE_SCHEMA_PATH}/#{sample.delete(:type)}"
+        url = "#{Workato::Connector::Sdk::WORKATO_BASE_URL}#{API_GENERATE_SCHEMA_PATH}/#{sample.delete(:type)}"
         response = RestClient.post(
           url,
           sample.to_json,
@@ -75,8 +74,7 @@ module Workato
         }
       end
 
-      private_constant :API_GENERATE_SCHEMA_PATH,
-                       :WORKATO_BASE_URL
+      private_constant :API_GENERATE_SCHEMA_PATH
     end
   end
 end

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

@@ -4,7 +4,7 @@
 module Workato
   module Connector
     module Sdk
-      VERSION = '1.0.2'
+      VERSION = '1.0.3'
     end
   end
 end

data/lib/workato/connector/sdk.rb

@@ -26,6 +26,10 @@ module Workato
 
       WORKATO_API_EMAIL_ENV = 'WORKATO_API_EMAIL'
       WORKATO_API_TOKEN_ENV = 'WORKATO_API_TOKEN'
+
+      WORKATO_BASE_URL_ENV = 'WORKATO_BASE_URL'
+      DEFAULT_WORKATO_BASE_URL = 'https://app.workato.com'
+      WORKATO_BASE_URL = T.let(ENV.fetch(WORKATO_BASE_URL_ENV, DEFAULT_WORKATO_BASE_URL), String)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workato-connector-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Pavel Abolmasov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport