wti_gettext_i18n_rails 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009-2010 Atelier Convivialité
+
+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 the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# Web Translate It
+
+[Homepage](https://webtranslateit.com) | 
+[RDocs](http://yardoc.org/docs/AtelierConvivialite-webtranslateit) | 
+[Metrics](http://getcaliper.com/caliper/project?repo=git%3A%2F%2Fgithub.com%2FAtelierConvivialite%2Fwebtranslateit.git) | 
+[Tests](http://runcoderun.com/AtelierConvivialite/webtranslateit/builds/74a78c2b382cb1856fa0964ed4ad372b50872844/1/ruby_186) | 
+[Example app](http://github.com/AtelierConvivialite/rails_example_app)
+
+This is a gem providing tools to integrate your software to translate with [Web Translate It](https://webtranslateit.com), a web-based translation hub.
+
+![Web Translate It](http://s3.amazonaws.com:80/edouard.baconfile.com/web_translate_it%2Fwti.png)
+
+This gem provides your app with:
+
+* an executable, `wti`, to upload and download language files from the command line (or in whatever else you want to execute it)
+* a handful of rake task to fetch and upload your translations.
+* a rack middleware to automatically fetch new translations from Web Translate It.
+
+## Installation
+
+    gem install web_translate_it
+    
+That’s it! At this point you have the Web Translate It executable.
+If your project if already set up on Web Translate It, run `wti autoconf` to generate the configuration file.
+
+Run `wti --help` to see the usage:
+
+    pull            Pull target language file(s) from Web Translate It.
+    push            Push master language file(s) to Web Translate It.
+    autoconf        Configure your project to sync with Web Translate It.
+    stats           Fetch and display your project statistics.
+
+    OPTIONAL PARAMETERS:
+    --------------------
+    -l --locale     The ISO code of a specific locale to pull or push.
+    -c --config     Path to a translation.yml file. If this option
+                    is absent, looks for config/translation.yml.
+    --all           Respectively download or upload all files.
+    --force         Force wti pull to re-download the language file,
+                    regardless if local version is current.
+    OTHER:
+    ------
+    -v --version    Show version.
+    -h --help       This page.
+
+## Specific tools for Ruby on Rails
+
+This gem includes some rake tasks and a rack middleware to integrate Web Translate It with Ruby on Rails.
+
+* Add to your config/environments.rb:
+
+    `config.gem 'web_translate_it'`
+    
+* Then, run:
+
+    `rake gems:install`
+
+* Copy/paste 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`
+  
+### Rake tasks provided
+
+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
+
+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 is very much inspired from the awesome [Gemcutter](http://gemcutter.org/) commands,
+* The Rails generator has been pinched from [Hoptoad Notifier](http://github.com/thoughtbot/hoptoad_notifier/).
+
+# What is Web Translate It anyway?
+
+Web Translate It is a web-based translation hub to collaboratively translate software.
+
+To learn more about it, please visit our [tour page](https://webtranslateit.com/tour).
+
+This gem is released under the MIT License.

data/bin/wti

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'web_translate_it'
+# require 'lib/web_translate_it' # for testing
+WebTranslateIt::CommandLine.run

data/examples/locale.rb

@@ -0,0 +1,12 @@
+class Locale
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    req = Rack::Request.new(env)
+    I18n.locale = req.params['locale']
+    status, headers, response = @app.call(env)
+    [status, headers, response.body]
+  end
+end

data/examples/translation.yml

@@ -0,0 +1,18 @@
+# The Project API Token from Web Translate It
+api_key: SECRET
+
+# The locales not to sync with Web Translate It.
+# Pass an array of string, or an array of symbols, a string or a symbol.
+# eg. [:en, :fr] or just 'en'
+ignore_locales: :en
+
+# 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
+#
+# wti_id is the file id from Web Translate It.
+files:
+  wti_id: config/locales/file1_[locale].yml
+  wti_id: config/locales/file2_[locale].yml

data/generators/webtranslateit/lib/insert_commands.rb

@@ -0,0 +1,34 @@
+# Mostly pinched from http://github.com/ryanb/nifty-generators/tree/master
+
+Rails::Generator::Commands::Base.class_eval do
+  def file_contains?(relative_destination, line)
+    File.read(destination_path(relative_destination)).include?(line)
+  end
+end
+
+Rails::Generator::Commands::Create.class_eval do
+  def append_to(file, line)
+    logger.insert "#{line} appended to #{file}"
+    unless options[:pretend] || file_contains?(file, line)
+      File.open(file, "a") do |file|
+        file.puts
+        file.puts line
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def append_to(file, line)
+    logger.remove "#{line} removed from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n#{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def append_to(file, line)
+    logger.insert "#{line} appended to #{file}"
+  end
+end

data/generators/webtranslateit/templates/translation.yml

@@ -0,0 +1,17 @@
+# The Project API Token from Web Translate It
+api_key: '<%= api_key %>'
+
+# The locales not to sync with Web Translate It.
+# Pass an array of string, or an array of symbols, a string or a symbol.
+# eg. [:en, :fr] or just 'en'
+ignore_locales: '<%= project["source_locale"]["code"] %>'
+
+# 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
+#
+# wti_id is the file id from Web Translate It.
+files:
+<% project["project_files"].each do |project_file| -%><% if project_file["master"] -%>  <%= project_file["id"] %>: config/locales/<%= project_file["name"].gsub(project["source_locale"]["code"], "[locale]") %><% end %><% end -%>

data/generators/webtranslateit/webtranslateit_generator.rb

@@ -0,0 +1,26 @@
+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
+
+  def manifest
+    if !api_key_configured? && !options[:api_key]
+      puts "You must pass --api-key or create config/translations.yml"
+      exit
+    end
+    record do |m|
+      if options[:api_key]
+        project_details = YAML.load WebTranslateIt::Project.fetch_info(options[:api_key])
+        m.template 'translation.yml', 'config/translation.yml',
+          :assigns => { :api_key => options[:api_key], :project => project_details["project"] }
+        m.append_to 'Rakefile', "require 'web_translate_it/tasks' rescue LoadError"
+      end
+    end
+  end
+
+  def api_key_configured?
+    File.exists?('config/translations.yml')
+  end
+end

data/history.md

@@ -0,0 +1,99 @@
+## Version 1.5.2 /2010-03-13
+
+* Only added a man page.
+
+## Version 1.5.1 /2010-03-09
+
+* Add `wti stats`, to fetch the project stats from the stats API endpoint.
+
+## Version 1.5.0 /2010-02-19
+
+Warning, some deprecations in this version.
+
+* Remove `wti fetch` and `wti upload`. It was deprecated in 1.4.7 in favour of `wti pull` and `wti push` respectively.
+* `wti push` now only pushes the master language file. Use `wti push --all` to push all or `wti push -l [locale]` to push a specific locale.
+* `wti pull` now only pulls the target language files. Use `wti pull --all` to pull all or `wti pull -l [locale]` to pull a specific locale.
+* Increase read timeout to 40s — Required for very large projects.
+* Bug fix: `wti autoconf` now create directory if it doesn't exist.
+* Bug fix: `wti autoconf` now ask the user where are the locale files.
+
+## Version 1.4.7 /2010-02-05
+
+* Add deprecation warning for `wti --fetch`, `wti -f`. These commands will be deprecated in favour of `wti pull`.
+* Add deprecation warning for `wti --upload`, `wti -u`. These commands will be deprecated in favour of `wti push`.
+* Add -c parameter to specify a configuration file at a custom location.
+* Add -l parameter to specify a specific language file to pull or push (only works with `wti pull` and `wti push`).
+* Add --force parameter to force Web Translate It to send the language files again, regardless if the current 
+  language file version is current (this makes `wti pull` very much slower).
+* Add `wti autoconf` command to automatically configure your project for Web Translate It.
+
+## Version 1.4.6 /2010-02-04
+
+* Add feedback when using the `wti command`.
+* Fix bug where fetch requests were not using the conditional get requests feature.
+
+## Version 1.4.5 /2010-02-02
+
+* Improved documentation
+* Web Translate is now an executable: `wti`
+
+## Version 1.4.4 / 2010-02-01
+
+* Add generator to automatically configure your project, given a Web Translate It API key.
+* Remove rake trans:config, as configuration is now handled by the generator.
+
+## Version 1.4.3 / 2010-01-09
+
+* Remove colour outputs as it increases code complexity and doesn't add any value.
+* Rack middleware now write to the application’s log file instead of just puts-ing
+* Better error messages for misconfigured projects
+
+## Version 1.4.2 / 2010-01-07
+
+* Bug fix for `rake trans:config` which was not installing the translation.yml file properly.
+
+## Version 1.4.1 / 2010-01-07
+
+* Rename `rake trans:send[fr_Fr]` to `rake trans:upload[fr_FR]`
+* Remove `rake trans:version` task. Instead, version number is displayed in the welcome banner.
+* Code refactoring
+* More tests
+
+## Version 1.4.0 / 2010-01-06
+
+* The plugin is now a gem
+
+## Version 1.3.0 / 2010-01-05
+
+* Add rack middleware to automatically fetch your translations
+* Remove `autofetch` parameter in configuration file as it is better off to leave it to the user to
+  include the rack middleware in each environment file.
+* Add example of rack middleware for setting up I18n.locale
+
+## Version 1.2.1 / 2010-01-04
+
+* Add some documentation
+* More feedback on file upload
+
+## Version 1.2 / 2010-01-04
+
+* New: Ability to **update** language files via PUT requests. Upload brand new language files is not possible at the moment.
+
+## Version 1.1.1 / 2010-01-04
+
+* Fix: locales in exclude list are no longer autofetched when browsing the app in these locales.
+
+## Version 1.1 / 2010-01-04
+
+* Support for multi-files projects.
+* Deprecate `rake translation:*` in favour of the shorter form `rake trans`.
+* Add task `rake trans:fetch[en_US]` to fetch files locale by locale.
+* Add task `rake trans:fetch:all` to fetch all the files for all locales defined in Web Translate It’s web interface.
+
+## Version 1.0.0 / 2009-11-02
+
+* Better support for exceptions.
+
+## Version 0.9.0 / 2009-10-26
+
+* First version, plugin only support download of strings. Strings upload will be available in a later version.

data/lib/web_translate_it/auto_fetch.rb

@@ -0,0 +1,22 @@
+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.
+  # Implementation example:
+  #
+  #   # in config/environment.rb:
+  #   config.middleware.use "WebTranslateIt::AutoFetch"
+  #
+  class AutoFetch
+    def initialize(app)
+      @app = app
+    end
+  
+    def call(env)
+      WebTranslateIt::fetch_translations
+      status, headers, response = @app.call(env)
+      [status, headers, response.body]
+    end
+  end
+end

data/lib/web_translate_it/command_line.rb

@@ -0,0 +1,167 @@
+# encoding: utf-8
+module WebTranslateIt
+  class CommandLine
+    require 'fileutils'
+    
+    OPTIONS = <<-OPTION
+pull            Pull target language file(s) from Web Translate It.
+push            Push master language file(s) to Web Translate It.
+autoconf        Configure your project to sync with Web Translate It.
+stats           Fetch and display your project statistics.
+
+OPTIONAL PARAMETERS:
+--------------------
+-l --locale     The ISO code of a specific locale to pull or push.
+-c --config     Path to a translation.yml file. If this option
+                is absent, looks for config/translation.yml.
+--all           Respectively download or upload all files.
+--force         Force wti pull to re-download the language file,
+                regardless if local version is current.
+OTHER:
+------
+-v --version    Show version.
+-h --help       This page.
+OPTION
+    
+    def self.run
+      case ARGV[0]
+      when 'pull'
+        pull
+      when 'push'
+        push
+      when 'autoconf'
+        autoconf
+      when 'stats'
+        stats
+      when '-v', '--version'
+        show_version
+      when '-h', '--help'
+        show_options
+      else
+        puts "Command not found"
+        show_options
+      end
+    end
+        
+    def self.pull
+      configuration = fetch_configuration
+      locales = fetch_locales_to_pull(configuration)
+      configuration.files.each do |file|
+        locales.each do |locale|
+          puts "Pulling #{file.file_path_for_locale(locale)}…"
+          file.fetch(locale, ARGV.index('--force'))
+        end
+      end
+    end
+    
+    def self.push
+      configuration = fetch_configuration
+      locales = fetch_locales_to_push(configuration)
+      configuration.files.each do |file|
+        locales.each do |locale|
+          puts "Pushing #{file.file_path_for_locale(locale)}…"
+          file.upload(locale)
+        end
+      end
+    end
+    
+    def self.autoconf
+      puts "We will attempt to configure your project automagically"
+      puts "Please enter your project API Key:"
+      api_key = STDIN.gets.strip
+      if api_key == ""
+        puts "You must enter your project API key provided by Web Translate It"
+        exit
+      end
+      puts "Where should we create the configuration file? (Default: `config/translation.yml`)"
+      path = STDIN.gets.strip
+      path = "config/translation.yml" if path == ""
+      FileUtils.mkpath(path.split('/')[0..path.split('/').size-1])
+      puts "Where are you language files located? (Default: `config/locales/`)"
+      path_to_locale_files = STDIN.gets.strip
+      path_to_locale_files = "config/locales/" if path_to_locale_files == ""
+      FileUtils.mkpath(path.split('/')[0..path.split('/').size-1])
+      File.open(path, 'w'){ |file| file << generate_configuration(api_key, path_to_locale_files) }
+      puts "Done! You can now use `wti` to push and pull your language files."
+      puts "Check `wti --help` for more information."
+    end
+    
+    def self.stats
+      configuration = fetch_configuration
+      stats = YAML.load(Project.fetch_stats(configuration.api_key))
+      stats.each do |locale, values|
+        percent_translated = Util.calculate_percentage(values['count_strings_to_proofread'] + values['count_strings_done'] + values['count_strings_to_verify'], values['count_strings'])
+        percent_completed  = Util.calculate_percentage(values['count_strings_done'], values['count_strings'])
+        puts "#{locale}: #{percent_translated}% translated, #{percent_completed}% completed #{values['stale'] ? "Stale" : ""}"
+      end
+    end
+    
+    def self.show_options
+      puts ""
+      puts "Web Translate It Help:"
+      puts "**********************"
+      $stdout.puts OPTIONS
+    end
+    
+    def self.show_version
+      puts ""
+      puts "Web Translate It #{WebTranslateIt::Util.version}"
+    end
+    
+    def self.fetch_configuration
+      if (index = ARGV.index('-c') || ARGV.index('--config')).nil?
+        configuration = WebTranslateIt::Configuration.new('.')
+      else
+        configuration = WebTranslateIt::Configuration.new('.', ARGV[index+1])
+      end
+      return configuration
+    end
+    
+    def self.fetch_locales_to_pull(configuration)
+      if (index = ARGV.index('-l') || ARGV.index('--locale')).nil?
+        locales = configuration.target_locales
+      else
+        locales = [ARGV[index+1]]
+      end
+      locales.push(configuration.source_locale) if ARGV.index('--all')
+      return locales.uniq
+    end
+    
+    def self.fetch_locales_to_push(configuration)
+      if (index = ARGV.index('-l') || ARGV.index('--locale')).nil?
+        locales = [configuration.source_locale]
+      else
+        locales = [ARGV[index+1]]
+      end
+      locales.push(configuration.target_locales) if ARGV.index('--all')
+      return locales.uniq
+    end
+    
+    def self.generate_configuration(api_key, path_to_locale_files)
+      project_info = YAML.load WebTranslateIt::Project.fetch_info(api_key)
+      project = project_info['project']
+      file = <<-FILE
+api_key: #{api_key}
+
+# The locales not to sync with Web Translate It.
+# Pass an array of string, or an array of symbols, a string or a symbol.
+# eg. [:en, :fr] or just 'en'
+ignore_locales: '#{project["source_locale"]["code"]}'
+
+# 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:
+FILE
+      project["project_files"].each do |project_file|
+        if project_file["master"]
+          file << "  #{project_file["id"]}: #{path_to_locale_files}" + project_file["name"].gsub(project["source_locale"]["code"], "[locale]") + "\n"
+        end
+      end
+      return file
+    end
+  end
+end

data/lib/web_translate_it/configuration.rb

@@ -0,0 +1,54 @@
+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 config/translation.yml file:
+  #
+  #   configuration = WebTranslateIt::Configuration.new
+  #
+  class Configuration
+    require 'yaml'
+    require 'fileutils'
+    attr_accessor :path, :api_key, :source_locale, :target_locales, :files, :ignore_locales, :logger
+    
+    # Load configuration file from the path.
+    def initialize(root_path=RAILS_ROOT, path_to_config="config/translation.yml")
+      self.path           = root_path
+      configuration       = YAML.load_file(File.join(root_path, path_to_config))
+      self.logger         = logger
+      self.api_key        = configuration['api_key']
+      self.files          = []
+      self.ignore_locales = configuration['ignore_locales'].split.map{ |locale| locale.to_s }
+      configuration['files'].each do |file_id, file_path|
+        self.files.push(TranslationFile.new(file_id, root_path + '/' + file_path, api_key))
+      end
+      set_locales
+    end
+    
+    # Makes an API request to fetch the list of the different locales for a project.
+    # Implementation example:
+    #
+    #   configuration = WebTranslateIt::Configuration.new
+    #   locales = configuration.locales # returns an array of locales: ['en', 'fr', 'es', ...]
+    def set_locales
+      project_info = YAML.load WebTranslateIt::Project.fetch_info(api_key)
+      project = project_info['project']
+      self.source_locale  = project['source_locale']['code']
+      self.target_locales = project['target_locales'].map{|locale| locale['code']}
+    end
+    
+    # Convenience method which returns the endpoint for fetching a list of locales for a project.
+    def api_url
+      "/api/projects/#{api_key}.yaml"
+    end
+    
+    # Returns a logger. If RAILS_DEFAULT_LOGGER is defined, use it, else, define a new logger.
+    def logger
+      if defined?(Rails.logger)
+        Rails.logger
+      elsif defined?(RAILS_DEFAULT_LOGGER)
+        RAILS_DEFAULT_LOGGER
+      end
+    end
+  end
+end

data/lib/web_translate_it/project.rb

@@ -0,0 +1,38 @@
+module WebTranslateIt
+  class Project
+    
+    def self.fetch_info(api_key)
+      WebTranslateIt::Util.http_connection do |http|
+        request  = Net::HTTP::Get.new("/api/projects/#{api_key}.yaml")
+        response = http.request(request)
+        if response.code.to_i >= 400 and response.code.to_i < 500
+          puts "We had a problem connecting to Web Translate It with this API key."
+          puts "Make sure it is correct."
+          exit
+        elsif response.code.to_i >= 500
+          puts "Web Translate It is temporarily unavailable. Please try again shortly."
+          exit
+        else
+          return response.body
+        end
+      end
+    end
+    
+    def self.fetch_stats(api_key)
+      WebTranslateIt::Util.http_connection do |http|
+        request  = Net::HTTP::Get.new("/api/projects/#{api_key}/stats.yaml")
+        response = http.request(request)
+        if response.code.to_i >= 400 and response.code.to_i < 500
+          puts "We had a problem connecting to Web Translate It with this API key."
+          puts "Make sure it is correct."
+          exit
+        elsif response.code.to_i >= 500
+          puts "Web Translate It is temporarily unavailable. Please try again shortly."
+          exit
+        else
+          return response.body
+        end
+      end
+    end
+  end
+end