zendesk_apps_support 0.3.2

data/spec/package_spec.rb

@@ -0,0 +1,84 @@
+require 'zendesk_apps_support'
+
+describe ZendeskAppsSupport::Package do
+
+  before do
+    @package = ZendeskAppsSupport::Package.new('spec/app')
+  end
+
+  describe 'files' do
+    it 'should return all the files within the app folder excluding files in tmp folder' do
+      @package.files.map(&:relative_path).should == %w(app.css app.js assets/logo-small.png assets/logo.png manifest.json templates/layout.hdbs translations/en.json)
+    end
+  end
+
+  describe 'template_files' do
+    it 'should return all the files in the templates folder within the app folder' do
+      @package.template_files.map(&:relative_path).should == %w(templates/layout.hdbs)
+    end
+  end
+
+  describe 'translation_files' do
+    it 'should return all the files in the translations folder within the app folder' do
+      @package.translation_files.map(&:relative_path).should == %w(translations/en.json)
+    end
+  end
+
+  describe 'manifest_json' do
+    it 'should return manifest json' do
+      manifest = @package.manifest_json
+      manifest[:name].should == 'ABC'
+      manifest[:author][:name].should == 'John Smith'
+      manifest[:author][:email].should == 'john@example.com'
+      manifest[:defaultLocale].should == 'en'
+      manifest[:private].should == true
+      manifest[:location].should == 'ticket_sidebar'
+      manifest[:frameworkVersion].should == '0.5'
+    end
+  end
+
+  describe 'readified_js' do
+    it 'should generate js ready for installation' do
+      js = @package.readified_js(nil, 0, 'http://localhost:4567')
+      expected =<<HERE
+(function() {
+    with( require('apps/framework/app_scope') ) {
+
+        var source = (function() {
+
+  return {
+    events: {
+      'app.activated':'doSomething'
+    },
+
+    doSomething: function() {
+    }
+  };
+
+}());
+;
+
+        ZendeskApps["ABC"] = ZendeskApps.defineApp(source)
+                .reopenClass({ location: "ticket_sidebar" })
+                .reopen({
+                    assetUrlPrefix: "http://localhost:4567",
+                    appClassName: "app-0",
+                    author: {
+                        name: "John Smith",
+                        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>"},
+                    frameworkVersion: "0.5"
+                });
+
+    }
+
+    ZendeskApps["ABC"].install({"id": 0, "app_id": 0, "settings": {\"title\":\"ABC\"}});
+
+}());
+HERE
+      js.should == expected
+    end
+  end
+end

data/spec/validations/jshint_error_spec.rb

@@ -0,0 +1,17 @@
+require 'zendesk_apps_support'
+
+describe ZendeskAppsSupport::Validations::JSHintValidationError do
+
+  let(:filename) { 'foo.js' }
+
+  context 'with nil errors' do
+
+    let(:errors) { [ nil, { 'line' => 12, 'reason' => 'eval is evil' }, nil ] }
+    let(:error) { ZendeskAppsSupport::Validations::JSHintValidationError.new(filename, errors) }
+
+    it 'ignores nil errors' do
+      error.to_s.should =~ /eval is evil/
+    end
+  end
+
+end

data/spec/validations/manifest_spec.rb

@@ -0,0 +1,39 @@
+require 'zendesk_apps_support'
+require 'json'
+
+describe ZendeskAppsSupport::Validations::Manifest do
+
+  it 'should have an error when manifest.json is missing' do
+    files = [mock('AppFile', :relative_path => 'abc.json')]
+    package = mock('Package', :files => files)
+    errors = ZendeskAppsSupport::Validations::Manifest.call(package)
+
+    errors.first().to_s.should eql 'Could not find manifest.json'
+  end
+
+  it 'should have an error when required field is missing' do
+    manifest = mock('AppFile', :relative_path => 'manifest.json', :read => "{}")
+    package = mock('Package', :files => [manifest])
+    errors = ZendeskAppsSupport::Validations::Manifest.call(package)
+
+    errors.first().to_s.should eql 'Missing required fields in manifest: author, defaultLocale, location, frameworkVersion'
+  end
+
+  it 'should have an error when the defaultLocale is invalid' do
+    manifest = { 'defaultLocale' => 'pt-BR' }
+    manifest_file = mock('AppFile', :relative_path => 'manifest.json', :read => JSON.dump(manifest))
+    package = mock('Package', :files => [manifest_file])
+    errors = ZendeskAppsSupport::Validations::Manifest.call(package)
+
+    locale_error = errors.find { |e| e.to_s =~ /defaultLocale/ }
+    locale_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])
+    errors = ZendeskAppsSupport::Validations::Manifest.call(package)
+
+    errors.first().to_s.should =~ /^manifest is not proper JSON/
+  end
+end

data/spec/validations/source_spec.rb

@@ -0,0 +1,21 @@
+require 'zendesk_apps_support'
+
+describe ZendeskAppsSupport::Validations::Source do
+
+  it 'should have an error when app.js is missing' do
+    files = [mock('AppFile', :relative_path => 'abc.js')]
+    package = mock('Package', :files => files)
+    errors = ZendeskAppsSupport::Validations::Source.call(package)
+
+    errors.first().to_s.should eql 'Could not find app.js'
+  end
+
+  it 'should have a jslint error when missing semicolon' do
+    source = mock('AppFile', :relative_path => 'app.js', :read => "var a = 1")
+    package = mock('Package', :files => [source])
+    errors = ZendeskAppsSupport::Validations::Source.call(package)
+
+    errors.first().to_s.should eql "JSHint error in app.js: \n  L1: Missing semicolon."
+  end
+
+end

data/spec/validations/templates_spec.rb

@@ -0,0 +1,13 @@
+require 'zendesk_apps_support'
+
+describe ZendeskAppsSupport::Validations::Templates do
+
+  it 'should have a jslint error when missing semicolon' do
+    template = mock('AppFile', :relative_path => 'layout.hdbs', :read => "<style>")
+    package = mock('Package', :template_files => [template])
+    errors = ZendeskAppsSupport::Validations::Templates.call(package)
+
+    errors.first().to_s.should eql "<style> tag in layout.hdbs. Use an app.css file instead."
+  end
+
+end

data/spec/validations/translations_spec.rb

@@ -0,0 +1,58 @@
+require 'zendesk_apps_support'
+require 'json'
+
+describe ZendeskAppsSupport::Validations::Translations do
+
+  let(:package) { mock('Package', :files => translation_files) }
+  subject { ZendeskAppsSupport::Validations::Translations.call(package) }
+
+  context 'when there are no translation files' do
+    let(:translation_files) { [] }
+    it 'should be valid' do
+      subject.should be_empty
+    end
+  end
+
+  context 'when there is file with invalid JSON' do
+    let(:translation_files) do
+      [ mock('AppFile', :relative_path => 'translations/en.json', :read => '}') ]
+    end
+
+    it 'should report the error' do
+      subject.length.should == 1
+      subject[0].to_s.should =~ /JSON/
+    end
+  end
+
+  context 'when there is file with JSON representing a non-Object' do
+    let(:translation_files) do
+      [ mock('AppFile', :relative_path => 'translations/en.json', :read => '"foo bar"') ]
+    end
+
+    it 'should report the error' do
+      subject.length.should == 1
+      subject[0].to_s.should =~ /JSON/
+    end
+  end
+
+  context 'when there is a file with an invalid locale for a name' do
+    let(:translation_files) do
+      [ mock('AppFile', :relative_path => 'translations/en-US.json', :read => '{}') ]
+    end
+
+    it 'should report the error' do
+      subject.length.should == 1
+      subject[0].to_s.should =~ /locale/
+    end
+  end
+
+  context 'when there is a file with a valid locale containing valid JSON' do
+    let(:translation_files) do
+      [ mock('AppFile', :relative_path => 'translations/en.json', :read => '{}') ]
+    end
+
+    it 'should be valid' do
+      subject.length.should == 0
+    end
+  end
+end

data/spec/validations/validation_serialization_spec.rb

@@ -0,0 +1,96 @@
+require 'zendesk_apps_support'
+require 'json'
+
+describe ZendeskAppsSupport::Validations::ValidationError do
+
+  ValidationError = ZendeskAppsSupport::Validations::ValidationError
+
+  it 'symbolizes the keys in its data' do
+    error = ValidationError.new(:foo, 'bar' => 'baz')
+    error.data[:bar].should == 'baz'
+  end
+
+  describe '#to_json' do
+    let(:key)   { 'foo.bar' }
+    let(:data)  { { 'baz' => 'quux' } }
+    let(:error) { ValidationError.new(key, data) }
+    subject     { error.to_json }
+
+    it do
+      should == {
+                  'class' => error.class.to_s,
+                  'key'   => error.key,
+                  'data'  => error.data
+                }.to_json
+    end
+  end
+
+  describe '.from_hash' do
+
+    subject { ValidationError.from_hash(hash) }
+
+    context 'for a generic error' do
+      let(:hash) do
+        {
+          'class' => 'ZendeskAppsSupport::Validations::ValidationError',
+          'key'   => 'foo.bar.baz',
+          'data'  => { 'quux' => 'yargle' }
+        }
+      end
+
+      it { should be_a(ValidationError) }
+
+      its(:key) { should == 'foo.bar.baz' }
+
+      its(:data) { should == { :quux => 'yargle' } }
+      its(:data) { should}
+    end
+
+    context 'for a JSHint error' do
+      let(:hash) do
+        {
+          'class'         => 'ZendeskAppsSupport::Validations::JSHintValidationError',
+          'file'          => 'foo.js',
+          'jshint_errors' => [ { 'line' => 55, 'reason' => 'Yuck' } ]
+        }
+      end
+
+      it { should be_a(ZendeskAppsSupport::Validations::JSHintValidationError) }
+
+      its(:key) { should == :jshint }
+
+      its(:jshint_errors) do
+        should == [ { 'line' => 55, 'reason' => 'Yuck' } ]
+      end
+    end
+
+    context 'for a non-ValidationError hash' do
+      let(:hash) do
+        {
+          :foo => 'bar'
+        }
+      end
+
+      it 'raises a DeserializationError' do
+        lambda { subject }.should raise_error(ValidationError::DeserializationError)
+      end
+    end
+
+  end
+
+  describe '.from_json' do
+
+    it 'decodes a JSON hash and passes it to .from_hash' do
+      ValidationError.should_receive(:from_hash).with('foo' => 'bar')
+      ValidationError.from_json(MultiJson.encode({ 'foo' => 'bar' }))
+    end
+
+    it 'raises a DeserializationError when passed non-JSON' do
+      lambda {
+        ValidationError.from_json('}}}')
+      }.should raise_error(ValidationError::DeserializationError)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: zendesk_apps_support
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+  prerelease: 
+platform: ruby
+authors:
+- James A. Rosen
+- Kenshiro Nakagawa
+- Shajith Chacko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-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
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jshintrb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Support to help you develop Zendesk Apps.
+email:
+- dev@zendesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zendesk_apps_support/app_file.rb
+- lib/zendesk_apps_support/app_version.rb
+- lib/zendesk_apps_support/default_styles.scss
+- lib/zendesk_apps_support/engine.rb
+- lib/zendesk_apps_support/i18n.rb
+- lib/zendesk_apps_support/package.rb
+- lib/zendesk_apps_support/sass_functions.rb
+- lib/zendesk_apps_support/src.js.erb
+- lib/zendesk_apps_support/stylesheet_compiler.rb
+- lib/zendesk_apps_support/validations/manifest.rb
+- lib/zendesk_apps_support/validations/source.rb
+- lib/zendesk_apps_support/validations/templates.rb
+- lib/zendesk_apps_support/validations/translations.rb
+- lib/zendesk_apps_support/validations/validation_error.rb
+- lib/zendesk_apps_support.rb
+- config/locales/en.yml
+- config/locales/translations/zendesk_apps_support.yml
+- README.md
+- LICENSE
+- spec/app/app.css
+- spec/app/app.js
+- spec/app/assets/logo-small.png
+- spec/app/assets/logo.png
+- spec/app/manifest.json
+- spec/app/templates/layout.hdbs
+- spec/app/translations/en.json
+- spec/app_file_spec.rb
+- spec/app_version_spec.rb
+- spec/i18n_spec.rb
+- spec/package_spec.rb
+- spec/validations/jshint_error_spec.rb
+- spec/validations/manifest_spec.rb
+- spec/validations/source_spec.rb
+- spec/validations/templates_spec.rb
+- spec/validations/translations_spec.rb
+- spec/validations/validation_serialization_spec.rb
+homepage: http://github.com/zendesk/zendesk_apps_support
+licenses: []
+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: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Support to help you develop Zendesk Apps.
+test_files:
+- spec/app/app.css
+- spec/app/app.js
+- spec/app/assets/logo-small.png
+- spec/app/assets/logo.png
+- spec/app/manifest.json
+- spec/app/templates/layout.hdbs
+- spec/app/translations/en.json
+- spec/app_file_spec.rb
+- spec/app_version_spec.rb
+- spec/i18n_spec.rb
+- spec/package_spec.rb
+- spec/validations/jshint_error_spec.rb
+- spec/validations/manifest_spec.rb
+- spec/validations/source_spec.rb
+- spec/validations/templates_spec.rb
+- spec/validations/translations_spec.rb
+- spec/validations/validation_serialization_spec.rb