zendesk_apps_support 1.1.2 → 1.1.3

data/config/locales/en.yml

@@ -27,6 +27,7 @@ en:
             invalid_hidden_parameter:
               one: ! '%{invalid_params} is set to hidden and cannot be required.'
               other: ! '%{invalid_params} are set to hidden and cannot be required.'
+            parameters_not_an_array: App Parameters must be an array.
             translation:
               invalid_locale: ! '%{file} is not a valid locale. Only two- and three-letter
                 ISO 639 language codes are allowed.'

data/config/locales/translations/zendesk_apps_support.yml

@@ -63,6 +63,10 @@ parts:
       key: "txt.apps.admin.error.app_build.invalid_hidden_parameter.other"
       title: "App builder job: hidden parameters set to required"
       value: "%{invalid_params} are set to hidden and cannot be required."
+  - translation:
+      key: "txt.apps.admin.error.app_build.parameters_not_an_array"
+      title: "App builder job: app parameters must be an array"
+      value: "App parameters must be an array."
   - translation:
       key: "txt.apps.admin.error.app_build.translation.invalid_locale"
       title: "App builder job: invalid locale file name"

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -19,6 +19,7 @@ module ZendeskAppsSupport
             errors << missing_keys_error(manifest)
             errors << default_locale_error(manifest, package)
             errors << invalid_location_error(manifest)
+            errors << parameters_must_be_an_array(manifest)
             errors << invalid_hidden_parameter_error(manifest)
             errors.compact!
           end
@@ -28,6 +29,14 @@ module ZendeskAppsSupport
 
         private
 
+        def parameters_must_be_an_array(manifest)
+          return unless manifest['parameters']
+
+          unless manifest['parameters'].kind_of?(Array)
+            ValidationError.new(:parameters_not_an_array)
+          end
+        end
+
         def missing_keys_error(manifest)
           missing = REQUIRED_MANIFEST_FIELDS.select do |key|
             manifest[key].nil?

data/spec/validations/manifest_spec.rb

@@ -3,6 +3,15 @@ require 'json'
 
 describe ZendeskAppsSupport::Validations::Manifest do
 
+  def default_required_params(overrides = {})
+    valid_fields = ZendeskAppsSupport::Validations::Manifest::REQUIRED_MANIFEST_FIELDS.inject({}) do |fields, name|
+      fields[name] = name
+      fields
+    end
+
+    valid_fields.merge(overrides)
+  end
+
   it 'should have an error when manifest.json is missing' do
     files = [mock('AppFile', :relative_path => 'abc.json')]
     package = mock('Package', :files => files)
@@ -74,4 +83,52 @@ describe ZendeskAppsSupport::Validations::Manifest do
 
     errors.first().to_s.should =~ /^manifest is not proper JSON/
   end
+
+  context 'with invalid parameter type' do
+
+    before do
+      ZendeskAppsSupport::Validations::Manifest.stub(:default_locale_error)
+      ZendeskAppsSupport::Validations::Manifest.stub(:invalid_location_error)
+    end
+
+    it 'has an error when the app parameters are not an array' do
+      parameter_hash = {
+          'parameters' => {
+              'name' => 'a parameter',
+              'type' => 'string'
+          }
+      }
+
+      params = default_required_params(parameter_hash)
+      manifest = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(params))
+      package = mock('Package', :files => [manifest])
+
+      errors = ZendeskAppsSupport::Validations::Manifest.call(package)
+      errors.map(&:to_s).should == ['App Parameters must be an array.']
+    end
+
+    it "doesn't have an error with an array of app parameters" do
+      parameter_hash = {
+          'parameters' => [{
+              'name' => 'a parameter',
+              'type' => 'string'
+          }]
+      }
+
+      params = default_required_params(parameter_hash)
+      manifest = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(params))
+      package = mock('Package', :files => [manifest])
+
+      errors = ZendeskAppsSupport::Validations::Manifest.call(package)
+      errors.should be_empty
+    end
+
+    it 'behaves when the manifest does not have parameters' do
+      manifest = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(default_required_params))
+      package = mock('Package', :files => [manifest])
+
+      errors = ZendeskAppsSupport::Validations::Manifest.call(package)
+      errors.should be_empty
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-15 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n