zendesk_apps_support 1.2.0 → 1.3.0

data/config/locales/en.yml

@@ -15,6 +15,10 @@ en:
               missing:
                 one: ! 'Missing required field in manifest: %{missing_keys}'
                 other: ! 'Missing required fields in manifest: %{missing_keys}'
+            oauth_keys:
+              missing:
+                one: ! 'Missing required oauth field in manifest: %{missing_keys}'
+                other: ! 'Missing required oauth fields in manifest: %{missing_keys}'
             missing_source: Could not find app.js
             style_in_template: <style> tag in %{template}. Use an app.css file instead.
             invalid_default_locale: ! '%{defaultLocale} is not a valid default locale.
@@ -27,6 +31,8 @@ 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.'
+            invalid_version: ! '%{target_version} is not a valid framework version.
+              Available versions are: %{available_versions}.'
             parameters_not_an_array: App parameters must be an array.
             duplicate_parameters: ! 'Duplicate app parameters defined: %{duplicate_parameters}'
             translation:
@@ -38,3 +44,8 @@ en:
             invalid_type_parameter:
               one: ! '%{invalid_types} is an invalid parameter type.'
               other: ! '%{invalid_types} are invalid parameter types.'
+        warning:
+          app_build:
+            deprecated_version: You are targeting a deprecated version of the framework,
+              your App will still work but might break as soon as the new framework
+              version is deployed.

data/config/locales/translations/zendesk_apps_support.yml

@@ -31,6 +31,14 @@ 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.oauth_keys.missing.one"
+      title: "App builder job: missing oauth fields error"
+      value: "Missing required oauth field in manifest: %{missing_keys}"
+  - translation:
+      key: "txt.apps.admin.error.app_build.oauth_keys.missing.other"
+      title: "App builder job: missing oauth fields error"
+      value: "Missing required oauth fields in manifest: %{missing_keys}"
   - translation:
       key: "txt.apps.admin.error.app_build.missing_source"
       title: "App builder job: missing app.js error"
@@ -63,6 +71,14 @@ 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.warning.app_build.deprecated_version"
+      title: "App builder job: deprecated version specified"
+      value: 'You are targeting a deprecated version of the framework, your App will still work but might break as soon as the new framework version is deployed.'
+  - translation:
+      key: "txt.apps.admin.error.app_build.invalid_version"
+      title: "App builder job: invalid framework version"
+      value: "%{target_version} is not a valid framework version. Available versions are: %{available_versions}."
   - translation:
       key: "txt.apps.admin.error.app_build.parameters_not_an_array"
       title: "App builder job: app parameters must be an array"

data/lib/zendesk_apps_support/app_version.rb

@@ -14,7 +14,7 @@ module ZendeskAppsSupport
 
     DEPRECATED = '0.4'.freeze
     CURRENT    = '0.5'.freeze
-    FUTURE     = nil
+    FUTURE     = '1.0'.freeze
 
     TO_BE_SERVED     = [ DEPRECATED, CURRENT, FUTURE ].compact.freeze
     VALID_FOR_UPDATE = [ CURRENT, FUTURE ].compact.freeze

data/lib/zendesk_apps_support/package.rb

@@ -8,10 +8,11 @@ module ZendeskAppsSupport
     DEFAULT_SCSS   = File.read(File.expand_path('../default_styles.scss', __FILE__))
     SRC_TEMPLATE = Erubis::Eruby.new( File.read(File.expand_path('../src.js.erb', __FILE__)) )
 
-    attr_reader :root
+    attr_reader :root, :warnings
 
     def initialize(dir)
       @root = Pathname.new(File.expand_path(dir))
+      @warnings = []
     end
 
     def validate

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
+      OAUTH_REQUIRED_FIELDS    = %w( client_id client_secret authorize_uri access_token_uri ).freeze
       LOCATIONS_AVAILABLE      = %w( nav_bar ticket_sidebar new_ticket_sidebar user_sidebar ).freeze
       TYPES_AVAILABLE          = %W(text password checkbox url number multiline hidden).freeze
 
