zendesk_apps_support 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4dd2daecb448295a2847cc9d879318f8b6011ba0
-  data.tar.gz: b3cab095bb292245d829e3577c3f58e95118b992
+  metadata.gz: 8f36f2639f048681823a88ef9669638499ce53d2
+  data.tar.gz: 526ed308014fe9475d670597f63904a112ecdd5c
 SHA512:
-  metadata.gz: 0120e92ede4d68764a5727116a2fcb21e6d928e10b528e0333f4f76e4078b06133b1e437717ee1da8ba6ebfd3a2edd69e445b37aa27b3fc0f545deafdea64318
-  data.tar.gz: 9fa406bf712f245602583e334a02fa14c3a220e6531714c6173d5e0a2d01bfb8a514b83178886f89b029643a64c08ac25d6fade7d3ce82dd68965d29ed13960f
+  metadata.gz: 881df6e418a86e65c7e8774b72f96924fd2b5d4aa96ffa34bb27d1f9fadc141d852835cc6677ceae7bfcad3284399b785f788c91547b982f20e5d109319a3b0b
+  data.tar.gz: d49736cdfb17419959dadee4b5755f0ef709432d0ffea53bf86655fe57ed5ec9794c1ea4276a8dcd3c9c93fe6be183f54dc23725fc19904295d5aff831e307dc

data/config/locales/en.yml

@@ -47,8 +47,8 @@ en:
             style_in_template: "<style> tag in %{template}. Use an app.css file instead."
             no_code_for_ifo_notemplate: Javascripts, stylesheets, and templates are
               not allowed when an iframe URI or noTemplate is specified
-            invalid_default_locale: "%{defaultLocale} is not a valid default locale."
-            missing_translation_file: 'Missing translation file for locale ''%{defaultLocale}''.
+            invalid_default_locale: "%{default_locale} is not a valid default locale."
+            missing_translation_file: 'Missing translation file for locale ''%{default_locale}''.
               Please read: http://developer.zendesk.com/documentation/apps/i18n.html'
             invalid_host: "%{host_name} is an invalid host for apps."
             invalid_location:
@@ -77,6 +77,12 @@ en:
             invalid_type_parameter:
               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}"'
+            invalid_no_template: noTemplate must be set to true, false, or an array
+              of valid locations.
+            duplicate_reference: 'Duplicate reference in manifest: "%{key}".'
+            duplicate_reference_values: Initially set to "%{original}", attempted
+              overwrite to "%{attempted}".
         warning:
           app_build:
             deprecated_version: You are targeting a deprecated version of the framework.

data/config/locales/translations/zendesk_apps_support.yml

@@ -115,11 +115,11 @@ parts:
   - translation:
       key: "txt.apps.admin.error.app_build.invalid_default_locale"
       title: "App builder job: invalid default locale"
-      value: "%{defaultLocale} is not a valid default locale."
+      value: "%{default_locale} is not a valid default locale."
   - translation:
       key: "txt.apps.admin.error.app_build.missing_translation_file"
       title: "App builder job: missing translation file"
-      value: "Missing translation file for locale '%{defaultLocale}'. Please read: http://developer.zendesk.com/documentation/apps/i18n.html"
+      value: "Missing translation file for locale '%{default_locale}'. Please read: http://developer.zendesk.com/documentation/apps/i18n.html"
   - translation:
       key: "txt.apps.admin.error.app_build.invalid_host"
       title: "App builder job: invalid host application for apps"
@@ -204,3 +204,19 @@ parts:
       key: "txt.apps.admin.error.app_build.invalid_type_parameter.other"
       title: "App builder job: multiple invalid parameter types error"
       value: "%{invalid_types} are invalid parameter types."
