wti_gettext_i18n_rails 1.0.0

data/lib/web_translate_it/tasks.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+namespace :trans do  
+  desc "Fetch translation files from Web Translate It"
+  task :fetch, :locale do |task, args|
+    welcome_message
+    puts "Fetching file for locale #{args.locale}…"
+    configuration = WebTranslateIt::Configuration.new
+    configuration.files.each do |file|
+      response_code = file.fetch(args.locale)
+      handle_response(file.file_path_for_locale(args.locale), response_code)
+    end
+  end  
+  
+  namespace :fetch do
+    desc "Fetch all the translation files from Web Translate It"
+    task :all do
+      welcome_message
+      configuration = WebTranslateIt::Configuration.new
+      locales = configuration.target_locales
+      configuration.ignore_locales.each do |ignore|
+        locales.delete(ignore)
+      end
+      puts "Fetching all files for all locales…"
+      locales.each do |locale|
+        configuration.files.each do |file|
+          unless File.exist?(file.file_path_for_directory(locale))
+            Dir.mkdir(file.file_path_for_directory(locale))
+          end
+          response_code = file.fetch(locale) 
+          handle_response(file.file_path_for_locale(locale), response_code)
+        end
+      end
+    end
+  end
+  
+  desc "Upload the translation files for a locale to Web Translate It"
+  task :upload, :locale do |task, args|
+    welcome_message
+    puts "Uploading file for locale #{args.locale}…"
+    configuration = WebTranslateIt::Configuration.new
+    configuration.files.each do |file|
+      response_code = file.upload(args.locale)
+      handle_response(file.file_path_for_locale(args.locale), response_code)
+    end
+  end
+    
+  def handle_response(file_path, response_code)
+    if response_code < 400
+      puts "#{file_path}: #{response_code}, OK"
+    else
+      puts "#{file_path}: #{response_code}, Problem!"
+    end
+  end
+  
+  def welcome_message
+    puts "Web Translate It v#{WebTranslateIt::Util.version}"
+  end
+end

data/lib/web_translate_it/translation_file.rb

@@ -0,0 +1,97 @@
+module WebTranslateIt
+  
+  # A TranslationFile is the representation of a master language file
+  # on Web Translate It.
+  #
+  # This class allows to manipulate TranslationFiles, more specifically upload and download them.
+  # If you pass a Locale to the master language file you will be able to
+  # manipulate a _target_ language file.
+  class TranslationFile
+    require 'net/https'
+    require 'net/http/post/multipart'
+    require 'time'
+    require 'fileutils'
+    
+    attr_accessor :id, :file_path, :api_key
+    
+    def initialize(id, file_path, api_key)
+      self.id        = id
+      self.file_path = file_path
+      self.api_key   = api_key
+    end
+    
+    # Fetch a language file.
+    # By default it will make a conditional GET Request, using the `If-Modified-Since` tag.
+    # You can force the method to re-download your file by passing `true` as a second argument
+    #
+    # Example of implementation:
+    #
+    #   configuration = WebTranslateIt::Configuration.new
+    #   locale = configuration.locales.first
+    #   file = configuration.files.first
+    #   file.fetch(locale) # the first time, will return the content of the language file with a status 200 OK
+    #   file.fetch(locale) # returns nothing, with a status 304 Not Modified
+    #   file.fetch(locale, true) # force to re-download the file, will return the content of the file with a 200 OK
+    #
+    def fetch(locale, force = false)
+      WebTranslateIt::Util.http_connection do |http|
+        request = Net::HTTP::Get.new(api_url(locale))
+        request.add_field('If-Modified-Since', last_modification(file_path_for_locale(locale))) if File.exist?(file_path_for_locale(locale)) and !force
+        response = http.request(request)
+        File.open(file_path_for_locale(locale), 'w'){ |file| file << response.body } if response.code.to_i == 200 and response.body != ''
+        response.code.to_i
+      end
+    end
+    
+    # Update a language file to Web Translate It by performing a PUT Request.
+    # Note that it is currently not possible to POST a new language file at the moment.
+    #
+    # Example of implementation:
+    #
+    #   configuration = WebTranslateIt::Configuration.new
+    #   locale = configuration.locales.first
+    #   file = configuration.files.first
+    #   file.upload(locale) # should respond the HTTP code 202 Accepted
+    #
+    # The meaning of the HTTP 202 code is: the request has been accepted for processing, but the processing has not
+    # been completed. 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(locale)
+      File.open(file_path_for_locale_initial(locale)) do |file|
+          WebTranslateIt::Util.http_connection do |http|
+            request  = Net::HTTP::Put::Multipart.new(api_url(locale), "file" => UploadIO.new(file, "text/plain", file.path))
+            response = http.request(request)
+            response.code.to_i
+          end
+        #end
+      end
+    end
+    
+    def file_path_for_locale_initial(locale)
+      self.file_path.gsub("[locale]", locale)
+    end
+    
+    # Convenience method which returns the file path of a TranslationFile for a given locale.
+    def file_path_for_locale(locale)
+      self.file_path.gsub("[locale].pot", locale.split(/-/, 2)[0].to_s.split(/_/, 2)[0].to_s + "/" + "en.po")
+    end
+    
+    def file_path_for_directory(locale)
+      self.file_path.gsub("[locale].pot", locale.split(/-/, 2)[0].to_s.split(/_/, 2)[0].to_s + "/")
+    end
+        
+    protected
+      
+      # Convenience method which returns the date of last modification of a language file.
+      def last_modification(file_path)
+        File.mtime(File.new(file_path, 'r')).rfc2822
+      end
+      
+      # Convenience method which returns the URL of the API endpoint for a locale.
+      def api_url(locale)
+        "/api/projects/#{api_key}/files/#{self.id}/locales/#{locale}"
+      end
+  end
+end

data/lib/web_translate_it/util.rb

@@ -0,0 +1,35 @@
+module WebTranslateIt
+  
+  # A few useful functions
+  class Util
+    
+    # Return a string representing the gem version
+    # For example "1.4.4"
+    def self.version
+      hash = YAML.load_file File.join(File.dirname(__FILE__), '..', '..' '/version.yml')
+      [hash[:major], hash[:minor], hash[:patch]].join('.')
+    end
+    
+    # Yields a HTTP connection over SSL to Web Translate It.
+    # This is used for the connections to the API throughout the library.
+    # Use it like so:
+    # 
+    #   WebTranslateIt::Util.http_connection do |http|
+    #     request = Net::HTTP::Get.new(api_url)
+    #     response = http.request(request)
+    #   end
+    #
+    def self.http_connection
+      http = Net::HTTP.new('webtranslateit.com', 443)
+      http.use_ssl      = true
+      http.verify_mode  = OpenSSL::SSL::VERIFY_NONE
+      http.read_timeout = 40
+      yield http
+    end
+    
+    def self.calculate_percentage(processed, total)
+      return 0 if total == 0
+      ((processed*10)/total).to_f.ceil*10
+    end
+  end
+end

data/lib/web_translate_it.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), 'web_translate_it', 'util')
+require File.join(File.dirname(__FILE__), 'web_translate_it', 'configuration')
+require File.join(File.dirname(__FILE__), 'web_translate_it', 'translation_file')
+require File.join(File.dirname(__FILE__), 'web_translate_it', 'auto_fetch')
+require File.join(File.dirname(__FILE__), 'web_translate_it', 'command_line')
+require File.join(File.dirname(__FILE__), 'web_translate_it', 'project')
+require File.join(File.dirname(__FILE__), 'web_translate_it', 'tasks')
+
+module WebTranslateIt
+  def self.fetch_translations
+    config = Configuration.new
+    locale = I18n.locale.to_s
+    return if config.ignore_locales.include?(locale)
+    config.logger.debug { "Fetching #{locale} translations to Web Translate It" } if config.logger
+    config.files.each do |file|
+      response = file.fetch(locale)
+      config.logger { "Web Translate It response: #{response}" } if config.logger
+    end
+  end
+end

data/man/wti.1

@@ -0,0 +1,90 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "WTI" "1" "March 2010" "Atelier Convivialité" "Web Translate It"
+.
+.SH "NAME"
+\fBwti\fR \-\- WebTranslateIt.com from the command line
+.
+.SH "SYNOPSIS"
+\fBwti\fR \fICOMMAND\fR \fIOPTIONS\fR
+.
+.P
+\fBwti push\fR [\fB\-l\fR] \fIOPTIONS\fR
+.
+.P
+\fBwti pull\fR [\fB\-l\fR] \fIOPTIONS\fR
+.
+.SH "DESCRIPTION"
+\fBwti\fR is an utility to help you sync language files between the
+WebTranslateIt.com service and your computer/server.
+.
+.P
+\fBwti push\fR will push your master language file to Web Translate It. It means it will
+update the strings hosted at Web Translate It by the strings from the file you push.
+.
+.P
+\fBwti pull\fR will pull the target language files from Web Translate It. It will download
+and update your file with the latest translations from Web Translate It.
+.
+.P
+\fBwti stats\fR fetch and display translation statistics from Web Translate It.
+.
+.SH "OPTIONS"
+\fBwti\fR's default mode of operation is to push only the master language file and to only
+pull target language files.
+.
+.P
+These options can be used to change this behaviour:
+.
+.TP
+\fB\-\-all\fR
+Push or pull all. For example, \fBwti push \-\-all\fR will push master and target language files. \fBwti pull \-\-all\fR will pull master and target language files
+.
+.TP
+\fB\-l\fR, \fB\-\-locale\fR
+Set the locale to push or pull explicitly. For example \fBwti pull \-l fr\fR will only pull
+the French language file.
+.
+.TP
+\fB\-\-force\fR
+The Web Translate It API use HTTP caching to be efficient, and check if your file needs
+to be updated by checking its modification date against the project’s latest activity.
+Use this option to bypass this check.
+.
+.P
+You may additionally ask for help:
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help.
+.
+.SH "CONFIGURATION"
+The first \fBwti\fR is used on a project, it must be configured.
+.
+.P
+\fBwti autoconf\fR will help you create a configuration file to sync with
+Web Translate It.
+.
+.SH "EXAMPLES"
+.
+.nf
+$ wti push
+Pushing ./config/locales/app/en.yml…
+Pushing ./config/locales/defaults/en.yml…
+$ wti pull \-l fr
+Pulling ./config/locales/app/fr.yml…
+Pulling ./config/locales/defaults/fr.yml…
+$ wti stats
+fr: 100% translated, 90% completed
+ru: 10% translated, 10% completed
+pt_BR: 0% translated, 0% completed
+en: 100% translated, 90% completed
+.
+.fi
+.
+.SH "BUGS"
+\fIhttp://github.com/atelierConvivialite/webtranslateit/issues\fR
+.
+.SH "AUTHOR"
+Édouard Brière :: edouard@atelierconvivialite.com

data/man/wti.1.html

@@ -0,0 +1,157 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.4.1'>
+  <title>wti(1) -- WebTranslateIt.com from the command line</title>
+  <style type='text/css'>
+    body {margin:0}
+    #man, #man code, #man pre, #man tt, #man kbd, #man samp {
+      font-family:consolas,monospace;
+      font-size:16px;
+      line-height:1.3;
+      color:#343331;
+      background:#fff; }
+    #man { max-width:89ex; text-align:justify; margin:0 25px 25px 25px }
+    #man h1, #man h2, #man h3 { color:#232221;clear:left }
+    #man h1 { font-size:28px; margin:15px 0 30px 0; text-align:center }
+    #man h2 { font-size:18px; margin-bottom:0; margin-top:10px; line-height:1.3; }
+    #man h3 { font-size:16px; margin:0 0 0 4ex; }
+    #man p, #man ul, #man ol, #man dl, #man pre { margin:0 0 18px 0; }
+    #man pre {
+      color:#333231;
+      background:#edeceb;
+      padding:5px 7px;
+      margin:0px 0 20px 0;
+      border-left:2ex solid #ddd}
+    #man pre + h2, #man pre + h3 {
+      margin-top:22px;
+    }
+    #man h2 + pre, #man h3 + pre {
+      margin-top:5px;
+    }
+    #man > p, #man > ul, #man > ol, #man > dl, #man > pre { margin-left:8ex; }
+    #man dt { margin:0; clear:left }
+    #man dt.flush { float:left; width:8ex }
+    #man dd { margin:0 0 0 9ex }
+    #man code, #man strong, #man b { font-weight:bold; color:#131211; }
+    #man pre code { font-weight:normal; color:#232221; background:inherit }
+    #man em, var, u {
+      font-style:normal; color:#333231; border-bottom:1px solid #999; }
+    #man h1.man-title { display:none; }
+    #man ol.man, #man ol.man li { margin:2px 0 10px 0; padding:0;
+      float:left; width:33%; list-style-type:none;
+      text-transform:uppercase; font-size:18px; color:#999;
+      letter-spacing:1px;}
+    #man ol.man { width:100%; }
+    #man ol.man li.tl { text-align:left }
+    #man ol.man li.tc { text-align:center;letter-spacing:4px }
+    #man ol.man li.tr { text-align:right }
+    #man ol.man a { color:#999 }
+    #man ol.man a:hover { color:#333231 }
+  </style>
+</head>
+<body>
+<div id='man'>
+
+<h1 class='man-title'>wti(1)</h1>
+
+<ol class='head man'>
+  <li class='tl'>wti(1)</li>
+  <li class='tc'>Web Translate It</li>
+  <li class='tr'>wti(1)</li>
+</ol>
+
+<h2 id='NAME'>NAME</h2>
+<p><code>wti</code> -- WebTranslateIt.com from the command line</p>
+
+<h2>SYNOPSIS</h2>
+
+<p><code>wti</code> <var>COMMAND</var> <var>OPTIONS</var></p>
+
+<p><code>wti push</code> [<code>-l</code>] <var>OPTIONS</var></p>
+
+<p><code>wti pull</code> [<code>-l</code>] <var>OPTIONS</var></p>
+
+<h2>DESCRIPTION</h2>
+
+<p><code>wti</code> is an utility to help you sync language files between the
+WebTranslateIt.com service and your computer/server.</p>
+
+<p><code>wti push</code> will push your master language file to Web Translate It. It means it will
+update the strings hosted at Web Translate It by the strings from the file you push.</p>
+
+<p><code>wti pull</code> will pull the target language files from Web Translate It. It will download
+and update your file with the latest translations from Web Translate It.</p>
+
+<p><code>wti stats</code> fetch and display translation statistics from Web Translate It.</p>
+
+<h2>OPTIONS</h2>
+
+<p><code>wti</code>'s default mode of operation is to push only the master language file and to only
+pull target language files.</p>
+
+<p>These options can be used to change this behaviour:</p>
+
+<dl>
+<dt class="flush"><code>--all</code></dt><dd><p>Push or pull all. For example, <code>wti push --all</code> will push master and target language files.
+<code>wti pull --all</code> will pull master and target language files</p></dd>
+<dt><code>-l</code>, <code>--locale</code></dt><dd><p>Set the locale to push or pull explicitly. For example <code>wti pull -l fr</code> will only pull
+the French language file.</p></dd>
+<dt class="flush"><code>--force</code></dt><dd><p>The Web Translate It API use HTTP caching to be efficient, and check if your file needs
+to be updated by checking its modification date against the project’s latest activity.
+Use this option to bypass this check.</p></dd>
+</dl>
+
+
+<p>You may additionally ask for help:</p>
+
+<dl>
+<dt><code>-h</code>, <code>--help</code></dt><dd>Print help.</dd>
+</dl>
+
+
+<h2>CONFIGURATION</h2>
+
+<p>The first <code>wti</code> is used on a project, it must be configured.</p>
+
+<p><code>wti autoconf</code> will help you create a configuration file to sync with
+Web Translate It.</p>
+
+<h2>EXAMPLES</h2>
+
+<pre><code>$ wti push
+Pushing ./config/locales/app/en.yml…
+Pushing ./config/locales/defaults/en.yml…
+
+
+$ wti pull -l fr
+Pulling ./config/locales/app/fr.yml…
+Pulling ./config/locales/defaults/fr.yml…
+
+
+$ wti stats
+fr: 100% translated, 90% completed 
+ru: 10% translated, 10% completed 
+pt_BR: 0% translated, 0% completed 
+en: 100% translated, 90% completed
+</code></pre>
+
+<h2>BUGS</h2>
+
+<p><a href="http://github.com/atelierConvivialite/webtranslateit/issues">http://github.com/atelierConvivialite/webtranslateit/issues</a></p>
+
+<h2>AUTHOR</h2>
+
+<p>Édouard Brière :: edouard@atelierconvivialite.com</p>
+
+
+<ol class='foot man'>
+  <li class='tl'>Atelier Convivialité</li>
+  <li class='tc'>March 2010</li>
+  <li class='tr'>wti(1)</li>
+</ol>
+
+</div>
+</body>
+</html>

data/man/wti.1.ron

@@ -0,0 +1,81 @@
+wti(1) -- WebTranslateIt.com from the command line
+==================================================
+ 
+## SYNOPSIS
+ 
+`wti` <COMMAND> <OPTIONS>
+
+`wti push` [`-l`] <OPTIONS>
+
+`wti pull` [`-l`] <OPTIONS>
+
+## DESCRIPTION
+ 
+`wti` is an utility to help you sync language files between the
+WebTranslateIt.com service and your computer/server.
+
+`wti push` will push your master language file to Web Translate It. It means it will
+update the strings hosted at Web Translate It by the strings from the file you push.
+
+`wti pull` will pull the target language files from Web Translate It. It will download
+and update your file with the latest translations from Web Translate It.
+
+`wti stats` fetch and display translation statistics from Web Translate It.
+
+## OPTIONS
+ 
+`wti`'s default mode of operation is to push only the master language file and to only
+pull target language files.
+
+These options can be used to change this behaviour:
+ 
+  * `--all`:
+    Push or pull all. For example, `wti push --all` will push master and target language files.
+    `wti pull --all` will pull master and target language files 
+ 
+  * `-l`, `--locale`:
+    Set the locale to push or pull explicitly. For example `wti pull -l fr` will only pull
+    the French language file.
+  
+  * `--force`:
+    The Web Translate It API use HTTP caching to be efficient, and check if your file needs
+    to be updated by checking its modification date against the project’s latest activity.
+    Use this option to bypass this check.
+    
+You may additionally ask for help:
+ 
+  * `-h`, `--help`:
+    Print help.
+ 
+## CONFIGURATION
+ 
+The first `wti` is used on a project, it must be configured.
+
+`wti autoconf` will help you create a configuration file to sync with
+Web Translate It.
+ 
+## EXAMPLES
+ 
+    $ wti push
+    Pushing ./config/locales/app/en.yml…
+    Pushing ./config/locales/defaults/en.yml…
+    
+    
+    $ wti pull -l fr
+    Pulling ./config/locales/app/fr.yml…
+    Pulling ./config/locales/defaults/fr.yml…
+    
+    
+    $ wti stats
+    fr: 100% translated, 90% completed 
+    ru: 10% translated, 10% completed 
+    pt_BR: 0% translated, 0% completed 
+    en: 100% translated, 90% completed
+ 
+## BUGS
+ 
+<http://github.com/atelierConvivialite/webtranslateit/issues>
+ 
+## AUTHOR
+ 
+Édouard Brière :: edouard@atelierconvivialite.com

data/spec/examples/config/translation.yml

@@ -0,0 +1,15 @@
+# The Project API Token from Web Translate It
+api_key: abcd
+
+# The Master locale is the locale you translate your project from. Web Translate It shouldn’t 
+# attempt to edit these files.
+ignore_locales: en_GB
+
+# A list of files to translate
+# You can name your language files as you want, as long as the locale name match the
+# locale name you set in Web Translate It, and that the different language files names are
+# differenciated by their locale name.
+# For example, if you set to translate a project in en_US in WTI, you should use the locale en_US in your app
+files:
+  - config/locales/file1_[locale].yml
+  - config/locales/file2_[locale].yml

data/spec/examples/en.yml

@@ -0,0 +1,38 @@
+en:
+  activerecord:
+    errors:
+      templates:
+        header:
+          one: "1 error prohibited this {{model}} from being saved"
+          other: "{{count}} errors prohibited this {{model}} from being saved"
+          body: "there were problems with the following fields:"
+          messages:
+            accepted: "must be accepted"
+            blank: "can't be blank"
+            confirmation: "doesn't match confirmation"
+            empty: "can't be empty"
+            equal_to: "must be equal to {{count}}"
+            even: "must be even"
+            exclusion: "is reserved"
+            greater_than: "must be greater than {{count}}"
+            greater_than_or_equal_to: "must be greater than or equal to {{count}}"
+            inclusion: "is not included in the list"
+            invalid: "is invalid"
+            less_than: "must be less than {{count}}"
+            less_than_or_equal_to: "must be less than or equal to {{count}}"
+            not_a_number: "is not a number"
+            odd: "must be odd"
+            taken: "is already taken"
+            too_long: "is too long (maximum is {{count}} characters)"
+            too_short: "is too short (minimum is {{count}} characters)"
+            wrong_length: "is the wrong length (should be {{count}} characters)" 
+      models:
+        invitation:
+          attributes:
+            email:
+              user_already_invited: "This user has already been invited"
+              user_already_member: "This user is already a member"
+        project_file:
+          attributes:
+            file:
+              file_format_not_supported: "Sorry, we currenly support only Gettext .pot/.po, .yml/.yaml and .strings"

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/../lib/web_translate_it'
+# $:.unshift File.dirname(__FILE__) + '/../lib'
+# Dir[File.join(File.dirname(__FILE__), '../vendor/*/lib')].each do |path|
+#   $:.unshift path
+# end

data/spec/web_translate_it/configuration_spec.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe WebTranslateIt::Configuration do
+  before(:each) do
+    WebTranslateIt::Configuration.const_set("RAILS_ROOT", File.dirname(__FILE__) + '/../examples')
+  end
+  
+  describe "#initialize" do
+    it "should fetch and not blow up" do
+      lambda{ WebTranslateIt::Configuration.new }.should_not raise_error
+    end
+        
+    it "should load the content of the YAML file" do
+      config_hash = {
+        "api_key"        => "abcd",
+        "ignore_locales" => "en_GB",
+        "files"          => ["config/locales/file1_[locale].yml", "config/locales/file2_[locale].yml"]
+      }
+      YAML.should_receive(:load_file).and_return(config_hash)
+      WebTranslateIt::Configuration.new
+    end
+    
+    it "should assign the API key, autofetch, files and master_locale" do
+      configuration = WebTranslateIt::Configuration.new
+      configuration.api_key.should == 'abcd'
+      configuration.files.first.should be_a(WebTranslateIt::TranslationFile)
+      configuration.ignore_locales.should == ['en_GB']
+    end
+  end
+  
+end