zendesk_apps_support 4.4.2 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d2e58ed37d53238a4125173c9b4cc4e401a2364
-  data.tar.gz: 31120c07af28f6a706c6be119012d8345aa51f74
+  metadata.gz: 68ec75f6edd58e546096a0264c27bb17652cdac8
+  data.tar.gz: f7941d0e10b8ed005b59e88af3c2c6ac50dbe742
 SHA512:
-  metadata.gz: 7d793ec518b66b7e1890f89a04e714987a61a335343c4007246782689eb6abc5b4af258338049f46a331a4400026d0d572761d410eb851b053f2fbb1ef5d9d8d
-  data.tar.gz: 0b9bb7cc6678f80e2dd19009fe6a314831fa59e73aab6035a1640cd505e29cc672a60a3636e82923ec59600f874c3d4d92a6ee576b25d30fe903eaf468c58a1b
+  metadata.gz: 006e9e8e880b349aa33a3fcff1925e3fccbe9b12ff0ee950ecba54a79ba73363652f43fddfe27720263c6d949da4b06af14d9ce7a0120fc4c43623fe571e5d20
+  data.tar.gz: 38c4f30c83611fd1e81b13e50df3e5c25027e07348b9dd6352d926cfee0560c156dec281c90e0fd7fbe3ad4fce23c0c9bde28758899ad357ed3c658bd9ffe240

data/config/locales/en.yml

@@ -57,6 +57,8 @@ en:
             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.
+            dirty_svg: "%{svg} contains invalid markup and was unable to be automatically
+              regenerated."
             oauth_keys:
               missing:
                 one: 'Missing required oauth field in manifest: %{missing_keys}'
@@ -120,3 +122,5 @@ en:
             deprecated_version: You are targeting a deprecated version of the framework.
               Your app will work, but it might break when the new framework version
               is deployed.
+            sanitised_svg: The markup in %{svg} has been edited for use in Zendesk,
+              and may not display as intended.

data/config/locales/translations/zendesk_apps_support.yml

@@ -128,6 +128,10 @@ parts:
       key: "txt.apps.admin.error.app_build.banner.invalid_size"
       title: "App builder job: Banner image invalid size error"
       value: "Invalid banner image dimensions. Must be %{required_banner_width}x%{required_banner_height}px."
+  - translation:
+      key: "txt.apps.admin.error.app_build.dirty_svg"
+      title: "App builder job: invalid SVG markup error"
+      value: "%{svg} contains invalid markup and was unable to be automatically regenerated."
   - translation:
       key: "txt.apps.admin.error.app_build.oauth_keys.missing.one"
       title: "App builder job: missing oauth fields error"
@@ -202,6 +206,10 @@ parts:
       key: "txt.apps.admin.warning.app_build.deprecated_version"
       title: "App builder job: deprecated version specified"
       value: 'You are targeting a deprecated version of the framework. Your app will work, but it might break when the new framework version is deployed.'
+  - translation:
+      key: "txt.apps.admin.warning.app_build.sanitised_svg"
+      title: "App builder job: warning that contents of svg have been sanitised and overwritten"
+      value: "The markup in %{svg} has been edited for use in Zendesk, and may not display as intended."
   - translation:
       key: "txt.apps.admin.error.app_build.invalid_version"
       title: "App builder job: invalid framework version"

data/lib/zendesk_apps_support.rb

@@ -27,6 +27,7 @@ module ZendeskAppsSupport
     autoload :Stylesheets,           'zendesk_apps_support/validations/stylesheets'
     autoload :Requirements,          'zendesk_apps_support/validations/requirements'
     autoload :Banner,                'zendesk_apps_support/validations/banner'
+    autoload :Svg,                   'zendesk_apps_support/validations/svg'
   end
 
   class Manifest

data/lib/zendesk_apps_support/package.rb

@@ -30,6 +30,7 @@ module ZendeskAppsSupport
     def validate(marketplace: true)
       [].tap do |errors|
         errors << Validations::Manifest.call(self)
+
         if has_manifest?
           errors << Validations::Marketplace.call(self) if marketplace
           errors << Validations::Source.call(self)
