zendesk_apps_tools 1.35.3 → 1.35.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 343966d2380b3c6d32c9fc42d96267f3206b7006
-  data.tar.gz: 7d71b9491415e36fc335ab2a1d2b47b33756ecda
+  metadata.gz: 4342a16a235ffb9c17d645b0b4671daf9af7ca82
+  data.tar.gz: fd5be11e0931293a51a78b53238cde0922895873
 SHA512:
-  metadata.gz: 0b59451499cb844d058bbafc5009b72c1e07a12e53ed6f9cfc3f1fe1c121dd9ddd1b10f062ede756d143b6b58f395427be46b42cc01f72a94d7e624a91da1070
-  data.tar.gz: 2da8f6270e4fb93e0f5b895dfec71152fab50939c614f716eb7c2b54b7b9c075a202805e503370c8af5dc356476349e21ff98b807cf299905332e342ee2d6fea
+  metadata.gz: 7b39f3699022df810613fdf8604e29592d5203e93ec185edf549649e3fbdcfbb70bda50e268e7c98dec94d5a9ee3c5af908b43f8aa83a5a729debfb206ad0127
+  data.tar.gz: 9c66857e215dac587315f9eb2ae699635be503219abc3ab83ff59df20fb4cd946a249e93b836ef256f0774affaee5f36fc3658b8b493d438d59cb183fc481240

data/features/new.feature

@@ -8,22 +8,23 @@ Feature: create a template for a new zendesk app
       | author email | john@example.com  |
       | author url   | http://myapp.com  |
       | app name     | John Test App     |
+      | iframe uri   | assets/iframe.html |
       | app dir      |                   |
 
    Then the app file "manifest.json" is created
    And I reset the working directory
 
-   Scenario: create a template for a new zendesk app by running 'zat new' command
-     Given an app directory "tmp/aruba" exists
-     When I run "zat 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      | tmp/aruba         |
+  Scenario: create a template for a new zendesk app by running 'zat new --v1' command
+    Given an app directory "tmp/aruba" exists
+    When I run "zat new --v1" 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      | tmp/aruba         |
 
-     Then the app file "tmp/aruba/manifest.json" is created with:
-     """
+    Then the app file "tmp/aruba/manifest.json" is created with:
+    """
  {
    "name": "John Test App",
    "author": {
@@ -37,9 +38,9 @@ Feature: create a template for a new zendesk app
    "version": "1.0",
    "frameworkVersion": "1.0"
  }
- """
-     And the app file "tmp/aruba/app.js" is created with:
-     """
+    """
+    And the app file "tmp/aruba/app.js" is created with:
+    """
  (function() {
 
    return {
@@ -52,9 +53,9 @@ Feature: create a template for a new zendesk app
    };
 
  }());
- """
-     And the app file "tmp/aruba/templates/layout.hdbs" is created with:
-     """
+    """
+    And the app file "tmp/aruba/templates/layout.hdbs" is created with:
+    """
  <header>
    <span class="logo"></span>
    <h3>{{setting "name"}}</h3>
@@ -65,9 +66,9 @@ Feature: create a template for a new zendesk app
      {{author.name}}
    </a>
  </footer>
- """
-     And the app file "tmp/aruba/translations/en.json" is created with:
-     """
+    """
+    And the app file "tmp/aruba/translations/en.json" is created with:
+    """
  {
    "app": {
      "description": "Play the famous zen tunes in your help desk.",
@@ -84,21 +85,21 @@ Feature: create a template for a new zendesk app
    "role": "Role",
    "groups": "Groups"
  }
- """
+    """
 
- Scenario: create a template for a new iframe only app by running 'zat new --v2' command
-   Given an app directory "tmp/aruba" exists
-   And I move to the app directory
-   When I run "zat new --v2" command with the following details:
-     | author name  | John Citizen      |
-     | author email | john@example.com  |
-     | author url   | http://myapp.com  |
-     | app name     | John Test App     |
-     | iframe uri   | assets/index.html |
-     | app dir      | tmp/aruba         |
+  Scenario: create a template for a new iframe only app by running 'zat new' command
+    Given an app directory "tmp/aruba" exists
+    And I move to the app directory
+    When I run "zat 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     |
+      | iframe uri   | assets/iframe.html |
+      | app dir      | tmp/aruba         |
 
-   Then the app file "tmp/aruba/manifest.json" is created with:
-   """
+    Then the app file "tmp/aruba/manifest.json" is created with:
+    """
 {
  "name": "John Test App",
  "author": {
@@ -109,10 +110,10 @@ Feature: create a template for a new zendesk app
  "defaultLocale": "en",
  "private": true,
  "location": { "zendesk":
-   { "ticket_sidebar": "assets/index.html" }
+   { "ticket_sidebar": "assets/iframe.html" }
  },
  "version": "1.0",
  "frameworkVersion": "2.0"
 }
-"""
+   """
    And I reset the working directory

data/features/package.feature

@@ -1,21 +1,33 @@
 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 'zat package' command
+    Given an app is created in directory "tmp/aruba"
     When I run the command "zat 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/iframe.html"
     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 v1 zendesk app by running 'zat package' command
+      Given a v1 app is created in directory "tmp/aruba"
+      When I run the command "zat package --path tmp/aruba" to package the app
+      And the command output should contain "adding app.js"
+      And the command output should contain "adding templates/layout.hdbs"
+      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 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 'zat package' command
+    Given an app is created in directory "tmp/aruba"
     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 "zat package --path tmp/aruba" to package the app

data/features/step_definitions/app_steps.rb

@@ -17,14 +17,16 @@ Given /^an app directory "(.*?)" exists$/ do |app_dir|
   FileUtils.mkdir_p(@app_dir)
 end
 
-Given /^an app is created in directory "(.*?)"$/ do |app_dir|
+Given /^a(n|(?: v1)) app is created in directory "(.*?)"$/ do |version, app_dir|
+  v1 = !!version[/v1/]
   steps %(
     Given an app directory "#{app_dir}" exists
-    And I run "zat new" command with the following details:
+    And I run "zat new #{'--v1' if v1}" command with the following details:
       | author name  | John Citizen      |
       | author email | john@example.com  |
       | author url   | http://myapp.com  |
       | app name     | John Test App     |
+      #{'| iframe uri   | assets/iframe.html |' unless v1}
       | app dir      | #{app_dir}        |
     )
 end

data/lib/zendesk_apps_tools/command.rb

@@ -10,11 +10,6 @@ module ZendeskAppsTools
     include Thor::Actions
     include ZendeskAppsTools::CommandHelpers
 
-    SHARED_OPTIONS = {
-      ['path', '-p'] => './',
-      clean: false
-    }.freeze
-
     map %w(-v) => :version
 
     source_root File.expand_path(File.join(File.dirname(__FILE__), '../..'))
@@ -28,9 +23,11 @@ module ZendeskAppsTools
     desc 'new', 'Generate a new app'
     method_option :'iframe-only', type: :boolean,
                                   default: false,
-                                  desc: 'Create an iFrame Only app template',
-                                  aliases: ['-i', '--v2']
+                                  hide: true,
+                                  aliases: ['--v2']
+    method_option :v1, type: :boolean, default: false, desc: 'Create a version 1 app template'
     def new
+      check_new_options
       enter = ->(variable) { "Enter this app author's #{variable}:\n" }
       invalid = ->(variable) { "Invalid #{variable}, try again:" }
       @author_name  = get_value_from_stdin(enter.call('name'),
@@ -45,24 +42,24 @@ module ZendeskAppsTools
       @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_location = if options[:v1]
+                           '_legacy'
+                         else
                            iframe_uri_text = 'Enter your iFrame URI or leave it blank to use'\
                                              " a default local template page:\n"
                            get_value_from_stdin(iframe_uri_text, allow_empty: true, default: 'assets/iframe.html')
-                         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'
+      skeleton = options[:v1] ? 'app_template' : 'app_template_iframe'
+      is_custom_iframe = !options[:v1] && @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
+    shared_options(except: [:unattended])
     def validate
       setup_path(options[:path])
       begin
@@ -91,7 +88,7 @@ module ZendeskAppsTools
     end
 
     desc 'package', 'Package your app'
-    method_options SHARED_OPTIONS
+    shared_options(except: [:unattended])
     def package
       return false unless invoke(:validate, [])
 
@@ -152,7 +149,7 @@ module ZendeskAppsTools
     end
 
     desc 'create', 'Create app on your account'
-    method_options SHARED_OPTIONS
+    shared_options
     method_option :zipfile, default: nil, required: false, type: :string
     def create
       cache.clear
@@ -166,7 +163,7 @@ module ZendeskAppsTools
     end
 
     desc 'update', 'Update app on the server'
-    method_options SHARED_OPTIONS
+    shared_options
     method_option :zipfile, default: nil, required: false, type: :string
     def update
       cache.clear
@@ -186,6 +183,17 @@ module ZendeskAppsTools
 
     protected
 
+    def check_new_options
+      if options[:'iframe-only']
+        if options[:v1]
+          say_error_and_exit "Apps can't be created with both --v1 and --v2 (or --iframe-only)."
+        else
+          warning = 'v2 is the default for new apps, the --v2 and --iframe-only options have no effect.'
+          say_status 'warning', warning, :yellow
+        end
+      end
+    end
+
     def setup_path(path)
       @destination_stack << relative_to_original_destination_root(path) unless @destination_stack.last == path
     end

data/lib/zendesk_apps_tools/command_helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'zendesk_apps_tools/common'
 require 'zendesk_apps_tools/api_connection'
 require 'zendesk_apps_tools/deploy'
@@ -14,6 +15,10 @@ module ZendeskAppsTools
     include ZendeskAppsTools::Directory
     include ZendeskAppsTools::PackageHelper
 
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
     def cache
       @cache ||= begin
         require 'zendesk_apps_tools/cache'

data/lib/zendesk_apps_tools/common.rb

@@ -1,5 +1,33 @@
+# frozen_string_literal: true
 module ZendeskAppsTools
   module Common
+    module ClassMethods
+      def shared_options(except: [])
+        unless except.include? :path
+          method_option :path,
+                        type: :string,
+                        default: './',
+                        aliases: ['-p']
+        end
+        unless except.include? :clean
+          method_option :clean,
+                        type: :boolean,
+                        default: false
+        end
+        unless except.include? :unattended
+          method_option :unattended,
+                        type: :boolean,
+                        default: false,
+                        desc: 'Experimental: Never prompt for input, expecting all input from the original invocation. Many '\
+                              'commands invoked with this option will just crash.'
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
     def say_error_and_exit(msg)
       say_error msg
       exit 1
@@ -10,6 +38,7 @@ module ZendeskAppsTools
     end
 
     def get_value_from_stdin(prompt, opts = {})
+      error_if_unattended(prompt)
       options = {
         valid_regex: opts[:allow_empty] ? /^.*$/ : /\S+/,
         error_msg: 'Invalid, try again:',
@@ -20,20 +49,26 @@ module ZendeskAppsTools
 
       while input = ask(prompt, thor_options)
         return '' if options[:allow_empty] && input.empty?
-        if input.to_s =~ options[:valid_regex]
-          break
-        else
-          say_error options[:error_msg]
-        end
+        break if input.to_s =~ options[:valid_regex]
+        say_error options[:error_msg]
       end
 
       input
     end
 
     def get_password_from_stdin(prompt)
+      error_if_unattended(prompt)
       password = ask(prompt, echo: false)
       say ''
       password
     end
+
+    private
+
+    def error_if_unattended(prompt)
+      return unless options[:unattended]
+      say_error 'Would have prompted for a value interactively, but we are running unattended.'
+      say_error_and_exit prompt
+    end
   end
 end

data/lib/zendesk_apps_tools/translate.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'thor'
 require 'json'
 require 'zendesk_apps_tools/common'
@@ -12,7 +13,7 @@ module ZendeskAppsTools
     LOCALE_ENDPOINT = 'https://support.zendesk.com/api/v2/locales/agent.json'
 
     desc 'to_yml', 'Create Zendesk translation file from en.json'
-    method_option :path, default: './', required: false
+    shared_options(except: [:clean])
     def to_yml
       setup_path(options[:path]) if options[:path]
       manifest = JSON.parse(File.open("#{destination_root}/manifest.json").read)
@@ -22,72 +23,56 @@ module ZendeskAppsTools
         app_name = get_value_from_stdin('What is the name of this app?', error_msg: 'Invalid name, try again:')
       end
 
-      en_json = JSON.parse(File.open("#{destination_root}/translations/en.json").read)
-
-      package = en_json['app']['package']
-      say('No package defined inside en.json! Abort.', :red) and exit 1 unless package
+      package = package_name_from_json(error_out: true)
       en_json['app'].delete('package')
 
       write_yml(en_json, app_name, package)
     end
 
     desc 'to_json', 'Convert Zendesk translation yml to I18n formatted json'
-    method_option :path, default: './', required: false
+    shared_options(except: [:clean])
     def to_json
       require 'yaml'
       setup_path(options[:path]) if options[:path]
       en_yml = YAML.load_file("#{destination_root}/translations/en.yml")
       package = /^txt.apps.([^\.]+)/.match(en_yml['parts'][0]['translation']['key'])[1]
       translations = en_yml['parts'].map { |part| part['translation'] }
-      en_json = array_to_nested_hash(translations)['txt']['apps'][package]
-      en_json['app']['package'] = package
+      en_hash = array_to_nested_hash(translations)['txt']['apps'][package]
+      en_hash['app']['package'] = package
 
-      write_json('translations/en.json', en_json)
+      write_json('translations/en.json', en_hash)
     end
 
     desc 'update', 'Update translation files from Zendesk'
-    method_option :path, default: './', required: false
-    def update()
+    shared_options(except: [:clean])
+    method_option :package_name, type: :string
+    def update
       setup_path(options[:path]) if options[:path]
-      app_package = get_value_from_stdin('What is the package name for this app? (without app_)', valid_regex: /^[a-z_]+$/, error_msg: 'Invalid package name, try again:')
-
-      key_prefix = "txt.apps.#{app_package}."
-
-      say('Fetching translations...')
-      require 'net/http'
-      require 'faraday'
-      locale_response = Faraday.get(LOCALE_ENDPOINT)
-
-      if locale_response.status == 200
-        locales = JSON.parse(locale_response.body)['locales']
-
-        locales = locales.map { |locale| fetch_locale_async locale, app_package}.map(&:value)
-
-        locales.each do |locale|
-          translations    = locale['translations']
+      app_package = package_name_for_update
+      locale_list
+        .map { |locale| fetch_locale_async locale, app_package }
+        .each do |locale_thread|
+          locale = locale_thread.value
+          translations = locale['translations']
 
           locale_name = ZendeskAppsTools::LocaleIdentifier.new(locale['locale']).locale_id
-          write_json("#{destination_root}/translations/#{locale_name}.json", nest_translations_hash(translations, key_prefix))
+          write_json(
+            "#{destination_root}/translations/#{locale_name}.json",
+            nest_translations_hash(translations, "txt.apps.#{app_package}.")
+          )
         end
-        say('Translations updated', :green)
-
-      elsif locale_response.status == 401
-        say('Authentication failed', :red)
-      end
+      say('Translations updated', :green)
     end
 
     desc 'pseudotranslate', 'Generate a Pseudo-translation to use for testing. This will pretend to be French.'
-    method_option :path, default: './', required: false
+    shared_options(except: [:clean])
     def pseudotranslate
       setup_path(options[:path]) if options[:path]
 
-      en_json = JSON.parse(File.open("#{destination_root}/translations/en.json").read)
-
-      package = en_json['app']['package']
-      say('No package defined inside en.json! Abort.', :red) and exit 1 unless package
+      package = package_name_from_json(error_out: true)
 
       pseudo = build_pseudotranslation(en_json, package)
-      write_json("translations/fr.json", pseudo)
+      write_json('translations/fr.json', pseudo)
     end
 
     def self.source_root
@@ -108,7 +93,7 @@ module ZendeskAppsTools
       end
 
       def write_json(filename, translations_hash)
-        create_file(filename, JSON.pretty_generate(translations_hash) + "\n")
+        create_file(filename, JSON.pretty_generate(translations_hash) + "\n", force: options[:unattended])
       end
 
       def nest_translations_hash(translations_hash, key_prefix)
@@ -134,7 +119,9 @@ module ZendeskAppsTools
       def write_yml(en_json, app_name, package_name)
         titles        = to_flattened_namespaced_hash(en_json, :title)
         values        = to_flattened_namespaced_hash(en_json, :value)
-        @translations = titles.each { |k, v| titles[k] = { 'title' => v, 'value' => escape_special_characters(values[k]) } }
+        @translations = titles.each do |k, v|
+          titles[k] = { 'title' => v, 'value' => escape_special_characters(values[k]) }
+        end
         @app_name     = app_name
         @package_name = package_name
         template(File.join(Translate.source_root, 'templates/translation.erb.tt'), 'translations/en.yml')
@@ -158,7 +145,7 @@ module ZendeskAppsTools
       end
 
       def array_to_nested_hash(array)
-        array.inject({}) do |result, item|
+        array.each_with_object({}) do |item, result|
           keys = item['key'].split('.')
           current = result
           keys[0..-2].each do |key|
@@ -176,6 +163,41 @@ module ZendeskAppsTools
         translations['app.package'] = package_name # don't pseudo translate the package name
         nest_translations_hash(translations, '')
       end
+
+      def locale_list
+        say('Fetching translations...')
+        require 'net/http'
+        require 'faraday'
+        locale_response = Faraday.get(LOCALE_ENDPOINT)
+
+        return JSON.parse(locale_response.body)['locales'] if locale_response.status == 200
+        if locale_response.status == 401
+          say_error_and_exit 'Authentication failed'
+        else
+          say_error_and_exit "Failed to download locales, got HTTP status #{locale_response.status}"
+        end
+      end
+
+      def package_name_for_update
+        options[:package_name] ||
+          package_name_from_json(error_out: options[:unattended]) ||
+          get_value_from_stdin('What is the package name for this app? (without leading app_)',
+                               valid_regex: /^[a-z_]+$/,
+                               error_msg: 'Invalid package name, try again:')
+      end
+
+      def en_json
+        @en_json ||= begin
+          path = "#{destination_root}/translations/en.json"
+          JSON.parse(File.open(path).read) if File.exist? path
+        end
+      end
+
+      def package_name_from_json(error_out: false)
+        package = en_json && en_json['app']['package']
+        return package if package
+        say_error_and_exit 'No package defined inside en.json!' if error_out
+      end
     end
   end
 end

data/lib/zendesk_apps_tools/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAppsTools
-  VERSION = "1.35.3"
+  VERSION = "1.35.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_tools
 version: !ruby/object:Gem::Version
-  version: 1.35.3
+  version: 1.35.4
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor