xat_support 1.29.3

data/lib/xat_support.rb

@@ -0,0 +1,30 @@
+module ZendeskAppsSupport
+  require 'zendesk_apps_support/sass_functions'
+  require 'zendesk_apps_support/engine'
+  require 'execjs'
+
+  autoload :AppFile,                'zendesk_apps_support/app_file'
+  autoload :BuildTranslation,       'zendesk_apps_support/build_translation'
+  autoload :I18n,                   'zendesk_apps_support/i18n'
+  autoload :Location,               'zendesk_apps_support/location'
+  autoload :Product,                'zendesk_apps_support/product'
+  autoload :Package,                'zendesk_apps_support/package'
+  autoload :Installed,              'zendesk_apps_support/installed'
+  autoload :Installation,           'zendesk_apps_support/installation'
+  autoload :AppRequirement,         'zendesk_apps_support/app_requirement'
+  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 :Marketplace,           'zendesk_apps_support/validations/marketplace'
+    autoload :Source,                'zendesk_apps_support/validations/source'
+    autoload :Templates,             'zendesk_apps_support/validations/templates'
+    autoload :Translations,          'zendesk_apps_support/validations/translations'
+    autoload :ESLintValidationError, 'zendesk_apps_support/validations/validation_error'
+    autoload :Stylesheets,           'zendesk_apps_support/validations/stylesheets'
+    autoload :Requirements,          'zendesk_apps_support/validations/requirements'
+    autoload :Banner,                'zendesk_apps_support/validations/banner'
+  end
+end

data/lib/zendesk_apps_support/app_file.rb

@@ -0,0 +1,38 @@
+module ZendeskAppsSupport
+  class AppFile
+    attr_reader :relative_path
+    attr_reader :absolute_path
+
+    def initialize(package, relative_path)
+      @relative_path = relative_path
+      @file = File.new(package.path_to(relative_path))
+      @absolute_path = File.absolute_path @file.path
+    end
+
+    def read
+      File.read @file.path
+    end
+
+    def =~(regex)
+      relative_path =~ regex
+    end
+
+    def match(regex)
+      self =~ 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
+
+    def respond_to_missing?(sym, include_private = false)
+      @file.send(:respond_to_missing?, sym, include_private) || super
+    end
+  end
+end

data/lib/zendesk_apps_support/app_requirement.rb

@@ -0,0 +1,5 @@
+module ZendeskAppsSupport
+  class AppRequirement
+    TYPES = %w(automations channel_integrations macros targets views ticket_fields triggers user_fields).freeze
+  end
+end

data/lib/zendesk_apps_support/app_version.rb

@@ -0,0 +1,64 @@
+require '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.5'.freeze
+    CURRENT    = '1.0'.freeze
+    FUTURE     = '2.0'.freeze
+
+    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(*)
+      @version.inspect
+    end
+
+    def ==(other)
+      @version == other.to_s
+    end
+  end
+
+  AppVersion.freeze
+end

data/lib/zendesk_apps_support/assets/default_styles.scss

@@ -0,0 +1,3 @@
+header .logo {
+  background-image: app-asset-url("logo-small.png");
+}

data/lib/zendesk_apps_support/assets/default_template.html.erb

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

data/lib/zendesk_apps_support/assets/installed.js.erb

@@ -0,0 +1,17 @@
+(function() {
+  <% appsjs.each do |appjs| %>
+    <%= appjs %>
+  <% end %>
+
+  <% installations.each do |installation| %>
+    if (ZendeskApps[<%= installation.app_name.to_json %>]) {
+      ZendeskApps[<%= installation.app_name.to_json %>].install(<%= installation.to_json %>);
+    }
+  <% end %>
+
+  <% installation_orders.each do |loc_name, installation_list| %>
+    ZendeskApps.sortAppsForSite(<%= loc_name.to_json %>, <%= installation_list.to_json %>);
+  <% end %>
+}());
+
+ZendeskApps.trigger && ZendeskApps.trigger('ready');

data/lib/zendesk_apps_support/assets/src.js.erb

@@ -0,0 +1,39 @@
+<% unless iframe_only %>
+with( ZendeskApps.AppScope.create() ) {
+  require.modules = {
+    <% modules.each do |path, content| %>
+      <%= path.to_json %>: function(exports, require, module) {
+        <%= content %>
+      },
+    <% end %>
+    <% if is_es2015 %>
+      '_root.js': function(exports, require, module) {
+        <%= source %>
+      }
+    <% else %>
+    eom: undefined
+    <% end %>
+  };
+
+  var source = <%= source %>;
+}
+<% end %>
+var app = ZendeskApps.defineApp(<%= iframe_only ? 'null' : 'source' %>)
+  .reopenClass(<%= app_settings.to_json %>)
+  .reopen({
+    appName: <%= name.to_json %>,
+    appVersion: <%= version.to_json %>,
+    assetUrlPrefix: <%= asset_url_prefix.to_json %>,
+    appClassName: <%= app_class_name.to_json %>,
+    author: {
+      name: <%= author['name'].to_json %>,
+      email: <%= author['email'].to_json %>
+    },
+    <% unless iframe_only %>
+    translations: <%= translations.to_json %>,
+    templates: <%= templates.to_json %>,
+    <% end %>
+    frameworkVersion: <%= framework_version.to_json %>
+  });
+
+ZendeskApps[<%= name.to_json %>] = app;

data/lib/zendesk_apps_support/build_translation.rb

@@ -0,0 +1,50 @@
+module ZendeskAppsSupport
+  module BuildTranslation
+    I18N_TITLE_KEY = 'title'
+    I18N_VALUE_KEY = 'value'
+    I18N_KEYS      = [I18N_TITLE_KEY, I18N_VALUE_KEY]
+
+    def to_flattened_namespaced_hash(hash, target_key = nil, prefix = nil)
+      hash.inject({}) do |result, (key, value)|
+        key = [prefix, key].compact.join('.')
+        if value.is_a?(Hash)
+          if target_key && is_translation_hash?(value)
+            result[key] = value[target_key]
+          else
+            result.update(to_flattened_namespaced_hash(value, target_key, key))
+          end
+        else
+          result[key] = value
+        end
+        result
+      end
+    end
+
+    def remove_zendesk_keys(scope, translations = {})
+      scope.each_key do |key|
+        context = scope[key]
+
+        if context.is_a?(Hash)
+
+          if is_translation_hash?(context)
+            translations[key] = context[I18N_VALUE_KEY]
+          else
+            translations[key] ||= {}
+            translations[key] = remove_zendesk_keys(context, translations[key])
+          end
+
+        else
+          translations[key] = context
+        end
+      end
+
+      translations
+    end
+
+    private
+
+    def is_translation_hash?(hash)
+      hash.keys.sort == I18N_KEYS
+    end
+  end
+end

data/lib/zendesk_apps_support/engine.rb

@@ -0,0 +1,9 @@
+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/installation.rb

@@ -0,0 +1,20 @@
+module ZendeskAppsSupport
+  class Installation
+
+    attr_accessor :id, :app_id, :app_name, :requirements, :settings, :enabled, :updated_at, :created_at
+
+    def initialize(options)
+      options.each do |k, v|
+        public_send("#{k}=", v)
+      end
+    end
+
+    def to_json
+      hash = {}
+      self.instance_variables.each do |var|
+        hash[var.to_s.sub('@', '')] = self.instance_variable_get var
+      end
+      hash.to_json
+    end
+  end
+end

data/lib/zendesk_apps_support/installed.rb

@@ -0,0 +1,22 @@
+require 'erubis'
+
+module ZendeskAppsSupport
+  class Installed
+    INSTALLED_TEMPLATE = Erubis::Eruby.new(File.read(File.expand_path('../assets/installed.js.erb', __FILE__)))
+
+    def initialize(appsjs, installations = [])
+      @appsjs = appsjs
+      @installations = installations
+    end
+
+    def compile_js(options = {})
+      installation_order = options.fetch(:installation_orders, {})
+
+      INSTALLED_TEMPLATE.result(
+        appsjs: @appsjs,
+        installations: @installations,
+        installation_orders: installation_order
+      )
+    end
+  end
+end

data/lib/zendesk_apps_support/location.rb

@@ -0,0 +1,29 @@
+module ZendeskAppsSupport
+  module Location
+    # the numbers below match the enum values on the database, do not change them!
+    LOCATIONS_AVAILABLE = {
+      'zendesk' => {
+        'top_bar' => { 'id' => 1, 'orderable' => true },
+        'nav_bar' => { 'id' => 2, 'orderable' => true },
+        'ticket_sidebar' => { 'id' => 3, 'orderable' => true },
+        'new_ticket_sidebar' => { 'id' => 4, 'orderable' => true },
+        'user_sidebar' => { 'id' => 5, 'orderable' => true },
+        'organization_sidebar' => { 'id' => 6, 'orderable' => true },
+        'background' => { 'id' => 7, 'orderable' => false }
+      },
+      'zopim' => {
+        'chat_sidebar' => { 'id' => 8, 'orderable' => false }
+      }
+    }.freeze
+
+    class << self
+      def hosts
+        LOCATIONS_AVAILABLE.keys
+      end
+
+      def names_for(host)
+        LOCATIONS_AVAILABLE[host.to_s].keys
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/package.rb

