zendesk_apps_support 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1af9b7ff78ef619e400492c4e98711a9e3a1014
-  data.tar.gz: 897349bef78c52a54a97759a4b1dfb66d82c235e
+  metadata.gz: d9d77a73de7a3e75fcae675994285e086f9c86cc
+  data.tar.gz: a4451063938bc04fa59d98831b05b6939c6eb2ab
 SHA512:
-  metadata.gz: 49de33216f17a4a87460689156ad783291c73821501e89feb2da7347677474d2828742c5488a04621e34810be8cc6e20175810545e9f4bee895f3782a234c5df
-  data.tar.gz: f0a266f0584d30542bcf4056069467986e3e0850f31b10ca90f25dc4ffd6211c529aff92f015e8092c94a46b95bbd111db31f7384ffa0fe00df6d144f516fb58
+  metadata.gz: f2dd54326aa0dab31f9c6b5325378e088a38ec8b655d1409eba64eb6864db08cdb2d867706afbe468bf36c25315f15d17273e54fd76a7e58f6db4c01b3960672
+  data.tar.gz: 7ed3221747e4b490502da442caeae6c0e82f3d806c2f2ea51b3a49360ab7ea226bc0e926a8a4c09ad2c64dcb662f8ce6c55c9b99f86c7f393eca5e148a629a33

data/config/locales/en.yml

@@ -9,12 +9,15 @@ en:
             jshint:
               one: 'JSHint error in %{file}: %{errors}'
               other: 'JSHint errors in %{file}: %{errors}'
+            missing_location_and_requirements: Missing app location or requirements
             manifest_not_json: manifest is not proper JSON. %{errors}
             missing_manifest: Could not find manifest.json
+            missing_requirements: Could not find requirements.json
             manifest_keys:
               missing:
                 one: 'Missing required field in manifest: %{missing_keys}'
                 other: 'Missing required fields in manifest: %{missing_keys}'
+            requirements_not_json: requirements.json is not proper JSON. %{errors}
             oauth_keys:
               missing:
                 one: 'Missing required oauth field in manifest: %{missing_keys}'

data/config/locales/translations/zendesk_apps_support.yml

@@ -5,6 +5,7 @@ title: "Apps Support"
 packages:
   - default
   - apps_support
+  - classic
 
 parts:
   - translation:
@@ -15,6 +16,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.missing_location_and_requirements"
+      title: "App builder job: missing location and requirements error"
+      value: "Missing app location or requirements"
   - translation:
       key: "txt.apps.admin.error.app_build.manifest_not_json"
       title: "App builder job: manifest is invalid JSON error"
@@ -23,6 +28,10 @@ parts:
       key: "txt.apps.admin.error.app_build.missing_manifest"
       title: "App builder job: missing manifest error"
       value: "Could not find manifest.json"
+  - translation:
+      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.manifest_keys.missing.one"
       title: "App builder job: missing manifest fields error"
@@ -31,6 +40,10 @@ parts:
       key: "txt.apps.admin.error.app_build.manifest_keys.missing.other"
       title: "App builder job: missing manifest fields error"
       value: "Missing required fields in manifest: %{missing_keys}"
+  - translation:
+      key: "txt.apps.admin.error.app_build.requirements_not_json"
+      title: "App builder job: requirements file is invalid JSON error"
+      value: "requirements.json is not proper JSON. %{errors}"
   - translation:
       key: "txt.apps.admin.error.app_build.oauth_keys.missing.one"
       title: "App builder job: missing oauth fields error"

data/lib/zendesk_apps_support.rb

@@ -3,20 +3,22 @@ module ZendeskAppsSupport
   require 'zendesk_apps_support/sass_functions'
   require 'zendesk_apps_support/engine'
 
-  autoload :AppFile,    'zendesk_apps_support/app_file'
-  autoload :BuildTranslation, 'zendesk_apps_support/build_translation'
-  autoload :I18n,       'zendesk_apps_support/i18n'
-  autoload :Package,    'zendesk_apps_support/package'
-  autoload :AppVersion,    'zendesk_apps_support/app_version'
-  autoload :StylesheetCompiler,    'zendesk_apps_support/stylesheet_compiler'
+  autoload :AppFile,                'zendesk_apps_support/app_file'
+  autoload :BuildTranslation,       'zendesk_apps_support/build_translation'
+  autoload :I18n,                   'zendesk_apps_support/i18n'
+  autoload :Package,                'zendesk_apps_support/package'
+  autoload :AppVersion,             'zendesk_apps_support/app_version'
+  autoload :StylesheetCompiler,     'zendesk_apps_support/stylesheet_compiler'
 
   module Validations
     autoload :ValidationError,       'zendesk_apps_support/validations/validation_error'