+  - translation:
+      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"
+      value: "%{field} must be a Boolean value, 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."
+      value: "noTemplate must be set to true, false, or an array of valid locations."
+  - translation:
+      key: "txt.apps.admin.error.app_build.duplicate_reference"
+      title: "App builder job: a key was included twice in the supplied manifest file, but it is only allowed once"
+      value: "Duplicate reference in manifest: \"%{key}\"."
+  - translation:
+      key: "txt.apps.admin.error.app_build.duplicate_reference_values"
+      title: "This sentence follows txt.apps.admin.error.app_build.duplicate_reference. The values are included to help find the problem."
+      value: "Initially set to \"%{original}\", attempted overwrite to \"%{attempted}\"."

data/lib/zendesk_apps_support/manifest/no_override_hash.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+require 'json'
+
+module ZendeskAppsSupport
+  class Manifest
+    class OverrideError < StandardError
+      attr_reader :key, :original, :attempted
+      attr_accessor :message
+      def initialize(key, original, attempted)
+        @key = key
+        @original = original
+        @attempted = attempted
+      end
+
+      def message
+        @message ||= begin
+          translated_error_key = 'txt.apps.admin.error.app_build.duplicate_reference'
+          translated_error = ZendeskAppsSupport::I18n.t(translated_error_key, key: key)
+
+          # if the error contains the word `_legacy` in the second sentence, let's
+          # only use the first one.
+          if [original, attempted].any? { |val| val =~ /_legacy/ }
+            return translated_error
+          end
+          translated_detail_key = 'txt.apps.admin.error.app_build.duplicate_reference_values'
+          translated_detail = ZendeskAppsSupport::I18n.t(translated_detail_key,
+                                                         original: original,
+                                                         attempted: attempted)
+          "#{translated_error} #{translated_detail}"
+        end
+      end
+    end
+
+    class NoOverrideHash < Hash
+      class << self
+        def [](array)
+          new.tap do |hash|
+            array.each do |key, value|
+              hash[key] = value
+            end
+          end
+        end
+      end
+
+      def []=(key, value)
+        raise OverrideError.new(key, self[key], value) if key? key
+        super
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/manifest/parameter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module ZendeskAppsSupport
+  class Manifest
+    class Parameter
+      TYPES = %w(text password checkbox url number multiline hidden).freeze
+      attr_reader :name, :type, :required, :secure, :default
+      def default?
+        @has_default
+      end
+
+      def initialize(p)
+        @name = p['name']
+        @type = p['type'] || 'text'
+        @required = p['required'] || false
+        @secure = p['secure'] || false
+        @has_default = p.key? 'default'
+        @default = p['default'] if @has_default
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/manifest.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+module ZendeskAppsSupport
+  class Manifest
+    LEGACY_URI_STUB = '_legacy'
+
+    RUBY_TO_JSON = {
+      requirements_only: 'requirementsOnly',
+      version: 'version',
+      author: 'author',
+      framework_version: 'frameworkVersion',
+      single_install: 'singleInstall',
+      signed_urls: 'signedUrls',
+      no_template: 'noTemplate',
+      default_locale: 'defaultLocale',
+      original_locations: 'location',
+      private: 'private',
+      oauth: 'oauth',
+      original_parameters: 'parameters',
+      domain_whitelist: 'domainWhitelist',
+      remote_installation_url: 'remoteInstallationURL',
+      terms_conditions_url: 'termsConditionsURL',
+      google_analytics_code: 'gaID'
+    }.freeze
+
+    attr_reader(*RUBY_TO_JSON.keys)
+
+    alias_method :requirements_only?, :requirements_only
+    alias_method :signed_urls?, :signed_urls
+    alias_method :single_install?, :single_install
+    alias_method :private?, :private
+
+    def no_template?
+      if no_template.is_a?(Array)
+        false
+      else
+        no_template
+      end
+    end
+
+    def no_template_locations
+      no_template || []
+    end
+
+    def location?
+      !locations.values.all?(&:empty?)
+    end
+
+    def locations
+      @locations ||=
+        case original_locations
+        when Hash
+          @used_hosts = original_locations.keys
+          replace_legacy_locations original_locations
+        when Array
+          @used_hosts = ['support']
+          { 'support' => NoOverrideHash[original_locations.map { |location| [ location, LEGACY_URI_STUB ] }] }
+        when String
+          @used_hosts = ['support']
+          { 'support' => { original_locations => LEGACY_URI_STUB } }
+        # TODO: error out for numbers and Booleans
+        else # NilClass
+          @used_hosts = ['support']
+          { 'support' => {} }
+        end
+    end
+
+    def unknown_hosts
+      @unknown_hosts ||= @used_hosts - Product::PRODUCTS_AVAILABLE.flat_map { |p| [p.name, p.legacy_name] }
+    end
+
+    def iframe_only?
+      Gem::Version.new(framework_version) >= Gem::Version.new('2')
+    end
+
+    def parameters
+      @parameters ||= begin
+        parameter_array = @original_parameters.is_a?(Array) ? @original_parameters : []
+        parameter_array.map do |parameter_hash|
+          Parameter.new(parameter_hash)
+        end
+      end
+    end
+
+    def initialize(manifest_text)
+      m = parse_json(manifest_text)
+      RUBY_TO_JSON.each do |ruby, json|
+        instance_variable_set(:"@#{ruby}", m[json])
+      end
+      @requirements_only ||= false
+      @single_install ||= false
+      @private = m.fetch('private', true)
+      @signed_urls ||= false
+      @no_template ||= false
+    end
+
+    private
+
+    def replace_legacy_locations(original_locations)
+      NoOverrideHash.new.tap do |new_locations_obj|
+        Product::PRODUCTS_AVAILABLE.each do |product|
+          product_key = product.name.to_s
+          legacy_key = product.legacy_name.to_s
+          value_for_product = original_locations.fetch(product_key, original_locations[legacy_key])
+          value_for_product && new_locations_obj[product_key] = value_for_product
+        end
+      end
+    end
+
+    def parse_json(manifest_text)
+      parser_opts = { object_class: Manifest::NoOverrideHash }
+      JSON.parse(manifest_text, parser_opts)
+    end
+  end
+end