@@ -43,6 +44,7 @@ module ZendeskAppsSupport
         end
 
         errors << Validations::Banner.call(self) if has_banner?
+        errors << Validations::Svg.call(self) if has_svgs?
 
         errors.flatten!.compact!
       end
@@ -91,6 +93,10 @@ module ZendeskAppsSupport
       @lib_files ||= js_files.select { |f| f =~ %r{^lib/} }
     end
 
+    def svg_files
+      @svg_files ||= files.select { |f| f =~ %r{^assets/.*\.svg$} }
+    end
+
     def template_files
       files.select { |f| f =~ %r{^templates/.*\.hdbs$} }
     end
@@ -181,6 +187,10 @@ module ZendeskAppsSupport
       File.file?(path_to(path))
     end
 
+    def has_svgs?
+      svg_files.any?
+    end
+
     def has_requirements?
       has_file?(REQUIREMENTS_FILENAME)
     end

data/lib/zendesk_apps_support/validations/banner.rb

@@ -7,7 +7,7 @@ module ZendeskAppsSupport
       BANNER_WIDTH = 830
       BANNER_HEIGHT = 200
 
-      class <<self
+      class << self
         def call(package)
           File.open(package.path_to('assets/banner.png'), 'rb') do |fh|
             begin

data/lib/zendesk_apps_support/validations/svg.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require 'loofah'
+
+module ZendeskAppsSupport
+  module Validations
+    module Svg
+      @strip_declaration = Loofah::Scrubber.new do |node|
+        node.remove if node.name == 'xml' && node.children.empty?
+      end
+
+      @empty_malformed_markup = Loofah::Scrubber.new do |node|
+        node.next.remove while node.name == 'svg' && node.next
+      end
+
+      # CRUFT: ignore a (very specific) style attribute which Loofah would otherwise scrub.
+      # This attribute is deprecated (https://www.w3.org/TR/filter-effects/#AccessBackgroundImage)
+      # but is included in many of the test apps used in fixtures for tests in ZAM, ZAT etc.
+      @remove_enable_background = Loofah::Scrubber.new do |node|
+        match_pattern = Regexp.new("enable-background:.*?(\;|\z)")
+        if node.name == 'svg' && node['style']
+          node['style'] = node['style'].gsub(match_pattern, '')
+          node.attributes['style'].remove if node['style'].empty?
+        end
+      end
+
+      class << self
+        def call(package)
+          errors = []
+
+          package.svg_files.each do |svg|
+            markup = Loofah.xml_fragment(svg.read)
+                           .scrub!(@strip_declaration)
+                           .scrub!(@remove_enable_background)
+                           .to_xml.strip
+
+            clean_markup = Loofah.xml_fragment(markup)
+                                 .scrub!(:prune)
+                                 .scrub!(@empty_malformed_markup)
+                                 .to_xml
+
+            filepath = svg.relative_path
+
+            next if clean_markup == markup
+            begin
+              compressed_clean_markup = clean_markup.tr("\n", '').squeeze(' ').gsub(/\>\s+\</, '><')
+              IO.write(filepath, compressed_clean_markup)
+              package.warnings << I18n.t('txt.apps.admin.warning.app_build.sanitised_svg', svg: filepath)
+            rescue
+              errors << ValidationError.new(:dirty_svg, svg: filepath)
+            end
+          end
+          errors
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 4.5.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -111,6 +111,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: loofah
+  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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -167,6 +195,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.6
 description: Support to help you develop Zendesk Apps.
 email:
 - dev@zendesk.com
@@ -207,6 +249,7 @@ files:
 - lib/zendesk_apps_support/validations/requirements.rb
 - lib/zendesk_apps_support/validations/source.rb
 - lib/zendesk_apps_support/validations/stylesheets.rb
+- lib/zendesk_apps_support/validations/svg.rb
 - lib/zendesk_apps_support/validations/templates.rb
 - lib/zendesk_apps_support/validations/translations.rb
 - lib/zendesk_apps_support/validations/validation_error.rb
@@ -222,7 +265,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="