web_translate_it 1.4.0 → 1.4.1

data/README.md

@@ -11,7 +11,7 @@ This gem provides your app with:
 
 * For each environment you want to use the gem, add to your config/environment/development.rb:
 
-    `config.gem 'web_translate_it', :version => '~> 1.4.0', :source => 'http://gemcutter.org'`
+    `config.gem 'web_translate_it', :version => '~> 1.4.1', :source => 'http://gemcutter.org'`
     
 * Then, run:
 
@@ -56,13 +56,13 @@ Fetch the latest translations for all your files for all languages defined in We
   
 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:send[fr_FR]
+    rake trans:upload[fr_FR]
     
-Updates the latest translations for all your files in a specific locale defined in Web Translate It’s interface.
+Upload to Web Translate It your files in a specific locale defined in Web Translate It’s interface.
 
-    rake trans:version
-  
-Display the gem version.
+    rake trans:config
+    
+Copy a `translation.yml` file to `config/translation.yml` if the file doesn’t exist.
 
 ### Automatically fetch new language files
 
@@ -77,7 +77,7 @@ Use the rack middleware!
   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)`.
+  [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:

data/history.md

@@ -1,3 +1,10 @@
+## Edge
+
+* 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

data/lib/web_translate_it.rb

@@ -4,19 +4,11 @@ require File.join(File.dirname(__FILE__), 'web_translate_it', 'translation_file'
 require File.join(File.dirname(__FILE__), 'web_translate_it', 'auto_fetch')
 
 module WebTranslateIt
-  def self.version
-    hash = YAML.load_file File.join(File.dirname(__FILE__), '../version.yml')
-    [hash[:major], hash[:minor], hash[:patch]].join('.')
-  end
-  
   def self.fetch_translations
     config = Configuration.new
     locale = I18n.locale.to_s
     return if config.ignore_locales.include?(locale)
-    puts "Looking for #{locale} translations..."
-    config.files.each do |file|
-      response_code = file.fetch(locale)
-      puts "Done. Response code: #{response_code}"
-    end
+    puts "Looking for #{locale} translations…"
+    config.files.each {|file| puts "Done. Response: #{file.fetch(locale)}" }
   end
 end

data/lib/web_translate_it/configuration.rb

@@ -24,7 +24,7 @@ module WebTranslateIt
       response.body.split
     end
     
-    def self.generate
+    def self.create_config_file
       config_file = "config/translation.yml"
       unless File.exists?(config_file)
         puts "Creating #{config_file}"

data/lib/web_translate_it/tasks.rb

@@ -4,18 +4,11 @@ namespace :trans do
   desc "Fetch translation files from Web Translate It"
   task :fetch, :locale do |t, args|
     welcome_message
-    colour_puts "<b>Fetching file for locale #{args.locale}...</b>"
+    colour_puts "<b>Fetching file for locale #{args.locale}…</b>"
     configuration = WebTranslateIt::Configuration.new
     configuration.files.each do |file|
       response_code = file.fetch(args.locale)
-      case response_code
-      when 200
-        colour_puts "<green>#{file.file_path_for_locale(args.locale)}: 200 OK. Saving changes</green>"
-      when 304
-        colour_puts "<green>#{file.file_path_for_locale(args.locale)}: 304 Not Modified</green>"
-      else
-        colour_puts "<red>#{file.file_path_for_locale(args.locale)}: Error, unhandled response: #{response_code}</red>"
-      end
+      handle_response(file.file_path_for_locale(args.locale), response_code)
     end
   end
   
@@ -28,49 +21,39 @@ namespace :trans do
       configuration.ignore_locales.each do |ignore|
         locales.delete(ignore)
       end
-      colour_puts "<b>Fetching all files for all locales...</b>"
+      colour_puts "<b>Fetching all files for all locales…</b>"
       locales.each do |locale|
         configuration.files.each do |file|
           response_code = file.fetch(locale) 
-          case response_code
-          when 200
-            colour_puts "<green>#{file.file_path_for_locale(locale)}: 200 OK.</green>"
-          when 304
-            colour_puts "<green>#{file.file_path_for_locale(locale)}: 304 Not Modified</green>"
-          else
-            colour_puts "<red>#{file.file_path_for_locale(locale)}: Error, unhandled response: #{response_code}</red>"
-          end
+          handle_response(file.file_path_for_locale(locale), response_code)
         end
       end
     end
   end
   
-  desc "Send a translation file to Web Translate It"
-  task :send, :locale do |t, args|
+  desc "Upload a translation file to Web Translate It"
+  task :upload, :locale do |t, args|
     welcome_message
-    colour_puts "<b>Sending file for locale #{args.locale}...</b>"
+    colour_puts "<b>Uploading file for locale #{args.locale}…</b>"
     configuration = WebTranslateIt::Configuration.new
     configuration.files.each do |file|
-      response_code = file.send(args.locale)
-      case response_code
-      when 200
-        colour_puts "<green>#{file.file_path_for_locale(args.locale)} uploaded OK.</green>"
-      else
-        colour_puts "<red>#{file.file_path_for_locale(args.locale)}: Error uploading, unhandled response: #{response_code}</red>"
-      end
+      response_code = file.upload(args.locale)
+      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.generate
+    WebTranslateIt::Configuration.create_config_file
   end
   
-  desc "Output the Web Translate It gem version"
-  task :version do
-    welcome_message
-    colour_puts "Web Translate It gem for Ruby on Rails <b>v#{WebTranslateIt.version}</b>"
+  def handle_response(file_path, response_code)
+    if response_code < 400
+      colour_puts "<green>#{file_path}: #{response_code}, OK</green>"
+    else
+      colour_puts "<red>#{file_path}: #{response_code}, Problem!</red>"
+    end
   end
   
   def welcome_message
@@ -84,9 +67,7 @@ namespace :trans do
 private
   
 WELCOME_SCREEN = <<-EO_WELCOME
-
-<banner>Web Translate It</banner>
+<banner>Web Translate It v#{WebTranslateIt::Util.version}</banner>
 
 EO_WELCOME
-  
 end

data/lib/web_translate_it/translation_file.rb

@@ -1,6 +1,7 @@
 module WebTranslateIt
   class TranslationFile
     require 'net/https'
+    require 'net/http/post/multipart'
     require 'time'
     
     attr_accessor :id, :file_path, :api_key
@@ -11,46 +12,43 @@ module WebTranslateIt
       self.api_key   = api_key
     end
     
-    def fetch(locale)
-      http              = Net::HTTP.new('webtranslateit.com', 443)
-      http.use_ssl      = true
-      http.verify_mode  = OpenSSL::SSL::VERIFY_NONE
-      http.read_timeout = 10
-      request           = Net::HTTP::Get.new(api_url(locale))
-      
-      if File.exist?(file_path_for_locale(locale))
-        request.add_field('If-Modified-Since', File.mtime(File.new(file_path_for_locale(locale), 'r')).rfc2822)
-      end
-      response      = http.request(request)
-      response_code = response.code.to_i
-      
-      if response_code == 200 and not response.body == ''
-        locale_file = File.new(file_path_for_locale(locale), 'w')
-        locale_file.puts(response.body)
-        locale_file.close
+    def fetch(locale, force = false)
+      http_connection do |http|
+        request = Net::HTTP::Get.new(api_url(locale))
+        request.add_field('If-Modified-Since', File.mtime(File.new(file_path, 'r')).rfc2822) if File.exist?(file_path) and !force
+        response      = http.request(request)
+        response_code = response.code.to_i
+        File.open(file_path_for_locale(locale), 'w'){ |f| f << response.body } if response_code == 200 and !response.body == ''
+        response_code
       end
-      response_code
     end
     
-    def send(locale)
+    def upload(locale)
       File.open(file_path_for_locale(locale)) do |file|
-        http              = Net::HTTP.new('webtranslateit.com', 443)
-        http.use_ssl      = true
-        http.verify_mode  = OpenSSL::SSL::VERIFY_NONE
-        http.read_timeout = 10
-
-        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
+        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
     
     def file_path_for_locale(locale)
       self.file_path.gsub("[locale]", locale)
     end
+        
+    protected
     
-    def api_url(locale)
-      "/api/projects/#{api_key}/files/#{self.id}/locales/#{locale}"
-    end
+      def http_connection
+        http = Net::HTTP.new('webtranslateit.com', 443)
+        http.use_ssl      = true
+        http.verify_mode  = OpenSSL::SSL::VERIFY_NONE
+        http.read_timeout = 10
+        yield http
+      end
+      
+      def api_url(locale)
+        "/api/projects/#{api_key}/files/#{self.id}/locales/#{locale}"
+      end
   end
 end

data/lib/web_translate_it/util.rb

@@ -3,6 +3,11 @@ module WebTranslateIt
     DEFAULT_TERMINAL_COLORS = "\e[0m\e[37m\e[40m"
     MONOCHROME_OUTPUT = "\\1"
     
+    def self.version
+      hash = YAML.load_file File.join(File.dirname(__FILE__), '..', '..' '/version.yml')
+      [hash[:major], hash[:minor], hash[:patch]].join('.')
+    end
+    
     def self.colourise_output?
       @colourise_output = !!(RUBY_PLATFORM !~ /mswin/ || defined?(Win32::Console::ANSI)) if @colourise_output.nil?
       @colourise_output
@@ -16,14 +21,5 @@ module WebTranslateIt
       data.gsub!(%r{<banner>(.*?)</banner>}m, colourise_output? ? "\e[33m\e[44m\e[1m\\1#{DEFAULT_TERMINAL_COLORS}" : MONOCHROME_OUTPUT)
       data
     end
-    
-    def self.insert_into(file, line)
-      logger.insert "#{line} into #{file}"
-      unless options[:pretend] || file_contains?(file, line)
-        gsub_file file, /^(class|module) .+$/ do |match|
-          "#{match}\n  #{line}"
-        end
-      end
-    end
   end
 end

data/spec/web_translate_it/translation_file_spec.rb

@@ -5,6 +5,15 @@ describe WebTranslateIt::TranslationFile do
     @translation_file = WebTranslateIt::TranslationFile.new(1174, "/config/locales/[locale].yml", "04b254da22a6eb301b103f848e469ad494eea47d")
   end
   
+  describe "#initialize" do
+    it "should assign id, file_path and api_key" do
+      tr_file = WebTranslateIt::TranslationFile.new(1174, "/config/locales/[locale].yml", "04b254da22a6eb301b103f848e469ad494eea47d")
+      tr_file.id.should == 1174
+      tr_file.file_path.should == "/config/locales/[locale].yml"
+      tr_file.api_key.should == "04b254da22a6eb301b103f848e469ad494eea47d"
+    end
+  end
+  
   describe "#fetch" do
     it "should prepare a HTTP request and get a 200 OK if the language file is stale" do
       file = mock(File)
@@ -13,12 +22,47 @@ describe WebTranslateIt::TranslationFile do
       @translation_file.fetch('fr_FR').should == 200
     end
     
+    it "should prepare a HTTP request and get a 200 OK if the language file is stale using the force download parameter" do
+      file = mock(File)
+      file.stub(:puts => true, :close => true)
+      File.stub(:exist? => true, :mtime => Time.at(0), :new => file)
+      @translation_file.fetch('fr_FR', true).should == 200
+    end
+    
     it "should prepare a HTTP request and get a 304 OK if the language file is fresh" do
       file = mock(File)
       file.stub(:puts => true, :close => true)
       File.stub(:exist? => true, :mtime => Time.now, :new => file)
-      @translation_file.stub(:path_to_locale_file => file)
       @translation_file.fetch('fr_FR').should == 304
     end
+    
+    it "should prepare a HTTP request and get a 200 OK if the language file is fresh using the force download parameter" do
+      file = mock(File)
+      file.stub(:puts => true, :close => true)
+      File.stub(:exist? => true, :mtime => Time.now, :new => file)
+      @translation_file.fetch('fr_FR', true).should == 200
+    end
+  end
+  
+  describe "#upload" do
+    it "should prepare a HTTP request and get a 200 OK" do
+      @translation_file.stub(:file_path => File.join(File.dirname(__FILE__), '..', 'examples', 'en.yml'))
+      @translation_file.upload('en')
+    end
+    
+    it "should fail if the file does not exist" do
+      @translation_file.stub(:file_path => File.join('something', 'that', 'does', 'not', 'exist'))
+      lambda { @translation_file.upload('en') }.should raise_error
+    end
+  end
+  
+  describe "#file_path_for_locale" do
+    it "should replace [locale] by the locale passed as a parameter" do
+      @translation_file.file_path_for_locale('fr').should == "/config/locales/fr.yml"
+    end
+    
+    it "should fail if no parameter is given" do
+      lambda { @translation_file.file_path_for_locale }.should raise_error
+    end
   end
 end

data/version.yml

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: web_translate_it
 version: !ruby/object:Gem::Version 
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors: 
 - "\xC3\x89douard Bri\xC3\xA8re"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-06 00:00:00 +01:00
+date: 2010-01-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,6 +34,7 @@ files:
 - history.md
 - MIT-LICENSE
 - README.md
+- version.yml
 - examples/locale.rb
 - lib/web_translate_it.rb
 - lib/web_translate_it/auto_fetch.rb