web_translate_it 2.4.9 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee4e863643d0a26d473d758833bbb905bf5d375de25e0892cae8068d72c5a688
-  data.tar.gz: 8a3f926cb779cfc79a491d9a0085c1c5dc1a624877a503da3b06f1fe3ad1dd90
+  metadata.gz: f01930a3c46a7521f57e14caa623d495f37d81f1e392ceee1d11716e53366f69
+  data.tar.gz: 24f554f5a22af0333e19adbcd846e1e100d789d06be261b28a943851307e5c57
 SHA512:
-  metadata.gz: dc9b48b992ef306e4a4f8955f0fedab83a8f50a8715137cc8e93d0fc7f3552266d15f33a195f6767781c52335f1c8f0d22bf4fc266e1e77feaf810f55647e7c6
-  data.tar.gz: c2f83a87eb83ff79c4c6753bdcab18bd80aa5db17970b33a065b6267afb2b63e794e7c001a7aabddc883527d219b319392cc2e8e7d36511c35640cc1866e3736
+  metadata.gz: 65aa66ec8c8b70c937c18de52857e8d2a54835847b147ea2b9c8e07e761ea8ef262b1af6db87be42ee6b41c36b94eaee1748f677e36dacb453e27e84e4710f7d
+  data.tar.gz: 47d4c899f44bb80f04d695a0365fe2acd9948b3cfac8eec936ce9df44c846a4659fcbd34e1023aab686ac2b51ec3ed39f0e68ff84e3852484745ae905b058533

data/bin/wti

@@ -14,18 +14,18 @@ The most commonly used wti commands are:
    match       Display matching of local files with File Manager
    add         Create and push a new master language file
    rm          Delete a master language file from a project
+   mv          Moves a file both locally and from a project
    addlocale   Add a new locale to the project
    rmlocale    Delete a locale from a project
    status      Fetch and display project statistics
    init        Configure your project to sync
-   configuser  Configure your user email
 
 See `wti <command> --help` for more information on a specific command.
 
 [options] are:
 EOS
 
-SUB_COMMANDS = %w(pull push match add addlocale status st init configuser)
+SUB_COMMANDS = %w(pull push match add rm mv addlocale rmlocale status st init)
 global_options = Optimist::options do
   stop_on SUB_COMMANDS
   banner show_commands
@@ -40,10 +40,10 @@ command_options = case command
 wti pull [filename] - Pull target language file(s)
 [options] are:
 EOS
-      opt :locale, "ISO code of locale(s) to pull", :type => :string
+      opt :locale, "ISO code of locale(s) to pull, space-separated", type: :string
       opt :all,    "Pull all files"
       opt :force,  "Force pull (bypass conditional requests to WTI)"
-      opt :config, "Path to a configuration file", :short => "-c", :default => ".wti"
+      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
       opt :debug,  "Display debug information"
     end
   when "push"
@@ -52,15 +52,15 @@ EOS
 wti push [filename] - Push master language file(s)
 [options] are:
 EOS
-      opt :locale, "ISO code of locale(s) to push", :type => :string
+      opt :locale, "ISO code of locale(s) to push, space-separated", type: :string
       opt :target, "Upload all target files"
       opt :force,  "Force push (bypass conditional requests to WTI)"
       opt :low_priority, "WTI will process this file with a low priority"
       opt :merge,  "Force WTI to merge this file"
       opt :ignore_missing, "Force WTI to not obsolete missing strings"
       opt :minor, "Minor Changes. When pushing a master file, prevents target translations to be flagged as `to_verify`."
-      opt :label,  "Apply a label to the changes", :type => :string
-      opt :config, "Path to a configuration file", :short => "-c", :default => ".wti"
+      opt :label,  "Apply a label to the changes", type: :string
+      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
       opt :all,    "DEPRECATED -- See `wti push --target` instead"
       opt :debug,  "Display debug information"
     end
@@ -68,48 +68,49 @@ EOS
     Optimist::options do
       banner "wti add filename - Create and push a new master language file"
       opt :low_priority, "WTI will process this file with a low priority"
-      opt :config, "Path to a configuration file", :short => "-c", :default => ".wti"
+      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
       opt :debug,  "Display debug information"
     end
   when "rm"
     Optimist::options do
       banner "wti rm filename - Delete a master language file"
-      opt :config, "Path to a configuration file", :short => "-c", :default => ".wti"
+      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
       opt :debug,  "Display debug information"
     end