data/lib/zendesk_apps_support/package.rb

@@ -1,19 +1,19 @@
+# frozen_string_literal: true
 require 'pathname'
 require 'erubis'
 require 'json'
 
 module ZendeskAppsSupport
   class Package
+    extend Gem::Deprecate
     include ZendeskAppsSupport::BuildTranslation
 
-    REQUIREMENTS_FILENAME = "requirements.json"
+    REQUIREMENTS_FILENAME = 'requirements.json'
 
     DEFAULT_LAYOUT = Erubis::Eruby.new(File.read(File.expand_path('../assets/default_template.html.erb', __FILE__)))
     DEFAULT_SCSS   = File.read(File.expand_path('../assets/default_styles.scss', __FILE__))
     SRC_TEMPLATE   = Erubis::Eruby.new(File.read(File.expand_path('../assets/src.js.erb', __FILE__)))
 
-    LEGACY_URI_STUB = '_legacy'
-
     attr_reader :lib_root, :root, :warnings
 
     def initialize(dir, is_cached = true)
@@ -34,7 +34,7 @@ module ZendeskAppsSupport
           errors << Validations::Source.call(self)
           errors << Validations::Translations.call(self)
 
-          unless manifest_json['requirementsOnly']
+          unless manifest.requirements_only?
             errors << Validations::Templates.call(self)
             errors << Validations::Stylesheets.call(self)
           end
@@ -116,40 +116,41 @@ module ZendeskAppsSupport
 
       locale = options.fetch(:locale, 'en')
 
-      source = iframe_only? ? nil : app_js
-      version = manifest_json['version']
+      source = manifest.iframe_only? ? nil : app_js
       app_class_name = "app-#{app_id}"
-      author = manifest_json['author']
-      framework_version = manifest_json['frameworkVersion']
-      single_install = manifest_json['singleInstall'] || false
-      signed_urls = manifest_json['signedUrls'] || false
-      templates = is_no_template ? {} : compiled_templates(app_id, asset_url_prefix)
+      # if no_template is an array, we still need the templates
+      templates = manifest.no_template == true ? {} : compiled_templates(app_id, asset_url_prefix)
 
       app_settings = {
-        location: locations,
-        noTemplate: no_template_locations,
-        singleInstall: single_install,
-        signedUrls: signed_urls
+        location: manifest.locations,
+        noTemplate: manifest.no_template_locations,
+        singleInstall: manifest.single_install?,
+        signedUrls: manifest.signed_urls?
       }.select { |_k, v| !v.nil? }
 
       SRC_TEMPLATE.result(
         name: name,
-        version: version,
+        version: manifest.version,
         source: source,
         app_settings: app_settings,
         asset_url_prefix: asset_url_prefix,
         app_class_name: app_class_name,
-        author: author,
+        author: manifest.author,
         translations: runtime_translations(translations_for(locale)),
-        framework_version: framework_version,
+        framework_version: manifest.framework_version,
         templates: templates,
         modules: commonjs_modules,
-        iframe_only: iframe_only?
+        iframe_only: manifest.iframe_only?
       )
     end
 
     def manifest_json
-      @manifest ||= read_json('manifest.json')
+      @manifest_json ||= read_json('manifest.json')
+    end
+    deprecate :manifest_json, :manifest, 2016, 9
+
+    def manifest
+      @manifest ||= Manifest.new(read_file('manifest.json'))
     end
 
     def requirements_json
@@ -158,20 +159,14 @@ module ZendeskAppsSupport
     end
 
     def is_no_template
-      if manifest_json['noTemplate'].is_a?(Array)
-        false
-      else
-        !!manifest_json['noTemplate']
-      end
+      manifest.no_template?
     end
+    deprecate :is_no_template, 'manifest.no_template?', 2016, 9
 
     def no_template_locations
-      if manifest_json['noTemplate'].is_a?(Array)
-        manifest_json['noTemplate']
-      else
-        !!manifest_json['noTemplate']
-      end
+      manifest.no_template_locations
     end
+    deprecate :no_template_locations, 'manifest.no_template_locations', 2016, 9
 
     def compiled_templates(app_id, asset_url_prefix)
       compiled_css = ZendeskAppsSupport::StylesheetCompiler.new(DEFAULT_SCSS + app_css, app_id, asset_url_prefix).compile
@@ -186,12 +181,13 @@ module ZendeskAppsSupport
     def translations_for(locale)
       trans = translations
       return trans[locale] if trans[locale]
-      trans[self.manifest_json['defaultLocale']]
+      trans[manifest.default_locale]
     end
 
     def has_location?
-      manifest_json['location']
+      manifest.location?
     end
+    deprecate :has_location?, 'manifest.location?', 2016, 9
 
     def has_file?(path)
       File.exist?(path_to(path))
@@ -204,26 +200,17 @@ module ZendeskAppsSupport
     end
 
     def locations
-      locations = manifest_json['location']
-      case locations
-      when Hash
-        locations
-      when Array
-        { 'zendesk' => Hash[locations.map { |location| [ location, LEGACY_URI_STUB ] }] }
-      when String
-        { 'zendesk' => { locations => LEGACY_URI_STUB } }
-      else # NilClass
-        { 'zendesk' => {} }
-      end
+      manifest.locations
     end
+    deprecate :locations, 'manifest.locations', 2016, 9
 
     def iframe_only?
-      !legacy_non_iframe_app?
+      manifest.iframe_only?
     end
+    deprecate :iframe_only?, 'manifest.iframe_only?', 2016, 9
 
     private
 
-
     def runtime_translations(translations)
       result = translations.dup
       result.delete('name')
@@ -233,11 +220,6 @@ module ZendeskAppsSupport
       result
     end
 
-    def legacy_non_iframe_app?
-      iframe_urls = locations.values.flat_map(&:values)
-      iframe_urls.all? { |l| l == LEGACY_URI_STUB }
-    end
-
     def templates
       templates_dir = File.join(root, 'templates')
       Dir["#{templates_dir}/*.hdbs"].inject({}) do |memo, file|
@@ -255,13 +237,13 @@ module ZendeskAppsSupport
         translation_dir = File.join(root, 'translations')
         return {} unless File.directory?(translation_dir)
 
-        locale_path = "#{translation_dir}/#{self.manifest_json['defaultLocale']}.json"
+        locale_path = "#{translation_dir}/#{manifest.default_locale}.json"
         default_translations = process_translations(locale_path)
 
         Dir["#{translation_dir}/*.json"].inject({}) do |memo, path|
           locale = File.basename(path, File.extname(path))
 
-          locale_translations = if locale == self.manifest_json['defaultLocale']
+          locale_translations = if locale == manifest.default_locale
             default_translations
           else
             deep_merge_hash(default_translations, process_translations(path))
@@ -325,10 +307,10 @@ module ZendeskAppsSupport
       File.read(path_to(path))
     end
 
-    def read_json(path)
+    def read_json(path, parser_opts = {})
       file = read_file(path)
       unless file.nil?
-        JSON.parse(read_file(path))
+        JSON.parse(read_file(path), parser_opts)
       end
     end
   end

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -4,26 +4,27 @@ require 'uri'
 module ZendeskAppsSupport
   module Validations
     module Manifest
-      REQUIRED_MANIFEST_FIELDS = %w( author defaultLocale ).freeze
-      OAUTH_REQUIRED_FIELDS    = %w( client_id client_secret authorize_uri access_token_uri ).freeze
-      TYPES_AVAILABLE          = %w( text password checkbox url number multiline hidden ).freeze
+      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
 
       class <<self
         def call(package)
           return [ValidationError.new(:missing_manifest)] unless package.has_file?('manifest.json')
-
-          manifest = package.manifest_json
+          manifest = package.manifest
 
           errors = []
           errors << missing_keys_error(manifest)
-          errors << default_locale_error(manifest, package)
           errors << oauth_error(manifest)
           errors << parameters_error(manifest)
           errors << invalid_hidden_parameter_error(manifest)
           errors << invalid_type_error(manifest)
           errors << name_as_parameter_name_error(manifest)
+          errors << no_template_format_error(manifest)
+          errors << boolean_error(manifest)
+          errors << default_locale_error(manifest, package)
 
-          if manifest['requirementsOnly']
+          if manifest.requirements_only?
             errors << ban_location(manifest)
             errors << ban_framework_version(manifest)
           else
@@ -31,8 +32,8 @@ module ZendeskAppsSupport
             errors << invalid_location_error(package)
             errors << duplicate_location_error(manifest)
             errors << missing_framework_version(manifest)
+            errors << location_framework_mismatch(manifest)
             errors << invalid_version_error(manifest, package)
-            errors << framework_version_iframe_only(package, manifest)
           end
 
           errors.flatten.compact
@@ -42,19 +43,42 @@ module ZendeskAppsSupport
 
         private
 
+        def boolean_error(manifest)
+          booleans = %i(requirements_only single_install signed_urls private)
+          errors = []
+          RUBY_TO_JSON.each do |ruby, json|
+            if booleans.include? ruby
+              errors << validate_boolean(manifest.public_send(ruby), json)
+            end
+          end
+          errors.compact
+        end
+
+        def validate_boolean(value, label_for_error)
+          unless [true, false].include? value
+            ValidationError.new(:unacceptable_boolean, field: label_for_error, value: value)
+          end
+        end
+
+        def check_errors(error_types, collector, *checked_objects)
+          error_types.each do |error_type|
+            collector << send(error_type, *checked_objects)
+          end
+        end
+
         def ban_location(manifest)
-          ValidationError.new(:no_location_required) unless manifest['location'].nil?
+          ValidationError.new(:no_location_required) if manifest.location?
         end
 
         def ban_framework_version(manifest)
-          ValidationError.new(:no_framework_version_required) unless manifest['frameworkVersion'].nil?
+          ValidationError.new(:no_framework_version_required) unless manifest.framework_version.nil?
         end
 
         def oauth_error(manifest)
-          return unless manifest['oauth']
+          return unless manifest.oauth
 
           missing = OAUTH_REQUIRED_FIELDS.select do |key|
-            manifest['oauth'][key].nil? || manifest['oauth'][key].empty?
+            manifest.oauth[key].nil? || manifest.oauth[key].empty?
           end
 
           if missing.any?
@@ -63,78 +87,86 @@ module ZendeskAppsSupport
         end
 
         def parameters_error(manifest)
-          return unless manifest['parameters']
-
-          unless manifest['parameters'].is_a?(Array)
+          original = manifest.original_parameters
+          unless original.nil? || original.is_a?(Array)
             return ValidationError.new(:parameters_not_an_array)
           end
 
-          para_names = manifest['parameters'].collect { |para| para['name'] }
+          return unless manifest.parameters.any?
+
+          para_names = manifest.parameters.map(&:name)
           duplicate_parameters = para_names.select { |name| para_names.count(name) > 1 }.uniq
           unless duplicate_parameters.empty?
             return ValidationError.new(:duplicate_parameters, duplicate_parameters: duplicate_parameters)
           end
+
+          invalid_required = manifest.parameters.map do |parameter|
+            validate_boolean(parameter.required, "parameters.#{parameter.name}.required")
+          end.compact
+          return invalid_required if invalid_required.any?
+
+          invalid_secure = manifest.parameters.map do |parameter|
+            validate_boolean(parameter.secure, "parameters.#{parameter.name}.secure")
+          end.compact
+          return invalid_secure if invalid_secure.any?
         end
 
         def missing_keys_error(manifest)
-          missing = REQUIRED_MANIFEST_FIELDS.select do |key|
-            manifest[key].nil?
-          end
+          missing = REQUIRED_MANIFEST_FIELDS.map do |ruby_method, manifest_value|
+            manifest_value if manifest.public_send(ruby_method).nil?
+          end.compact
 
           missing_keys_validation_error(missing) if missing.any?
         end
 
         def default_locale_error(manifest, package)
-          default_locale = manifest['defaultLocale']
+          default_locale = manifest.default_locale
           unless default_locale.nil?
             if default_locale !~ Translations::VALID_LOCALE
-              ValidationError.new(:invalid_default_locale, defaultLocale: default_locale)
+              ValidationError.new(:invalid_default_locale, default_locale: default_locale)
             elsif package.translation_files.detect { |file| file.relative_path == "translations/#{default_locale}.json" }.nil?
-              ValidationError.new(:missing_translation_file, defaultLocale: default_locale)
+              ValidationError.new(:missing_translation_file, default_locale: default_locale)
             end
           end
         end
 
         def missing_location_error(package)
-          missing_keys_validation_error(['location']) unless package.has_location?
+          missing_keys_validation_error(['location']) unless package.manifest.location?
         end
 
         def invalid_location_error(package)
           errors = []
-          manifest_locations = package.locations
+          manifest_locations = package.manifest.locations
           manifest_locations.find do |host, locations|
-            # CRUFT: remove when support for legacy names are deprecated
-            product = Product.find_by(legacy_name: host) || Product.find_by(name: host)
-            error = if product.nil?
-              ValidationError.new(:invalid_host, host_name: host)
-            elsif (invalid_locations = locations.keys - Location.where(product_code: product.code).map(&:name)).any?
-              ValidationError.new(:invalid_location,
+            product = Product.find_by(name: host)
+            stub = ZendeskAppsSupport::Manifest::LEGACY_URI_STUB
+            locations_allowed = Location.where(product_code: product.code).map(&:name).push(stub)
+            if (invalid_locations = locations.keys - locations_allowed).any?
+              errors << ValidationError.new(:invalid_location,
                                   invalid_locations: invalid_locations.join(', '),
                                   host_name: host,
                                   count: invalid_locations.length)
             end
 
-            # abort early for invalid host or location name
-            if error
-              errors << error
-              break
-            end
-
             locations.values.each do |path|
               errors << invalid_location_uri_error(package, path)
             end
           end
+
+          package.manifest.unknown_hosts.each do |unknown_host|
+            errors << ValidationError.new(:invalid_host, host_name: unknown_host)
+          end
           errors
         end
 
         def invalid_location_uri_error(package, path)
-          return nil if path == Package::LEGACY_URI_STUB
+          return nil if path == ZendeskAppsSupport::Manifest::LEGACY_URI_STUB
           validation_error = ValidationError.new(:invalid_location_uri, uri: path)
           uri = URI.parse(path)
           unless uri.absolute? ? valid_absolute_uri?(uri) : valid_relative_uri?(package, uri)
             validation_error
           end
-        rescue URI::InvalidURIError => e
+        rescue URI::InvalidURIError
           validation_error
         end
 
@@ -147,7 +179,7 @@ module ZendeskAppsSupport
         end
 
         def duplicate_location_error(manifest)
-          locations           = *manifest['location']
+          locations           = *manifest.locations
           duplicate_locations = *locations.select { |location| locations.count(location) > 1 }.uniq
 
           unless duplicate_locations.empty?
@@ -156,12 +188,12 @@ module ZendeskAppsSupport
         end
 
         def missing_framework_version(manifest)
-          missing_keys_validation_error(['frameworkVersion']) if manifest['frameworkVersion'].nil?
+          missing_keys_validation_error([RUBY_TO_JSON[:framework_version]]) if manifest.framework_version.nil?
         end
 
         def invalid_version_error(manifest, package)
           valid_to_serve = AppVersion::TO_BE_SERVED
-          target_version = manifest['frameworkVersion']
+          target_version = manifest.framework_version
 
           if target_version == AppVersion::DEPRECATED
             package.warnings << I18n.t('txt.apps.admin.warning.app_build.deprecated_version')
@@ -173,19 +205,13 @@ module ZendeskAppsSupport
         end
 
         def name_as_parameter_name_error(manifest)
-          if manifest['parameters'].is_a?(Array)
-            if manifest['parameters'].any? { |p| p['name'] == 'name' }
-              ValidationError.new(:name_as_parameter_name)
-            end
+          if manifest.parameters.any? { |p| p.name == 'name' }
+            ValidationError.new(:name_as_parameter_name)
           end
         end
 
         def invalid_hidden_parameter_error(manifest)
-          invalid_params = []
-
-          if manifest.key?('parameters')
-            invalid_params = manifest['parameters'].select { |p| p['type'] == 'hidden' && p['required'] }.map { |p| p['name'] }
-          end
+          invalid_params = manifest.parameters.select { |p| p.type == 'hidden' && p.required }.map(&:name)
 
           if invalid_params.any?
             ValidationError.new(:invalid_hidden_parameter, invalid_params: invalid_params.join(', '), count: invalid_params.length)
@@ -193,18 +219,17 @@ module ZendeskAppsSupport
         end
 
         def invalid_type_error(manifest)
-          return unless manifest['parameters'].is_a?(Array)
-
           invalid_types = []
+          manifest.parameters.each do |parameter|
+            parameter_type = parameter.type
 
-          manifest['parameters'].each do |parameter|
-            parameter_type = parameter.fetch('type', '')
-
-            invalid_types << parameter_type unless TYPES_AVAILABLE.include?(parameter_type)
+            invalid_types << parameter_type unless ZendeskAppsSupport::Manifest::Parameter::TYPES.include?(parameter_type)
           end
 
           if invalid_types.any?
-            ValidationError.new(:invalid_type_parameter, invalid_types: invalid_types.join(', '), count: invalid_types.length)
+            ValidationError.new(:invalid_type_parameter,
+                                invalid_types: invalid_types.join(', '),
+                                count: invalid_types.length)
           end
         end
 
@@ -212,14 +237,35 @@ module ZendeskAppsSupport
           ValidationError.new('manifest_keys.missing', missing_keys: missing_keys.join(', '), count: missing_keys.length)
         end
 
-        def framework_version_iframe_only(package, manifest)
-          if (package.iframe_only?)
-            manifest_version = Gem::Version.new (manifest['frameworkVersion'] || 0)
-            required_version = Gem::Version.new '2.0'
+        def location_framework_mismatch(manifest)
+          locations = manifest.locations
+          stub = ZendeskAppsSupport::Manifest::LEGACY_URI_STUB
+          iframe_locations = locations_any?(locations) do |url|
+            url != stub
+          end
+          legacy_locations = (!iframe_locations && manifest.location?) || locations_any?(locations) do |url|
+            url != stub
+          end
+          if manifest.iframe_only?
+            return ValidationError.new(:locations_must_be_urls) if legacy_locations
+          elsif iframe_locations
+            return ValidationError.new(:locations_cant_be_urls)
+          end
+        end
 
-            if (manifest_version < required_version)
-              ValidationError.new(:old_version)
-            end
+        def locations_any?(locations)
+          locations.values.any? do |location_hash|
+            location_hash.values.any? { |url| yield(url) }
+          end
+        end
+
+        # TODO: support the new location format in the no_template array and 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
+          unless no_template.is_a?(Array) && manifest.no_template_locations.all? { |loc| Location.find_by(name: loc) }
+            ValidationError.new(:invalid_no_template)
           end
         end
       end

data/lib/zendesk_apps_support/validations/source.rb

@@ -42,8 +42,8 @@ module ZendeskAppsSupport
         end
 
         def package_needs_app_js?(package)
-          return false if package.manifest_json['requirementsOnly']
-          return false if package.iframe_only?
+          return false if package.manifest.requirements_only?
+          return false if package.manifest.iframe_only?
           true
         end
 

data/lib/zendesk_apps_support.rb

@@ -6,6 +6,7 @@ module ZendeskAppsSupport
   autoload :BuildTranslation,       'zendesk_apps_support/build_translation'
   autoload :I18n,                   'zendesk_apps_support/i18n'
   autoload :Location,               'zendesk_apps_support/location'
+  autoload :Manifest,               'zendesk_apps_support/manifest'
   autoload :Product,                'zendesk_apps_support/product'
   autoload :Package,                'zendesk_apps_support/package'
   autoload :Installed,              'zendesk_apps_support/installed'
@@ -27,4 +28,9 @@ module ZendeskAppsSupport
     autoload :Requirements,          'zendesk_apps_support/validations/requirements'
     autoload :Banner,                'zendesk_apps_support/validations/banner'
   end
+
+  class Manifest
+    autoload :Parameter, 'zendesk_apps_support/manifest/parameter'
+    autoload :NoOverrideHash, 'zendesk_apps_support/manifest/no_override_hash'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -139,6 +139,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
 description: Support to help you develop Zendesk Apps.
 email:
 - dev@zendesk.com
@@ -165,6 +179,9 @@ files:
 - lib/zendesk_apps_support/installation.rb
 - lib/zendesk_apps_support/installed.rb
 - lib/zendesk_apps_support/location.rb
+- lib/zendesk_apps_support/manifest.rb
+- lib/zendesk_apps_support/manifest/no_override_hash.rb
+- lib/zendesk_apps_support/manifest/parameter.rb
 - lib/zendesk_apps_support/package.rb
 - lib/zendesk_apps_support/product.rb
 - lib/zendesk_apps_support/sass_functions.rb
@@ -198,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Support to help you develop Zendesk Apps.