envoy-hooks 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 967f499b30294744218f09df13dfbfd97d4746421c4bee0dbbe81c1b3ba360ac
-  data.tar.gz: d383ec4346b1bcde2085835e02769a6ea6f2339e3c9b802fc1dcaaf543d8d2d7
+  metadata.gz: 22909d2d61ea631aa5c416510ccb95440a7265f5c793bf0794221c2f2dd50b18
+  data.tar.gz: 3706f19b970c11c6d67a679edf2464e804af878f1209746e59e12b78a5930c81
 SHA512:
-  metadata.gz: 365724d8370f3f6a1fb832bccb32f51a740632ec9f7fa1ff00964b95dd70a421ba4c69ac7b7079d79ee92fa12655f4b1a37427e476dd7baa625fb9d3012fb858
-  data.tar.gz: '09ddb4785e2238f552459e86f55c463a487a96d50871612f5b86b206f2bbd3fdf06aa3c8d15eb7633a6b0330d833cc46b8b03f7b86d8637ac44962e4d27b9f4d'
+  metadata.gz: 1c665b82b32b50af42d6363aacff26326ed4ae47cde23a044ef5a0dee3f17152153b928a7641d3a0ed564f1a95f8f2e0674bd5fb42a60b6835bbcab4d4e60118
+  data.tar.gz: '09ad5daf753fd75807c3cfad4ccf21bd3624cd5e00f66e3a11e34b0f1e3e8c07995a2312184a0f3761d2e690d25094b655b4ada9e8f6154cbe4da6c4ecec791b'

data/.rubocop.yml

@@ -3,7 +3,7 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7.7
   Exclude:
     - 'bin/*'
     - 'db/**/*'
@@ -14,9 +14,6 @@ AllCops:
     - 'vendor/**/*'
   CacheRootDirectory: "tmp/cache"
 
-Rails:
-  Enabled: true
-
 Layout/LineLength:
   Max: 150
 

data/.ruby-version

@@ -1 +1 @@
-2.6.8
+2.7.7

data/Gemfile

@@ -8,3 +8,9 @@ gemspec
 gem 'rake', '~> 13.0'
 
 gem 'rspec', '~> 3.0'
+
+gem  'rubocop', require: false
+
+gem  'rubocop-rspec', require: false
+
+gem  'rubocop-performance', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    envoy-hooks (0.9.1)
+    envoy-hooks (0.9.3)
       faraday (~> 0.15.4)
       faraday-net_http (~> 1.0)
       faraday_middleware (~> 0.12.2)
@@ -9,14 +9,22 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     diff-lcs (1.5.0)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday-net_http (1.0.1)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
+    json (2.6.3)
     multipart-post (2.2.0)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
     rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -30,8 +38,30 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
