zendesk_apps_support 4.28.0 → 4.29.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 18a2219c066ccf5b47f80f660a62cd4b292810f7
-  data.tar.gz: 32c93abb832fbf273644fcc5e223f9f72b7c178f
+SHA256:
+  metadata.gz: 8a0de7b7d7fcdd4588d5eff4a44ca2b7359630094c9660705f6964867de0324f
+  data.tar.gz: c2184021707a952289f78987019a8aab46fcebe51f094c8e0b5cba28aff57381
 SHA512:
-  metadata.gz: c258716b5eb2ca613b9fb9ae98a13fcaa4aa2aa72c07604ed8d5f965764596a55c6e0cdfbe5964279336b2726923b07744582cead4b64359c5849075a23369dc
-  data.tar.gz: ac7944c1a7b828e567cc2850cea3a013d825c47ef879fcd6494151a8932cc2d82d7951e0e5b2111a4f0eb6629a2d33bf440bfdf4403dd906dc2d0569eb4a1fbb
+  metadata.gz: c523f4bc63ff062085caebc36d05d708fd475661e338811d2ab435c011499333189a55965a3bb1b7b070f16d6ce2103210caf96edaafd13b264fcc19fdd5749e
+  data.tar.gz: b16330afa2508ad09407910ba8887c8e2f7304306d8141493059b71773783189426482b2731e126a0b5464dfa79dbbf19de4f86b912d0b7d47d9085a86e7b51a

data/README.md

@@ -22,7 +22,7 @@ This project uses Rspec, which can be run with `bundle exec rake`.
 
 ## Contribute
 * Put up a PR into the master branch.
-* CC and get two +1 from @zendesk/vegemite.
+* CC and get two +1 from @zendesk/dingo, @zendesk/wattle, or @zendesk/vegemite.
 
 ## Bugs
 Bugs can be reported as an issue here on github, or submitted to support@zendesk.com. By mentioning this project it will assigned to the right team.

data/config/locales/en.yml

@@ -62,7 +62,7 @@ en:
               other: Unsupported MIME types detected in %{file_names}.
             multiple_channel_integrations: Specifying multiple channel integrations
               in requirements.json is not supported.
-            too_many_oauth_parameters: "Too many parameters with type 'oauth': one permitted"
+            oauth_parameter_required: "Please upgrade to our new oauth format. Learn more: %{link}"
             invalid_cr_schema_keys:
               one: 'Custom resources schema contains an invalid key: %{invalid_keys}'
               other: 'Custom resources schema contains invalid keys: %{invalid_keys}'
@@ -78,6 +78,8 @@ en:
               missing:
                 one: 'Missing required oauth field in manifest: %{missing_keys}'
                 other: 'Missing required oauth fields in manifest: %{missing_keys}'
+            too_many_oauth_parameters: 'Too many parameters with type ''oauth'': one
+              permitted'
             missing_source: Could not find app.js
             style_in_template: "<style> tag in %{template}. Use an app.css file instead."
             no_code_for_ifo_notemplate: Javascripts, stylesheets, and templates are
@@ -139,6 +141,8 @@ en:
             invalid_v1_location:
               one: "%{invalid_locations} is an invalid location in framework v1."
               other: "%{invalid_locations} are invalid locations in framework v1."
+            oauth_parameter_cannot_be_secure: oauth parameter cannot be set to be
+              secure.
         warning:
           app_build:
             deprecated_version: You are targeting a deprecated version of the framework.

data/config/locales/translations/zendesk_apps_support.yml

@@ -399,3 +399,7 @@ parts:
       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."
+  - translation:
+      key: "txt.apps.admin.error.app_build.oauth_parameter_cannot_be_secure"
+      title: "oauth parameter cannot be set to be secure."
+      value: "oauth parameter cannot be set to be secure."

data/lib/zendesk_apps_support/location.rb

@@ -64,7 +64,8 @@ module ZendeskAppsSupport
       Location.new(id: 22, name: 'note_editor', product_code: Product::SELL.code, visible: true),
       Location.new(id: 23, name: 'call_log_editor', product_code: Product::SELL.code, visible: true),
       Location.new(id: 24, name: 'email_editor', product_code: Product::SELL.code, visible: true),
-      Location.new(id: 25, name: 'top_bar', product_code: Product::SELL.code, visible: true)
+      Location.new(id: 25, name: 'top_bar', product_code: Product::SELL.code, visible: true),
+      Location.new(id: 26, name: 'visit_editor', product_code: Product::SELL.code, visible: true)
     ].freeze
   end
 end

data/lib/zendesk_apps_support/package.rb

@@ -40,10 +40,10 @@ module ZendeskAppsSupport
         errors << Validations::Source.call(self)
         errors << Validations::Translations.call(self, skip_marketplace_translations: skip_marketplace_translations)
         errors << Validations::Requirements.call(self)
-        errors << Validations::Requests.call(self)
 
         # only adds warnings
         Validations::SecureSettings.call(self)
+        Validations::Requests.call(self)
 
         unless manifest.requirements_only? || manifest.marketing_only? || manifest.iframe_only?
           errors << Validations::Templates.call(self)
@@ -278,6 +278,24 @@ module ZendeskAppsSupport
       end
     end
 
+    def location_icons
+      Hash.new { |h, k| h[k] = {} }.tap do |location_icons|
+        manifest.location_options.each do |location_options|
+          # no location information in the manifest
+          next unless location_options.location
+
+          product = location_options.location.product
+          location_name = location_options.location.name
+          # the location on the product does not support icons
+          next unless LOCATIONS_WITH_ICONS_PER_PRODUCT.fetch(product, []).include?(location_name)
+
+          host = location_options.location.product.name
+          product_directory = manifest.products.count > 1 ? "#{host}/" : ''
+          location_icons[host][location_name] = build_location_icons_hash(location_name, product_directory)
+        end
+      end
+    end
+
     private
 
     def generate_logo_hash(products)
@@ -321,24 +339,6 @@ module ZendeskAppsSupport
       has_file?('assets/banner.png')
     end
 
-    def location_icons
-      Hash.new { |h, k| h[k] = {} }.tap do |location_icons|
-        manifest.location_options.each do |location_options|
-          # no location information in the manifest
-          next unless location_options.location
-
-          product = location_options.location.product
-          location_name = location_options.location.name
-          # the location on the product does not support icons
-          next unless LOCATIONS_WITH_ICONS_PER_PRODUCT.fetch(product, []).include?(location_name)
-
-          host = location_options.location.product.name
-          product_directory = manifest.products.count > 1 ? "#{host}/" : ''
-          location_icons[host][location_name] = build_location_icons_hash(location_name, product_directory)
-        end
-      end
-    end
-
     def build_location_icons_hash(location, product_directory)
       inactive_png = "icon_#{location}_inactive.png"
       if has_file?("assets/#{product_directory}icon_#{location}.svg")

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -10,6 +10,7 @@ module ZendeskAppsSupport
       REQUIRED_MANIFEST_FIELDS = RUBY_TO_JSON.select { |k| %i[author default_locale].include? k }.freeze
       OAUTH_REQUIRED_FIELDS = %w[client_id client_secret authorize_uri access_token_uri].freeze
       PARAMETER_TYPES = ZendeskAppsSupport::Manifest::Parameter::TYPES
+      OAUTH_MANIFEST_LINK = 'https://developer.zendesk.com/apps/docs/developer-guide/manifest#oauth'
 
       class << self
         def call(package)
@@ -33,51 +34,71 @@ module ZendeskAppsSupport
         def collate_manifest_errors(package)
           manifest = package.manifest
 
-          errors = []
-          errors << missing_keys_error(manifest)
-          errors << type_checks(manifest)
-          errors << oauth_error(manifest)
-          errors << default_locale_error(manifest, package)
+          errors = [
+            missing_keys_error(manifest),
+            type_checks(manifest),
+            oauth_error(manifest),
+            default_locale_error(manifest, package),
+            validate_parameters(manifest),
+            if manifest.requirements_only? || manifest.marketing_only?
+              [ ban_location(manifest),
+                ban_framework_version(manifest) ]
+            else
+              [ validate_location(package),
+                missing_framework_version(manifest),
+                invalid_version_error(manifest) ]
+            end,
+            ban_no_template(manifest)
+          ]
+          errors.flatten.compact
+        end
 
+        def validate_location(package)
+          manifest = package.manifest
+          [
+            missing_location_error(package),
+            invalid_location_error(package),
+            invalid_v1_location(package),
+            location_framework_mismatch(manifest)
+          ]
+        end
+
+        def validate_parameters(manifest)
           if manifest.marketing_only?
-            errors.push(*marketing_only_errors(manifest))
+            marketing_only_errors(manifest)
           else
-            errors << parameters_error(manifest)
-            errors << invalid_hidden_parameter_error(manifest)
-            errors << invalid_type_error(manifest)
-            errors << too_many_oauth_parameters(manifest)
-            errors << name_as_parameter_name_error(manifest)
+            [
+              parameters_error(manifest),
+              invalid_hidden_parameter_error(manifest),
+              invalid_type_error(manifest),
+              too_many_oauth_parameters(manifest),
+              oauth_cannot_be_secure(manifest),
+              name_as_parameter_name_error(manifest)
+            ]
           end
+        end
 
-          if manifest.requirements_only? || manifest.marketing_only?
-            errors << ban_location(manifest)
-            errors << ban_framework_version(manifest)
-          else
-            errors << missing_location_error(package)
-            errors << invalid_location_error(package)
-            errors << invalid_v1_location(package)
-            errors << missing_framework_version(manifest)
-            errors << location_framework_mismatch(manifest)
-            errors << invalid_version_error(manifest)
+        def oauth_cannot_be_secure(manifest)
+          manifest.parameters.map do |parameter|
+            if parameter.type == 'oauth' && parameter.secure
+              return ValidationError.new('oauth_parameter_cannot_be_secure')
+            end
           end
-
-          errors << ban_no_template(manifest) if manifest.iframe_only?
-
-          errors.flatten.compact
         end
 
         def marketing_only_errors(manifest)
-          [].tap do |errors|
-            errors << ban_parameters(manifest)
-            errors << private_marketing_app_error(manifest)
-          end
+          [
+            ban_parameters(manifest),
+            private_marketing_app_error(manifest)
+          ]
         end
 
         def type_checks(manifest)
-          errors = []
-          errors << boolean_error(manifest)
-          errors << string_error(manifest)
-          errors << no_template_format_error(manifest)
+          errors = [
+            boolean_error(manifest),
+            string_error(manifest),
+            no_template_format_error(manifest)
+          ]
           unless manifest.experiments.is_a?(Hash)
             errors << ValidationError.new(
               :unacceptable_hash,
@@ -152,6 +173,7 @@ module ZendeskAppsSupport
         end
 
         def ban_no_template(manifest)
+          return unless manifest.iframe_only?
           no_template_migration_link = 'https://developer.zendesk.com/apps/docs/apps-v2/manifest#location'
           if manifest.no_template? || !manifest.no_template_locations.empty?
             ValidationError.new(:no_template_deprecated_in_v2, link: no_template_migration_link)
@@ -176,14 +198,21 @@ module ZendeskAppsSupport
 
         def oauth_error(manifest)
           return unless manifest.oauth
-
+          oauth_errors = []
           missing = OAUTH_REQUIRED_FIELDS.select do |key|
             manifest.oauth[key].nil? || manifest.oauth[key].empty?
           end
 
           if missing.any?
-            ValidationError.new('oauth_keys.missing', missing_keys: missing.join(', '), count: missing.length)
+            oauth_errors << \
+              ValidationError.new('oauth_keys.missing', missing_keys: missing.join(', '), count: missing.length)
+          end
+
+          unless manifest.parameters.any? { |param| param.type == 'oauth' }
+            oauth_errors << ValidationError.new('oauth_parameter_required',
+                                                link: OAUTH_MANIFEST_LINK)
           end
+          oauth_errors
         end
 
         def parameters_error(manifest)

data/lib/zendesk_apps_support/validations/requests.rb

@@ -7,62 +7,25 @@ module ZendeskAppsSupport
   module Validations
     module Requests
       class << self
-        IP_ADDRESS = /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/
-
         def call(package)
-          errors = []
           files = package.js_files + package.html_files
-          private_app = package.manifest.private?
 
           files.each do |file|
             file_content = file.read
 
             http_protocol_urls = find_address_containing_http(file_content)
-            if http_protocol_urls.any?
-              package.warnings << insecure_http_requests_warning(
-                http_protocol_urls,
-                file.relative_path
-              )
-            end
-
-            ip_addresses = file_content.scan(IP_ADDRESS)
-            next unless ip_addresses.any?
-
-            ip_validation_messages = ip_validation_messages(
-              file.relative_path,
-              ip_addresses,
-              private_app
+            next unless http_protocol_urls.any?
+            package.warnings << insecure_http_requests_warning(
+              http_protocol_urls,
+              file.relative_path
             )
-
-            validation_group = private_app ? package.warnings : errors
-            validation_group << ip_validation_messages
           end
 
           package.warnings.flatten!
-          errors
         end
 
         private
 
-        def ip_validation_messages(file_path, ip_addresses, private_app)
-          ip_addresses.each_with_object([]) do |ip_address, messages|
-            ip_type_string = ip_type_string(ip_address)
-            next unless ip_type_string
-
-            string_params = {
-              type: ip_type_string, uri: ip_address, file: file_path
-            }
-            validation_message =
-              if private_app
-                I18n.t('txt.apps.admin.error.app_build.blocked_request', string_params)
-              else
-                ValidationError.new(:blocked_request, string_params)
-              end
-
-            messages << validation_message
-          end
-        end
-
         def insecure_http_requests_warning(http_protocol_urls, relative_path)
           http_protocol_urls = http_protocol_urls.join(
             I18n.t('txt.apps.admin.error.app_build.listing_comma')
@@ -75,19 +38,6 @@ module ZendeskAppsSupport
           )
         end
 
-        def ip_type_string(ip_address)
-          block_type =
-            case IPAddress.parse(ip_address)
-            when proc(&:private?) then 'private'
-            when proc(&:loopback?) then 'loopback'
-            when proc(&:link_local?) then 'link_local'
-            end
-
-          block_type && I18n.t("txt.apps.admin.error.app_build.blocked_request_#{block_type}")
-        rescue ArgumentError
-          nil # Ignore numbers which are not an IP address
-        end
-
         def find_address_containing_http(file_content)
           file_content.scan(URI.regexp(['http'])).map(&:compact).map(&:last)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 4.28.0
+  version: 4.29.4
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -320,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.10
 signing_key: 
 specification_version: 4
 summary: Support to help you develop Zendesk Apps.