@@ -0,0 +1,339 @@
+require 'pathname'
+require 'erubis'
+require 'json'
+require 'babel/transpiler'
+
+module ZendeskAppsSupport
+  class Package
+    include ZendeskAppsSupport::BuildTranslation
+
+    REQUIREMENTS_FILENAME = "requirements.json"
+
+    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__)))
+
+    LEGACY_URI_STUB = '_legacy'
+
+    attr_reader :lib_root, :root, :warnings
+
+    def initialize(dir, is_cached = true)
+      @root     = Pathname.new(File.expand_path(dir))
+      @lib_root = Pathname.new(File.join(root, 'lib'))
+
+      @is_cached = is_cached # disabled by ZAT for development
+      @warnings = []
+    end
+
+    def validate(marketplace: true)
+      [].tap do |errors|
+        errors << Validations::Marketplace.call(self) if marketplace
+
+        errors << Validations::Manifest.call(self)
+
+        if has_manifest?
+          errors << Validations::Source.call(self)
+          errors << Validations::Translations.call(self)
+
+          unless manifest_json['requirementsOnly']
+            errors << Validations::Templates.call(self)
+            errors << Validations::Stylesheets.call(self)
+          end
+
+          if has_requirements?
+            errors << Validations::Requirements.call(self)
+          end
+        end
+
+        if has_banner?
+          errors << Validations::Banner.call(self)
+        end
+
+        errors.flatten!.compact!
+      end
+    end
+
+    def validate!(marketplace: true)
+      errors = validate(marketplace: marketplace)
+      if errors.any?
+        raise errors.first
+      end
+      true
+    end
+
+    def assets
+      @assets ||= Dir.chdir(root) do
+        Dir['assets/**/*'].select { |f| File.file?(f) }
+      end
+    end
+
+    def path_to(file)
+      File.join(root, file)
+    end
+
+    def requirements_path
+      path_to(REQUIREMENTS_FILENAME)
+    end
+
+    def locales
+      translations.keys
+    end
+
+    def 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
+
+    def js_files
+      @js_files ||= files.select { |f| f.to_s == 'app.js' || ( f.to_s.start_with?('lib/') && f.to_s.end_with?('.js') ) }
+    end
+
+    def lib_files
+      @lib_files ||= js_files.select { |f| f =~ /^lib\// }
+    end
+
+    def template_files
+      files.select { |f| f =~ /^templates\/.*\.hdbs$/ }
+    end
+
+    def translation_files
+      files.select { |f| f =~ /^translations\// }
+    end
+
+    def compile_js(options)
+      begin
+        app_id = options.fetch(:app_id)
+        asset_url_prefix = options.fetch(:assets_dir)
+        name = options.fetch(:app_name)
+      rescue KeyError => e
+        raise ArgumentError, e.message
+      end
+
+      locale = options.fetch(:locale, 'en')
+
+      source = iframe_only? ? nil : app_js
+      version = manifest_json['version']
+      app_class_name = "app-#{app_id}"
+      author = manifest_json['author']
+      framework_version = manifest_json['frameworkVersion']
+      single_install = manifest_json['singleInstall'] || false
+      templates = is_no_template ? {} : compiled_templates(app_id, asset_url_prefix)
+
+      app_settings = {
+        location: locations,
+        noTemplate: no_template_locations,
+        singleInstall: single_install
+      }.select { |_k, v| !v.nil? }
+
+      SRC_TEMPLATE.result(
+        name: name,
+        version: version,
+        is_es2015: !!manifest_json['es2015'],
+        source: source,
+        app_settings: app_settings,
+        asset_url_prefix: asset_url_prefix,
+        app_class_name: app_class_name,
+        author: author,
+        translations: translations_for(locale),
+        framework_version: framework_version,
+        templates: templates,
+        modules: commonjs_modules,
+        iframe_only: iframe_only?
+      )
+    end
+
+    def manifest_json
+      @manifest ||= read_json('manifest.json')
+    end
+
+    def requirements_json
+      return nil unless has_requirements?
+      @requirements ||= read_json('requirements.json')
+    end
+
+    def is_no_template
+      if manifest_json['noTemplate'].is_a?(Array)
+        false
+      else
+        !!manifest_json['noTemplate']
+      end
+    end
+
+    def no_template_locations
+      if manifest_json['noTemplate'].is_a?(Array)
+        manifest_json['noTemplate']
+      else
+        !!manifest_json['noTemplate']
+      end
+    end
+
+    def compiled_templates(app_id, asset_url_prefix)
+      compiled_css = ZendeskAppsSupport::StylesheetCompiler.new(DEFAULT_SCSS + app_css, app_id, asset_url_prefix).compile
+
+      layout = templates['layout'] || DEFAULT_LAYOUT.result
+
+      templates.tap do |templates|
+        templates['layout'] = "<style>\n#{compiled_css}</style>\n#{layout}"
+      end
+    end
+
+    def market_translations!(locale)
+      result = translations[locale].fetch('app', {})
+      result.delete('name')
+      result.delete('description')
+      result.delete('long_description')
+      result.delete('installation_instructions')
+      result
+    end
+
+    def has_location?
+      manifest_json['location']
+    end
+
+    def has_file?(path)
+      File.exist?(path_to(path))
+    end
+
+    def app_css
+      css_file = path_to('app.css')
+      scss_file = path_to('app.scss')
+      File.exist?(scss_file) ? File.read(scss_file) : ( File.exist?(css_file) ? File.read(css_file) : '' )
+    end
+
+    def locations
+      locations = manifest_json['location']
+      case locations
+      when Hash
+        locations
+      when Array
+        { 'zendesk' => Hash[locations.map { |location| [ location, LEGACY_URI_STUB ] }] }
+      when String
+        { 'zendesk' => { locations => LEGACY_URI_STUB } }
+      else # NilClass
+        { 'zendesk' => {} }
+      end
+    end
+
+    def iframe_only?
+      !legacy_non_iframe_app?
+    end
+
+    private
+
+    def legacy_non_iframe_app?
+      iframe_urls = locations.values.flat_map(&:values)
+      iframe_urls.all? { |l| l == LEGACY_URI_STUB }
+    end
+
+    def templates
+      templates_dir = File.join(root, 'templates')
+      Dir["#{templates_dir}/*.hdbs"].inject({}) do |memo, file|
+        str = File.read(file)
+        str.chomp!
+        memo[File.basename(file, File.extname(file))] = str
+        memo
+      end
+    end
+
+    def translations_for(locale)
+      trans = translations
+      return trans[locale] if trans[locale]
+      trans[self.manifest_json['defaultLocale']]
+    end
+
+    def translations
+      return @translations if @is_cached && @translations
+
+      @translations = begin
+        translation_dir = File.join(root, 'translations')
+        return {} unless File.directory?(translation_dir)
+
+        locale_path = "#{translation_dir}/#{self.manifest_json['defaultLocale']}.json"
+        default_translations = process_translations(locale_path)
+
+        Dir["#{translation_dir}/*.json"].inject({}) do |memo, path|
+          locale = File.basename(path, File.extname(path))
+
+          locale_translations = if locale == self.manifest_json['defaultLocale']
+            default_translations
+          else
+            deep_merge_hash(default_translations, process_translations(path))
+          end
+
+          memo[locale] = locale_translations
+          memo
+        end
+      end
+    end
+
+    def process_translations(locale_path)
+      translations = File.exist?(locale_path) ? JSON.parse(File.read(locale_path)) : {}
+      translations['app'].delete('package') if translations.has_key?('app')
+      remove_zendesk_keys(translations)
+    end
+
+    def has_lib_js?
+      lib_files.any?
+    end
+
+    def has_manifest?
+      has_file?('manifest.json')
+    end
+
+    def has_requirements?
+      has_file?('requirements.json')
+    end
+
+    def has_banner?
+      has_file?('assets/banner.png')
+    end
+
+    def app_js
+      transpile(read_file('app.js'))
+    end
+
+    def transpile(code)
+      manifest_json['es2015'] ? Babel::Transpiler.transform(code)['code'] : code
+    end
+
+    def commonjs_modules
+      return {} unless has_lib_js?
+
+      lib_files.each_with_object({}) do |file, modules|
+        raise Validations::ValidationError.new('reserved_filename') if file.relative_path == 'lib/_root.js'
+        name          = file.relative_path.gsub(/^lib\//, '')
+        content       = file.read
+        modules[name] = transpile(content)
+      end
+    end
+
+    def deep_merge_hash(h, another_h)
+      result_h = h.dup
+      another_h.each do |key, value|
+        if h.has_key?(key) && h[key].is_a?(Hash) && value.is_a?(Hash)
+          result_h[key] = deep_merge_hash(h[key], value)
+        else
+          result_h[key] = value
+        end
+      end
+      result_h
+    end
+
+    def read_file(path)
+      File.read(path_to(path))
+    end
+
+    def read_json(path)
+      file = read_file(path)
+      unless file.nil?
+        JSON.parse(file)
+      end
+    end
+  end
+end