xat 1.32.0

data/lib/zendesk_apps_tools/command_helpers.rb

@@ -0,0 +1,20 @@
+require 'zendesk_apps_tools/cache'
+require 'zendesk_apps_tools/common'
+require 'zendesk_apps_tools/api_connection'
+require 'zendesk_apps_tools/deploy'
+require 'zendesk_apps_tools/directory'
+require 'zendesk_apps_tools/package_helper'
+require 'zendesk_apps_tools/settings'
+require 'zendesk_apps_tools/translate'
+require 'zendesk_apps_tools/bump'
+
+module ZendeskAppsTools
+  module CommandHelpers
+    include ZendeskAppsTools::Cache
+    include ZendeskAppsTools::Common
+    include ZendeskAppsTools::APIConnection
+    include ZendeskAppsTools::Deploy
+    include ZendeskAppsTools::Directory
+    include ZendeskAppsTools::PackageHelper
+  end
+end

data/lib/zendesk_apps_tools/common.rb

@@ -0,0 +1,40 @@
+require 'faraday'
+
+module ZendeskAppsTools
+  module Common
+    def api_request(url, request = Faraday.new)
+      request.get(url)
+    end
+
+    def say_error_and_exit(msg)
+      say msg, :red
+      exit 1
+    end
+
+    def get_value_from_stdin(prompt, opts = {})
+      options = {
+        valid_regex: opts[:allow_empty] ? /^.*$/ : /\S+/,
+        error_msg: 'Invalid, try again:',
+        allow_empty: false
+      }.merge(opts)
+
+      while input = ask(prompt)
+        return '' if input.empty? && options[:allow_empty]
+        if input =~ options[:valid_regex]
+          break
+        else
+          say(options[:error_msg], :red)
+        end
+      end
+
+      input
+    end
+
+    def get_password_from_stdin(prompt)
+      print "#{prompt} "
+      password = STDIN.noecho(&:gets).chomp
+      puts
+      password
+    end
+  end
+end

data/lib/zendesk_apps_tools/deploy.rb

@@ -0,0 +1,94 @@
+module ZendeskAppsTools
+  module Deploy
+    def deploy_app(connection_method, url, body)
+      body[:upload_id] = upload(options[:path]).to_s
+
+      connection = get_connection
+
+      response = connection.send(connection_method) do |req|
+        req.url url
+        req.headers[:content_type] = 'application/json'
+        req.body = JSON.generate body
+      end
+
+      check_status response
+
+    rescue Faraday::Error::ClientError, JSON::ParserError => e
+      say_error_and_exit e.message
+    end
+
+    def upload(path)
+      connection = get_connection :multipart
+      zipfile_path = options[:zipfile]
+
+      if zipfile_path
+        package_path = zipfile_path
+      else
+        package
+        package_path = Dir[File.join path, '/tmp/*.zip'].sort.last
+      end
+
+      payload = { uploaded_data: Faraday::UploadIO.new(package_path, 'application/zip') }
+
+      response = connection.post('/api/v2/apps/uploads.json', payload)
+      JSON.parse(response.body)['id']
+
+    rescue Faraday::Error::ClientError, JSON::ParserError => e
+      say_error_and_exit e.message
+    end
+
+    def find_app_id
+      say_status 'Update', 'app ID is missing, searching...'
+      name = get_value_from_stdin('Enter the name of the app:')
+
+      connection = get_connection
+
+      all_apps = connection.get('/api/v2/apps.json').body
+
+      app_id = JSON.parse(all_apps)['apps'].find { |app| app['name'] == name }['id']
+
+      save_cache 'app_id' => app_id
+      app_id
+    rescue Faraday::Error::ClientError => e
+      say_error_and_exit e.message
+    end
+
+    def check_status(response)
+      job = response.body
+      job_response = JSON.parse(job)
+      say_error_and_exit job_response['error'] if job_response['error']
+
+      job_id = job_response['job_id']
+      check_job job_id
+    end
+
+    def check_job(job_id)
+      connection = get_connection
+
+      loop do
+        response = connection.get("/api/v2/apps/job_statuses/#{job_id}")
+        info     = JSON.parse(response.body)
+        status   = info['status']
+        message  = info['message']
+        app_id   = info['app_id']
+
+        if %w(completed failed).include? status
+          case status
+          when 'completed'
+            save_cache 'app_id' => app_id
+            say_status @command, 'OK'
+          when 'failed'
+            say_status @command, message, :red
+            exit 1
+          end
+          break
+        end
+
+        say_status 'Status', status
+        sleep 3
+      end
+    rescue Faraday::Error::ClientError => e
+      say_error_and_exit e.message
+    end
+  end
+end

data/lib/zendesk_apps_tools/directory.rb

@@ -0,0 +1,28 @@
+module ZendeskAppsTools
+  module Directory
+    def app_dir
+      @app_dir ||= Pathname.new(destination_root)
+    end
+
+    def tmp_dir
+      @tmp_dir ||= Pathname.new(File.join(app_dir, 'tmp')).tap do |dir|
+        FileUtils.mkdir_p(dir)
+      end
+    end
+
+    def prompt_new_app_dir
+      prompt = "Enter a directory name to save the new app (will create the dir if it does not exist, default to current dir):\n"
+      opts = { valid_regex: /^(\w|\/|\\)*$/, allow_empty: true }
+      while @app_dir = get_value_from_stdin(prompt, opts)
+        @app_dir = './' and break if @app_dir.empty?
+        if !File.exist?(@app_dir)
+          break
+        elsif !File.directory?(@app_dir)
+          puts 'Invalid dir, try again:'
+        else
+          break
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_apps_tools/locale_identifier.rb

@@ -0,0 +1,10 @@
+module ZendeskAppsTools
+  class LocaleIdentifier
+    attr_reader :locale_id
+
+    # Convert :"en-US-x-12" to 'en-US'
+    def initialize(code)
+      @locale_id = code.start_with?('en-US') ? 'en-US' : code.sub(/-x-.*/, '').downcase
+    end
+  end
+end

data/lib/zendesk_apps_tools/manifest_handler.rb

@@ -0,0 +1,72 @@
+require 'zendesk_apps_tools/array_patch'
+
+module ZendeskAppsTools
+  module ManifestHandler
+    VERSION_PARTS = %i(major minor patch)
+
+    attr_reader :semver
+
+    VERSION_PARTS.each do |m|
+      define_method m do
+        load_manifest
+        read_version
+        normalize_version
+        super()
+        update_version
+        write_manifest
+        post_actions
+      end
+    end
+
+    private
+
+    def manifest_json_path
+      'manifest.json'
+    end
+
+    def load_manifest
+      manifest_json = File.read(manifest_json_path)
+      @manifest = JSON.load(manifest_json)
+    rescue => e
+      say(e.message, :red) and exit 1
+    end
+
+    def read_version
+      version = @manifest.fetch('version', '0.0.0')
+      sem_parts = sub_semver(version)
+      @semver = sem_parts.names.map(&:to_sym).zip(sem_parts.to_a.drop(1)).to_h
+    end
+
+    def normalize_version
+      VERSION_PARTS.each do |part|
+        semver[part] = (semver[part] || '0').to_i
+      end
+    end
+
+    def update_version
+      @manifest['version'] = version
+    end
+
+    def write_manifest
+      File.open(manifest_json_path, 'w') do |f|
+        f.write(JSON.pretty_generate(@manifest))
+        f.write("\n")
+      end
+    end
+
+    def sub_semver(v)
+      v.match(/\A(?<v>v)?(?<major>\d+)(?:\.(?<minor>\d+)(?:\.(?<patch>\d+))?)?\Z/)
+    end
+
+    def version(v: false)
+      [
+        v ? 'v' : semver[:v],
+        [
+          semver[:major],
+          semver[:minor],
+          semver[:patch]
+        ].compact.map(&:to_s).join('.')
+      ].compact.join
+    end
+  end
+end

data/lib/zendesk_apps_tools/package_helper.rb

@@ -0,0 +1,30 @@
+module ZendeskAppsTools
+  require 'zendesk_apps_support'
+
+  module PackageHelper
+    include ZendeskAppsSupport
+
+    def app_package
+      @app_package ||= Package.new(app_dir.to_s)
+    end
+
+    def zip(archive_path)
+      Zip::ZipFile.open(archive_path, 'w') do |zipfile|
+        app_package.files.each do |file|
+          relative_path = file.relative_path
+          path = relative_path
+          say_status 'package', "adding #{path}"
+
+          # resolve symlink to source path
+          if File.symlink? file.absolute_path
+            path = File.expand_path(File.readlink(file.absolute_path), File.dirname(file.absolute_path))
+          end
+          if file.to_s == 'app.scss'
+            relative_path = relative_path.sub 'app.scss', 'app.css'
+          end
+          zipfile.add(relative_path, app_dir.join(path).to_s)
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_apps_tools/server.rb

@@ -0,0 +1,65 @@
+require 'sinatra/base'
+require 'zendesk_apps_support/package'
+
+module ZendeskAppsTools
+  class Server < Sinatra::Base
+    set :protection, :except => :frame_options
+    last_mtime = Time.new(0)
+    ZENDESK_DOMAINS_REGEX = /^http(?:s)?:\/\/[a-z0-9-]+\.(?:zendesk|zopim|zd-(?:dev|master|staging))\.com$/
+
+    get '/app.js' do
+      access_control_allow_origin
+      content_type 'text/javascript'
+
+      if File.exists? settings.config
+        curr_mtime = File.stat(settings.config).mtime
+        if curr_mtime > last_mtime
+          settings_helper = ZendeskAppsTools::Settings.new
+          settings.parameters = settings_helper.get_settings_from_file(settings.config, settings.manifest)
+          last_mtime = curr_mtime
+        end
+      end
+
+      package = ZendeskAppsSupport::Package.new(settings.root, false)
+      app_name = package.manifest_json['name'] || 'Local App'
+      installation = ZendeskAppsSupport::Installation.new(
+        id: settings.app_id,
+        app_id: settings.app_id,
+        app_name: app_name,
+        enabled: true,
+        requirements: package.requirements_json,
+        settings: settings.parameters.merge({title: app_name}),
+        updated_at: Time.now.iso8601,
+        created_at: Time.now.iso8601
+      )
+
+      app_js = package.compile_js(
+        app_id: settings.app_id,
+        app_name: package.manifest_json['name'] || 'Local App',
+        assets_dir: "http://localhost:#{settings.port}/",
+        locale: params['locale']
+      )
+
+      ZendeskAppsSupport::Installed.new([app_js], [installation]).compile_js
+    end
+
+    get "/:file" do |file|
+      access_control_allow_origin
+      send_file File.join(settings.root, 'assets', file)
+    end
+
+    # This is for any preflight request
+    # It reads 'Access-Control-Request-Headers' to set 'Access-Control-Allow-Headers'
+    # And also sets 'Access-Control-Allow-Origin' header
+    options "*" do
+      access_control_allow_origin
+      headers 'Access-Control-Allow-Headers' => request.env['HTTP_ACCESS_CONTROL_REQUEST_HEADERS'] if request.env['HTTP_ORIGIN'] =~ ZENDESK_DOMAINS_REGEX
+    end
+
+    # This sets the 'Access-Control-Allow-Origin' header for requests coming from zendesk
+    def access_control_allow_origin
+      origin = request.env['HTTP_ORIGIN']
+      headers 'Access-Control-Allow-Origin' => origin if origin =~ ZENDESK_DOMAINS_REGEX
+    end
+  end
+end

data/lib/zendesk_apps_tools/settings.rb

@@ -0,0 +1,82 @@
+require 'zendesk_apps_tools/common'
+require 'yaml'
+
+module ZendeskAppsTools
+  class Settings
+    def get_settings_from_user_input(user_input, parameters)
+      return {} if parameters.nil?
+
+      parameters.inject({}) do |settings, param|
+        if param['default']
+          input = user_input.get_value_from_stdin("Enter a value for parameter '#{param['name']}' or press 'Return' to use the default value '#{param['default']}':\n", allow_empty: true)
+          input = param['default'] if input.empty?
+        elsif param['required']
+          input = user_input.get_value_from_stdin("Enter a value for required parameter '#{param['name']}':\n")
+        else
+          input = user_input.get_value_from_stdin("Enter a value for optional parameter '#{param['name']}' or press 'Return' to skip:\n", allow_empty: true)
+        end
+
+        if param['type'] == 'checkbox'
+          input = convert_to_boolean_for_checkbox(input)
+        end
+
+        settings[param['name']] = input if input != ''
+        settings
+      end
+    end
+
+    def get_settings_from_file(filepath, parameters)
+      return {} if parameters.nil?
+      return nil unless File.exist? filepath
+
+      begin
+        settings_file = File.read(filepath)
+
+        if filepath =~ /\.json$/ || settings_file =~ /\A\s*{/
+          settings_data = JSON.load(settings_file)
+        else
+          settings_data = YAML.load(settings_file)
+        end
+
+        settings_data.each do |index, setting|
+          if setting.is_a?(Hash) || setting.is_a?(Array)
+            settings_data[index] = JSON.dump(setting)
+          end
+        end
+      rescue => err
+        puts "Failed to load #{filepath}"
+        puts err.message
+        return nil
+      end
+
+      parameters.inject({}) do |settings, param|
+        input = settings_data[param['name']]
+
+        if !input && param['default']
+          input = param['default']
+        end
+
+        if !input && param['required']
+          puts "'#{param['name']}' is required but not specified in the config file.\n"
+          return nil
+        end
+
+        if param['type'] == 'checkbox'
+          input = convert_to_boolean_for_checkbox(input)
+        end
+
+        settings[param['name']] = input if input != ''
+        settings
+      end
+    end
+
+    private
+
+    def convert_to_boolean_for_checkbox(input)
+      unless [TrueClass, FalseClass].include?(input.class)
+        return (input =~ /^(true|t|yes|y|1)$/i) ? true : false
+      end
+      input
+    end
+  end
+end