web_translate_it 1.4.3 → 1.4.4

data/README.md

@@ -1,57 +1,37 @@
-# Web Translate It for Ruby on Rails
+# Web Translate It
 
-This is a gem to integrate your app with [Web Translate It](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 app with [Web Translate It](https://webtranslateit.com).
 
 This gem provides your app with:
 
-* a set of 4 handy rake task to fetch your translations.
+* a handful of rake task to fetch your translations.
 * a rack middleware to automatically fetch new translations from Web Translate It.
 
-Examples
-
-* See a [Rails 2.3 example app](http://github.com/AtelierConvivialite/rails_example_app) using it.
-* All the necessary changes have been made in [this commit](http://github.com/AtelierConvivialite/rails_example_app/commit/d88e4aa62b061f215d1784d76c94cd8613efc9bb)
+## Installation
 
-## First steps
+* Add to your config/environments.rb:
 
-* For each environment you want to use the gem, add to your config/environment/development.rb:
-
-    `config.gem 'web_translate_it', :version => '~> 1.4.2', :source => 'http://gemcutter.org'`
+    `config.gem 'web_translate_it'`
     
 * Then, run:
 
     `rake gems:install`
     
-  Web Translate It doesn’t to be unpacked.
-    
-* Add in your `Rakefile` to add Web Translate It’s rake tasks:
+* Copy/paste your api key from Web Translate It and run:
 
-      `require 'web_translate_it/tasks' rescue LoadError`
-
-* Run:
-
-      `rake trans:config`
+    `script/generate webtranslateit --api-key your_key_here`
     
-  If it doesn’t exist already, it will create a `config/translation.yml` file that contains:
+  The generator does two things:
   
-      api_key: SECRET
-      ignore_locales: :en
-      wti_id1: config/locales/file1_[locale].yml
-      wti_id2: config/locales/file2_[locale].yml</pre>
-
-`api_key` is the API key (or token) provided per project by Web Translate It.
-
-`ignore_locales` is an array of symbols, an array of strings, a symbol or a string of locales not to sync with Web Translate It. You usually don’t want to sync your master language files.
-
-`wti_id1` is the id of your *master* language file on Web Translate It. If you only have one language file, then only put this one in the configuration file.
-
-`config/locales/file1_[locale].yml` is the name of your language file on your project. To keep things simple, the gem makes the reasonable assumption that you differentiate your language files using the locale name. For example, you will have `file1_en.yml` for English, and `file1_fr.yml` for French. Replace `en` or `fr` by `[locale]` and the gem will update the files `file1_en.yml` and `file1_fr.yml`.
-
-The gem also assume that you use the same locale name on your project and on Web Translate It. For example if you use the locale `fr_FR` on Web Translate It, then you should use `fr_FR` on your project.
-
-### Rake tasks provided
+  * 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
 
-The gem provides 4 rake tasks.
+The gem provides 3 rake tasks.
 
     rake trans:fetch:all
   
@@ -65,27 +45,19 @@ Fetch the latest translations for all the languages defined in Web Translate It
     
 Upload to Web Translate It your files in a specific locale defined in Web Translate It’s interface.
 
-    rake trans:config
-    
-Copy a `translation.yml` file to `config/translation.yml` if the file doesn’t exist.
-
-### Automatically fetch new language files
+## Optional: automatically fetch new language files for each page request
 
-This is useful for translators on development and staging environment: you get the strings as soon as they are translated on Web Translate It, but you probably don’t want this on production for performance and reliability reasons.
+This should not be used on production. This allows to translate text on Web Translate It, reload a page on your site and see the translations appear.
 
-#### Rails 2.3 and newer
+### Rails 2.3 and newer
 
 Use the rack middleware!
 
-* Before starting up anything, you need to have a rack middleware setup to assign the value of the current locale to
-  `I18n.locale`.
-  This is very much specific to your app, this is left as an exercise to the reader. You can inspire yourself from 
-  Ryan Tomakyo’s [locale.rb](http://github.com/rack/rack-contrib/blob/master/lib/rack/contrib/locale.rb).
-  You can also find an example of a very simple middleware using the `locale` parameter in
-  [examples/locale.rb](http://github.com/AtelierConvivialite/webtranslateit/blob/master/examples/locale.rb).
+* Before starting up anything, you need to have a rack middleware setup to assign the value of the current locale to `I18n.locale`.
+  This is very much specific to your app, this is left as an exercise to the reader. You can inspire yourself from Ryan Tomakyo’s [locale.rb](http://github.com/rack/rack-contrib/blob/master/lib/rack/contrib/locale.rb).
+  You can also find an example of a very simple middleware using the `locale` parameter in [examples/locale.rb](http://github.com/AtelierConvivialite/webtranslateit/blob/master/examples/locale.rb).
 
-* The next step is to setup the `autofetch` middleware. Add in `config/environments/development.rb` and any other 
-  environments you want to autofetch this line:
+* The next step is to setup the `autofetch` middleware. Add in `config/environments/development.rb` and any other environments you want to autofetch this line:
 
       config.middleware.use "WebTranslateIt::AutoFetch"
     
@@ -96,7 +68,7 @@ Use the rack middleware!
     
 * That’s it!
 
-#### Rails older than 2.3 (works also for 2.3 and newer)
+### Rails older than 2.3 (works also for 2.3 and newer)
 
 * Add the following lines in your `ApplicationController`:
 
@@ -119,17 +91,17 @@ end</pre>
 
 ## Supported Rails Versions
 
-The gem currently has been tested against the following version of Rails:
+The gem currently has been tested against the following versions of Rails:
 
 * 2.3.4
 * 2.3.5
 
-Please open a discussion on [the support forum](https://webtranslateit.com/forum) if you're using a version of Rails that is not listed above and the gem is not working properly.
+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.
 
-## What is Web Translate It anyway?
+# What is Web Translate It anyway?
 
-Web Translate It is a web-based software for translating websites and applications. Its API it affords you to translate on Web Translate It’s web interface and test your translations on your development or staging environment. This is really useful for translations to translate on a stable environment, while being able to test their work directly.
+Web Translate It is an easy to use web-based translation hub to collaboratively translate software.
 
-Take a look at the [tour page](https://webtranslateit.com/tour) and at our [plans](https://webtranslateit.com/plans). We have a 10-day free trial, so you can give it a try for free.
+To learn more about it, please visit our [tour page](https://webtranslateit.com/tour).
 
-Released under the MIT License.
+This gem is released under the MIT License.

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,44 @@
+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 fetch_project_information(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
+  
+  def fetch_project_information(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
+end

data/history.md

@@ -1,3 +1,8 @@
+## Version 1.4.4 / 2010-02-02
+
+* 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.

data/lib/web_translate_it/configuration.rb

@@ -30,14 +30,6 @@ module WebTranslateIt
       end
     end
     
-    def self.create_config_file
-      config_file = "config/translation.yml"
-      unless File.exists?(config_file)
-        puts "Created #{config_file}"
-        FileUtils.copy File.join(File.dirname(__FILE__), '..', '..', 'examples', 'translation.yml'), config_file
-      end
-    end
-    
     def api_url
       "/api/projects/#{api_key}/locales"
     end

data/lib/web_translate_it/tasks.rb

@@ -41,13 +41,7 @@ namespace :trans do
       handle_response(file.file_path_for_locale(args.locale), response_code)
     end
   end
-  
-  desc "Install Web Translate It for your application"
-  task :config do
-    welcome_message
-    WebTranslateIt::Configuration.create_config_file
-  end
-  
+    
   def handle_response(file_path, response_code)
     if response_code < 400
       puts "#{file_path}: #{response_code}, OK"

data/spec/web_translate_it/util_spec.rb

@@ -0,0 +1,10 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe WebTranslateIt::Util do
+    
+  describe "Util.version" do
+    it "should return a String" do
+      WebTranslateIt::Util.version.should be_a(String)
+    end
+  end
+end

data/spec/web_translate_it_spec.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+module WebTranslateIt
+  class I18n
+  end
+end
+
+describe WebTranslateIt do
+  
+  before(:each) do
+    WebTranslateIt::I18n.stub(:locale => 'en')
+    WebTranslateIt::Configuration.const_set("RAILS_ROOT", File.dirname(__FILE__) + '/examples')
+    @configuration = WebTranslateIt::Configuration.new
+    @file = mock(WebTranslateIt::TranslationFile)
+    @file.stub(:fetch => true)
+    @configuration.stub(:files => [@file])
+    WebTranslateIt::Configuration.stub(:new => @configuration)
+    
+  end
+  
+  describe "WebTranslateIt.fetch_translations" do
+    it "should fetch the configuration" do
+      WebTranslateIt::Configuration.should_receive(:new)
+      WebTranslateIt.fetch_translations
+    end
+  end
+end

data/version.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
 :minor: 4
-:patch: 3
+:patch: 4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: web_translate_it
 version: !ruby/object:Gem::Version 
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors: 
 - "\xC3\x89douard Bri\xC3\xA8re"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-09 00:00:00 +01:00
+date: 2010-02-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1.0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mg
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.7
+    version: 
 description: A rack middleware and a handful of rake tasks to sync your translations between webtranslateit.com and your rails applications.
 email: edouard@atelierconvivialite.com
 executables: []
@@ -37,13 +57,16 @@ files:
 - version.yml
 - examples/locale.rb
 - examples/translation.yml
-- lib/web_translate_it.rb
 - lib/web_translate_it/auto_fetch.rb
 - lib/web_translate_it/configuration.rb
+- lib/web_translate_it/tasks.rb
 - lib/web_translate_it/translation_file.rb
 - lib/web_translate_it/util.rb
-- lib/web_translate_it/tasks.rb
-has_rdoc: false
+- lib/web_translate_it.rb
+- generators/webtranslateit/lib/insert_commands.rb
+- generators/webtranslateit/templates/translation.yml
+- generators/webtranslateit/webtranslateit_generator.rb
+has_rdoc: true
 homepage: https://webtranslateit.com
 licenses: []
 
@@ -72,9 +95,11 @@ signing_key:
 specification_version: 3
 summary: Sync your translations between your Rails app and Web Translate It
 test_files: 
+- spec/examples/config/translation.yml
+- spec/examples/en.yml
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/web_translate_it/configuration_spec.rb
 - spec/web_translate_it/translation_file_spec.rb
-- spec/examples/en.yml
-- spec/examples/config/translation.yml
+- spec/web_translate_it/util_spec.rb
+- spec/web_translate_it_spec.rb