web_translate_it 1.7.1.3 → 1.7.1.5

data/README.md

@@ -20,6 +20,8 @@ This gem provides 4 tools:
 
 ## Installation
 
+These instructions are for Linux and Mac OS X system. Follow [these instructions](http://help.webtranslateit.com/kb/tips/how-to-install-wti-on-windows) if you’re using Microsoft Windows.
+
     gem install web_translate_it
     
 At this point you should have the `wti` executable working.
@@ -27,31 +29,34 @@ If your project if already set up on Web Translate It, open a terminal and type
 
 Execute `wti --help` to see the usage:
 
-    Usage: wti [-lcphv]
-            pull                         Pull target language file(s).
-            push                         Push master language file(s).
-            add                          Create and push a new master language file.
+    Usage: wti [-lcphhv]
+            pull                         Pull target language file(s)
+            push                         Push master language file(s)
+            add                          Create and push a new master language file
+            addlocale                    Add a new locale to the project
             server                       Start a synchronisation server
-            stats                        Fetch and display project statistics.
-            autoconf                     Configure your project to sync.
+            stats                        Fetch and display project statistics
+            autoconf                     Configure your project to sync
 
     Synchronization options: 
-        -l, --locale                     ISO code of a locale to pull or push.
-        -c, --config                     Path to a translation.yml file.
-                                         (default: config/translation.yml).
-            --all                        Download or upload all files.
-            --force                      Force wti pull to download files.
-            --merge                      Force WTI to merge this file.
-            --ignore_missing             Force WTI to not obsolete missing strings.
+        -l, --locale                     ISO code of a locale to pull or push
+        -c, --config                     Path to a translation.yml file
+                                         (default: config/translation.yml)
+            --all                        Download or upload all files
+            --force                      Force wti pull to download files
+            --merge                      Force WTI to merge this file
+            --ignore_missing             Force WTI to not obsolete missing strings
+            --low_priority               Tells WTI to process this command with a low priority
+            --label                      Apply a label to the changes
 
     Server options: 
         -p, --port                       Run server on a specific port
-                                         (default: 4000).
+                                         (default: 4000)
         -h, --host                       Run server on a specific host
-                                         (default: localhost).
+                                         (default: localhost)
 
     Other options: 
-            --help                       Show this message
+        -h, --help                       Show this message
         -v, --version                    Show version
 
 ## Configuration
@@ -106,7 +111,7 @@ where `fr` should be replaced by the locale code of your file.
 
     wti pull --all
     
-### Force pull (bypasses Web Translate It’s HTTP caching)
+### Force pull (bypass Web Translate It’s HTTP caching)
 
     wti pull --force
 
@@ -116,7 +121,7 @@ where `fr` should be replaced by the locale code of your file.
     
 ## Web Translate It Synchronisation Console
 
-![Web Translate It](http://s3.amazonaws.com:80/edouard.baconfile.com/web_translate_it%2Fadmin_console.png)
+![Web Translate It](http://s3.amazonaws.com:80/edouard.baconfile.com/web_translate_it%2Fadmin_console2.png)
 
 The `wti` gem integrates since its version 1.7.0 a sinatra back-end that allow you to sync your translations directly from a friendly web interface. It allows a translation team to refresh the language files on a staging server without having to ask the developers to manually `wti pull`.
 
@@ -126,7 +131,7 @@ To get started, go to the directory of the application you want to sync and do:
     
 By default, it starts an application on localhost on the port 4000. You will find the tool on `http://localhost:4000`.
 
-Should you need to use another host or port, you can use the -h and -p options. For example: `wti server -p 1234`.
+Should you need to use another host or port, you can use the `-h` and `-p` options. For example: `wti server -p 1234`.
 
 You may want to run some commands before or after synching translations. To do so, add in the `translation.yml` file the following:
 
@@ -182,17 +187,6 @@ The gem currently has been tested against the following versions of Rails:
 
 Please open a discussion on [our support site](http://help.webtranslateit.com) if you're using a version of Rails that is not listed above and the gem is not working properly.
 
-# Acknowledgement
-
-* The executable’s commands are very much inspired from [Gemcutter](http://gemcutter.org),
-* The Rails generator was pinched from [Hoptoad Notifier](http://github.com/thoughtbot/hoptoad_notifier),
-* The idea of a web-app to sync translations with Web Translate It come from Tom Lea’s awesome [rack-webtranslateit](http://github.com/cwninja/rack-webtranslateit),
-* The Sinatra app is much inspired from Chris Wanstrath’s [CI Joe](http://github.com/defunkt/cijoe).
-
-# What is Web Translate It anyway?
-
-[Web Translate It](https://webtranslateit.com) is a web-based computer-aided translation tool to collaboratively translate software.
-
-To learn more about it, please visit our [tour page](https://webtranslateit.com/tour).
+# License
 
-This gem is released under the MIT License.
+Copyright (c) 2009-2011 Atelier Convivialité, and released under the MIT License.

data/bin/wti

@@ -7,17 +7,17 @@ Choice.options do
 
   option :pull do
     long 'pull'
-    desc "Pull target language file(s)."
+    desc "Pull target language file(s)"
   end
 
   option :push do
     long 'push'
-    desc "Push master language file(s)."
+    desc "Push master language file(s)"
   end
 
   option :add do
     long 'add'
-    desc "Create and push a new master language file."
+    desc "Create and push a new master language file"
   end
   
   option :addlocale do
@@ -32,12 +32,12 @@ Choice.options do
 
   option :stats do
     long 'stats'
-    desc "Fetch and display project statistics."
+    desc "Fetch and display project statistics"
   end
 
   option :autoconf do
     long 'autoconf'
-    desc "Configure your project to sync."
+    desc "Configure your project to sync"
   end
 
   separator ''
@@ -46,40 +46,45 @@ Choice.options do
   option :locale do
     short '-l'
     long  '--locale'
-    desc  "ISO code of a locale to pull or push."
+    desc  "ISO code of a locale to pull or push"
   end
   
   option :config do
     short '-c'
     long  '--config'
-    desc  "Path to a translation.yml file."
-    desc  "(default: config/translation.yml)."
+    desc  "Path to a translation.yml file"
+    desc  "(default: config/translation.yml)"
     default "config/translation.yml"
   end
   
   option :all do
     long  '--all'
-    desc  "Download or upload all files."
+    desc  "Download or upload all files"
   end
   
   option :force do
     long  '--force'
-    desc  "Force wti pull to download files."
+    desc  "Force wti pull to download files"
   end
   
   option :merge do
     long  '--merge'
-    desc  "Force WTI to merge this file."
+    desc  "Force WTI to merge this file"
   end
   
   option :ignore_missing do
     long  '--ignore_missing'
-    desc  "Force WTI to not obsolete missing strings."
+    desc  "Force WTI to not obsolete missing strings"
+  end
+  
+  option :low_priority do
+    long '--low_priority'
+    desc "Tells WTI to process this command with a low priority"
   end
   
   option :label do
     long  '--label'
-    desc  "Apply a label to the changes."
+    desc  "Apply a label to the changes"
   end
   
   separator ''
@@ -89,7 +94,7 @@ Choice.options do
     short '-p'
     long  '--port'
     desc  "Run server on a specific port"
-    desc  "(default: 4000)."
+    desc  "(default: 4000)"
     cast  Integer
     default '4000'
   end
@@ -98,7 +103,7 @@ Choice.options do
     short '-h'
     long  '--host'
     desc  "Run server on a specific host"
-    desc  "(default: localhost)."
+    desc  "(default: localhost)"
     default '0.0.0.0'
   end
   

data/history.md

@@ -1,10 +1,20 @@
+## Version 1.7.1.5 / 2011-02-10
+
+* Fix an issue with `wti server` swallowing all `wti` outputs.
+
+## Version 1.7.1.4 / 2011-02-10
+
+* New: Add `--low_priority` option.
+* Update Sinatra and multipart-post dependancies.
+* New: Enable logging of `wti server`. Logs will be saved in `log/webtranslateit.log` in your project directory.
+
 ## Version 1.7.1.3 / 2011-01-13
 
-* Fix: Bug in `wti add`
+* Fix: Bug in `wti add`.
 
 ## Version 1.7.1.2 / 2011-01-13
 
-* Fix: server timeout handling on `wti addlocale`
+* Fix: server timeout handling on `wti addlocale`.
 
 ## Version 1.7.1.1 / 2011-01-13
 

data/lib/web_translate_it/command_line.rb

@@ -19,7 +19,7 @@ module WebTranslateIt
       STDOUT.sync = true
       fetch_locales_to_pull.each do |locale|
         configuration.files.find_all{ |file| file.locale == locale }.each do |file|
-          print "Pulling #{file.file_path}… "
+          print "Pulling #{file.file_path}... "
           puts file.fetch(ARGV.index('--force'))
         end
       end
@@ -31,8 +31,8 @@ module WebTranslateIt
         merge = !(ARGV.index('--merge')).nil?
         ignore_missing = !(ARGV.index('--ignore_missing')).nil?
         configuration.files.find_all{ |file| file.locale == locale }.each do |file|
-          print "Pushing #{file.file_path}… "
-          puts file.upload(merge, ignore_missing, options.label)
+          print "Pushing #{file.file_path}... "
+          puts file.upload(merge, ignore_missing, options.label, options.low_priority)
         end
       end
     end
@@ -45,7 +45,7 @@ module WebTranslateIt
       end
       parameters.each do |param|
         file = TranslationFile.new(nil, param, nil, configuration.api_key)
-        print "Creating #{file.file_path}… "
+        print "Creating #{file.file_path}... "
         puts file.create
       end
       puts "Master file added. Use `wti push --all` to send your existing translations."
@@ -58,7 +58,7 @@ module WebTranslateIt
         exit
       end
       parameters.each do |param|
-        print "Adding locale #{param}… "
+        print "Adding locale #{param}... "
         puts WebTranslateIt::Project.create_locale(configuration.api_key, param)
       end
       puts "Done!"

data/lib/web_translate_it/project.rb

@@ -3,7 +3,7 @@ module WebTranslateIt
   class Project
     
     def self.fetch_info(api_key)
-      puts "Gathering project's information…"
+      puts "Gathering project's information..."
       begin
         WebTranslateIt::Util.http_connection do |http|
           request = Net::HTTP::Get.new("/api/projects/#{api_key}.yaml")

data/lib/web_translate_it/server.rb

@@ -12,7 +12,7 @@ module WebTranslateIt
     set :public, "#{dir}/public"
     set :static, true
     set :lock, true
-    
+        
     helpers do
       def wti_root
         ""
@@ -52,6 +52,9 @@ module WebTranslateIt
     end
     
     def self.start(host, port)
+      logger = ::File.open("log/webtranslateit.log", "a+")
+      STDOUT.reopen(logger)
+      STDERR.reopen(logger)
       WebTranslateIt::Server.run! :host => host, :port => port
     end
   end

data/lib/web_translate_it/tasks.rb

@@ -5,7 +5,7 @@ namespace :trans do
   desc "Fetch translation files from Web Translate It"
   task :fetch, :locale do |task, args|
     WebTranslateIt::Util.welcome_message
-    puts "Fetching file for locale #{args.locale}…"
+    puts "Fetching file for locale #{args.locale}..."
     configuration = WebTranslateIt::Configuration.new
     configuration.files.find_all{ |file| file.locale == args.locale }.each do |file|
       puts file.file_path + ": " + file.fetch
@@ -19,7 +19,7 @@ namespace :trans do
       configuration = WebTranslateIt::Configuration.new
       locales = configuration.target_locales
       configuration.ignore_locales.each{ |locale_to_ignore| locales.delete(locale_to_ignore) }
-      puts "Fetching all files for all locales…"
+      puts "Fetching all files for all locales..."
       locales.each do |locale|
         configuration.files.find_all{ |file| file.locale == locale }.each do |file|
           puts file.file_path + " " + file.fetch
@@ -31,7 +31,7 @@ namespace :trans do
   desc "Upload the translation files for a locale to Web Translate It"
   task :upload, :locale do |task, args|
     WebTranslateIt::Util.welcome_message
-    puts "Uploading file for locale #{args.locale}…"
+    puts "Uploading file for locale #{args.locale}..."
     configuration = WebTranslateIt::Configuration.new
     configuration.files.find_all{ |file| file.locale == args.locale }.each do |file|
       puts file.file_path + " " + file.upload

data/lib/web_translate_it/translation_file.rb

@@ -70,12 +70,12 @@ 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(merge=false, ignore_missing=false, label=nil)
+    def upload(merge=false, ignore_missing=false, label=nil, low_priority=false)
       if File.exists?(self.file_path)
         File.open(self.file_path) do |file|
           begin
             WebTranslateIt::Util.http_connection do |http|
-              request = Net::HTTP::Put::Multipart.new(api_url, {"file" => UploadIO.new(file, "text/plain", file.path), "merge" => merge, "ignore_missing" => ignore_missing, "label" => label })
+              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 })
               Util.handle_response(http.request(request))
             end
           rescue Timeout::Error

data/lib/web_translate_it/views/index.erb

@@ -23,7 +23,7 @@
             <% end %>
           </select>
           <form method="post" action="<%= wti_root %>/pull/<%= locale %>">
-            <input type="submit" value="Update" onclick="if (window.hiddenCommit) { window.hiddenCommit.setAttribute('value', this.value); }else { hiddenCommit = document.createElement('input');hiddenCommit.type = 'hidden';hiddenCommit.value = this.value;hiddenCommit.name = this.name;this.form.appendChild(hiddenCommit); }this.setAttribute('originalValue', this.value);this.disabled = true;this.value='Please wait…';result = (this.form.onsubmit ? (this.form.onsubmit() ? this.form.submit() : false) : this.form.submit());if (result == false) { this.value = this.getAttribute('originalValue');this.disabled = false; }return result;" />
+            <input type="submit" value="Update" onclick="if (window.hiddenCommit) { window.hiddenCommit.setAttribute('value', this.value); }else { hiddenCommit = document.createElement('input');hiddenCommit.type = 'hidden';hiddenCommit.value = this.value;hiddenCommit.name = this.name;this.form.appendChild(hiddenCommit); }this.setAttribute('originalValue', this.value);this.disabled = true;this.value='Please wait...';result = (this.form.onsubmit ? (this.form.onsubmit() ? this.form.submit() : false) : this.form.submit());if (result == false) { this.value = this.getAttribute('originalValue');this.disabled = false; }return result;" />
           </form>
           <div class="clear"></div>
         </div>

data/readme.md

@@ -0,0 +1,192 @@
+# Web Translate It
+
+[Homepage](https://webtranslateit.com) | 
+[RDocs](http://yardoc.org/docs/AtelierConvivialite-webtranslateit) | 
+[Example app](http://github.com/AtelierConvivialite/rails_example_app) | 
+[Report a bug](http://github.com/AtelierConvivialite/webtranslateit/issues) | 
+[Support](http://help.webtranslateit.com) | 
+[Documentation](http://docs.webtranslateit.com/web_translate_it_client/)
+
+`web_translate_it` is a rubygem providing tools to sync your language files with [Web Translate It](https://webtranslateit.com), a web-based computer-aided translation tool.
+
+![Web Translate It](http://s3.amazonaws.com:80/edouard.baconfile.com/web_translate_it%2Fwti2.png)
+
+This gem provides 4 tools:
+
+* an executable, `wti`, that will help you to upload and download language files from the command line,
+* a synchronisation server to help your translation team update your language files from a web-based interface,
+* a handful of rake task you can use with your Ruby on Rails application,
+* a rack middleware to automatically fetch new translations from Web Translate It.
+
+## Installation
+
+These instructions are for Linux and Mac OS X system. Follow [these instructions](http://help.webtranslateit.com/kb/tips/how-to-install-wti-on-windows) if you’re using Microsoft Windows.
+
+    gem install web_translate_it
+    
+At this point you should have the `wti` executable working.
+If your project if already set up on Web Translate It, open a terminal and type `wti autoconf` to generate the configuration file.
+
+Execute `wti --help` to see the usage:
+
+    Usage: wti [-lcphhv]
+            pull                         Pull target language file(s)
+            push                         Push master language file(s)
+            add                          Create and push a new master language file
+            addlocale                    Add a new locale to the project
+            server                       Start a synchronisation server
+            stats                        Fetch and display project statistics
+            autoconf                     Configure your project to sync
+
+    Synchronization options: 
+        -l, --locale                     ISO code of a locale to pull or push
+        -c, --config                     Path to a translation.yml file
+                                         (default: config/translation.yml)
+            --all                        Download or upload all files
+            --force                      Force wti pull to download files
+            --merge                      Force WTI to merge this file
+            --ignore_missing             Force WTI to not obsolete missing strings
+            --low_priority               Tells WTI to process this command with a low priority
+            --label                      Apply a label to the changes
+
+    Server options: 
+        -p, --port                       Run server on a specific port
+                                         (default: 4000)
+        -h, --host                       Run server on a specific host
+                                         (default: localhost)
+
+    Other options: 
+        -h, --help                       Show this message
+        -v, --version                    Show version
+
+## Configuration
+
+Now that the tool is installed, you’ll have to configure your project:
+
+    wti autoconf
+
+It will ask for your Web Translate It API key, and where to save its configuration file. Letting it put in `config/translations.yml` makes everything easier.
+
+## Usage
+
+### Uploading your first language file
+
+If you have no file on Web Translate It yet, you need to send us your master language files. You can do it from the web interface, or from the command line:
+
+    wti add path/to/master/file.po
+
+You can also add several files at once:
+
+    wti add file1.po file2.po file3.xml
+
+Or
+
+    wti add *.po
+
+After receiving your master language files, Web Translate It will automatically create the corresponding, empty target files. If you have already some translations for these files, use `wti push --all` to synchronise them to Web Translate It.
+
+### Updating a master language file
+
+    wti push
+
+### Updating a target language file
+
+    wti push -l fr
+   
+where `fr` should be replaced by the locale code of your file.
+
+### Updating all language files
+
+    wti push --all
+
+### Download target language files
+
+    wti pull
+    
+### Download a specific language file
+
+    wti pull -l fr
+    
+### Download all the language files
+
+    wti pull --all
+    
+### Force pull (bypass Web Translate It’s HTTP caching)
+
+    wti pull --force
+
+### View project stats
+
+    wti stats
+    
+## Web Translate It Synchronisation Console
+
+![Web Translate It](http://s3.amazonaws.com:80/edouard.baconfile.com/web_translate_it%2Fadmin_console2.png)
+
+The `wti` gem integrates since its version 1.7.0 a sinatra back-end that allow you to sync your translations directly from a friendly web interface. It allows a translation team to refresh the language files on a staging server without having to ask the developers to manually `wti pull`.
+
+To get started, go to the directory of the application you want to sync and do:
+
+    wti server
+    
+By default, it starts an application on localhost on the port 4000. You will find the tool on `http://localhost:4000`.
+
+Should you need to use another host or port, you can use the `-h` and `-p` options. For example: `wti server -p 1234`.
+
+You may want to run some commands before or after synching translations. To do so, add in the `translation.yml` file the following:
+
+    before_pull: "echo 'some unix command'"
+    after_pull:  "touch tmp/restart.txt"
+    
+`before_pull` and `after_pull` will respectively be executed before and after pulling your language files.
+
+## Rake tasks
+
+This gem includes some rake tasks and a rack middleware you could use to integrate Web Translate It with Ruby on Rails. The rake tasks are significantly slower than the executable, since it has to load the whole rails stack.
+
+* Add to your config/environments.rb:
+
+    `config.gem 'web_translate_it'`
+    
+* Then, run:
+
+    `rake gems:install`
+
+* If you did not already did `wti autoconf`, copy your API key from Web Translate It and run:
+
+    `script/generate webtranslateit --api-key your_key_here`
+    
+  The generator does two things:
+  
+  - It adds a auto-configured `config/translation.yml` file using Web Translate It’s API.
+  - It adds `require 'web_translate_it/tasks' rescue LoadError` to your `Rakefile`
+  
+There are 3 rake tasks.
+
+    rake trans:fetch:all
+  
+Fetch the latest translations for all your files for all languages defined in Web Translate It’s interface, except for the languages set in `ignore_locales`.
+
+    rake trans:fetch[fr_FR]
+  
+Fetch the latest translations for all the languages defined in Web Translate It’s interface. It takes the locale name as a parameter
+
+    rake trans:upload[fr_FR]
+    
+Upload to Web Translate It your files in a specific locale defined in Web Translate It’s interface.
+
+Read more about [Rails integration in the wiki](http://wiki.github.com/AtelierConvivialite/webtranslateit/).
+
+### Supported Rails Versions
+
+The gem currently has been tested against the following versions of Rails:
+
+* 2.3.4
+* 2.3.5
+* 2.3.10
+
+Please open a discussion on [our support site](http://help.webtranslateit.com) if you're using a version of Rails that is not listed above and the gem is not working properly.
+
+# License
+
+Copyright (c) 2009-2011 Atelier Convivialité, and released under the MIT License.

data/version.yml

@@ -2,4 +2,4 @@
 :major: 1
 :minor: 7
 :tiny: 1
-:patch: 3
+:patch: 5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: web_translate_it
 version: !ruby/object:Gem::Version 
-  hash: 101
-  prerelease: false
+  hash: 105
+  prerelease: 
   segments: 
   - 1
   - 7
   - 1
-  - 3
-  version: 1.7.1.3
+  - 5
+  version: 1.7.1.5
 platform: ruby
 authors: 
 - "\xC3\x89douard Bri\xC3\xA8re"
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-14 00:00:00 +01:00
+date: 2011-02-10 00:00:00 +01:00
 default_executable: wti
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,11 +27,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 19
         segments: 
         - 1
+        - 1
         - 0
-        version: "1.0"
+        version: 1.1.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -58,11 +59,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 23
         segments: 
         - 1
-        - 0
-        version: "1.0"
+        - 1
+        - 2
+        version: 1.1.2
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -92,8 +94,8 @@ extra_rdoc_files:
 - README.md
 files: 
 - history.md
-- MIT-LICENSE
-- README.md
+- licence
+- readme.md
 - version.yml
 - examples/locale.rb
 - examples/translation.yml
@@ -115,6 +117,7 @@ files:
 - man/wti.1
 - man/wti.1.html
 - man/wti.1.ron
+- README.md
 - spec/examples/config/translation.yml
 - spec/examples/en.yml
 - spec/spec.opts
@@ -154,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Sync your translations between your app and Web Translate It