zendesk_apps_support 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54e7a6ab73eb5859482ab34120496dc7d0436d94
-  data.tar.gz: 628d00f657e16bd523e243933df0ebd33335ff71
+  metadata.gz: a9e45de07d4fc43d38abc3c8acc5181bc91e2186
+  data.tar.gz: 641719f94991cc135fa59d776cf1323dba3f93a1
 SHA512:
-  metadata.gz: 307849eca5c7198db760d0cf88a31ad499ec6c96faf3465e7d367bac82903cd891e66e19330e25cd70ae86e1da3aa47abaab4fe5ac88b0189e699c78e38808c3
-  data.tar.gz: ff42fe5d330299f1fb3a4b6baff4f78d527281f17e621da70d244b0ef2ab62a486653aeeb136f2fd42199aff0ee4141418791782050df3c2a93acc37f57223df
+  metadata.gz: 8317dae950108e25ade2c756ab55687dfa72c01cc5d114470e3ed531c4b1be4ff17cd9fbce201568b0116b688daace243ea7147c3cb7a7dd561e6ae26e2e0cd3
+  data.tar.gz: 1bc68d32b49422d96f9d1f74572d7393f6a26def3140d558a4629426c1918687d94a49c847ec77171ce30179ac08c36dcdbaa7a4ed0d4a288f7f7e0a92d5c841

data/config/locales/en.yml

@@ -60,6 +60,7 @@ en:
             invalid_location:
               one: "%{invalid_locations} is an invalid location in %{host_name}."
               other: "%{invalid_locations} are invalid locations in %{host_name}."
+            blank_location_uri: "%{location} location does not specify a URI."
             invalid_location_uri: "%{uri} is either an invalid location URI, refers
               to a missing asset, or does not use HTTPS."
             duplicate_location:

data/config/locales/translations/zendesk_apps_support.yml

@@ -144,6 +144,10 @@ parts:
       key: "txt.apps.admin.error.app_build.invalid_location.other"
       title: "App builder job: invalid locations"
       value: "%{invalid_locations} are invalid locations in %{host_name}."
+  - translation:
+      key: "txt.apps.admin.error.app_build.blank_location_uri"
+      title: "App builder job: invalid URI for an iframe in the manifest"
+      value: "%{location} location does not specify a URI."
   - translation:
       key: "txt.apps.admin.error.app_build.invalid_location_uri"
       title: "App builder job: invalid URI for an iframe in the manifest"
@@ -152,10 +156,12 @@ parts:
       key: "txt.apps.admin.error.app_build.duplicate_location.one"
       title: "App builder job: duplicate locations"
       value: "%{duplicate_locations} is a duplicate location."
+      obsolete: "2016-12-31"
   - translation:
       key: "txt.apps.admin.error.app_build.duplicate_location.other"
       title: "App builder job: duplicate locations"
       value: "%{duplicate_locations} are duplicate locations."
+      obsolete: "2016-12-31"
   - translation:
       key: "txt.apps.admin.error.app_build.name_as_parameter_name"
       title: "App builder job: error message when developer names a parameter 'name'"

data/lib/zendesk_apps_support.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ZendeskAppsSupport
   require 'zendesk_apps_support/engine'
 
@@ -29,6 +30,7 @@ module ZendeskAppsSupport
   end
 
   class Manifest
+    autoload :LocationOptions, 'zendesk_apps_support/manifest/location_options'
     autoload :Parameter, 'zendesk_apps_support/manifest/parameter'
     autoload :NoOverrideHash, 'zendesk_apps_support/manifest/no_override_hash'
   end

data/lib/zendesk_apps_support/assets/src.js.erb

@@ -15,7 +15,7 @@ with( ZendeskApps.AppScope.create() ) {
 }
 <% end %>
 var app = ZendeskApps.defineApp(<%= iframe_only ? 'null' : 'source' %>)
