workato-connector-sdk 0.5.0 → 1.0.2

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

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 require 'securerandom'
@@ -5,19 +6,41 @@ require 'securerandom'
 module Workato
   module Connector
     module Sdk
+      module SorbetTypes
+        WebhookSubscribeOutputHash = T.type_alias { T::Hash[T.any(String, Symbol), T.untyped] }
+      end
+
       class Trigger < Operation
         using BlockInvocationRefinements
 
-        def initialize(trigger:, connection: {}, methods: {}, settings: {}, object_definitions: nil)
+        sig do
+          params(
+            trigger: SorbetTypes::SourceHash,
+            methods: SorbetTypes::SourceHash,
+            connection: Connection,
+            object_definitions: T.nilable(ObjectDefinitions)
+          ).void
+        end
+        def initialize(trigger:, methods: {}, connection: Connection.new, object_definitions: nil)
           super(
             operation: trigger,
             connection: connection,
             methods: methods,
-            settings: settings,
             object_definitions: object_definitions
           )
         end
 
+        sig do
+          params(
+            settings: T.nilable(SorbetTypes::SettingsHash),
+            input: SorbetTypes::OperationInputHash,
+            closure: T.untyped,
+            extended_input_schema: SorbetTypes::OperationSchema,
+            extended_output_schema: SorbetTypes::OperationSchema
+          ).returns(
+            HashWithIndifferentAccess
+          )
+        end
         def poll_page(settings = nil, input = {}, closure = nil, extended_input_schema = [],
                       extended_output_schema = [])
           poll_proc = trigger[:poll]
@@ -34,8 +57,19 @@ module Workato
           output
         end
 
+        sig do
+          params(
+            settings: T.nilable(SorbetTypes::SettingsHash),
+            input: SorbetTypes::OperationInputHash,
+            closure: T.untyped,
+            extended_input_schema: SorbetTypes::OperationSchema,
+            extended_output_schema: SorbetTypes::OperationSchema
+          ).returns(
+            HashWithIndifferentAccess
+          )
+        end
         def poll(settings = nil, input = {}, closure = nil, extended_input_schema = [], extended_output_schema = [])
-          events = []
+          events = T.let([], T::Array[T::Hash[T.any(String, Symbol), T.untyped]])
 
           loop do
             output = poll_page(settings, input, closure, extended_input_schema, extended_output_schema)
@@ -52,23 +86,60 @@ module Workato
           }.with_indifferent_access
         end
 
+        sig { params(input: SorbetTypes::OperationInputHash).returns(T.untyped) }
         def dedup(input = {})
           trigger[:dedup].call(input)
         end
 
-        def webhook_notification(input = {}, payload = {}, extended_input_schema = [],
-                                 extended_output_schema = [], headers = {}, params = {})
+        sig do
+          params(
+            input: SorbetTypes::OperationInputHash,
+            payload: T::Hash[T.any(String, Symbol), T.untyped],
+            extended_input_schema: SorbetTypes::OperationSchema,
+            extended_output_schema: SorbetTypes::OperationSchema,
+            headers: T::Hash[T.any(String, Symbol), T.untyped],
+            params: T::Hash[T.any(String, Symbol), T.untyped],
+            settings: T.nilable(SorbetTypes::SettingsHash),
+            webhook_subscribe_output: SorbetTypes::WebhookSubscribeOutputHash
+          ).returns(
+            HashWithIndifferentAccess
+          )
+        end
+        def webhook_notification(
+          input = {},
+          payload = {},
+          extended_input_schema = [],
+          extended_output_schema = [],
+          headers = {},
+          params = {},
+          settings = nil,
+          webhook_subscribe_output = {}
+        )
+          connection.merge_settings!(settings) if settings
           Dsl::WithDsl.execute(
+            connection,
             input.with_indifferent_access,
             payload.with_indifferent_access,
-            extended_input_schema.map(&:with_indifferent_access),
-            extended_output_schema.map(&:with_indifferent_access),
+            Array.wrap(extended_input_schema).map(&:with_indifferent_access),
+            Array.wrap(extended_output_schema).map(&:with_indifferent_access),
             headers.with_indifferent_access,
             params.with_indifferent_access,
+            connection.settings,
+            webhook_subscribe_output.with_indifferent_access,
             &trigger[:webhook_notification]
-          )
+          ).with_indifferent_access
         end
 
+        sig do
+          params(
+            webhook_url: String,
+            settings: T.nilable(SorbetTypes::SettingsHash),
+            input: SorbetTypes::OperationInputHash,
+            recipe_id: String
+          ).returns(
+            SorbetTypes::WebhookSubscribeOutputHash
+          )
+        end
         def webhook_subscribe(webhook_url = '', settings = nil, input = {}, recipe_id = SecureRandom.uuid)
           webhook_subscribe_proc = trigger[:webhook_subscribe]
           execute(settings, { input: input, webhook_url: webhook_url, recipe_id: recipe_id }) do |connection, payload|
@@ -82,6 +153,7 @@ module Workato
           end
         end
 
+        sig { params(webhook_subscribe_output: SorbetTypes::WebhookSubscribeOutputHash).returns(T.untyped) }
         def webhook_unsubscribe(webhook_subscribe_output = {})
           webhook_unsubscribe_proc = trigger[:webhook_unsubscribe]
           execute(nil, webhook_subscribe_output) do |_connection, input|
@@ -89,29 +161,51 @@ module Workato
           end
         end
 
-        def invoke(input = {}, payload = {}, headers = {}, params = {})
+        sig do
+          params(
+            input: SorbetTypes::OperationInputHash,
+            payload: T::Hash[T.any(String, Symbol), T.untyped],
+            headers: T::Hash[T.any(String, Symbol), T.untyped],
+            params: T::Hash[T.any(String, Symbol), T.untyped],
+            webhook_subscribe_output: SorbetTypes::WebhookSubscribeOutputHash
+          ).returns(
+            T::Hash[T.any(String, Symbol), T.untyped]
+          )
+        end
+        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
 
         alias trigger operation
 
+        sig { returns(T::Boolean) }
         def webhook_notification?
           trigger[:webhook_notification].present?
         end

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

@@ -1,9 +1,10 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Workato
   module Connector
     module Sdk
-      VERSION = '0.5.0'
+      VERSION = '1.0.2'
     end
   end
 end

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

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

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

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

data/lib/workato/connector/sdk.rb

@@ -1,5 +1,9 @@
+# typed: strict
 # frozen_string_literal: true
 
+require 'sorbet-runtime'
+::Method.prepend(T::CompatibilityPatches::MethodExtensions)
+
 module Workato
   module Connector
     module Sdk

data/lib/workato/extension/array.rb

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

data/lib/workato/extension/case_sensitive_headers.rb

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

data/lib/workato/extension/currency.rb

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

data/lib/workato/extension/date.rb

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

data/lib/workato/extension/enumerable.rb

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

data/lib/workato/extension/extra_chain_cert.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'rest-client'

data/lib/workato/extension/hash.rb

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

data/lib/workato/extension/integer.rb

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

data/lib/workato/extension/nil_class.rb

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

data/lib/workato/extension/object.rb

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

data/lib/workato/extension/phone.rb

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

data/lib/workato/extension/string.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Workato
@@ -164,7 +165,7 @@ module Workato
       end
 
       def from_xml
-        XML.parse_xml_to_hash self
+        Connector::Sdk::Xml.parse_xml_to_hash self
       end
 
       TO_COUNTRY_METHODS.each do |suffix|
@@ -229,6 +230,10 @@ module Workato
         self
       end
 
+      def to_json(_options = nil)
+        summary
+      end
+
       def binary?
         true
       end
@@ -245,19 +250,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 +265,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)

data/lib/workato/extension/symbol.rb

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

data/lib/workato/extension/time.rb

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

data/lib/workato/testing/vcr_encrypted_cassette_serializer.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Workato
@@ -24,6 +25,7 @@ module Workato
         File.binread(content_path)
       ensure
         File.unlink(content_path) if content_path.exist?
+        @content_path = ''
       end
 
       def deserialize(string)
@@ -32,6 +34,9 @@ module Workato
         end
         File.write(@content_path, string)
         ::YAML.safe_load(read).presence || {}
+      ensure
+        File.unlink(content_path) if content_path.exist?
+        @content_path = ''
       end
     end
   end

data/lib/workato/testing/vcr_multipart_body_matcher.rb

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

data/lib/workato/web/app.rb

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

data/lib/workato-connector-sdk.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workato-connector-sdk
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Pavel Abolmasov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.5
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: 2.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: 2.16.0
 - !ruby/object:Gem::Dependency
   name: net-http-digest_auth
   requirement: !ruby/object:Gem::Requirement
@@ -220,20 +234,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: ruby_rncryptor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -304,6 +346,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: stub_server
   requirement: !ruby/object:Gem::Requirement
@@ -469,7 +525,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