xat 1.32.0

data/features/package.feature

@@ -0,0 +1,22 @@
+Feature: package a zendesk app into a zip file
+
+  Background: create a new zendesk app
+    Given an app is created in directory "tmp/aruba"
+
+  Scenario: package a zendesk app by running 'xat package' command
+    When I run the command "xat package --path tmp/aruba" to package the app
+    And the command output should contain "adding app.js"
+    And the command output should contain "adding assets/logo-small.png"
+    And the command output should contain "adding assets/logo.png"
+    And the command output should contain "adding manifest.json"
+    And the command output should contain "adding templates/layout.hdbs"
+    And the command output should contain "adding translations/en.json"
+    And the command output should contain "created"
+    And the zip file should exist in directory "tmp/aruba/tmp"
+
+
+  Scenario: package a zendesk app by running 'xat package' command
+    When I create a symlink from "./templates/translation.erb.tt" to "tmp/aruba/assets/translation.erb.tt"
+    Then "tmp/aruba/assets/translation.erb.tt" should be a symlink
+    When I run the command "xat package --path tmp/aruba" to package the app
+    Then the zip file in "tmp/aruba/tmp" should not contain any symlinks

data/features/step_definitions/app_steps.rb

@@ -0,0 +1,103 @@
+require 'fileutils'
+require 'zip/zip'
+require 'English'
+
+When /^I move to the app directory$/ do
+  @previous_dir = Dir.pwd
+  Dir.chdir(@app_dir)
+end
+
+When /^I reset the working directory$/ do
+  Dir.chdir(@previous_dir)
+end
+
+Given /^an app directory "(.*?)" exists$/ do |app_dir|
+  @app_dir = app_dir
+  FileUtils.rm_rf(@app_dir)
+  FileUtils.mkdir_p(@app_dir)
+end
+
+Given /^an app is created in directory "(.*?)"$/ do |app_dir|
+  steps %(
+    Given an app directory "#{app_dir}" exists
+    And I run "xat new" command with the following details:
+      | author name  | John Citizen      |
+      | author email | john@example.com  |
+      | author url   | http://myapp.com  |
+      | app name     | John Test App     |
+      | app dir      | #{app_dir}        |
+    )
+end
+
+When /^I run "(.*?)" command with the following details:$/ do |cmd, table|
+  IO.popen(cmd, 'w+') do |pipe|
+    # [ ['parameter name', 'value'] ]
+    table.raw.each do |row|
+      pipe.puts row.last
+    end
+    pipe.close_write
+    @output = pipe.readlines
+    @output.each { |line| puts line }
+  end
+end
+
+When /^I create a symlink from "(.*?)" to "(.*?)"$/ do |src, dest|
+  @link_destname = File.basename(dest)
+  # create a symlink
+  FileUtils.ln_s(src, dest)
+end
+
+When /^I run the command "(.*?)" to (validate|package|clean) the app$/ do |cmd, _action|
+  IO.popen(cmd, 'w+') do |pipe|
+    pipe.puts "\n"
+    pipe.close_write
+    @output = pipe.readlines
+    @output.each { |line| puts line }
+  end
+end
+
+Then /^the app file "(.*?)" is created with:$/ do |file, content|
+  File.read(file).chomp.gsub(' ', '').should == content.gsub(' ', '')
+end
+
+Then /^the app file "(.*?)" is created$/ do |filename|
+  File.exist?(filename).should be_truthy
+end
+
+Then /^the fixture "(.*?)" is used for "(.*?)"$/ do |fixture, app_file|
+  fixture_file = File.join('features', 'fixtures', fixture)
+  app_file_path = File.join(@app_dir, app_file)
+
+  FileUtils.cp(fixture_file, app_file_path)
+end
+
+Then /^the zip file should exist in directory "(.*?)"$/ do |path|
+  Dir[path + '/app-*.zip'].size.should == 1
+end
+
+Given /^I remove file "(.*?)"$/ do |file|
+  File.delete(file)
+end
+
+Then /^the zip file in "(.*?)" folder should not exist$/ do |path|
+  expect(Dir[path + '/app-*.zip'].size).to eq 0
+end
+
+Then /^it should pass the validation$/ do
+  @output.last.should =~ /OK/
+  $CHILD_STATUS.should == 0
+end
+
+Then /^the command output should contain "(.*?)"$/ do |output|
+  @output.join.should =~ /#{output}/
+end
+
+Then /^"(.*?)" should be a symlink$/ do |path|
+  File.symlink?(path).should be_truthy
+end
+
+Then /^the zip file in "(.*?)" should not contain any symlinks$/ do |path|
+  Zip::ZipFile.foreach Dir[path + '/app-*.zip'][0] do |p|
+    p.symlink?.should be_falsy
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'aruba/cucumber'
+
+Before do
+  @aruba_timeout_seconds = 15
+end

