zendesk_apps_support 3.3.6 → 3.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b12d11bc57f62df776a651d8d9c06292815c41b
-  data.tar.gz: 5e2e1ec2503c0364e4bbc5b4288e8684a70bdd3b
+  metadata.gz: 911488fbf5c3bbe10e98b1696e6b0915f6894b35
+  data.tar.gz: b383f7790f4ac3a8bc34a0e50b4d6d47e4f79af9
 SHA512:
-  metadata.gz: 51b9342a9ab4d031e565bf9a482ff18f1bc77110148e3a298a805bd7a8d64fc158eb33c899c65a04501ad7312a588d89d584a49f3e5cc16fe5ae214030260826
-  data.tar.gz: 1e11c048c19ea123bce3f012fe07e2866b2e0ddbfa12ea38ff600066680cd9bec364deebe97d007ce27aa259bcd0e316a3c241d11d0cee2db8dbd957001a4dc7
+  metadata.gz: f1ab63b2557319672569094b3561bd63edb21b708091475eacc02833c9be8185b26b693850021436a494ecaea13cc1ce4f670533d99381e83133ba15df217fab
+  data.tar.gz: 9e6a726beb6676c1dafaea5e0f3e1d6ab7d5d271a6f05be4dc0d8ffe56fc7f58b5a2e8494b6d8982a531425aa4b24df18203cea846252be1bca2a7f603712828

data/config/locales/en.yml

@@ -26,6 +26,12 @@ en:
             symlink_in_zip: Symlinks are not allowed in the zip file
             invalid_experiment: 'Manifest specifies unknown or unavailable experiment:
               %{experiment}'
+            unacceptable_hash: The manifest field %{field} needs to be key-value pairs
+              with string keys, but it was %{value}
+            unacceptable_array: The manifest field %{field} needs to be an array,
+              but it was %{value}
+            unacceptable_array_of_strings: The manifest field %{field} need to be
+              an array containing strings
             missing_requirements: Could not find requirements.json
             requirements_not_supported: App requirements are not supported for marketing-only
               apps
@@ -89,6 +95,7 @@ en:
               one: "%{invalid_types} is an invalid parameter type."
               other: "%{invalid_types} are invalid parameter types."
             unacceptable_boolean: '%{field} must be a boolean value, got "%{value}".'
+            unacceptable_string: '%{field} must be a string, got "%{value}".'
             invalid_no_template: noTemplate must be set to true, false, or an array
               of valid locations.
             duplicate_reference: 'Duplicate reference in manifest: "%{key}".'

data/config/locales/translations/zendesk_apps_support.yml

@@ -56,6 +56,18 @@ parts:
       key: "txt.apps.admin.error.app_build.invalid_experiment"
       title: "App builder job: an experiment has been specifed that is not publically available or otherwise invalid. https://en.wikipedia.org/wiki/Manifest_file"
       value: "Manifest specifies unknown or unavailable experiment: %{experiment}"
+  - translation:
+      key: "txt.apps.admin.error.app_build.unacceptable_hash"
+      title: "App builder job: the value for a field needs to be key-value pairs, but it was something else. https://en.wikipedia.org/wiki/Manifest_file"
+      value: "The manifest field %{field} needs to be key-value pairs with string keys, but it was %{value}"
+  - translation:
+      key: "txt.apps.admin.error.app_build.unacceptable_array"
+      title: "App builder job: the value for a field needs to be an array, but it was something else. https://en.wikipedia.org/wiki/Manifest_file"
+      value: "The manifest field %{field} needs to be an array, but it was %{value}"
+  - translation:
+      key: "txt.apps.admin.error.app_build.unacceptable_array_of_strings"
+      title: "App builder job: the value for domainWhitelist needs to be an array of strings, but it was something else. https://en.wikipedia.org/wiki/Manifest_file"
+      value: "The manifest field %{field} need to be an array containing strings"
   - translation:
       key: "txt.apps.admin.error.app_build.missing_requirements"
       title: "App builder job: missing requirements error"
@@ -234,6 +246,10 @@ parts:
       key: "txt.apps.admin.error.app_build.unacceptable_boolean"
       title: "App builder job: this value needs to be either true or false, but something else was passed in. placeholder value is taken from user input. You can translate as: The value %{field} must be a Boolean... to avoid any gender issues."
       value: "%{field} must be a boolean value, got \"%{value}\"."
+  - translation:
+      key: "txt.apps.admin.error.app_build.unacceptable_string"
+      title: "App builder job: this value needs to be a text string, but something else was passed in. placeholder value is taken from user input. You can translate as: The value %{field} must be a string... to avoid any gender issues."
+      value: "%{field} must be a string, got \"%{value}\"."
   - translation:
       key: "txt.apps.admin.error.app_build.invalid_no_template"
       title: "App builder job: `noTemplate` needs to be true, false or a valid array, but something else was passed in. noTemplate, true, and false should not be translated."
