crowdin-cli 0.0.13 → 0.0.14

data/README.md

@@ -32,7 +32,7 @@ Create a `crowdin.yaml` YAML file in your root project directory with the follow
 
 ```
 ---
-project_id: test
+project_idenfier: test
 api_key: KeepTheAPIkeySecret
 base_url: http://api.crowdin.net
 base_path: /path/to/your/project
@@ -44,13 +44,13 @@ files:
 ```
 
 * `api_key` - Crowdin Project API key
-* `project_id` - Crowdin project name
+* `project_identifier` - Crowdin project name
 * `base_url` - (default: http://api.crowdin.net)
 * `base_path` - defines what directory we have to scan(default: current directory)
 * `files`
   * `source` - defines only files we will upload as sources
   * `translation` - attribute defines where translations should be placed after downloading (also we have to check those path to detect and upload existing translations)
-    
+
         Use the following placeholders to put appropriate variables into the resulting file name:
       * `%language%` - Language name (i.e. Ukrainian)
       * `%two_letters_code%` - Language code ISO 639-1 (i.e. uk)
@@ -77,7 +77,7 @@ Also you can add and upload all directories mathing the pattern including all ne
 Create a `crowdin.yaml` YAML file in your root project directory with the following structure:
 ```
 ---
-project_id: test
+project_identifier: test
 api_key: KeepTheAPIkeySecret
 base_url: http://api.crowdin.net
 base_path: /path/to/your/project
@@ -92,7 +92,7 @@ Languages mapping.
 
 ```
 ---
-project_id: test
+project_identifier: test
 api_key: KeepTheAPIkeySecret
 base_url: http://api.crowdin.net
 base_path: /path/to/your/project
@@ -102,7 +102,8 @@ files:
     source: /locale/en/**/*.po
     translation: /locale/%two_letters_code%/**/%original_file_name%
     languages_mapping:
-      '%two_letters_code%':
+      two_letters_code:
+        # crowdin_language_code: local_name
         ru: ros
         uk: ukr
 ```

data/bin/crowdin-cli

@@ -70,7 +70,7 @@ def export_pattern_to_path(path, export_pattern, lang, languages_mapping = nil)
   unless languages_mapping.nil?
     pattern = Hash[pattern.map{|k, str| [
       k,
-      (languages_mapping[k[/%(.*)%/, 1]][str] rescue nil) || str]
+      (languages_mapping[k[/%(.*)%/, 1]][lang['crowdin_code']] rescue nil) || str]
     }]
   end
 
@@ -119,42 +119,36 @@ end
 ###
 include GLI::App
 
-program_desc 'A CLI to sync locale files with crowdin.net'
-
 version Crowdin::CLI::VERSION
 
+program_desc 'is a command line tool that allows you to manage and synchronize your localization resources with Crowdin project'
+program_long_desc 'This tool requires configuration file to be created. See http://crowdin.net/page/cli-client for more details.'
+sort_help :manually # help commands are ordered in the order declared
+wrap_help_text :to_terminal
+
 desc 'Be verbose'
 switch [:v, :verbose]
 
-desc 'Path to config file'
+desc 'Configuration file'
 default_value File.join(Dir.pwd, 'crowdin.yaml')
 arg_name '<s>'
 flag [:c, :config]
 
-desc 'Upload existing translations to Crowdin project'
-#arg_name 'Describe arguments to upload here'
+desc 'Allows you to upload source files and existing translations to Crowdin project'
+long_desc 'This command is used to upload source files and translations to Crowdin. This command is used in combination with sub-commands `sources` and `translations`.'
+
 command :upload do |c|
-  # Command 'upload' requires a subcommand
-  #
-  #c.action do |global_options, options, args|
-  #  puts "upload command ran"
-  #end
-
-  #c.default_command :all
-
-  #c.desc 'Upload source and translation files'
-  #c.command :all do |c|
-  #  c.action do |global_options, options, args|
-  #    puts options
-  #    puts "`upload all` command ran"
-  #  end
-  #end
-
-  c.desc 'Upload source files'
+
+  c.desc 'safely upload source files to Crowdin'
+  c.long_desc <<EOS
+Upload source files to Crowdin project. If there are new localization files locally they will be added to Crowdin project.
+Othervice files will be updated (if no --no-auto-update option specified).
+EOS
+
   c.command :sources do |c|
 
-    c.desc 'defines whether to add sources if there is the same file previously added'
-    c.switch [:ignore_duplicates]
+    c.desc 'Defines whether to update source files in Crowdin project. --no-auto-update is useful when you just want to upload new files without updating existing ones.'
+    c.switch ['auto-update']
 
     c.action do |global_options, options, args|
       project_info = @crowdin.project_info
@@ -206,15 +200,16 @@ command :upload do |c|
         @crowdin.add_directory(dir)
       end
 
-      unless options[:ignore_duplicates]
+      if options['auto-update'].nil? or options['auto-update']
         # Update existing files in Crowdin project
         #
         # array containing elements common to the two arrays
         update_files = local_project_tree[:files] & remote_project_tree[:files]
         files_for_upload = local_files.select{ |file| update_files.include?(file[:dest]) }
         files_for_upload.each do |file|
-          puts "Update file `#{file[:dest]}`"
+          print "Updating file `#{file[:dest]}'"
           @crowdin.update_file([] << file)
+          puts "\rUpdating file `#{file[:dest]}' - OK"
         end
       end
 
@@ -223,29 +218,37 @@ command :upload do |c|
       add_files = local_project_tree[:files] - remote_project_tree[:files]
       files_for_add = local_files.select{ |file| add_files.include?(file[:dest]) }
       files_for_add.each do |file|
-        puts "Add new file `#{file[:dest]}`"
+        print "Uploading file `#{file[:dest]}'"
         @crowdin.add_file([] << file)
+        puts "\rUploading file `#{file[:dest]}' - OK"
       end
 
     end # action
   end # command
 
-  c.desc 'Upload translation files'
+  c.desc 'upload existing translations to Crowdin project'
+  c.long_desc <<EOS
+Upload existing translations to Crowdin.
+See below available options that can be used in combination with this command.
+If no options specified uploaded translations will be not approved,
+imported to Crowdin project even if they are duplicated and imported even they are equal to souce string.
+(In many localization formats they can be considered as not actually translations).
+EOS
   c.command :translations do |c|
 
-    c.desc 'the language of translation you need'
+    c.desc 'Defines what language upload translations to. By default translations will be uploaded for all Crowdin project target languages'
     c.default_value 'all'
-    c.arg_name 'language_code'
+    c.arg_name 'crowdin_language_code'
     c.flag [:l, :language]
 
-    c.desc 'defines whether to add translation if there is the same translation previously added'
-    c.switch [:import_duplicates]
+    c.desc 'Defines whether to add translation if there is the same translation already existing in Crowdin project'
+    c.switch ['import-duplicates']
 
-    c.desc 'defines whether to add translation if it is equal to source string at Crowdin'
-    c.switch [:import_eq_suggestions]
+    c.desc 'Defines whether to add translation if it is equal to source string in Crowdin project'
+    c.switch ['import-eq-suggestions']
 
-    c.desc 'mark uploaded translations as approved'
-    c.switch [:auto_approve_imported]
+    c.desc 'Automatically approve uploaded translations'
+    c.switch ['auto-approve-imported']
 
 
     c.action do |global_options, options, args|
@@ -303,9 +306,9 @@ command :upload do |c|
       exit_now!("Nothing to upload") if dest_files.empty?
 
       params = {}
-      params[:import_duplicates]     = options[:import_dublicates]     ? 1 : 0
-      params[:import_eq_suggestions] = options[:import_eq_suggestions] ? 1 : 0
-      params[:auto_approve_imported] = options[:auto_approve_imported] ? 1 : 0
+      params[:import_duplicates]     = options['import-dublicates']     ? 1 : 0
+      params[:import_eq_suggestions] = options['import-eq-suggestions'] ? 1 : 0
+      params[:auto_approve_imported] = options['auto-approve-imported'] ? 1 : 0
 
       common_dir = find_common_directory_path(dest_files)
 
@@ -314,14 +317,15 @@ command :upload do |c|
           file[:dest].sub!(common_dir, '')
           if remote_project_tree[:files].include?(file[:dest])
             if File.exist?(file[:source])
-              puts "Uploading #{file[:source].sub(@base_path, '')}"
+              print "Uploading `#{file[:source].sub(@base_path, '')}'"
               @crowdin.upload_translation([] << file, language, params)
+              puts "\rUploading `#{file[:source].sub(@base_path, '')}' - OK"
             else
-              puts "Local file #{file[:source]} not exists"
+              puts "Warning: Local file `#{file[:source]}' does not exists"
             end
           else
             # if source file not exist, don't upload translation
-            puts "Skip #{file[:source].sub(@base_path, '')}"
+            puts "Warning: Skip `#{file[:source].sub(@base_path, '')}'"
           end
         end
       end
@@ -331,17 +335,17 @@ command :upload do |c|
 
 end
 
-desc 'Download existing translations'
+desc 'Download latest translations from Crowdin and put them to the right places in your project'
 #arg_name 'Describe arguments to download here'
 command :download do |c|
 
-  c.desc 'the language of translation you need'
+  c.desc 'If the option is defined the translations will be downloaded for single specified language. Othervice (by default) translations are downloaded for all languages'
   c.arg_name 'language_code'
   c.flag :l, :language, :default_value => 'all'
 
   c.action do |global_options ,options, args|
     # use export API method before to download the most recent translations
-    #@crowdin.export_translations
+    @crowdin.export_translations
 
     language = options[:language]
     project_info = @crowdin.project_info
@@ -417,9 +421,41 @@ pre do |global ,command, options, args|
   # Use skips_pre before a command to skip this block
   # on that command only
 
-  @config = YAML.load_file(global[:config])
+  if File.exists?(global[:config])
+    @config = YAML.load_file(global[:config])
+
+    ['api_key', 'project_identifier'].each do |key|
+      unless @config[key]
+        exit_now! <<EOS
+Configuration file misses required option `#{key}`
+
+See http://crowdin.net/page/cli-client#configuration-file for more details
+EOS
+      end
+    end
+
+    unless @config['files']
+      exit_now! <<EOS
+Configuration file misses required section `files`
+
+See http://crowdin.net/page/cli-client#configuration-file for more details
+EOS
+    end
+
+  else
+    exit_now! <<EOS
+Can't find configuration file (default `crowdin.yml').
+Type `crowdin-cli help` to know how to specify custom configuration file
+
+See http://crowdin.net/page/cli-client#configuration-file for more details
+EOS
+  end
+
+  @config['files'].each do |file|
+    file['source'] = '/' + file['source'] unless file['source'].start_with?('/')
+    file['translation'] = '/' + file['translation'] unless file['translation'].start_with?('/')
+  end
 
