zci 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fb7673acae1967d9772186d2997a792219bf996
+  data.tar.gz: 7ff6daca96e2fd78ebebc4da556bac1fdc01dc42
+SHA512:
+  metadata.gz: a277fb3302cde662f210b296a7e49e5df1d007130b02cb5c5e445e1f4cd8e0bdb3747bfac08220603060bf99c4e01eaf005533cd5deba5bcc279cb52ae30a08e
+  data.tar.gz: 2c1cb1046cb17af46a71b23caf6c90c5277aefab0f3608d0d4a7eba1399f13e5f3fb97324631977ca17439fa73a6e4dd45c4328ce5abfc5351017148db8635e1

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/zci.yml
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-gemset

@@ -0,0 +1 @@
+zendesk_api

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+
+# gem 'zendesk_help_center_api', path: '../zendesk_help_center_api_client_rb'

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Anton Maminov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,122 @@
+# ZCI
+
+Zendesk and Crowdin integration Command Line Interface (CLI)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'zci'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it manually as:
+
+```
+$ gem install zci
+```
+
+## Use
+
+The simplest way to get started is to create a scaffold project:
+
+```
+> zci init todo
+```
+
+A new ./todo directory is created containing the sample config `zci.yml`. View the basic output of the scaffold with:
+
+```
+> cd todo
+> zci help
+```
+
+Which will output:
+
+```
+NAME
+    zci - is a command line tool that allows you to manage and synchronize your Zendesk localization with Crowdin project
+
+SYNOPSIS
+    zci [global options] command [command options] [arguments...]
+
+VERSION
+    0.0.1
+
+GLOBAL OPTIONS
+    -c, --config=<s> - Project-specific configuration file (default: /home/user/todo/zci.yml)
+    --version        - Display the program version
+    -v, --verbose    - Be verbose
+    --help           - Show this message
+
+COMMANDS
+    help                  - Shows a list of commands or help for one command
+    init:project          - Create a new ZCI-based project
+    import:sources        - Read categories/section/articles from Zendesk and upload resource files to Crowdin
+    download:translations - Build and download last exported translation resources from Crowdin
+    export:translations   - Add or update localized resource files(sections and articles) in Zendesk
+```
+
+## Configuration
+
+The scaffold project that was created in ./todo comes with a `zci.yml` shell.
+
+```
+---
+# Crowdin API credentials
+crowdin_project_id: '<%your-crowdin-project-id%>'
+crowdin_api_key: '<%your-crowdin-api-key%>'
+crowdin_base_url: 'https://api.crowdin.com'
+
+# Zendesk API credentials
+zendesk_base_url: 'https://<%subdomain%>.zendesk.com'
+zendesk_username: '<%your-zendesk-username%>'
+zendesk_password: '<%your-zendesk-password%>'
+
+# Zendesk catogories
+categories:
+- zendesk_category: '<%zendesk-category-id%>'
+  translations:
+    -
+      crowdin_language_code: '<%crowdin-two-letters-code%>'
+      zendesk_locale: '<%zendesk-locale%>'
+    -
+      crowdin_language_code: '<%crowdin-two-letters-code%>'
+      zendesk_locale: '<%zendesk-locale%>'
+- zendesk_category: '<%zendesk-category-id%>'
+  translations:
+    -
+      crowdin_language_code: '<%crowdin-two-letters-code%>'
+      zendesk_locale: '<%zendesk-locale%>'
+    -
+      crowdin_language_code: '<%crowdin-two-letters-code%>'
+      zendesk_locale: '<%zendesk-locale%>'
+```
+
+## Supported Rubies
+
+Tested with the following Ruby versions:
+
+- MRI 2.2.0
+- JRuby 9.0.0.0.pre2
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License and Author
+
+Author: Anton Maminov (anton.maminov@gmail.com)
+
+Copyright: 2015 [crowdin.com](http://crowdin.com/)
+
+This project is licensed under the MIT license, a copy of which can be found in the LICENSE file.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('zci.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test,:features]

data/bin/zci

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'zci'
+
+include GLI::App
+include ZCI
+
+program_desc 'is a command line tool that allows you to manage and synchronize your Zendesk localization with Crowdin project'
+
+sort_help :manually # help commands are ordered in the order declared
+
+version ZCI::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+desc 'Be verbose'
+switch [:v, :verbose], negatable: false
+
+desc 'Project-specific configuration file'
+default_value File.join(Dir.pwd, 'zci.yml')
+arg_name '<s>'
+flag [:c, :config]
+
+commands_from 'zci/commands'
+
+pre do |global, command, options, args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+
+  unless File.exists?(global[:config])
+    exit_now! <<-EOS.strip_heredoc
+      Can't find configuration file (default `zci.yml').
+      Type `zci help` to know how to specify custom configuration file
+    EOS
+  end
+
+  # load project-specific configuration
+  begin
+    @cli_config = YAML.load(File.read(global[:config])) || {}
+  rescue Psych::SyntaxError => err
+    exit_now! <<-EOS
+      Could not parse YAML: #{err.message}
+    EOS
+  end
+
+  @zendesk = ZendeskAPI::Client.new do |config|
+    config.url       = @cli_config['zendesk_base_url']
+    config.username  = @cli_config['zendesk_username']
+    config.password  = @cli_config['zendesk_password']
+
+    if global[:verbose]
+      require 'logger'
+      config.logger = Logger.new(STDOUT)
+    end
+  end
+
+  if global[:verbose]
+    Crowdin::API.log = Logger.new(STDOUT) if globals[:verbose]
+  end
+
+  @crowdin = Crowdin::API.new(api_key: @cli_config['crowdin_api_key'], project_id: @cli_config['crowdin_project_id'], base_url: @cli_config['crowdin_base_url'])
+
+  true
+end
+
+post do |global, command, options, args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/features/fci.feature

@@ -0,0 +1,8 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "zci"
+    Then the exit status should be 0

data/features/step_definitions/fci_steps.rb

@@ -0,0 +1,6 @@
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} help`)
+end
+
+# Add more step definitions here

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/zci.rb

@@ -0,0 +1,18 @@
+require 'zci/version.rb'
+
+require 'zendesk_api'
+require 'zendesk_api/help_center'
+
+require 'crowdin-api'
+require 'nokogiri'
+require 'zip'
+
+# require 'byebug'
+
+# Add requires for other files you add to your project here, so
+# you just need to require this one file in your bin file
+require 'zci/helpers.rb'
+require 'zci/init.rb'
+require 'zci/import.rb'
+require 'zci/download.rb'
+require 'zci/export.rb'

data/lib/zci/commands/01_init.rb

@@ -0,0 +1,28 @@
+desc 'Create a new ZCI-based project'
+arg 'project_name'
+arg_name 'project_name'
+skips_pre
+command :'init:project' do |c|
+  c.desc 'Root dir of project'
+  c.long_desc <<-EOS.strip_heredoc
+    This is the directory where the project's directory will be made, so if you
+    specify a project name `foo` and the root dir of `.`, the directory
+    `./foo` will be created
+  EOS
+  c.flag :r, :root, :default_value => '.'
+
+  c.switch :force, :desc => 'Overwrite/ignore existing files and directories'
+
+  c.action do |global_options, options, args|
+    if args.length < 1
+      raise 'You must specify the name of your project'
+    end
+
+    root_dir = options[:root]
+    force = options[:force]
+    project_name = args.first
+
+    create_scaffold(root_dir, project_name, force)
+  end
+end
+

data/lib/zci/commands/02_import.rb

@@ -0,0 +1,123 @@
+desc 'Read categories/section/articles from Zendesk and upload resource files to Crowdin'
+command :'import:sources' do |c|
+  c.desc 'Directory of resource files'
+  c.long_desc <<-EOS.strip_heredoc
+    This is the directory where the project's files will be store.
+  EOS
+  c.default_value 'resources'
+  c.arg_name 'dir'
+  c.flag [:resources_dir]
+
+  c.action do |global_options, options, args|
+    resources_dir = File.join(File.dirname(global_options[:config]), options[:resources_dir])
+
+    unless File.exists?(resources_dir)
+      FileUtils.mkdir(resources_dir)
+    end
+
+    @cli_config['categories'].each do |category|
+      # Source Category
+      source_category_id = category['zendesk_category'].to_i
+
+      # Check if Category exists in Zendesk
+      source_category = @zendesk.hc_categories.find(id: source_category_id)
+      raise('No such category') unless source_category.id == source_category_id
+
+      # Get category's sections in Zendesk
+      puts "[Zendesk] Get sections for Category with id #{source_category_id}"
+      sections = source_category.sections
+
+      sections_builder = []
+      sections.each do |section|
+        section_xml = build_section_xml(section)
+
+        unless section_xml.nil?
+          sections_builder << build_section_hash(section).merge({ xml: section_xml })
+        end
+      end
+
+      # Get articles for each section
+      articles_builder = []
+      sections.each do |section|
+        puts "[Zendesk] Get articles for Section with id #{section.id}"
+        articles = section.articles
+
+        articles.each do |article|
+          article_xml = build_article_xml(article)
+
+          unless article_xml.nil?
+            articles_builder << build_article_hash(article).merge({ xml: article_xml })
+          end
+        end
+      end
+
+      crowdin_project_info = @crowdin.project_info
+      remote_project_tree = get_remote_files_hierarchy(crowdin_project_info['files'])
+
+      resources_category_dir = File.join(resources_dir, source_category_id.to_s)
+      unless File.exists?(resources_category_dir)
+        FileUtils.mkdir(resources_category_dir)
+      end
+
+      # Create directory for Category on Crowdin if it does not exist yet
+      unless remote_project_tree[:dirs].include?("/#{source_category_id}")
+        puts "[Crowdin] Create directory `#{source_category_id}`"
+        @crowdin.add_directory(source_category_id.to_s)
+        @crowdin.change_directory(source_category_id.to_s, title: source_category.attributes[:name])
+      end
+
+      # Creates xml files for sections and upload to Crowdin
+      sections_builder.each do |section|
+        file_name = "section_#{section[:id]}.xml"
+
+        o = File.new(File.join(resources_category_dir, file_name), 'w')
+        o.write section[:xml].to_xml
+        o.close
+
+        files = [
+          {
+            source:         File.join(resources_category_dir, file_name),
+            dest:           File.join(source_category_id.to_s, file_name),
+            export_pattert: '/%two_letters_code%/%original_path%/%original_file_name%',
+            title:          section[:name]
+          }
+        ]
+
+        if remote_project_tree[:files].include?("/#{source_category_id}/#{file_name}")
+          puts "[Crowdin] Update file `#{file_name}`"
+          @crowdin.update_file(files, type: 'webxml')
+        else
+          puts "[Crowdin] Add file `#{file_name}`"
+          @crowdin.add_file(files, type: 'webxml')
+        end
+      end
+
+      # Creates xml files for articles and upload to Crowdin
+      articles_builder.each do |article|
+        file_name = "article_#{article[:id]}.xml"
+
+        o = File.new(File.join(resources_category_dir, file_name), 'w')
+        o.write article[:xml].to_xml
+        o.close
+
+        files = [
+          {
+            source:         File.join(resources_category_dir, file_name),
+            dest:           File.join(source_category_id.to_s, file_name),
+            export_pattert: '/%two_letters_code%/%original_path%/%original_file_name%',
+            title:          article[:title]
+          }
+        ]
+
+        if remote_project_tree[:files].include?("/#{source_category_id}/#{file_name}")
+          puts "[Crowdin] Update file `#{file_name}`"
+          @crowdin.update_file(files, type: 'webxml')
+        else
+          puts "[Crowdin] Add file `#{file_name}`"
+          @crowdin.add_file(files, type: 'webxml')
+
+        end
+      end
+    end # @cli_config['categories'].each
+  end
+end

data/lib/zci/commands/03_download.rb

@@ -0,0 +1,31 @@
+desc 'Build and download last exported translation resources from Crowdin'
+command :'download:translations' do |c|
+  c.desc 'Directory of resource files'
+  c.long_desc <<-EOS.strip_heredoc
+    This is the directory where the project's files will be store.
+  EOS
+  c.default_value 'resources'
+  c.arg_name 'dir'
+  c.flag [:resources_dir]
+
+  c.action do |global_options, options, args|
+    resources_dir = File.join(File.dirname(global_options[:config]), options[:resources_dir])
+
+    language = 'all'
+    tempfile = Tempfile.new(language)
+    zipfile_name = tempfile.path
+
+    begin
+      export_translations!(@crowdin)
+
+      puts 'Downloading translations'
+      @crowdin.download_translation(language, output: zipfile_name)
+
+      unzip_file_with_translations(zipfile_name, resources_dir)
+    ensure
+      tempfile.close
+      tempfile.unlink # delete the tempfile
+    end
+
+  end
+end

data/lib/zci/commands/04_export.rb

@@ -0,0 +1,76 @@
+desc 'Add or update localized resource files(sections and articles) in Zendesk'
+command :'export:translations' do |c|
+  c.desc 'Directory of resource files'
+  c.long_desc <<-EOS.strip_heredoc
+    This is the directory where the project's files will be store.
+  EOS
+  c.default_value 'resources'
+  c.arg_name 'dir'
+  c.flag [:resources_dir]
+
+  c.action do |global_options, options, args|
+    resources_dir = File.join(File.dirname(global_options[:config]), options[:resources_dir])
+
+    @cli_config['categories'].each do |category|
+      @zendesk.locales.select { |locale| !locale.default? }.each do |locale|
+        if lang = category['translations'].detect { |tr| tr['zendesk_locale'] == locale.locale }
+          section_xml_files = Dir["#{resources_dir}/#{lang['crowdin_language_code']}/#{category['zendesk_category']}/section_*.xml"]
+          article_xml_files = Dir["#{resources_dir}/#{lang['crowdin_language_code']}/#{category['zendesk_category']}/article_*.xml"]
+
+          all_sections = []
+          all_articles = []
+
+          # Read sections from XML files
+          section_xml_files.each do |file|
+            section_xml_file = File.read(file)
+            section = parse_section_xml(section_xml_file)
+            all_sections << section
+          end
+
+          # Read articles from XML filse
+          article_xml_files.each do |file|
+            article_xml_file = File.read(file)
+            article = parse_article_xml(article_xml_file)
+            all_articles << article
+          end
+
+          ### Sections
+          #
+          sections = @zendesk.sections
+          all_sections.each do |section_hash|
+            if section = sections.find(id: section_hash[:id])
+              if section_tr = section.translations.detect { |tr| tr.locale == locale.locale }
+                puts "[Zendesk] Update `#{lang['crowdin_language_code']}` language translation for Section\##{section.id}."
+                section_tr = section_tr.update(name: section_hash[:name], description: section_hash[:description])
+                section_tr.save
+              else
+                puts "[Zendesk] Create `#{lang['crowdin_language_code']}` language translation for Section\##{section.id}."
+                section_tr = section.translations.build(locale: locale.locale, name: section_hash[:name], description: section_hash[:description])
+                section_tr.save
+              end
+            end
+          end
+
+          ### Articles
+          #
+          all_articles.each do |article_hash|
+            if section = sections.find(id: article_hash[:section_id])
+              if article = section.articles.find(id: article_hash[:id])
+                if article_tr = article.translations.detect { |tr| tr.locale == locale.locale }
+                  puts "[Zendesk] Update `#{lang['crowdin_language_code']}` language translation for Article\##{article.id}."
+                  article_tr = article_tr.update(title: article_hash[:title], body: article_hash[:body])
+                  article_tr.save
+                else
+                  puts "[Zendesk] Create `#{lang['crowdin_language_code']}` language translation for Article\##{article.id}."
+                  article_tr = article.translations.build(locale: locale.locale, title: article_hash[:title], body: article_hash[:body])
+                  article_tr.save
+                end
+              end
+            end
+          end
+
+        end
+      end # @zendesk.locales
+    end # @cli_config['categories'].each
+  end
+end

data/lib/zci/download.rb

@@ -0,0 +1,31 @@
+module ZCI
+  def unzip_file_with_translations(zipfile_name, dest_path)
+    # overwrite files if they already exist inside of the extracted path
+    Zip.on_exists_proc = true
+
+    Zip::File.open(zipfile_name) do |zip_file|
+      zip_file.select { |zip_entry| zip_entry.file? }.each do |f|
+        # `f' - relative path in archive
+        fpath = File.join(dest_path, f.name)
+        FileUtils.mkdir_p(File.dirname(fpath))
+        puts "Extracting: `#{dest_path}/#{f.name}'"
+        zip_file.extract(f, fpath)
+      end
+    end
+  end
+
+  # use export API method before to download the most recent translations
+  def export_translations!(crowdin)
+    print 'Building ZIP archive with the latest translations '
+    export_translations = crowdin.export_translations
+    if export_translations['success']
+      if export_translations['success']['status'] == 'built'
+        puts "- OK"
+      elsif export_translations['success']['status'] == 'skipped'
+        puts "- Skipped"
+        puts "Warning: Export was skipped. Please note that this method can be invoked only once per 30 minutes."
+      end
+    end
+  end
+
+end

data/lib/zci/export.rb

@@ -0,0 +1,32 @@
+module ZCI
+  def parse_section_xml(xml_file)
+    doc = Nokogiri::XML.parse(xml_file)
+    section_xml = doc.xpath("//section").first
+
+    section = {
+      id: section_xml[:id],
+      category_id: section_xml[:category_id],
+      name: section_xml.xpath('name').text,
+      description: section_xml.xpath('description').text,
+      position: section_xml[:position],
+    }
+
+    return section
+  end
+
+  def parse_article_xml(xml_file)
+    doc = Nokogiri::XML.parse(xml_file)
+    article_xml = doc.xpath('//article').first
+
+    article = {
+      id: article_xml[:id],
+      section_id: article_xml[:section_id],
+      title: article_xml.xpath('title').text,
+      body: article_xml.xpath('body').text,
+      position: article_xml[:position],
+    }
+
+    return article
+  end
+
+end

data/lib/zci/helpers.rb

@@ -0,0 +1,24 @@
+class String
+  def strip_heredoc
+    indent = scan(/^[ \t]*(?=\S)/).min.size || 0
+    gsub(/^[ \t]{#{indent}}/, '')
+  end
+end
+
+# Return +hierarchy+ of directories and files in Crowdin project
+#
+# +files+ - basically, it's project files details from API method `project_info`
+#
+def get_remote_files_hierarchy(files, root = '/', hierarchy = { dirs: [], files: [] })
+  files.each do |node|
+    case node['node_type']
+      when 'directory'
+        hierarchy[:dirs] << "#{root}#{node['name']}"
+        get_remote_files_hierarchy(node['files'], root + node['name'] + '/', hierarchy)
+      when 'file'
+        hierarchy[:files] << "#{root}#{node['name']}"
+    end
+  end
+
+  return hierarchy
+end

data/lib/zci/import.rb

@@ -0,0 +1,60 @@
+module ZCI
+  def build_section_xml(section)
+    section_xml = Nokogiri::XML::Builder.new do |xml|
+      xml.root {
+        # id - id of the original section
+        # category_id - id of the original category
+        xml.section(id: section.id, category_id: section.category_id, position: section.position, identifier: 'section', type: 'document') {
+          xml.name {
+            xml.cdata section.name
+          }
+          xml.description {
+            xml.cdata section.description
+          }
+        }
+      }
+    end
+
+    return section_xml
+  end
+
+  def build_section_hash(section)
+    return {
+      id:          section.id,
+      category_id: section.category_id,
+      position:    section.position,
+      name:        section.name,
+      description: section.description,
+    }
+  end
+
+  def build_article_xml(article)
+    article_xml = Nokogiri::XML::Builder.new do |xml|
+      xml.root {
+        # id - id of the original acticle
+        # section_id - id of the original section
+        xml.article(id: article.id, section_id: article.section_id, position: article.position, identifier: 'article', type: 'document') {
+          xml.title {
+            xml.cdata article.title
+          }
+          xml.body {
+            xml.cdata article.body
+          }
+        }
+      }
+    end
+
+    return article_xml
+  end
+
+  def build_article_hash(article)
+    return {
+      id:         article.id,
+      section_id: article.section_id,
+      position:   article.position,
+      title:      article.title,
+      body:       article.body,
+    }
+  end
+
+end

data/lib/zci/init.rb

@@ -0,0 +1,71 @@
+require 'fileutils'
+
+module ZCI
+  def create_scaffold(root_dir, project_name, force)
+    dir = File.join(root_dir, project_name)
+
+    if mkdir(dir, force)
+      mk_config(root_dir, project_name)
+    end
+  end
+
+  def mkdir(dir, force)
+    exists = false
+    if !force
+      if File.exist? dir
+        raise "#{dir} exists; use --force to override"
+        exists = true
+      end
+    end
+
+    if !exists
+      puts "Creating dir #{dir}..."
+      FileUtils.mkdir_p dir
+    else
+      puts "Exiting..."
+      false
+    end
+
+    true
+  end
+
+  def mk_config(root_dir, project_name)
+    config = <<-EOS.strip_heredoc
+    ---
+    # Crowdin API credentials
+    crowdin_project_id: '<%your-crowdin-project-id%>'
+    crowdin_api_key: '<%your-crowdin-api-key%>'
+    crowdin_base_url: 'https://api.crowdin.com'
+
+    # Zendesk API credentials
+    zendesk_base_url: 'https://<%subdomain%>.zendesk.com'
+    zendesk_username: '<%your-zendesk-username%>'
+    zendesk_password: '<%your-zendesk-password%>'
+
+    # Zendesk catogories
+    categories:
+    - zendesk_category: '<%zendesk-category-id%>'
+      translations:
+        -
+          crowdin_language_code: '<%crowdin-two-letters-code%>'
+          zendesk_locale: '<%zendesk-locale%>'
+        -
+          crowdin_language_code: '<%crowdin-two-letters-code%>'
+          zendesk_locale: '<%zendesk-locale%>'
+    - zendesk_category: '<%zendesk-category-id%>'
+      translations:
+        -
+          crowdin_language_code: '<%crowdin-two-letters-code%>'
+          zendesk_locale: '<%zendesk-locale%>'
+        -
+          crowdin_language_code: '<%crowdin-two-letters-code%>'
+          zendesk_locale: '<%zendesk-locale%>'
+    EOS
+
+    File.open("#{root_dir}/#{project_name}/zci.yml", 'w') do |file|
+      file << config
+    end
+
+    puts "Created #{root_dir}/#{project_name}/zci.yml"
+  end
+end

data/lib/zci/version.rb

@@ -0,0 +1,3 @@
+module ZCI
+  VERSION = '0.0.1'
+end

data/test/default_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class DefaultTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_the_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+# Add test libraries you want to use here, e.g. mocha
+
+class Test::Unit::TestCase
+
+  # Add global extensions to the test case class here
+end

data/zci.gemspec

@@ -0,0 +1,28 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','zci','version.rb'])
+spec = Gem::Specification.new do |s|
+  s.name = 'zci'
+  s.version = ZCI::VERSION
+  s.author = 'Anton Maminov'
+  s.email = 'anton.maminov@gmail.com'
+  s.homepage = 'https://github.com/mamantoha/zci'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Zendesk and Crowdin integration Command Line Interface (CLI)'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths << 'lib'
+  # s.has_rdoc = true
+  # s.extra_rdoc_files = ['README.rdoc','zci.rdoc']
+  # s.rdoc_options << '--title' << 'zci' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'zci'
+  s.add_runtime_dependency('nokogiri')
+  s.add_runtime_dependency('rubyzip')
+  s.add_runtime_dependency('crowdin-api')
+  s.add_runtime_dependency('zendesk_api')
+  s.add_runtime_dependency('zendesk_help_center_api')
+  s.add_runtime_dependency('gli','2.13.0')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('aruba')
+  s.add_development_dependency('byebug')
+end

data/zci.yml.example

@@ -0,0 +1,29 @@
+---
+# Crowdin API credentials
+crowdin_project_id: '<%your-crowdin-project-id%>'
+crowdin_api_key: '<%your-crowdin-api-key%>'
+crowdin_base_url: 'https://api.crowdin.com'
+
+# Zendesk API credentials
+zendesk_base_url: 'https://<%subdomain%>.zendesk.com'
+zendesk_username: '<%your-zendesk-username%>'
+zendesk_password: '<%your-zendesk-password%>'
+
+# Zendesk catogories
+categories:
+- zendesk_category: '<%zendesk-category-id%>'
+  translations:
+    -
+      crowdin_language_code: '<%crowdin-two-letters-code%>'
+      zendesk_locale: '<%zendesk-locale%>'
+    -
+      crowdin_language_code: '<%crowdin-two-letters-code%>'
+      zendesk_locale: '<%zendesk-locale%>'
+- zendesk_category: '<%zendesk-category-id%>'
+  translations:
+    -
+      crowdin_language_code: '<%crowdin-two-letters-code%>'
+      zendesk_locale: '<%zendesk-locale%>'
+    -
+      crowdin_language_code: '<%crowdin-two-letters-code%>'
+      zendesk_locale: '<%zendesk-locale%>'

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: zci
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anton Maminov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: rubyzip
+  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: crowdin-api
+  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: zendesk_api
+  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: zendesk_help_center_api
+  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: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rdoc
+  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: byebug
+  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: 
+email: anton.maminov@gmail.com
+executables:
+- zci
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/zci
+- features/fci.feature
+- features/step_definitions/fci_steps.rb
+- features/support/env.rb
+- lib/zci.rb
+- lib/zci/commands/01_init.rb
+- lib/zci/commands/02_import.rb
+- lib/zci/commands/03_download.rb
+- lib/zci/commands/04_export.rb
+- lib/zci/download.rb
+- lib/zci/export.rb
+- lib/zci/helpers.rb
+- lib/zci/import.rb
+- lib/zci/init.rb
+- lib/zci/version.rb
+- test/default_test.rb
+- test/test_helper.rb
+- zci.gemspec
+- zci.yml.example
+homepage: https://github.com/mamantoha/zci
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Zendesk and Crowdin integration Command Line Interface (CLI)
+test_files: []