@@ -261,4 +277,4 @@ parts:
   - translation:
       key: "txt.apps.admin.error.app_build.invalid_v1_location.other"
       title: "The locations listed are not available in framework v1."
-      value: "%{invalid_locations} are invalid locations in framework v1."
+      value: "%{invalid_locations} are invalid locations in framework v1."

data/lib/zendesk_apps_support/manifest.rb

@@ -107,7 +107,7 @@ module ZendeskAppsSupport
     end
 
     def enabled_experiments
-      (experiments || {}).select { |_k, v| v }.keys
+      experiments.select { |_k, v| v }.keys
     end
 
     def initialize(manifest_text)

data/lib/zendesk_apps_support/manifest/parameter.rb

@@ -3,7 +3,8 @@ module ZendeskAppsSupport
   class Manifest
     class Parameter
       TYPES = %w(text password checkbox url number multiline hidden).freeze
-      attr_reader :name, :type, :required, :secure, :default
+      ATTRIBUTES = %i(name type required secure default).freeze
+      attr_reader(*ATTRIBUTES)
       def default?
         @has_default
       end

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -22,14 +22,13 @@ module ZendeskAppsSupport
 
         private
 
-        # rubocop:disable Metrics/AbcSize
         def collate_manifest_errors(package)
           manifest = package.manifest
 
           errors = []
           errors << missing_keys_error(manifest)
+          errors << type_checks(manifest)
           errors << oauth_error(manifest)
-          errors << boolean_error(manifest)
           errors << default_locale_error(manifest, package)
 
           if manifest.marketing_only?
@@ -40,7 +39,6 @@ module ZendeskAppsSupport
             errors << invalid_hidden_parameter_error(manifest)
             errors << invalid_type_error(manifest)
             errors << name_as_parameter_name_error(manifest)
-            errors << no_template_format_error(manifest)
           end
 
           if manifest.requirements_only? || manifest.marketing_only?
@@ -59,7 +57,55 @@ module ZendeskAppsSupport
 
           errors.flatten.compact
         end
-        # rubocop:enable Metrics/AbcSize
+
+        def type_checks(manifest)
+          errors = []
+          errors << boolean_error(manifest)
+          errors << string_error(manifest)
+          errors << no_template_format_error(manifest)
+          unless manifest.experiments.is_a?(Hash)
+            errors << ValidationError.new(
+              :unacceptable_hash,
+              field: 'experiments',
+              value: manifest.experiments.class.to_s
+            )
+          end
+          whitelist = manifest.domain_whitelist
+          unless whitelist.nil? || whitelist.is_a?(Array) && whitelist.all? { |dom| dom.is_a? String }
+            errors << ValidationError.new(:unacceptable_array_of_strings, field: 'domainWhitelist')
+          end
+          parameters = manifest.original_parameters
+          unless parameters.nil? || parameters.is_a?(Array)
+            errors << ValidationError.new(
+              :unacceptable_array,
+              field: 'parameters',
+              value: parameters.class.to_s
+            )
+          end
+          errors
+        end
+
+        def string_error(manifest)
+          manifest_strings = %i(
+            default_locale
+            version
+            framework_version
+            remote_installation_url
+            terms_conditions_url
+            google_analytics_code
+          )
+          errors = manifest_strings.map do |field|
+            validate_string(manifest.public_send(field), field)
+          end
+
+          if manifest.author
+            author_strings = %w(name email url)
+            errors << (author_strings.map do |field|
+              validate_string(manifest.author[field], "author #{field}")
+            end)
+          end
+          errors
+        end
 
         def boolean_error(manifest)
           booleans = %i(requirements_only marketing_only single_install signed_urls private)
@@ -72,6 +118,12 @@ module ZendeskAppsSupport
           errors.compact
         end
 
+        def validate_string(value, label_for_error)
+          unless value.is_a?(String) || value.nil?
+            ValidationError.new(:unacceptable_string, field: label_for_error, value: value)
+          end
+        end
+
         def validate_boolean(value, label_for_error)
           unless [true, false].include? value
             ValidationError.new(:unacceptable_boolean, field: label_for_error, value: value)
@@ -294,8 +346,7 @@ module ZendeskAppsSupport
           end
         end
 
-        # TODO: support the new location format in the no_template array and check the app actually runs in
-        # included locations
+        # TODO: check the app actually runs in included locations
         def no_template_format_error(manifest)
           no_template = manifest.no_template
           return if [false, true].include? no_template

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 3.3.6
+  version: 3.3.7
 platform: ruby
 authors:
 - James A. Rosen