web_translate_it 1.10.2 → 2.0.0.rc2

data/lib/web_translate_it/term_translation.rb

@@ -2,41 +2,95 @@
 module WebTranslateIt
   class TermTranslation
     require 'net/https'
+    require 'json'
     
-    attr_accessor :id, :locale, :api_key
+    attr_accessor :api_key, :id, :locale, :text, :description, :status, :new_record, :term_id
     
-    def initialize(id, locale, api_key)
-      self.id         = id
-      self.locale     = locale
-      self.api_key    = api_key
+    # Initialize a new WebTranslateIt::TermTranslation
+    # Mandatory parameter is `api_key`
+    #
+    # Implementation Example:
+    #
+    #   WebTranslateIt::TermTranslation.new('secret_api_token', { "text" => "Super!" })
+    #
+    # to instantiate a new TermTranslation.
+    #
+    
+    def initialize(api_key, params = {})
+      self.api_key     = api_key
+      self.id          = params["id"] || nil
+      self.locale      = params["locale"] || nil
+      self.text        = params["text"] || nil
+      self.description = params["description"] || nil
+      self.status      = params["status"] || nil
+      self.term_id     = params["term_id"] || nil
+      self.new_record  = true
+    end
+    
+    # Update or Create a WebTranslateIt::TermTranslation
+    #
+    # Implementation Example:
+    #
+    #   translation = WebTranslateIt::TermTranslation.new('secret_api_token', { "term_id" => "1234", "text" => "Super!" })
+    #   translation.text = "I changed it!"
+    #   WebTranslateIt::Util.http_connection do |connection|
+    #     translation.save(connection)
+    #   end
+    #
+    
+    def save(http_connection)
+      if self.new_record
+        self.create(http_connection)
+      else
+        self.update(http_connection)
+      end
+    end
+    
+    def to_hash
+      {
+        "id" => id,
+        "locale" => locale,
+        "text" => text,
+        "description" => description,
+        "status" => status
+      }
     end
     
-    def show(http_connection, options = {})
-      options.reverse_merge!(:format => 'yaml')
-      
-      request = Net::HTTP::Get.new("/api/projects/#{self.api_key}/terms/#{self.id}/locales/#{self.locale}/translations.#{options[:format]}")
+    protected
+    
+    def create(http_connection)
+      request = Net::HTTP::Post.new("/api/projects/#{self.api_key}/terms/#{self.term_id}/locales/#{self.locale}/translations")
       request.add_field("X-Client-Name", "web_translate_it")
       request.add_field("X-Client-Version", WebTranslateIt::Util.version)
+      request.add_field("Content-Type", "application/json")
+        
+      request.body = self.to_hash.to_json
 
       begin
-        Util.handle_response(http_connection.request(request), true)
+        response = Util.handle_response(http_connection.request(request), true)
+        response = YAML.load(response)
+        self.id = response["id"]
+        self.new_record = false
+        return true
+        
       rescue Timeout::Error
         puts "The request timed out. The service may be overloaded. We will retry in 5 seconds."
         sleep(5)
         retry
       end
     end
-    
-    def create(http_connection, params = {})
-      request = Net::HTTP::Post.new("/api/projects/#{self.api_key}/terms/#{self.id}/locales/#{self.locale}/translations")
+
+    def update(http_connection)
+      request = Net::HTTP::Put.new("/api/projects/#{self.api_key}/terms/#{self.id}/locales/#{self.locale}/translations/#{self.id}")
       request.add_field("X-Client-Name", "web_translate_it")
       request.add_field("X-Client-Version", WebTranslateIt::Util.version)
       request.add_field("Content-Type", "application/json")
         
-      request.body = params.to_json
+      request.body = self.to_hash.to_json
 
       begin
         Util.handle_response(http_connection.request(request), true)
+        
       rescue Timeout::Error
         puts "The request timed out. The service may be overloaded. We will retry in 5 seconds."
         sleep(5)

data/lib/web_translate_it/translation.rb

@@ -2,38 +2,53 @@
 module WebTranslateIt
   class Translation
     require 'net/https'
+    require 'json'
     
-    attr_accessor :id, :locale, :api_key
+    attr_accessor :api_key, :id, :locale, :text, :status, :created_at, :updated_at, :version, :string_id
     
-    def initialize(id, locale, api_key)
-      self.id         = id
-      self.locale     = locale
-      self.api_key    = api_key
-    end
+    # Initialize a new WebTranslateIt::Translation
+    # Mandatory parameters are `api_key` and { "string_id" => "1234" }
+    #
+    # Implementation Example:
+    #
+    #   WebTranslateIt::Translation.new('secret_api_token', { "string_id" => "1234", "text" => "Super!" })
+    #
+    # to instantiate a new Translation without any text.
+    #
     
