zendesk_apps_tools 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f6aebc0331def0f61f777fcfee6c885ca518751
-  data.tar.gz: 8b5eb53908cb059769583cd42da31fe8758d5c62
+  metadata.gz: c9671e253af31f401823ee8fbe0ca6b9aed32b1c
+  data.tar.gz: ba2aa8edc896d0d1f3d22e5da360ea2e569dd94d
 SHA512:
-  metadata.gz: cc89513fb13b00cee92a7362f3909f5e21a4da8260cd5347224d1490a473d988485bddfa0276c5503a74e84d10ae5473a2515c2b53f9996782c460e171cb175a
-  data.tar.gz: 9fe853d0f697005c47bdbe8bf4d74ec0988dbd4da5b90216a2230509ab9126d685a7d920a013c99055cf22c18db939d9ceb941cc215a037ea1200176e4370f7b
+  metadata.gz: 869b048a92f9721b689030c45ec5f5b355cb7640a8d16c738d28664c600a6c52e039008bf26e11db2247af3879e0b5729e41173e09642f903861fcb88d58ba36
+  data.tar.gz: 988d22c6814670f837304c52365a7a07f67fd08d536ad5d2f57ce306a94fd8abb67ff708d6041085ba5afbec57223d4b936e47835cbad088a12cf68d4fb8f4e6

data/lib/zendesk_apps_tools/api_connection.rb

@@ -16,7 +16,7 @@ module ZendeskAppsTools
       require 'faraday'
       prepare_api_auth
       Faraday.new full_url do |f|
-        f.request encoding
+        f.request encoding if encoding
         f.adapter :net_http
         f.basic_auth @username, @password
       end

data/lib/zendesk_apps_tools/command.rb

@@ -10,13 +10,17 @@ module ZendeskAppsTools
     include Thor::Actions
     include ZendeskAppsTools::CommandHelpers
 
-    map %w(-v) => :version
+    map %w[-v] => :version
+    DEFAULT_SERVER_PORT = '4567'
 
     source_root File.expand_path(File.join(File.dirname(__FILE__), '../..'))
 
     desc 'translate SUBCOMMAND', 'Manage translation files', hide: true
     subcommand 'translate', Translate
 
+    desc 'theme SUBCOMMAND', 'Development tools for Theming Center (Beta)', hide: false
+    subcommand 'theme', Theme
+
     desc 'bump SUBCOMMAND', 'Bump version for app', hide: true
     subcommand 'bump', Bump
 
@@ -125,13 +129,12 @@ module ZendeskAppsTools
 
     DEFAULT_SERVER_PATH = './'
     DEFAULT_CONFIG_PATH = './settings.yml'
-    DEFAULT_SERVER_PORT = '4567'
     DEFAULT_APP_ID = 0
 
     desc 'server', 'Run a http server to serve the local app'
     shared_options(except: [:clean])
     method_option :config, default: DEFAULT_CONFIG_PATH, required: false, aliases: '-c'
-    method_option :port, default: DEFAULT_SERVER_PORT, required: false
+    method_option :port, default: DEFAULT_SERVER_PORT, required: false, desc: 'Port for the http server to use.'
     method_option :app_id, default: DEFAULT_APP_ID, required: false, type: :numeric
     method_option :bind, required: false
     def server
@@ -206,10 +209,6 @@ module ZendeskAppsTools
       manifest.location_options.collect{ |option| option.location.product_code }
     end
 
-    def setup_path(path)
-      @destination_stack << relative_to_original_destination_root(path) unless @destination_stack.last == path
-    end
-
     def settings
       settings_helper.get_settings_from_file(options[:config], manifest.original_parameters) ||
         settings_helper.get_settings_from_user_input(manifest.original_parameters)

data/lib/zendesk_apps_tools/command_helpers.rb

@@ -25,5 +25,9 @@ module ZendeskAppsTools
         Cache.new(options)
       end
     end
+
+    def setup_path(path)
+      @destination_stack << relative_to_original_destination_root(path) unless @destination_stack.last == path
+    end
   end
 end

data/lib/zendesk_apps_tools/server.rb

@@ -5,6 +5,7 @@ require 'zendesk_apps_support/package'
 
 module ZendeskAppsTools
   class Server < Sinatra::Base
+    set :server, :thin
     set :protection, except: :frame_options
     ZENDESK_DOMAINS_REGEX = %r{^http(?:s)?://[a-z0-9-]+\.(?:zendesk|zopim|zd-(?:dev|master|staging))\.com$}
 

data/lib/zendesk_apps_tools/theme.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require 'zendesk_apps_tools/theming/common'
+
+module ZendeskAppsTools
+  class Theme < Thor
+    include Thor::Actions
+    include ZendeskAppsTools::CommandHelpers
+    include ZendeskAppsTools::Theming::Common
+
+    desc 'preview', 'Preview a theme in development'
+    shared_options(except: %i[clean unattended])
+    method_option :port, default: Command::DEFAULT_SERVER_PORT, required: false, desc: 'Port for the http server to use.'
+    method_option :bind, required: false
+    method_option :role,
+                  type: :string,
+                  enum: %w[manager agent end_user anonymous],
+                  default: 'manager',
+                  desc: 'The role for the preview URL',
+                  aliases: '-r'
+    method_option :livereload, type: :boolean, default: true, desc: 'Enable or disable live-reloading the preview when a change is made.'
+    def preview
+      setup_path(options[:path])
+      ensure_manifest!
+      require 'faraday'
+      full_upload
+      callbacks_after_upload = []
+      start_listener(callbacks_after_upload)
+      start_server(callbacks_after_upload)
+    end
+
+    no_commands do
+      def full_upload
+        say_status 'Generating', 'Generating theme from local files'
+        payload = generate_payload.merge(role: options[:role])
+        say_status 'Generating', 'OK'
+        say_status 'Uploading', 'Uploading theme'
+        connection = get_connection(nil)
+        connection.use Faraday::Response::RaiseError
+        connection.put do |req|
+          req.url '/hc/api/internal/theming/local_preview'
+          req.body = JSON.dump(payload)
+          req.headers['Content-Type'] = 'application/json'
+        end
+        say_status 'Uploading', 'OK'
+        say_status 'Ready', "#{connection.url_prefix}hc/admin/local_preview/start"
+        say "You can exit preview mode in the UI or by visiting #{connection.url_prefix}hc/admin/local_preview/stop"
+      rescue Faraday::Error::ClientError => e
+        say_status 'Uploading', "Failed: #{e.message}", :red
+        begin
+          error_hash = JSON.parse(e.response[:body])
+          broken_templates = error_hash['template_errors']
+          if broken_templates
+            broken_templates.each do |template_name, errors|
+              errors.each do |error|
+                say_status 'Error', "#{template_name} L#{error['line']}:#{error['column']}: #{error['description']}", :red
+              end
+            end
+          else
+            say_status 'Error', error_hash
+          end
+        rescue JSON::ParserError
+          say_error_and_exit 'Server error 😭'
+        end
+      end
+
+      def start_listener(callbacks_after_upload)
+        # TODO: do we need to stop the listener at some point?
+        require 'listen'
+        path = Pathname.new(theme_package_path('.')).cleanpath
+        listener = ::Listen.to(path, ignore: /\.zat/) do |modified, added, removed|
+          need_upload = false
+          if modified.any? { |file| file[/templates|manifest/] }
+            need_upload = true
+          end
+          if added.any? || removed.any?
+            need_upload = true
+          end
+          if need_upload
+            full_upload
+          end
+          callbacks_after_upload.each do |callback|
+            callback.call
+          end
+        end
+        listener.start
+      end
+
+      def generate_payload
+        payload = {}
+        templates = Dir.glob(theme_package_path('templates', '*.hbs'))
+        templates_payload = {}
+        templates.each do |template|
+          templates_payload[File.basename(template, '.hbs')] = File.read(template)
+        end
+        payload['templates'] = templates_payload
+        payload['templates']['document_head'] = inject_external_tags(payload['templates']['document_head'])
+        payload['templates']['css'] = ''
+        payload['templates']['js'] = ''
+        payload['templates']['assets'] = assets
+        payload['templates']['variables'] = settings_hash
+        payload
+      end
+
+      def inject_external_tags(head_template)
+        live_reload_script_tag = <<-html
+          <script type="text/javascript">
+            RACK_LIVERELOAD_PORT = 4567;
+          </script>
+          <script src="http://localhost:4567/__rack/livereload.js?host=localhost"></script>
+        html
+
+        js_tag = <<-html
+          <script src="http://localhost:4567/guide/script.js"></script>
+        html
+
+        css_tag = <<-html
+          <link rel="stylesheet" type="text/css" href="http://localhost:4567/guide/style.css">
+        html
+
+        template = StringIO.new
+        template << css_tag
+        template << head_template
+        template << js_tag
+        template << live_reload_script_tag
+        template.string
+      end
+
+      alias_method :ensure_manifest!, :manifest
+
+      def start_server(callbacks_after_upload)
+        require 'zendesk_apps_tools/theming/server'
+        if options[:livereload]
+          require 'rack-livereload'
+          require 'faye/websocket'
+          Faye::WebSocket.load_adapter('thin')
+        end
+
+        ZendeskAppsTools::Theming::Server.tap do |server|
+          server.set :bind, options[:bind] if options[:bind]
+          server.set :port, options[:port]
+          server.set :root, app_dir
+          server.set :public_folder, app_dir
+          server.set :livereload, options[:livereload]
+          server.set :callbacks_after_load, callbacks_after_upload
+          server.set :callback_map, {}
+          server.use Rack::LiveReload, live_reload_port: 4567 if options[:livereload]
+          server.run!
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_apps_tools/theming/common.rb

@@ -0,0 +1,64 @@
+module ZendeskAppsTools
+  module Theming
+    module Common
+      def theme_package_path(*file)
+        File.expand_path(File.join(app_dir, *file))
+      end
+
+      def url_for(package_file)
+        relative_path = relative_path_for(package_file)
+        path_parts = recursive_pathname_split(relative_path)
+        path_parts.shift
+        "http://localhost:4567/guide/#{path_parts.join('/')}"
+      end
+
+      def relative_path_for(filename)
+        Pathname.new(filename).relative_path_from(Pathname.new(File.expand_path(app_dir))).cleanpath
+      end
+
+      def assets
+        assets = Dir.glob(theme_package_path('assets', '*'))
+        assets.each_with_object({}) do |asset, asset_payload|
+          asset_payload[File.basename(asset)] = url_for(asset)
+        end
+      end
+
+      def assets_hash
+        assets.each_with_object({}) do |(k,v), h|
+          parametrized = k.gsub(/[^a-z0-9\-_]+/, '-')
+          h["assets-#{parametrized}"] = v
+        end
+      end
+
+      def manifest
+        full_manifest_path = theme_package_path('manifest.json')
+        JSON.parse(File.read(full_manifest_path))
+      rescue Errno::ENOENT
+        say_error_and_exit "There's no manifest file in #{full_manifest_path}"
+      rescue JSON::ParserError
+        say_error_and_exit "The manifest file is invalid at #{full_manifest_path}"
+      end
+
+      def settings_hash
+        manifest['settings'].flat_map { |setting_group| setting_group['variables'] }.each_with_object({}) do |variable, result|
+          result[variable.fetch('identifier')] = value_for_setting(variable)
+        end
+      end
+
+      def value_for_setting(variable)
+        return variable.fetch('value') unless variable.fetch('type') == 'file'
+
+        files = Dir.glob(theme_package_path('settings', '*.*'))
+        file = files.find { |f| File.basename(f, '.*') == variable.fetch('identifier') }
+        url_for(file)
+      end
+
+      def recursive_pathname_split(relative_path)
+        split_path = relative_path.split
+        joined_directories = split_path[0]
+        return split_path if split_path[0] == joined_directories.split[0]
+        [*recursive_pathname_split(joined_directories), split_path[1]]
+      end
+    end
+  end
+end

data/lib/zendesk_apps_tools/theming/server.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+require 'zendesk_apps_tools/theming/common'
+
+module ZendeskAppsTools
+  module Theming
+    class Server < Sinatra::Base
+      include Common
+
+      get '/livereload' do
+        if settings.livereload && Faye::WebSocket.websocket?(env)
+          ws = Faye::WebSocket.new(env)
+
+          new_callback = ->() { ws.send(JSON.dump(command: 'reload', path: '')) }
+          settings.callback_map[ws] = new_callback
+          settings.callbacks_after_load.push(new_callback)
+
+          ws.onmessage = lambda do |event|
+            message = JSON.parse(event.data)
+            if message['command'] == 'hello'
+              ws.send(JSON.dump(
+                command: 'hello',
+                protocols: [
+                  'http://livereload.com/protocols/official-7',
+                  'http://livereload.com/protocols/official-8',
+                  'http://livereload.com/protocols/official-9',
+                  'http://livereload.com/protocols/2.x-origin-version-negotiation',
+                  'http://livereload.com/protocols/2.x-remote-control'
+                ],
+                serverName: 'ZAT LiveReload 2'
+              ))
+            end
+          end
+
+          ws.onclose = lambda do |event|
+            settings.callbacks_after_load.delete_if do |entry|
+              entry == settings.callback_map[ws]
+            end
+            settings.callback_map.delete ws
+            ws = nil
+          end
+
+          # Return async Rack response
+          ws.rack_response
+        else
+          [500, {}, 'Websocket Server Error']
+        end
+      end
+
+      get '/guide/style.css' do
+        content_type 'text/css'
+        style_css = theme_package_path('style.css')
+        raise Sinatra::NotFound unless File.exist?(style_css)
+        zass_source = File.read(style_css)
+        require 'zendesk_apps_tools/theming/zass_formatter'
+        response = ZassFormatter.format(zass_source, settings_hash.merge(assets_hash))
+        response
+      end
+
+      get '/guide/*' do
+        path = File.join(app_dir, *params[:splat])
+        return send_file path if File.exist?(path)
+        raise Sinatra::NotFound
+      end
+
+      def app_dir
+        settings.root
+      end
+    end
+  end
+end

data/lib/zendesk_apps_tools/theming/zass_formatter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'sass'
+require 'English'
+
+module ZendeskAppsTools
+  module Theming
+    class ZassFormatter
+      COMMAND = /(?<command>lighten|darken)/i
+      COLOR = /(?<color>#\h{6}|#\h{3})/
+      PERCENTAGE = /(?<percentage>\d{1,3})%/
+      COLOR_COMMAND_REGEXP = /#{COMMAND}\s*\(\s*#{COLOR}\s*,\s*#{PERCENTAGE}\s*\)/
+
+      def self.format(raw, variables)
+        joined_keys = "(#{variables.keys.join('|')})"
+
+        keys_regex = /(\$#{joined_keys}\b)|(#\{\$#{joined_keys}\})/
+
+        substitution_hash = variables.each_with_object({}) do |(k, v), hash|
+          hash["$#{k}"] = v.to_s
+          hash["\#{$#{k}}"] = v.to_s
+        end
+
+        body = raw.to_s.dup
+        body.gsub!(keys_regex, substitution_hash)
+
+        # Color manipulation
+        body.gsub!(COLOR_COMMAND_REGEXP) do |whole_match|
+          if $LAST_MATCH_INFO[:command] == 'lighten'
+            color_adjust($LAST_MATCH_INFO[:color], $LAST_MATCH_INFO[:percentage].to_i, :+) || whole_match
+          else
+            color_adjust($LAST_MATCH_INFO[:color], $LAST_MATCH_INFO[:percentage].to_i, :-) || whole_match
+          end
+        end
+
+        body
+      end
+
+      def self.color_adjust(rgb, percentage, op)
+        color = Sass::Script::Value::Color.from_hex(rgb)
+
+        # Copied from:
+        # https://github.com/sass/sass/blob/3.4.21/lib/sass/script/functions.rb#L2671
+        new_color = color.with(lightness: color.lightness.public_send(op, percentage))
+
+        # We set the Sass Output to compressed
+        new_color.options = { style: :compressed }
+        new_color.to_sass
+      rescue ArgumentError
+        nil
+      end
+    end
+  end
+end

data/lib/zendesk_apps_tools/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ZendeskAppsTools
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

data/lib/zendesk_apps_tools.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module ZendeskAppsTools
   autoload :Command,      'zendesk_apps_tools/command'
   autoload :Translate,    'zendesk_apps_tools/translate'
+  autoload :Theme,        'zendesk_apps_tools/theme'
   autoload :LocaleIdentifier, 'zendesk_apps_tools/locale_identifier'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_tools
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2017-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -41,6 +41,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +125,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: rack-livereload
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.7
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +294,10 @@ files:
 - lib/zendesk_apps_tools/package_helper.rb
 - lib/zendesk_apps_tools/server.rb
 - lib/zendesk_apps_tools/settings.rb
+- lib/zendesk_apps_tools/theme.rb
+- lib/zendesk_apps_tools/theming/common.rb
+- lib/zendesk_apps_tools/theming/server.rb
+- lib/zendesk_apps_tools/theming/zass_formatter.rb
 - lib/zendesk_apps_tools/translate.rb
 - lib/zendesk_apps_tools/version.rb
 - templates/translation.erb.tt
@@ -261,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Tools to help you develop Zendesk Apps.
@@ -276,3 +336,4 @@ test_files:
 - features/support/helpers.rb
 - features/support/webmock.rb
 - features/validate.feature
+has_rdoc: