zendesk_apps_support 4.29.1 → 4.29.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d27dac2cde5663bdcd342904a0c21e60d893ed4e
-  data.tar.gz: ac2c5bd8a24391142e04b72dce853fd7d81b59a8
+  metadata.gz: e89ddab1603d8b47a42131aa838533db345d7b25
+  data.tar.gz: 581fed15b75d31626cfbd0dcbd6fa954a9fb22e2
 SHA512:
-  metadata.gz: 2506afc6138a7144c66227f284f82c464152c162bd492f7a63a3fc1aba81736511ad771ed4d93d1e01eb3cf262a5c227c3180871bc0c51ab28a8d7f8b5cb1ae2
-  data.tar.gz: 9be082b1bdbd0687c4c70b8ff7b986b003355ca2d95a6d5a608199ffa75221abe09f3e99d192d0706e79ada9a76eab35d451b583e4cfa8b5bed401b238487ee3
+  metadata.gz: e9408e37d495fec69e354bb0859ca60b2ec1f06c94094815f8f37b5c0fa1302d0b51cd7aa4cd410ba4b643b2decba2c3e56762f33c161b34fc8317447a93f707
+  data.tar.gz: f015c41838160e6ecb4de15e8ab46961948b9dd776bbcab4ba33d794794f26682830f6de69f626979326449a4bf80969a66330cf46a2e5473945104c6a6b3125

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/sass_functions.rb

@@ -26,9 +26,9 @@ require 'sassc'
 module SassC::Script::Functions
   module AppAssetUrl
     def app_asset_url(name)
-      raise ArgumentError, "Expected #{name} to be a string" unless name.is_a? Sass::Script::Value::String
+      raise ArgumentError, "Expected #{name} to be a string" unless name.is_a? SassC::Script::Value::String
       result = %{url("#{app_asset_url_helper(name)}")}
-      SassC::Script::String.new(result)
+      SassC::Script::Value::String.new(result)
     end
 
     private

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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 4.29.1
+  version: 4.29.6
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -31,16 +31,16 @@ dependencies:
   name: sassc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.11.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.11.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -73,16 +73,16 @@ dependencies:
   name: image_size
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -115,16 +115,22 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: rb-inotify
   requirement: !ruby/object:Gem::Requirement