@@ -20,6 +21,8 @@ module ZendeskAppsSupport
             errors << missing_keys_error(manifest)
             errors << default_locale_error(manifest, package)
             errors << invalid_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)
@@ -31,6 +34,19 @@ module ZendeskAppsSupport
 
         private
 
+        def oauth_error(manifest)
+          return unless manifest['oauth']
+
+          missing = OAUTH_REQUIRED_FIELDS.select do |key|
+            manifest['oauth'][key].nil? || manifest['oauth'][key].empty?
+          end
+
+          if missing.any?
+            ValidationError.new('oauth_keys.missing', :missing_keys => missing.join(', '), :count => missing.length)
+          end
+
+        end
+
         def parameters_error(manifest)
           return unless manifest['parameters']
 
@@ -73,6 +89,19 @@ module ZendeskAppsSupport
           end
         end
 
+        def invalid_version_error(manifest, package)
+          valid_to_serve = AppVersion::TO_BE_SERVED
+          target_version = manifest['frameworkVersion']
+
+          if target_version == AppVersion::DEPRECATED
+            package.warnings << I18n.t('txt.apps.admin.warning.app_build.deprecated_version')
+          end
+
+          unless valid_to_serve.include?(target_version)
+            return ValidationError.new(:invalid_version, :target_version => target_version, :available_versions => valid_to_serve.join(', '))
+          end
+        end
+
         def invalid_hidden_parameter_error(manifest)
           invalid_params = []
 

data/spec/package_spec.rb

@@ -68,7 +68,7 @@ describe ZendeskAppsSupport::Package do
                         email: "john@example.com"
                     },
                     translations: {"app":{\"name\":\"Buddha Machine\"}},
-                    templates: {"layout":"<style>\\n.app-0 header {\\n  border-bottom: 1px dotted #cccccc;\\n  margin-bottom: 12px; }\\n  .app-0 header h3 {\\n    line-height: 30px; }\\n  .app-0 header hr {\\n    margin-top: 0; }\\n  .app-0 header .logo {\\n    background: transparent url(\\"http://localhost:4567/logo-small.png\\") no-repeat;\\n    background-size: 25px 25px;\\n    float: right;\\n    height: 25px;\\n    width: 25px; }\\n  .app-0 header .app-warning-icon {\\n    cursor: pointer;\\n    float: right;\\n    margin-left: 2px;\\n    padding: 5px; }\\n.app-0 h3 {\\n  font-size: 14px; }\\n.app-0 footer {\\n  background: none;\\n  border: 0; }\\n.app-0 h1 {\\n  color: red; }\\n  .app-0 h1 span {\\n    color: green; }\\n</style>\\n<header>\\n  <span class=\\"logo\\"/>\\n  <h3>{{setting \\"name\\"}}</h3>\\n</header>\\n<section data-main/>\\n<footer>\\n  <a href=\\"mailto:{{author.email}}\\">\\n    {{author.name}}\\n  </a>\\n</footer>\\n</div>"},
+                    templates: {"layout":"<style>\\n.app-0 header {\\n  border-bottom: 1px dotted #CCC;\\n  margin-bottom: 12px; }\\n  .app-0 header h3 {\\n    line-height: 30px; }\\n  .app-0 header hr {\\n    margin-top: 0; }\\n  .app-0 header .logo {\\n    background: transparent url(\\"http://localhost:4567/logo-small.png\\") no-repeat;\\n    background-size: 25px 25px;\\n    float: right;\\n    height: 25px;\\n    width: 25px; }\\n  .app-0 header .app-warning-icon {\\n    cursor: pointer;\\n    float: right;\\n    margin-left: 2px;\\n    padding: 5px; }\\n.app-0 h3 {\\n  font-size: 14px; }\\n.app-0 footer {\\n  background: none;\\n  border: 0; }\\n.app-0 h1 {\\n  color: red; }\\n  .app-0 h1 span {\\n    color: green; }\\n</style>\\n<header>\\n  <span class=\\"logo\\"/>\\n  <h3>{{setting \\"name\\"}}</h3>\\n</header>\\n<section data-main/>\\n<footer>\\n  <a href=\\"mailto:{{author.email}}\\">\\n    {{author.name}}\\n  </a>\\n</footer>\\n</div>"},
                     frameworkVersion: "0.5"
                 });
 
@@ -81,4 +81,4 @@ HERE
       js.should == expected
     end
   end
-end
+end

data/spec/validations/manifest_spec.rb

@@ -65,6 +65,16 @@ describe ZendeskAppsSupport::Validations::Manifest do
     locations_error.should_not be_nil
   end
 
+  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])
+    errors = ZendeskAppsSupport::Validations::Manifest.call(package)
+
+    version_error = errors.find { |e| e.to_s =~ /not a valid framework version/ }
+    version_error.should_not be_nil
+  end
+
   it 'should have an error when a hidden parameter is set to required' do
     manifest = {
       'parameters' => [
@@ -90,11 +100,21 @@ describe ZendeskAppsSupport::Validations::Manifest do
     errors.first().to_s.should =~ /^manifest is not proper JSON/
   end
 
+  it "should have an error when required oauth fields are missing" do
+    oauth_hash = {
+      "oauth" => {}
+    }
+    errors = ZendeskAppsSupport::Validations::Manifest.call(create_package(default_required_params.merge(oauth_hash)))
+    oauth_error = errors.find { |e| e.to_s =~ /oauth field/ }
+    oauth_error.to_s.should == "Missing required oauth fields in manifest: client_id, client_secret, authorize_uri, access_token_uri"
+  end
+
   context 'with invalid parameters' do
 
     before do
       ZendeskAppsSupport::Validations::Manifest.stub(:default_locale_error)
       ZendeskAppsSupport::Validations::Manifest.stub(:invalid_location_error)
+      ZendeskAppsSupport::Validations::Manifest.stub(:invalid_version_error)
     end
 
     it 'has an error when the app parameters are not an array' do

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
+  prerelease: 
 platform: ruby
 authors:
 - James A. Rosen
@@ -10,11 +11,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,6 +24,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -29,6 +32,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -36,6 +40,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -43,6 +48,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -50,6 +56,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -57,6 +64,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -64,6 +72,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -71,6 +80,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,6 +88,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -85,6 +96,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: jshintrb
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -92,6 +104,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -99,6 +112,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -106,10 +120,27 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description: Support to help you develop Zendesk Apps.
 email:
 - dev@zendesk.com
@@ -158,26 +189,27 @@ files:
 homepage: http://github.com/zendesk/zendesk_apps_support
 licenses:
 - Apache License Version 2.0
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Support to help you develop Zendesk Apps.
 test_files:
 - spec/app/app.css

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGU4ZDQ2YzkxOWEzNmM2NjJjNDNiZmYzODZjOTdhNmM5MGE3YjA4ZQ==
-  data.tar.gz: !binary |-
-    OGU3MTU0YmJhNDQzODEzMWZhODA0ZmU2YWYxOWYwZWM0OGQ3ZTBkYw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZWNlZWNjZDg3NzNlNDIxNjc5OWRhZWFlMzBkMWQ3OTUyOGM1MWZlOTYyNjJl
-    NWQ3MjQ5ODJiYzFiNzRmOWZiOTE3ZGY4N2Y1OTZhY2U2ZjdiMzJjYTk1MTky
-    YjEwNGJjYmNkOTk0NzJlN2ViZTRmMjJjMWVlNzIyNTY0NWMxZjI=
-  data.tar.gz: !binary |-
-    MGQ0Njk5YmIxMTMzYmU3YTdiYzNkN2VmMTMyNmIzOWU4NjEyZDk2ZGY2NWVm
-    MzFhZTUzNmMyMGM1NjAwMWEyZTg1MGM5NzNkMTVjMDA4MWE0YTI4NjEyZjQx
-    Zjg5ZjE1ZmZkMzcwYTE4MDJkNjFhYmZjYWNmY2QwODkwMzFhZDY=