zendesk_apps_support 1.22.1 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 838d3e4ddc17abe2d67d032c27f61e605f32b074
-  data.tar.gz: 461798b1797da8aa3a38d8dd8ecbe684b43f82f4
+  metadata.gz: f490761e6e3ea2fad15e7167423c27f688c72222
+  data.tar.gz: 8c961e7b5f39c62c4f7bc448a8345d159861b610
 SHA512:
-  metadata.gz: 0c72139b36e06e03a63a26ef3ac3091de834699a7d456fa9ae3aa9e56a0404e94dc6169dfe87205e225083a38744a5086bd1913a80e56c5c72d096b1392a7f4f
-  data.tar.gz: ee97a2debbd15242fe926ba57ba8c0c44ab3f2ec5c89608e660059eaed0397951f09eae69cb7cac665fcbbedec1a1c8fd89a50ea04175d37cfbb4d8ca57a2299
+  metadata.gz: 781bc38ab817fef3745d22719f3fa87fd165cb36e1eed9b84d86fe564f29df611b154110229199b8e02f47a6295cb3dc84f5c754e2808bddb8ea189987aaab85
+  data.tar.gz: a18f52f007eb5a5463e671bf7f9c9512ba835c62a369f4ecaebe462dd2287bd06a52b9b6d15fe6dd5cbe08349d6a3ae958f93eb0ddc1cade5fabb95ef80c2e77

data/config/locales/en.yml

@@ -43,6 +43,7 @@ en:
                 other: 'Missing required oauth fields in manifest: %{missing_keys}'
             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 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}''.
               Please read: http://developer.zendesk.com/documentation/apps/i18n.html'
@@ -50,6 +51,8 @@ en:
             invalid_location:
               one: "%{invalid_locations} is an invalid location in %{host_name}."
               other: "%{invalid_locations} are invalid locations in %{host_name}."
+            invalid_location_uri: "%{uri} is either an invalid location URI, refers
+              to a missing asset or does not use HTTPS."
             duplicate_location:
               one: "%{duplicate_locations} is a duplicate location."
               other: "%{duplicate_locations} are duplicate locations."

data/config/locales/translations/zendesk_apps_support.yml

@@ -27,6 +27,7 @@ parts:
       key: "txt.apps.admin.error.app_build.no_app_js_required"
       title: "App builder job: ban app.js while requirements only"
       value: "Do not set your app to requirements only if you need app.js"
+      obsolete: "2016-02-28"
   - translation:
       key: "txt.apps.admin.error.app_build.manifest_not_json"
       title: "App builder job: manifest is invalid JSON error"
@@ -103,6 +104,10 @@ parts:
       key: "txt.apps.admin.error.app_build.style_in_template"
       title: "App builder job: <style> tags in template error"
       value: "<style> tag in %{template}. Use an app.css file instead."
+  - translation:
+      key: "txt.apps.admin.error.app_build.no_code_for_ifo_notemplate"
+      title: "App builder job: code included for a type of app that shouldn't have code"
+      value: "Javascripts, stylesheets, and templates are not allowed when an iframe URI or noTemplate is specified"
   - translation:
       key: "txt.apps.admin.error.app_build.invalid_default_locale"
       title: "App builder job: invalid default locale"
@@ -123,6 +128,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.invalid_location_uri"
+      title: "App builder job: invalid URI for an iframe in the manifest"
+      value: "%{uri} is either an invalid location URI, refers to a missing asset, or does not use HTTPS."
   - translation:
       key: "txt.apps.admin.error.app_build.duplicate_location.one"
       title: "App builder job: duplicate locations"

data/lib/zendesk_apps_support/app_file.rb

@@ -5,7 +5,7 @@ module ZendeskAppsSupport
 
     def initialize(package, relative_path)
       @relative_path = relative_path
-      @file = File.new(package.root.join(relative_path))
+      @file = File.new(package.path_to(relative_path))
       @absolute_path = File.absolute_path @file.path
     end
 
@@ -31,12 +31,6 @@ module ZendeskAppsSupport
       end
     end
 
-    # Unless Ruby 1.9
-    def respond_to?(sym, include_private = false)
-      @file.respond_to?(sym, include_private) || super
-    end
-
-    # If Ruby 1.9
     def respond_to_missing?(sym, include_private = false)
       @file.send(:respond_to_missing?, sym, include_private) || super
     end

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

@@ -1,32 +1,35 @@
+<% unless iframe_only %>
 with( ZendeskApps.AppScope.create() ) {
   <% unless modules.empty? %>
-    require.modules = {
+  require.modules = {
       <% modules.each do |path, content| %>
-        <%= path.to_json %>: function(exports, require, module) {
-          <%= content %>
-        },
+      <%= path.to_json %>: function(exports, require, module) {
+        <%= content %>
+      },
       <% end %>
-      eom: undefined
-    };
+    eom: undefined
+  };
   <% end %>
 
   var source = <%= source %>;
-
-  var app = ZendeskApps.defineApp(source)
-    .reopenClass(<%= app_settings.to_json %>)
-    .reopen({
-      appName: <%= name.to_json %>,
-      appVersion: <%= version.to_json %>,
-      assetUrlPrefix: <%= asset_url_prefix.to_json %>,
-      appClassName: <%= app_class_name.to_json %>,
-      author: {
-        name: <%= author['name'].to_json %>,
-        email: <%= author['email'].to_json %>
-      },
-      translations: <%= translations.to_json %>,
-      templates: <%= templates.to_json %>,
-      frameworkVersion: <%= framework_version.to_json %>
-    });
-
-  ZendeskApps[<%= name.to_json %>] = app;
 }
+<% end %>
+var app = ZendeskApps.defineApp(<%= iframe_only ? 'null' : 'source' %>)
+  .reopenClass(<%= app_settings.to_json %>)
+  .reopen({
+    appName: <%= name.to_json %>,
+    appVersion: <%= version.to_json %>,
+    assetUrlPrefix: <%= asset_url_prefix.to_json %>,
+    appClassName: <%= app_class_name.to_json %>,
+    author: {
+      name: <%= author['name'].to_json %>,
+      email: <%= author['email'].to_json %>
+    },
+    <% unless iframe_only %>
+    translations: <%= translations.to_json %>,
+    templates: <%= templates.to_json %>,
+    <% end %>
+    frameworkVersion: <%= framework_version.to_json %>
+  });
+
+ZendeskApps[<%= name.to_json %>] = app;

data/lib/zendesk_apps_support/location.rb

@@ -2,17 +2,17 @@ module ZendeskAppsSupport
   module Location
     # the numbers below match the enum values on the database, do not change them!
     LOCATIONS_AVAILABLE = {
-      "zendesk" => {
-        "top_bar" => 1,
-        "nav_bar" => 2,
-        "ticket_sidebar" => 3,
-        "new_ticket_sidebar" => 4,
-        "user_sidebar" => 5,
-        "organization_sidebar" => 6,
-        "background" => 7
+      'zendesk' => {
+        'top_bar' => 1,
+        'nav_bar' => 2,
+        'ticket_sidebar' => 3,
+        'new_ticket_sidebar' => 4,
+        'user_sidebar' => 5,
+        'organization_sidebar' => 6,
+        'background' => 7
       },
-      "zopim" => {
-        "chat_sidebar" => 8
+      'zopim' => {
+        'chat_sidebar' => 8
       }
     }.freeze
 

data/lib/zendesk_apps_support/package.rb

@@ -12,13 +12,15 @@ 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__)))
 
+    LEGACY_URI_STUB = '_legacy'
+
     attr_reader :lib_root, :root, :warnings
 
     def initialize(dir, is_cached = true)
       @root     = Pathname.new(File.expand_path(dir))
-      @lib_root = Pathname.new(File.join(@root, 'lib'))
+      @lib_root = Pathname.new(File.join(root, 'lib'))
 
-      @is_cached    = is_cached #disabled by ZAT for development
+      @is_cached = is_cached # disabled by ZAT for development
       @warnings = []
     end
 
@@ -59,13 +61,13 @@ module ZendeskAppsSupport
     end
 
     def assets
-      @assets ||= Dir.chdir(@root) do
-        Dir["assets/**/*"].select { |f| File.file?(f) }
+      @assets ||= Dir.chdir(root) do
+        Dir['assets/**/*'].select { |f| File.file?(f) }
       end
     end
 
     def path_to(file)
-      File.join(@root, file)
+      File.join(root, file)
     end
 
     def requirements_path
@@ -114,8 +116,7 @@ module ZendeskAppsSupport
 
       locale = options.fetch(:locale, 'en')
 
-      source = app_js
-      location = manifest_json['location']
+      source = iframe_only? ? nil : app_js
       version = manifest_json['version']
       app_class_name = "app-#{app_id}"
       author = manifest_json['author']
@@ -124,23 +125,24 @@ module ZendeskAppsSupport
       templates = is_no_template ? {} : compiled_templates(app_id, asset_url_prefix)
 
       app_settings = {
-        location: location,
+        location: locations,
         noTemplate: is_no_template,
         singleInstall: single_install
       }.select { |_k, v| !v.nil? }
 
       SRC_TEMPLATE.result(
-          name: name,
-          version: version,
-          source: source,
-          app_settings: app_settings,
-          asset_url_prefix: asset_url_prefix,
-          app_class_name: app_class_name,
-          author: author,
-          translations: translations_for(locale),
-          framework_version: framework_version,
-          templates: templates,
-          modules: commonjs_modules
+        name: name,
+        version: version,
+        source: source,
+        app_settings: app_settings,
+        asset_url_prefix: asset_url_prefix,
+        app_class_name: app_class_name,
+        author: author,
+        translations: translations_for(locale),
+        framework_version: framework_version,
+        templates: templates,
+        modules: commonjs_modules,
+        iframe_only: iframe_only?
       )
     end
 
@@ -192,19 +194,38 @@ module ZendeskAppsSupport
       manifest_json['location']
     end
 
+    def has_file?(path)
+      File.exist?(path_to(path))
+    end
+
     def app_css
-      css_file = file_path('app.css')
+      css_file = path_to('app.css')
       File.exist?(css_file) ? File.read(css_file) : ''
     end
 
-    def file_path(path)
-      File.join(root, path)
+    def locations
+      locations = manifest_json['location']
+      if locations.is_a?(Hash)
+        locations
+      elsif locations.is_a?(Array)
+        { 'zendesk' => Hash[locations.map { |location| [ location, LEGACY_URI_STUB ] }] }
+      else # String
+        { 'zendesk' => { locations => LEGACY_URI_STUB } }
+      end
+    end
+
+    def iframe_only?
+      !legacy_non_iframe_app?
     end
 
     private
 
+    def legacy_non_iframe_app?
+      @non_iframe ||= locations.values.flat_map(&:values).any? { |l| l == LEGACY_URI_STUB }
+    end
+
     def templates
-      templates_dir = File.join(@root, 'templates')
+      templates_dir = File.join(root, 'templates')
       Dir["#{templates_dir}/*.hdbs"].inject({}) do |memo, file|
         str = File.read(file)
         str.chomp!
@@ -223,7 +244,7 @@ module ZendeskAppsSupport
       return @translations if @is_cached && @translations
 
       @translations = begin
-        translation_dir = File.join(@root, 'translations')
+        translation_dir = File.join(root, 'translations')
         return {} unless File.directory?(translation_dir)
 
         locale_path = "#{translation_dir}/#{self.manifest_json['defaultLocale']}.json"
@@ -255,15 +276,15 @@ module ZendeskAppsSupport
     end
 
     def has_manifest?
-      file_exists?('manifest.json')
+      has_file?('manifest.json')
     end
 
     def has_requirements?
-      file_exists?('requirements.json')
+      has_file?('requirements.json')
     end
 
     def has_banner?
-      file_exists?('assets/banner.png')
+      has_file?('assets/banner.png')
     end
 
     def app_js
@@ -280,10 +301,6 @@ module ZendeskAppsSupport
       end
     end
 
-    def file_exists?(path)
-      File.exist?(file_path(path))
-    end
-
     def deep_merge_hash(h, another_h)
       result_h = h.dup
       another_h.each do |key, value|
@@ -297,7 +314,7 @@ module ZendeskAppsSupport
     end
 
     def read_file(path)
-      File.read(file_path(path))
+      File.read(path_to(path))
     end
 
     def read_json(path)

data/lib/zendesk_apps_support/validations/banner.rb

@@ -8,7 +8,7 @@ module ZendeskAppsSupport
 
       class <<self
         def call(package)
