dxw-zendesk_apps_support 4.29.5

data/lib/zendesk_apps_support/validations/svg.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'loofah'
+
+module ZendeskAppsSupport
+  module Validations
+    module Svg
+      PLACEHOLDER_SVG_MARKUP = File.read(File.expand_path('../../assets/default_app_logo.svg', __FILE__))
+
+      # whitelist elements and attributes used in Zendesk Garden assets
+      Loofah::HTML5::WhiteList::ALLOWED_ELEMENTS_WITH_LIBXML2.add 'symbol'
+      Loofah::HTML5::WhiteList::ACCEPTABLE_CSS_PROPERTIES.add 'position'
+
+      # 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.
+      Loofah::HTML5::WhiteList::ACCEPTABLE_CSS_PROPERTIES.add 'enable-background'
+
+      @strip_declaration = Loofah::Scrubber.new do |node|
+        node.remove if node.name == 'xml' && node.children.empty?
+      end
+
+      # Loofah's default scrubber strips spaces between CSS attributes. Passing the input markup through this scrubber
+      # first ensures that this stripped whitespace in the output doesn't register as a diff.
+      @strip_spaces_between_css_attrs = Loofah::Scrubber.new do |node|
+        match_pattern = Regexp.new(/\s+/)
+        if node.name == 'svg' && node['style']
+          node['style'] = node['style'].gsub(match_pattern, '')
+        end
+      end
+
+      @empty_malformed_markup = Loofah::Scrubber.new do |node|
+        node.next.remove while node.name == 'svg' && node.next
+      end
+
+      class << self
+        def contains_embedded_bitmap?(markup)
+          Nokogiri::XML(markup).css('//image').any?
+        end
+
+        def rewrite_svg(svg, new_markup, package, errors)
+          warning_string = if contains_embedded_bitmap?(svg.read)
+                             'txt.apps.admin.warning.app_build.bitmap_in_svg'
+                           else
+                             'txt.apps.admin.warning.app_build.sanitised_svg'
+                           end
+
+          package.warnings << I18n.t(warning_string, svg: svg.relative_path)
+          compressed_new_markup = new_markup.tr("\n", '').squeeze(' ').gsub(/\>\s+\</, '><')
+          IO.write(svg.absolute_path, compressed_new_markup)
+        rescue
+          errors << ValidationError.new(:dirty_svg, svg: svg.relative_path)
+        end
+
+        def call(package)
+          errors = []
+
+          package.svg_files.each do |svg|
+            if contains_embedded_bitmap?(svg.read)
+              rewrite_svg(svg, PLACEHOLDER_SVG_MARKUP, package, errors)
+            else
+              markup = Loofah.xml_fragment(svg.read)
+                             .scrub!(@strip_declaration)
+                             .scrub!(@strip_spaces_between_css_attrs)
+                             .to_xml.strip
+
+              clean_markup = Loofah.xml_fragment(markup)
+                                   .scrub!(:prune)
+                                   .scrub!(@empty_malformed_markup)
+                                   .to_xml
+
+              next if clean_markup == markup
+              rewrite_svg(svg, clean_markup, package, errors)
+            end
+          end
+          errors
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/validations/templates.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ZendeskAppsSupport
+  module Validations
+    module Templates
+      class <<self
+        def call(package)
+          errors = []
+          package.template_files.each do |template|
+            contents = template.read
+            if contents =~ /<\s*style\b/
+              errors << ValidationError.new(:style_in_template, template: template.relative_path)
+            end
+          end
+          errors
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/validations/translations.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ZendeskAppsSupport
+  module Validations
+    module Translations
+      TRANSLATIONS_PATH = %r{^translations/(.*)\.json$}
+      VALID_LOCALE      = /^[a-z]{2}(-\w{2,3})?$/
+
+      class TranslationFormatError < StandardError
+      end
+
+      class << self
+        def call(package, opts = {})
+          package.files.each_with_object([]) do |file, errors|
+            path_match = TRANSLATIONS_PATH.match(file.relative_path)
+            next unless path_match
+            errors << locale_error(file, path_match[1]) << json_error(file) << format_error(file)
+            next unless errors.compact.empty?
+            if file.relative_path == 'translations/en.json'
+              # rubocop:disable Metrics/LineLength
+              errors.push(*validate_marketplace_content(file, package, opts.fetch(:skip_marketplace_translations, false)))
+            end
+          end.compact
+        end
+
+        private
+
+        def locale_error(file, locale)
+          return nil if VALID_LOCALE =~ locale
+          ValidationError.new('translation.invalid_locale', file: file.relative_path)
+        end
+
+        def format_error(file)
+          with_valid_json(file) do |json|
+            if json['app'] && json['app']['parameters']
+              parameters_node = json['app']['parameters']
+              parameters_node.keys.map do |param|
+                unless parameters_node[param].is_a?(Hash) && parameters_node[param].keys.include?('label')
+                  return ValidationError.new('translation.missing_required_key_on_leaf',
+                                             file: file.relative_path, missing_key: 'label', leaf: param)
+                end
+              end
+            end
+          end
+          nil
+        end
+
+        def json_error(file)
+          with_valid_json(file) do |json|
+            if json['app'] && json['app']['package']
+              json['app'].delete('package')
+              begin
+                validate_translation_format(json)
+                return
+              rescue TranslationFormatError => e
+                ValidationError.new('translation.invalid_format', field: e.message)
+              end
+            end
+          end
+        end
+
+        def with_valid_json(file)
+          json = JSON.parse(file.read)
+          if json.is_a?(Hash)
+            yield json
+          else
+            ValidationError.new('translation.not_json_object', file: file.relative_path)
+          end
+        rescue JSON::ParserError => e
+          ValidationError.new('translation.not_json', file: file.relative_path, errors: e)
+        end
+
+        def validate_marketplace_content(file, package, skip_marketplace_translations)
+          errors = []
+          json = JSON.parse(file.read)
+          product_names = Product::PRODUCTS_AVAILABLE.map(&:name)
+          present_product_keys = json['app'].is_a?(Hash) ? json['app'].keys & product_names : []
+          skip_marketplace_strings = package.manifest.private? || skip_marketplace_translations
+
+          if present_product_keys.empty?
+            errors << validate_top_level_required_keys(json, file.relative_path, skip_marketplace_strings)
+          else
+            errors << validate_products_match_manifest_products(present_product_keys, package, file.relative_path)
+            errors << validate_products_have_required_keys(
+              json,
+              present_product_keys,
+              file.relative_path,
+              skip_marketplace_strings
+            )
+          end
+          errors.compact
+        end
+
+        def validate_top_level_required_keys(json, file_path, skip_marketplace_strings)
+          keys = json['app'].is_a?(Hash) ? json['app'].keys : []
+          missing_keys = get_missing_keys(keys, skip_marketplace_strings)
+          return if missing_keys.empty?
+          ValidationError.new(
+            'translation.missing_required_key',
+            file: file_path,
+            missing_key: missing_keys.join(', ')
+          )
+        end
+
+        def validate_products_have_required_keys(json, products, file_path, skip_marketplace_strings)
+          products.each do |product|
+            missing_keys = get_missing_keys(json['app'][product].keys, skip_marketplace_strings)
+            next if missing_keys.empty?
+            return ValidationError.new(
+              'translation.missing_required_key_for_product',
+              file: file_path,
+              product: product.capitalize,
+              missing_key: missing_keys.join(', ')
+            )
+          end
+          nil
+        end
+
+        def validate_products_match_manifest_products(products, package, file_path)
+          manifest_products = package.manifest.products.map(&:name)
+          return if (products - manifest_products).empty?
+          ValidationError.new(
+            'translation.products_do_not_match_manifest_products',
+            file: file_path,
+            translation_products: products.map(&:capitalize).join(', '),
+            manifest_products: manifest_products.map(&:capitalize).join(', ')
+          )
+        end
+
+        def validate_translation_format(json)
+          json.keys.each do |key|
+            raise TranslationFormatError, "'#{key}': '#{json[key]}'" unless json[key].is_a? Hash
+
+            if json[key].keys.sort == BuildTranslation::I18N_KEYS &&
+               json[key][BuildTranslation::I18N_TITLE_KEY].class == String &&
+               json[key][BuildTranslation::I18N_VALUE_KEY].class == String
+              next
+            else
+              validate_translation_format(json[key])
+            end
+          end
+        end
+
+        def get_missing_keys(keys, skip_marketplace_strings)
+          public_app_keys = %w[name short_description installation_instructions long_description]
+          mandatory_keys = skip_marketplace_strings ? ['name'] : public_app_keys
+          # since we support description as well as short_description for backwards compatibility,
+          # validate keys as if description == short_description
+          keys_to_validate = keys.map do |key|
+            key == 'description' ? 'short_description' : key
+          end
+
+          mandatory_keys - keys_to_validate
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/validations/validation_error.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ZendeskAppsSupport
+  module Validations
+    class ValidationError < StandardError
+      KEY_PREFIX = 'txt.apps.admin.error.app_build.'
+
+      class DeserializationError < StandardError
+        def initialize(serialized)
+          super "Cannot deserialize ValidationError from #{serialized}"
+        end
+      end
+
+      class << self
+        # Turn a JSON string into a ValidationError.
+        def from_json(json)
+          hash = JSON.parse(json)
+          raise DeserializationError, json unless hash.is_a?(Hash)
+          from_hash(hash)
+        rescue JSON::ParserError, NameError
+          raise DeserializationError, json
+        end
+
+        def from_hash(hash)
+          raise DeserializationError, hash unless hash['class']
+          klass = constantize(hash['class'])
+          raise DeserializationError, hash unless klass <= self
+          klass.vivify(hash)
+        end
+
+        # Turn a Hash into a ValidationError. Used within from_json.
+        def vivify(hash)
+          new(hash['key'], hash['data'])
+        end
+
+        private
+
+        def constantize(klass)
+          klass.to_s.split('::').inject(Object) { |superclass, part| superclass.const_get(part) }
+        end
+      end
+
+      attr_reader :key, :data
+
+      def initialize(key, data = nil)
+        @key = key
+        @data = symbolize_keys(data || {})
+      end
+
+      def to_s
+        ZendeskAppsSupport::I18n.t("#{KEY_PREFIX}#{key}", data)
+      end
+
+      def to_json(*)
+        JSON.generate(as_json)
+      end
+
+      def as_json(*)
+        {
+          'class' => self.class.to_s,
+          'key'   => key,
+          'data'  => data
+        }
+      end
+
+      private
+
+      def symbolize_keys(hash)
+        hash.each_with_object({}) do |(key, value), result|
+          result[key.to_sym] = value
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,353 @@
+--- !ruby/object:Gem::Specification
+name: dxw-zendesk_apps_support
+version: !ruby/object:Gem::Version
+  version: 4.29.5
+platform: ruby
+authors:
+- James A. Rosen
+- Likun Liu
+- Sean Caffery
+- Daniel Ribeiro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: sassc
+  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: sass
+  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: json
+  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: image_size
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: erubis
+  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: loofah
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: ipaddress_2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.52.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.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
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+description: Support to help you develop Zendesk Apps.
+email:
+- dev@zendesk.com
+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
+- lib/zendesk_apps_support/assets/default_app_logo.svg
+- lib/zendesk_apps_support/assets/default_styles.scss
+- lib/zendesk_apps_support/assets/default_template.html.erb
+- lib/zendesk_apps_support/assets/installed.js.erb
+- lib/zendesk_apps_support/assets/src.js.erb
+- lib/zendesk_apps_support/build_translation.rb
+- lib/zendesk_apps_support/engine.rb
+- lib/zendesk_apps_support/finders.rb
+- lib/zendesk_apps_support/i18n.rb
+- lib/zendesk_apps_support/installation.rb
+- 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
+- lib/zendesk_apps_support/product.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/marketplace.rb
+- lib/zendesk_apps_support/validations/mime.rb
+- lib/zendesk_apps_support/validations/requests.rb
+- lib/zendesk_apps_support/validations/requirements.rb
+- lib/zendesk_apps_support/validations/secrets.rb
+- lib/zendesk_apps_support/validations/secure_settings.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
+homepage: http://github.com/zendesk/zendesk_apps_support
+licenses:
+- Apache License Version 2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
+specification_version: 4
+summary: Support to help you develop Zendesk Apps.
+test_files: []