data/features/validate.feature

@@ -0,0 +1,15 @@
+Feature: validate a zendesk app
+
+  Validate a zendesk app by running 'xat package' command
+
+  Background: create a new zendesk app
+    Given an app is created in directory "tmp/aruba"
+
+  Scenario: valid app
+    When I run the command "xat validate --path tmp/aruba" to validate the app
+    Then it should pass the validation
+
+  Scenario: invalid app (missing manifest.json
+    Given I remove file "tmp/aruba/manifest.json"
+    When I run the command "xat validate --path tmp/aruba" to validate the app
+    Then the command output should contain "Could not find manifest.json"

data/lib/xat.rb

@@ -0,0 +1,5 @@
+module ZendeskAppsTools
+  autoload :Command,      'zendesk_apps_tools/command'
+  autoload :Translate,    'zendesk_apps_tools/translate'
+  autoload :LocaleIdentifier, 'zendesk_apps_tools/locale_identifier'
+end

data/lib/zendesk_apps_tools/api_connection.rb

@@ -0,0 +1,33 @@
+module ZendeskAppsTools
+  module APIConnection
+    FULL_URL     = /https?:\/\//
+    URL_TEMPLATE = 'https://%s.zendesk.com/'
+
+    def prepare_api_auth
+      @subdomain ||= fetch_cache('subdomain') || get_value_from_stdin('Enter your Zendesk subdomain or full Zendesk URL:')
+      @username  ||= fetch_cache('username') || get_value_from_stdin('Enter your username:')
+      @password  ||= fetch_cache('password') || get_password_from_stdin('Enter your password:')
+
+      save_cache 'subdomain' => @subdomain, 'username' => @username
+    end
+
+    def get_connection(encoding = :url_encoded)
+      prepare_api_auth
+      Faraday.new full_url do |f|
+        f.request encoding
+        f.adapter :net_http
+        f.basic_auth @username, @password
+      end
+    end
+
+    private
+
+    def full_url
+      if FULL_URL =~ @subdomain
+        @subdomain
+      else
+        URL_TEMPLATE % @subdomain
+      end
+    end
+  end
+end

data/lib/zendesk_apps_tools/array_patch.rb

@@ -0,0 +1,22 @@
+class Array
+  unless instance_methods.include? :to_h
+    def to_h
+      if elem_index = index { |elem| !elem.is_a?(Array) }
+        raise TypeError.new("wrong element type #{self[elem_index].class} at #{elem_index} (expected array)")
+      end
+
+      each_with_index.inject({}) do |hash, elem|
+        pair, index = elem
+
+        if pair.size != 2
+          raise ArgumentError.new("wrong array length at #{index} (expected 2, was #{pair.size})")
+        end
+
+        hash.tap do |h|
+          key, val = pair
+          h[key] = val
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_apps_tools/bump.rb

@@ -0,0 +1,60 @@
+require 'thor'
+require 'json'
+
+require 'zendesk_apps_tools/manifest_handler'
+
+module ZendeskAppsTools
+  class Bump < Thor
+    include Thor::Actions
+    prepend ManifestHandler
+
+    SHARED_OPTIONS = {
+      ['commit', '-c'] => false,
+      ['message', '-m'] => nil,
+      ['tag', '-t'] => false
+    }
+
+    desc 'major', 'Bump major version'
+    method_options SHARED_OPTIONS
+    def major
+      semver[:major] += 1
+      semver[:minor] = 0
+      semver[:patch] = 0
+    end
+
+    desc 'minor', 'Bump minor version'
+    method_options SHARED_OPTIONS
+    def minor
+      semver[:minor] += 1
+      semver[:patch] = 0
+    end
+
+    desc 'patch', 'Bump patch version'
+    method_options SHARED_OPTIONS
+    def patch
+      semver[:patch] += 1
+    end
+
+    default_task :patch
+
+    private
+
+    def post_actions
+      return tag if options[:tag]
+      commit if options[:commit]
+    end
+
+    def commit
+      `git commit -am #{commit_message}`
+    end
+
+    def commit_message
+      options[:message] || version(v: true)
+    end
+
+    def tag
+      commit
+      `git tag #{version(v: true)}`
+    end
+  end
+end

data/lib/zendesk_apps_tools/cache.rb

@@ -0,0 +1,25 @@
+module ZendeskAppsTools
+  module Cache
+    CACHE_FILE_NAME = '.xat'
+
+    def save_cache(hash)
+      return if options[:zipfile]
+
+      @cache = File.exist?(cache_path) ? JSON.parse(File.read(@cache_path)).update(hash) : hash
+      File.open(@cache_path, 'w') { |f| f.write JSON.pretty_generate(@cache) }
+    end
+
+    def fetch_cache(key)
+      @cache ||= File.exist?(cache_path) ? JSON.parse(File.read(@cache_path)) : {}
+      @cache[key] if @cache
+    end
+
+    def clear_cache
+      File.delete cache_path if options[:clean] && File.exist?(cache_path)
+    end
+
+    def cache_path
+      @cache_path ||= File.join options[:path], CACHE_FILE_NAME
+    end
+  end
+end

data/lib/zendesk_apps_tools/command.rb

@@ -0,0 +1,183 @@
+require 'thor'
+require 'zip/zip'
+require 'pathname'
+require 'net/http'
+require 'json'
+require 'faraday'
+require 'io/console'
+require 'zendesk_apps_support'
+
+require 'zendesk_apps_tools/command_helpers'
+
+module ZendeskAppsTools
+  class Command < Thor
+    include Thor::Actions
+    include ZendeskAppsSupport
+    include ZendeskAppsTools::CommandHelpers
+
+    SHARED_OPTIONS = {
+      ['path', '-p'] => './',
+      clean: false
+    }
+
+    source_root File.expand_path(File.join(File.dirname(__FILE__), '../..'))
+
+    desc 'translate SUBCOMMAND', 'Manage translation files', hide: true
+    subcommand 'translate', Translate
+
+    desc 'bump SUBCOMMAND', 'Bump version for app', hide: true
+    subcommand 'bump', Bump
+
+    desc 'new', 'Generate a new app'
+    method_option :'iframe-only', type: :boolean,
+                                  default: false,
+                                  desc: 'Create an iFrame Only app template',
+                                  aliases: ['-i', '--v2']
+    def new
+      enter = ->(variable) { "Enter this app author's #{variable}:\n" }
+      invalid = ->(variable) { "Invalid #{variable}, try again:" }
+      @author_name  = get_value_from_stdin(enter.call('name'),
+                                           error_msg: invalid.call('name'))
+      @author_email = get_value_from_stdin(enter.call('email'),
+                                           valid_regex: /^.+@.+\..+$/,
+                                           error_msg: invalid.call('email'))
+      @author_url   = get_value_from_stdin(enter.call('url'),
+                                           valid_regex: %r{^https?://.+$},
+                                           error_msg: invalid.call('url'),
+                                           allow_empty: true)
+      @app_name     = get_value_from_stdin("Enter a name for this new app:\n",
+                                           error_msg: invalid.call('app name'))
+
+      @iframe_location = if options[:'iframe-only']
+                           iframe_uri_text = 'Enter your iFrame URI or leave it blank to use'\
+                                             " a default local template page:\n"
+                           value = get_value_from_stdin(iframe_uri_text, allow_empty: true)
+                           value == '' ? 'assets/iframe.html' : value
+                         else
+                           '_legacy'
+                         end
+
+      prompt_new_app_dir
+
+      skeleton = options[:'iframe-only'] ? 'app_template_iframe' : 'app_template'
+      is_custom_iframe = options[:'iframe-only'] && @iframe_location != 'assets/iframe.html'
+      directory_options = is_custom_iframe ? { exclude_pattern: /iframe.html/ } : {}
+      directory(skeleton, @app_dir, directory_options)
+    end
+
+    desc 'validate', 'Validate your app'
+    method_options SHARED_OPTIONS
+    def validate
+      setup_path(options[:path])
+      errors = app_package.validate(marketplace: false)
+      valid = errors.none?
+
+      if valid
+        app_package.warnings.each { |w| say w.to_s, :yellow }
+        say_status 'validate', 'OK'
+      else
+        errors.each do |e|
+          say_status 'validate', e.to_s
+        end
+      end
+
+      @destination_stack.pop if options[:path]
+      exit 1 unless valid
+      true
+    end
+
+    desc 'package', 'Package your app'
+    method_options SHARED_OPTIONS
+    def package
+      return false unless invoke(:validate, [])
+
+      setup_path(options[:path])
+      archive_path = File.join(tmp_dir, "app-#{Time.now.strftime('%Y%m%d%H%M%S')}.zip")
+
+      archive_rel_path = relative_to_original_destination_root(archive_path)
+
+      zip archive_path
+
+      say_status 'package', "created at #{archive_rel_path}"
+      true
+    end
+
+    desc 'clean', 'Remove app packages in temp folder'
+    method_option :path, default: './', required: false, aliases: '-p'
+    def clean
+      setup_path(options[:path])
+
+      return unless File.exist?(Pathname.new(File.join(app_dir, 'tmp')).to_s)
+
+      FileUtils.rm(Dir["#{tmp_dir}/app-*.zip"])
+    end
+
+    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'
+    method_option :path, default: DEFAULT_SERVER_PATH, required: false, aliases: '-p'
+    method_option :config, default: DEFAULT_CONFIG_PATH, required: false, aliases: '-c'
+    method_option :port, default: DEFAULT_SERVER_PORT, required: false
+    method_option :app_id, default: DEFAULT_APP_ID, required: false
+    def server
+      setup_path(options[:path])
+      manifest = app_package.manifest_json
+
+      settings_helper = ZendeskAppsTools::Settings.new
+
+      settings = settings_helper.get_settings_from_file options[:config], manifest['parameters']
+
+      unless settings
+        settings = settings_helper.get_settings_from_user_input self, manifest['parameters']
+      end
+
+      require 'zendesk_apps_tools/server'
+      ZendeskAppsTools::Server.tap do |server|
+        server.set :port, options[:port]
+        server.set :root, options[:path]
+        server.set :parameters, settings
+        server.set :manifest, manifest['parameters']
+        server.set :config, options[:config]
+        server.set :app_id, options[:app_id]
+        server.run!
+      end
+    end
+
+    desc 'create', 'Create app on your account'
+    method_options SHARED_OPTIONS
+    method_option :zipfile, default: nil, required: false, type: :string
+    def create
+      clear_cache
+      @command = 'Create'
+
+      unless options[:zipfile]
+        app_name = JSON.parse(File.read(File.join options[:path], 'manifest.json'))['name']
+      end
+      app_name ||= get_value_from_stdin('Enter app name:')
+      deploy_app(:post, '/api/v2/apps.json',  name: app_name)
+    end
+
+    desc 'update', 'Update app on the server'
+    method_options SHARED_OPTIONS
+    method_option :zipfile, default: nil, required: false, type: :string
+    def update
+      clear_cache
+      @command = 'Update'
+
+      app_id = fetch_cache('app_id') || find_app_id
+      unless /\d+/ =~ app_id.to_s
+        say_error_and_exit "App id not found\nPlease try running command with --clean or check your internet connection"
+      end
+      deploy_app(:put, "/api/v2/apps/#{app_id}.json", {})
+    end
+
+    protected
+
+    def setup_path(path)
+      @destination_stack << relative_to_original_destination_root(path) unless @destination_stack.last == path
+    end
+  end
+end