zendesk_apps_support 0.3.2

data/lib/zendesk_apps_support/stylesheet_compiler.rb

@@ -0,0 +1,25 @@
+require 'sass'
+
+module ZendeskAppsSupport
+  class StylesheetCompiler
+
+    def initialize(source, app_id, url_prefix)
+      @source, @app_id, @url_prefix = source, app_id, url_prefix
+    end
+
+    def compile
+      Sass::Engine.new(wrapped_source, :syntax => :scss, :app_asset_url_builder => self).render
+    end
+
+    def app_asset_url(name)
+      "#{@url_prefix}/#{name}"
+    end
+
+    private
+
+    def wrapped_source
+      ".app-#{@app_id} {#{@source}}"
+    end
+
+  end
+end

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -0,0 +1,48 @@
+require 'multi_json'
+
+module ZendeskAppsSupport
+  module Validations
+    module Manifest
+
+      REQUIRED_MANIFEST_FIELDS = %w( author defaultLocale location frameworkVersion).freeze
+
+      class <<self
+        def call(package)
+          manifest = package.files.find { |f| f.relative_path == 'manifest.json' }
+
+          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)
+            errors.compact!
+          end
+        rescue MultiJson::DecodeError => e
+          return [ ValidationError.new(:manifest_not_json, :errors => e) ]
+        end
+
+        private
+
+        def missing_keys_error(manifest)
+          missing = REQUIRED_MANIFEST_FIELDS.select do |key|
+            manifest[key].nil?
+          end
+
+          if missing.any?
+            ValidationError.new('manifest_keys.missing', :missing_keys => missing.join(', '), :count => missing.length)
+          end
+        end
+
+        def default_locale_error(manifest)
+          default_locale = manifest['defaultLocale']
+          if !default_locale.nil? && default_locale !~ /^[a-z]{2,3}$/
+            ValidationError.new(:invalid_default_locale, :defaultLocale => default_locale)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/validations/source.rb

@@ -0,0 +1,43 @@
+require 'jshintrb'
+
+module ZendeskAppsSupport
+  module Validations
+    module Source
+
+      LINTER_OPTIONS = {
+        # enforcing options:
+        :noarg => true,
+        :undef => true,
+
+        # relaxing options:
+        :eqnull => true,
+        :laxcomma => true,
+
+        # predefined globals:
+        :predef => %w(_ console services helpers alert JSON Base64 clearInterval clearTimeout setInterval setTimeout)
+      }.freeze
+
+      class <<self
+        def call(package)
+          source = package.files.find { |f| f.relative_path == 'app.js' }
+
+          return [ ValidationError.new(:missing_source) ] unless source
+
+          jshint_errors = linter.lint(source.read)
+          if jshint_errors.any?
+            [ JSHintValidationError.new(source.relative_path, jshint_errors) ]
+          else
+            []
+          end
+        end
+
+        private
+
+        def linter
+          Jshintrb::Lint.new(LINTER_OPTIONS)
+        end
+
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/validations/templates.rb

@@ -0,0 +1,20 @@
+module ZendeskAppsSupport
+  module Validations
+    module Templates
+
+      class <<self
+        def call(package)
+          errors = []
+          package.template_files.each do |template|
+            contents = template.read
+            if contents =~ /<\s*style\b/
+              errors << ValidationError.new(:style_in_template, :template => template.relative_path)
+            end
+          end
+          errors
+        end
+      end
+
+    end
+  end
+end

data/lib/zendesk_apps_support/validations/translations.rb

@@ -0,0 +1,38 @@
+require 'jshintrb'
+
+module ZendeskAppsSupport
+  module Validations
+    module Translations
+      class << self
+
+        TRANSLATIONS_PATH = %r{^translations/(.*)\.json$}
+        VALID_LOCALE = /^[a-z]{2,3}$/
+
+        def call(package)
+          package.files.inject([]) do |errors, file|
+            if path_match = TRANSLATIONS_PATH.match(file.relative_path)
+              errors << locale_error(file, path_match[1]) << json_error(file)
+            end
+            errors
+          end.compact
+        end
+
+        private
+
+        def locale_error(file, locale)
+          return nil if VALID_LOCALE =~ locale
+          ValidationError.new('translation.invalid_locale', :file => file.relative_path)
+        end
+
+        def json_error(file)
+          json = MultiJson.load(file.read)
+          return nil if json.kind_of?(Hash)
+          ValidationError.new('translation.not_json_object', :file => file.relative_path)
+        rescue MultiJson::DecodeError => e
+          ValidationError.new('translation.not_json', :file => file.relative_path, :errors => e)
+        end
+
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/validations/validation_error.rb

@@ -0,0 +1,103 @@
+require 'multi_json'
+
+module ZendeskAppsSupport
+  module Validations
+
+    class ValidationError
+      KEY_PREFIX = 'txt.apps.admin.error.app_build.'.freeze
+
+      class DeserializationError < StandardError
+        def initialize(serialized)
+          super "Cannot deserialize ValidationError from #{serialized}"
+        end
+      end
+
+      class << self
+
+        # Turn a JSON string into a ValidationError.
+        def from_json(json)
+          hash = MultiJson.decode(json)
+          raise DeserializationError.new(json) unless hash.is_a?(Hash)
+          from_hash(hash)
+        rescue MultiJson::DecodeError, NameError
+          raise DeserializationError.new(json)
+        end
+
+        def from_hash(hash)
+          raise DeserializationError.new(hash) unless hash['class']
+          klass = constantize(hash['class'])
+          raise DeserializationError.new(hash) unless klass <= self
+          klass.vivify(hash)
+        end
+
+        # Turn a Hash into a ValidationError. Used within from_json.
+        def vivify(hash)
+          new(hash['key'], hash['data'])
+        end
+
+        private
+
+        def constantize(klass)
+          klass.to_s.split('::').inject(Object) { |klass, part| klass = klass.const_get(part) }
+        end
+      end
+
+      attr_reader :key, :data
+
+      def initialize(key, data = nil)
+        @key, @data = key, symbolize_keys(data || {})
+      end
+
+      def to_s
+        ZendeskAppsSupport::I18n.t("#{KEY_PREFIX}#{key}", data)
+      end
+
+      def to_json(*options)
+        MultiJson.encode(as_json)
+      end
+
+      def as_json(*options)
+        {
+          'class' => self.class.to_s,
+          'key'   => key,
+          'data'  => data
+        }
+      end
+
+      private
+
+      def symbolize_keys(hash)
+        hash.inject({}) do |result, (key, value)|
+          result[key.to_sym] = value
+          result
+        end
+      end
+    end
+
+    class JSHintValidationError < ValidationError
+      attr_reader :filename, :jshint_errors
+
+      def self.vivify(hash)
+        new(hash['filename'], hash['jshint_errors'])
+      end
+
+      def initialize(filename, jshint_errors)
+        errors = jshint_errors.compact.map { |err| "\n  L#{err['line']}: #{err['reason']}" }.join('')
+        @filename = filename, @jshint_errors = jshint_errors
+        super(:jshint, {
+          :file => filename,
+          :errors => errors,
+          :count => jshint_errors.length
+        })
+      end
+
+      def as_json(*options)
+        {
+          'class' => self.class.to_s,
+          'filename' => filename,
+          'jshint_errors' => jshint_errors
+        }
+      end
+    end
+  end
+end

data/spec/app/app.css

@@ -0,0 +1,6 @@
+h1 {
+  color: red;
+  span {
+    color: green;
+  }
+}

data/spec/app/app.js

@@ -0,0 +1,12 @@
+(function() {
+
+  return {
+    events: {
+      'app.activated':'doSomething'
+    },
+
+    doSomething: function() {
+    }
+  };
+
+}());

data/spec/app/manifest.json

@@ -0,0 +1,11 @@
+{
+  "name": "ABC",
+  "author": {
+    "name": "John Smith",
+    "email": "john@example.com"
+  },
+  "defaultLocale": "en",
+  "private": true,
+  "location": "ticket_sidebar",
+  "frameworkVersion": "0.5"
+}

data/spec/app/templates/layout.hdbs

@@ -0,0 +1,11 @@
+<header>
+  <span class="logo"/>
+  <h3>{{setting "name"}}</h3>
+</header>
+<section data-main/>
+<footer>
+  <a href="mailto:{{author.email}}">
+    {{author.name}}
+  </a>
+</footer>
+</div>

data/spec/app/translations/en.json

@@ -0,0 +1,5 @@
+{
+  "app": {
+    "name":         "Buddha Machine"
+  }
+}

data/spec/app_file_spec.rb

@@ -0,0 +1,27 @@
+require 'zendesk_apps_support'
+
+describe ZendeskAppsSupport::AppFile do
+
+  before do
+    package = mock('Package', :root => Pathname("spec/app/templates/"))
+    @file = ZendeskAppsSupport::AppFile.new(package, 'layout.hdbs')
+  end
+
+  describe '=~' do
+    it 'should test against the relative path of the file' do
+      @file.should =~ /layout/
+    end
+  end
+
+  describe 'read' do
+    it 'should read file content' do
+      @file.read.should =~ /<header>/
+    end
+  end
+
+  describe 'to_s' do
+    it 'should return file name' do
+      @file.to_s.should == 'layout.hdbs'
+    end
+  end
+end

data/spec/app_version_spec.rb

@@ -0,0 +1,61 @@
+require 'zendesk_apps_support'
+
+describe ZendeskAppsSupport::AppVersion do
+
+  describe 'the current version' do
+    subject do
+      ZendeskAppsSupport::AppVersion.new(ZendeskAppsSupport::AppVersion::CURRENT)
+    end
+
+    it { should be_frozen }
+    it { should be_present }
+    it { should be_servable }
+    it { should be_valid_for_update }
+    it { should_not be_blank }
+    it { should_not be_deprecated }
+    it { should_not be_obsolete }
+    it { should == ZendeskAppsSupport::AppVersion.new(ZendeskAppsSupport::AppVersion::CURRENT) }
+    it { should_not == ZendeskAppsSupport::AppVersion.new('0.2') }
+
+    its(:to_s) { should == ZendeskAppsSupport::AppVersion::CURRENT }
+    its(:to_json) { should == ZendeskAppsSupport::AppVersion::CURRENT.to_json }
+  end
+
+  describe 'the deprecated version' do
+    subject do
+      ZendeskAppsSupport::AppVersion.new(ZendeskAppsSupport::AppVersion::DEPRECATED)
+    end
+
+    it { should be_frozen }
+    it { should be_present }
+    it { should be_servable }
+    it { should_not be_valid_for_update }
+    it { should_not be_blank }
+    it { should be_deprecated }
+    it { should_not be_obsolete }
+    it { should == ZendeskAppsSupport::AppVersion.new(ZendeskAppsSupport::AppVersion::DEPRECATED) }
+    it { should_not == ZendeskAppsSupport::AppVersion.new('0.2') }
+
+    its(:to_s) { should == ZendeskAppsSupport::AppVersion::DEPRECATED }
+    its(:to_json) { should == ZendeskAppsSupport::AppVersion::DEPRECATED.to_json }
+  end
+
+  describe 'a really old version' do
+    subject do
+      ZendeskAppsSupport::AppVersion.new('0.1')
+    end
+
+    it { should be_frozen }
+    it { should be_present }
+    it { should_not be_servable }
+    it { should_not be_valid_for_update }
+    it { should_not be_blank }
+    it { should_not be_deprecated }
+    it { should be_obsolete }
+    it { should == ZendeskAppsSupport::AppVersion.new('0.1') }
+    it { should_not == ZendeskAppsSupport::AppVersion.new('0.2') }
+
+    its(:to_s) { should == '0.1' }
+    its(:to_json) { should == '0.1'.to_json }
+  end
+end

data/spec/i18n_spec.rb

@@ -0,0 +1,22 @@
+require 'zendesk_apps_support'
+require 'pathname'
+
+describe ZendeskAppsSupport::I18n do
+
+  it 'should translate error messages' do
+    key_prefix = ZendeskAppsSupport::Validations::ValidationError::KEY_PREFIX
+    ZendeskAppsSupport::I18n.t("#{key_prefix}.missing_manifest").should == 'Could not find manifest.json'
+  end
+
+end
+
+describe 'translations' do
+
+  it 'should be up-to-date' do
+    project_root = Pathname.new(File.expand_path('../../', __FILE__))
+    zendesk_version  = project_root.join('config/locales/translations/zendesk_apps_support.yml')
+    standard_version = project_root.join('config/locales/en.yml')
+    File.mtime(standard_version).should be >= File.mtime(zendesk_version)
+  end
+
+end