zendesk_apps_support 3.3.3 → 3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8760acb02112cebac8b8daca8460f1faedad4e64
-  data.tar.gz: 17b865646f23c21bcdc07a91e9b045107952e3ae
+  metadata.gz: c2cdd80ab3e773cb08066ad7b85e520150249eee
+  data.tar.gz: 2c2ed26d634b62778a2807c8122afca66929623d
 SHA512:
-  metadata.gz: 63f2b79999d8f52ffb0653a3d59788dbb286c34ab8d7c346a03123997deb602459be6e99e5b7df86f82723775bdbde6cfaec33beffdc469a2f6fcdd4dc694a83
-  data.tar.gz: 884dca14e438507f1034090774b9c51d5bce8b9079769095db5302cbb4f340868757e57e0e525a9e8bb53d85dbbc81fd63cb74f3127fd5fd9df0f06cc4899741
+  metadata.gz: 6bb71ca453c6f05e157e2a650bb435ae7efe0753d7426dc04baeba82dfe5f33dfeb6f910f14b1cea25d5c699c69ce28d2f65803def6f9fc72c9a06801d0726e7
+  data.tar.gz: 448acbd4700429e4ed500a5a3750452f63d38a3df43dd1b7a09fd48938b8ef0695fc2dcb0262bfefa793b11f9fc3920460793b29c2eabc0b21fd1e08dd21ce9a

data/config/locales/en.yml

@@ -97,6 +97,9 @@ en:
               version.
             locations_cant_be_urls: App locations must not be URLs for this framework
               version.
+            invalid_v1_location:
+              one: "%{invalid_locations} is an invalid location in framework v1."
+              other: "%{invalid_locations} are invalid locations in framework v1."
         warning:
           app_build:
             deprecated_version: You are targeting a deprecated version of the framework.

data/config/locales/translations/zendesk_apps_support.yml

@@ -250,3 +250,11 @@ parts:
       key: "txt.apps.admin.error.app_build.locations_cant_be_urls"
       title: "The locations can't be URLs, but they were."
       value: "App locations must not be URLs for this framework version."
+  - translation:
+      key: "txt.apps.admin.error.app_build.invalid_v1_location.one"
+      title: "The location listed is not available in framework v1."
+      value: "%{invalid_locations} is an invalid location in framework v1."
+  - 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."

data/lib/zendesk_apps_support/location.rb

@@ -2,7 +2,7 @@
 module ZendeskAppsSupport
   class Location
     extend ZendeskAppsSupport::Finders
-    attr_reader :id, :name, :orderable, :product_code
+    attr_reader :id, :name, :orderable, :product_code, :v2_only
 
     def self.unique_ids
       @ids ||= Set.new
@@ -15,6 +15,7 @@ module ZendeskAppsSupport
       @name = attrs.fetch(:name)
       @orderable = attrs.fetch(:orderable)
       @product_code = attrs.fetch(:product_code)
+      @v2_only = attrs.fetch(:v2_only, product != Product::SUPPORT)
     end
 
     def product
@@ -35,11 +36,15 @@ module ZendeskAppsSupport
       Location.new(id: 6, orderable: true, name: 'organization_sidebar', product_code: Product::SUPPORT.code),
       Location.new(id: 7, orderable: false, name: 'background', product_code: Product::SUPPORT.code),
       Location.new(id: 8, orderable: true, name: 'chat_sidebar', product_code: Product::CHAT.code),
-      Location.new(id: 9, orderable: false, name: 'modal', product_code: Product::SUPPORT.code),
-      Location.new(id: 10, orderable: false, name: 'ticket_editor', product_code: Product::SUPPORT.code),
-      Location.new(id: 11, orderable: false, name: 'nav_bar', product_code: Product::STANDALONE_CHAT.code),
+      Location.new(id: 9, orderable: false, name: 'modal', product_code: Product::SUPPORT.code,
+                   v2_only: true),
+      Location.new(id: 10, orderable: false, name: 'ticket_editor', product_code: Product::SUPPORT.code,
+                   v2_only: true),
+      Location.new(id: 11, orderable: false, name: 'nav_bar', product_code: Product::STANDALONE_CHAT.code,
+                   v2_only: false),
       Location.new(id: 12, orderable: false, name: 'system_top_bar', product_code: Product::SUPPORT.code),
-      Location.new(id: 13, orderable: false, name: 'system_top_bar', product_code: Product::STANDALONE_CHAT.code)
+      Location.new(id: 13, orderable: false, name: 'system_top_bar', product_code: Product::STANDALONE_CHAT.code,
+                   v2_only: false)
     ].freeze
   end
 end

data/lib/zendesk_apps_support/manifest.rb

@@ -80,8 +80,11 @@ module ZendeskAppsSupport
     end
 
     def unknown_locations(host)
+      product = Product.find_by(name: host)
+
       if locations.key?(host)
-        locations[host].keys.uniq - Location::LOCATIONS_AVAILABLE.map(&:name)
+        product_locations = Location.where(product_code: product.code)
+        locations[host].keys.uniq - product_locations.map(&:name)
       else
         []
       end

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -1,3 +1,4 @@
+# rubocop:disable ModuleLength
 # frozen_string_literal: true
 require 'uri'
 
@@ -6,17 +7,29 @@ module ZendeskAppsSupport
     module Manifest
       RUBY_TO_JSON = ZendeskAppsSupport::Manifest::RUBY_TO_JSON
       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
+      OAUTH_REQUIRED_FIELDS = %w(client_id client_secret authorize_uri access_token_uri).freeze
       PARAMETER_TYPES = ZendeskAppsSupport::Manifest::Parameter::TYPES
 
-      class <<self
+      class << self
         def call(package)
           return [ValidationError.new(:missing_manifest)] unless package.has_file?('manifest.json')
+
+          collate_manifest_errors(package)
+
+        rescue JSON::ParserError => e
+          return [ValidationError.new(:manifest_not_json, errors: e)]
+        end
+
+        private
+
+        def collate_manifest_errors(package)
           manifest = package.manifest
 
           errors = []
           errors << missing_keys_error(manifest)
           errors << oauth_error(manifest)
+          errors << boolean_error(manifest)
+          errors << default_locale_error(manifest, package)
 
           if manifest.marketing_only?
             errors << ban_parameters(manifest)
@@ -27,10 +40,6 @@ module ZendeskAppsSupport
             errors << name_as_parameter_name_error(manifest)
             errors << no_template_format_error(manifest)
           end
-          errors << boolean_error(manifest)
-          errors << default_locale_error(manifest, package)
-
-          errors << ban_no_template(manifest) if manifest.iframe_only?
 
           if manifest.requirements_only? || manifest.marketing_only?
             errors << ban_location(manifest)
@@ -38,18 +47,17 @@ module ZendeskAppsSupport
           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, package)
           end
 
+          errors << ban_no_template(manifest) if manifest.iframe_only?
+
           errors.flatten.compact
-        rescue JSON::ParserError => e
-          return [ValidationError.new(:manifest_not_json, errors: e)]
         end
 
-        private
-
         def boolean_error(manifest)
           booleans = %i(requirements_only marketing_only single_install signed_urls private)
           errors = []
@@ -178,6 +186,23 @@ module ZendeskAppsSupport
           errors
         end
 
+        def invalid_v1_location(package)
+          return unless package.manifest.framework_version &&
+                        Gem::Version.new(package.manifest.framework_version) < Gem::Version.new('2')
+
+          invalid_locations = package.manifest.location_options
+                                     .map(&:location)
+                                     .compact
+                                     .select(&:v2_only)
+                                     .map(&:name)
+
+          unless invalid_locations.empty?
+            return ValidationError.new(:invalid_v1_location,
+                                       invalid_locations: invalid_locations.join(', '),
+                                       count: invalid_locations.length)
+          end
+        end
+
         def invalid_location_uri_error(package, path)
           return nil if path == ZendeskAppsSupport::Manifest::LEGACY_URI_STUB
           validation_error = ValidationError.new(:invalid_location_uri, uri: path)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.3.4
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Support to help you develop Zendesk Apps.