web_translate_it 2.6.3 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b4f8260eedb1c889b34365fbb4d5e5f00b4907c52068a5f9ee1271eac7e0aa8
-  data.tar.gz: b872158814a7a958c873ddb603651b14aab8a2809c5ee42fbc7398d01fe71218
+  metadata.gz: 6cef77421b30d347178a38e6fe50300e44d41a2c47fe46736ad79d76bc891374
+  data.tar.gz: e3d93cec2762262b06a8eb5aa2f71a901eb5ba77ff09b1e2f85462f765617501
 SHA512:
-  metadata.gz: 2e71ac4f5c76fb436583cd10b1f2092528eb5204a4b777a97b611eff2e55600c07f192c4844794d20c8e5dc800af5e0c73d308f074dc643917173efd5a0703e6
-  data.tar.gz: 5955c786b2a7f69f55e9ac9126d0a4637a4ecb9e286b9d810efdb1a5c58450cf183dee71601eb35454798c244c8d098f8af635e25988a4a1b30935e8eeb5fc11
+  metadata.gz: 154b48ea91ca07bc107ff3b551678bf152a791db84432be020d1e3f3444c7f0830f303f5a222947fdbf1178638648df973f1c2ff8755c8db30e22c8916808c75
+  data.tar.gz: 1bbf7533a388aeec98f9d0541c1839d95d18ed99d0cf2ccb4bb6400cb0852ddd8d98d04e4d29315b55c05790e70095db5d5a418ac47a1b47234ca84da495cf5b

data/bin/wti

@@ -34,93 +34,93 @@ end
 
 command = ARGV.shift # get the subcommand
 command_options = case command
-                  when 'pull'
-                    Optimist.options do
-                      banner <<~BANNER
-                        wti pull [filename] - Pull target language file(s)
-                        [options] are:
-                      BANNER
-                      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 :debug,  'Display debug information'
-                    end
-                  when 'push'
-                    Optimist.options do
-                      banner <<~BANNER
-                        wti push [filename] - Push master language file(s)
-                        [options] are:
-                      BANNER
-                      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 :all,    'DEPRECATED -- See `wti push --target` instead'
-                      opt :debug,  'Display debug information'
-                    end
-                  when 'add'
-                    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 :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 :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 :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 :debug,  'Display debug information'
-                    end
-                  when 'status'
-                    Optimist.options do
-                      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 '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 :debug,  'Display debug information'
-                    end
-                  else
-                    if command.nil?
-                      puts show_commands
-                      exit
-                    else
-                      Optimist.die "Unknown subcommand #{command.inspect}"
-                    end
-                  end
+when 'pull'
+  Optimist.options do
+    banner <<~BANNER
+      wti pull [filename] - Pull target language file(s)
+      [options] are:
+    BANNER
+    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 :debug,  'Display debug information'
+  end
+when 'push'
+  Optimist.options do
+    banner <<~BANNER
+      wti push [filename] - Push master language file(s)
+      [options] are:
+    BANNER
+    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 :all,    'DEPRECATED -- See `wti push --target` instead'
+    opt :debug,  'Display debug information'
+  end
+when 'add'
+  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 :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 :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 :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 :debug,  'Display debug information'
+  end
+when 'status'
+  Optimist.options do
+    banner "wti status [filename] - 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 '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 :debug,  'Display debug information'
+  end
+else
+  if command.nil?
+    puts show_commands
+    exit
+  else
+    Optimist.die "Unknown subcommand #{command.inspect}"
+  end
+end
 
 begin
   WebTranslateIt::Connection.turn_debug_on if command_options.debug

data/examples/locale.rb

@@ -1,4 +1,5 @@
 class Locale
+
   def initialize(app)
     @app = app
   end
@@ -9,4 +10,5 @@ class Locale
     status, headers, response = @app.call(env)
     [status, headers, response]
   end
+
 end

data/generators/webtranslateit/webtranslateit_generator.rb

@@ -1,6 +1,7 @@
 require File.expand_path("#{File.dirname(__FILE__)}/lib/insert_commands.rb")
 
 class WebtranslateitGenerator < Rails::Generator::Base
+
   def add_options!(opt)
     opt.on('-k', '--api-key=key', String, 'Your Web Translate It API key') { |v| options[:api_key] = v }
   end
@@ -14,7 +15,7 @@ class WebtranslateitGenerator < Rails::Generator::Base
       if options[:api_key]
         project_details = YAML.load WebTranslateIt::Project.fetch_info(options[:api_key])
         m.template '.wti', '.wti',
-                   assigns: { api_key: options[:api_key], project: project_details['project'] }
+                   assigns: {api_key: options[:api_key], project: project_details['project']}
         m.append_to 'Rakefile', "require 'web_translate_it' rescue LoadError"
       end
     end
@@ -23,4 +24,5 @@ class WebtranslateitGenerator < Rails::Generator::Base
   def api_key_configured?
     File.exist?('config/translations.yml')
   end
+
 end

data/history.md

@@ -1,3 +1,16 @@
+## Version 2.7.0 / 2022-10-10
+
+* New: Ability to see translation statistics per file.
+  - `wti status` gives the whole translation project statistics.
+  - `wti status path/to/file` gives the file translation statistics.
+* Update readme file (installation instructions and add link to Docker package).
+* Fix Rspec ExampleWording offences.
+
+## Version 2.6.4 / 2022-09-22
+
+* Move development dependencies to Gemfile and commit Gemfile.lock to version control.
+* wti now sends a `User-Agent` header.
+
 ## Version 2.6.3 / 2022-06-14
 
 * Fix deprecation warning. #181

data/lib/web_translate_it/auto_fetch.rb

@@ -1,4 +1,5 @@
 module WebTranslateIt
+
   # Class to automatically fetch the last translations from Web Translate It
   # for every page requested.
   # This can be used as a rack middleware.
@@ -8,6 +9,7 @@ module WebTranslateIt
   #   config.middleware.use "WebTranslateIt::AutoFetch"
   #
   class AutoFetch
+
     def initialize(app)
       @app = app
     end
@@ -27,5 +29,7 @@ module WebTranslateIt
     def valid_request?(env)
       env['PATH_INFO'] !~ /\.(js|css|jpeg|jpg|gif|png|woff)$/
     end
+
   end
+
 end

data/lib/web_translate_it/command_line.rb

@@ -1,31 +1,33 @@
 module WebTranslateIt
+
   class CommandLine # rubocop:todo Metrics/ClassLength
+
     require 'fileutils'
     require 'set'
     attr_accessor :configuration, :global_options, :command_options, :parameters
 
-    def initialize(command, command_options, global_options, parameters, project_path) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/MethodLength
+    def initialize(command, command_options, _global_options, parameters, project_path) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/MethodLength
       self.command_options = command_options
       self.parameters = parameters
       unless command == 'init'
         message = case command
-                  when 'pull'
-                    'Pulling files'
-                  when 'push'
-                    'Pushing files'
-                  when 'add'
-                    'Creating master files'
-                  when 'rm'
-                    'Deleting files'
-                  when 'mv'
-                    'Moving files'
-                  when 'addlocale'
-                    'Adding locale'
-                  when 'rmlocale'
-                    'Deleting locale'
-                  else
-                    'Gathering information'
-                  end
+        when 'pull'
+          'Pulling files'
+        when 'push'
+          'Pushing files'
+        when 'add'
+          'Creating master files'
+        when 'rm'
+          'Deleting files'
+        when 'mv'
+          'Moving files'
+        when 'addlocale'
+          'Adding locale'
+        when 'rmlocale'
+          'Deleting locale'
+        else
+          'Gathering information'
+        end
         throb do
           print "  #{message}"
           self.configuration = WebTranslateIt::Configuration.new(project_path, configuration_file_path)
@@ -107,10 +109,10 @@ module WebTranslateIt
       WebTranslateIt::Connection.new(configuration.api_key) do |http|
         fetch_locales_to_push(configuration).each do |locale|
           files = if parameters.any?
-                    configuration.files.find_all { |file| parameters.include?(file.file_path) }.sort { |a, b| a.file_path <=> b.file_path }
-                  else
-                    configuration.files.find_all { |file| file.locale == locale }.sort { |a, b| a.file_path <=> b.file_path }
-                  end
+            configuration.files.find_all { |file| parameters.include?(file.file_path) }.sort { |a, b| a.file_path <=> b.file_path }
+          else
+            configuration.files.find_all { |file| file.locale == locale }.sort { |a, b| a.file_path <=> b.file_path }
+          end
           if files.empty?
             puts "Couldn't find any local files registered on WebTranslateIt to push."
           else
@@ -295,10 +297,10 @@ module WebTranslateIt
       end
       FileUtils.mkpath(path.split('/')[0..path.split('/').size - 2].join('/')) unless path.split('/').size == 1
       project = if RUBY_VERSION >= '3.1'
-                  YAML.safe_load WebTranslateIt::Project.fetch_info(api_key), permitted_classes: [Time]
-                else
-                  YAML.load WebTranslateIt::Project.fetch_info(api_key)
-                end
+        YAML.safe_load WebTranslateIt::Project.fetch_info(api_key), permitted_classes: [Time]
+      else
+        YAML.load WebTranslateIt::Project.fetch_info(api_key)
+      end
       project_info = project['project']
       if File.exist?(path) && !File.writable?(path)
         puts StringUtil.failure("Error: `#{path}` file is not writable.")
@@ -351,8 +353,15 @@ module WebTranslateIt
       true
     end
 
-    def status # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
-      stats = YAML.load(Project.fetch_stats(configuration.api_key))
+    def status # rubocop:todo Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      if parameters.any?
+        file = configuration.files.find { |f| parameters.first.strip == f.file_path }
+        abort "File '#{parameters.first}' not found." unless file
+
+        file_id = file.master_id || file.id
+        puts "Statistics for '#{parameters.first}':"
+      end
+      stats = YAML.load(Project.fetch_stats(configuration.api_key, file_id))
       completely_translated = true
       completely_proofread  = true
       stats.each do |locale, values|
@@ -470,5 +479,7 @@ module WebTranslateIt
         puts "\r\e[0G#\e[?25h"
       end
     end
+
   end
+
 end

data/lib/web_translate_it/configuration.rb

@@ -1,4 +1,5 @@
 module WebTranslateIt
+
   # Handles the configuration of your project, both via the the configuration file
   # and via the API.
   # Implementation example, assuming you have a valid .wti file:
@@ -6,6 +7,7 @@ module WebTranslateIt
   #   configuration = WebTranslateIt::Configuration.new
   #
   class Configuration
+
     require 'yaml'
     require 'fileutils'
     require 'erb'
@@ -24,10 +26,10 @@ module WebTranslateIt
         self.after_push     = configuration['after_push']
         self.ignore_files   = configuration['ignore_files']
         project_info = if RUBY_VERSION >= '3.1.0'
-                         YAML.safe_load WebTranslateIt::Project.fetch_info(api_key), permitted_classes: [Time]
-                       else
-                         YAML.load WebTranslateIt::Project.fetch_info(api_key)
-                       end
+          YAML.safe_load WebTranslateIt::Project.fetch_info(api_key), permitted_classes: [Time]
+        else
+          YAML.load WebTranslateIt::Project.fetch_info(api_key)
+        end
         set_locales_to_ignore(configuration)
         set_locales_needed(configuration)
         set_files(project_info['project'])
@@ -116,5 +118,7 @@ module WebTranslateIt
     def parse_erb_in_configuration
       ERB.new(File.read(File.expand_path(path_to_config_file, path))).result
     end
+
   end
+
 end

data/lib/web_translate_it/connection.rb

@@ -1,6 +1,8 @@
 require 'English'
 module WebTranslateIt
+
   class Connection
+
     attr_reader :api_key, :http_connection
 
     require 'net/http'
@@ -55,5 +57,7 @@ module WebTranslateIt
     def self.turn_debug_on
       @debug = true
     end
+
   end
+
 end

data/lib/web_translate_it/project.rb

@@ -1,6 +1,8 @@
 require 'English'
 module WebTranslateIt
+
   class Project
+
     def self.fetch_info(api_key) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       success = true
       tries ||= 3
@@ -29,12 +31,13 @@ module WebTranslateIt
       success
     end
 
-    def self.fetch_stats(api_key) # rubocop:todo Metrics/MethodLength
+    def self.fetch_stats(api_key, file_id = nil) # rubocop:todo Metrics/MethodLength
+      url = file_id.nil? ? "/api/projects/#{api_key}/stats.yaml" : "/api/projects/#{api_key}/stats.yaml?file=#{file_id}"
       success = true
       tries ||= 3
       begin
         WebTranslateIt::Connection.new(api_key) do |http|
-          request = Net::HTTP::Get.new("/api/projects/#{api_key}/stats.yaml")
+          request = Net::HTTP::Get.new(url)
           WebTranslateIt::Util.add_fields(request)
           return Util.handle_response(http.request(request), true)
         end
@@ -56,7 +59,7 @@ module WebTranslateIt
       begin
         request = Net::HTTP::Post.new("/api/projects/#{Connection.api_key}/locales")
         WebTranslateIt::Util.add_fields(request)
-        request.set_form_data({ 'id' => locale_code }, ';')
+        request.set_form_data({'id' => locale_code}, ';')
         Util.handle_response(Connection.http_connection.request(request), true)
       rescue Timeout::Error
         puts 'Request timeout. Will retry in 5 seconds.'
@@ -88,5 +91,7 @@ module WebTranslateIt
       end
       success
     end
+
   end
+
 end

data/lib/web_translate_it/string.rb

@@ -1,5 +1,7 @@
 module WebTranslateIt
+
   class String # rubocop:todo Metrics/ClassLength
+
     require 'multi_json'
 
     attr_accessor :id, :key, :plural, :type, :dev_comment, :word_count, :status, :category, :labels, :file,
@@ -265,7 +267,7 @@ module WebTranslateIt
       success
     end
 
-    def to_json(with_translations = false) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+    def to_json(with_translations = false) # rubocop:todo Metrics/AbcSize
       hash = {
         'id' => id,
         'key' => key,
@@ -278,12 +280,14 @@ module WebTranslateIt
         'file' => file
       }
       if translations.any? && with_translations
-        hash.update({ 'translations' => [] })
+        hash.update({'translations' => []})
         translations.each do |translation|
           hash['translations'].push(translation.to_hash)
         end
       end
       MultiJson.dump(hash)
     end
+
   end
+
 end

data/lib/web_translate_it/term.rb

@@ -1,5 +1,7 @@
 module WebTranslateIt
+
   class Term # rubocop:todo Metrics/ClassLength
+
     require 'net/https'
     require 'multi_json'
 
@@ -255,19 +257,21 @@ module WebTranslateIt
       success
     end
 
-    def to_json(with_translations = false) # rubocop:todo Metrics/MethodLength
+    def to_json(with_translations = false)
       hash = {
         'id' => id,
         'text' => text,
         'description' => description
       }
       if translations.any? && with_translations
-        hash.update({ 'translations' => [] })
+        hash.update({'translations' => []})
         translations.each do |translation|
           hash['translations'].push(translation.to_hash)
         end
       end
       MultiJson.dump(hash)
     end
+
   end
+
 end

data/lib/web_translate_it/term_translation.rb

@@ -1,5 +1,7 @@
 module WebTranslateIt
+
   class TermTranslation
+
     require 'net/https'
     require 'multi_json'
 
@@ -98,5 +100,7 @@ module WebTranslateIt
       end
       success
     end
+
   end
+
 end

data/lib/web_translate_it/translation.rb

@@ -1,5 +1,7 @@
 module WebTranslateIt
+
   class Translation
+
     require 'net/https'
     require 'multi_json'
 
@@ -63,5 +65,7 @@ module WebTranslateIt
     def to_json(*_args)
       MultiJson.dump(to_hash)
     end
+
   end
+
 end

data/lib/web_translate_it/translation_file.rb

@@ -1,4 +1,5 @@
 module WebTranslateIt
+
   # A TranslationFile is the representation of a master language file
   # on Web Translate It.
   #
@@ -6,6 +7,7 @@ module WebTranslateIt
   # If you pass a Locale to the master language file you will be able to
   # manipulate a _target_ language file.
   class TranslationFile # rubocop:todo Metrics/ClassLength
+
     require 'net/https'
     require 'net/http/post/multipart'
     require 'time'
@@ -99,7 +101,7 @@ module WebTranslateIt
       if File.exist?(file_path)
         if force || (remote_checksum != local_checksum)
           File.open(file_path) do |file|
-            params = { 'file' => Multipart::Post::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' => Multipart::Post::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)
@@ -150,7 +152,7 @@ module WebTranslateIt
       display.push "#{StringUtil.checksumify(local_checksum.to_s)}..[     ]"
       if File.exist?(file_path)
         File.open(file_path) do |file|
-          request = Net::HTTP::Post::Multipart.new(api_url_for_create, { 'name' => file_path, 'file' => Multipart::Post::UploadIO.new(file, 'text/plain', file.path), 'low_priority' => low_priority })
+          request = Net::HTTP::Post::Multipart.new(api_url_for_create, {'name' => file_path, 'file' => Multipart::Post::UploadIO.new(file, 'text/plain', file.path), 'low_priority' => low_priority})
           WebTranslateIt::Util.add_fields(request)
           display.push Util.handle_response(http_connection.request(request))
           puts ArrayUtil.to_columns(display)
@@ -239,5 +241,7 @@ module WebTranslateIt
         ''
       end
     end
+
   end
+
 end

data/lib/web_translate_it/util/array_util.rb

@@ -1,4 +1,5 @@
 class ArrayUtil
+
   def self.to_columns(arr)
     if arr[0][0] == '*'
       "*#{StringUtil.backward_truncate(arr[0][1..])} | #{arr[1]}  #{arr[2]}\n"
@@ -20,4 +21,5 @@ class ArrayUtil
     end
     chunks
   end
+
 end

data/lib/web_translate_it/util/hash_util.rb

@@ -1,4 +1,5 @@
 class HashUtil
+
   def self.to_params(hash) # rubocop:todo Metrics/MethodLength
     params = ''
     stack = []
@@ -24,9 +25,11 @@ class HashUtil
     params.chop! # trailing &
     params
   end
+
 end
 
 class Hash
+
   # Destructively convert all keys to strings.
   def stringify_keys!
     keys.each do |key|
@@ -34,4 +37,5 @@ class Hash
     end
     self
   end
+
 end

data/lib/web_translate_it/util/string_util.rb

@@ -1,4 +1,5 @@
 class StringUtil
+
   def self.backward_truncate(str)
     return '...' << str[str.length - 50 + 3..str.length] if str.length > 50
 
@@ -26,4 +27,5 @@ class StringUtil
   def self.important(str)
     WebTranslateIt::Util.can_display_colors? ? "\e[1m#{str}\e[0m" : str
   end
+
 end

data/lib/web_translate_it/util.rb

@@ -1,6 +1,8 @@
 module WebTranslateIt
+
   # A few useful functions
   class Util
+
     require 'multi_json'
 
     # Return a string representing the gem version
@@ -41,8 +43,7 @@ module WebTranslateIt
     # rubocop:enable Metrics/PerceivedComplexity
 
     def self.add_fields(request)
-      request.add_field('X-Client-Name', 'web_translate_it')
-      request.add_field('X-Client-Version', version)
+      request.add_field('User-Agent', "wti v#{version}")
       request.add_field('Content-Type', 'application/json')
     end
 
@@ -51,26 +52,26 @@ module WebTranslateIt
 
     def self.ask_yes_no(question, default = nil) # rubocop:todo Metrics/MethodLength
       qstr = case default
-             when nil
-               'yn'
-             when true
-               'Yn'
-             else
-               'yN'
-             end
+      when nil
+        'yn'
+      when true
+        'Yn'
+      else
+        'yN'
+      end
 
       result = nil
 
       while result.nil?
         result = ask("#{question} [#{qstr}]")
         result = case result
-                 when /^[Yy].*/
-                   true
-                 when /^[Nn].*/
-                   false
-                 when '', nil
-                   default
-                 end
+        when /^[Yy].*/
+          true
+        when /^[Nn].*/
+          false
+        when '', nil
+          default
+        end
       end
 
       result
@@ -96,5 +97,7 @@ module WebTranslateIt
     def self.can_display_colors?
       !RUBY_PLATFORM.downcase.include?('mingw32')
     end
+
   end
+
 end

data/lib/web_translate_it.rb

@@ -16,6 +16,7 @@ require 'web_translate_it/project'
 require 'English'
 
 module WebTranslateIt
+
   def self.fetch_translations # rubocop:todo Metrics/AbcSize
     config = Configuration.new
     locale = I18n.locale.to_s
@@ -28,4 +29,5 @@ module WebTranslateIt
       end
     end
   end
+
 end

data/readme.md

@@ -3,7 +3,8 @@
 [RubyDoc](https://www.rubydoc.info/gems/web_translate_it/) |
 [Report a bug](https://github.com/webtranslateit/webtranslateit/issues) |
 [Support](https://webtranslateit.com/support) |
-[WebTranslateIt.com Homepage](https://webtranslateit.com)
+[WebTranslateIt.com Homepage](https://webtranslateit.com) |
+[Docker Package](https://github.com/webtranslateit/wti-docker/pkgs/container/wti-docker)
 
 wti lets you easily sync your language files with [WebTranslateIt.com](https://webtranslateit.com), a web-based tool to translation software.
 
@@ -11,7 +12,7 @@ wti lets you easily sync your language files with [WebTranslateIt.com](https://w
 
 ### wti...
 
-* wti is a **command-line tool**. It works on all operating systems: Windows, Linux, MacOS X...
+* wti is a **command-line tool**. It works on all operating systems: Windows, Linux, MacOS X, ... It is also available as a [Docker package](https://github.com/webtranslateit/wti-docker/pkgs/container/wti-docker).
 * wti is really easy to use. It was inspired by git. Use `wti push` and `wti pull` to sync your language files with WebTranslateIt.com.
 
 ### Optionally, wti does...
@@ -24,12 +25,12 @@ wti lets you easily sync your language files with [WebTranslateIt.com](https://w
 
 ## Installation
 
-You will also need ruby to run `wti`. On Linux or a Mac, it’s already installed. Install [RubyInstaller](http://rubyinstaller.org/) if you’re using Windows. [See detailed installation instructions for Windows users](https://github.com/webtranslateit/webtranslateit/wiki/Install-wti-on-Windows).
+You will also need ruby to run `wti`. We require ruby version 2.6 or newer. On Linux or a Mac, it’s already installed. Install [RubyInstaller](http://rubyinstaller.org/) if you’re using Windows. [See detailed installation instructions for Windows users](https://github.com/webtranslateit/webtranslateit/wiki/Install-wti-on-Windows).
 
 ``` bash
 $ gem install web_translate_it
-Fetching: web_translate_it-2.1.3.gem (100%)
-Successfully installed web_translate_it-2.1.3
+Fetching: web_translate_it-2.6.4.gem (100%)
+Successfully installed web_translate_it-2.6.4
 1 gem installed
 ```
 
@@ -37,26 +38,14 @@ At this point you should have the `wti` executable working:
 
 ``` bash
 $ wti -v
-wti version 2.2.1
+wti version 2.6.4
 ```
 
-On some Linux distributions you may get the following error:
-
-``` bash
-$ wti
-If 'wti' is not a typo you can use command-not-found to lookup the package that contains it, like this:
-    cnf wti
-```
-
-The reason is that the wti file is named in another way: `/usr/bin/wti.ruby2.1` so you will have to create a symlink to make wti run.
-
-``` bash
-# ln -s /usr/bin/wti.ruby2.1 /usr/bin/wti
-```
+We also provide `wti` as a Docker packages. [See our packages and instructions to install](https://github.com/webtranslateit/wti-docker/pkgs/container/wti-docker).
 
 ## Configuration
 
-Now that the tool is installed, you’ll have to configure your project. Basically, `wti` is to be run on a project root directory, and looks for a `.wti` file containing your project information. The command `wti init` lets your create your `.wti` file.
+Now that `wti` is installed, you’ll have to configure your project. Basically, `wti` is to be run on a project root directory, and looks for a `.wti` file containing your project information. The command `wti init` lets your create your `.wti` file.
 
 ``` bash
 $ wti init proj_pvt_V8skdjsdDDA4
@@ -217,7 +206,7 @@ There are 4 hooks:
 * `before_push`
 * `after_push`
 
-Check the [sample `.wti`](https://github.com/webtranslateit/webtranslateit/blob/master/examples/.wti#L16-L21) file for implementation.
+Check the [sample `.wti`](https://github.com/webtranslateit/webtranslateit/blob/main/examples/.wti#L21-L28) file for implementation.
 
 ## Exit codes
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web_translate_it
 version: !ruby/object:Gem::Version
-  version: 2.6.3
+  version: 2.7.0
 platform: ruby
 authors:
 - Edouard Briere
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-14 00:00:00.000000000 Z
+date: 2022-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -52,76 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  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: guard-rubocop
-  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: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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: simplecov
-  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'
 description: A Command Line Interface tool to push and pull language files to WebTranslateIt.com.
 email: support@webtranslateit.com
 executables:
@@ -184,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.21
 signing_key:
 specification_version: 4
 summary: A CLI tool to sync locale files with WebTranslateIt.com.