zendesk_apps_support 1.14.3 → 1.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2739e242f4b1d7e65cda16d7defdb0abad01d3ca
-  data.tar.gz: a6a7b977ba95950a17140bab5f2e4a8148f45ba7
+  metadata.gz: 42facf839227ec97b70c5ddb1777a8fc35750da2
+  data.tar.gz: d8e73edd9f09a0db0894fe701ce63ac742e2f221
 SHA512:
-  metadata.gz: 09a9020134872ac37b4f13bea94162e1ffb877115288165a28b8f26d4fa61f682f5ad2c479b9dbd51d4ff89b6774e982ff12fbca77afb5cfcd05387471de5b16
-  data.tar.gz: f212352b4c2648e1d8fbcb83e92acc3b14dace379a87a76274a8105613b901c981a99a45213f300cc425c41f6c4e72cf703b42241f1a5dd0c14e090490fcd584
+  metadata.gz: 8c4de5166b970b0b8e1c01bffab99e38f62da6602899934e23ec6d26d7bb22b40139de64870e63e99c94e12da8385d20eff9c098054bc6cb92632a5b838c28b7
+  data.tar.gz: 3c8e1d7b0044c330457881e3050e24f6932f26d08d648fceda214e22405ad209942a0194b0487df55e90e2ae71cf40cb56926952ad2cfb3fa420b7c7b478df45

data/config/locales/en.yml

@@ -23,12 +23,19 @@ en:
                 one: 'Missing required field in manifest: %{missing_keys}'
                 other: 'Missing required fields in manifest: %{missing_keys}'
             requirements_not_json: requirements.json is not proper JSON. %{errors}
+            excessive_requirements: The requirements.json file contains too many requirements.
+              The current limit is %{max} requirements.
+            missing_required_fields: 'Missing required fields in requirements.json:
+              "%{field}" is required in "%{identifier}"'
             duplicate_requirements:
               one: 'requirements.json contains a duplicate key: %{duplicate_keys}'
               other: 'requirements.json contains duplicate keys: %{duplicate_keys}'
             invalid_requirements_types:
               one: 'requirements.json contains an invalid type: %{invalid_types}'
               other: 'requirements.json contains invalid types: %{invalid_types}'
+            banner:
+              invalid_format: 'Banner image must be a PNG file'
+              invalid_size: 'Invalid banner image dimensions. Must be %{required_banner_width}x%{required_banner_height}px'
             oauth_keys:
               missing:
                 one: 'Missing required oauth field in manifest: %{missing_keys}'

data/config/locales/translations/zendesk_apps_support.yml

@@ -5,7 +5,6 @@ title: "Apps Support"
 packages:
   - default
   - apps_support
-  - classic
 
 parts:
   - translation:
@@ -52,6 +51,14 @@ parts:
       key: "txt.apps.admin.error.app_build.requirements_not_json"
       title: "App builder job: requirements file is invalid JSON error"
       value: "requirements.json is not proper JSON. %{errors}"
+  - translation:
+      key: "txt.apps.admin.error.app_build.excessive_requirements"
+      title: "App builder job: requirements file contains too many requirements"
+      value: "The requirements.json file contains too many requirements. The current limit is %{max} requirements."
+  - translation:
+      key: "txt.apps.admin.error.app_build.missing_required_fields"
+      title: "App builder job: required key missing in requirements, e.g. \"title\" is required in \"my_custom_email_target\""
+      value: "Missing required fields in requirements.json: \"%{field}\" is required in \"%{identifier}\""
   - translation:
       key: "txt.apps.admin.error.app_build.duplicate_requirements.one"
       title: "App builder job: requirements file contains duplicate key error"

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

@@ -22,3 +22,5 @@
     ZendeskApps[<%= name.to_json %>].install({"id": <%= app_id %>, "app_id": <%= app_id %>, "settings": <%= settings.to_json %>});
 
 }());
+
+ZendeskApps.trigger && ZendeskApps.trigger('ready');

data/lib/zendesk_apps_support/package.rb

@@ -38,6 +38,10 @@ module ZendeskAppsSupport
           end
         end
 
+        if has_banner?
+          errors << Validations::Banner.call(self)
+        end
+
         errors.flatten!
       end
     end
@@ -98,7 +102,7 @@ module ZendeskAppsSupport
     end
 
     def customer_css
-      css_file = File.join(root, 'app.css')
+      css_file = file_path('app.css')
       customer_css = File.exist?(css_file) ? File.read(css_file) : ""
     end
 
@@ -118,6 +122,14 @@ module ZendeskAppsSupport
       file_exists?("requirements.json")
     end
 
+    def has_banner?
+      file_exists?("assets/banner.png")
+    end
+
+    def file_path(path)
+      File.join(root, path)
+    end
+
     private
 
     def compiled_templates(app_id, asset_url_prefix)
@@ -151,12 +163,11 @@ module ZendeskAppsSupport
     end
 
     def file_exists?(path)
-      File.exist?(File.join(root, path))
+      File.exist?(file_path(path))
     end
 
     def read_file(path)
-      file_path = File.join(root, path)
-      File.read(File.join(root, path))
+      File.read(file_path(path))
     end
 
     def read_json(path, symbolize_names = true)

data/lib/zendesk_apps_support/validations/banner.rb

@@ -0,0 +1,33 @@
+require 'image_size'
+
+module ZendeskAppsSupport
+  module Validations
+    module Banner
+      BANNER_WIDTH = 830
+      BANNER_HEIGHT = 200
+
+      class <<self
+        def call(package)
+          File.open(package.file_path('assets/banner.png'), 'rb') do |fh|
+            begin
+              image = ImageSize.new(fh)
+
+              unless image.format == :png
+                return [ValidationError.new('banner.invalid_format')]
+              end
+
+              unless (image.width == BANNER_WIDTH && image.height == BANNER_HEIGHT) ||
+                     (image.width == 2*BANNER_WIDTH && image.height == 2*BANNER_HEIGHT)
+                return [ValidationError.new('banner.invalid_size', :required_banner_width => BANNER_WIDTH,
+                                                                   :required_banner_height => BANNER_HEIGHT)]
+              end
+            rescue => e
+              return [ValidationError.new('banner.invalid_format')]
+            end
+          end
+          []
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/validations/requirements.rb

@@ -1,11 +1,12 @@
 require 'multi_json'
 require 'json/stream'
-require 'pp'
 
 module ZendeskAppsSupport
   module Validations
     module Requirements
 
+      MAX_REQUIREMENTS = 10
+
       class <<self
         def call(package)
           requirements_file = package.files.find { |f| f.relative_path == 'requirements.json' }
@@ -21,6 +22,9 @@ module ZendeskAppsSupport
           requirements = MultiJson.load(requirements_stream)
           [].tap do |errors|
             errors << invalid_requirements_types(requirements)
+            errors << excessive_requirements(requirements)
+            errors << missing_required_fields(requirements)
+            errors.flatten!
             errors.compact!
           end
         rescue MultiJson::DecodeError => e
@@ -29,6 +33,30 @@ module ZendeskAppsSupport
 
         private
 
+        def missing_required_fields(requirements)
+          [].tap do |errors|
+            requirements.values.each do |requirement|
+              requirement.each do |identifier, fields|
+                next if fields.include? 'title'
+                errors << ValidationError.new(:missing_required_fields, :field => 'title', :identifier => identifier)
+              end
+            end
+
+            unless requirements['user_fields'].nil?
+              requirements['user_fields'].each do |identifier, fields|
+                next if fields.include? 'key'
+                errors << ValidationError.new(:missing_required_fields, :field => 'key', :identifier => identifier)
+              end
+            end
+          end
+        end
+
+        def excessive_requirements(requirements)
+          if requirements.values.map(&:values).flatten.size > MAX_REQUIREMENTS
+            ValidationError.new(:excessive_requirements, :max => MAX_REQUIREMENTS)
+          end
+        end
+
         def invalid_requirements_types(requirements)
           invalid_types = requirements.keys - ZendeskAppsSupport::AppRequirement::TYPES
 

data/lib/zendesk_apps_support/validations/source.rb

@@ -14,7 +14,8 @@ module ZendeskAppsSupport
         :laxcomma => true,
 
         # predefined globals:
-        :predef => %w(_ console services helpers alert JSON Base64 clearInterval clearTimeout setInterval setTimeout)
+        :predef => %w(_ console services helpers alert window document self
+                      JSON Base64 clearInterval clearTimeout setInterval setTimeout)
       }.freeze
 
       class <<self

data/lib/zendesk_apps_support.rb

@@ -20,5 +20,6 @@ module ZendeskAppsSupport
     autoload :JSHintValidationError, 'zendesk_apps_support/validations/validation_error'
     autoload :Stylesheets,           'zendesk_apps_support/validations/stylesheets'
     autoload :Requirements,          'zendesk_apps_support/validations/requirements'
+    autoload :Banner,                'zendesk_apps_support/validations/banner'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 1.14.3
+  version: 1.14.4
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -83,6 +83,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: image_size
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -146,11 +160,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
-- README.md
-- config/locales/en.yml
-- config/locales/translations/zendesk_apps_support.yml
-- lib/zendesk_apps_support.rb
 - lib/zendesk_apps_support/app_file.rb
 - lib/zendesk_apps_support/app_requirement.rb
 - lib/zendesk_apps_support/app_version.rb
@@ -163,6 +172,7 @@ files:
 - lib/zendesk_apps_support/package.rb
 - lib/zendesk_apps_support/sass_functions.rb
 - lib/zendesk_apps_support/stylesheet_compiler.rb
+- lib/zendesk_apps_support/validations/banner.rb
 - lib/zendesk_apps_support/validations/manifest.rb
 - lib/zendesk_apps_support/validations/requirements.rb
 - lib/zendesk_apps_support/validations/source.rb
@@ -170,6 +180,11 @@ files:
 - lib/zendesk_apps_support/validations/templates.rb
 - lib/zendesk_apps_support/validations/translations.rb
 - lib/zendesk_apps_support/validations/validation_error.rb
+- lib/zendesk_apps_support.rb
+- config/locales/en.yml
+- config/locales/translations/zendesk_apps_support.yml
+- README.md
+- LICENSE
 homepage: http://github.com/zendesk/zendesk_apps_support
 licenses:
 - Apache License Version 2.0
@@ -190,9 +205,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Support to help you develop Zendesk Apps.
 test_files: []
-has_rdoc: