mugen 0.2.1

data/lib/mugen.rb

@@ -0,0 +1,73 @@
+require 'active_support'
+require 'cgi'      
+require 'hmac-sha1'
+require 'httparty'
+require 'mugen/core_extensions'
+require 'mugen/httparty_extensions'
+
+module Mugen  
+  extend self
+  
+  autoload :Client, 'mugen/client'
+  autoload :Account, 'mugen/account'
+  autoload :Service, 'mugen/service'
+  autoload :Jobs, 'mugen/jobs'
+  autoload :Job, 'mugen/job'
+  
+  @@errors = []
+
+  def api_url=(url)
+    @api_url = url
+  end
+
+  def api_url
+    @api_url || 'http://api.sandbox.mygengo.com/v1/'
+  end
+  
+  def api_key=(key)
+    @api_key = key
+  end
+
+  def api_key
+    @api_key or raise "API_KEY is not specified"
+  end
+  
+  def private_key=(key)
+    @private_key = key
+  end
+
+  def private_key
+    @private_key or raise "PRIVATE_KEY is not specified"
+  end   
+  
+  def errors
+    @@errors || []
+  end
+
+  def sign(private_key, data)
+    if Hash === data
+      sorted_keys = data.keys.sort
+      data = sorted_keys.zip(data.values_at(*sorted_keys)).map {|k, v|
+        "#{k}=#{CGI::escape(v.to_s)}"
+      } * '&'          
+    end
+    
+    HMAC::SHA1.hexdigest private_key, data
+  end
+  
+  def set_params(options = {}, method = :get)
+    params = ActiveSupport::OrderedHash.new
+    params.merge! '_method' => 'post' if method == :post
+    params.merge! 'api_key' => Mugen.api_key
+    params.merge! 'data' => options.to_json unless options.empty? 
+    params.merge! 'ts' => Time.now.gmtime.to_i.to_s
+    if method == :get 
+      params.merge! 'api_sig' => sign(Mugen.private_key, params)
+    else
+      params.merge! 'api_sig' => sign(Mugen.private_key, params.to_json.gsub('/', '\/'))
+    end
+      
+    params
+  end
+    
+end

data/lib/mugen/account.rb

@@ -0,0 +1,27 @@
+module Mugen
+  class Account < Client 
+    class << self
+      
+    #
+    # /account/stats (GET)
+    # Retrieves account stats, such as orders made.
+    #
+    def stats(options={})
+      res = self.get "/account/stats", :query => options
+      check_for_errors(res)
+      res['response']
+    end
+  
+    #
+    # /account/balance (GET)
+    # Retrieves account balance in credits
+    #
+    def balance(options={})
+      res = self.get "/account/balance", :query => options
+      check_for_errors(res)
+      res['response']      
+    end                              
+    
+    end
+  end
+end

data/lib/mugen/client.rb

@@ -0,0 +1,33 @@
+module Mugen
+  class Client
+    include HTTParty
+    base_uri Mugen.api_url || 'http://api.sandbox.mygengo.com/v1/'
+    headers = {
+      'Accept' => 'application/json',
+      'User-Agent' => 'myGengo Mugen Rails API Wrapper; Version 0.0.1; http://github.com/shell/mugen'
+    }
+
+    # debug_output $stderr                                
+
+    def self.before_get(path, options)
+      options[:query] = Mugen.set_params(options[:query]) if options.has_key? :query
+      [path, options]
+    end
+    
+    def self.before_post(path, options)
+      options[:body] = Mugen.set_params(options[:body], :post) if options.has_key? :body
+      [path, options]
+    end
+    
+    def self.before_put(path, options)
+      options[:body] = Mugen.set_params(options[:body], :post) if options.has_key? :body
+      [path, options]
+    end
+    
+    def self.check_for_errors(res)
+      if res['opstat'] != 'ok' && res['err']
+        Mugen.errors << res['err']['msg']
+      end
+    end
+  end                     
+end

data/lib/mugen/core_extensions.rb

