zendesk_apps_support 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c35e29cfb59ea49f7c17e2c67e7e87448d082d70
-  data.tar.gz: 9b9bed066d256daedaaddb4430f8c8e2cf77d2b3
+  metadata.gz: e72293eff17b81b124a52b13846a4fa5960d0f09
+  data.tar.gz: 4187e6abb5b4d2f8c1d2c923c91e5b18ae3d8029
 SHA512:
-  metadata.gz: f77764d71a3a8a65e69a50b8ee708ffc25f110694d28b218bb001d7675a8949f30b2d7896b1b5b394a3d99aa4a0624f84d23c7ac12c632a08b19d22457ac0ed1
-  data.tar.gz: 61c0cdff51c2ddff19b94d24b37355c5d01ec1c57fcecd379f9e09df716a3280373548e7c76a28b3e9268052f82ff229efa103b8fe9ab0322f6008fd4801f528
+  metadata.gz: 0debb87a845b756dd8baa4610d29d06b0cc0aef16b2a8623a1cfc0134c32f45d0b2432d76cf2d7d0439b73107c91ad2be1e436c5cce6d3fd9088b349d4207ad1
+  data.tar.gz: 912cd57cc7ce6e5448a0b28124038760ae9d98a700edd0ebfc49f935f4d255128cb4233f1bac6ac656855be291cbeac0989aa3883d8f767cd20bd8fbce684e2d

data/config/locales/en.yml

@@ -94,6 +94,8 @@ en:
               not_json: "%{file} is not valid JSON. %{errors}"
               not_json_object: "%{file} is not a JSON object."
               missing_required_key: 'Missing required key from %{file}: %{missing_key}'
+              missing_required_key_for_product: 'Missing required key from %{file} for %{product}: %{missing_key}'
+              products_do_not_match_manifest_products: 'Products in manifest (%{manifest_products}) do not match products in translations (%{translation_products}).'
             stylesheet_error: 'Sass error: %{sass_error}'
             invalid_type_parameter:
               one: "%{invalid_types} is an invalid parameter type."

data/lib/zendesk_apps_support/validations/translations.rb

@@ -15,10 +15,10 @@ module ZendeskAppsSupport
         def call(package)
           package.files.each_with_object([]) do |file, errors|
             path_match = TRANSLATIONS_PATH.match(file.relative_path)
-            if path_match
-              errors << locale_error(file, path_match[1]) << json_error(file)
-              errors << required_keys(file) if errors.compact.empty?
-            end
+            next unless path_match
+            errors << locale_error(file, path_match[1]) << json_error(file)
+            next unless errors.compact.empty?
+            errors.push(*validate_marketplace_content(file, package)) if file.relative_path == 'translations/en.json'
           end.compact
         end
 
@@ -48,14 +48,54 @@ module ZendeskAppsSupport
           ValidationError.new('translation.not_json', file: file.relative_path, errors: e)
         end
 
-        def required_keys(file)
-          return unless file.relative_path == 'translations/en.json'
+        def validate_marketplace_content(file, package)
+          errors = []
           json = JSON.parse(file.read)
-          return if json.is_a?(Hash) && json['app'].is_a?(Hash) && json['app']['name']
+          product_names = Product::PRODUCTS_AVAILABLE.map(&:name)
+          present_product_keys = json['app'].is_a?(Hash) ? json['app'].keys & product_names : []
+
+          if present_product_keys.empty?
+            errors << validate_top_level_required_keys(json, package, file.relative_path)
+          else
+            errors << validate_products_match_manifest_products(present_product_keys, package, file.relative_path)
+            errors << validate_products_have_required_keys(json, package, present_product_keys, file.relative_path)
+          end
+          errors.compact
+        end
+
+        def validate_top_level_required_keys(json, package, file_path)
+          missing_keys = get_missing_keys(package, json['app'].keys)
+          return if missing_keys.empty?
+          ValidationError.new(
+            'translation.missing_required_key',
+            file: file_path,
+            missing_key: missing_keys.join(', ')
+          )
+        end
 
-          ValidationError.new('translation.missing_required_key',
-                              file: file.relative_path,
-                              missing_key: 'app.name')
+        def validate_products_have_required_keys(json, package, products, file_path)
+          products.each do |product|
+            missing_keys = get_missing_keys(package, json['app'][product].keys)
+            next if missing_keys.empty?
+            return ValidationError.new(
+              'translation.missing_required_key_for_product',
+              file: file_path,
+              product: product,
+              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.join(', '),
+            manifest_products: manifest_products.join(', ')
+          )
         end
 
         def validate_translation_format(json)
@@ -71,6 +111,19 @@ module ZendeskAppsSupport
             end
           end
         end
+
+        def get_missing_keys(package, keys)
+          public_app_keys = %w(name short_description installation_instructions long_description)
+          mandatory_keys = package.manifest.private? ? ['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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2017-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n