zendesk_apps_support 4.29.4

data/lib/zendesk_apps_support.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ZendeskAppsSupport
+  require 'zendesk_apps_support/engine'
+
+  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 :Manifest,               'zendesk_apps_support/manifest'
+  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 :Finders,                'zendesk_apps_support/finders'
+  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 :SecureSettings,        'zendesk_apps_support/validations/secure_settings'
+    autoload :Marketplace,           'zendesk_apps_support/validations/marketplace'
+    autoload :Mime,                  'zendesk_apps_support/validations/mime'
+    autoload :Secrets,               'zendesk_apps_support/validations/secrets'
+    autoload :Source,                'zendesk_apps_support/validations/source'
+    autoload :Templates,             'zendesk_apps_support/validations/templates'
+    autoload :Translations,          'zendesk_apps_support/validations/translations'
+    autoload :Stylesheets,           'zendesk_apps_support/validations/stylesheets'
+    autoload :Requirements,          'zendesk_apps_support/validations/requirements'
+    autoload :Requests,              'zendesk_apps_support/validations/requests'
+    autoload :Banner,                'zendesk_apps_support/validations/banner'
+    autoload :Svg,                   'zendesk_apps_support/validations/svg'
+  end
+
+  class Manifest
+    autoload :LocationOptions, 'zendesk_apps_support/manifest/location_options'
+    autoload :Parameter, 'zendesk_apps_support/manifest/parameter'
+    autoload :NoOverrideHash, 'zendesk_apps_support/manifest/no_override_hash'
+  end
+end

data/lib/zendesk_apps_support/app_file.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+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 extension
+      File.extname relative_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,11 @@
+# frozen_string_literal: true
+
+module ZendeskAppsSupport
+  class AppRequirement
+    CUSTOM_OBJECTS_KEY = 'custom_objects'
+    CUSTOM_OBJECTS_TYPE_KEY = 'custom_object_types'
+    CUSTOM_OBJECTS_RELATIONSHIP_TYPE_KEY = 'custom_object_relationship_types'
+    TYPES = %w[automations channel_integrations custom_objects macros targets views ticket_fields
+               triggers user_fields organization_fields].freeze
+  end
+end

data/lib/zendesk_apps_support/app_version.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ZendeskAppsSupport
+  # At any point in time, we support up to four versions:
+  #  * deprecated -- we will still serve apps targeting the deprecated version,
+  #                  but newly created or updated apps CANNOT target it
+  #  * sunsetting -- we will soon be removing support for this version;
+  #                  updated apps SHOULD target the current version, no new apps allowed
+  #  * 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', '1.0'].freeze
+    SUNSETTING = nil
+    CURRENT    = '2.0'
+    FUTURE     = nil
+
+    TO_BE_SERVED     = [DEPRECATED, SUNSETTING, CURRENT, FUTURE].flatten.compact.freeze
+    VALID_FOR_UPDATE = [SUNSETTING, CURRENT, FUTURE].compact.freeze
+    VALID_FOR_CREATE = [CURRENT, FUTURE].compact.freeze
+
+    attr_reader :current
+
+    def initialize(version)
+      @version = version.to_s.freeze
+      @current = CURRENT
+      freeze
+    end
+
+    def servable?
+      TO_BE_SERVED.include?(@version)
+    end
+
+    def valid_for_update?
+      VALID_FOR_UPDATE.include?(@version)
+    end
+
+    def valid_for_create?
+      VALID_FOR_CREATE.include?(@version)
+    end
+
+    def deprecated?
+      DEPRECATED.include?(@version)
+    end
+
+    def sunsetting?
+      @version == SUNSETTING
+    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_app_logo.svg

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+   viewBox="0 0 18 18" style="enable-background:new 0 0 18 18;" xml:space="preserve">
+<path id="Fill-3" d="M1.5,6.1C1.3,5.9,1,6,1,6.4l0,7c0,0.3,0.2,0.7,0.5,0.9l6,3.6C7.8,18.1,8,18,8,17.6l0-7.1c0-0.3-0.2-0.7-0.5-0.9
+  L1.5,6.1z"/>
+<path id="Fill-5" d="M10.5,17.9c-0.3,0.2-0.5,0-0.5-0.3l0-7c0-0.3,0.2-0.7,0.5-0.9l6-3.6C16.8,5.9,17,6,17,6.4l0,7.1
+  c0,0.3-0.2,0.7-0.5,0.9L10.5,17.9z"/>
+<path id="Fill-1" d="M2.2,3.7c-0.3,0.2-0.3,0.4,0,0.6l6.2,3.6C8.7,8,9.2,8,9.4,7.9l6.3-3.6c0.3-0.2,0.3-0.4,0-0.6L9.5,0.1
+  C9.2,0,8.8,0,8.5,0.1L2.2,3.7z"/>
+</svg>

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,21 @@
+(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 %>
+}());
+
+<% unless rollbar_zaf_access_token.empty? %>
+ZendeskApps.rollbarAccessToken = "<%= rollbar_zaf_access_token %>";
+<% end %>
+
+ZendeskApps.trigger && ZendeskApps.trigger('ready');

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

@@ -0,0 +1,37 @@
+<% unless iframe_only %>
+with( ZendeskApps.AppScope.create() ) {
+  <% unless modules.empty? %>
+  require.modules = {
+      <% modules.each do |path, content| %>
+      <%= path.to_json %>: function(exports, require, module) {
+        <%= content %>
+      },
+      <% end %>
+    eom: undefined
+  };
+  <% end %>
+
+  var source = <%= source %>;
+}
+<% end %>
+var app = ZendeskApps.defineApp(<%= iframe_only ? 'null' : 'source' %>)
+  .reopenClass(<%= app_class_properties.to_json %>)
+  .reopen({
+    appName: <%= name.to_json %>,
+    appVersion: <%= version.to_json %>,
+    locationIcons: <%= location_icons.to_json %>,
+    assetUrlPrefix: <%= asset_url_prefix.to_json %>,
+    logoAssetHash: <%= logo_asset_hash.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,51 @@
+# frozen_string_literal: true
+
+module ZendeskAppsSupport
+  module BuildTranslation
+    I18N_TITLE_KEY = 'title'
+    I18N_VALUE_KEY = 'value'
+    I18N_KEYS      = [I18N_TITLE_KEY, I18N_VALUE_KEY].freeze
+
+    def to_flattened_namespaced_hash(hash, target_key = nil, prefix = nil)
+      hash.each_with_object({}) do |(key, value), result|
+        key = [prefix, key].compact.join('.')
+        if value.is_a?(Hash)
+          if target_key && 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
+      end
+    end
+
+    def remove_zendesk_keys(scope, translations = {})
+      scope.each_key do |key|
+        context = scope[key]
+
+        if context.is_a?(Hash)
+
+          if 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 translation_hash?(hash)
+      hash.keys.sort == I18N_KEYS
+    end
+  end
+end

data/lib/zendesk_apps_support/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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/finders.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ZendeskAppsSupport
+  module Finders
+    class RecordNotFound < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+
+    def find_by(arg)
+      all.find(&filter_by_arg(arg))
+    end
+
+    def find_by!(arg)
+      found = find_by(arg)
+      raise(RecordNotFound, "Unable to find #{name} with #{arg.inspect}") if found.nil?
+      found
+    end
+
+    def where(arg)
+      all.select(&filter_by_arg(arg))
+    end
+
+    private
+
+    def filter_by_arg(arg)
+      lambda do |findable_record|
+        arg.all? do |attribute, value|
+          value = value.to_s if value.is_a? Symbol
+          findable_record.public_send(attribute) == value
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_apps_support/i18n.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ZendeskAppsSupport
+  module I18n
+    class << self
+      def t(key, *args)
+        i18n.t(key, *args)
+      end
+
+      def set_load_path
+        i18n
+        nil
+      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,22 @@
+# frozen_string_literal: true
+
+module ZendeskAppsSupport
+  class Installation
+    attr_accessor :id, :app_id, :app_name, :requirements, :settings, :enabled, :collapsible, :updated_at, :created_at
+    attr_accessor :plan
+
+    def initialize(options)
+      options.each do |k, v|
+        public_send("#{k}=", v)
+      end
+    end
+
+    def to_json
+      hash = {}
+      instance_variables.each do |var|
+        hash[var.to_s.sub('@', '')] = instance_variable_get var
+      end
+      hash.to_json
+    end
+  end
+end

data/lib/zendesk_apps_support/installed.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'erubis'
+
+module ZendeskAppsSupport
+  class Installed
+    extend Gem::Deprecate
+    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(options = {})
+      INSTALLED_TEMPLATE.result(
+        appsjs: @appsjs,
+        installations: @installations,
+        installation_orders: options.fetch(:installation_orders, {}),
+        rollbar_zaf_access_token: options.fetch(:rollbar_zaf_access_token, '')
+      )
+    end
+
+    alias compile_js compile
+    deprecate :compile_js, :compile, 2017, 1
+  end
+end