-  .reopenClass(<%= app_settings.to_json %>)
+  .reopenClass(<%= app_class_properties.to_json %>)
   .reopen({
     appName: <%= name.to_json %>,
     appVersion: <%= version.to_json %>,

data/lib/zendesk_apps_support/finders.rb

@@ -23,10 +23,12 @@ module ZendeskAppsSupport
     private
 
     def filter_by_arg(arg)
-      fail('More than one key-value pair found') if arg.size > 1
-      attribute, value = arg.to_a.first
-      value = value.to_s if value.is_a? Symbol
-      ->(product) { product.public_send(attribute) == value }
+      lambda do |findable_record|
+        arg.all? do |attribute, value|
+          value = value.to_s if value.is_a? Symbol
+          findable_record.public_send(attribute) == value
+        end
+      end
     end
   end
 end

data/lib/zendesk_apps_support/i18n.rb

@@ -9,6 +9,11 @@ module ZendeskAppsSupport
         i18n.locale = locale
       end
 
+      def set_load_path
+        i18n
+        nil
+      end
+
       private
 
       def i18n

data/lib/zendesk_apps_support/manifest.rb

@@ -26,7 +26,6 @@ module ZendeskAppsSupport
     }.freeze
 
     attr_reader(*RUBY_TO_JSON.keys)
-    attr_reader :locations
 
     alias_method :requirements_only?, :requirements_only
     alias_method :marketing_only?, :marketing_only
@@ -46,8 +45,42 @@ module ZendeskAppsSupport
       no_template || []
     end
 
-    def location?
-      !locations.values.all?(&:empty?)
+    def products
+      @products ||=
+        location_options.map { |lo| lo.location.product_code }
+                        .uniq
+                        .map { |code| Product.find_by(code: code) }
+    end
+
+    def location_options
+      @location_options ||= locations.flat_map do |product_key, locations|
+        product = Product.find_by(name: product_key)
+        locations.map do |location_key, location_options|
+          location = product && Location.find_by(product_code: product.code, name: location_key)
+          options_with_defaults = {
+            'signed' => signed_urls?
+          }.merge(location_options)
+          Manifest::LocationOptions.new(location, options_with_defaults)
+        end
+      end
+    end
+
+    def app_class_properties
+      {
+        experiments: experiments,
+        location: locations,
+        noTemplate: no_template_locations,
+        singleInstall: single_install?,
+        signedUrls: signed_urls?
+      }.select { |_k, v| !v.nil? }
+    end
+
+    def unknown_locations(host)
+      if locations.key?(host)
+        locations[host].keys.uniq - Location::LOCATIONS_AVAILABLE.map(&:name)
+      else
+        []
+      end
     end
 
     def unknown_hosts
@@ -87,8 +120,13 @@ module ZendeskAppsSupport
       set_locations_and_hosts
     end
 
+    LEGACY_LOCATION_OBJECT = { 'url' => LEGACY_URI_STUB }.freeze
+    private_constant :LEGACY_LOCATION_OBJECT
+
     private
 
+    attr_reader :locations
+
     def set_locations_and_hosts
       @locations =
         case original_locations
@@ -97,10 +135,11 @@ module ZendeskAppsSupport
           replace_legacy_locations original_locations
         when Array
           @used_hosts = ['support']
-          { 'support' => NoOverrideHash[original_locations.map { |location| [ location, LEGACY_URI_STUB ] }] }
+          new_locations = NoOverrideHash[original_locations.map { |location| [ location, LEGACY_LOCATION_OBJECT ] }]
+          { 'support' => new_locations }
         when String
           @used_hosts = ['support']
-          { 'support' => { original_locations => LEGACY_URI_STUB } }
+          { 'support' => { original_locations => LEGACY_LOCATION_OBJECT } }
         # TODO: error out for numbers and Booleans
         else # NilClass
           @used_hosts = ['support']
@@ -114,7 +153,17 @@ module ZendeskAppsSupport
           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
+          value_for_product && new_locations_obj[product_key] = replace_string_uris(value_for_product)
+        end
+      end
+    end
+
+    def replace_string_uris(product_locations)
+      product_locations.each_with_object({}) do |(k, v), new_locations|
+        if v.is_a? Hash
+          new_locations[k] = v
+        else
+          new_locations[k] = { 'url' => v }
         end
       end
     end

data/lib/zendesk_apps_support/manifest/location_options.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module ZendeskAppsSupport
+  class Manifest
+    class LocationOptions
+      RUBY_TO_JSON = {
+        legacy: 'legacy',
+        auto_load: 'autoLoad',
+        auto_hide: 'autoHide',
+        signed: 'signed',
+        url: 'url'
+      }.freeze
+
+      attr_reader :location
+      attr_reader(*RUBY_TO_JSON.keys)
+
+      alias_method :signed?, :signed
+      alias_method :legacy?, :legacy
+      alias_method :auto_load?, :auto_load
+      alias_method :auto_hide?, :auto_hide
+
+      def initialize(location, options)
+        @location = location
+
+        RUBY_TO_JSON.each do |ruby, json|
+          instance_variable_set(:"@#{ruby}", options[json])
+        end
+        @legacy ||= @url == ZendeskAppsSupport::Manifest::LEGACY_URI_STUB
+        @auto_load = options.fetch('autoLoad', true)
+        @auto_hide ||= false
+        @signed ||= false
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/package.rb

@@ -15,7 +15,7 @@ module ZendeskAppsSupport
     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__)))
 
-    LOCATIONS_WITH_ICONS = ['top_bar', 'nav_bar', 'system_top_bar']
+    LOCATIONS_WITH_ICONS = %w(top_bar nav_bar system_top_bar).freeze
 
     attr_reader :lib_root, :root, :warnings
 
@@ -119,19 +119,11 @@ module ZendeskAppsSupport
       # 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 = {
-        experiments: manifest.experiments,
-        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: manifest.version,
         source: source,
-        app_settings: app_settings,
+        app_class_properties: manifest.app_class_properties,
         asset_url_prefix: asset_url_prefix,
         location_icons: location_icons,
         app_class_name: app_class_name,
@@ -184,11 +176,6 @@ module ZendeskAppsSupport
       trans[manifest.default_locale]
     end
 
-    def has_location?
-      manifest.location?
-    end
-    deprecate :has_location?, 'manifest.location?', 2016, 9
-
     def has_file?(path)
       File.file?(path_to(path))
     end
@@ -203,11 +190,6 @@ module ZendeskAppsSupport
       File.exist?(scss_file) ? File.read(scss_file) : ( File.exist?(css_file) ? File.read(css_file) : '' )
     end
 
-    def locations
-      manifest.locations
-    end
-    deprecate :locations, 'manifest.locations', 2016, 9
-
     def iframe_only?
       manifest.iframe_only?
     end
@@ -282,23 +264,25 @@ module ZendeskAppsSupport
     end
 
     def location_icons
-      {}.tap do |location_icons|
-        manifest.locations.each do |host, locations_for_host|
-          locations_for_host.keys.each do |location|
-            next unless LOCATIONS_WITH_ICONS.include?(location)
-            location_icons[host] ||= {}
-            location_icons[host][location] = if (has_file?("assets/icon_#{location}.svg"))
-              cache_busting_param = "?#{Time.now.to_i}" unless @is_cached
-              { 'svg' => "icon_#{location}.svg#{cache_busting_param}" }
-            elsif (has_file?("assets/icon_#{location}_inactive.png"))
-              {
-                'inactive' => "icon_#{location}_inactive.png",
-                'active' => has_file?("assets/icon_#{location}_active.png") ? "icon_#{location}_active.png" : "icon_#{location}_inactive.png",
-                'hover' => has_file?("assets/icon_#{location}_hover.png") ? "icon_#{location}_hover.png" : "icon_#{location}_inactive.png"
-              }
-            else
-              {}
-            end
+      Hash.new { |h, k| h[k] = {} }.tap do |location_icons|
+        manifest.location_options.each do |location_options|
+          next unless location_options.location &&
+                      LOCATIONS_WITH_ICONS.include?(location_options.location.name) &&
+                      location_options.location.product == Product::SUPPORT
+
+          host = location_options.location.product.name
+          location = location_options.location.name
+          location_icons[host][location] = if (has_file?("assets/icon_#{location}.svg"))
+            cache_busting_param = "?#{Time.now.to_i}" unless @is_cached
+            { 'svg' => "icon_#{location}.svg#{cache_busting_param}" }
+          elsif (has_file?("assets/icon_#{location}_inactive.png"))
+            {
+              'inactive' => "icon_#{location}_inactive.png",
+              'active' => has_file?("assets/icon_#{location}_active.png") ? "icon_#{location}_active.png" : "icon_#{location}_inactive.png",
+              'hover' => has_file?("assets/icon_#{location}_hover.png") ? "icon_#{location}_hover.png" : "icon_#{location}_inactive.png"
+            }
+          else
+            {}
           end
         end
       end

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -34,7 +34,6 @@ module ZendeskAppsSupport
           else
             errors << missing_location_error(package)
             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)
@@ -75,7 +74,7 @@ module ZendeskAppsSupport
         end
 
         def ban_location(manifest)
-          ValidationError.new(:no_location_required) if manifest.location?
+          ValidationError.new(:no_location_required) unless manifest.location_options.empty?
         end
 
         def ban_framework_version(manifest)
@@ -139,31 +138,32 @@ module ZendeskAppsSupport
         end
 
         def missing_location_error(package)
-          missing_keys_validation_error(['location']) unless package.manifest.location?
+          missing_keys_validation_error(['location']) if package.manifest.location_options.empty?
         end
 
         def invalid_location_error(package)
           errors = []
-          manifest_locations = package.manifest.locations
-          manifest_locations.find do |host, locations|
-            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)
+          package.manifest.location_options.each do |location_options|
+            if location_options.url && !location_options.url.empty?
+              errors << invalid_location_uri_error(package, location_options.url)
+            elsif location_options.auto_load?
+              errors << ValidationError.new(:blank_location_uri, location: location_options.location.name)
             end
+          end
 
-            locations.values.each do |path|
-              errors << invalid_location_uri_error(package, path)
-            end
+          Product::PRODUCTS_AVAILABLE.each do |product|
+            invalid_locations = package.manifest.unknown_locations(product.name)
+            next if invalid_locations.empty?
+            errors << ValidationError.new(:invalid_location,
+                                    invalid_locations: invalid_locations.join(', '),
+                                    host_name: product.name,
+                                    count: invalid_locations.length)
           end
 
           package.manifest.unknown_hosts.each do |unknown_host|
             errors << ValidationError.new(:invalid_host, host_name: unknown_host)
           end
+
           errors
         end
 
@@ -186,15 +186,6 @@ module ZendeskAppsSupport
           uri.path.start_with?('assets/') && package.has_file?(uri.path)
         end
 
-        def duplicate_location_error(manifest)
-          locations           = *manifest.locations
-          duplicate_locations = *locations.select { |location| locations.count(location) > 1 }.uniq
-
-          unless duplicate_locations.empty?
-            ValidationError.new(:duplicate_location, duplicate_locations: duplicate_locations.join(', '), count: duplicate_locations.length)
-          end
-        end
-
         def missing_framework_version(manifest)
           missing_keys_validation_error([RUBY_TO_JSON[:framework_version]]) if manifest.framework_version.nil?
         end
@@ -246,27 +237,14 @@ module ZendeskAppsSupport
         end
 
         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
+          legacy_locations, iframe_locations = manifest.location_options.partition(&:legacy?)
           if manifest.iframe_only?
-            return ValidationError.new(:locations_must_be_urls) if legacy_locations
-          elsif iframe_locations
+            return ValidationError.new(:locations_must_be_urls) unless legacy_locations.empty?
+          elsif !iframe_locations.empty?
             return ValidationError.new(:locations_cant_be_urls)
           end
         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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -139,6 +139,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.6
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
 description: Support to help you develop Zendesk Apps.
 email:
 - dev@zendesk.com
@@ -166,6 +180,7 @@ files:
 - lib/zendesk_apps_support/installed.rb
 - lib/zendesk_apps_support/location.rb
 - lib/zendesk_apps_support/manifest.rb
+- lib/zendesk_apps_support/manifest/location_options.rb
 - lib/zendesk_apps_support/manifest/no_override_hash.rb
 - lib/zendesk_apps_support/manifest/parameter.rb
 - lib/zendesk_apps_support/package.rb
@@ -201,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Support to help you develop Zendesk Apps.