@@ -0,0 +1,32 @@
+class Hash
+  
+  def sorted_hash
+    self.keys.sort
+  end
+  
+  # This hack to enables CGI::escape instead of URI.encode in to_params
+  def normalize_param(key, value)
+    param = ''
+    stack = []
+
+    if value.is_a?(Array)
+      param << value.map { |element| normalize_param("#{key}[]", element) }.join
+    elsif value.is_a?(Hash)
+      stack << [key,value]
+    else
+      param << "#{key}=#{CGI::escape(value.to_s)}&"            
+    end
+
+    stack.each do |parent, hash|
+      hash.each do |key, value|
+        if value.is_a?(Hash)
+          stack << ["#{parent}[#{key}]", value]
+        else
+          param << normalize_param("#{parent}[#{key}]", value)
+        end
+      end
+    end
+
+    param
+  end
+end

data/lib/mugen/httparty_extensions.rb

@@ -0,0 +1,26 @@
+module HTTParty
+  module ClassMethods
+    alias :original_get :get
+    alias :original_post :post
+    alias :original_put :put
+    
+    # Inject pre GET hook
+    def get(path, options={})
+      path, options = before_get(path, options) if respond_to?(:before_get)
+      original_get(path, options)      
+    end                                        
+
+    # Inject pre POST hook
+    def post(path, options={})
+      path, options = before_post(path, options) if respond_to?(:before_post)
+      original_post(path, options)
+    end
+
+    # Inject pre PUT hook
+    def put(path, options={})
+      path, options = before_put(path, options) if respond_to?(:before_put)
+      original_put(path, options)
+    end
+    
+  end
+end

data/lib/mugen/job.rb

@@ -0,0 +1,169 @@
+require 'tempfile'
+module Mugen
+  class Job < Client
+    class << self
+
+    attr_accessor :job_id, :slug, :body_src, :body_tgt, :lc_src, :lc_tgt,
+                  :unit_count, :tier, :credits, :status, :capcha_url,
+                  :eta, :callback_url, :auto_approve, :ctime, :custom_data,
+                  :mt, :comment, :as_group
+
+
+
+    #
+    # translate/job/{id} (GET)
+    #
+    # Retrieves a specific job
+    #
+    def find(id, options={})
+      res = self.get "/translate/job/#{id}", :query => options
+      check_for_errors(res)
+      res['response']['job']
+    end
+
+    #
+    # translate/job (POST)
+    #
+    # Post a new job for translation
+    #
+    def create(options = {})
+      if options.nil? || options.empty?
+        raise Exception, '"options" missing required parameters'
+      end
+      job = { 'job' => options }
+      res = self.post "/translate/job", :body => job
+      check_for_errors(res)
+      res['response']
+    end
+
+    #
+    # translate/job/{id} (PUT)
+    #
+    # Updates a job to translate.
+    #
+    def update(job_id, action, options = {})
+      # if options.nil? || options.empty?
+      #   raise Exception, '"options" missing required parameters'
+      # end
+      options.merge! :action => action
+      job = options
+      res = self.put "/translate/job/#{job_id}", :body => job
+      check_for_errors(res)
+      res['response']
+    end
+
+    def purchase(job_id, options = {})
+      update(job_id, 'purchase', options)
+    end
+
+    def revise(job_id, options = {})
+      update(job_id, 'revise', options)
+    end
+
+    def approve(job_id, options = {})
+      update(job_id, 'approve', options)
+    end
+
+    def reject(job_id, options = {})
+      update(job_id, 'reject', options)
+    end
+
+    #
+    # translate/job/{id} (DELETE)
+    #
+    # Cancels the job. You can only cancel a job if it has not been
+    # started already by a translator.
+    #
+    def delete(id, options = {})
+      options.merge!('_method' => 'delete')
+      res = self.delete "/translate/job/#{id}", :query => options
+      check_for_errors(res)
+      res['response']
+    end
+
+    #
+    # translate/job/{id}/preview (GET)
+    #
+    # Renders a JPEG preview of the translated text
+    # N.B. - if the request is valid, a raw JPEG stream is returned.
+    #
+    def preview(id, options = {})
+      name = "#{Time.now.gmtime.to_i}.jpg"
+      res = self.get "/translate/job/#{id}/preview", :query => options
+      check_for_errors(res)
+      fn = if defined?(Rails)
+        Rails.root.join('public', 'images', 'mygengo', name)
+      else
+        Tempfile.new(name)
+      end
+      if !File.exists?(fn)
+        tempfile = File.new(fn, "w+")
+        tempfile << res
+        tempfile.close
+        "mygengo/#{name}"
+      else
+        nil
+      end
+    end
+
+    #
+    # translate/job/{id}/comment (POST)
+    #
+    # Submits a new comment to the job's comment thread.
+    #
+    def create_comment(job_id, comment)
+      if comment.nil? || comment.empty?
+        raise Exception, '"options" missing required parameters'
+      end
+      res = self.post "/translate/job/#{job_id}/comment", :body => comment
+      check_for_errors(res)
+      res['response']
+    end
+
+    #
+    # translate/job/{id}/comments (GET)
+    #
+    # Retrieves the comment thread for a job
+    #
+    def comments(id, options = {})
+      res = self.get "/translate/job/#{id}/comments", :query => options
+      check_for_errors(res)
+      res['response']['thread']
+    end
+
+    #
+    # translate/job/{id}/feedback (GET)
+    #
+    # Retrieves the feedback
+    #
+    def feedback(id, options = {})
+      res = self.get "/translate/job/#{id}/feedback", :query => options
+      check_for_errors(res)
+      res['response']['feedback']
+    end
+
+    #
+    # translate/job/{id}/revisions (GET)
+    #
+    # Gets list of revision resources for a job.
+    #
+    def revisions(id, options = {})
+      res = self.get "/translate/job/#{id}/revisions", :query => options
+      check_for_errors(res)
+      res['response']['revisions']
+    end
+
+    #
+    # translate/job/{job_id}/revision/{id} (GET)
+    #
+    # Gets specific revision for a job.
+    #
+    def revision(job_id, id, options = {})
+      res = self.get "/translate/job/#{job_id}/revision/#{id}", :query => options
+      check_for_errors(res)
+      res['response']['revision']
+    end
+
+    end
+  end
+end

