web_translate_it 1.4.2 → 1.4.3

data/README.md

@@ -7,6 +7,11 @@ This gem provides your app with:
 * a set of 4 handy 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)
+
 ## First steps
 
 * For each environment you want to use the gem, add to your config/environment/development.rb:

data/history.md

@@ -1,3 +1,9 @@
+## 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.

data/lib/web_translate_it.rb

@@ -8,7 +8,10 @@ module WebTranslateIt
     config = Configuration.new
     locale = I18n.locale.to_s
     return if config.ignore_locales.include?(locale)
-    puts "Looking for #{locale} translations…"
-    config.files.each {|file| puts "Done. Response: #{file.fetch(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/lib/web_translate_it/auto_fetch.rb

@@ -6,7 +6,7 @@ module WebTranslateIt
   
     def call(env)
       # Update language files
-      fetch_translations
+      WebTranslateIt::fetch_translations
       status, headers, response = @app.call(env)
       [status, headers, response.body]
     end

data/lib/web_translate_it/configuration.rb

@@ -2,27 +2,32 @@ module WebTranslateIt
   class Configuration
     require 'yaml'
     require 'fileutils'
-    attr_accessor :api_key, :files, :ignore_locales
+    attr_accessor :api_key, :files, :ignore_locales, :logger
     
     def initialize
       file = File.join(RAILS_ROOT, 'config', 'translation.yml')
       configuration       = YAML.load_file(file)
+      self.logger         = logger
       self.api_key        = configuration['api_key']
       self.files          = []
-      self.ignore_locales = configuration['ignore_locales'].to_a.map{ |l| l.to_s }
+      self.ignore_locales = configuration['ignore_locales'].to_a.map{ |locale| locale.to_s }
       configuration['files'].each do |file_id, file_path|
         self.files.push(TranslationFile.new(file_id, file_path, api_key))
       end
     end
     
     def locales
-      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/projects/#{api_key}/locales")
-      response          = http.request(request)
-      response.body.split
+      WebTranslateIt::Util.http_connection do |http|
+        request  = Net::HTTP::Get.new(api_url)
+        response = http.request(request)
+        if response.code.to_i >= 400 and response.code.to_i < 500
+          puts "----------------------------------------------------------------------"
+          puts "You API key seems to be misconfigured. It is currently “self.api_key”."
+          puts "Change it in RAILS_ROOT/configuration/translation.yml."
+        else
+          response.body.split
+        end
+      end
     end
     
     def self.create_config_file
@@ -32,5 +37,17 @@ module WebTranslateIt
         FileUtils.copy File.join(File.dirname(__FILE__), '..', '..', 'examples', 'translation.yml'), config_file
       end
     end
+    
+    def api_url
+      "/api/projects/#{api_key}/locales"
+    end
+    
+    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/tasks.rb

@@ -2,9 +2,9 @@ require File.join(File.dirname(__FILE__), '..', 'web_translate_it')
 
 namespace :trans do  
   desc "Fetch translation files from Web Translate It"
-  task :fetch, :locale do |t, args|
+  task :fetch, :locale do |task, args|
     welcome_message
-    colour_puts "<b>Fetching file for locale #{args.locale}…</b>"
+    puts "Fetching file for locale #{args.locale}…"
     configuration = WebTranslateIt::Configuration.new
     configuration.files.each do |file|
       response_code = file.fetch(args.locale)
@@ -21,7 +21,7 @@ namespace :trans do
       configuration.ignore_locales.each do |ignore|
         locales.delete(ignore)
       end
-      colour_puts "<b>Fetching all files for all locales…</b>"
+      puts "Fetching all files for all locales…"
       locales.each do |locale|
         configuration.files.each do |file|
           response_code = file.fetch(locale) 
@@ -32,9 +32,9 @@ namespace :trans do
   end
   
   desc "Upload a translation file to Web Translate It"
-  task :upload, :locale do |t, args|
+  task :upload, :locale do |task, args|
     welcome_message
-    colour_puts "<b>Uploading file for locale #{args.locale}…</b>"
+    puts "Uploading file for locale #{args.locale}…"
     configuration = WebTranslateIt::Configuration.new
     configuration.files.each do |file|
       response_code = file.upload(args.locale)
@@ -50,24 +50,13 @@ namespace :trans do
   
   def handle_response(file_path, response_code)
     if response_code < 400
-      colour_puts "<green>#{file_path}: #{response_code}, OK</green>"
+      puts "#{file_path}: #{response_code}, OK"
     else
-      colour_puts "<red>#{file_path}: #{response_code}, Problem!</red>"
+      puts "#{file_path}: #{response_code}, Problem!"
     end
   end
   
   def welcome_message
-    colour_puts WELCOME_SCREEN
+    puts "Web Translate It v#{WebTranslateIt::Util.version}"
   end
-  
-  def colour_puts(text)
-    puts WebTranslateIt::Util.subs_colour(text)
-  end
-  
-private
-  
-WELCOME_SCREEN = <<-EO_WELCOME
-<banner>Web Translate It v#{WebTranslateIt::Util.version}</banner>
-
-EO_WELCOME
 end

data/lib/web_translate_it/translation_file.rb

@@ -13,19 +13,18 @@ module WebTranslateIt
     end
     
     def fetch(locale, force = false)
-      http_connection do |http|
+      WebTranslateIt::Util.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
+        request.add_field('If-Modified-Since', last_modification(file_path)) if File.exist?(file_path) 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
     
     def upload(locale)
       File.open(file_path_for_locale(locale)) do |file|
-        http_connection do |http|
+        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
@@ -38,15 +37,11 @@ module WebTranslateIt
     end
         
     protected
-    
-      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 last_modification(file_path)
+        File.mtime(File.new(file_path, 'r')).rfc2822
+      end
+            
       def api_url(locale)
         "/api/projects/#{api_key}/files/#{self.id}/locales/#{locale}"
       end

data/lib/web_translate_it/util.rb

@@ -1,25 +1,17 @@
 module WebTranslateIt
   class Util    
-    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
-    end
-
-    def self.subs_colour(data)
-      data = data.gsub(%r{<b>(.*?)</b>}m, colourise_output? ? "\e[1m\\1#{DEFAULT_TERMINAL_COLORS}" : MONOCHROME_OUTPUT)
-      data.gsub!(%r{<red>(.*?)</red>}m, colourise_output? ? "\e[1m\e[31m\\1#{DEFAULT_TERMINAL_COLORS}" : MONOCHROME_OUTPUT)
-      data.gsub!(%r{<green>(.*?)</green>}m, colourise_output? ? "\e[1m\e[32m\\1#{DEFAULT_TERMINAL_COLORS}" : MONOCHROME_OUTPUT)
-      data.gsub!(%r{<yellow>(.*?)</yellow>}m, colourise_output? ? "\e[1m\e[33m\\1#{DEFAULT_TERMINAL_COLORS}" : MONOCHROME_OUTPUT)
-      data.gsub!(%r{<banner>(.*?)</banner>}m, colourise_output? ? "\e[33m\e[44m\e[1m\\1#{DEFAULT_TERMINAL_COLORS}" : MONOCHROME_OUTPUT)
-      data
+    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 = 10
+      yield http
     end
+    
   end
 end

data/version.yml

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: web_translate_it
 version: !ruby/object:Gem::Version 
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors: 
 - "\xC3\x89douard Bri\xC3\xA8re"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-07 00:00:00 +01:00
+date: 2010-01-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency