crowdin-cli 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 167ef12c5091fa606c78a514bb4ba5eca0f1edf4
-  data.tar.gz: f2e3308d437fcac56099fb9ca118619508c703b5
+  metadata.gz: daa20289026306a2008ed1ecc5ef161d7a6a4101
+  data.tar.gz: 77731ee49a71b4b23f04e2a5aa864821e1d2016b
 SHA512:
-  metadata.gz: 731742a0475fe5070dda8bad25d7b6afbac5fc86ed2b8fe6f051d9b6127d0604085d13a63cf163824c45a4f18a9c1ab8a86921d948bb6eeaeb5a4146cd8e0bbd
-  data.tar.gz: 1e50b3cb3bf5d5b7f148a6c905d1fd8c1e6f289d59a92f01f32eacce9f366355fbfe0ca178d2dbaef49a67af169aa6654f53795c58ebf80f274d8bf5352e8efa
+  metadata.gz: 939acca8288fdee76d5f1cf7e4256d09f4b4ccc228f45c0e810d581cc88b860838f736410ce2363e54f01e35268fde2ed6b31deb3a263509d0dc959cb1a54a03
+  data.tar.gz: de55fe67aa2668fb7c34096804f795c414eb87181f024f3f955c0e60f33bae289d96bdb1b8e2cf2e35c3595479f2d7f842bb941ea63cdab76d0fbe23bf3dbf57

data/LICENSE

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

data/README.md

@@ -68,6 +68,8 @@ files:
       * `%original_path%` - Take parent folders names in Crowdin project to build file path in resulted bundle
       * `%file_extension%` - Original file extension
       * `%file_name%` - File name without extension
+      * `%osx_code%` - OS X Locale identifier used to name ".lproj" directories
+      * `%osx_xliff%` - OS X Locale used to name xliff files (i.e. uk.xliff)
 
          Example for Android projects:
           ```
@@ -120,6 +122,25 @@ files:
     translation: /locale/%two_letters_code%/**/%original_file_name%
 ```
 
+### API Credentials from environment variables
+
+You could load the API Credentials from an environment variable, e.g.
+
+```
+api_key_env: 'CROWDIN_API_KEY'
+project_identifier_env: 'CROWDIN_PROJECT_ID'
+
+```
+
+If mix, `api_key` and `project_identifier` have priority:
+
+```
+api_key_env: CROWDIN_API_KEY            # Low priority
+project_identifier_env: CROWDIN_PROJECT # Low priority
+api_key: xxx                            # High priority
+project_identifier: yyy                 # Hight priority
+```
+
 ### Split project configuration and user credentials
 
 The `crowdin.yaml` file contains project-specific configuration and user credentials(`api_key`, `project_identifier`).
@@ -192,6 +213,26 @@ base_path: /path/to/your/project
 preserve_hierarchy: true
 ```
 
+### [I Have No Idea How To Call This Section]
+
+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.
+`dest` allows you to specify a file name on Crowdin.
+**NOTE**: `dest` only works for single files. Don't try to use it with patterns (multiple files).
+
+Configuration sample is below:
+
+```
+files
+  -
+    source: '/conf/messages'
+    dest: '/messages.properties'
+    translation: '/conf/messages.%two_letters_code%'
+    type: 'properties'
+
+
+```
+
 ### Escape quotes for `.properties` file format
 
 Defines whether single quote should be escaped by another single quote or backslash in exported translations.
@@ -376,6 +417,6 @@ Tested with the following Ruby versions:
 
 Author: Anton Maminov (anton.maminov@gmail.com)
 
-Copyright: 2012-2014 [crowdin.com](http://crowdin.com/)
+Copyright: 2012-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/bin/crowdin-cli

@@ -76,6 +76,7 @@ def export_pattern_to_path(path, export_pattern, lang, languages_mapping = nil)
     '%locale_with_underscore%' => lang['locale'].gsub('-', '_'),
     '%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',
   }
 
   placeholders = pattern.inject([]){ |memo, h| memo << h.first[/%(.*)%/, 1] }
@@ -203,6 +204,7 @@ def get_invalid_placeholders(export_pattern)
     '%locale_with_underscore%',
     '%android_code%',
     '%osx_code%',
+    '%osx_liff%',
     '%original_file_name%',
     '%original_path%',
     '%file_extension%',
@@ -235,7 +237,7 @@ end
 
 # Extract compressed files +files_list+ in a ZIP archive +zipfile_name+ to +dest_path+
 #
-# +files_list+ is a Hash of key-value pairs. Where key is a posible archive filename based on current project configuration
+# +files_list+ is a Hash of key-value pairs. Where key is a possible archive filename based on current project configuration
 # and value is the expanded filename
 #
 def unzip_file_with_translations(zipfile_name, dest_path, files_list)
@@ -246,7 +248,7 @@ def unzip_file_with_translations(zipfile_name, dest_path, files_list)
   unmatched_files = []
 
   Zip::File.open(zipfile_name) do |zipfile|
-    zipfile.select{ |zip_entry| zip_entry.file? }.each do |f|
+    zipfile.select { |zip_entry| zip_entry.file? }.each do |f|
       # `f' - relative path in archive
       file = files_list[f.name]
       if file
@@ -316,6 +318,13 @@ def display_tree(files_tree, level = -2, branches = [])
   end
 end
 
+class String
+  def strip_heredoc
+    indent = scan(/^[ \t]*(?=\S)/).min.size || 0
+    gsub(/^[ \t]{#{indent}}/, '')
+  end
+end
+
 ###
 include GLI::App
 
@@ -329,7 +338,7 @@ sort_help :manually # help commands are ordered in the order declared
 wrap_help_text :to_terminal
 
 desc I18n.t('app.switches.verbose.desc')
-switch [:v, :verbose], :negatable => false
+switch [:v, :verbose], negatable: false
 
 desc I18n.t('app.flags.config.desc')
 default_value File.join(Dir.pwd, 'crowdin.yaml')
@@ -389,7 +398,7 @@ command :upload do |c|
           local_files << local_file
         else
           Find.find(@base_path) do |source_path|
-            dest = source_path.sub(/\A#{@base_path}/, '') # relative path in Crowdin
+            dest = source_path.sub(/\A#{Regexp.escape(@base_path)}/, '') # relative path in Crowdin
 
             if File.directory?(source_path)
               if ignores.any? { |pattern| File.fnmatch?(pattern, dest, File::FNM_PATHNAME) }
@@ -418,11 +427,11 @@ command :upload do |c|
       end # @config['files']
 
       if dest_files.empty?
-        exit_now! <<EOS
-No source files to upload.
-Check your configuration file to ensure that they contain valid directives.
-See http://crowdin.com/page/cli-tool#configuration-file for more details.
-EOS
+        exit_now! <<-EOS.strip_heredoc
+          No source files to upload.
+          Check your configuration file to ensure that they contain valid directives.
+          See http://crowdin.com/page/cli-tool#configuration-file for more details.
+        EOS
       end
 
       common_dir = @preserve_hierarchy ? '' : find_common_directory_path(dest_files)
@@ -435,7 +444,7 @@ EOS
       #
       create_dirs = local_project_tree[:dirs] - remote_project_tree[:dirs]
       create_dirs.each do |dir|
-        puts "Create directory `#{dir}`"
+        puts "Creating directory `#{dir}`"
         @crowdin.add_directory(dir)
       end
 
@@ -524,7 +533,7 @@ EOS
         if project_languages.include?(language)
           project_languages = [] << language
         else
-          exit_now!("language '#{language}' doesn't exist in a project")
+          exit_now!("language '#{language}' doesn't exist in the project")
         end
       end
 
@@ -557,7 +566,8 @@ EOS
         end
 
         if File.exists?(File.join(@base_path, file['source']))
-          dest = file['source'].sub(/\A#{@base_path}/, '')
+          dest = file['dest'] || file['source']
+          dest.sub!(/\A#{Regexp.escape(@base_path)}/, '')
           dest_files << dest
 
           file_translation_languages.each do |lang|
@@ -566,7 +576,7 @@ EOS
           end
         else
           Find.find(@base_path) do |source_path|
-            dest = source_path.sub(/\A#{@base_path}/, '') # relative path in Crowdin
+            dest = source_path.sub(/\A#{Regexp.escape(@base_path)}/, '') # relative path in Crowdin
 
             if File.directory?(source_path)
               if ignores.any? { |pattern| File.fnmatch?(pattern, dest, File::FNM_PATHNAME) }
@@ -593,11 +603,11 @@ EOS
       end # @config['files']
 
       if dest_files.empty?
-        exit_now! <<EOS
-No translation files to upload.
-Check your configuration file to ensure that they contain valid directives.
-See http://crowdin.com/page/cli-tool#configuration-file for more details.
-EOS
+        exit_now! <<-EOS.strip_heredoc
+          No translation files to upload.
+          Check your configuration file to ensure that they contain valid directives.
+          See https://crowdin.com/page/cli-tool#configuration-file for more details.
+        EOS
       end
 
       common_dir = @preserve_hierarchy ? '' : find_common_directory_path(dest_files)
@@ -608,23 +618,23 @@ EOS
 
           if remote_project_tree[:files].include?(file[:dest])
             if File.exist?(file[:source])
-              print "Uploading translation file `#{file[:source].sub(/\A#{@base_path}/, '')}'"
+              print "Uploading translation file `#{file[:source].sub(/\A#{Regexp.escape(@base_path)}/, '')}'"
 
               resp = @crowdin.upload_translation([] << file, language, params)
               case resp['files'].first[1]
               when 'skipped'
-                puts "\rUploading translation file `#{file[:source].sub(/\A#{@base_path}/, '')}' - Skipped"
+                puts "\rUploading translation file `#{file[:source].sub(/\A#{Regexp.escape(@base_path)}/, '')}' - Skipped"
               when 'uploaded'
-                puts "\rUploading translation file `#{file[:source].sub(/\A#{@base_path}/, '')}' - OK"
+                puts "\rUploading translation file `#{file[:source].sub(/\A#{Regexp.escape(@base_path)}/, '')}' - OK"
               when 'not_allowed'
-                puts "\rUploading translation file `#{file[:source].sub(/\A#{@base_path}/, '')}' - is not possible"
+                puts "\rUploading translation file `#{file[:source].sub(/\A#{Regexp.escape(@base_path)}/, '')}' - is not possible"
               end
             else
               puts "Warning: Local file `#{file[:source]}' does not exist"
             end
           else
             # if source file does not exist, don't upload translations
-            puts "Warning: Skip `#{file[:source].sub(/\A#{@base_path}/, '')}'"
+            puts "Warning: Skip `#{file[:source].sub(/\A#{Regexp.escape(@base_path)}/, '')}'. Translation can not be uploaded for a non-existent source file `#{file[:dest]}'. Please upload sources first."
           end
         end
       end
@@ -641,7 +651,7 @@ command :download do |c|
   c.desc I18n.t('app.commands.download.flags.language.desc')
   c.long_desc I18n.t('app.commands.download.flags.language.long_desc')
   c.arg_name 'language_code'
-  c.flag [:l, :language], :default_value => 'all'
+  c.flag [:l, :language], default_value: 'all'
 
   c.action do |global_options ,options, args|
     language = options[:language]
@@ -669,7 +679,7 @@ command :download do |c|
     end
 
     # use export API method before to download the most recent translations
-    print 'Build ZIP archive with the latest translations '
+    print 'Building ZIP archive with the latest translations '
     export_translations = @crowdin.export_translations
     if export_translations['success']
       if export_translations['success']['status'] == 'built'
@@ -704,7 +714,7 @@ command :download do |c|
       end
 
       if File.exists?(File.join(@base_path, file['source']))
-        dest = file['source'].sub(/\A#{@base_path}/, '')
+        dest = file['source'].sub(/\A#{Regexp.escape(@base_path)}/, '')
 
         file_translation_languages.each do |lang|
           zipped_file = export_pattern_to_path(dest, file['translation'], lang)
@@ -715,7 +725,7 @@ command :download do |c|
 
       else
         Find.find(@base_path) do |source_path|
-          dest = source_path.sub(/\A#{@base_path}/, '') # relative path in Crowdin
+          dest = source_path.sub(/\A#{Regexp.escape(@base_path)}/, '') # relative path in Crowdin
 
           if File.directory?(source_path)
             if ignores.any? { |pattern| File.fnmatch?(pattern, dest, File::FNM_PATHNAME) }
@@ -762,7 +772,7 @@ command :list do |ls_cmd|
   ls_cmd.desc I18n.t('app.commands.list.commands.project.desc')
   ls_cmd.command :project do |proj_cmd|
     proj_cmd.desc I18n.t('app.commands.list.switches.tree.desc')
-    proj_cmd.switch ['tree'], :negatable => false
+    proj_cmd.switch ['tree'], negatable: false
 
     proj_cmd.action do |global_options, options, args|
       project_info = @crowdin.project_info
@@ -780,7 +790,7 @@ command :list do |ls_cmd|
   ls_cmd.desc I18n.t('app.commands.list.commands.sources.desc')
   ls_cmd.command :sources do |src_cmd|
     src_cmd.desc I18n.t('app.commands.list.switches.tree.desc')
-    src_cmd.switch ['tree'], :negatable => false
+    src_cmd.switch ['tree'], negatable: false
 
     src_cmd.action do |global_options, options, args|
       local_files = []
@@ -806,7 +816,7 @@ command :list do |ls_cmd|
           local_files << local_file
         else
           Find.find(@base_path) do |source_path|
-            dest = source_path.sub(/\A#{@base_path}/, '') # relative path in Crowdin
+            dest = source_path.sub(/\A#{Regexp.escape(@base_path)}/, '') # relative path in Crowdin
 
             if File.directory?(source_path)
               if ignores.any? { |pattern| File.fnmatch?(pattern, dest, File::FNM_PATHNAME) }
@@ -850,7 +860,7 @@ command :list do |ls_cmd|
   ls_cmd.desc I18n.t('app.commands.list.commands.translations.desc')
   ls_cmd.command :translations do |trans_cmd|
     trans_cmd.desc I18n.t('app.commands.list.switches.tree.desc')
-    trans_cmd.switch ['tree'], :negatable => false
+    trans_cmd.switch ['tree'], negatable: false
 
     trans_cmd.action do |global_options, options, args|
       project_info = @crowdin.project_info
@@ -867,7 +877,7 @@ command :list do |ls_cmd|
         ignores = file['ignore'] || []
 
         if File.exists?(File.join(@base_path, file['source']))
-          dest = file['source'].sub(/\A#{@base_path}/, '')
+          dest = file['source'].sub(/\A#{Regexp.escape(@base_path)}/, '')
 
           translation_languages.each do |lang|
             local_file  = export_pattern_to_path(dest, file['translation'], lang, languages_mapping)
@@ -876,7 +886,7 @@ command :list do |ls_cmd|
 
         else
           Find.find(@base_path) do |source_path|
-            dest = source_path.sub(/\A#{@base_path}/, '') # relative path in Crowdin
+            dest = source_path.sub(/\A#{Regexp.escape(@base_path)}/, '') # relative path in Crowdin
 
             if File.directory?(source_path)
               if ignores.any? { |pattern| File.fnmatch?(pattern, dest, File::FNM_PATHNAME) }
@@ -935,70 +945,107 @@ pre do |globals ,command, options, args|
   ]
 
   unless File.exists?(globals[:config])
-    exit_now! <<EOS
-Can't find configuration file (default `crowdin.yaml').
-Type `crowdin-cli help` to know how to specify custom configuration file
+    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
 
-See http://crowdin.com/page/cli-tool#configuration-file for more details
-EOS
-  else
-    begin
-      @config = YAML.load_file(globals[:config]) || {}
-    rescue Psych::SyntaxError => err
-      exit_now! <<EOS
-Could not parse YAML: #{err.message}
-
-We were unable to successfully parse the crowdin.yaml file that you provided - it most likely is not well-formed YAML.
-Please check whether your crowdin.yaml is valid YAML - you can use the http://yamllint.com/ validator to do this - and make any necessary changes to fix it.
-EOS
-    end
+      See http://crowdin.com/page/cli-tool#configuration-file for more details
+    EOS
+  end
+
+  # load project-specific configuration
+  #
+  begin
+    # undocumented feature
+    # you can use ERB in your config file, e.g.
+    # api_key: <%= # ruby code ... %>
+    #
+    @config = YAML.load(ERB.new(File.read(globals[:config])).result) || {}
+  rescue Psych::SyntaxError => err
+    exit_now! <<-EOS.strip_heredoc
+      Could not parse YAML: #{err.message}
+
+      We were unable to successfully parse the crowdin.yaml file that you provided - most likely it is not well-formatted YAML.
+      Please check whether your crowdin.yaml is valid YAML - you can use the http://yamllint.com/ validator to do this - and make any necessary changes to fix it.
+    EOS
+  end
 
-    if File.exists?(globals[:identity])
-      identity = YAML.load_file(globals[:identity]) || {}
-      ['api_key', 'project_identifier', 'base_path'].each do |key|
-        @config[key] = identity[key] if identity[key]
+  # try to load the API credentials from an environment variable, e.g.
+  #
+  # project_identifier_env: 'CROWDIN_PROJECT_ID'
+  # api_key_env: 'CROWDIN_API_KEY'
+  #
+  ['api_key', 'project_identifier'].each do |key|
+    if @config["#{key}_env"]
+      unless @config[key] # project credentials have a higher priority if they are specified in the config
+        @config[key] = ENV[@config["#{key}_env"]]
       end
     end
+  end
 
-    ['api_key', 'project_identifier'].each do |key|
-      unless @config[key]
-        exit_now! <<EOS
-Configuration file misses required option `#{key}`
-
-See http://crowdin.com/page/cli-tool#configuration-file for more details
-EOS
-      end
+  # user credentials in the user-specific config file have a higher priority than project-specific
+  #
+  if File.exists?(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]
     end
+  end
 
-    unless @config['files']
-      exit_now! <<EOS
-Configuration file misses required section `files`
+  ['api_key', 'project_identifier'].each do |key|
+    unless @config[key]
+      exit_now! <<-EOS.strip_heredoc
+        Configuration file misses required option `#{key}`
 
-See http://crowdin.com/page/cli-tool#configuration-file for more details
-EOS
+        See http://crowdin.com/page/cli-tool#configuration-file for more details
+      EOS
     end
   end
 
+  unless @config['files']
+    exit_now! <<-EOS.strip_heredoc
+      Configuration file misses required section `files`
+
+      See https://crowdin.com/page/cli-tool#configuration-file for more details
+    EOS
+  end
+
   @config['files'].each do |file|
+    unless file['source']
+      exit_now! <<-EOS.strip_heredoc
+        Files section misses required parameter `source`
+
+        See https://crowdin.com/page/cli-tool#configuration-file for more details
+      EOS
+    end
+
+    unless file['translation']
+      exit_now! <<-EOS.strip_heredoc
+        Files section misses required parameter `translation`
+
+        See https://crowdin.com/page/cli-tool#configuration-file for more details
+      EOS
+    end
+
     file['source'] = '/' + file['source'] unless file['source'].start_with?('/')
     #file['translation'] = '/' + file['translation'] unless file['translation'].start_with?('/')
 
     if file['source'].include?('**')
       if file['source'].scan('**').size > 1
-        exit_now! <<EOS
-Source pattern `#{file['source']}` is not valid. The mask `**` can be used only once in the source pattern.
-EOS
+        exit_now! <<-EOS.strip_heredoc
+          Source pattern `#{file['source']}` is not valid. The mask `**` can be used only once in the source pattern.
+        EOS
       elsif file['source'].scan('**').size == 1 and !file['source'].match(/\/\*\*\//)
-        exit_now! <<EOS
-Source pattern `#{file['source']}` is not valid. The mask `**` must be surrounded by backslashes `/` in the source pattern.
-EOS
+        exit_now! <<-EOS.strip_heredoc
+          Source pattern `#{file['source']}` is not valid. The mask `**` must be surrounded by slashes `/` in the source pattern.
+        EOS
       end
     else
       if file['translation'].include?('**')
-        exit_now! <<EOS
-Translation pattern `#{file['translation']}` is not valid. The mask `**` can't be used.
-When using `**` in 'translation' pattern it will always contain sub-path from 'source' for certain file.
-EOS
+        exit_now! <<-EOS.strip_heredoc
+          Translation pattern `#{file['translation']}` is not valid. The mask `**` can't be used.
+          When using `**` in 'translation' pattern it will always contain sub-path from 'source' for certain file.
+        EOS
       end
     end
 
@@ -1008,9 +1055,9 @@ EOS
     @base_path = @config['base_path']
   else
     @base_path = Dir.pwd
-    puts <<EOS
-Warning: Configuration file misses parameter `base_path` that defines your project root directory. Using `#{@base_path}` as a root directory.
-EOS
+    puts <<-EOS.strip_heredoc
+      Warning: Configuration file misses parameter `base_path` that defines your project root directory. Using `#{@base_path}` as a root directory.
+    EOS
   end
 
   @preserve_hierarchy = false
@@ -1021,9 +1068,9 @@ EOS
       when false
         false
       else
-        exit_now! <<EOS
-Parameter `preserve_hierarchy` allows values of true or false.
-EOS
+        exit_now! <<-EOS.strip_heredoc
+          Parameter `preserve_hierarchy` allows values of true or false.
+        EOS
     end
   end
 
@@ -1053,7 +1100,7 @@ post do |globals, 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 globals[:verbose]
+  # puts "Executed #{command.name}" if globals[:verbose]
 end
 
 on_error do |exception|

data/lib/crowdin-cli/version.rb

@@ -1,5 +1,5 @@
 module Crowdin
   module CLI
-    VERSION = '0.4.1'
+    VERSION = '0.4.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-cli
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-20 00:00:00.000000000 Z
+date: 2015-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Crowdin CLI.