xat 1.32.0

data/lib/zendesk_apps_tools/translate.rb

@@ -0,0 +1,168 @@
+require 'thor'
+require 'json'
+require 'zendesk_apps_tools/common'
+require 'zendesk_apps_tools/locale_identifier'
+require 'zendesk_apps_support'
+require 'yaml'
+
+module ZendeskAppsTools
+  class Translate < Thor
+    include Thor::Shell
+    include Thor::Actions
+    include ZendeskAppsTools::Common
+    include ZendeskAppsSupport::BuildTranslation
+
+    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
+    def to_yml
+      setup_path(options[:path]) if options[:path]
+      manifest = JSON.parse(File.open("#{destination_root}/manifest.json").read)
+      app_name = manifest['name']
+
+      unless app_name
+        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
+      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
+    def to_json
+      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
+
+      write_json('translations/en.json', en_json)
+    end
+
+    desc 'update', 'Update translation files from Zendesk'
+    method_option :path, default: './', required: false
+    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...')
+      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']
+
+          locale_name = ZendeskAppsTools::LocaleIdentifier.new(locale['locale']).locale_id
+          write_json("#{destination_root}/translations/#{locale_name}.json", nest_translations_hash(translations, key_prefix))
+        end
+        say('Translations updated', :green)
+
+      elsif locale_response.status == 401
+        say('Authentication failed', :red)
+      end
+    end
+
+    desc 'pseudotranslate', 'Generate a Pseudo-translation to use for testing. This will pretend to be French.'
+    method_option :path, default: './', required: false
+    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
+
+      pseudo = build_pseudotranslation(en_json, package)
+      write_json("translations/fr.json", pseudo)
+    end
+
+    def self.source_root
+      File.expand_path(File.join(File.dirname(__FILE__), '../..'))
+    end
+
+    no_commands do
+      def fetch_locale_async(locale, app_package)
+        Thread.new do
+          say("Fetching #{locale['locale']}")
+          json = Faraday.get("#{locale['url']}?include=translations&packages=app_#{app_package}").body
+          JSON.parse(json)['locale']
+        end
+      end
+
+      def setup_path(path)
+        @destination_stack << relative_to_original_destination_root(path) unless @destination_stack.last == path
+      end
+
+      def write_json(filename, translations_hash)
+        create_file(filename, JSON.pretty_generate(translations_hash) + "\n")
+      end
+
+      def nest_translations_hash(translations_hash, key_prefix)
+        result = {}
+
+        translations_hash.each do |full_key, value|
+          parts       = full_key.gsub(key_prefix, '').split('.')
+          parts_count = parts.size - 1
+          context     = result
+
+          parts.each_with_index do |part, i|
+            if parts_count == i
+              context[part] = value
+            else
+              context = context[part] ||= {}
+            end
+          end
+        end
+
+        result
+      end
+
+      def write_yml(en_json, app_name, package_name)
+        titles        = to_flattened_namespaced_hash(en_json, I18N_TITLE_KEY)
+        values        = to_flattened_namespaced_hash(en_json, I18N_VALUE_KEY)
+        @translations = titles.each { |k, v| titles[k] = { 'title' => v, 'value' => escape_special_characters(values[k]) } }
+        @app_name     = app_name
+        @package_name = package_name
+        template(File.join(Translate.source_root, 'templates/translation.erb.tt'), 'translations/en.yml')
+      end
+
+      def escape_special_characters(v)
+        v.gsub('"', '\"')
+      end
+
+      def array_to_nested_hash(array)
+        array.inject({}) do |result, item|
+          keys = item['key'].split('.')
+          current = result
+          keys[0..-2].each do |key|
+            current = (current[key] ||= {})
+          end
+          current[keys[-1]] = { 'title' => item['title'], 'value' => item['value'] }
+          result
+        end
+      end
+
+      def build_pseudotranslation(translations_hash, package_name)
+        titles       = to_flattened_namespaced_hash(translations_hash, I18N_TITLE_KEY)
+        values       = to_flattened_namespaced_hash(translations_hash, I18N_VALUE_KEY)
+        translations = titles.each { |k, v| titles[k] = { 'title' => v, 'value' => "[日本#{values[k]}éñđ]" } }
+        translations['app.package'] = package_name # don't pseudo translate the package name
+        nest_translations_hash(translations, '')
+      end
+    end
+  end
+end

data/templates/translation.erb.tt

@@ -0,0 +1,13 @@
+---
+title: "<%= @app_name %>"
+packages:
+  - default
+  - app_<%= @package_name %>
+
+parts:
+<% @translations.each do |key, title_value| -%>
+  - translation:
+      key: "txt.apps.<%= @package_name %>.<%= key %>"
+      title: "<%= title_value["title"] %>"
+      value: "<%= title_value["value"] %>"
+<% end %>

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: xat
+version: !ruby/object:Gem::Version
+  version: 1.32.0
+platform: ruby
+authors:
+- Olaf Kwant
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: zendesk_apps_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tools to help you develop Zendesk Apps.
+email:
+- okwant@zendesk.com
+executables:
+- xat
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- app_template/README.md
+- app_template/app.css
+- app_template/app.js
+- app_template/assets/banner.png
+- app_template/assets/logo-promotion.png
+- app_template/assets/logo-small.png
+- app_template/assets/logo.png
+- app_template/manifest.json.tt
+- app_template/templates/layout.hdbs
+- app_template/translations/en.json
+- app_template_iframe/README.md
+- app_template_iframe/assets/banner.png
+- app_template_iframe/assets/iframe.html
+- app_template_iframe/assets/logo-promotion.png
+- app_template_iframe/assets/logo-small.png
+- app_template_iframe/assets/logo.png
+- app_template_iframe/manifest.json.tt
+- app_template_iframe/translations/en.json
+- bin/xat
+- features/clean.feature
+- features/fixtures/quote_character_translation.json
+- features/new.feature
+- features/package.feature
+- features/step_definitions/app_steps.rb
+- features/support/env.rb
+- features/validate.feature
+- lib/xat.rb
+- lib/zendesk_apps_tools/api_connection.rb
+- lib/zendesk_apps_tools/array_patch.rb
+- lib/zendesk_apps_tools/bump.rb
+- lib/zendesk_apps_tools/cache.rb
+- lib/zendesk_apps_tools/command.rb
+- lib/zendesk_apps_tools/command_helpers.rb
+- lib/zendesk_apps_tools/common.rb
+- lib/zendesk_apps_tools/deploy.rb
+- lib/zendesk_apps_tools/directory.rb
+- lib/zendesk_apps_tools/locale_identifier.rb
+- lib/zendesk_apps_tools/manifest_handler.rb
+- lib/zendesk_apps_tools/package_helper.rb
+- lib/zendesk_apps_tools/server.rb
+- lib/zendesk_apps_tools/settings.rb
+- lib/zendesk_apps_tools/translate.rb
+- templates/translation.erb.tt
+homepage: https://github.com/ocke/xat
+licenses:
+- Apache License Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Tools to help you develop Zendesk Apps.
+test_files:
+- features/clean.feature
+- features/fixtures/quote_character_translation.json
+- features/new.feature
+- features/package.feature
+- features/step_definitions/app_steps.rb
+- features/support/env.rb
+- features/validate.feature
+has_rdoc: