fci 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3a1f7a7cdd1414f54ea6bcb540c2773d5d6d709
+  data.tar.gz: 4f9966373cceb847965fa8e14fee574327882b48
+SHA512:
+  metadata.gz: 35fdca0463444bdcb87d78e7226fef51544d585e5c3f90d9b3474e091a7c92b9db5a7e4020fd179a9862dbd7a87260f66be4ccefce0fc807b1f4e812d99dd317
+  data.tar.gz: 30abeaba691a5d96ed8a25bbf5c6baf895716add0c4d1da12f671b8ba748bab7135644a65213529673ef5fb76a8a754ebd7b0ecac35d79625280a55ec2dd407c

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/fci.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 @@
+freshdesk_api

data/.ruby-version

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

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,111 @@
+# FCI
+
+Freshdesk and Crowdin integration Command Line Interface (CLI)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'fci'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it manually as:
+
+```
+$ gem install fci
+```
+
+## Use
+
+The simplest way to get started is to create a scaffold project:
+
+```
+> fci init todo
+```
+
+A new ./todo directory is created containing the sample config `fci.yml`. View the basic output of the scaffold with:
+
+```
+> cd todo
+> fci help
+```
+
+Which will output:
+
+```
+NAME
+    fci - is a command line tool that allows you to manage and synchronize your Freshdesk localization with Crowdin project
+
+SYNOPSIS
+    fci [global options] command [command options] [arguments...]
+
+VERSION
+    0.0.1
+
+GLOBAL OPTIONS
+    -c, --config=<s> - Project-specific configuration file (default: /home/user/project/fci.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 FCI-based project
+    import:sources        - Read folders/articles from Freshdesk 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(folders and articles) in Freshdesk
+```
+
+## Configuration
+
+The scaffold project that was created in ./todo comes with a `fci.yml` shell.
+
+```
+---
+crowdin_project_id: '<%your-crowdin-project-id%>'
+crowdin_api_key: '<%your-crowdin-api-key%>'
+crowdin_base_url: 'https://api.crowdin.com'
+
+freshdesk_base_url: 'https://<%subdomain%>.freshdesk.com'
+freshdesk_username: '<%your-freshdek-username%>'
+freshdesk_password: '<%your-freshdesk-password%>'
+
+freshdesk_category: '<%category-id%>'
+
+translations:
+  -
+    crowdin_language_code: '<%crowdin-two-letters-code%>'
+    freshdesk_category_id: '<%freshdesk-category-id%>'
+  -
+    crowdin_language_code: '<%crowdin-two-letters-code%>'
+    freshdesk_category_id: '<%freshdesk-category-id%>'
+
+```
+
+## Supported Rubies
+
+Tested with the following Ruby versions:
+
+- MRI 2.2.0
+
+## 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('fci.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/fci

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+require 'gli'
+begin # XXX: Remove this begin/rescue before distributing your app
+require 'fci'
+rescue LoadError
+  STDERR.puts "In development, you need to use `bundle exec bin/fci` to run your app"
+  STDERR.puts "At install-time, RubyGems will make sure lib, etc. are in the load path"
+  STDERR.puts "Feel free to remove this message from bin/fci now"
+  exit 64
+end
+
+include GLI::App
+include FCI
+
+program_desc 'is a command line tool that allows you to manage and synchronize your Freshdesk localization with Crowdin project'
+
+sort_help :manually # help commands are ordered in the order declared
+
+version FCI::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, 'fci.yml')
+arg_name '<s>'
+flag [:c, :config]
+
+commands_from 'fci/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 `fci.yml').
+      Type `fci help` to know how to specify custom configuration file
+    EOS
+  end
+
+  # load project-specific configuration
+  begin
+    @fci_config = YAML.load(File.read(global[:config])) || {}
+  rescue Psych::SyntaxError => err
+    exit_now! <<-EOS
+      Could not parse YAML: #{err.message}
+    EOS
+  end
+
+  @freshdesk = FreshdeskAPI::Client.new do |c|
+    c.base_url = @fci_config['freshdesk_base_url']
+    c.username = @fci_config['freshdesk_username']
+    c.password = @fci_config['freshdesk_password']
+  end
+
+  @crowdin = Crowdin::API.new(api_key: @fci_config['crowdin_api_key'], project_id: @fci_config['crowdin_project_id'], base_url: @fci_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/fci.gemspec

@@ -0,0 +1,27 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','fci','version.rb'])
+spec = Gem::Specification.new do |s|
+  s.name = 'fci'
+  s.version = FCI::VERSION
+  s.author = 'Anton Maminov'
+  s.email = 'anton.maminov@gmail.com'
+  s.homepage = 'https://github.com/mamantoha/fci'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Freshdesk 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','fci.rdoc']
+  # s.rdoc_options << '--title' << 'fci' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'fci'
+  s.add_runtime_dependency('nokogiri')
+  s.add_runtime_dependency('rubyzip')
+  s.add_runtime_dependency('byebug')
+  s.add_runtime_dependency('crowdin-api')
+  s.add_runtime_dependency('freshdesk_api')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('aruba')
+  s.add_runtime_dependency('gli','2.13.0')
+end

data/fci.yml.example

@@ -0,0 +1,20 @@
+---
+# Crowdin API credentials
+crowdin_project_id: '<%your-crowdin-project-id%>'
+crowdin_api_key: '<%your-crowdin-api-key%>'
+crowdin_base_url: 'https://api.crowdin.com'
+
+# Freshdesk API credentials
+freshdesk_base_url: 'https://<%subdomain%>.freshdesk.com'
+freshdesk_username: '<%your-freshdek-username%>'
+freshdesk_password: '<%your-freshdesk-password%>'
+
+freshdesk_category: '<%freshdesk-category-id%>'
+
+translations:
+  -
+    crowdin_language_code: '<%crowdin-two-letters-code%>'
+    freshdesk_category_id: '<%freshdesk-category-id%>'
+  -
+    crowdin_language_code: '<%crowdin-two-letters-code%>'
+    freshdesk_category_id: '<%freshdesk-category-id%>'

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 "fci"
+    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/fci/commands/01_init.rb

@@ -0,0 +1,29 @@
+
+desc 'Create a new FCI-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/fci/commands/02_import.rb

@@ -0,0 +1,170 @@
+desc 'Read folders/articles from Freshdesk 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.desc 'Resources config file'
+  c.long_desc <<-EOS.strip_heredoc
+    This is the config file where the information about project's files will be store.
+  EOS
+  c.default_value 'resources/.resources.yml'
+  c.arg_name 'file'
+  c.flag [:resources_config]
+
+  c.action do |global_options, options, args|
+    resources_dir = options[:resources_dir]
+    unless File.exists?(resources_dir)
+      FileUtils.mkdir(resources_dir)
+    end
+    resources_config_file = options[:resources_config]
+
+    File.open(resources_config_file, 'a+') do |f|
+      config = YAML.load(f)
+      unless config # config file empty
+        config = {}
+        # initialize empty config file
+        f.write config.to_yaml
+      end
+    end
+
+    # for store information about folders/articles ids
+    resources_config = YAML.load(File.open(resources_config_file))
+
+    # Source Category
+    source_category_id = @fci_config['freshdesk_category'].to_i
+
+    # Check if Category exists in Freshdesk
+    source_category = FreshdeskAPI::SolutionCategory.find!(@freshdesk, id: source_category_id)
+    raise('No such category') unless source_category.id == source_category_id
+
+    # Get category's folders in Freshdesk
+    puts "[Freshdesk] Get folders for Category with id #{source_category_id}"
+    folders = @freshdesk.solution_folders(category_id: source_category_id).all!
+
+    folders_builder = []
+    folders.each do |folder|
+      folder_xml = build_folder_xml(folder)
+
+      # write to resources config file
+      unless folder_xml.nil?
+        resources_config[:folders] = [] unless resources_config[:folders]
+        unless resources_config[:folders].detect { |f| f[:id] == folder.id }
+          resources_config[:folders] << { id: folder.id }
+        end
+      end
+
+      unless folder_xml.nil?
+        folders_builder << build_folder_hash(folder).merge({ xml: folder_xml })
+      end
+    end
+
+    # Get folders articles
+    articles_builder = []
+    folders.each do |folder|
+      puts "[Freshdesk] Get articles for Folder with id #{folder.id}"
+      articles = @freshdesk.solution_articles(category_id: source_category_id, folder_id: folder.id).all!
+
+      articles.each do |article|
+        article_xml = build_article_xml(article)
+
+        # write to resources config file
+        if config_folder = resources_config[:folders].detect { |f| f[:id] == folder.id }
+          (config_folder[:articles] ||= []) << { id: article.id }
+        else
+          abort 'No such folder!'
+        end
+
+        unless article_xml.nil?
+          articles_builder << build_article_hash(article).merge({ xml:  article_xml })
+        end
+      end
+    end
+
+
+    crowdin_project_info = @crowdin.project_info
+
+    # Creates xml files for folders and upload to Crowdin
+    folders_builder.each do |folder|
+      file_name = "folder_#{folder[:id]}.xml"
+
+      o = File.new(File.join(resources_dir, file_name), 'w')
+      o.write folder[:xml].to_xml
+      o.close
+
+      if crowdin_project_info['files'].detect { |file| file['name'] == file_name }
+        puts "[Crowdin] Update file `#{file_name}`"
+        @crowdin.update_file(
+          files = [
+            {
+              source: File.join(resources_dir, file_name),
+              dest: file_name,
+              export_pattert: '/%two_letters_code%/%original_file_name%',
+              title: folder[:name]
+            }
+          ], type: 'webxml'
+        )
+      else
+        puts "[Crowdin] Add file `#{file_name}`"
+        @crowdin.add_file(
+          files = [
+            {
+              source: File.join(resources_dir, file_name),
+              dest: file_name,
+              export_pattert: '/%two_letters_code%/%original_file_name%',
+              title: folder[:name]
+            }
+          ], 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_dir, file_name), 'w')
+      o.write article[:xml].to_xml
+      o.close
+
+      if crowdin_project_info['files'].detect { |file| file['name'] == file_name }
+        puts "[Crowdin] Update file `#{file_name}`"
+        @crowdin.update_file(
+          files = [
+            {
+              source: File.join(resources_dir, file_name),
+              dest: file_name,
+              export_pattert: '/%two_letters_code%/%original_file_name%',
+              title: article[:title]
+            }
+          ], type: 'webxml'
+        )
+      else
+        puts "[Crowdin] Add file `#{file_name}`"
+        @crowdin.add_file(
+          files = [
+            {
+              source: File.join(resources_dir, file_name),
+              dest: file_name,
+              export_pattert: '/%two_letters_code%/%original_file_name%',
+              title: article[:title]
+            }
+          ], type: 'webxml'
+        )
+
+      end
+    end
+
+    # Write resources config file
+    puts "Write config file"
+    File.open(resources_config_file, 'w') do |f|
+      f.write resources_config.to_yaml
+    end
+
+  end
+end
+

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

@@ -0,0 +1,32 @@
+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|
+    language = 'all'
+    tempfile = Tempfile.new(language)
+    zipfile_name = tempfile.path
+    resources_dir = options[:resources_dir]
+
+    base_path = File.join(Dir.pwd, resources_dir)
+    begin
+      export_translations!(@crowdin)
+
+      puts 'Downloading translations'
+      @crowdin.download_translation(language, output: zipfile_name)
+
+      base_path = File.join(Dir.pwd, resources_dir)
+      unzip_file_with_translations(zipfile_name, base_path)
+    ensure
+      tempfile.close
+      tempfile.unlink # delete the tempfile
+    end
+
+  end
+end

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

@@ -0,0 +1,207 @@
+desc 'Add or update localized resource files(folders and articles) in Freshdesk'
+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.desc 'Resources config file'
+  c.long_desc <<-EOS.strip_heredoc
+    This is the config file where the information about project's files will be store.
+  EOS
+  c.default_value 'resources/.resources.yml'
+  c.arg_name 'file'
+  c.flag [:resources_config]
+
+  c.action do |global_options, options, args|
+    # DO NOT EDIT THIS FILE BY HAND!
+    resources_config_file = options[:resources_config]
+    resources_dir = options[:resources_dir]
+
+    # for store information about folders/articles ids
+    unless File.exists?(resources_config_file)
+      raise "Error! Config file does not exist. First run `push` command"
+    end
+
+    resources_config = YAML.load(File.open(resources_config_file))
+
+    if !resources_config || resources_config.nil? || resources_config.empty?
+      raise "Error! Resources config empty. First run `push` command"
+    end
+
+    @fci_config['translations'].each do |lang|
+      folder_xml_files = Dir["#{resources_dir}/#{lang['crowdin_language_code']}/folder_*.xml"]
+      article_xml_files = Dir["#{resources_dir}/#{lang['crowdin_language_code']}/article_*.xml"]
+
+      unless freshdesk_category = FreshdeskAPI::SolutionCategory.find(@freshdesk, id: lang['freshdesk_category_id'].to_i)
+        raise "Not such Category ID for language `#{lang['crowdin_language_code']}`in Freshdesk. Please create new one and set ID in config file."
+      end
+
+      all_folders = []
+      all_articles = []
+
+      # Read folders from XML files
+      folder_xml_files.each do |file|
+        # Load the xml file into a String
+        folder_xml_file = File.read(file)
+
+        folder = parse_folder_xml(folder_xml_file)
+
+        all_folders << folder
+      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
+
+      ### Folders ###
+      #
+      all_folders.each do |folder|
+        if config_folder = resources_config[:folders].detect { |f| f[:id].to_s == folder[:id].to_s }
+
+          config_folder[:translations] = [] unless config_folder[:translations]
+
+          # if Folder translation ID exists in config
+          if folder_translation = config_folder[:translations].detect { |t| t[:lang] == lang['crowdin_language_code'] }
+            # Get folder from Freshdesk and update it
+            freshdesk_folder = FreshdeskAPI::SolutionFolder.find(
+              @freshdesk,
+              category_id: lang['freshdesk_category_id'].to_i,
+              id: folder_translation[:id]
+            )
+
+            # Remove Folder translation from config it it not found in Freshdesk
+            if freshdesk_folder.nil?
+              puts "Remove undefined Folder from config"
+              config_folder[:translations].delete_if { |tr| tr[:lang] == lang['crowdin_language_code'] }
+
+              puts "[Freshdesk] Create new Folder"
+              freshdesk_folder = FreshdeskAPI::SolutionFolder.create!(
+                @freshdesk,
+                category_id: lang['freshdesk_category_id'].to_i,
+                name: folder[:name],
+                description: folder[:description],
+                visibility: 1
+              )
+
+              config_folder[:translations] << { lang: lang['crowdin_language_code'], id: freshdesk_folder.id }
+
+            end
+
+            if freshdesk_folder.attributes[:name] != folder[:name] || freshdesk_folder.attributes[:description] != folder[:description]
+              puts "[Freshdesk] Update existing Folder"
+              freshdesk_folder.update!(name: folder[:name], description: folder[:description])
+            else
+              puts "[Freshdesk] Nothing to update. An existing Folder still the same."
+            end
+
+          else
+            # create new folder in Freshdesk and save id to config file
+            puts "[Freshdesk] Create new Folder"
+            freshdesk_folder = FreshdeskAPI::SolutionFolder.create!(
+              @freshdesk,
+              category_id: lang['freshdesk_category_id'].to_i,
+              name: folder[:name],
+              description: folder[:description],
+              visibility: 1
+            )
+
+            config_folder[:translations] << { lang: lang['crowdin_language_code'], id: freshdesk_folder.id }
+          end
+        else
+          abort "No such folder!"
+        end
+      end # all_folders
+
+      ### Articles ###
+      #
+      all_articles.each do |article|
+        if config_folder = resources_config[:folders].detect { |f| f[:id].to_s == article[:folder_id].to_s }
+          unless folder_translation = config_folder[:translations].detect { |t| t[:lang] == lang['crowdin_language_code'] }
+            abort "No `#{lang['crowdin_language_code']}` translations for folder"
+          end
+
+          if config_article = config_folder[:articles].detect { |f| f[:id].to_s == article[:id].to_s }
+            config_article[:translations] = [] unless config_article[:translations]
+
+            # if Article translation ID exists in config - update article on Freshdesk
+            if article_translation = config_article[:translations].detect { |t| t[:lang] == lang['crowdin_language_code'] }
+              freshdesk_article = FreshdeskAPI::SolutionArticle.find(
+                @freshdesk,
+                category_id: lang['freshdesk_category_id'].to_i,
+                folder_id: folder_translation[:id],
+                id: article_translation[:id]
+              )
+
+              # Remove Article translation from config if it not found in Freshdesk
+              if freshdesk_article.nil?
+                puts "Remove undefined Article from config"
+                config_article[:translations].delete_if { |tr| tr[:lang] == lang['crowdin_language_code'] }
+
+                puts "[Freshdesk] Create new Article"
+                freshdesk_article = FreshdeskAPI::SolutionArticle.create!(
+                    @freshdesk,
+                    category_id: lang['freshdesk_category_id'].to_i,
+                    folder_id: folder_translation[:id],
+                    title: article[:title],
+                    description: article[:description]
+                )
+                config_article[:translations] << { lang: lang['crowdin_language_code'], id: freshdesk_article.id }
+                next
+              end
+
+              if freshdesk_article.attributes[:title] != article[:title] || freshdesk_article.attributes[:description] != article[:description]
+                puts "[Freshdesk] Update existing Article"
+
+                freshdesk_article.update!(
+                  title: article[:title],
+                  description: article[:description]
+                )
+              else
+                puts "[Freshdesk] Nothing to update. An existing Article still the same."
+              end
+
+            else
+              # creates new article on Freshdesk and save ID to config file
+              if folder_translation = config_folder[:translations].detect { |t| t[:lang] == lang['crowdin_language_code'] }
+                # do nothing for now
+              else
+                abort "No translation for this folder"
+              end
+
+              puts "[Freshdesk] Create new Article"
+              freshdesk_article = FreshdeskAPI::SolutionArticle.create!(
+                @freshdesk,
+                category_id: lang['freshdesk_category_id'].to_i,
+                folder_id: folder_translation[:id],
+                title: article[:title],
+                description: article[:description]
+              )
+              config_article[:translations] << { lang: lang['crowdin_language_code'], id: freshdesk_article.id }
+            end
+          else
+            abort "No such article!"
+          end
+        else
+          abort "No such folder!"
+        end
+      end # all_articles
+
+      puts "Write info about localization to config"
+      File.open(resources_config_file, 'w') do |f|
+        f.write resources_config.to_yaml
+      end
+
+    end # @fci_config['translations']
+
+  end
+end
+

data/lib/fci/download.rb

@@ -0,0 +1,31 @@
+module FCI
+  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/fci/export.rb

@@ -0,0 +1,31 @@
+module FCI
+  def parse_folder_xml(folder_xml_file)
+    doc = Nokogiri::XML.parse(folder_xml_file)
+    folder_xml = doc.xpath("//folder").first
+
+    folder = {
+      id: folder_xml[:id],
+      name: folder_xml.xpath('name').text,
+      description: folder_xml.xpath('name').text,
+      position: folder_xml[:position],
+    }
+
+    return folder
+  end
+
+  def parse_article_xml(article_xml_file)
+    doc = Nokogiri::XML.parse(article_xml_file)
+    article_xml = doc.xpath('//article').first
+
+    article = {
+      id: article_xml[:id],
+      position: article_xml[:position],
+      folder_id: article_xml[:folder_id],
+      title: article_xml.xpath('title').text,
+      description: article_xml.xpath('description').text,
+    }
+
+    return article
+  end
+
+end

data/lib/fci/helpers.rb

@@ -0,0 +1,6 @@
+class String
+  def strip_heredoc
+    indent = scan(/^[ \t]*(?=\S)/).min.size || 0
+    gsub(/^[ \t]{#{indent}}/, '')
+  end
+end

data/lib/fci/import.rb

@@ -0,0 +1,66 @@
+module FCI
+  def build_folder_xml(folder)
+    attr = folder.attributes
+
+    folder_xml = Nokogiri::XML::Builder.new do |xml|
+      xml.root {
+        # id - id of the original folder
+        xml.folder(id: folder.id, position: attr[:position], identifier: 'folder', type: 'document') {
+          xml.name {
+            xml.cdata attr[:name]
+          }
+          xml.description {
+            xml.cdata attr[:description]
+          }
+        }
+      }
+    end
+
+    return folder_xml
+  end
+
+  def build_article_xml(article)
+    attr = article.attributes
+
+    article_xml = Nokogiri::XML::Builder.new do |xml|
+      xml.root {
+        # id - id of the original acticle
+        # folder_id - id of the original folder
+        xml.article(id: article.id, folder_id: attr[:folder_id], position: attr[:position], identifier: 'article', type: 'document') {
+          xml.title {
+            xml.cdata attr[:title]
+          }
+          xml.description {
+            xml.cdata attr[:description]
+          }
+        }
+      }
+    end
+
+    return article_xml
+  end
+
+  def build_folder_hash(folder)
+    attr = folder.attributes
+
+    return {
+      id:          folder.id,
+      position:    attr[:position],
+      name:        attr[:name],
+      description: attr[:description],
+    }
+  end
+
+  def build_article_hash(article)
+    attr = article.attributes
+
+    return {
+      id:          article.id,
+      folder_id:   attr[:folder_id],
+      position:    attr[:position],
+      title:       attr[:title],
+      description: attr[:description],
+    }
+  end
+
+end

data/lib/fci/init.rb

@@ -0,0 +1,62 @@
+require 'fileutils'
+
+module FCI
+  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'
+
+      # Freshdesk API credentials
+      freshdesk_base_url: 'https://<%subdomain%>.freshdesk.com'
+      freshdesk_username: '<%your-freshdek-username%>'
+      freshdesk_password: '<%your-freshdesk-password%>'
+
+      freshdesk_category: '<%freshdesk-category-id%>'
+
+      translations:
+        -
+          crowdin_language_code: '<%crowdin-two-letters-code%>'
+          freshdesk_category_id: '<%freshdesk-category-id%>'
+        -
+          crowdin_language_code: '<%crowdin-two-letters-code%>'
+          freshdesk_category_id: '<%freshdesk-category-id%>'
+    EOS
+
+    File.open("#{root_dir}/#{project_name}/fci.yml", 'w') do |file|
+      file << config
+    end
+
+    puts "Created #{root_dir}/#{project_name}/fci.yml"
+  end
+end

data/lib/fci/version.rb

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

data/lib/fci.rb

@@ -0,0 +1,14 @@
+require 'freshdesk_api'
+require 'crowdin-api'
+require 'byebug'
+require 'nokogiri'
+require 'zip'
+require 'fci/version.rb'
+
+# 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 'fci/helpers.rb'
+require 'fci/init.rb'
+require 'fci/import.rb'
+require 'fci/download.rb'
+require 'fci/export.rb'

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

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: fci
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anton Maminov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-19 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: byebug
+  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: freshdesk_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: 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: 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
+description: 
+email: anton.maminov@gmail.com
+executables:
+- fci
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/fci
+- fci.gemspec
+- fci.yml.example
+- features/fci.feature
+- features/step_definitions/fci_steps.rb
+- features/support/env.rb
+- lib/fci.rb
+- lib/fci/commands/01_init.rb
+- lib/fci/commands/02_import.rb
+- lib/fci/commands/03_download.rb
+- lib/fci/commands/04_export.rb
+- lib/fci/download.rb
+- lib/fci/export.rb
+- lib/fci/helpers.rb
+- lib/fci/import.rb
+- lib/fci/init.rb
+- lib/fci/version.rb
+- test/default_test.rb
+- test/test_helper.rb
+homepage: https://github.com/mamantoha/fci
+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.6
+signing_key: 
+specification_version: 4
+summary: Freshdesk and Crowdin integration Command Line Interface (CLI)
+test_files: []