-    def show(http_connection, options = {})
-      options.reverse_merge!(:format => 'yaml')
-      
-      request = Net::HTTP::Get.new("/api/projects/#{self.api_key}/strings/#{self.id}/locales/#{self.locale}/translations.#{options[:format]}")
-      request.add_field("X-Client-Name", "web_translate_it")
-      request.add_field("X-Client-Version", WebTranslateIt::Util.version)
-
-      begin
-        Util.handle_response(http_connection.request(request), true)
-      rescue Timeout::Error
-        puts "The request timed out. The service may be overloaded. We will retry in 5 seconds."
-        sleep(5)
-        retry
+    def initialize(api_key, params = {})
+      self.api_key    = api_key
+      self.id         = params["id"] || nil
+      self.locale     = params["locale"] || nil
+      self.text       = params["text"] || nil
+      self.status     = params["status"] || "status_unproofread"
+      self.created_at = params["created_at"] || nil
+      self.updated_at = params["updated_at"] || nil
+      self.version    = params["version"] || nil
+      if params["string"]
+        self.string_id  = params["string"]["id"]
+      else
+        self.string_id = nil
       end
     end
     
-    def create(http_connection, params = {})
-      request = Net::HTTP::Post.new("/api/projects/#{self.api_key}/strings/#{self.id}/locales/#{self.locale}/translations")
+    # Save a WebTranslateIt::Translation
+    #
+    # Implementation Example:
+    #
+    #   translation = WebTranslateIt::Translation.new('secret_api_token', { "string_id" => "1234", "text" => "Super!" })
+    #   translation.text = "I changed it!"
+    #   WebTranslateIt::Util.http_connection do |connection|
+    #     translation.save(connection)
+    #   end
+    #
+    
+    def save(http_connection)
+      request = Net::HTTP::Post.new("/api/projects/#{self.api_key}/strings/#{self.string_id}/locales/#{self.locale}/translations")
       request.add_field("X-Client-Name", "web_translate_it")
       request.add_field("X-Client-Version", WebTranslateIt::Util.version)
       request.add_field("Content-Type", "application/json")
-        
-      request.body = params.to_json
+      request.body = self.to_hash.to_json
 
       begin
         Util.handle_response(http_connection.request(request), true)
@@ -43,6 +58,13 @@ module WebTranslateIt
         retry
       end
     end
-
+    
+    def to_hash
+      {
+        "locale" => locale,
+        "text" => text,
+        "status" => status
+      }
+    end
   end
 end

data/lib/web_translate_it/util.rb

@@ -11,8 +11,7 @@ module WebTranslateIt
     # Return a string representing the gem version
     # For example "1.8.3"
     def self.version
-      hash = YAML.load_file File.expand_path('../../../version.yml', __FILE__)
-      [hash[:major], hash[:minor], hash[:patch]].join('.')
+      IO.read(File.expand_path('../../../version', __FILE__))
     end
     
     # Yields a HTTP connection over SSL to Web Translate It.

data/lib/web_translate_it/util/hash_util.rb

@@ -1,7 +1,27 @@
 class HashUtil
-  def self.to_param(hash, namespace = nil) # taken from Rails
-    hash.collect do |key, value|
-      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
-    end.sort * '&'
+  def self.to_params(hash)
+    params = ''
+    stack = []
+
+    hash.each do |k, v|
+      if v.is_a?(Hash)
+        stack << [k,v]
+      else
+        params << "#{k}=#{v}&"
+      end
+    end
+
+    stack.each do |parent, hash|
+      hash.each do |k, v|
+        if v.is_a?(Hash)
+          stack << ["#{parent}[#{k}]", v]
+        else
+          params << "#{parent}[#{k}]=#{v}&"
+        end
+      end
+    end
+
+    params.chop! # trailing &
+    params
   end
 end

data/readme.md

@@ -1,5 +1,4 @@
-Web Translate It
-================
+# Web Translate It
 
 [Homepage](https://webtranslateit.com) | 
 [RDoc](http://yardoc.org/docs/AtelierConvivialite-webtranslateit) | 
@@ -7,18 +6,22 @@ Web Translate It
 [Report a bug](http://github.com/AtelierConvivialite/webtranslateit/issues) | 
 [Support](http://help.webtranslateit.com)
 
-`web_translate_it` is a rubygem providing tools to sync your language files with [Web Translate It](https://webtranslateit.com), a web-based translation software.
+`web_translate_it` is a tool to sync your language files with [WebTranslateIt.com](https://webtranslateit.com), a web-based translation software.
 
 ![Web Translate It](http://f.cl.ly/items/2X3m0h0g0I1O1U07163o/wti_example.jpg)
 
-This gem provides:
+## This rubygem provides:
 
-* a command-line executable `wti`, to sync your files between your computer/server and WebTranslateIt.com,
-* a synchronisation server to help your translation team update your language files from a web interface,
-* a rack middleware you can use within your Rails app to automatically fetch new translations from Web Translate It.
+1. A command-line executable `wti` to sync your files between your computer/server and WebTranslateIt.com. It can run in a terminal (Linux, MacOS X) or in cmd.exe (Windows). This is what this page is all about.
+2. A synchronisation server to help your translation team update your language files from a web interface. To learn how to install it, go to [web_translate_it_server](https://github.com/AtelierConvivialite/web_translate_it_server).
+3. Ruby libraries to write programs connecting to WebTranslateIt.com’s API. For more information, go to [Extras](https://github.com/AtelierConvivialite/webtranslateit/wiki/Extras).
+4. A rack middleware you can use in your Rails app to automatically fetch new translations from Web Translate It.
 
-Installation
-------------
+This readme focusses on the most commonly used functionality of this rubygem: the `wti` command-line executable.
+
+---
+
+## Installation
 
 You will need ruby to run wti. On Linux or a Mac, it’s already installed. Install [RubyInstaller](http://rubyinstaller.org/) if you’re using Windows. [See detailed installation instructions for Windows users](https://github.com/AtelierConvivialite/webtranslateit/wiki/Install-wti-on-Windows).
 
@@ -26,20 +29,18 @@ You will need ruby to run wti. On Linux or a Mac, it’s already installed. Inst
     
 At this point you should have the `wti` executable working.
 
-Configuration
--------------
+## Configuration
 
 Now that the tool is installed, you’ll have to configure your project:
 
     wti init
 
-The tool will prompt for:
+The command will ask you to enter:
 
-* your Web Translate It API key. You can find it in your project settings ([where are the project settings?](http://help.webtranslateit.com/kb/troubleshooting/where-are-my-project-settings)),
-* where to save the configuration file (by default in `config/translations.yml`).
+* Your Web Translate It API key. You can find it in your project settings,
+* Where to save the configuration file (by default it will create a `.wti` in your project root directory).
 
-Usage
------
+## Usage
 
 Execute `wti --help` to see the usage:
 
@@ -76,8 +77,7 @@ Append `--help` for each command for more information. For instance:
            --label, -b <s>:   Apply a label to the changes
                 --help, -h:   Show this message
 
-Sample Commands
----------------
+## Sample Commands
 
 <table>
   <tr>
@@ -146,8 +146,7 @@ Sample Commands
   </tr>
 </table>
 
-Hooks
------
+## Hooks
 
 It is sometimes useful to hook a command or a script before or after a push or a pull. One use-case would be to launch a build after pulling language files. You can do that by implementing hooks in your `.wti` file.
 
@@ -160,8 +159,7 @@ There are 4 hooks:
 
 Check the [sample `.wti`](https://github.com/AtelierConvivialite/webtranslateit/blob/master/examples/.wti#L9..L13) file for implementation.
 
-Web Translate It Synchronisation Console
-----------------------------------------
+## Web Translate It Server
 
 This feature was extracted out to a separate gem. See [web_translate_it_server](https://github.com/AtelierConvivialite/web_translate_it_server).
 

data/spec/web_translate_it/string_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe WebTranslateIt::String do
+  
+  let(:api_key) { "19875cfdd4f169b33e0ffab32cfb0bbb9e33d653" }
+  
+  describe "#initialize" do
+    it "should assign api_key and many parameters" do
+      string = WebTranslateIt::String.new(api_key, { "id" => 1234, "key" => "bacon"})
+      string.api_key.should == api_key
+      string.id.should == 1234
+      string.key.should == "bacon"
+    end
+  end
+  
+  describe "#save" do
+    it "should create a new String" do
+      WebTranslateIt::Util.http_connection do |connection|
+        string = WebTranslateIt::String.new(api_key, { "key" => "bacon" })
+        string.save(connection)
+        string.id.should_not be_nil
+        string_fetched = WebTranslateIt::String.find(connection, api_key, string.id)
+        string_fetched.should_not be_nil
+        string_fetched.should be_a(WebTranslateIt::String)
+        string_fetched.id.should == string.id
+        string.delete(connection)
+      end
+    end
+    
+    it "should update an existing String" do
+      WebTranslateIt::Util.http_connection do |connection|
+        string = WebTranslateIt::String.new(api_key, { "key" => "bacony" })
+        string.save(connection)
+        string.key = "bacon changed"
+        string.save(connection)
+        string_fetched = WebTranslateIt::String.find(connection, api_key, string.id)
+        string_fetched.key.should == "bacon changed"
+        string.delete(connection)
+      end
+    end
+    
+    it "should create a new String with Translation" do
+      translation1 = WebTranslateIt::Translation.new(api_key, { "locale" => "en", "text" => "Hello" })
+      translation2 = WebTranslateIt::Translation.new(api_key, { "locale" => "fr", "text" => "Bonjour" })
+      
+      string = WebTranslateIt::String.new(api_key, { "key" => "bacon", "translations" => [translation1, translation2] })
+      WebTranslateIt::Util.http_connection do |connection|
+        string.save(connection)
+        string_fetched = WebTranslateIt::String.find(connection, api_key, string.id)
+        string_fetched.translation_for(connection, "en").should_not be_nil
+        string_fetched.translation_for(connection, "en").text.should == "Hello"
+        string_fetched.translation_for(connection, "fr").should_not be_nil
+        string_fetched.translation_for(connection, "fr").text.should == "Bonjour"
+        string_fetched.translation_for(connection, "es").should be_nil
+        string.delete(connection)
+      end
+    end
+    
+    it "should update a String and save its Translation" do
+      translation1 = WebTranslateIt::Translation.new(api_key, { "locale" => "en", "text" => "Hello" })
+      translation2 = WebTranslateIt::Translation.new(api_key, { "locale" => "fr", "text" => "Bonjour" })
+      
+      string = WebTranslateIt::String.new(api_key, { "key" => "bacon" })
+      WebTranslateIt::Util.http_connection do |connection|
+        string.save(connection)
+        string_fetched = WebTranslateIt::String.find(connection, api_key, string.id)
+        string_fetched.translation_for(connection, "fr").should be_nil
+        
+        string_fetched.translations = [translation1, translation2]
+        string_fetched.save(connection)
+        
+        string_fetched = WebTranslateIt::String.find(connection, api_key, string.id)
+        string_fetched.translation_for(connection, "en").should_not be_nil
+        string_fetched.translation_for(connection, "en").text.should == "Hello"
+        string_fetched.translation_for(connection, "fr").should_not be_nil
+        string_fetched.translation_for(connection, "fr").text.should == "Bonjour"
+        string.delete(connection)
+      end
+    end
+  end
+  
+  describe "#delete" do
+    it "should delete a String" do
+      string = WebTranslateIt::String.new(api_key, { "key" => "bacon" })
+      WebTranslateIt::Util.http_connection do |connection|
+        string.save(connection)
+        string_fetched = WebTranslateIt::String.find(connection, api_key, string.id)
+        string_fetched.should_not be_nil
+        
+        string_fetched.delete(connection)
+        string_fetched = WebTranslateIt::String.find(connection, api_key, string.id)
+        string_fetched.should be_nil
+      end
+    end
+  end
+  
+  describe "#find_all" do
+    it "should find many strings" do
+      WebTranslateIt::Util.http_connection do |connection|
+        string1 = WebTranslateIt::String.new(api_key, { "key" => "bacon" })
+        string1.save(connection)
+        string2 = WebTranslateIt::String.new(api_key, { "key" => "tart" })
+        string2.save(connection)
+        string3 = WebTranslateIt::String.new(api_key, { "key" => "bacon tart" })
+        string3.save(connection)
+      
+        strings = WebTranslateIt::String.find_all(connection, api_key, { "key" => "bacon" })
+        strings.count.should == 2
+        strings[0].key.should == "bacon"
+        strings[1].key.should == "bacon tart"
+        
+        strings = WebTranslateIt::String.find_all(connection, api_key, { "key" => "tart" })
+        strings.count.should == 2
+        strings[0].key.should == "tart"
+        strings[1].key.should == "bacon tart"
+        
+        strings = WebTranslateIt::String.find_all(connection, api_key, { "key" => "bacon tart" })
+        strings.count.should == 1
+        strings[0].key.should == "bacon tart"
+        
+        string1.delete(connection)
+        string2.delete(connection)
+        string3.delete(connection)
+      end
+    end
+  end
+end