zendesk_apps_support 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c3fca724e7f35785484603ca55af83855f552b4
-  data.tar.gz: 0d43d9895907802f2b78e2254b51fd9071cfd81b
+  metadata.gz: 17e0397eb9e955f39c20172e468c5c802c16e6b9
+  data.tar.gz: 729794611cb19c2ad235ef74edcdb57b8d10cea3
 SHA512:
-  metadata.gz: ab5d576101b539d7ae1f03a2e8ee3d19dba79ae06ac63c99e81aed69f82892b6223214ca1fe604c19c2b6f6b247616e6969ae0b4954604184412d450356ae69d
-  data.tar.gz: f0055a8a80058d9dc1418c01ead238e9baa10f2ead12599cbaf2e0f1b69b3fe198cc43ee5d1e4814207de159f6434bb1300e21b4f82395618ddf5109587883fb
+  metadata.gz: 31db6f1d415c359436fda55684f6040bc5187b6700814f63398bcfa6f6f912dc329f63cb2b5628eb186b7a1abea085d11b4e7e28cc68d55381608c6b1be2e55e
+  data.tar.gz: 855a7bd5ae36894856819ebed680ce64d5628b54da9ec6fae5873eae20a7537fdea6851e5e22ca254e470604e75fb06e74c29d4a34a9326661198d2b1c59cb86

data/config/locales/en.yml

@@ -9,6 +9,8 @@ en:
             jshint:
               one: 'JSHint error in %{file}: %{errors}'
               other: 'JSHint errors in %{file}: %{errors}'
+            no_parameters_required: Parameters can't be defined for marketing-only
+              apps
             no_location_required: Locations can't be defined when you specify requirements
               only
             no_framework_version_required: Framework versions can't be set when you
@@ -19,6 +21,8 @@ en:
             missing_manifest: Could not find manifest.json
             symlink_in_zip: Symlinks are not allowed in the zip file
             missing_requirements: Could not find requirements.json
+            requirements_not_supported: App requirements are not supported for marketing-only
+              apps
             manifest_keys:
               missing:
                 one: 'Missing required field in manifest: %{missing_keys}'

data/config/locales/translations/zendesk_apps_support.yml

@@ -15,6 +15,10 @@ parts:
       key: "txt.apps.admin.error.app_build.jshint.other"
       title: "App builder job: JSHint error messages"
       value: "JSHint errors in %{file}: %{errors}"
+  - translation:
+      key: "txt.apps.admin.error.app_build.no_parameters_required"
+      title: "App builder job: prevent adding parameters while marketing only"
+      value: "Parameters can't be defined for marketing-only apps"
   - translation:
       key: "txt.apps.admin.error.app_build.no_location_required"
       title: "App builder job: ban location while requirements only"
@@ -44,6 +48,10 @@ parts:
       key: "txt.apps.admin.error.app_build.missing_requirements"
       title: "App builder job: missing requirements error"
       value: "Could not find requirements.json"
+  - translation:
+      key: "txt.apps.admin.error.app_build.requirements_not_supported"
+      title: "App builder job: requirements not supported error"
+      value: "App requirements are not supported for marketing-only apps"
   - translation:
       key: "txt.apps.admin.error.app_build.manifest_keys.missing.one"
       title: "App builder job: missing manifest fields error"

data/lib/zendesk_apps_support/manifest.rb

@@ -5,6 +5,7 @@ module ZendeskAppsSupport
 
     RUBY_TO_JSON = {
       requirements_only: 'requirementsOnly',
+      marketing_only: 'marketingOnly',
       version: 'version',
       author: 'author',
       framework_version: 'frameworkVersion',
@@ -26,6 +27,7 @@ module ZendeskAppsSupport
     attr_reader :locations
 
     alias_method :requirements_only?, :requirements_only
+    alias_method :marketing_only?, :marketing_only
     alias_method :signed_urls?, :signed_urls
     alias_method :single_install?, :single_install
     alias_method :private?, :private
@@ -70,6 +72,7 @@ module ZendeskAppsSupport
         instance_variable_set(:"@#{ruby}", m[json])
       end
       @requirements_only ||= false
+      @marketing_only ||= false
       @single_install ||= false
       @private = m.fetch('private', true)
       @signed_urls ||= false

data/lib/zendesk_apps_support/package.rb

@@ -8,6 +8,7 @@ module ZendeskAppsSupport
     extend Gem::Deprecate
     include ZendeskAppsSupport::BuildTranslation
 
+    MANIFEST_FILENAME = 'manifest.json'
     REQUIREMENTS_FILENAME = 'requirements.json'
 
     DEFAULT_LAYOUT = Erubis::Eruby.new(File.read(File.expand_path('../assets/default_template.html.erb', __FILE__)))
@@ -29,19 +30,15 @@ module ZendeskAppsSupport
         errors << Validations::Marketplace.call(self) if marketplace
 
         errors << Validations::Manifest.call(self)
-
         if has_manifest?
           errors << Validations::Source.call(self)
           errors << Validations::Translations.call(self)
+          errors << Validations::Requirements.call(self)
 
-          unless manifest.requirements_only?
+          if !manifest.requirements_only? && !manifest.marketing_only? && !manifest.iframe_only?
             errors << Validations::Templates.call(self)
             errors << Validations::Stylesheets.call(self)
           end
-
-          if has_requirements?
-            errors << Validations::Requirements.call(self)
-          end
         end
 
         if has_banner?
@@ -145,17 +142,17 @@ module ZendeskAppsSupport
     end
 
     def manifest_json
-      @manifest_json ||= read_json('manifest.json')
+      @manifest_json ||= read_json(MANIFEST_FILENAME)
     end
     deprecate :manifest_json, :manifest, 2016, 9
 
     def manifest
-      @manifest ||= Manifest.new(read_file('manifest.json'))
+      @manifest ||= Manifest.new(read_file(MANIFEST_FILENAME))
     end
 
     def requirements_json
       return nil unless has_requirements?
-      @requirements ||= read_json('requirements.json', object_class: Manifest::NoOverrideHash)
+      @requirements ||= read_json(REQUIREMENTS_FILENAME, object_class: Manifest::NoOverrideHash)
     end
 
     def is_no_template
@@ -193,6 +190,10 @@ module ZendeskAppsSupport
       File.exist?(path_to(path))
     end
 
+    def has_requirements?
+      has_file?(REQUIREMENTS_FILENAME)
+    end
+
     def app_css
       css_file = path_to('app.css')
       scss_file = path_to('app.scss')
@@ -266,11 +267,7 @@ module ZendeskAppsSupport
     end
 
     def has_manifest?
-      has_file?('manifest.json')
-    end
-
-    def has_requirements?
-      has_file?('requirements.json')
+      has_file?(MANIFEST_FILENAME)
     end
 
     def has_banner?

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -15,15 +15,20 @@ module ZendeskAppsSupport
           errors = []
           errors << missing_keys_error(manifest)
           errors << oauth_error(manifest)
-          errors << parameters_error(manifest)
-          errors << invalid_hidden_parameter_error(manifest)
-          errors << invalid_type_error(manifest)
-          errors << name_as_parameter_name_error(manifest)
-          errors << no_template_format_error(manifest)
+
+          if manifest.marketing_only?
+            errors << ban_parameters(manifest)
+          else
+            errors << parameters_error(manifest)
+            errors << invalid_hidden_parameter_error(manifest)
+            errors << invalid_type_error(manifest)
+            errors << name_as_parameter_name_error(manifest)
+            errors << no_template_format_error(manifest)
+          end
           errors << boolean_error(manifest)
           errors << default_locale_error(manifest, package)
 
-          if manifest.requirements_only?
+          if manifest.requirements_only? || manifest.marketing_only?
             errors << ban_location(manifest)
             errors << ban_framework_version(manifest)
           else
@@ -43,7 +48,7 @@ module ZendeskAppsSupport
         private
 
         def boolean_error(manifest)
-          booleans = %i(requirements_only single_install signed_urls private)
+          booleans = %i(requirements_only marketing_only single_install signed_urls private)
           errors = []
           RUBY_TO_JSON.each do |ruby, json|
             if booleans.include? ruby
@@ -65,6 +70,10 @@ module ZendeskAppsSupport
           end
         end
 
+        def ban_parameters(manifest)
+          ValidationError.new(:no_parameters_required) unless manifest.parameters.empty?
+        end
+
         def ban_location(manifest)
           ValidationError.new(:no_location_required) if manifest.location?
         end

data/lib/zendesk_apps_support/validations/requirements.rb

@@ -5,7 +5,13 @@ module ZendeskAppsSupport
 
       class <<self
         def call(package)
-          return [ValidationError.new(:missing_requirements)] unless package.has_file? 'requirements.json'
+          if package.manifest.requirements_only? && !package.has_requirements?
+            return [ValidationError.new(:missing_requirements)]
+          elsif package.manifest.marketing_only? && package.has_requirements?
+            return [ValidationError.new(:requirements_not_supported)]
+          elsif !package.has_requirements?
+            return []
+          end
 
           begin
             requirements = package.requirements_json

data/lib/zendesk_apps_support/validations/source.rb

@@ -42,6 +42,7 @@ module ZendeskAppsSupport
         end
 
         def package_needs_app_js?(package)
+          return false if package.manifest.marketing_only?
           return false if package.manifest.requirements_only?
           return false if package.manifest.iframe_only?
           true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-02 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -201,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Support to help you develop Zendesk Apps.