workato-connector-sdk 0.1.0

data/lib/workato/extension/symbol.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Workato
+  module Extension
+    module Symbol
+      def labelize(*acronyms)
+        to_s.labelize(*acronyms)
+      end
+    end
+  end
+end
+
+Symbol.include(Workato::Extension::Symbol)

data/lib/workato/extension/time.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Workato
+  module Extension
+    module Time
+      def yweek
+        to_date.cweek
+      end
+    end
+  end
+end
+
+Time.include(Workato::Extension::Time)

data/lib/workato/testing/vcr_encrypted_cassette_serializer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Workato
+  module Testing
+    class VCREncryptedCassetteSerializer < ActiveSupport::EncryptedFile
+      def initialize
+        super(
+          content_path: '',
+          key_path: Workato::Connector::Sdk::DEFAULT_MASTER_KEY_PATH,
+          env_key: Workato::Connector::Sdk::DEFAULT_MASTER_KEY_ENV,
+          raise_if_missing_key: true
+        )
+      end
+
+      def file_extension
+        'enc'
+      end
+
+      def serialize(hash)
+        ::Dir::Tmpname.create('vcr_cassette') do |tmp_path|
+          @content_path = Pathname.new(tmp_path)
+        end
+        write(YAML.dump(hash))
+        File.binread(content_path)
+      ensure
+        File.unlink(content_path) if content_path.exist?
+      end
+
+      def deserialize(string)
+        ::Dir::Tmpname.create('vcr_cassette') do |tmp_path|
+          @content_path = Pathname.new(tmp_path)
+        end
+        File.write(@content_path, string)
+        ::YAML.safe_load(read).presence || {}
+      end
+    end
+  end
+end

data/lib/workato/testing/vcr_multipart_body_matcher.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Workato
+  module Testing
+    class VCRMultipartBodyMatcher
+      MULTIPART_HEADER_MATCHER = %r{^multipart/form-data; boundary=(.+)$}.freeze
+
+      class << self
+        def call(request1, request2)
+          normalized_multipart_body(request1) == normalized_multipart_body(request2)
+        end
+
+        private
+
+        def normalized_multipart_body(request)
+          content_type = (request.headers['Content-Type'] || []).first.to_s
+
+          return request.body unless multipart_request?(content_type)
+
+          boundary = MULTIPART_HEADER_MATCHER.match(content_type)[1]
+          request.body.gsub(boundary, '----RubyFormBoundaryTsqIBL0iujC5POpr')
+        end
+
+        def multipart_request?(content_type)
+          return false if content_type.empty?
+
+          MULTIPART_HEADER_MATCHER.match?(content_type)
+        end
+      end
+    end
+  end
+end

data/lib/workato-connector-sdk.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'workato/connector/sdk'

data/templates/.rspec.erb

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/templates/Gemfile.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'byebug'
+gem 'rspec'
+gem 'timecop'
+gem 'vcr'
+gem 'webmock'
+gem 'workato-connector-sdk'

data/templates/connector.rb.erb

@@ -0,0 +1,37 @@
+{
+  title: '<%= name.titleize %>',
+
+  connection: {
+    authorization: {
+      type: 'custom_auth'
+    },
+
+    base_uri: lambda do |connection|
+      ''
+    end
+  },
+
+  test: lambda do |connection|
+
+  end,
+
+  actions: {
+
+  },
+
+  triggers: {
+
+  },
+
+  methods: {
+
+  },
+
+  object_definitions: {
+
+  },
+
+  pick_lists: {
+
+  }
+}

data/templates/spec/action_spec.rb.erb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+RSpec.describe 'actions/<%= name %>', :vcr do
+
+  # Spec describes the most commons blocks of an action. Remove describes that you don't need.
+  # Learn more: https://docs.workato.com/developing-connectors/sdk/cli/reference/rspec-commands.html
+
+  let(:connector) { Workato::Connector::Sdk::Connector.from_file('connector.rb', settings) }
+  let(:settings) { Workato::Connector::Sdk::Settings.from_default_file }
+
+  let(:action) { connector.actions.<%= name %> }
+
+  describe 'execute' do
+    subject(:output) { action.execute(settings, input, extended_input_schema, extended_output_schema) }
+
+    pending 'add some examples'
+  end
+
+  describe 'sample_output' do
+    subject(:sample_output) { action.sample_output(settings, input) }
+
+    pending 'add some examples'
+  end
+
+  describe 'input_fields' do
+    subject(:input_fields) { action.input_fields(settings, config_fields) }
+
+    pending 'add some examples'
+  end
+
+  describe 'output_fields' do
+    subject(:output_fields) { action.output_fields(settings, config_fields) }
+
+    pending 'add some examples'
+  end
+end

data/templates/spec/connector_spec.rb.erb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+RSpec.describe 'connector', :vcr do
+
+  # Spec describes the most commons blocks of an connector. Remove describes that you don't need.
+  # Learn more: https://docs.workato.com/developing-connectors/sdk/cli/reference/rspec-commands.html
+
+  let(:connector) { Workato::Connector::Sdk::Connector.from_file('connector.rb', settings) }
+  let(:settings) { Workato::Connector::Sdk::Settings.from_default_file }
+
+  it { expect(connector).to be_present }
+
+  describe 'test' do
+    subject(:output) { connector.test(settings) }
+
+    pending 'add some examples'
+  end
+end

data/templates/spec/method_spec.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.describe 'methods/<%= name %>', :vcr do
+
+  # Learn more: https://docs.workato.com/developing-connectors/sdk/cli/reference/rspec-commands.html
+
+  let(:connector) { Workato::Connector::Sdk::Connector.from_file('connector.rb', settings) }
+  let(:settings) { Workato::Connector::Sdk::Settings.from_default_file }
+
+  subject(:result) { connector.methods.<%= name %>(arg_1, arg_2) }
+
+  pending 'add some examples'
+end

data/templates/spec/object_definition_spec.rb.erb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+RSpec.describe 'object_definition/<%= name %>', :vcr do
+
+  # Spec describes the most commons blocks of an object definition.
+  # Learn more: https://docs.workato.com/developing-connectors/sdk/cli/reference/rspec-commands.html
+
+  let(:connector) { Workato::Connector::Sdk::Connector.from_file('connector.rb', settings) }
+  let(:settings) { Workato::Connector::Sdk::Settings.from_default_file }
+
+  let(:object_definition) { connector.object_definitions.<%= name %> }
+
+  describe 'fields' do
+    subject(:schema_fields) { object_definition.fields(settings, config_fields) }
+
+    pending 'add some examples'
+  end
+end

data/templates/spec/pick_list_spec.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.describe 'pick_lists/<%= name %>', :vcr do
+
+  # Learn more: https://docs.workato.com/developing-connectors/sdk/cli/reference/rspec-commands.html
+
+  let(:connector) { Workato::Connector::Sdk::Connector.from_file('connector.rb', settings) }
+  let(:settings) { Workato::Connector::Sdk::Settings.from_default_file }
+
+  subject(:pick_list) { connector.pick_lists.<%= name %>(settings) }
+
+  pending 'add some examples'
+end

data/templates/spec/spec_helper.rb.erb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'webmock/rspec'
+require 'timecop'
+require 'vcr'
+require 'workato-connector-sdk'
+require 'workato/testing/vcr_encrypted_cassette_serializer'
+require 'workato/testing/vcr_multipart_body_matcher'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'tape_library'
+  config.hook_into :webmock
+  config.cassette_serializers[:encrypted] = Workato::Testing::VCREncryptedCassetteSerializer.new
+  config.register_request_matcher :headers_without_user_agent do |request1, request2|
+    request1.headers.except('User-Agent') == request2.headers.except('User-Agent')
+  end
+  config.register_request_matcher :multipart_body do |request1, request2|
+    Workato::Testing::VCRMultipartBodyMatcher.call(request1, request2)
+  end
+  config.default_cassette_options = {
+    record: ENV.fetch('VCR_RECORD_MODE', <%= vcr_record_mode == '1' ? ':none' : ':once' %>).to_sym,
+    <% if vcr_record_mode == '1' %>serialize_with: :encrypted,<% end %>
+    match_requests_on: %i[uri headers_without_user_agent body]
+  }
+  config.configure_rspec_metadata!
+end

data/templates/spec/trigger_spec.rb.erb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+RSpec.describe 'triggers/<%= name %>', :vcr do
+
+  # Spec describes the most commons blocks of a trigger.
+  # Depending on the type of your trigger remove describes that you don't need.
+  # Learn more: https://docs.workato.com/developing-connectors/sdk/cli/reference/rspec-commands.html
+
+  let(:connector) { Workato::Connector::Sdk::Connector.from_file('connector.rb', settings) }
+  let(:settings) { Workato::Connector::Sdk::Settings.from_default_file }
+
+  let(:trigger) { connector.triggers.<%= name %> }
+
+  describe 'webhook_subscribe' do
+    subject(:output) { trigger.webhook_subscribe(webhook_url, settings, input, recipe_id) }
+
+    pending 'add some examples or remove for poll trigger'
+  end
+
+  describe 'webhook_unsubscribe' do
+    subject(:output) { trigger.webhook_unsubscribe(subscribe_output) }
+
+    pending 'add some examples or remove for poll trigger'
+  end
+
+  describe 'webhook_notification' do
+    subject(:output) { trigger.webhook_notification(settings, payload, e_i_s, e_o_s, headers, params) }
+
+    pending 'add some examples or remove for poll trigger'
+  end
+
+  describe 'poll' do
+    subject(:output) { trigger.poll(settings, input, closure) }
+
+    pending 'add some examples or remove for webhook based trigger'
+  end
+
+  describe 'dedup' do
+    subject(:output) { trigger.dedup(record) }
+
+    pending 'add some examples'
+  end
+
+  describe 'sample_output' do
+    subject(:sample_output) { trigger.sample_output(settings, input) }
+
+    pending 'add some examples'
+  end
+
+  describe 'input_fields' do
+    subject(:input_fields) { trigger.input_fields(settings, config_fields) }
+
+    pending 'add some examples'
+  end
+
+  describe 'output_fields' do
+    subject(:output_fields) { trigger.output_fields(settings, config_fields) }
+
+    pending 'add some examples'
+  end
+end

metadata

@@ -0,0 +1,372 @@
+--- !ruby/object:Gem::Specification
+name: workato-connector-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Abolmasov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: countries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: currencies
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: gyoku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: loofah
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+- !ruby/object:Gem::Dependency
+  name: net-http-digest_auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.10.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.10.10
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  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: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: stub_server
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Reproduce key concepts of Workato SDK, DSL, behavior and constraints.
+email:
+- pavel.abolmasov@workato.com
+executables:
+- workato
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- exe/workato
+- lib/workato-connector-sdk.rb
+- lib/workato/cli/edit_command.rb
+- lib/workato/cli/exec_command.rb
+- lib/workato/cli/generate_command.rb
+- lib/workato/cli/generators/connector_generator.rb
+- lib/workato/cli/generators/master_key_generator.rb
+- lib/workato/cli/main.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/connector.rb
+- lib/workato/connector/sdk/dsl.rb
+- lib/workato/connector/sdk/dsl/account_property.rb
+- lib/workato/connector/sdk/dsl/call.rb
+- lib/workato/connector/sdk/dsl/error.rb
+- lib/workato/connector/sdk/dsl/http.rb
+- lib/workato/connector/sdk/dsl/lookup_table.rb
+- lib/workato/connector/sdk/dsl/time.rb
+- lib/workato/connector/sdk/dsl/workato_code_lib.rb
+- lib/workato/connector/sdk/dsl/workato_schema.rb
+- lib/workato/connector/sdk/errors.rb
+- lib/workato/connector/sdk/lookup_tables.rb
+- lib/workato/connector/sdk/object_definitions.rb
+- lib/workato/connector/sdk/operation.rb
+- lib/workato/connector/sdk/request.rb
+- lib/workato/connector/sdk/settings.rb
+- lib/workato/connector/sdk/summarize.rb
+- lib/workato/connector/sdk/trigger.rb
+- lib/workato/connector/sdk/version.rb
+- lib/workato/connector/sdk/workato_schemas.rb
+- lib/workato/connector/sdk/xml.rb
+- lib/workato/extension/array.rb
+- lib/workato/extension/case_sensitive_headers.rb
+- lib/workato/extension/currency.rb
+- lib/workato/extension/date.rb
+- lib/workato/extension/enumerable.rb
+- lib/workato/extension/extra_chain_cert.rb
+- lib/workato/extension/hash.rb
+- lib/workato/extension/integer.rb
+- lib/workato/extension/nil_class.rb
+- lib/workato/extension/object.rb
+- lib/workato/extension/phone.rb
+- lib/workato/extension/string.rb
+- lib/workato/extension/symbol.rb
+- lib/workato/extension/time.rb
+- lib/workato/testing/vcr_encrypted_cassette_serializer.rb
+- lib/workato/testing/vcr_multipart_body_matcher.rb
+- templates/.rspec.erb
+- templates/Gemfile.erb
+- templates/connector.rb.erb
+- templates/spec/action_spec.rb.erb
+- templates/spec/connector_spec.rb.erb
+- templates/spec/method_spec.rb.erb
+- templates/spec/object_definition_spec.rb.erb
+- templates/spec/pick_list_spec.rb.erb
+- templates/spec/spec_helper.rb.erb
+- templates/spec/trigger_spec.rb.erb
+homepage: https://docs.workato.com/developing-connectors/sdk.html
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Gem for running adapter's code outside Workato infrastructure
+test_files: []