zendesk_apps_support 4.2.1 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fe5bdb5612e8bb4a6a19203bac397d803344e56
-  data.tar.gz: f26d674ecd167f9e89d105c709ebc87d065a4144
+  metadata.gz: c35e29cfb59ea49f7c17e2c67e7e87448d082d70
+  data.tar.gz: 9b9bed066d256daedaaddb4430f8c8e2cf77d2b3
 SHA512:
-  metadata.gz: 4182a52d6006ddf7bc3e408ba6c9c6b7385dcbf5c87170ff1d73267df409701676cb19d7705dacc475ead01320f386a9e3a3602fb2e52731b3ef0b57cfe84c1b
-  data.tar.gz: be090702051d35c47de0a4a01ca65dafb86231b0163d02e435579cd32d337a1a4a61e4c5fa8828bac7c9cc45c31333bc8f110e873c44ab60d377ee246ba6c338
+  metadata.gz: f77764d71a3a8a65e69a50b8ee708ffc25f110694d28b218bb001d7675a8949f30b2d7896b1b5b394a3d99aa4a0624f84d23c7ac12c632a08b19d22457ac0ed1
+  data.tar.gz: 61c0cdff51c2ddff19b94d24b37355c5d01ec1c57fcecd379f9e09df716a3280373548e7c76a28b3e9268052f82ff229efa103b8fe9ab0322f6008fd4801f528

data/config/locales/en.yml

@@ -57,6 +57,7 @@ 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}'
@@ -116,3 +117,4 @@ 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/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
@@ -268,6 +274,10 @@ module ZendeskAppsSupport
       has_file?('assets/banner.png')
     end
 
+    def has_svgs?
+      svg_files.any?
+    end
+
     def location_icons
       Hash.new { |h, k| h[k] = {} }.tap do |location_icons|
         manifest.location_options.each do |location_options|

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,28 @@
+# frozen_string_literal: true
+require 'loofah'
+
+module ZendeskAppsSupport
+  module Validations
+    module Svg
+      class << self
+        def call(package)
+          errors = []
+          package.svg_files.each do |svg|
+            markup = svg.read
+            clean_markup = Loofah.scrub_xml_document(markup, :prune).to_html
+            filepath = svg.relative_path
+
+            next if clean_markup == markup
+            begin
+              IO.write(filepath, clean_markup)
+              package.warnings << I18n.t('txt.apps.admin.warning.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.2.1
+  version: 4.3.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -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.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8.1
 - !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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:
   - - ">="
@@ -230,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Support to help you develop Zendesk Apps.