zendesk_apps_support 0.3.2

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2012 Zendesk
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,3 @@
+## Zendesk Apps Support
+
+Classes to manage and validate zendesk apps

data/config/locales/en.yml

@@ -0,0 +1,26 @@
+# This is a generated file. Please do not edit it.
+---
+en:
+  txt:
+    apps:
+      admin:
+        error:
+          app_build:
+            jshint:
+              one: ! 'JSHint error in %{file}: %{errors}'
+              other: ! 'JSHint errors in %{file}: %{errors}'
+            manifest_not_json: manifest is not proper JSON. %{errors}
+            missing_manifest: Could not find manifest.json
+            manifest_keys:
+              missing:
+                one: ! 'Missing required field in manifest: %{missing_keys}'
+                other: ! 'Missing required 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 defaultLocale.
+              Only two- and three-letter ISO 639 language codes are allowed.'
+            translation:
+              invalid_locale: ! '%{file} is not a valid locale. Only two- and three-letter
+                ISO 639 language codes are allowed.'
+              not_json: ! '%{file} is not valid JSON. %{errors}'
+              not_json_object: ! '%{file} is not a JSON object.'

data/config/locales/translations/zendesk_apps_support.yml

@@ -0,0 +1,54 @@
+# This file is contains translations in Zendesk's custom format. The rake task
+# `i18n:standardize` will generate a version that is compatible with the i18n
+# gem (and thus Rails). Both versions should be checked in.
+title: "Apps Support"
+
+parts:
+  - translation:
+      key: "txt.apps.admin.error.app_build.jshint.one"
+      title: "App builder job: JSHint error message"
+      value: "JSHint error in %{file}: %{errors}"
+  - translation:
+      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.manifest_not_json"
+      title: "App builder job: manifest is invalid JSON error"
+      value: "manifest is not proper JSON. %{errors}"
+  - translation:
+      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.manifest_keys.missing.one"
+      title: "App builder job: missing manifest fields error"
+      value: "Missing required field in manifest: %{missing_keys}"
+  - translation:
+      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.missing_source"
+      title: "App builder job: missing app.js error"
+      value: "Could not find app.js"
+  - translation:
+      key: "txt.apps.admin.error.app_build.style_in_template"
+      title: "App builder job: <style> tags in template error"
+      value: "<style> tag in %{template}. Use an app.css file instead."
+  - translation:
+      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.translation.invalid_locale"
+      title: "App builder job: invalid locale file name"
+      value: "%{file} is not a valid locale. Only two- and three-letter ISO 639 language codes are allowed."
+  - translation:
+      key: "txt.apps.admin.error.app_build.translation.not_json"
+      title: "App builder job: translation file is invalid json"
+      value: "%{file} is not valid JSON. %{errors}"
+  - translation:
+      key: "txt.apps.admin.error.app_build.translation.not_json_object"
+      title: "App builder job: translation file is not a JSON object"
+      value: "%{file} is not a JSON object."

data/lib/zendesk_apps_support.rb

@@ -0,0 +1,20 @@
+module ZendeskAppsSupport
+
+  require 'zendesk_apps_support/sass_functions'
+  require 'zendesk_apps_support/engine'
+
+  autoload :AppFile,    'zendesk_apps_support/app_file'
+  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 :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'
+  end
+end

data/lib/zendesk_apps_support/app_file.rb

@@ -0,0 +1,42 @@
+module ZendeskAppsSupport
+
+  class AppFile
+
+    attr_reader :relative_path
+
+    def initialize(package, relative_path)
+      @relative_path = relative_path
+      @file = File.new(package.root.join(relative_path))
+    end
+
+    def read
+      File.read @file.path
+    end
+
+    def =~(regex)
+      @relative_path =~ regex
+    end
+
+    alias_method :to_s, :relative_path
+
+    def method_missing(sym, *args, &block)
+      if @file.respond_to?(sym)
+        @file.call(sym, *args, &block)
+      else
+        super
+      end
+    end
+
+    # Unless Ruby 1.9
+    def respond_to?(sym, include_private = false)
+      @file.respond_to?(sym, include_private) || super
+    end
+
+    # If Ruby 1.9
+    def respond_to_missing?(sym, include_private = false)
+      @file.respond_to_missing?(sym, include_private) || super
+    end
+
+  end
+
+end

data/lib/zendesk_apps_support/app_version.rb

@@ -0,0 +1,68 @@
+require 'multi_json'
+
+module ZendeskAppsSupport
+
+  # At any point in time, we support up to three versions:
+  #  * deprecated -- we will still serve apps targeting the deprecated version,
+  #                  but newly created or updated apps CANNOT target it
+  #  * current    -- we will serve apps targeting the current version;
+  #                  newly created or updated apps SHOULD target it
+  #  * future     -- we will serve apps targeting the future version;
+  #                  newly created or updates apps MAY target it, but it
+  #                  may change without notice
+  class AppVersion
+
+    DEPRECATED = '0.4'.freeze
+    CURRENT    = '0.5'.freeze
+    FUTURE     = nil
+
+    TO_BE_SERVED     = [ DEPRECATED, CURRENT, FUTURE ].compact.freeze
+    VALID_FOR_UPDATE = [ CURRENT, FUTURE ].compact.freeze
+
+    def initialize(version)
+      @version = version.to_s
+      @version.freeze
+      freeze
+    end
+
+    def servable?
+      TO_BE_SERVED.include?(@version)
+    end
+
+    def valid_for_update?
+      VALID_FOR_UPDATE.include?(@version)
+    end
+
+    def deprecated?
+      @version == DEPRECATED
+    end
+
+    def obsolete?
+      !servable?
+    end
+
+    def blank?
+      @version.nil? || @version == ''
+    end
+
+    def present?
+      !blank?
+    end
+
+    def to_s
+      @version
+    end
+
+    def to_json(*options)
+      MultiJson.encode(@version)
+    end
+
+    def ==(other)
+      @version == other.to_s
+    end
+
+  end
+
+  AppVersion.freeze
+
+end

data/lib/zendesk_apps_support/default_styles.scss

@@ -0,0 +1,21 @@
+header {
+  border-bottom: 1px dotted #CCC; margin-bottom: 12px;
+
+  h3 { line-height: 30px; }
+  hr { margin-top: 0; }
+
+  .logo {
+    background: transparent app-asset-url("logo-small.png") no-repeat;
+    background-size: 25px 25px; float: right; height: 25px; width: 25px;
+  }
+
+  .app-warning-icon {
+    cursor: pointer;
+    float: right;
+    margin-left: 2px;
+    padding: 5px;
+  }
+}
+
+h3 { font-size: 14px; }
+footer { background: none; border: 0 }

data/lib/zendesk_apps_support/engine.rb

@@ -0,0 +1,11 @@
+if Object.const_defined?(:Rails) && Rails.const_defined?(:Engine)
+
+  module ZendeskAppsSupport
+
+    class Engine < Rails::Engine
+      engine_name 'zendesk_apps_support'
+    end
+
+  end
+
+end

data/lib/zendesk_apps_support/i18n.rb

@@ -0,0 +1,28 @@
+module ZendeskAppsSupport
+  module I18n
+    class << self
+      def t(key, *args)
+        i18n.t(key, *args)
+      end
+
+      def set_locale(locale)
+        i18n.locale = locale
+      end
+
+      private
+
+      def i18n
+        @i18n ||= begin
+          require 'i18n'
+          ::I18n.load_path += locale_files
+          ::I18n
+        end
+      end
+
+      def locale_files
+        Dir[ File.expand_path('../../../config/locales/*.yml', __FILE__) ] -
+          Dir[ File.expand_path('../../../config/locales/*.zendesk.yml', __FILE__) ]
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/package.rb