-  #@base_path = @config['base_path'] || Dir.pwd
   if @config['base_path']
     if @config['base_path'].start_with?('/')
       @base_path = @config['base_path']
@@ -431,9 +467,14 @@ pre do |global ,command, options, args|
   end
 
   Crowdin::API.log = Logger.new($stderr) if global[:v]
-  @crowdin = Crowdin::API.new(api_key: @config['api_key'], project_id: @config['project_id'], base_url: @config['base_url'] || 'http://api.crowdin.net')
+  @crowdin = Crowdin::API.new(api_key: @config['api_key'], project_id: @config['project_identifier'], base_url: @config['base_url'] || 'http://api.crowdin.net')
+  begin
+    @crowdin.project_info
+  rescue
+    exit_now!("Seems Crowdin server API URL is not valid. Please check the `base_url` parameter in the configuration file.")
+  end
 
-  puts "Executing #{command.name}" if global[:v]
+  #puts "Executing #{command.name}" if global[:v]
   true
 end
 
@@ -441,7 +482,7 @@ post do |global, command, options, args|
   # Post logic here
   # Use skips_post before a command to skip this
   # block on that command only
-  puts "Executed #{command.name}" if global[:v]
+  #puts "Executed #{command.name}" if global[:v]
 end
 
 on_error do |exception|

data/lib/crowdin-cli/version.rb

@@ -1,5 +1,5 @@
 module Crowdin
   module CLI
-    VERSION = '0.0.13'
+    VERSION = '0.0.14'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2012-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement