workato-connector-sdk 0.4.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0432805c30301cec341b2c9bbd3168064b5b47e772f8dfd5d49a46b220cf6984'
-  data.tar.gz: d2161b5a4dd6211d0ef4cfc2a354235d6e4f6b4f6a8466021dcb367d52d493d6
+  metadata.gz: 70241ed06aeae85f14f775ff2366ec4edbc54322aa034f0931dd987e9fd1fb2c
+  data.tar.gz: 1a99f10c8c3c4dfe036e591cddb81504980586b0fb48cd319f7cfd5e510a1512
 SHA512:
-  metadata.gz: aa8779a641225ed5553d59173c8b44df0b6f29c296028414af7cf124175c602f024e69a5ac7ebfdff7b48d54eee3646a9225217a1e77630247606cc13b72182a
-  data.tar.gz: 30b6719d84588071e4afb8afca6fcd7edadb3e9f0d40a5127c46ecafe66262fded930f239031039bc1128de03ac07d441f16f58e1aba72c0b5ca82ef0b86ea28
+  metadata.gz: b74c573b4e5c00509b955a14477a132ce01cfa6824382f21e50646bc10ce5ee44f3f2bf9bbf06ad7e565ddedfd0cce8c5017ae31e28e3b470164600abbb29d6d
+  data.tar.gz: 1f1139718e2f18faa63087e3782c42a0bb0b3bae237086044873283bad8128f9ce42b26b3738d0a3a8ff22e529180a6d8df821f7c7eee9da68b85d3b97098340

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/exec_command.rb

@@ -50,7 +50,7 @@ module Workato
           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]).presence,
           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 || [],

data/lib/workato/cli/generate_command.rb

@@ -39,12 +39,39 @@ module Workato
         create_spec_files
       end
 
-      desc 'schema', 'Generate schema by JSON example'
+      desc 'schema', 'Generate schema from example'
+
+      method_option :json, type: :string, desc: 'Path to JSON sample file'
+      method_option :csv, type: :string, desc: 'Path to CSV sample file'
+      method_option :col_sep,
+                    type: :string,
+                    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} 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"
+
+      long_desc <<~HELP
+        The 'workato generate schema' command generates Workato Schema from a sample file.
+        Supported inputs #{SchemaCommand::SAMPLE_TO_SCHEMA_SUPPORT_TYPES.join(', ')}
+
+        Example:
+
+          workato generate schema --csv=input.csv --col-sep=semicolon # This generates a schema from CSV file.
+
+          workato generate schema --json=input.json
+      HELP
+
       def schema
-        say <<~HELP
-          Generate schema is not implemented yet.
-          Use Workato UI "JSON to Schema" converter for now.
-        HELP
+        SchemaCommand.new(
+          options: options
+        ).call
       end
 
       private

data/lib/workato/cli/main.rb

@@ -4,6 +4,7 @@ require 'thor'
 require 'workato/connector/sdk'
 require_relative './exec_command'
 require_relative './edit_command'
+require_relative './schema_command'
 require_relative './generate_command'
 require_relative './push_command'
 require_relative './oauth2_command'
@@ -53,6 +54,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'
@@ -125,11 +127,11 @@ module Workato
       method_option :api_email,
                     type: :string,
                     desc: 'Email for accessing Workato API or '\
-                          "set #{Workato::CLI::PushCommand::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::CLI::PushCommand::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,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'securerandom'
 require 'workato/web/app'
 
 module Workato
@@ -112,6 +113,7 @@ module Workato
         @authorize_url =
           if (authorization_url = connector.connection.authorization.authorization_url(settings))
             params = {
+              state: SecureRandom.hex(8),
               client_id: connector.connection.authorization.client_id(settings),
               redirect_uri: redirect_url
             }

data/lib/workato/cli/push_command.rb

@@ -10,9 +10,6 @@ module Workato
     class PushCommand
       include Thor::Shell
 
-      WORKATO_API_TOKEN_ENV = 'WORKATO_API_TOKEN'
-      WORKATO_API_EMAIL_ENV = 'WORKATO_API_EMAIL'
-
       ENVIRONMENTS = {
         'preview' => 'https://app.preview.workato.com',
         'preview-eu' => 'https://app.preview.eu.workato.com',
@@ -35,8 +32,8 @@ module Workato
       def initialize(options:)
         @options = options
         @api_base_url = ENVIRONMENTS.fetch(options[:environment])
-        @api_email = options[:api_email] || ENV[WORKATO_API_EMAIL_ENV]
-        @api_token = options[:api_token] || ENV[WORKATO_API_TOKEN_ENV]
+        @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]
       end
 

