crowdin-cli 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca8a6106bede17a0348f4cde54823cf779579783
-  data.tar.gz: a7004c0632c8115cee028c8c0b6a367774ced70d
+  metadata.gz: 670a39458358d6f3b7be7cb8e4d17d1218ae10c5
+  data.tar.gz: abc0a523a67c8a6d05a9bfb12613f8857a2bda9a
 SHA512:
-  metadata.gz: 787ccfe292caa45919033c849b25b947653a40a96e60da62826858c6cb1d1f4215221322aed60e86a5187c4526dea132afd06972430095fce9c17a85fefb112b
-  data.tar.gz: 5bb5f8afe7014b66a8847279776e19195c9b554b19cd2e84b069bd085c7e097344a2d95e1cd3a7f0aa3ec3092c58318375038dc4358c56b662d4e003b49cdfc1
+  metadata.gz: 13580b9db9a409a01ebc2dc18207f4e0f97a97184f67e9cb859b93de1efaf97ae5811c591434f75f24c0fca36437c4a94976c8840084426a1f0d378d7bff53af
+  data.tar.gz: 1e30247d743d9f1b08363866985938d7ddc4c2f56555d80c61da360e3479f4f04dbf2d0db6db4766f999c486b57a3fa9a3b417861d260009c49b94acc8b21df3

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2012-2015 Anton Maminov
+Copyright (c) 2012-2016 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

data/README.md

@@ -216,7 +216,7 @@ base_path: /path/to/your/project
 preserve_hierarchy: true
 ```
 
-### [I Have No Idea How To Call This Section]
+### Uploading files to specified path with specified type
 
 This add support for 2 optional parameters in the yaml file section: `dest` and `type`.
 This is useful typically for some projects, where the uploaded name must be different so Crowdin can detect the type correctly.
@@ -301,9 +301,41 @@ files:
     first_line_contains_header: true
     scheme: "identifier,source_phrase,context,uk,ru,fr"
     multilingual_spreadsheet: true
+```
+
+### Versions Management
 
+In version `0.5.0` we added support for versions management feature in Crowdin. Read more in our [blog](http://blog.crowdin.com/post/130133108120/new-feature-versions-management).
+
+This is how Crowdin CLI command looks like if you upload source texts from the branch:
+```
+crowdin-cli upload sources -b {branch_name}
 ```
 
+Upload translations texts from the branch:
+```
+crowdin-cli upload translations -b {branch_name}
+```
+
+Download translations from the branch:
+```
+crowdin-cli download -b {branch_name}
+```
+
+### Using a common base path for multiple branches
+
+By default CLI tool uses the base path without taking the branch into account when using the new versions management feature.
+In case you need to specify a common base path that contains the branches in subfolders named after branch names you can add `base_path_contains_branch_subfolders: true` option in main section of the configuration file.
+
+Configuration file example:
+```
+---
+project_identifier: test
+api_key: KeepTheAPIkeySecret
+base_url: https://api.crowdin.com
+base_path: /path/to/your/project
+base_path_contains_branch_subfolders: true
+```
 
 ## Configurations Examples
 
@@ -416,10 +448,10 @@ Installation/SystemRequirements:
 - Java
 - rvm
 
-Install JRuby 9.0.0.0 and Warbler gem:
+Install JRuby `>=9.0.0.0` and Warbler gem `>=2.0.0`:
 
 ```
-$ rvm install jruby-9.0.0.0
+$ rvm install jruby
 $ gem install warbler --pre
 ```
 
@@ -427,8 +459,8 @@ Create a new file called `Gemfile` in new project directory, an specify `crowdin
 
 ```ruby
 source 'https://rubygems.org'
-gem 'crowdin-api', '=0.3.0'
-gem 'crowdin-cli', '=0.4.6'
+gem 'crowdin-api', '=0.4.0'
+gem 'crowdin-cli', '=0.5.1'
 ```
 
 Create a new file called `bin/crowdin-cli`:
@@ -459,7 +491,7 @@ Install dependencies:
 $ bundle
 ```
 
-Compile/package with warbler
+Compile/package with Warbler:
 
 ```
 $ warble jar
@@ -467,7 +499,7 @@ $ warble jar
 
 and rename `warbler.jar` to whatever you want.
 
-Run jar in any computer with Java:
+Run jar in any computer with installed Java:
 
 ```
 java -jar <myapp>.jar
@@ -485,6 +517,47 @@ java -jar <myapp>.jar
 
 Author: Anton Maminov (anton.maminov@gmail.com)
 
-Copyright: 2012-2015 [crowdin.com](http://crowdin.com/)
+Copyright: 2012-2016 [crowdin.com](http://crowdin.com/)
 
 This project is licensed under the MIT license, a copy of which can be found in the LICENSE file.
+
+```
+
+                             `.-:://oooosyyyyyyyyyyyyyyyyyyyysoooo+///:::...                        
+                      .-//oyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyysoo//:-.`             
+                 .:+syyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyssssssssssssyyyyyyyyyyyyso+/:.`     
+             `:oyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyssoo+++///::::::::::::::::::-------::::////+ooooo+/:.
+          `:oyyyyyyyyyyyyyyyyyyyyyyyyyyyso++/::::::::::::--......````                            ```
+        -+yyyyyyyyyyyyyyyyyyyyyyyyyso+/:::::::::--...``                                             
+      .oyyyyyyyyyyyyyyyyyyyyyyyyo+::::::::--.``            ....-----------------....`               
+     /yyyyyyyyyyyyyyyyyyyyyyyo/:::::::-..`      ..-:/+oosssyyyyyyyyyyyyyyyyyyyyyssssssso++/:--`     
+   `oyyyyyyyyyyyyyyyyyyyyyyo/::::::-.`    .-/+ssyyyyyyyyyyyyyyyysssooo++////::----..........```     
+  `syyyyyyyyyyyyyyyyyyyyys/:::::-.`   .:+syyyyyyyyyyyyyyysoo+//:::---..```                          
+  oyyyyyyyyyyyyyyyyyyyyy+:::::-.   ./syyyyyyyyyyyyyyso+/::::--.``                                   
+ :yyyyyyyyyyyyyyyyyyyyy+::::-.   -oyyyyyyyyyyyyyys+/::::-.``   `.--::/++++ssssssssso++++/::-.`      
+ oyyyyyyyyyyyyyyyyyyyy+::::-`  .oyyyyyyyyyyyyyyo/:::-.`   .-/+ssyyyyyyyyssoo++///::----......``     
+.yyyyyyyyyyyyyyyyyyyys::::-   :syyyyyyyyyyyyys/:::-`   ./osyyyyyyyyso+/::-.````                     
+:ossyyyyyyyyyyyyyyyyy/:::-   -yyyyyyyyyyyyyy+:::-`   -oyyyyyyyyso/::-.``                            
+  ``.:/+oosssyyyyyyyo::::`  `syyyyyyyyyyyyyo:::.   `oyyyyyyyyy+::-.`                                
+     .:::::::///++oo::::-   -yyyyyyyyyyyyys:::.   `oyyyyyyyys/:-`                                   
+     -::::::::::::::::::.   /yyyyyyyyyyyyy+::-    :yyyyyyyyy/:.                                     
+     -::::::::::::::::::    .:::++ooosssss:::`    /ssyyyyyyo:-                                    
+o+/:-::::::::::::::::::-        :::::::::::::`    ``.///////:.                                  
+yyyyyyssoo++////:::::::.        ::::::::::::-     `..::::::::.                                  
+yyyyyyyyyyyyyyyysso::::.    -o+/++///////:::-     :yyssssss/:.                                 
+yyyyyyyyyyyyyyyyyyy::::.    .yyyyyyyyyyyys:::`    `yyyyyyyyo:-                                
++yyyyyyyyyyyyyyyyyy/:::.     syyyyyyyyyyyy/::.     /yyyyyyyy/:.                              
+-yyyyyyyyyyyyyyyyyy/::::     :yyyyyyyyyyyyo:::     `oyyyyyyyy/:-`                           
+`syyyyyyyyyyyyyyyyyo::::`     oyyyyyyyyyyyy+::-      /syyyyyyyo/:-.``   `````.             
+ :yyyyyyyyyyyyyyyyyy/:::-     `syyyyyyyyyyyy/::-`     `/oyyyyyyyssoo+++//:-.`             
+  +yyyyyyyyyyyyyyyyyo::::-     `oyyyyyyyyyyyyo:::-`      `-://oo+///--`                   
+  `syyyyyyyyyyyyyyyyy+::::-      /yyyyyyyyyyyyyo/:::-..`         ``..`                    
+   `syyyyyyyyyyyyyyyyy+::::-`     `/syyyyyyyyyyyyso++//::::/:///:-.`                       
+    `+yyyyyyyyyyyyyyyyys/::::-`      .:+yyyyyyyyyyyyyyyysso/:.`                                     
+      -syyyyyyyyyyyyyyyyyo:::::-.`       `.---////----..                                            
+       `/syyyyyyyyyyyyyyyyyo+::::::-..``                                                            
+          -+yyyyyyyyyyyyyyyyyyso+/:::::::---......--::-..`                                          
+             -/oyyyyyyyyyyyyyyyyyyyysssoooooooo++/-.`                                               
+                 `-:/oosyyyyyyyyyyyyyooo//::.`                                                      
+
+```

data/bin/crowdin-cli

@@ -82,6 +82,7 @@ def export_pattern_to_path(path, export_pattern, lang, languages_mapping = nil)
     '%android_code%'           => android_locale_code(lang['locale']),
     '%osx_code%'               => osx_language_code(lang['crowdin_code']) + '.lproj',
     '%osx_xliff%'              => osx_language_code(lang['crowdin_code']) + '.xliff',
+    '%osx_locale%'             => osx_language_code(lang['crowdin_code']),
   }
 
   placeholders = pattern.inject([]){ |memo, h| memo << h.first[/%(.*)%/, 1] }
@@ -209,7 +210,8 @@ def get_invalid_placeholders(export_pattern)
     '%locale_with_underscore%',
     '%android_code%',
     '%osx_code%',
-    '%osx_liff%',
+    '%osx_xliff%',
+    '%osx_locale%',
     '%original_file_name%',
     '%original_path%',
     '%file_extension%',
@@ -254,8 +256,14 @@ def unzip_file_with_translations(zipfile_name, dest_path, files_list, ignore_mat
 
   Zip::File.open(zipfile_name) do |zipfile|
     zipfile.select { |zip_entry| zip_entry.file? }.each do |f|
+      filename = f.name
+      if @branch_name and @base_path_contains_branch_subfolders
+        # strip branch from filename
+        filename = f.name.sub(File.join(@branch_name, '/'), '')
+      end
+
       # `f' - relative path in archive
-      file = files_list[f.name]
+      file = files_list[filename]
       if file
         fpath = File.join(dest_path, file)
         FileUtils.mkdir_p(File.dirname(fpath))
@@ -452,7 +460,7 @@ command :upload do |c|
             end
           end # Find
 
-        end # if File.exists?
+        end # if File.exist?
       end # @config['files']
 
       if dest_files.empty?
@@ -630,7 +638,7 @@ command :upload do |c|
           file_translation_languages = translation_languages
         end
 
-        if File.exists?(File.join(@base_path, file['source']))
+        if File.exist?(File.join(@base_path, file['source']))
           dest = file['dest'] || file['source']
           dest.sub!(/\A#{Regexp.escape(@base_path)}/, '')
           dest_files << dest
@@ -732,6 +740,9 @@ command :download do |c|
   c.desc I18n.t('app.commands.download.switches.ignore_match.desc')
   c.switch ['ignore-match'], negatable: false
 
+  c.desc I18n.t('app.commands.download.switches.include_unchanged')
+  c.switch ['include-unchanged'], negatable: false
+
   c.action do |global_options, options, args|
     if @branch_name
       branch = @project_info['files'].find { |h| h['node_type'] == 'branch' && h['name'] == @branch_name }
@@ -768,15 +779,17 @@ command :download do |c|
     params = {}
     params[:branch] = @branch_name if @branch_name
 
-    # use export API method before to download the most recent translations
-    print 'Building ZIP archive with the latest translations '
-    export_translations = @crowdin.export_translations(params)
-    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."
+    unless options['include-unchanged']
+      # use export API method before to download the most recent translations
+      print 'Building ZIP archive with the latest translations '
+      export_translations = @crowdin.export_translations(params)
+      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
 
@@ -803,7 +816,7 @@ command :download do |c|
         file_translation_languages = translation_languages
       end
 
-      if File.exists?(File.join(@base_path, file['source']))
+      if File.exist?(File.join(@base_path, file['source']))
         dest = file['source'].sub(/\A#{Regexp.escape(@base_path)}/, '')
 
         file_translation_languages.each do |lang|
@@ -952,7 +965,7 @@ command :list do |ls_cmd|
             end
           end # Find
 
-        end # if File.exists?
+        end # if File.exist?
       end # @config['files']
 
       common_dir = @preserve_hierarchy ? '' : find_common_directory_path(dest_files)
@@ -985,7 +998,7 @@ command :list do |ls_cmd|
 
         ignores = file['ignore'] || []
 
-        if File.exists?(File.join(@base_path, file['source']))
+        if File.exist?(File.join(@base_path, file['source']))
           dest = file['source'].sub(/\A#{Regexp.escape(@base_path)}/, '')
 
           translation_languages.each do |lang|
@@ -1053,7 +1066,7 @@ pre do |globals, command, options, args|
     'translatable_elements',
   ]
 
-  unless File.exists?(globals[:config])
+  unless File.exist?(globals[:config])
     exit_now! <<-EOS.strip_heredoc
       Can't find configuration file (default `crowdin.yaml').
       Type `crowdin-cli help` to know how to specify custom configuration file
@@ -1095,7 +1108,7 @@ pre do |globals, command, options, args|
 
   # user credentials in the user-specific config file have a higher priority than project-specific
   #
-  if File.exists?(globals[:identity])
+  if File.exist?(globals[:identity])
     identity = YAML.load(ERB.new(File.read(globals[:identity])).result) || {}
     ['api_key', 'project_identifier', 'base_path'].each do |key|
       @config[key] = identity[key] if identity[key]
@@ -1170,10 +1183,26 @@ pre do |globals, command, options, args|
     EOS
   end
 
+  @base_path_contains_branch_subfolders = false
+  if @config['base_path_contains_branch_subfolders']
+    @base_path_contains_branch_subfolders = case @config['base_path_contains_branch_subfolders']
+      when true
+        true
+      when false
+        false
+      else
+        exit_now! <<-EOS.strip_heredoc
+          Parameter `base_path_contains_branch_subfolders` allows values of true or false.
+        EOS
+    end
+  end
+
   @branch_name = options[:branch] || nil
-  # @base_path = @branch_name ? File.join(@base_path, @branch_name) : @base_path
+  if @branch_name and @base_path_contains_branch_subfolders
+    @base_path = File.join(@base_path, @branch_name)
+  end
 
-  unless Dir.exists?(@base_path)
+  unless Dir.exist?(@base_path)
     exit_now! <<-EOS.strip_heredoc
       No such directory `#{@base_path}`. Please make sure that the `base_path` is properly set.
     EOS

data/lib/crowdin-cli/version.rb

@@ -1,5 +1,5 @@
 module Crowdin
   module CLI
-    VERSION = '0.5.1'
+    VERSION = '0.5.3'
   end
 end

data/locales/en.yml

@@ -65,6 +65,9 @@ en:
           ignore_match:
             desc: |
               Exit with a zero even if no files matched
+          include_unchanged:
+            desc: |
+              Download all translation files whether or not they have changes
 
       list:
         desc: Show a list of files (the current project)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-cli
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2016-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Crowdin CLI.