zendesk_apps_support 1.0.1 → 1.1.0

data/config/locales/en.yml

@@ -19,6 +19,12 @@ en:
             style_in_template: <style> tag in %{template}. Use an app.css file instead.
             invalid_default_locale: ! '%{defaultLocale} is not a valid default locale.
               Only two- and three-letter ISO 639 language codes are allowed.'
+            invalid_location:
+              one: ! '%{invalid_locations} in an invalid location.'
+              other: ! '%{invalid_locations} are invalid locations.'
+            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.'
             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

@@ -43,6 +43,22 @@ parts:
       key: "txt.apps.admin.error.app_build.invalid_default_locale"
       title: "App builder job: invalid default locale"
       value: "%{defaultLocale} is not a valid default locale. Only two- and three-letter ISO 639 language codes are allowed."
+  - translation:
+      key: "txt.apps.admin.error.app_build.invalid_location.one"
+      title: "App builder job: invalid locations"
+      value: "%{invalid_locations} in an invalid location."
+  - translation:
+      key: "txt.apps.admin.error.app_build.invalid_location.other"
+      title: "App builder job: invalid locations"
+      value: "%{invalid_locations} are invalid locations."
+  - translation:
+      key: "txt.apps.admin.error.app_build.invalid_hidden_parameter.one"
+      title: "App builder job: hidden parameters set to required"
+      value: "%{invalid_params} is set to hidden and cannot be required."
+  - translation:
+      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.translation.invalid_locale"
       title: "App builder job: invalid locale file name"

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -5,6 +5,7 @@ module ZendeskAppsSupport
     module Manifest
 
       REQUIRED_MANIFEST_FIELDS = %w( author defaultLocale location frameworkVersion).freeze
+      LOCATIONS_AVAILABLE = %w( nav_bar ticket_sidebar ).freeze
 
       class <<self
         def call(package)
@@ -17,6 +18,8 @@ module ZendeskAppsSupport
           [].tap do |errors|
             errors << missing_keys_error(manifest)
             errors << default_locale_error(manifest)
+            errors << invalid_location_error(manifest)
+            errors << invalid_hidden_parameter_error(manifest)
             errors.compact!
           end
         rescue MultiJson::DecodeError => e
@@ -42,6 +45,25 @@ module ZendeskAppsSupport
           end
         end
 
+        def invalid_location_error(manifest)
+          invalid_locations = [*manifest['location']] - LOCATIONS_AVAILABLE
+          unless invalid_locations.empty?
+            ValidationError.new(:invalid_location, :invalid_locations => invalid_locations.join(', '), :count => invalid_locations.length)
+          end
+        end
+
+        def invalid_hidden_parameter_error(manifest)
+          invalid_params = []
+
+          if manifest.has_key?('parameters')
+            invalid_params = manifest['parameters'].select { |p| p['type'] == 'hidden' && p['required'] }.map { |p| p['name'] }
+          end
+
+          if invalid_params.any?
+            ValidationError.new(:invalid_hidden_parameter, :invalid_params => invalid_params.join(', '), :count => invalid_params.length)
+          end
+        end
+
       end
     end
   end

data/spec/validations/manifest_spec.rb

@@ -29,6 +29,33 @@ describe ZendeskAppsSupport::Validations::Manifest do
     locale_error.should_not be_nil
   end
 
+  it 'should have an error when the location is invalid' do
+    manifest = { 'location' => ['ticket_sidebar', 'a_invalid_location'] }
+    manifest_file = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(manifest))
+    package = mock('Package', :files => [manifest_file])
+    errors = ZendeskAppsSupport::Validations::Manifest.call(package)
+
+    locations_error = errors.find { |e| e.to_s =~ /invalid location/ }
+    locations_error.should_not be_nil
+  end
+
+  it 'should have an error when a hidden parameter is set to required' do
+    manifest = {
+      'parameters' => [
+        'name'     => 'a parameter',
+        'type'     => 'hidden',
+        'required' => true
+      ]
+    }
+
+    manifest_file = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(manifest))
+    package = mock('Package', :files => [manifest_file])
+    errors = ZendeskAppsSupport::Validations::Manifest.call(package)
+
+    hidden_params_error = errors.find { |e| e.to_s =~ /set to hidden and cannot be required/ }
+    hidden_params_error.should_not be_nil
+  end
+
   it 'should have an error when manifest is not a valid json' do
     manifest = mock('AppFile', :relative_path => 'manifest.json', :read => "}")
     package = mock('Package', :files => [manifest])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -189,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Support to help you develop Zendesk Apps.