+    rubocop (1.48.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
+  ruby
   universal-darwin-21
   x86_64-darwin-18
   x86_64-darwin-19
@@ -41,6 +71,9 @@ DEPENDENCIES
   envoy-hooks!
   rake (~> 13.0)
   rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  rubocop-rspec
 
 BUNDLED WITH
    2.3.19

data/README.md

@@ -10,6 +10,7 @@ It has the following three API methods regarding UI Hooks and their subscription
 
 * `upsertSubscription`
 * `triggerUIHooks`
+* `triggerZoneUIHooks`
 * `subscribedUIHooks`
 
 These are the methods listed in [the Jira ticket](https://envoycom.atlassian.net/jira/software/c/projects/DEVP/boards/131?modal=detail&selectedIssue=DEVP-829) describing what's required for the email customization screen and the dynamic email sender.
@@ -171,6 +172,32 @@ hooksService.triggerUIHooks(
 )
 ```
 
+The return value will be an array of objects.  Each object will contain a lot of information, but the most important part is `response` - that will contain the HTML or JSON from the UI Hooks, which will then be used to create the UI.
+### **`triggerZoneUIHooks`**
+
+This is how we fetch custom UI at a Connect zone.  The name "trigger Zone UI Hooks" comes from the fact that we are getting the custom UI from potentially multiple UI Hooks, and we "trigger" them in order to fetch the data.
+
+This will act to fetch the custom UI, which we will receive in the response.
+
+```rb
+hooksService.triggerZoneUIHooks(
+  # REQUIRED
+  zoneIds: [3],
+  triggerName: "welcome_email", # The UI Hook name to invoke (deprecated)
+  triggerNames: ["welcome_email"], # The list of UI Hook extension names to invoke (triggerName or triggerNames required)
+  responseType: "JSON", # only other option is HTML.  Determines whether you get Component JSON or prerendered HTML.
+
+  # XOR REQUIRED
+  resourceId: 341153, # the ID of the invite we are working with
+  resourceIds: [341153, 341153] # array of IDs of the invites we are working with
+
+  # OPTIONAL
+  previewMode: false, # Whether or not to run in preview mode.  Preview mode makes it so you do not need to send in a resourceId
+  accentColor: "#123DEF", # Override the default Envoy accent color on applicable UI components.  Currently only in emails, but that could change.
+  uiHookIds: [2954, 8271], # The specific UI hooks to invoke. If you don't include it, _all_ UI Hook subscriptions that match the locationId and triggerName will trigger.
+)
+```
+
 The return value will be an array of objects.  Each object will contain a lot of information, but the most important part is `response` - that will contain the HTML or JSON from the UI Hooks, which will then be used to create the UI.
 ## Client Config
 

data/envoy-hooks.gemspec

@@ -5,13 +5,13 @@ require_relative 'lib/envoy/hooks/version'
 Gem::Specification.new do |spec|
   spec.name          = 'envoy-hooks'
   spec.version       = Envoy::Hooks::VERSION
-  spec.authors       = ['Jeffrey-Biles-Envoy']
-  spec.email         = ['jeffrey@envoy.com']
+  spec.authors       = ['Jeffrey-Biles-Envoy', 'Anthony-Floccari-Envoy']
+  spec.email         = ['afloccari@envoy.com']
 
   spec.summary       = 'Ruby wrapper for envoy/hooks'
   # spec.description   = "TODO: Write a longer description or delete this line."
   spec.homepage      = 'https://github.com/envoy/envoy-hooks-ruby'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.7')
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 

data/lib/envoy/hooks/version.rb

@@ -2,6 +2,6 @@
 
 module Envoy
   class Hooks
-    VERSION = '0.9.1'
+    VERSION = '0.9.3'
   end
 end

data/lib/envoy/hooks.rb

@@ -9,6 +9,7 @@ module Envoy
     class Error < StandardError; end
 
     attr_reader :jwtToken, :baseUrl, :adapter
+
     def initialize(jwtToken:, baseUrl:, adapter: Faraday.default_adapter, stubs: nil, timeout: 25)
       @jwtToken = jwtToken
       @baseUrl = baseUrl
@@ -30,8 +31,9 @@ module Envoy
     end
 
     # Should we require all these, or can we get some from the environment?
-    def upsertSubscription(subscriptionScope:, clientId:, status:, config: {}, externalId: nil, creatorUserId: nil, authorizedScopes: [])
-      # NOTE - should we be doing these checks in here, or let the API handle it?
+    def upsertSubscription(subscriptionScope:, clientId:, status:, config: {}, externalId: nil, creatorUserId: nil,
+                           authorizedScopes: [])
+      # NOTE: - should we be doing these checks in here, or let the API handle it?
       if !subscriptionScope || !subscriptionScope[:type] || !subscriptionScope[:id]
         raise(Error, 'Must fully define a subscriptionScope for `upsertSubscription`')
       end
@@ -55,9 +57,7 @@ module Envoy
 
       validateEnum('responseType', responseType, %w[HTML JSON])
 
-      unless resourceType.nil?
-        validateEnum('resourceType', resourceType, %w[INVITE ENTRY])
-      end
+      validateEnum('resourceType', resourceType, %w[INVITE ENTRY]) unless resourceType.nil?
 
       faraday.post("/rest/v1/locations/#{locationId}/hooks/ui/trigger", {
                      locationId: locationId,
@@ -72,6 +72,26 @@ module Envoy
                    })
     end
 
+    def triggerZoneUIHooks(responseType:, zoneIds:, triggerNames: [], resourceId: nil, resourceIds: [],
+                           resourceType: nil, accentColor: nil, previewMode: false, uiHookIds: [])
+
+      validateEnum('responseType', responseType, %w[HTML JSON])
+
+      validateEnum('resourceType', resourceType, %w[INVITE ENTRY]) unless resourceType.nil?
+
+      resource_ids = Array(resourceId || resourceIds)
+      faraday.post('/rest/v1/zones/hooks/ui/trigger', {
+                     zoneIds: zoneIds,
+                     triggerNames: triggerNames,
+                     responseType: responseType,
+                     resourceIds: resource_ids,
+                     resourceType: resourceType,
+                     accentColor: accentColor,
+                     previewMode: previewMode,
+                     uiHookIds: uiHookIds
+                   })
+    end
+
     def subscribedUIHooks(locationId: nil, locationIds: [], triggerName: nil, triggerNames: [], includeHidden: false)
       faraday.get('/rest/v1/locations/hooks/ui', {
                     locationId: locationId,
@@ -82,6 +102,14 @@ module Envoy
                   })
     end
 
+    def subscribedZoneUIHooks(zoneIds: [], triggerNames: [], includeHidden: false)
+      faraday.get('/rest/v1/zones/hooks/ui', {
+                    zoneIds: zoneIds,
+                    triggerNames: triggerNames,
+                    includeHidden: includeHidden
+                  })
+    end
+
     def triggerEventHooks(locationId:, userEmail: nil, userEmails: [], triggerName: nil,
                           triggerNames: [], resourceId: nil, eventHookIds: [])
       faraday.post("/rest/v1/locations/#{locationId}/hooks/event/trigger", {
@@ -112,12 +140,8 @@ module Envoy
     )
       validateEnum('clientType', clientType, %w[APP PRODUCT])
       uiHooks.each do |uiHook|
-        if uiHook[:invocationType] != 'STATIC_CONTENT'
-          uiHook[:staticContent] = nil
-        end
-        if uiHook[:invocationType] != 'DYNAMIC_CONTENT'
-          uiHook[:invocationURL] = nil
-        end
+        uiHook[:staticContent] = nil if uiHook[:invocationType] != 'STATIC_CONTENT'
+        uiHook[:invocationURL] = nil if uiHook[:invocationType] != 'DYNAMIC_CONTENT'
       end
       faraday.post("/rest/v1/clients/#{clientId}/config", {
                      clientId: clientId,
@@ -137,7 +161,10 @@ module Envoy
     end
 
     def validateEnum(optionName, testOption, validOptions)
-      raise(Error, "#{optionName} must be one of the allowed options: #{validOptions.join(', ')}") unless validOptions.include?(testOption)
+      return if validOptions.include?(testOption)
+
+      raise(Error,
+            "#{optionName} must be one of the allowed options: #{validOptions.join(', ')}")
     end
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: envoy-hooks
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Jeffrey-Biles-Envoy
-autorequire: 
+- Anthony-Floccari-Envoy
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-04 00:00:00.000000000 Z
+date: 2023-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,9 +53,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 
+description:
 email:
-- jeffrey@envoy.com
+- afloccari@envoy.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -78,7 +79,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/envoy/envoy-hooks-ruby
   source_code_uri: https://github.com/envoy/envoy-hooks-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,15 +87,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for envoy/hooks
 test_files: []