+  when "mv"
+    Optimist::options do
+      banner "wti mv filename - Moves a master language file and its target files"
+      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
+      opt :debug, "Display debug information"
+    end
   when "addlocale"
     Optimist::options do
       banner "wti addlocale localename - Add a new locale to the project"
-      opt :config, "Path to a configuration file", :short => "-c", :default => ".wti"
+      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
       opt :debug,  "Display debug information"
     end
   when "rmlocale"
     Optimist::options do
       banner "wti rmlocale localename Delete a locale from the project"
-      opt :config, "Path to a configuration file", :short => "-c", :default => ".wti"
+      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
       opt :debug,  "Display debug information"
     end
   when "status"
     Optimist::options do
-      banner "wti status - Fetch and display project statistics"
-      opt :config, "Path to a configuration file", :short => "-c", :default => ".wti"
+      banner "wti status - Fetch and display project statistics.\nReturns 100 if untranslated segments exist in project\nReturns 101 if unproofread segments exist in project."
+      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
       opt :debug,  "Display debug information"
     end
   when "init"
     Optimist::options do
       banner "wti init [api_token] - Configure your project to sync"
-      opt :config, "Path to a configuration file", :short => "-c", :default => ".wti"
-      opt :debug,  "Display debug information"
-    end
-  when "configuser"
-    Optimist::options do
-      banner "wti configuser - Configure your user email"
+      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
       opt :debug,  "Display debug information"
     end
   when "match"
     Optimist::options do
       banner "wti match - Display matching of local files with File Manager"
-      opt :config, "Path to a configuration file", :short => "-c", :default => ".wti"
+      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
       opt :debug,  "Display debug information"
     end
   else
@@ -128,4 +129,3 @@ rescue Interrupt => e
   puts StringUtil.failure("\nQuitting...")
   exit 1
 end
- 

data/history.md

@@ -1,3 +1,39 @@
+## Version 2.5.0 / 2021-11-15
+
+* Display files that are being updated on WebTranslateIt but are not ready to be downloaded by a `*`.
+
+``` bash
+~/Desktop/test% wti pull 
+# Pulling files on test 3
+*cs-CZ.de.yml                                       | 65a7fc8..65a7fc8  Skipped
+ en.yml                                             | ffd8096..ffd8096  Skipped
+ i18nextv4.de.json                                  | 142aca7..142aca7  Skipped
+*cs-CZ.yml                                          | 42c32a3..42c32a3  Skipped
+ de.yml                                             | 9dda491..9dda491  Skipped
+ test.de.json                                       | 48a9c13..48a9c13  Skipped
+ test.de.txt                                        | 8f305f3..8f305f3  Skipped
+ test.json                                          | 7a9478f..7a9478f  Skipped
+ i18nextv4.json                                     | 84d6cdf..8776cb3  OK
+ test.txt                                           | 8f305f3..7a1a5db  OK
+```
+* Improve help on `wti status` documentation.
+
+## Version 2.4.12 / 2021-06-30
+
+* Add ability to pass project API token as an ENV variable. You can run:
+  `export WTI_PROJECT_API_KEY=[my_api_token]`
+  `wti pull`
+
+## Version 2.4.11 / 2019-10-22
+
+* Fix for `wti pull` without parameters.
+
+## Version 2.4.10 / 2019-10-21
+
+* New command: `wti mv path/to/file.po newpath/to/file.po` to move a language file
+  both on your local working directory and on your WebTranslateIt project.
+* Fix: `wti pull something` now doesn’t pull anything if no files match what needs to be pulled. Close #151.
+
 ## Version 2.4.9 / 2019-08-07
 
 * Fix issue referencing old `Trollop` library. #149

data/lib/web_translate_it/command_line.rb

@@ -18,6 +18,8 @@ module WebTranslateIt
           message = "Creating master files"
         when 'rm'
           message = "Deleting files"
+        when 'mv'
+          message = "Moving files"
         when 'addlocale'
           message = "Adding locale"
         when 'rmlocale'
@@ -44,7 +46,7 @@ module WebTranslateIt
       parameters.each do |parameter|
         found_files += files.find_all{ |file| File.fnmatch(parameter, file.file_path) }
       end
-      files = found_files if found_files.any?
+      files = found_files if parameters.any?
       files = files.uniq.sort{ |a,b| a.file_path <=> b.file_path }
       if files.size == 0
         puts "No files to pull."
@@ -111,7 +113,7 @@ module WebTranslateIt
         to_add = parameters.reject{ |param| added.include?(File.expand_path(param))}
         if to_add.any?
           to_add.each do |param|
