gengo 0.0.6 → 0.0.7.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ff0f3938fa56369d49bd3d1b433cf89df456a30
-  data.tar.gz: 393640dd5d5048c6cb0d6019da56ac8bb5e386c8
+  metadata.gz: be085b6228a9ff5fd3fba670320090db211a8507
+  data.tar.gz: aa298c83a73ce44d7a51e6090a4f0ceb6c475291
 SHA512:
-  metadata.gz: 2afd41658a2d4e95d723c26b1e7e05dc5e5cdbe915640f9d122337556c1384392efaaf0a737ece1fdc79d481cebe9bef969fb9f570174321960e2700adbfeae1
-  data.tar.gz: 8ca39ce90ba3c64f7127083e98ae3c051e555d62a14fa74d3d42d0d235e0f2f98f5fced6e431c28a6625f4f1cb096bfed2e85ed10e75111e7b597f126abfb004
+  metadata.gz: d60284a73d86897c116f3fc4242ef98d8fb5107eab982da7e5cea9f7649087963dc0c7c151b1d8b875dfda02c5e9746dcb7f81bd73f032fc508ab474d4270513
+  data.tar.gz: c1a2a082c13c47033295380ee221117548fe40bacbc6b51b904c9fd7e712e82b947ec02894a666d27a52be130d12d5934e52c68fbba0c357c9721dd35a1ed08c

data/Gemfile

@@ -2,9 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in gengo-ruby.gemspec
 gemspec
-
-group :development, :test do
-  gem 'rake'
-  gem 'rspec'
-  gem 'simplecov'
-end

data/gengo-ruby.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gs|
         "Issam Zeibak",
         "Alexander Lidé",
     ]
-    gs.date = "2015-04-27"
+    gs.date = "2015-08-24"
     gs.summary = "A library for interfacing with the Gengo Translation API."
     gs.description = "Gengo is a service that offers various translation APIs, both machine and high quality human-sourced. The Gengo gem lets you interface with the Gengo REST API (http://developers.gengo.com/).Note: previous version of this library can be found at https://rubygems.org/gems/mygengo. All further updates will be made here."
     gs.email = "api@gengo.com"
@@ -25,6 +25,7 @@ Gem::Specification.new do |gs|
     gs.add_dependency('mime-types')
     gs.add_development_dependency 'rspec', '~> 2.7'
     gs.add_development_dependency 'rack-test'
+    gs.add_development_dependency 'rake'
     gs.add_development_dependency 'simplecov'
     gs.add_development_dependency 'webmock'
 end

data/lib/gengo-ruby/api_handler.rb

@@ -30,13 +30,13 @@ module Gengo
         :private_key => '',
         :api_version => '2',
         :sandbox => false,
-        :user_agent => "Gengo Ruby Library; Version #{Gengo::Config::VERSION}; http://gengo.com/;",
+        :user_agent => "Gengo Ruby Library; Version #{Gengo::Config::VERSION}; Ruby Version #{RUBY_DESCRIPTION}; http://gengo.com/;",
         :debug => false,
       }.merge(opts)
 
       # Let's go ahead and separate these out, for clarity...
       @debug = @opts[:debug]
-      @api_host = (@opts[:sandbox] == true ? Gengo::Config::SANDBOX_API_HOST : Gengo::Config::API_HOST)
+      @api_host = (@opts[:sandbox] ? Gengo::Config::SANDBOX_API_HOST : Gengo::Config::API_HOST)
 
       # More of a public "check this" kind of object.
       @client_info = {"VERSION" => Gengo::Config::VERSION}
@@ -94,18 +94,23 @@ module Gengo
       http.read_timeout = 5*60
       resp = http.request(req)
 
-      if is_download_file.nil?
+      return resp.body if is_download_file
+
+      begin
         json = JSON.parse(resp.body)
-        if json['opstat'] != 'ok'
-          raise Gengo::Exception.new(json['opstat'], json['err']['code'].to_i, json['err']['msg'])
-        end
+      rescue => e
+        # TODO(yugui) Log the original error
+        raise Gengo::Exception.new('error', resp.code.to_i, resp.body) unless resp.kind_of?(Net::HTTPSuccess)
 
-        # Return it if there are no problems, nice...
-        return json
-      else
-        return resp.body
+        # It should be very unlikely, but resp.body can be invalid as a JSON in theory even though the status is successful.
+        # In this case, raise an exception to report that unexpected status.
+        raise Gengo::Exception.new('error', 500, 'unexpected format of server response. Report it to Gengo if this exception repeatedly happens')
       end
 
+      raise Gengo::Exception.new(json['opstat'], json['err']['code'].to_i, json['err']['msg']) unless json['opstat'] == 'ok'
+
+      # Return it if there are no problems, nice...
+      return json
     end
 
     # The "POST" method; handles shuttling up encoded job data to Gengo
@@ -152,19 +157,18 @@ module Gengo
       end
 
       resp = http.request(request)
-
-      case resp
-      when Net::HTTPSuccess, Net::HTTPRedirection
-        json = JSON.parse(resp.body)
-
-        if json['opstat'] != 'ok'
-          raise Gengo::Exception.new(json['opstat'], json['err']['code'].to_i, json['err']['msg'])
-        end
-
-        # Return it if there are no problems, nice...
-        json
-      else
-        resp.error!
+      resp.error! unless resp.kind_of?(Net::HTTPSuccess)
+
+      json = JSON.parse(resp.body)
+      return json if json['opstat'] == 'ok'
+
+      case
+      when json['err']['code']
+        raise Gengo::Exception.new(json['opstat'], json['err']['code'].to_i, json['err']['msg'])
+      when json['err'].respond_to?(:each)
+        # Ad-hock care of bulk operations. To be done in a higher-layer in future.  [#93504182]
+        err = json['err'].map {|key, value| value.respond_to?(:first) ? value.first : value }
+        raise Gengo::Exception.new(json['opstat'], err.first['code'], err.map{|e| e['msg']}.join(';'))
       end
     end
 
@@ -262,17 +266,18 @@ module Gengo
     # <tt>action</tt> - A hash describing the update to this job. See the examples for further documentation.
     def updateTranslationJob(params = {})
       params[:is_put] = true
-      self.send_to_gengo('translate/job/:id'.gsub(':id', params.delete(:id).to_s), params)
+      id = params.delete(:id).to_s
+      self.send_to_gengo("translate/job/#{id}", params)
     end
 
     # Updates a group of already submitted jobs.
     #
     # Options:
-    # <tt>jobs</tt> - An Array of job objects to update (job objects or ids)
+    # <tt>job_ids</tt> - An Array of job objects to update (job objects or ids)
     # <tt>action</tt> - A String describing the update to this job. "approved", "rejected", etc - see Gengo docs.
     def updateTranslationJobs(params = {})
       params[:is_put] = true
-      self.send_to_gengo('translate/jobs', {:jobs => params[:jobs], :action => params[:action]})
+      self.send_to_gengo('translate/jobs', params)
     end
 
     # Given an ID, pulls down information concerning that job from Gengo.
@@ -280,35 +285,75 @@ module Gengo
     # <tt>id</tt> - The ID of a job to check.
     # <tt>pre_mt</tt> - Optional, get a machine translation if the human translation is not done.
     def getTranslationJob(params = {})
-      self.get_from_gengo('translate/job/:id'.gsub(':id', params.delete(:id).to_s), params)
+      id = params.delete(:id).to_s
+      self.get_from_gengo("translate/job/#{id}", params)
     end
 
-    # Pulls down a list of recently submitted jobs, allows some filters.
+    # Fetches a list of recent jobs you made.
+    #
+    # @deprecated Use {#jobs} or {#query_jobs} instead.
     #
-    # <tt>status</tt> - Optional. "unpaid", "available", "pending", "reviewable", "approved", "rejected", or "canceled".
-    # <tt>timestamp_after</tt> - Optional. Epoch timestamp from which to filter submitted jobs.
-    # <tt>count</tt> - Optional. Defaults to 10.
+    # == Keyword Parameters
+    # <tt>ids</tt>::
+    #   Optional. An array of job IDs to be fetched.
+    #   Other parameters are ignored if you specify this parameter.
+    # <tt>status</tt>::
+    #   Optional. "unpaid", "available", "pending", "reviewable", "approved", "rejected", or "canceled".
+    # <tt>timestamp_after</tt>::
+    #   Optional. Epoch timestamp from which to filter submitted jobs.
+    # <tt>count</tt>::
+    #   Optional. Defaults to 10.
     def getTranslationJobs(params = {})
-      if params[:ids] and params[:ids].kind_of?(Array)
-        params[:ids] = params[:ids].map { |i| i.to_s() }.join(',')
-        self.get_from_gengo('translate/jobs/:ids'.gsub(':ids', params.delete(:ids)))
+      if params[:ids].respond_to?(:each)
+        jobs(params.delete(:ids))
       else
-        self.get_from_gengo('translate/jobs', params)
+        query_jobs(params)
       end
     end
 
-    # Pulls a group of jobs that were previously submitted together.
+    # Fetchs a set of recent jobs whose IDs are the given ones.
+    # @param ids [[Integer|String]] An array of job IDs to be fetched
+    def jobs(ids)
+      get_from_gengo('translate/jobs/%s' % ids.join(','))
+    end
+
+    # Fetchs a set of recent jobs you made.
+    # You can apply filters with the following keyword parameters.
+    #
+    # == Keyword Parameters
+    # <tt>status</tt>::
+    #   Optional. Fetches only jobs in this status.
+    #   Must be "unpaid", "available", "pending", "reviewable", "approved", "rejected", or "canceled".
+    # <tt>timestamp_after</tt>::
+    #   Optional. Epoch timestamp from which to filter submitted jobs.
+    # <tt>count</tt>::
+    #   Optional. The maximum number of jobs to be returned. Defaults to 10.
+    def query_jobs(params = {})
+      get_from_gengo('translate/jobs', params)
+    end
+
+    # Fetches a set of jobs in the order you made.
+    #
+    # @deprecated Use {#jobs_in_order} instead.
     #
-    # <tt>id</tt> - Required, the ID of a job that you want the batch/group of.
+    # == Required keyword parameters
+    # <tt>order_id</tt> - Required, the ID of a job that you want the batch/group of.
     def getTranslationOrderJobs(params = {})
-      self.get_from_gengo('translate/order/:order_id'.gsub(':order_id', params.delete(:order_id).to_s), params)
+      order_id = params[:order_id]
+      raise ArgumentError, 'order_id is a required parameter' unless order_id
+      jobs_in_order(order_id)
+    end
+
+    # Fetches a set of jobs in the order you made.
+    def jobs_in_order(id)
+      self.get_from_gengo("translate/order/#{id}")
     end
 
     # Mirrors the bulk Translation call, but just returns an estimated cost.
     def determineTranslationCost(params = {})
       is_upload = params.delete(:is_upload)
       if is_upload
-        self.upload_to_gengo('translate/service/quote/file', params)
+        self.upload_to_gengo('translate/service/quote', params)
       else
         self.send_to_gengo('translate/service/quote', params)
       end
@@ -325,7 +370,8 @@ module Gengo
     # <tt>id</tt> - The ID of the job you're commenting on.
     # <tt>comment</tt> - The comment to put on the job.
     def postTranslationJobComment(params = {})
-      self.send_to_gengo('translate/job/:id/comment'.gsub(':id', params.delete(:id).to_s), params)
+      id = params.delete(:id).to_s
+      self.send_to_gengo("translate/job/#{id}/comment", params)
     end
 
     # Get all comments (the history) from a given job.
@@ -333,7 +379,8 @@ module Gengo
     # Options:
     # <tt>id</tt> - The ID of the job to get comments for.
     def getTranslationJobComments(params = {})
-      self.get_from_gengo('translate/job/:id/comments'.gsub(':id', params.delete(:id).to_s), params)
+      id = params.delete(:id).to_s
+      self.get_from_gengo("translate/job/#{id}/comments", params)
     end
 
     # Returns the feedback you've submitted for a given job.
@@ -341,7 +388,8 @@ module Gengo
     # Options:
     # <tt>id</tt> - The ID of the translation job you're retrieving comments from.
     def getTranslationJobFeedback(params = {})
-      self.get_from_gengo('translate/job/:id/feedback'.gsub(':id', params.delete(:id).to_s), params)
+      id = params.delete(:id).to_s
+      self.get_from_gengo("translate/job/#{id}/feedback", params)
     end
 
     # Gets a list of the revision resources for a job. Revisions are created each time a translator updates the text.
@@ -349,7 +397,8 @@ module Gengo
     # Options:
     # <tt>id</tt> - The ID of the translation job you're getting revisions from.
     def getTranslationJobRevisions(params = {})
-      self.get_from_gengo('translate/job/:id/revisions'.gsub(':id', params.delete(:id).to_s), params)
+      id = params.delete(:id).to_s
+      self.get_from_gengo("translate/job/#{id}/revisions", params)
     end
 
     # Get a specific revision to a job.
@@ -358,7 +407,9 @@ module Gengo
     # <tt>id</tt> - The ID of the translation job you're getting revisions from.
     # <tt>rev_id</tt> - The ID of the revision you're looking up.
     def getTranslationJobRevision(params = {})
-      self.get_from_gengo('translate/job/:id/revision/:revision_id'.gsub(':id', params.delete(:id).to_s).gsub(':revision_id', params.delete(:rev_id).to_s), params)
+      id = params.delete(:id).to_s
+      revision_id = params.delete(:rev_id).to_s
+      self.get_from_gengo("translate/job/#{id}/revision/#{revision_id}", params)
     end
 
     # Deletes an order, cancelling all available jobs.
@@ -369,7 +420,26 @@ module Gengo
     # <tt>id</tt> - The ID of the order you want to delete.
     def deleteTranslationOrder(params = {})
       params[:is_delete] = true
-      self.get_from_gengo('translate/order/:id'.gsub(':id', params.delete(:id).to_s), params)
+      id = params.delete(:id).to_s
+      self.get_from_gengo("translate/order/#{id}", params)
+    end
+
+    # Get all comments (the history) from a given order.
+    #
+    # Requirements:
+    # <tt>order_id</tt> - The ID of the order to get comments for.
+    def get_translation_order_comments(order_id)
+      get_from_gengo("translate/order/#{order_id}/comments")
+    end
+
+    # Post a comment for a translator or Gengo on an order.
+    #
+    # Options:
+    # <tt>id</tt> - The ID of the order you're commenting on.
+    # <tt>comment</tt> - The comment to put on the order.
+    def post_translation_order_comment(params = {})
+      id = params.delete(:id).to_s
+      send_to_gengo("translate/order/#{id}/comment", params)
     end
 
     # Deletes a job.
@@ -378,7 +448,8 @@ module Gengo
     # <tt>id</tt> - The ID of the job you want to delete.
     def deleteTranslationJob(params = {})
       params[:is_delete] = true
-      self.get_from_gengo('translate/job/:id'.gsub(':id', params.delete(:id).to_s), params)
+      id = params.delete(:id).to_s
+      self.get_from_gengo("translate/job/#{id}", params)
     end
 
     # Deletes multiple jobs.
@@ -415,13 +486,15 @@ module Gengo
 
     # Gets one glossary that belongs to the authenticated user
     def getGlossary(params = {})
-      self.get_from_gengo('translate/glossary/:id'.gsub(':id', params.delete(:id).to_s), params)
+      id = params.delete(:id).to_s
+      self.get_from_gengo("translate/glossary/#{id}", params)
     end
 
     # Downloads one glossary that belongs to the authenticated user
     def getGlossaryFile(params = {})
       params[:is_download] = true
-      self.get_from_gengo('translate/glossary/download/:id'.gsub(':id', params.delete(:id).to_s), params)
+      id = params.delete(:id).to_s
+      self.get_from_gengo("translate/glossary/download/#{id}", params)
     end
   end
 

data/lib/gengo-ruby/gengo_exception.rb

@@ -8,6 +8,11 @@ module Gengo
       @opstat = opstat
       @code = code
       @msg = msg
+      super(msg)
+    end
+
+    def inspect
+      "Gengo::Exception(opstat=%s, code=%d, msg=%s)" % [opstat, code, msg]
     end
   end
 end

data/lib/gengo-ruby/version.rb

@@ -1,5 +1,5 @@
 module Gengo
   module Config
-    VERSION = '0.0.6'
+    VERSION = '0.0.7.rc1'
   end
 end

data/test.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+require 'gengo'
+
+gengo = Gengo::API.new({
+  :public_key => 'cee8d849f2354e0a9ff62f19868194c1',
+  :private_key => 'd0895146e2d9459b908b2c31bab36f52',
+  :sandbox => false,
+})
+
+# Return the number of credits left on your account.
+puts gengo.getAccountBalance()

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gengo
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7.rc1
 platform: ruby
 authors:
 - Matthew Romaine
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-27 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -83,6 +83,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +145,7 @@ files:
 - lib/gengo-ruby/version.rb
 - lib/gengo.rb
 - licenses/LICENSE.txt
+- test.rb
 homepage: http://developers.gengo.com
 licenses:
 - New BSD
@@ -146,9 +161,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5