-          File.open(package.file_path('assets/banner.png'), 'rb') do |fh|
+          File.open(package.path_to('assets/banner.png'), 'rb') do |fh|
             begin
               image = ImageSize.new(fh)
 

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'uri'
 
 module ZendeskAppsSupport
   module Validations
@@ -9,34 +10,31 @@ module ZendeskAppsSupport
 
       class <<self
         def call(package)
-          manifest = package.files.find { |f| f.relative_path == 'manifest.json' }
-
-          return [ValidationError.new(:missing_manifest)] unless manifest
-
-          manifest = JSON.load(manifest.read)
-
-          [].tap do |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)
-
-            if manifest['requirementsOnly']
-              errors << ban_location(manifest)
-              errors << ban_framework_version(manifest)
-            else
-              errors << missing_location_error(package)
-              errors << invalid_location_error(manifest)
-              errors << duplicate_location_error(manifest)
-              errors << missing_framework_version(manifest)
-              errors << invalid_version_error(manifest, package)
-            end
-
-            errors.compact!
-          end
+          return [ValidationError.new(:missing_manifest)] unless package.has_file?('manifest.json')
+
+          manifest = package.manifest_json
+
+          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)
+
+          if manifest['requirementsOnly']
+            errors << ban_location(manifest)
+            errors << ban_framework_version(manifest)
+          else
+            errors << missing_location_error(package)
+            errors << invalid_location_error(package)
+            errors << duplicate_location_error(manifest)
+            errors << missing_framework_version(manifest)
+            errors << invalid_version_error(manifest, package)
+          end
+
+          errors.flatten.compact
         rescue JSON::ParserError => e
           return [ValidationError.new(:manifest_not_json, errors: e)]
         end
@@ -100,16 +98,49 @@ module ZendeskAppsSupport
           missing_keys_validation_error(['location']) unless package.has_location?
         end
 
-        def invalid_location_error(manifest)
-          manifest_location = manifest['location'].is_a?(Hash) ? manifest['location'] : { 'zendesk' => [*manifest['location']] }
-          manifest_location.find do |host, locations|
+        def invalid_location_error(package)
+          errors = []
+          manifest_locations = package.locations
+          manifest_locations.find do |host, locations|
             error = if !Location.hosts.include?(host)
               ValidationError.new(:invalid_host, host_name: host)
-            elsif (invalid_locations = locations - Location.names_for(host)).any?
-              ValidationError.new(:invalid_location, invalid_locations: invalid_locations.join(', '), host_name: host, count: invalid_locations.length)
+            elsif (invalid_locations = locations.keys - Location.names_for(host)).any?
+              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
-            break error if error
           end
+          errors
+        end
+
+        def invalid_location_uri_error(package, path)
+          return nil if path == Package::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
+          validation_error
+        end
+
+        def valid_absolute_uri?(uri)
+          uri.scheme == 'https' || uri.host == 'localhost'
+        end
+
+        def valid_relative_uri?(package, uri)
+          uri.path.start_with?('assets/') && package.has_file?(uri.path)
         end
 
         def duplicate_location_error(manifest)

data/lib/zendesk_apps_support/validations/source.rb

@@ -26,17 +26,27 @@ module ZendeskAppsSupport
           files = package.js_files
           app   = files.find { |file| file.relative_path == 'app.js' }
 
-          if package.manifest_json['requirementsOnly']
-            return app ? [ValidationError.new(:no_app_js_required)] : []
+          if package_needs_app_js?(package)
+            return [ ValidationError.new(:missing_source) ] unless app
+          else
+            return (package_has_code?(package) ? [ ValidationError.new(:no_code_for_ifo_notemplate) ] : [])
           end
 
-          return [ValidationError.new(:missing_source)] unless app
-
           jshint_errors(files).flatten!
         end
 
         private
 
+        def package_has_code?(package)
+          !(package.js_files.empty? && package.template_files.empty? && package.app_css.empty?)
+        end
+
+        def package_needs_app_js?(package)
+          return false if package.manifest_json['requirementsOnly']
+          return false if package.iframe_only?
+          true
+        end
+
         def jshint_error(file)
           errors = linter.lint(file.read)
           [JSHintValidationError.new(file.relative_path, errors)] if errors.any?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 1.22.1
+  version: 1.23.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -117,14 +117,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -196,9 +196,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Support to help you develop Zendesk Apps.
 test_files: []
-has_rdoc: