web_translate_it 2.0.1 → 2.0.2

data/history.md

@@ -1,3 +1,8 @@
+## Version 2.0.2 / 2012-06-06
+
+* String, Translation, Term and TermTranslation classes now raise exceptions and display useful error messages. #87
+* Implemented pagination for `String#find_all` and `Term#find_all`. This should work seemlessly with no API change.
+
 ## Version 2.0.1 / 2012-05-11
 
 * Fix: Issue with saving labels on a string.

data/lib/web_translate_it/string.rb

@@ -49,8 +49,6 @@ module WebTranslateIt
     #   puts strings.inspect #=> An array of WebTranslateIt::String objects
     #
     # to find and instantiate an array of String which key is like `product_name_123`.
-    #
-    # TODO: Implement pagination
     
     def self.find_all(params = {})
       params.stringify_keys!
@@ -62,12 +60,22 @@ module WebTranslateIt
       request.add_field("X-Client-Version", WebTranslateIt::Util.version)
 
       begin
-        response = Util.handle_response(Connection.http_connection.request(request), true)
         strings = []
-        YAML.load(response).each do |string_response|
-          string = WebTranslateIt::String.new(string_response)
-          string.new_record = false
-          strings.push(string)
+        while(request) do
+          response = Connection.http_connection.request(request)
+          YAML.load(response.body).each do |string_response|
+            string = WebTranslateIt::String.new(string_response)
+            string.new_record = false
+            strings.push(string)
+          end
+          if response["Link"] && response["Link"].include?("rel=\"next\"")
+            url = response["Link"].match(/<(.*)>; rel="next"/)[1]
+            request = Net::HTTP::Get.new(url)
+            request.add_field("X-Client-Name", "web_translate_it")
+            request.add_field("X-Client-Version", WebTranslateIt::Util.version)
+          else
+            request = nil
+          end
         end
         return strings
       rescue Timeout::Error
@@ -96,9 +104,8 @@ module WebTranslateIt
       request.add_field("X-Client-Version", WebTranslateIt::Util.version)
 
       begin
-        response = Connection.http_connection.request(request)
-        return nil if response.code.to_i == 404
-        string = WebTranslateIt::String.new(YAML.load(response.body))
+        response = Util.handle_response(Connection.http_connection.request(request), true, true)
+        string = WebTranslateIt::String.new(YAML.load(response))
         string.new_record = false
         return string
       rescue Timeout::Error
@@ -139,7 +146,7 @@ module WebTranslateIt
       request.add_field("X-Client-Version", WebTranslateIt::Util.version)
 
       begin
-        Util.handle_response(Connection.http_connection.request(request), true)
+        Util.handle_response(Connection.http_connection.request(request), true, true)
       rescue Timeout::Error
         puts "The request timed out. The service may be overloaded. We will retry in 5 seconds."
         sleep(5)
@@ -164,7 +171,7 @@ module WebTranslateIt
       request.add_field("X-Client-Version", WebTranslateIt::Util.version)
 
       begin
-        response = Util.handle_response(Connection.http_connection.request(request), true)
+        response = Util.handle_response(Connection.http_connection.request(request), true, true)
         hash = YAML.load(response)
         return nil if hash.empty?
         translation = WebTranslateIt::Translation.new(hash)
@@ -195,7 +202,7 @@ module WebTranslateIt
       end
       
       begin
-        Util.handle_response(Connection.http_connection.request(request), true)
+        Util.handle_response(Connection.http_connection.request(request), true, true)
       rescue Timeout::Error
         puts "The request timed out. The service may be overloaded. We will retry in 5 seconds."
         sleep(5)
@@ -214,7 +221,7 @@ module WebTranslateIt
       request.body = self.to_json(true)
 
       begin
-        response = YAML.load(Util.handle_response(Connection.http_connection.request(request), true))
+        response = YAML.load(Util.handle_response(Connection.http_connection.request(request), true, true))
         self.id = response["id"]
         self.new_record = false
         return true

data/lib/web_translate_it/term.rb

@@ -40,8 +40,6 @@ module WebTranslateIt
     #   end
     #
     #  puts terms.inspect #=> An array of WebTranslateIt::Term objects
-    #
-    # TODO: Implement pagination
     
     def self.find_all(params = {})
       params.stringify_keys!
@@ -53,15 +51,24 @@ module WebTranslateIt
       request.add_field("X-Client-Version", WebTranslateIt::Util.version)
 
       begin
-        response = Util.handle_response(Connection.http_connection.request(request), true)
         terms = []
-        YAML.load(response).each do |term_response|
-          term = WebTranslateIt::Term.new(term_response)
-          term.new_record = false
-          terms.push(term)
+        while(request) do
+          response = Connection.http_connection.request(request)
+          YAML.load(response).each do |term_response|
+            term = WebTranslateIt::Term.new(term_response)
+            term.new_record = false
+            terms.push(term)
+          end
+          if response["Link"] && response["Link"].include?("rel=\"next\"")
+            url = response["Link"].match(/<(.*)>; rel="next"/)[1]
+            request = Net::HTTP::Get.new(url)
+            request.add_field("X-Client-Name", "web_translate_it")
+            request.add_field("X-Client-Version", WebTranslateIt::Util.version)
+          else
+            request = nil
+          end
         end
         return terms
-        
       rescue Timeout::Error
         puts "The request timed out. The service may be overloaded. We will retry in 5 seconds."
         sleep(5)
@@ -88,8 +95,7 @@ module WebTranslateIt
       request.add_field("X-Client-Version", WebTranslateIt::Util.version)
 
       begin
-        response = Connection.http_connection.request(request)
-        return nil if response.code.to_i == 404
+        response = Util.handle_response(Connection.http_connection.request(request), true, true)
         term = WebTranslateIt::Term.new(YAML.load(response.body))
         term.new_record = false
         return term
@@ -131,7 +137,7 @@ module WebTranslateIt
       request.add_field("X-Client-Version", WebTranslateIt::Util.version)
 
       begin
-        Util.handle_response(Connection.http_connection.request(request), true)
+        Util.handle_response(Connection.http_connection.request(request), true, true)
       rescue Timeout::Error
         puts "The request timed out. The service may be overloaded. We will retry in 5 seconds."
         sleep(5)
@@ -156,7 +162,7 @@ module WebTranslateIt
       request.add_field("X-Client-Version", WebTranslateIt::Util.version)
 
       begin
-        response = Util.handle_response(Connection.http_connection.request(request), true)
+        response = Util.handle_response(Connection.http_connection.request(request), true, true)
         array = YAML.load(response)
         return nil if array.empty?
         translations = []
@@ -189,7 +195,7 @@ module WebTranslateIt
       end
 
       begin
-        Util.handle_response(Connection.http_connection.request(request), true)
+        Util.handle_response(Connection.http_connection.request(request), true, true)
       rescue Timeout::Error
         puts "The request timed out. The service may be overloaded. We will retry in 5 seconds."
         sleep(5)
@@ -206,7 +212,7 @@ module WebTranslateIt
       request.body = self.to_json(true)
 
       begin
-        response = YAML.load(Util.handle_response(Connection.http_connection.request(request), true))
+        response = YAML.load(Util.handle_response(Connection.http_connection.request(request), true, true))
         self.id = response["id"]
         self.new_record = false
         return true

data/lib/web_translate_it/term_translation.rb

@@ -61,8 +61,7 @@ module WebTranslateIt
       request.body = self.to_hash.to_json
 
       begin
-        response = Util.handle_response(Connection.http_connection.request(request), true)
-        response = YAML.load(response)
+        response = YAML.load(Util.handle_response(Connection.http_connection.request(request), true, true))
         self.id = response["id"]
         self.new_record = false
         return true
@@ -83,8 +82,7 @@ module WebTranslateIt
       request.body = self.to_hash.to_json
 
       begin
-        Util.handle_response(Connection.http_connection.request(request), true)
-        
+        Util.handle_response(Connection.http_connection.request(request), true, 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

@@ -49,7 +49,7 @@ module WebTranslateIt
       request.body = self.to_hash.to_json
 
       begin
-        Util.handle_response(Connection.http_connection.request(request), true)
+        Util.handle_response(Connection.http_connection.request(request), true, 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/util.rb

@@ -4,6 +4,8 @@ module WebTranslateIt
   # A few useful functions
   class Util
     
+    require 'json'
+    
     # Return a string representing the gem version
     # For example "1.8.3"
     def self.version
@@ -15,15 +17,19 @@ module WebTranslateIt
       ((processed*10)/total).to_f.ceil*10
     end
     
-    def self.handle_response(response, return_response = false)
+    def self.handle_response(response, return_response = false, raise_exception = false)
       if response.code.to_i >= 400 and response.code.to_i < 500
-        if response.body
-          StringUtil.failure(response.body)
+        if raise_exception
+          raise "Error: #{JSON.parse(response.body)['error']}"
         else
-          StringUtil.failure("Error: Can't find project with this API key.")
+          StringUtil.failure(JSON.parse(response.body)['error'])
         end
       elsif response.code.to_i == 500
-        StringUtil.failure("Error: Server temporarily unavailable. Please try again shortly.")
+        if raise_exception
+          raise "Error: Server temporarily unavailable (Error 500)."
+        else
+          StringUtil.failure("Error: Server temporarily unavailable (Error 500).")
+        end
       else
         return response.body if return_response
         return StringUtil.success("OK") if response.code.to_i == 200

data/readme.md

@@ -23,7 +23,9 @@ This readme focusses on the most commonly used functionality of this rubygem: th
 
 ## 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).
+A dependency of wti needs gcc in order to install, so you will need build tools. With Linux, `apt-get install gcc` or `yum install gcc` should do it.
+
+You will also 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).
 
     gem install web_translate_it
     

data/spec/web_translate_it/string_spec.rb

@@ -93,8 +93,7 @@ describe WebTranslateIt::String do
         string_fetched.should_not be_nil
         
         string_fetched.delete
-        string_fetched = WebTranslateIt::String.find(string.id)
-        string_fetched.should be_nil
+        lambda { WebTranslateIt::String.find(string.id) }.should raise_error
       end
     end
   end

data/version

@@ -1 +1 @@
-2.0.1
+2.0.2

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web_translate_it
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-11 00:00:00.000000000 Z
+date: 2012-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -104,7 +104,6 @@ files:
 - license
 - readme.md
 - version
-- examples/en.yml
 - examples/locale.rb
 - lib/web_translate_it/auto_fetch.rb
 - lib/web_translate_it/cacert.pem
@@ -155,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A CLI to sync locale files with webtranslateit.com.

data/examples/en.yml

@@ -1,43 +0,0 @@
-fr:
-  activerecord:
-    errors:
-      templates:
-        header:
-          one: "1 error prohibited this {{model}} from being saved"
-          other: "{{count}} errors prohibited this {{model}} from being saved"
-          body: "there were problems with the following fields:"
-          messages:
-            accepted: "must be accepted"
-            blank: "can't be blank"
-            confirmation: "doesn't match confirmation"
-            empty: "can't be empty"
-            equal_to: "must be equal to {{count}}"
-            even: "must be even"
-            exclusion: "is reserved"
-            greater_than: "must be greater than {{count}}"
-            greater_than_or_equal_to: "must be greater than or equal to {{count}}"
-            inclusion: "is not included in the list"
-            invalid: "is invalid"
-            less_than: "must be less than {{count}}"
-            less_than_or_equal_to: "must be less than or equal to {{count}}"
-            not_a_number: "is not a number"
-            odd: "must be odd"
-            taken: "is already taken"
-            too_long: "is too long (maximum is {{count}} characters)"
-            too_short: "is too short (minimum is {{count}} characters)"
-            wrong_length: "is the wrong length (should be {{count}} characters)"
-      models:
-        invitation:
-          attributes:
-            email:
-              user_already_invited: "This user has already been invited"
-              user_already_member: "This user is already a member"
-        project_file:
-          attributes:
-            file:
-              file_format_not_supported: "Sorry, we currenly support only Gettext .pot/.po, .yml/.yaml and .strings"
-  another_one: dskjdks
-  another_string: "this is another string"
-  hello: "Hello world!!"
-  new_string: hehe
-  test: " & & "