zendesk_apps_support 4.23.0 → 4.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40c2caa76f6951364c92953a7bdb0c41e3d9d9b9
-  data.tar.gz: 465900fbbd27294f5410e6e6069f371bb679d6cd
+  metadata.gz: b29599afad604e6a6adae9e02073bd95466b9e33
+  data.tar.gz: ee73401ed11aab0e76f126532e95f535d6c07305
 SHA512:
-  metadata.gz: d53c27eaf542b51a4ec004fdc44856b6ca20d08400095b892e27e0bd691de51b2118347e1db530bd2c940b0404e18913ee9b02d6e20fd928319a5ae118a0a57f
-  data.tar.gz: 9c554449f03a09400edb1e040113c6db43fe1426a476487415ae2f639ff34ff4ff24baf349e1c585f0deeaaa2dede8b54b50b8cfa476e90e78522ce7da52643b
+  metadata.gz: 2d0a284d1868be7d4af01943e2db275291d3505585df2ca322cf5e97d2776137e1c224e4220d215cc96da6312e424ebb0e266c553e6793c7b4c304d301608ca7
+  data.tar.gz: b556b25327365c6066954be876a3966bbc9b9ec972754aa8afac61c4aba096dddd6f0776bb291cbd37d55439ed1b0025a4f3ae521883c251f3ad9d33e8550e35

data/config/locales/en.yml

@@ -46,6 +46,9 @@ en:
             requirements_not_json: requirements.json is not proper JSON. %{errors}
             excessive_requirements: The requirements.json file contains too many requirements.
               The current limit is %{max} requirements. This app has %{count} requirements.
+            excessive_custom_objects_requirements: The requirements.json file contains
+              too many custom objects requirements. The current limit is %{max} requirements.
+              This app has %{count} requirements.
             missing_required_fields: 'Missing required fields in requirements.json:
               "%{field}" is required in "%{identifier}"'
             duplicate_requirements:
@@ -62,6 +65,9 @@ en:
             invalid_cr_schema_keys:
               one: 'Custom resources schema contains an invalid key: %{invalid_keys}'
               other: 'Custom resources schema contains invalid keys: %{invalid_keys}'
+            invalid_custom_objects_schema_keys:
+              one: 'Custom objects schema contains an invalid key: %{invalid_keys}'
+              other: 'Custom objects schema contains invalid keys: %{invalid_keys}'
             banner:
               invalid_format: Banner image must be a PNG file.
               invalid_size: Invalid banner image dimensions. Must be %{required_banner_width}x%{required_banner_height}px.

data/config/locales/translations/zendesk_apps_support.yml

@@ -101,6 +101,11 @@ parts:
       key: "txt.apps.admin.error.app_build.excessive_requirements"
       title: "App builder job: requirements file contains too many requirements"
       value: "The requirements.json file contains too many requirements. The current limit is %{max} requirements. This app has %{count} requirements."
+  - translation:
+      key: "txt.apps.admin.error.app_build.excessive_custom_objects_requirements"
+      title: "App builder job: requirements file contains too many custom objects requirements. Leave requirements.json as is (do not localize)"
+      value: "The requirements.json file contains too many custom objects requirements. The current limit is %{max} requirements. This app has %{count} requirements."
+      screenshot: "https://drive.google.com/open?id=18yac8rV7kMe5qm49ERVFVCA7WOZl8vcP"
   - translation:
       key: "txt.apps.admin.error.app_build.missing_required_fields"
       title: "App builder job: required key missing in requirements, e.g. \"title\" is required in \"my_custom_email_target\""
@@ -140,11 +145,23 @@ parts:
       title: "App builder job: custom resources schema contains invalid key error"
       value: "Custom resources schema contains an invalid key: %{invalid_keys}"
       screenshot: "https://drive.google.com/open?id=1-CHVDcmr5mf1DKKeWqiOuGWrW25gDY4y"
+      obsolete: "2020-01-01"
   - translation:
       key: "txt.apps.admin.error.app_build.invalid_cr_schema_keys.other"
       title: "App builder job: custom resources schema contains invalid keys error"
       value: "Custom resources schema contains invalid keys: %{invalid_keys}"
       screenshot: "https://drive.google.com/open?id=1iEx7f7PYnum_qDQESD3Gz2PwLDza3zI0"
+      obsolete: "2020-01-01"
+  - translation:
+      key: "txt.apps.admin.error.app_build.invalid_custom_objects_schema_keys.one"
+      title: "App builder job: custom objects schema contains invalid key error"
+      value: "Custom objects schema contains an invalid key: %{invalid_keys}"
+      screenshot: "https://drive.google.com/open?id=1-CHVDcmr5mf1DKKeWqiOuGWrW25gDY4y"
+  - translation:
+      key: "txt.apps.admin.error.app_build.invalid_custom_objects_schema_keys.other"
+      title: "App builder job: custom objects schema contains invalid keys error"
+      value: "Custom objects schema contains invalid keys: %{invalid_keys}"
+      screenshot: "https://drive.google.com/open?id=1iEx7f7PYnum_qDQESD3Gz2PwLDza3zI0"
   - translation:
       key: "txt.apps.admin.error.app_build.banner.invalid_format"
       title: "App builder job: Banner image invalid format error"

