web_translate_it 1.6.7 → 1.7.0

data/README.md

@@ -5,6 +5,7 @@
 [Example app](http://github.com/AtelierConvivialite/rails_example_app) | 
 [Report a bug](http://github.com/AtelierConvivialite/webtranslateit/issues) | 
 [Support](http://help.webtranslateit.com)
+[Documentation](http://docs.webtranslateit.com/web_translate_it_client/)
 
 This is a gem providing tools to sync your software’s language files with [Web Translate It](https://webtranslateit.com), a web-based computer-aided translation tool.
 
@@ -12,8 +13,9 @@ This is a gem providing tools to sync your software’s language files with [Web
 
 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)
-* a handful of rake task to fetch and upload your translations.
+* an executable, `wti`, that will help you to upload and download language files from the command line (or in whatever else you want to execute it),
+* a handful of rake task to fetch and upload your translations,
+* a Sinatra app to help you download your translations from a web-based interface,
 * a rack middleware to automatically fetch new translations from Web Translate It.
 
 ## Installation
@@ -43,13 +45,69 @@ Run `wti --help` to see the usage:
     -v --version    Show version.
     -h --help       This page.
 
-You should also configure your language file paths in your project’s File Manager so the `web_translate_it` gems knows about your file structure, like so.
+## Generalities
 
-![Web Translate It File Manager](http://s3.amazonaws.com:80/edouard.baconfile.com/web_translate_it%2Ffile_manager.png)
+The first time, you’ll have to configure your project:
 
-## Specific tools for Ruby on Rails
+    wti autoconf
+    
+It will ask for your Web Translate It API key, and where to save its configuration file. Letting it put in `config/translations.yml` makes everything easier.
+
+### Uploading your first language file
+
+If you have no file on Web Translate It yet, you need to send us your master language files. You can do it from the web interface, or from the command line:
+
+    wti add path/to/master/file.po
+
+That’s it! Web Translate It will automatically create the corresponding target files.
+
+### Updating a master language file
+
+    wti push
+
+### Updating a target language file
 
-This gem includes some rake tasks and a rack middleware to integrate Web Translate It with Ruby on Rails.
+    wti push -l fr
+   
+where fr should be replaced by the locale code of your file.
+
+### Download target language files
+
+    wti pull
+    
+### Download a specific language file
+
+    wti pull -l fr
+    
+### Download all the language files
+
+    wti pull --all
+    
+### Force pull (bypasses Web Translate It’s HTTP caching)
+
+    wti pull --force
+
+### View project stats
+
+    wti stats
+    
+## Web Translate It Synchronisation Console
+
+![Web Translate It](http://s3.amazonaws.com:80/edouard.baconfile.com/web_translate_it%2Fadmin_console.png)
+
+The `wti` gem integrates since its version 1.7.0 a sinatra back-end that allow you to sync your translations directly from a friendly web interface. It allows a translation team to refresh the language files on a staging server without having to ask the developers to manually `wti pull`.
+
+To get started, go to the directory of the application you want to sync and do:
+
+    wti server
+    
+By default, it starts an application on localhost on the port 4000. You will find the tool on `http://localhost:4000`.
+
+Should you need to use another host or port, you can use the -h and -p options. For example: `wti server -p 1234`.
+
+## Rake tasks
+
+This gem includes some rake tasks and a rack middleware you could use to integrate Web Translate It with Ruby on Rails. The rake tasks are significantly slower than the executable, since it has to load the whole rails stack.
 
 * Add to your config/environments.rb:
 
@@ -59,7 +117,7 @@ This gem includes some rake tasks and a rack middleware to integrate Web Transla
 
     `rake gems:install`
 
-* Copy/paste your API key from Web Translate It and run:
+* If you did not already did `wti autoconf`, copy your API key from Web Translate It and run:
 
     `script/generate webtranslateit --api-key your_key_here`
     
@@ -68,8 +126,6 @@ This gem includes some rake tasks and a rack middleware to integrate Web Transla
   - 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
-
 There are 3 rake tasks.
 
     rake trans:fetch:all
@@ -86,8 +142,7 @@ Upload to Web Translate It your files in a specific locale defined in Web Transl
 
 Read more about [Rails integration in the wiki](http://wiki.github.com/AtelierConvivialite/webtranslateit/).
 
-
-## Supported Rails Versions
+### Supported Rails Versions
 
 The gem currently has been tested against the following versions of Rails:
 
@@ -98,8 +153,10 @@ Please open a discussion on [our support site](http://help.webtranslateit.com) i
 
 # Acknowledgement
 
-* The executable’s commands are very much inspired from [Gemcutter](http://gemcutter.org/),
-* The Rails generator was pinched from [Hoptoad Notifier](http://github.com/thoughtbot/hoptoad_notifier/).
+* The executable’s commands are very much inspired from [Gemcutter](http://gemcutter.org),
+* The Rails generator was pinched from [Hoptoad Notifier](http://github.com/thoughtbot/hoptoad_notifier),
+* The idea of a web-app to sync translations with Web Translate It come from Tom Lea’s awesome [rack-webtranslateit](http://github.com/cwninja/rack-webtranslateit),
+* The Sinatra app is much inspired from Chris Wanstrath’s [CI Joe](http://github.com/defunkt/cijoe).
 
 # What is Web Translate It anyway?
 

data/bin/wti

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
 
 require 'web_translate_it'
-# require 'lib/web_translate_it' # for testing
 WebTranslateIt::CommandLine.run

data/history.md

@@ -1,3 +1,9 @@
+## Edge
+
+* New: `wti server` launch a sinatra app allowing to sync files from a web interface.
+  Pinched from Tom Lea’s awesome rack-webtranslate-it, but made less specific.
+* Bug fix: `wti autoconf` now create directories correctly if they don’t already exist. #27
+
 ## Version 1.6.7 /2010-05-05
 
 * New: `wti add file_path` to create a new master language file on Web Translate It.

data/lib/web_translate_it/command_line.rb

@@ -9,12 +9,15 @@ push             Push master language file(s) to Web Translate It.
 add              Create a new master language file to Web Translate It.
 autoconf         Configure your project to sync with Web Translate It.
 stats            Fetch and display your project statistics.
+server           Launch web-based synchronisation console.
 
 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.
+-h --host        Set server host when using `wti server` (default 0.0.0.0).
+-p --port        Set server port when using `wti server` (default 4000).
 --all            Respectively download or upload all files.
 --force          Force wti pull to re-download the language file,
                  regardless if local version is current.
@@ -39,6 +42,8 @@ OPTION
         autoconf
       when 'stats'
         stats
+      when 'server'
+        server
       when '-v', '--version'
         show_version
       when '-h', '--help'
@@ -86,7 +91,7 @@ OPTION
       puts "We will attempt to configure your project automagically"
       api_key = Util.ask("Please enter your project API Key")
       path = Util.ask("Where should we create the configuration file?", 'config/translation.yml')
-      FileUtils.mkpath(path.split('/')[0..path.split('/').size-1])
+      FileUtils.mkpath(path.split('/')[0..path.split('/').size-2].join('/'))
       project = YAML.load WebTranslateIt::Project.fetch_info(api_key)
       project_info = project['project']
       File.open(path, 'w'){ |file| file << generate_configuration(api_key, project_info) }
@@ -127,6 +132,11 @@ OPTION
       end
     end
     
+    def self.server
+      host_port = fetch_server_host_and_port
+      WebTranslateIt::Server.start(host_port[0], host_port[1])
+    end
+    
     def self.show_options
       puts ""
       puts "Web Translate It Help:"
@@ -148,6 +158,20 @@ OPTION
       return configuration
     end
     
+    def self.fetch_server_host_and_port
+      if (index = ARGV.index('-h') || ARGV.index('--host')).nil?
+        host = "0.0.0.0"
+      else
+        host = ARGV[index+1]
+      end
+      if (index = ARGV.index('-p') || ARGV.index('--port')).nil?
+        port = "4000"
+      else
+        port = ARGV[index+1]
+      end
+      return [host,port]
+    end
+    
     def self.fetch_locales_to_pull(configuration)
       if (index = ARGV.index('-l') || ARGV.index('--locale')).nil?
         locales = configuration.target_locales

data/lib/web_translate_it/configuration.rb

@@ -9,7 +9,7 @@ module WebTranslateIt
   class Configuration
     require 'yaml'
     require 'fileutils'
-    attr_accessor :path, :api_key, :source_locale, :target_locales, :files, :ignore_locales, :logger
+    attr_accessor :path, :api_key, :source_locale, :target_locales, :files, :ignore_locales, :logger, :before_pull, :after_pull
     
     # Load configuration file from the path.
     def initialize(root_path = Rails.root, path_to_config_file = "config/translation.yml")
@@ -17,6 +17,8 @@ module WebTranslateIt
       self.logger         = logger
       configuration       = YAML.load_file(File.join(self.path, path_to_config_file))
       self.api_key        = configuration['api_key']
+      self.before_pull    = configuration['before_pull']
+      self.after_pull     = configuration['after_pull']
       project_info        = YAML.load WebTranslateIt::Project.fetch_info(api_key)
       set_locales_to_ignore(configuration)
       set_files(project_info['project'])
@@ -58,7 +60,7 @@ module WebTranslateIt
     def api_url
       "/api/projects/#{api_key}.yaml"
     end
-    
+        
     # Returns a logger. If RAILS_DEFAULT_LOGGER is defined, use it, else, define a new logger.
     def logger
       if defined?(Rails.logger)

data/lib/web_translate_it/public/screen.css

@@ -0,0 +1,233 @@
+/*****************************************************************************/
+/*
+/* Common
+/*
+/*****************************************************************************/
+
+/* Global Reset */
+
+* {
+  margin: 0;
+  padding: 0;
+}
+
+html, body {
+  height: 100%;
+}
+
+body {
+  background-color: white;
+  font: 13.34px helvetica, arial, clean, sans-serif;
+  *font-size: small;
+  text-align: center;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-size: 100%;
+}
+
+h1 {
+  margin-bottom: 1em;
+}
+
+h1 a {
+  text-decoration: none;
+  color: #000;
+}
+
+.failed, .color31 {
+  color: red !important;
+}
+
+.worked, .color32 {
+  color: green !important;
+}
+
+.errored, .color33 {
+  color: yellow !important;
+}
+
+p {
+  margin: 1em 0;
+}
+
+a {
+  color: #00a;
+}
+
+a:hover {
+  color: black;
+}
+
+a:visited {
+  color: #a0a;
+}
+
+table {
+  font-size: inherit;
+  font: 100%;
+  border-collapse: collapse;
+}
+
+th {
+  text-align: center;
+  padding-right: 1em;
+}
+
+tr {
+  border-bottom: 1px solid #CCC;
+}
+
+td {
+  padding: .5em 1em;
+}
+
+.information {
+  background-color: #ffffc0;
+  color: #333;
+  padding: 5px;
+}
+
+/*****************************************************************************/
+/*
+/* Home
+/*
+/*****************************************************************************/
+
+ul.posts {
+  list-style-type: none;
+  margin-bottom: 2em;
+}
+
+  ul.posts li {
+    line-height: 1.75em;
+  }
+ 
+  ul.posts .date,
+  ul.posts .duration {
+    color: #aaa;
+    font-family: Monaco, "Courier New", monospace;
+    font-size: 80%;
+  }
+
+/*****************************************************************************/
+/*
+/* Site
+/*
+/*****************************************************************************/
+
+.site {
+  font-size: 110%;
+  text-align: justify;
+  width: 80%;
+  margin: 3em auto 2em auto;
+  line-height: 1.5em;
+}
+
+.title {
+  color: #a00;
+  font-weight: bold;
+  margin-bottom: 2em;
+}
+
+  .site .title a {
+    color: #a00;
+    text-decoration: none;
+  }
+
+  .site .title a:hover {
+    color: black;
+  }
+
+  .site .title .extra {
+    color: #aaa;
+    text-decoration: none;
+    margin-left: 1em;
+    font-size: 0.9em;
+  }
+
+  .site .title a.extra:hover {
+    color: black;
+  }
+
+  .site .meta {
+    color: #aaa;
+  }
+
+  .site .footer {
+    font-size: 80%;
+    color: #666;
+    border-top: 4px solid #eee;
+    margin-top: 2em;
+    overflow: hidden;
+  }
+
+    .site .footer .contact {
+      float: left;
+      margin-right: 3em;
+    }
+
+      .site .footer .contact a {
+        color: #8085C1;
+      }
+
+    .site .footer .rss {
+      margin-top: 1.1em;
+      margin-right: -.2em;
+      float: right;
+    }
+
+      .site .footer .rss img {
+        border: 0;
+      }
+
+/*****************************************************************************/
+/*
+/* Posts
+/*
+/*****************************************************************************/
+
+#post {
+
+}
+
+/* standard */
+
+#post pre {
+  border: 1px solid #ddd;
+  background-color: #eef;
+  padding: 0 .4em;
+}
+
+#post ul,
+#post ol {
+  margin-left: 1.25em;
+}
+
+#post code {
+  border: 1px solid #ddd;
+  background-color: #eef;
+  font-size: 95%;
+  padding: 0 .2em;
+}
+
+  #post pre code {
+    border: none;
+  }
+
+/* terminal */
+
+pre.terminal {
+  border: 1px solid black;
+  background-color: #333;
+  color: white;
+  padding: 5px;
+  overflow: auto;
+  word-wrap: break-word;
+}
+
+pre.terminal code {
+  font-family: 'Bitstream Vera Sans Mono', 'Courier', monospace;
+  background-color: #333;
+}
+

data/lib/web_translate_it/server.rb

@@ -0,0 +1,50 @@
+require 'sinatra/base'
+require 'erb'
+
+module WebTranslateIt
+  class Server < Sinatra::Base
+    attr_reader :config
+    
+    dir = File.dirname(File.expand_path(__FILE__))
+
+    set :views,  "#{dir}/views"
+    set :public, "#{dir}/public"
+    set :static, true
+    set :lock, true
+    
+    helpers do
+      def wti_root
+        root = request.path
+        root = "" if root == "/"
+        root
+      end
+      
+      def highlight(value, expected)
+        return if value.nil?
+        print_value = value == true ? "Yes" : "No"
+        value == expected ? "<em>#{print_value}</em>" : "<em class=\"information\">#{print_value}</em>"
+      end
+    end
+    
+    get '/' do
+      erb :index, :locals => { :config => config }
+    end
+    
+    post '/pull' do
+      `#{config.before_pull}` if config.before_pull
+      WebTranslateIt::CommandLine.pull
+      `#{config.after_pull}` if config.after_pull
+      redirect "/"
+    end
+        
+    def initialize(*args)
+      super
+      @config = WebTranslateIt::Configuration.new('.')
+    end
+
+    def self.start(host, port)
+      WebTranslateIt::Server.run! :host => host, :port => port
+    end
+    
+  end
+end

data/lib/web_translate_it/translation_file.rb

@@ -89,7 +89,22 @@ module WebTranslateIt
         puts "\nFile #{self.file_path} doesn't exist!"
       end
     end
-            
+    
+    def committed?
+      Dir.chdir(File.dirname(file_path)) do
+        system "git status | grep 'modified:   #{File.basename(file_path)}' > /dev/null"
+      end
+      ! $?.success?
+    end
+    
+    def exists?
+      File.exists?(file_path)
+    end
+    
+    def modified_remotely?
+      fetch == "200 OK"
+    end
+         
     protected
       
       # Convenience method which returns the date of last modification of a language file.

data/lib/web_translate_it/views/index.erb

@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <link href="<%= wti_root %>/screen.css" media="screen" rel="stylesheet" type="text/css" />
+    <link rel="shortcut icon" href="<%= wti_root %>/favicon.ico" type="image/x-icon" />
+    <title>Web Translate It Synchronisation Console</title>
+  </head>
+  <body>
+    <div class="site">
+      <div class="title">
+        <a href="<%= wti_root %>/">Web Translate It Synchronisation Console</a>
+      </div>
+
+      <div id="home">
+        <h1>Language File Status</h1>
+          <table>
+            <thead>
+              <tr>
+                <th>File Name</th>
+                <th>Locale</th>
+                <th>Exists</th>
+                <th>Committed</th>
+                <th>New Version Available</th>
+              </tr>
+            </thead>
+            <tbody>
+              <% config.files.each do |file| %>
+                <tr>
+                  <td><%= file.file_path %></td>
+                  <td><%= file.locale.upcase %></td>
+                  <td><%= highlight(file.exists?, true) %></td>
+                  <td><%= highlight(file.committed?, true) %></td>
+                  <td><%= highlight(file.modified_remotely?, false) %></td>
+                </tr>
+              <% end %>
+          </tbody>
+        </table>
+        
+        <form method="post" action="<%= wti_root %>/pull">
+          <input type="submit" value="Get new translations" />
+        </form>        
+      </div>
+
+      <div class="footer">
+        <div class="contact">
+          <p>
+            <a href="http://docs.webtranslateit.com">Documentation</a><br/>
+            <a href="http://github.com/AtelierConvivialite/web_translate_it">Source</a><br/>
+            <a href="http://github.com/AtelierConvivialite/web_translate_it/issues">Issues</a><br/>
+            <a href="http://twitter.com/webtranslateit">Twitter</a>
+          </p>
+        </div>
+        <div class="contact">
+          <p>
+            <code>wti</code> v.<%= WebTranslateIt::Util.version %><br/>
+            Built with <a href="http://sinatrarb.com/">Sinatra</a>
+          </p>
+        </div>        
+      </div>
+    </div>
+  </body>
+</html>

data/lib/web_translate_it.rb

@@ -6,6 +6,7 @@ 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')
 require File.join(File.dirname(__FILE__), 'web_translate_it', 'tasks')
+require File.join(File.dirname(__FILE__), 'web_translate_it', 'server')
 
 module WebTranslateIt
   

data/version.yml

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

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 6
   - 7
-  version: 1.6.7
+  - 0
+  version: 1.7.0
 platform: ruby
 authors: 
 - "\xC3\x89douard Bri\xC3\xA8re"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-05 00:00:00 +02:00
+date: 2010-05-12 00:00:00 +02:00
 default_executable: wti
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,9 +31,22 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: sinatra
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -43,8 +56,8 @@ dependencies:
         - 9
         version: 1.2.9
   type: :development
-  version_requirements: *id002
-description: A rack middleware and a handful of rake tasks to sync your translations between webtranslateit.com and your rails applications.
+  version_requirements: *id003
+description: An ruby executable, a sinatra app and a handful of rake tasks to sync your translations between your app and webtranslateit.com.
 email: edouard@atelierconvivialite.com
 executables: 
 - wti
@@ -65,9 +78,12 @@ files:
 - lib/web_translate_it/command_line.rb
 - lib/web_translate_it/configuration.rb
 - lib/web_translate_it/project.rb
+- lib/web_translate_it/public/screen.css
+- lib/web_translate_it/server.rb
 - lib/web_translate_it/tasks.rb
 - lib/web_translate_it/translation_file.rb
 - lib/web_translate_it/util.rb
+- lib/web_translate_it/views/index.erb
 - lib/web_translate_it.rb
 - generators/webtranslateit/lib/insert_commands.rb
 - generators/webtranslateit/templates/translation.yml
@@ -80,7 +96,7 @@ has_rdoc: true
 homepage: https://webtranslateit.com
 licenses: []
 
-post_install_message: "  ************************************************************\n\n    Thank you for installing web_translate_it\n\n    If you upgrade from a version <= 1.5.2\n    be sure to read this blog post: http://bit.ly/aEox3b\n    for useful information about this release.\n    1.6.0 bring some important breaking changes.\n\n  ************************************************************\n"
+post_install_message: 
 rdoc_options: 
 - --main
 - README.md
@@ -106,7 +122,7 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Sync your translations between your Rails app and Web Translate It
+summary: Sync your translations between your app and Web Translate It
 test_files: 
 - spec/examples/config/translation.yml
 - spec/examples/en.yml