data/lib/mugen/jobs.rb

@@ -0,0 +1,42 @@
+module Mugen
+  class Jobs < Client
+    class << self
+    #
+    # translate/jobs (GET)
+    #
+    # Retrieves a list of resources for the most recent jobs filtered
+    # by the given parameters.
+    #
+    def all(options={})
+      res = self.get "/translate/jobs", :query => options 
+      check_for_errors(res)
+      res['response']
+    end
+    
+
+    #
+    # translate/jobs/{id} (GET)
+    #
+    # Retrieves the group of jobs that were previously submitted
+    # together.
+    #
+    def by_group(id, options={})
+      res = self.get "/translate/jobs/#{id}", :query => options 
+      check_for_errors(res)
+      res['response']
+    end            
+    
+    #
+    # translate/jobs (POST)
+    #
+    # Submits a job or group of jobs to translate.
+    #
+    def create(options = {})
+      res = self.post "/translate/jobs", :body => options
+      check_for_errors(res)
+      res['response']
+    end
+   
+    end 
+  end
+end

data/lib/mugen/service.rb

@@ -0,0 +1,30 @@
+module Mugen
+  class Service < Client
+    class << self
+      
+    #
+    # translate/service/language_pairs (GET)
+    #
+    # Returns supported translation language pairs, tiers, and credit
+    # prices.
+    #
+    def language_pairs(options={})
+      res = self.get "/translate/service/language_pairs", :query => options
+      check_for_errors(res)
+      res['response']
+    end
+
+    #
+    # translate/service/languages (GET)
+    #
+    # Returns a list of supported languages and their language codes.
+    #
+    def languages(options={})
+      res = self.get "/translate/service/languages", :query => options
+      check_for_errors(res)
+      res['response']
+    end
+    
+    end 
+  end
+end

data/lib/mugen/version.rb

@@ -0,0 +1,3 @@
+module Mugen
+  VERSION = "0.2.1"
+end

data/lib/tasks/mugen.rake

@@ -0,0 +1,5 @@
+namespace :mugen do 
+  task :hello
+    puts 'Hello'
+  end
+end