data/lib/zendesk_apps_support/app_requirement.rb

@@ -2,7 +2,7 @@
 
 module ZendeskAppsSupport
   class AppRequirement
-    TYPES = %w[automations channel_integrations custom_resources_schema macros targets views ticket_fields
+    TYPES = %w[automations channel_integrations custom_objects macros targets views ticket_fields
                triggers user_fields organization_fields].freeze
   end
 end

data/lib/zendesk_apps_support/validations/requirements.rb

@@ -4,6 +4,7 @@ module ZendeskAppsSupport
   module Validations
     module Requirements
       MAX_REQUIREMENTS = 5000
+      MAX_CUSTOM_OBJECTS_REQUIREMENTS = 50
 
       class << self
         def call(package)
@@ -24,9 +25,10 @@ module ZendeskAppsSupport
           [].tap do |errors|
             errors << invalid_requirements_types(requirements)
             errors << excessive_requirements(requirements)
+            errors << excessive_custom_objects_requirements(requirements)
             errors << invalid_channel_integrations(requirements)
             errors << invalid_custom_fields(requirements)
-            errors << invalid_custom_resources_schema(requirements)
+            errors << invalid_custom_objects(requirements)
             errors << missing_required_fields(requirements)
             errors.flatten!
             errors.compact!
@@ -44,9 +46,9 @@ module ZendeskAppsSupport
         def missing_required_fields(requirements)
           [].tap do |errors|
             requirements.each do |requirement_type, requirement|
-              next if %w[channel_integrations custom_resources_schema].include? requirement_type
+              next if %w[channel_integrations custom_objects].include? requirement_type
               requirement.each do |identifier, fields|
-                next if fields.include? 'title'
+                next if fields.nil? || fields.include?('title')
                 errors << ValidationError.new(:missing_required_fields,
                                               field: 'title',
                                               identifier: identifier)
@@ -56,10 +58,23 @@ module ZendeskAppsSupport
         end
 
         def excessive_requirements(requirements)
-          count = requirements.values.map(&:values).flatten.size
+          count = requirements.values.map do |req|
+            req.is_a?(Hash) ? req.values : req
+          end.flatten.size
           ValidationError.new(:excessive_requirements, max: MAX_REQUIREMENTS, count: count) if count > MAX_REQUIREMENTS
         end
 
+        def excessive_custom_objects_requirements(requirements)
+          custom_objects = requirements['custom_objects']
+          return unless custom_objects
+
+          count = custom_objects.values.flatten.size
+          if count > MAX_CUSTOM_OBJECTS_REQUIREMENTS
+            ValidationError.new(:excessive_custom_objects_requirements, max: MAX_CUSTOM_OBJECTS_REQUIREMENTS,
+                                                                        count: count)
+          end
+        end
+
         def invalid_custom_fields(requirements)
           user_fields = requirements['user_fields']
           organization_fields = requirements['organization_fields']
@@ -92,23 +107,26 @@ module ZendeskAppsSupport
           end
         end
 
-        def invalid_custom_resources_schema(requirements)
-          custom_resources_schema = requirements['custom_resources_schema']
-          return unless custom_resources_schema
-          valid_schema_keys = %w[resource_types relationship_types]
+        def invalid_custom_objects(requirements)
+          custom_objects = requirements['custom_objects']
+          return if custom_objects.nil?
+
           [].tap do |errors|
-            invalid_keys = custom_resources_schema.keys - valid_schema_keys
-            unless invalid_keys.empty?
-              errors << ValidationError.new(:invalid_cr_schema_keys,
-                                            invalid_keys: invalid_keys.join(', '),
-                                            count: invalid_keys.length)
+            unless custom_objects.key?('custom_object_types')
+              errors << ValidationError.new(:missing_required_fields,
+                                            field: 'custom_object_types',
+                                            identifier: 'custom_objects')
             end
 
-            valid_schema_keys.each do |required_key|
-              next if custom_resources_schema.keys.include? required_key
-              errors << ValidationError.new(:missing_required_fields,
-                                            field: required_key,
-                                            identifier: 'custom_resources_schema')
+            valid_schema = {
+              'custom_object_types' => %w[key schema],
+              'custom_object_relationship_types' => %w[key source target]
+            }
+
+            valid_schema.keys.each do |requirement_type|
+              (custom_objects[requirement_type] || []).each do |requirement|
+                validate_custom_objects_keys(requirement.keys, valid_schema[requirement_type], requirement_type, errors)
+              end
             end
           end
         end
@@ -121,6 +139,15 @@ module ZendeskAppsSupport
                                 count: invalid_types.length)
           end
         end
+
+        def validate_custom_objects_keys(keys, expected_keys, identifier, errors = [])
+          missing_keys = expected_keys - keys
+          missing_keys.each do |key|
+            errors << ValidationError.new(:missing_required_fields,
+                                          field: key,
+                                          identifier: identifier)
+          end
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 4.23.0
+  version: 4.25.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n