data/lib/workato/cli/schema_command.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Workato
+  module CLI
+    class SchemaCommand
+      include Thor::Shell
+
+      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:)
+        @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]
+        @options = options
+      end
+
+      def call
+        if verbose?
+          say('INPUT')
+          say sample[:sample]
+        end
+
+        schema = sample_to_schema(sample)
+
+        say('SCHEMA') if verbose?
+        jj schema
+      end
+
+      private
+
+      attr_reader :options,
+                  :api_token,
+                  :api_email
+
+      def verbose?
+        @options[:verbose]
+      end
+
+      def sample
+        return @sample if @sample
+
+        @sample = if options[:json]
+                    { sample: File.read(options[:json]), type: :json }
+                  elsif options[:csv]
+                    { sample: File.read(options[:csv]), type: :csv, col_sep: options[:col_sep] }
+                  else
+                    { sample: {}, type: :json }
+                  end
+      end
+
+      def sample_to_schema(sample)
+        url = "#{WORKATO_BASE_URL}#{API_GENERATE_SCHEMA_PATH}/#{sample.delete(:type)}"
+        response = RestClient.post(
+          url,
+          sample.to_json,
+          {
+            content_type: :json,
+            accept: :json
+          }.merge(auth_headers)
+        )
+        JSON.parse(response.body)
+      rescue RestClient::ExceptionWithResponse => e
+        message = JSON.parse(e.response.body).fetch('message') rescue e.message
+        raise "Failed to generate schema: #{message}"
+      end
+
+      def auth_headers
+        {
+          'x-user-email' => api_email,
+          'x-user-token' => api_token
+        }
+      end
+
+      private_constant :API_GENERATE_SCHEMA_PATH,
+                       :WORKATO_BASE_URL
+    end
+  end
+end

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

@@ -56,8 +56,16 @@ module Workato
           trigger[:dedup].call(input)
         end
 
-        def webhook_notification(input = {}, payload = {}, extended_input_schema = [],
-                                 extended_output_schema = [], headers = {}, params = {})
+        def webhook_notification(
+          input = {},
+          payload = {},
+          extended_input_schema = [],
+          extended_output_schema = [],
+          headers = {},
+          params = {},
+          settings = nil,
+          webhook_subscribe_output = {}
+        )
           Dsl::WithDsl.execute(
             input.with_indifferent_access,
             payload.with_indifferent_access,
@@ -65,6 +73,8 @@ module Workato
             extended_output_schema.map(&:with_indifferent_access),
             headers.with_indifferent_access,
             params.with_indifferent_access,
+            (settings || @settings).with_indifferent_access,
+            webhook_subscribe_output.with_indifferent_access,
             &trigger[:webhook_notification]
           )
         end
@@ -89,23 +99,33 @@ module Workato
           end
         end
 
-        def invoke(input = {}, payload = {}, headers = {}, params = {})
+        def invoke(input = {}, payload = {}, headers = {}, params = {}, webhook_subscribe_output = {})
           extended_schema = extended_schema(nil, input)
           config_schema = Schema.new(schema: config_fields_schema)
           input_schema = Schema.new(schema: extended_schema[:input])
           output_schema = Schema.new(schema: extended_schema[:output])
 
           input = apply_input_schema(input, config_schema + input_schema)
-          output = if webhook_notification?
-                     webhook_notification(input, payload, input_schema, output_schema, headers, params)
-                   else
-                     poll(nil, input, nil, input_schema, output_schema)
-                   end
-          output[:events].each do |event|
-            apply_output_schema(event, output_schema)
+          if webhook_notification?
+            webhook_notification(
+              input,
+              payload,
+              input_schema,
+              output_schema,
+              headers,
+              params,
+              nil,
+              webhook_subscribe_output
+            ).tap do |event|
+              apply_output_schema(event, output_schema)
+            end
+          else
+            output = poll(nil, input, nil, input_schema, output_schema)
+            output[:events].each do |event|
+              apply_output_schema(event, output_schema)
+            end
+            output
           end
-
-          output
         end
 
         private

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

@@ -3,7 +3,7 @@
 module Workato
   module Connector
     module Sdk
-      VERSION = '0.4.1'
+      VERSION = '1.0.1'
     end
   end
 end

data/lib/workato/connector/sdk.rb

@@ -19,6 +19,9 @@ module Workato
       DEFAULT_TIME_ZONE = 'Pacific Time (US & Canada)'
 
       DEFAULT_SCHEMAS_PATH = 'workato_schemas.json'
+
+      WORKATO_API_EMAIL_ENV = 'WORKATO_API_EMAIL'
+      WORKATO_API_TOKEN_ENV = 'WORKATO_API_TOKEN'
     end
   end
 end

data/lib/workato/extension/string.rb

@@ -229,6 +229,10 @@ module Workato
         self
       end
 
+      def to_json(_options = nil)
+        summary
+      end
+
       def binary?
         true
       end
@@ -245,19 +249,12 @@ module Workato
         as_string('utf-8')
       end
 
-      # representation in event title
-      def title
-        if length.positive?
-          "0x#{byteslice(0, TITLE_LENGTH).unpack1('H*')}#{bytesize > TITLE_LENGTH ? '…' : ''}"
-        else
-          ''
-        end
-      end
-
       def sha1
         Binary.new(::Digest::SHA1.digest(self))
       end
 
+      private
+
       def summary
         if length.positive?
           left = "0x#{byteslice(0, SUMMARY_LENGTH).unpack1('H*')}"
@@ -267,12 +264,8 @@ module Workato
           ''
         end
       end
-
-      def self.from_base64(base64str)
-        new(Base64.strict_decode64(base64str))
-      end
     end
   end
 end
 
-String.include(Workato::Extension::String)
+String.prepend(Workato::Extension::String)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workato-connector-sdk
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Pavel Abolmasov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -380,6 +380,7 @@ files:
 - lib/workato/cli/main.rb
 - lib/workato/cli/oauth2_command.rb
 - lib/workato/cli/push_command.rb
+- lib/workato/cli/schema_command.rb
 - lib/workato/connector/sdk.rb
 - lib/workato/connector/sdk/account_properties.rb
 - lib/workato/connector/sdk/action.rb
@@ -468,7 +469,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Gem for running adapter's code outside Workato infrastructure