+    autoload :Package,               'zendesk_apps_support/validations/package'
     autoload :Manifest,              'zendesk_apps_support/validations/manifest'
     autoload :Source,                'zendesk_apps_support/validations/source'
     autoload :Templates,             'zendesk_apps_support/validations/templates'
     autoload :Translations,          'zendesk_apps_support/validations/translations'
     autoload :JSHintValidationError, 'zendesk_apps_support/validations/validation_error'
     autoload :Stylesheets,           'zendesk_apps_support/validations/stylesheets'
+    autoload :Requirements,          'zendesk_apps_support/validations/requirements'
   end
 end

data/lib/zendesk_apps_support/package.rb

@@ -8,7 +8,7 @@ module ZendeskAppsSupport
 
     DEFAULT_LAYOUT = Erubis::Eruby.new( File.read(File.expand_path('../assets/default_template.html.erb', __FILE__)) )
     DEFAULT_SCSS   = File.read(File.expand_path('../assets/default_styles.scss', __FILE__))
-    SRC_TEMPLATE = Erubis::Eruby.new( File.read(File.expand_path('../assets/src.js.erb', __FILE__)) )
+    SRC_TEMPLATE   = Erubis::Eruby.new( File.read(File.expand_path('../assets/src.js.erb', __FILE__)) )
 
     attr_reader :root, :warnings
 
@@ -18,11 +18,24 @@ module ZendeskAppsSupport
     end
 
     def validate
-      Validations::Manifest.call(self) +
-        Validations::Source.call(self) +
-        Validations::Templates.call(self) +
-        Validations::Translations.call(self) +
-        Validations::Stylesheets.call(self)
+      [].tap do |errors|
+
+        errors << Validations::Package.call(self)
+        errors << Validations::Manifest.call(self)
+        errors << Validations::Translations.call(self)
+
+        if has_location?
+          errors << Validations::Source.call(self)
+          errors << Validations::Templates.call(self)
+          errors << Validations::Stylesheets.call(self)
+        end
+
+        if has_requirements?
+          errors << Validations::Requirements.call(self)
+        end
+
+        errors.flatten!
+      end
     end
 
     def files
@@ -38,11 +51,15 @@ module ZendeskAppsSupport
     end
 
     def manifest_json
-      JSON.parse(File.read(File.join(root, "manifest.json")), :symbolize_names => true)
+      read_json("manifest.json")
+    end
+
+    def requirements_json
+      read_json("requirements.json")
     end
 
     def translations
-      JSON.parse(File.read(File.join(root, "translations/en.json")))
+      read_json("translations/en.json", false)
     end
 
     def app_translations
@@ -51,7 +68,7 @@ module ZendeskAppsSupport
 
     def readified_js(app_name, app_id, asset_url_prefix, settings={})
       manifest = manifest_json
-      source = File.read(File.join(root, "app.js"))
+      source = read_file("app.js")
       name = app_name || manifest[:name] || 'Local App'
       location = manifest[:location]
       app_class_name = "app-#{app_id}"
@@ -81,6 +98,18 @@ module ZendeskAppsSupport
       customer_css = File.exist?(css_file) ? File.read(css_file) : ""
     end
 
+    def has_location?
+      manifest_json[:location]
+    end
+
+    def has_requirements?
+      !requirements_json.nil?
+    end
+
+    def is_requirements_only?
+      has_requirements? && !has_location?
+    end
+
     private
 
     def compiled_templates(app_id, asset_url_prefix)
@@ -112,5 +141,17 @@ module ZendeskAppsSupport
       end
       files
     end
+
+    def read_file(path)
+      file_path = File.join(root, path)
+      File.read(File.join(root, path))
+    end
+
+    def read_json(path, symbolize_names = true)
+      file = read_file(path)
+      unless file.nil?
+        JSON.parse(read_file(path), :symbolize_names => symbolize_names)
+      end
+    end
   end
 end

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -4,7 +4,7 @@ module ZendeskAppsSupport
   module Validations
     module Manifest
 
-      REQUIRED_MANIFEST_FIELDS = %w( author defaultLocale location frameworkVersion ).freeze
+      REQUIRED_MANIFEST_FIELDS = %w( author defaultLocale frameworkVersion ).freeze
       OAUTH_REQUIRED_FIELDS    = %w( client_id client_secret authorize_uri access_token_uri ).freeze
       LOCATIONS_AVAILABLE      = %w( top_bar nav_bar ticket_sidebar new_ticket_sidebar user_sidebar ).freeze
       TYPES_AVAILABLE          = %W( text password checkbox url number multiline hidden ).freeze
@@ -16,18 +16,20 @@ module ZendeskAppsSupport
           return [ValidationError.new(:missing_manifest)] unless manifest
 
           manifest = MultiJson.load(manifest.read)
-
           [].tap do |errors|
             errors << missing_keys_error(manifest)
             errors << default_locale_error(manifest, package)
-            errors << invalid_location_error(manifest)
-            errors << duplicate_location_error(manifest)
             errors << invalid_version_error(manifest, package)
             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)
+
+            if package.has_location?
+              errors << invalid_location_error(manifest)
+              errors << duplicate_location_error(manifest)
+            end
             errors.compact!
           end
         rescue MultiJson::DecodeError => e

data/lib/zendesk_apps_support/validations/package.rb

@@ -0,0 +1,24 @@
+module ZendeskAppsSupport
+  module Validations
+    module Package
+
+      class <<self
+        def call(package)
+          [].tap do |errors|
+            errors << has_location_or_requirements(package)
+            errors.compact!
+          end
+        end
+
+        private
+
+        def has_location_or_requirements(package)
+          if !package.has_location? && !package.has_requirements?
+            ValidationError.new('missing_location_and_requirements')
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/validations/requirements.rb

@@ -0,0 +1,32 @@
+require 'multi_json'
+
+module ZendeskAppsSupport
+  module Validations
+    module Requirements
+
+      class <<self
+        def call(package)
+          requirements = package.files.find { |f| f.relative_path == 'requirements.json' }
+
+          errors = []
+
+          if requirements && !valid_json?(requirements)
+            errors << ValidationError.new(:requirements_not_json)
+          end
+
+          errors
+        end
+
+        private
+
+        def valid_json? json
+          MultiJson.load(json)
+          true
+        rescue MultiJson::DecodeError
+          false
+        end
+
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+def read_fixture_file(file)
+  File.read("#{File.dirname(__FILE__)}/validations/fixture/#{file}")
+end

data/spec/validations/fixture/requirements.json

@@ -0,0 +1,22 @@
+{
+  "targets": {
+    "jira_story_target": {
+      "title": "blah",
+      "type": "jira_target",
+      "active": true,
+      "target_url": "http://example.org"
+    }
+  },
+
+  "triggers": {
+    "submit_trigger": {
+      "title": "whatever",
+      "position": "whatever",
+      "active": true,
+      "conditions": {
+        "all": [{ "field": "status", "operator": "less_than", "value": "solved" }]
+      },
+      "actions" : []
+    }
+  }
+}

data/spec/validations/manifest_spec.rb

@@ -15,7 +15,7 @@ describe ZendeskAppsSupport::Validations::Manifest do
   def create_package(parameter_hash)
     params = default_required_params(parameter_hash)
     manifest = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(params))
-    mock('Package', :files => [manifest])
+    mock('Package', :files => [manifest], :has_location? => true)
   end
 
   it 'should have an error when manifest.json is missing' do
@@ -28,16 +28,16 @@ describe ZendeskAppsSupport::Validations::Manifest do
 
   it 'should have an error when required field is missing' do
     manifest = mock('AppFile', :relative_path => 'manifest.json', :read => "{}")
-    package = mock('Package', :files => [manifest])
+    package = mock('Package', :files => [manifest], :has_location? => true)
     errors = ZendeskAppsSupport::Validations::Manifest.call(package)
 
-    errors.first().to_s.should eql 'Missing required fields in manifest: author, defaultLocale, location, frameworkVersion'
+    errors.first().to_s.should eql 'Missing required fields in manifest: author, defaultLocale, frameworkVersion'
   end
 
   it 'should have an error when the defaultLocale is invalid' do
     manifest = { 'defaultLocale' => 'pt-BR-1' }
     manifest_file = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(manifest))
-    package = mock('Package', :files => [manifest_file])
+    package = mock('Package', :files => [manifest_file], :has_location? => true)
     errors = ZendeskAppsSupport::Validations::Manifest.call(package)
 
     locale_error = errors.find { |e| e.to_s =~ /default locale/ }
@@ -48,7 +48,7 @@ describe ZendeskAppsSupport::Validations::Manifest do
     manifest = { 'defaultLocale' => 'pt' }
     manifest_file = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(manifest))
     translation_files = mock('AppFile', :relative_path => 'translations/en.json')
-    package = mock('Package', :files => [manifest_file], :translation_files => [translation_files])
+    package = mock('Package', :files => [manifest_file], :has_location? => true, :translation_files => [translation_files])
     errors = ZendeskAppsSupport::Validations::Manifest.call(package)
 
     locale_error = errors.find { |e| e.to_s =~ /Missing translation file/ }
@@ -58,7 +58,7 @@ describe ZendeskAppsSupport::Validations::Manifest do
   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])
+    package = mock('Package', :files => [manifest_file], :has_location? => true)
     errors = ZendeskAppsSupport::Validations::Manifest.call(package)
 
     locations_error = errors.find { |e| e.to_s =~ /invalid location/ }
@@ -68,7 +68,7 @@ describe ZendeskAppsSupport::Validations::Manifest do
   it 'should have an error when there are duplicate locations' do
     manifest = { 'location' => ['ticket_sidebar', 'ticket_sidebar'] }
     manifest_file = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(manifest))
-    package = mock('Package', :files => [manifest_file])
+    package = mock('Package', :files => [manifest_file], :has_location? => true)
     errors = ZendeskAppsSupport::Validations::Manifest.call(package)
 
     locations_error = errors.find { |e| e.to_s =~ /duplicate/ }
@@ -78,7 +78,7 @@ describe ZendeskAppsSupport::Validations::Manifest do
   it 'should have an error when the version is not supported' do
     manifest = { 'frameworkVersion' => '0.7' }
     manifest_file = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(manifest))
-    package = mock('Package', :files => [manifest_file])
+    package = mock('Package', :files => [manifest_file], :has_location? => true)
     errors = ZendeskAppsSupport::Validations::Manifest.call(package)
 
     version_error = errors.find { |e| e.to_s =~ /not a valid framework version/ }
@@ -95,7 +95,7 @@ describe ZendeskAppsSupport::Validations::Manifest do
     }
 
     manifest_file = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(manifest))
-    package = mock('Package', :files => [manifest_file])
+    package = mock('Package', :files => [manifest_file], :has_location? => true)
     errors = ZendeskAppsSupport::Validations::Manifest.call(package)
 
     hidden_params_error = errors.find { |e| e.to_s =~ /set to hidden and cannot be required/ }
@@ -104,7 +104,7 @@ describe ZendeskAppsSupport::Validations::Manifest do
 
   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])
+    package = mock('Package', :files => [manifest], :has_location? => true)
     errors = ZendeskAppsSupport::Validations::Manifest.call(package)
 
     errors.first().to_s.should =~ /^manifest is not proper JSON/

data/spec/validations/requirements_spec.rb

@@ -0,0 +1,23 @@
+require 'zendesk_apps_support'
+require 'spec_helper'
+
+describe ZendeskAppsSupport::Validations::Requirements do
+
+  it 'creates an error when the file is not valid JSON' do
+    requirements = mock('AppFile', :relative_path => 'requirements.json', :read => "{")
+    package = mock('Package', :files => [requirements])
+    errors = ZendeskAppsSupport::Validations::Requirements.call(package)
+
+    errors.first.key.should == :requirements_not_json
+  end
+
+  it "creates no error when the file is valid JSON" do
+    requirements = mock('AppFile', :relative_path => 'requirements.json',
+                                   :read => read_fixture_file('requirements.json'))
+    package = mock('Package', :files => [requirements])
+    errors = ZendeskAppsSupport::Validations::Requirements.call(package)
+
+    expect(errors).to be_empty
+  end
+
+end

data/spec/validations/translations_spec.rb

@@ -1,9 +1,7 @@
 require 'zendesk_apps_support'
+require 'spec_helper'
 require 'json'
 
-def read_fixture_file(file)
-  File.read("#{File.dirname(__FILE__)}/fixture/#{file}")
-end
 
 describe ZendeskAppsSupport::Validations::Translations do
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-15 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -144,6 +144,8 @@ files:
 - lib/zendesk_apps_support/sass_functions.rb
 - lib/zendesk_apps_support/stylesheet_compiler.rb
 - lib/zendesk_apps_support/validations/manifest.rb
+- lib/zendesk_apps_support/validations/package.rb
+- lib/zendesk_apps_support/validations/requirements.rb
 - lib/zendesk_apps_support/validations/source.rb
 - lib/zendesk_apps_support/validations/stylesheets.rb
 - lib/zendesk_apps_support/validations/templates.rb
@@ -166,10 +168,13 @@ files:
 - spec/build_translation_spec.rb
 - spec/i18n_spec.rb
 - spec/package_spec.rb
+- spec/spec_helper.rb
 - spec/validations/fixture/invalid_en.json
+- spec/validations/fixture/requirements.json
 - spec/validations/fixture/valid_en.json
 - spec/validations/jshint_error_spec.rb
 - spec/validations/manifest_spec.rb
+- spec/validations/requirements_spec.rb
 - spec/validations/source_spec.rb
 - spec/validations/stylesheets_spec.rb
 - spec/validations/templates_spec.rb
@@ -212,10 +217,13 @@ test_files:
 - spec/build_translation_spec.rb
 - spec/i18n_spec.rb
 - spec/package_spec.rb
+- spec/spec_helper.rb
 - spec/validations/fixture/invalid_en.json
+- spec/validations/fixture/requirements.json
 - spec/validations/fixture/valid_en.json
 - spec/validations/jshint_error_spec.rb
 - spec/validations/manifest_spec.rb
+- spec/validations/requirements_spec.rb
 - spec/validations/source_spec.rb
 - spec/validations/stylesheets_spec.rb
 - spec/validations/templates_spec.rb