web_translate_it 1.4.7 → 1.5.0

data/README.md

@@ -8,6 +8,8 @@
 
 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)
@@ -23,10 +25,8 @@ If your project if already set up on Web Translate It, run `wti autoconf` to gen
 
 Run `wti --help` to see the usage:
 
-    Web Translate It Help:
-    **********************
-    pull            Pull language file(s) from Web Translate It.
-    push            Push language file(s) to Web Translate It.
+    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.
 
     OPTIONAL PARAMETERS:
@@ -34,7 +34,8 @@ Run `wti --help` to see the usage:
     -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.
-    --force         Force `wti pull` to re-download the language file,
+    --all           Respectively download or upload all files.
+    --force         Force wti pull to re-download the language file,
                     regardless if local version is current.
     OTHER:
     ------

data/history.md

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

data/lib/web_translate_it/command_line.rb

@@ -1,9 +1,10 @@
 module WebTranslateIt
   class CommandLine
+    require 'fileutils'
     
     OPTIONS = <<-OPTION
-pull            Pull language file(s) from Web Translate It.
-push            Push language file(s) to Web Translate It.
+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.
 
 OPTIONAL PARAMETERS:
@@ -11,6 +12,7 @@ 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:
@@ -31,11 +33,6 @@ OPTION
         show_version
       when '-h', '--help'
         show_options
-      # deprecated in 1.5.0
-      when '-f', '--fetch'
-        fetch
-      when '-u', '--upload'
-        upload        
       else
         puts "Command not found"
         show_options
@@ -44,7 +41,7 @@ OPTION
         
     def self.pull
       configuration = fetch_configuration
-      locales = fetch_locales(configuration)
+      locales = fetch_locales_to_pull(configuration)
       configuration.files.each do |file|
         locales.each do |locale|
           puts "Pulling #{file.file_path_for_locale(locale)}…"
@@ -55,7 +52,7 @@ OPTION
     
     def self.push
       configuration = fetch_configuration
-      locales = fetch_locales(configuration)
+      locales = fetch_locales_to_push(configuration)
       configuration.files.each do |file|
         locales.each do |locale|
           puts "Pushing #{file.file_path_for_locale(locale)}…"
@@ -72,11 +69,15 @@ OPTION
         puts "You must enter your project API key provided by Web Translate It"
         exit
       end
-      puts "We will now create a `config/translation.yml` file in the current directory."
-      puts "Enter below another path if you want to change, or leave it blank if the defaut path is okay."
+      puts "Where should we create the configuration file? (Default: `config/translation.yml`)"
       path = STDIN.gets.strip
       path = "config/translation.yml" if path == ""
-      File.open(path, 'w'){ |file| file << generate_configuration(api_key) }
+      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
@@ -93,42 +94,6 @@ OPTION
       puts "Web Translate It #{WebTranslateIt::Util.version}"
     end
     
-    # deprecated in 1.5.0
-    def self.fetch
-      puts "Warning: this command is deprecated and will stop working in 1.5.0."
-      puts "Use `wti pull` instead. See help: `wti --help`"
-      configuration = WebTranslateIt::Configuration.new('.')
-      if ARGV.size == 2
-        locales = [ARGV[1]]
-      elsif ARGV.size == 1
-        locales = configuration.locales
-      end
-      configuration.files.each do |file|
-        locales.each do |locale|
-          puts "Fetching #{file.file_path_for_locale(locale)}…"
-          file.fetch(locale)
-        end
-      end
-    end
-    
-    # deprecated in 1.5.0
-    def self.upload
-      puts "Warning: this command is deprecated and will stop working in 1.5.0."
-      puts "Use `wti push` instead. See help: `wti --help`"
-      configuration = WebTranslateIt::Configuration.new('.')
-      if ARGV.size == 2
-        locales = [ARGV[1]]
-      elsif ARGV.size == 1
-        locales = configuration.locales
-      end
-      configuration.files.each do |file|
-        locales.each do |locale|
-          puts "Uploading #{file.file_path} in #{locale}…"
-          file.upload(locale)
-        end
-      end
-    end
-    
     def self.fetch_configuration
       if (index = ARGV.index('-c') || ARGV.index('--config')).nil?
         configuration = WebTranslateIt::Configuration.new('.')
@@ -138,16 +103,27 @@ OPTION
       return configuration
     end
     
-    def self.fetch_locales(configuration)
+    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.locales
+        locales = [configuration.source_locale]
       else
         locales = [ARGV[index+1]]
       end
-      return locales
+      locales.push(configuration.target_locales) if ARGV.index('--all')
+      return locales.uniq
     end
     
-    def self.generate_configuration(api_key)
+    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
@@ -168,7 +144,7 @@ files:
 FILE
       project["project_files"].each do |project_file|
         if project_file["master"]
-          file << "  #{project_file["id"]}: config/locales/" + project_file["name"].gsub(project["source_locale"]["code"], "[locale]") + "\n"
+          file << "  #{project_file["id"]}: #{path_to_locale_files}" + project_file["name"].gsub(project["source_locale"]["code"], "[locale]") + "\n"
         end
       end
       return file

data/lib/web_translate_it/configuration.rb

@@ -9,9 +9,9 @@ module WebTranslateIt
   class Configuration
     require 'yaml'
     require 'fileutils'
-    attr_accessor :path, :api_key, :files, :ignore_locales, :logger
+    attr_accessor :path, :api_key, :source_locale, :target_locales, :files, :ignore_locales, :logger
     
-    # Load the configuration file from the path.
+    # 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))
@@ -22,6 +22,7 @@ module WebTranslateIt
       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.
@@ -29,25 +30,16 @@ module WebTranslateIt
     #
     #   configuration = WebTranslateIt::Configuration.new
     #   locales = configuration.locales # returns an array of locales: ['en', 'fr', 'es', ...]
-    #
-    # TODO: Make this use the new endpoint serving YAML
-    def locales
-      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
+    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}/locales"
+      "/api/projects/#{api_key}.yaml"
     end
     
     # Returns a logger. If RAILS_DEFAULT_LOGGER is defined, use it, else, define a new logger.

data/lib/web_translate_it/tasks.rb

@@ -17,7 +17,7 @@ namespace :trans do
     task :all do
       welcome_message
       configuration = WebTranslateIt::Configuration.new
-      locales = configuration.locales
+      locales = configuration.target_locales
       configuration.ignore_locales.each do |ignore|
         locales.delete(ignore)
       end

data/lib/web_translate_it/util.rb

@@ -23,7 +23,7 @@ module WebTranslateIt
       http = Net::HTTP.new('webtranslateit.com', 443)
       http.use_ssl      = true
       http.verify_mode  = OpenSSL::SSL::VERIFY_NONE
-      http.read_timeout = 10
+      http.read_timeout = 40
       yield http
     end
   end

data/version.yml

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: web_translate_it
 version: !ruby/object:Gem::Version 
-  version: 1.4.7
+  version: 1.5.0
 platform: ruby
 authors: 
 - "\xC3\x89douard Bri\xC3\xA8re"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 +01:00
+date: 2010-02-19 00:00:00 +01:00
 default_executable: wti
 dependencies: 
 - !ruby/object:Gem::Dependency