@@ -0,0 +1,100 @@
+require 'pathname'
+require 'erubis'
+require 'json'
+
+module ZendeskAppsSupport
+  class Package
+
+    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
+
+    def initialize(dir)
+      @root = Pathname.new(File.expand_path(dir))
+    end
+
+    def validate
+      Validations::Manifest.call(self) +
+        Validations::Source.call(self) +
+        Validations::Templates.call(self) +
+        Validations::Translations.call(self)
+    end
+
+    def files
+      non_tmp_files
+    end
+
+    def template_files
+      files.select { |f| f =~ /^templates\/.*\.hdbs$/ }
+    end
+
+    def translation_files
+      files.select { |f| f =~ /^translations\// }
+    end
+
+    def manifest_json
+      JSON.parse(File.read(File.join(root, "manifest.json")), :symbolize_names => true)
+    end
+
+    def readified_js(app_name, app_id, asset_url_prefix, settings={})
+      manifest = manifest_json
+      source = File.read(File.join(root, "app.js"))
+      name = app_name || manifest[:name] || 'Local App'
+      location = manifest[:location]
+      app_class_name = "app-#{app_id}"
+      author = manifest[:author]
+      translations = JSON.parse(File.read(File.join(root, "translations/en.json")))
+      framework_version = manifest[:frameworkVersion]
+      templates = compiled_templates(app_id, asset_url_prefix)
+
+      settings["title"] = name
+
+      SRC_TEMPLATE.result(
+          :name => name,
+          :source => source,
+          :location => location,
+          :asset_url_prefix => asset_url_prefix,
+          :app_class_name => app_class_name,
+          :author => author,
+          :translations => translations,
+          :framework_version => framework_version,
+          :templates => templates,
+          :settings => settings,
+          :app_id => app_id
+      )
+    end
+
+    private
+
+    def compiled_templates(app_id, asset_url_prefix)
+      css_file = File.join(root, "app.css")
+      customer_css = File.exist?(css_file) ? File.read(css_file) : ""
+      compiled_css = ZendeskAppsSupport::StylesheetCompiler.new(DEFAULT_SCSS + customer_css, app_id, asset_url_prefix).compile
+
+      templates = begin
+        Dir["#{root.to_s}/templates/*.hdbs"].inject({}) do |h, file|
+          str = File.read(file)
+          str.chomp!
+          h[File.basename(file, File.extname(file))] = str
+          h
+        end
+      end
+
+      templates.tap do |templates|
+        templates['layout'] = "<style>\n#{compiled_css}</style>\n#{templates['layout']}"
+      end
+    end
+
+    def non_tmp_files
+      files = []
+      Dir[ root.join('**/**') ].each do |f|
+        next unless File.file?(f)
+        relative_file_name = f.sub(/#{root}\/?/, '')
+        next if relative_file_name =~ /^tmp\//
+        files << AppFile.new(self, relative_file_name)
+      end
+      files
+    end
+  end
+end

data/lib/zendesk_apps_support/sass_functions.rb

@@ -0,0 +1,22 @@
+require 'sass'
+
+module Sass::Script::Functions
+
+  module AppAssetUrl
+    def app_asset_url(name)
+      assert_type name, :String
+      result = %Q{url("#{app_asset_url_helper(name)}")}
+      Sass::Script::String.new(result)
+    end
+
+    private
+
+    def app_asset_url_helper(name)
+      url_builder = options[:app_asset_url_builder]
+      url_builder.app_asset_url(name.value)
+    end
+  end
+
+  include AppAssetUrl
+
+end

data/lib/zendesk_apps_support/src.js.erb

@@ -0,0 +1,24 @@
+(function() {
+    with( require('apps/framework/app_scope') ) {
+
+        var source = <%= source %>;
+
+        ZendeskApps[<%= name.to_json %>] = ZendeskApps.defineApp(source)
+                .reopenClass({ location: <%= location.to_json %> })
+                .reopen({
+                    assetUrlPrefix: <%= asset_url_prefix.to_json %>,
+                    appClassName: <%= app_class_name.to_json %>,
+                    author: {
+                        name: <%= author[:name].to_json %>,
+                        email: <%= author[:email].to_json %>
+                    },
+                    translations: <%= translations.to_json %>,
+                    templates: <%= templates.to_json %>,
+                    frameworkVersion: <%= framework_version.to_json %>
+                });
+
+    }
+
+    ZendeskApps[<%= name.to_json %>].install({"id": <%= app_id %>, "app_id": <%= app_id %>, "settings": <%= settings.to_json %>});
+
+}());