web_translate_it 1.4.6 → 1.4.7

data/README.md

@@ -18,20 +18,28 @@ This gem provides your app with:
 
     gem install web_translate_it
     
-That’s it! At this point you have the Web Translate It executable. Run `wti --help` to see the usage:
+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:
 
     Web Translate It Help:
     **********************
-    -f --fetch [locale]           Download all the files for your project.
-                                  If a locale is specified, only download
-                                  the file for that locale.
-    -u --upload [locale]          Upload your files for a locale.
-    -v --version                  Show version.
-    -h --help                     This page.
-
-### Assumptions
-
-We assume you have a `config/translation.yml` file in your project containing the configuration to sync with Web Translate It. [Read about the configuration file in the wiki](http://wiki.github.com/AtelierConvivialite/webtranslateit/).
+    pull            Pull language file(s) from Web Translate It.
+    push            Push language file(s) to Web Translate It.
+    autoconf        Configure your project to sync with Web Translate It.
+
+    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.
+    --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
 
@@ -82,6 +90,11 @@ The gem currently has been tested against the following versions of Rails:
 
 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.

data/generators/webtranslateit/webtranslateit_generator.rb

@@ -12,7 +12,7 @@ class WebtranslateitGenerator < Rails::Generator::Base
     end
     record do |m|
       if options[:api_key]
-        project_details = YAML.load fetch_project_information(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"
@@ -23,22 +23,4 @@ class WebtranslateitGenerator < Rails::Generator::Base
   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,13 @@
+## 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`.

data/lib/web_translate_it.rb

@@ -3,6 +3,7 @@ require File.join(File.dirname(__FILE__), 'web_translate_it', 'configuration')
 require File.join(File.dirname(__FILE__), 'web_translate_it', 'translation_file')
 require File.join(File.dirname(__FILE__), 'web_translate_it', 'auto_fetch')
 require File.join(File.dirname(__FILE__), 'web_translate_it', 'command_line')
+require File.join(File.dirname(__FILE__), 'web_translate_it', 'project')
 
 module WebTranslateIt
   def self.fetch_translations

data/lib/web_translate_it/command_line.rb

@@ -2,32 +2,101 @@ module WebTranslateIt
   class CommandLine
     
     OPTIONS = <<-OPTION
--f --fetch [locale]           Download all the files for your project.
-                              If a locale is specified, only download
-                              the file for that locale.
--u --upload [locale]          Upload your files for a locale.
--v --version                  Show version.
--h --help                     This page.
+pull            Pull language file(s) from Web Translate It.
+push            Push language file(s) to Web Translate It.
+autoconf        Configure your project to sync with Web Translate It.
+
+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.
+--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 '-f', '--fetch'
-        fetch
-      when '-u', '--upload'
-        upload
+      when 'pull'
+        pull
+      when 'push'
+        push
+      when 'autoconf'
+        autoconf
       when '-v', '--version'
         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
       end
     end
+        
+    def self.pull
+      configuration = fetch_configuration
+      locales = fetch_locales(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(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 "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."
+      path = STDIN.gets.strip
+      path = "config/translation.yml" if path == ""
+      File.open(path, 'w'){ |file| file << generate_configuration(api_key) }
+      puts "Done! You can now use `wti` to push and pull your language files."
+      puts "Check `wti --help` for more information."
+    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
+    
+    # deprecated in 1.5.0
     def self.fetch
-      #TODO: Ability to pass a path as an argument
+      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]]
@@ -42,8 +111,10 @@ OPTION
       end
     end
     
+    # deprecated in 1.5.0
     def self.upload
-      #TODO: Ability to pass a path as an argument
+      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]]
@@ -58,16 +129,49 @@ OPTION
       end
     end
     
-    def self.show_options
-      puts ""
-      puts "Web Translate It Help:"
-      puts "**********************"
-      $stdout.puts OPTIONS
+    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.show_version
-      puts ""
-      puts "Web Translate It #{WebTranslateIt::Util.version}"
+    def self.fetch_locales(configuration)
+      if (index = ARGV.index('-l') || ARGV.index('--locale')).nil?
+        locales = configuration.locales
+      else
+        locales = [ARGV[index+1]]
+      end
+      return locales
+    end
+    
+    def self.generate_configuration(api_key)
+      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"]}: config/locales/" + project_file["name"].gsub(project["source_locale"]["code"], "[locale]") + "\n"
+        end
+      end
+      return file
     end
   end
 end

data/lib/web_translate_it/project.rb

@@ -0,0 +1,21 @@
+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
+  end
+end

data/version.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
 :minor: 4
-:patch: 6
+:patch: 7

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: web_translate_it
 version: !ruby/object:Gem::Version 
-  version: 1.4.6
+  version: 1.4.7
 platform: ruby
 authors: 
 - "\xC3\x89douard Bri\xC3\xA8re"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-04 00:00:00 +01:00
+date: 2010-02-05 00:00:00 +01:00
 default_executable: wti
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,6 +61,7 @@ files:
 - lib/web_translate_it/auto_fetch.rb
 - lib/web_translate_it/command_line.rb
 - lib/web_translate_it/configuration.rb
+- lib/web_translate_it/project.rb
 - lib/web_translate_it/tasks.rb
 - lib/web_translate_it/translation_file.rb
 - lib/web_translate_it/util.rb