-            file = TranslationFile.new(nil, param, nil, configuration.api_key)
+            file = TranslationFile.new(nil, param.gsub(/ /, "\\ "), nil, configuration.api_key)
             success = file.create(http, command_options.low_priority)
             complete_success = false if !success
           end
@@ -127,26 +129,77 @@ module WebTranslateIt
       STDOUT.sync = true
       if parameters == []
         puts StringUtil.failure("Error: You must provide the path to the master file to remove.")
-        puts "Usage: wti path/to/rm master_file_1 path/to/master_file_2 ..."
+        puts "Usage: wti rm path/to/master_file_1 path/to/master_file_2 ..."
         exit
       end
       WebTranslateIt::Connection.new(configuration.api_key) do |http|
         parameters.each do |param|
           if Util.ask_yes_no("Are you sure you want to delete the master file #{param}?\nThis will also delete its target files and translations.", false)
-            configuration.files.find_all{ |file| file.file_path == param }.each do |master_file|
-              master_file.delete(http)
-              # delete files
-              success = File.delete(master_file.file_path) if File.exists?(master_file.file_path)
-              complete_success = false if !success
-              configuration.files.find_all{ |file| file.master_id == master_file.id }.each do |target_file|
-                success = File.delete(target_file.file_path) if File.exists?(target_file.file_path)
+            files = configuration.files.find_all{ |file| file.file_path == param }
+            if files.any?
+              files.each do |master_file|
+                master_file.delete(http)
+                # delete files
+                if File.exists?(master_file.file_path)
+                  success = File.delete(master_file.file_path)
+                  puts StringUtil.success("Deleted master file #{master_file.file_path}.") if success
+                end
                 complete_success = false if !success
+                configuration.files.find_all{ |file| file.master_id == master_file.id }.each do |target_file|
+                  if File.exists?(target_file.file_path)
+                    success = File.delete(target_file.file_path)
+                    puts StringUtil.success("Deleted target file #{target_file.file_path}.") if success
+                  else
+                    puts StringUtil.failure("Target file #{target_file.file_path} doesn’t exist locally")
+                  end
+                  complete_success = false if !success
+                end
               end
+              puts StringUtil.success("All done.") if complete_success
+            else
+              puts StringUtil.failure("#{param}: File doesn’t exist on project.")
+            end
+          end
+        end
+      end
+      complete_success
+    end
+    
+    def mv
+      complete_success = true
+      STDOUT.sync = true
+      if parameters.count != 2
+        puts StringUtil.failure("Error: You must provide the source path and destination path of the master file to move.")
+        puts "Usage: wti mv path/to/master_file_old_path path/to/master_file_new_path ..."
+        exit
+      end
+      source = parameters[0]
+      destination = parameters[1]
+      WebTranslateIt::Connection.new(configuration.api_key) do |http|
+        if Util.ask_yes_no("Are you sure you want to move the master file #{source} and its target files?", true)
+          configuration.files.find_all{ |file| file.file_path == source }.each do |master_file|
+            master_file.upload(http, false, false, nil, false, false, true, true, destination)
+            # move master file
+            if File.exists?(source)
+              success = File.rename(source, destination) if File.exists?(source)
+              puts StringUtil.success("Moved master file #{master_file.file_path}.") if success
+            end
+            complete_success = false if !success
+            configuration.files.find_all{ |file| file.master_id == master_file.id }.each do |target_file|
+              if File.exists?(target_file.file_path)
+                success = File.delete(target_file.file_path)
+                complete_success = false if !success
+              end
+            end
+            configuration.reload
+            configuration.files.find_all{ |file| file.master_id == master_file.id }.each do |target_file|
+              success = target_file.fetch(http)
+              complete_success = false if !success
             end
+            puts StringUtil.success("All done.") if complete_success
           end
         end
       end
-      puts StringUtil.success("Master file deleted.")
       complete_success
     end
     

data/lib/web_translate_it/configuration.rb

@@ -20,7 +20,7 @@ module WebTranslateIt
       self.path           = root_path
       self.logger         = logger
       if File.exists?(File.expand_path(path_to_config_file, self.path))
-        self.api_key        = configuration['api_key']
+        self.api_key        = ENV["WTI_PROJECT_API_KEY"] || configuration['api_key']
         self.before_pull    = configuration['before_pull']
         self.after_pull     = configuration['after_pull']
         self.before_push    = configuration['before_push']
@@ -33,11 +33,23 @@ module WebTranslateIt
         WebTranslateIt::Connection.turn_silent_on if configuration['silence_errors']
         self.project_name = project_info['project']['name']
       else
-        puts StringUtil.failure("\nCan't find a configuration file in #{File.expand_path(path_to_config_file, self.path)}")
+        puts StringUtil.failure("\nNo configuration file found in #{File.expand_path(path_to_config_file, self.path)}")
         exit(1)
       end
     end
     
+    # Reload project data
+    #
+    def reload
+      project_info = YAML.load WebTranslateIt::Project.fetch_info(self.api_key)
+      set_locales_to_ignore(configuration)
+      set_locales_needed(configuration)
+      set_files(project_info['project'])
+      set_locales(project_info['project'])
+      WebTranslateIt::Connection.turn_silent_on if configuration['silence_errors']
+      self.project_name = project_info['project']['name']
+    end
+    
     # Set the project locales from the Project API.
     # Implementation example:
     #
@@ -59,7 +71,7 @@ module WebTranslateIt
         if project_file['name'].nil? or project_file['name'].strip == ''
           puts "File #{project_file['id']} not set up"
         else
-          self.files.push TranslationFile.new(project_file['id'], project_file['name'], project_file['locale_code'], self.api_key, project_file['updated_at'], project_file['hash_file'], project_file['master_project_file_id'])
+          self.files.push TranslationFile.new(project_file['id'], project_file['name'], project_file['locale_code'], self.api_key, project_file['updated_at'], project_file['hash_file'], project_file['master_project_file_id'], project_file['fresh'])
         end
       end
     end

data/lib/web_translate_it/translation_file.rb

@@ -12,9 +12,9 @@ module WebTranslateIt
     require 'time'
     require 'fileutils'
     
-    attr_accessor :id, :file_path, :locale, :api_key, :updated_at, :remote_checksum, :master_id
+    attr_accessor :id, :file_path, :locale, :api_key, :updated_at, :remote_checksum, :master_id, :fresh
     
-    def initialize(id, file_path, locale, api_key, updated_at = nil, remote_checksum = "", master_id = nil)
+    def initialize(id, file_path, locale, api_key, updated_at = nil, remote_checksum = "", master_id = nil, fresh = nil)
       self.id         = id
       self.file_path  = file_path
       self.locale     = locale
@@ -22,6 +22,7 @@ module WebTranslateIt
       self.updated_at = updated_at
       self.remote_checksum = remote_checksum
       self.master_id  = master_id
+      self.fresh      = fresh
     end
     
     # Fetch a language file.
@@ -40,7 +41,11 @@ module WebTranslateIt
       success = true
       tries ||= 3
       display = []
-      display.push(self.file_path)
+      if self.fresh
+        display.push(self.file_path)
+      else
+        display.push("*#{self.file_path}")
+      end
       display.push "#{StringUtil.checksumify(self.local_checksum.to_s)}..#{StringUtil.checksumify(self.remote_checksum.to_s)}"
       if !File.exist?(self.file_path) or force or self.remote_checksum != self.local_checksum
         begin
@@ -82,7 +87,7 @@ module WebTranslateIt
     #
     # Note that the request might or might not eventually be acted upon, as it might be disallowed when processing
     # actually takes place. This is due to the fact that language file imports are handled by background processing.
-    def upload(http_connection, merge=false, ignore_missing=false, label=nil, low_priority=false, minor_changes=false, force=false)
+    def upload(http_connection, merge=false, ignore_missing=false, label=nil, low_priority=false, minor_changes=false, force=false, rename_others=false, destination_path=nil)
       success = true
       tries ||= 3
       display = []
@@ -92,7 +97,10 @@ module WebTranslateIt
 	      if force or self.remote_checksum != self.local_checksum
           File.open(self.file_path) do |file|
             begin
-              request = Net::HTTP::Put::Multipart.new(api_url, {"file" => UploadIO.new(file, "text/plain", file.path), "merge" => merge, "ignore_missing" => ignore_missing, "label" => label, "low_priority" => low_priority, "minor_changes" => minor_changes })
+              params = {"file" => UploadIO.new(file, "text/plain", file.path), "merge" => merge, "ignore_missing" => ignore_missing, "label" => label, "low_priority" => low_priority, "minor_changes" => minor_changes }
+              params["name"] = destination_path unless destination_path.nil?
+              params["rename_others"] = rename_others
+              request = Net::HTTP::Put::Multipart.new(api_url, params)
               WebTranslateIt::Util.add_fields(request)
               display.push Util.handle_response(http_connection.request(request))
             rescue Timeout::Error
@@ -113,7 +121,7 @@ module WebTranslateIt
         end
         puts ArrayUtil.to_columns(display)
       else
-        puts StringUtil.failure("Can't push #{self.file_path}. File doesn't exist.")
+        puts StringUtil.failure("Can't push #{self.file_path}. File doesn't exist locally.")
       end
       return success
     end
@@ -156,7 +164,7 @@ module WebTranslateIt
           end
         end
       else
-        puts StringUtil.failure("\nFile #{self.file_path} doesn't exist!")
+        puts StringUtil.failure("\nFile #{self.file_path} doesn't exist locally!")
       end
       return success
     end
@@ -169,27 +177,25 @@ module WebTranslateIt
       display = []
       display.push file_path
       if File.exists?(self.file_path)
-        File.open(self.file_path) do |file|
-          begin
-            request = Net::HTTP::Delete.new(api_url_for_delete)
-            WebTranslateIt::Util.add_fields(request)
-            display.push Util.handle_response(http_connection.request(request))
-            puts ArrayUtil.to_columns(display)
-          rescue Timeout::Error
-            puts StringUtil.failure("Request timeout. Will retry in 5 seconds.")
-            if (tries -= 1) > 0
-              sleep(5)
-              retry
-            else
-              success = false
-            end
-          rescue
-            display.push StringUtil.failure("An error occured: #{$!}")
+        begin
+          request = Net::HTTP::Delete.new(api_url_for_delete)
+          WebTranslateIt::Util.add_fields(request)
+          display.push Util.handle_response(http_connection.request(request))
+          puts ArrayUtil.to_columns(display)
+        rescue Timeout::Error
+          puts StringUtil.failure("Request timeout. Will retry in 5 seconds.")
+          if (tries -= 1) > 0
+            sleep(5)
+            retry
+          else
             success = false
           end
+        rescue
+          display.push StringUtil.failure("An error occured: #{$!}")
+          success = false
         end
       else
-        puts StringUtil.failure("\nFile #{self.file_path} doesn't exist!")
+        puts StringUtil.failure("\nMaster file #{self.file_path} doesn't exist locally!")
       end
       return success
     end

data/lib/web_translate_it/util/array_util.rb

@@ -1,6 +1,10 @@
 class ArrayUtil
   def self.to_columns(arr)
-    " #{StringUtil.backward_truncate(arr[0])} | #{arr[1]}  #{arr[2]}\n"
+    if arr[0][0] == "*"
+      "*#{StringUtil.backward_truncate(arr[0][1..-1])} | #{arr[1]}  #{arr[2]}\n"
+    else
+      " #{StringUtil.backward_truncate(arr[0])} | #{arr[1]}  #{arr[2]}\n"
+    end
   end
 
   def self.chunk(arr, pieces=2)

data/license

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2009-2014 Atelier Convivialite
+Copyright (c) 2009-2019 WebTranslateIt Software S.L
 
 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

data/readme.md

@@ -7,7 +7,7 @@
 
 wti lets you easily sync your language files with [WebTranslateIt.com](https://webtranslateit.com), a web-based tool to translation software.
 
-<img src="https://s3.amazonaws.com/f.cl.ly/items/27192V1K263K2O433h2g/webtranslateit_com_%E2%80%94_edouard_Edouards-MacBook-Pro-2____code_webtranslateit_com_%E2%80%94___anslateit_com_%E2%80%94_zsh_%E2%80%94_80%C3%9740.png" alt="WebTranslateIt Synchronization Tool" width="500px">
+<img src="http://edouard.baconfile.com.s3.us-east-1.amazonaws.com/web_translate_it/wti4.png" alt="WebTranslateIt Synchronization Tool" width="500px">
 
 ### wti...
 
@@ -276,4 +276,4 @@ fr: 100% translated, 100% completed.
 
 # License
 
-Copyright (c) 2009-2018 Atelier Convivialité, released under the MIT License.
+Copyright (c) 2009-2021 WebTranslateIt Software S.L, released under the MIT License.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web_translate_it
 version: !ruby/object:Gem::Version
-  version: 2.4.9
+  version: 2.5.0
 platform: ruby
 authors:
 - Edouard Briere
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-07 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -124,7 +124,7 @@ homepage: https://webtranslateit.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - readme.md
@@ -141,9 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: A CLI to sync locale files with WebTranslateIt.com.
 test_files: