crutch-google_translate 0.0.3

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 3
+:major: 0

data/lib/google_translate.rb

@@ -0,0 +1,26 @@
+#require 'open-uri'
+require 'net/http'
+require 'cgi'
+require 'rubygems'
+require 'json'
+
+# google translate API gem
+# This is based on the documentation found here
+# http://code.google.com/apis/ajaxlanguage/documentation/#Versioning
+# look for the paragraph 'Flash and other Non-Javascript Environments'
+#
+# look at the Translator and LanguageDetect class (or README file) for instructions
+module GoogleTranslate
+  HOSTNAME = "ajax.googleapis.com"
+  PATH ="/ajax/services/language/"
+  VERSION = "1.0"
+  #USERAGENT = 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.0.1) Gecko/20060111 Firefox/1.5.0.1'
+
+end
+
+require 'google_translate/exceptions'
+require 'google_translate/languages'
+require 'google_translate/parsed_response'
+require 'google_translate/api_call'
+require 'google_translate/translator'
+require 'google_translate/language_detect' 

data/lib/google_translate/api_call.rb

@@ -0,0 +1,31 @@
+module GoogleTranslate
+  module ApiCall
+    def google_api_call(service,params,response_class,get=false)
+      data = []
+      params.each_pair {|key, value| data << "#{key}=#{value}" }
+      data_string = data.join('&')
+      headers = {
+        'Referer' => 'http://www.here-goes-a-referreri',
+        'Content-Type' => 'application/x-www-form-urlencoded',
+      }
+
+      if(get)
+        require 'uri'
+        response = Net::HTTP.get(URI.parse("http://#{HOSTNAME}#{PATH}#{service}?#{data_string}"))
+      else
+        response = Net::HTTP.new(HOSTNAME).post(PATH + service,data_string,headers)
+      end
+
+      raise GoogleUnavailable if response.nil? || response == ""
+      raise GoogleException if !get && response.code.to_i != 200
+      
+      if(get)
+        parsed_response = response_class.new(response)
+      else
+        parsed_response = response_class.new(response.body)
+      end
+      
+      parsed_response # return response class
+    end
+  end
+end

data/lib/google_translate/exceptions.rb

@@ -0,0 +1,22 @@
+module GoogleTranslate
+  
+  # Invalid language (or more specifically not one in existing list)
+  class InvalidLanguage < Exception
+  end
+  
+  # no response returned to request
+  class GoogleUnavailable < Exception
+  end
+  
+  # the status of the response indicates an error
+  class GoogleException < Exception
+  end
+  
+  # the detection of the language is deemed unreliable by google.
+  class UnreliableDetection < Exception
+  end
+  
+  # if no string is furnished for translation or detection
+  class NoGivenString < Exception
+  end
+end

data/lib/google_translate/language_detect.rb

@@ -0,0 +1,31 @@
+module GoogleTranslate
+  # manage language detection based on a given string of text
+  # <b>how to use</b>:
+  #   language = LanguageDetect.detect("il fait beau aujourd'hui") # returns "fr"
+  class LanguageDetect
+    extend ApiCall
+
+    SERVICE = "detect"
+    PARAMS = {"v" => "#{VERSION}"}
+    
+    # detect the language of a given text.
+    def self.detect(text)
+      PARAMS["q"] = CGI.escape(text)
+      #the "true" parameter indicates that HTTP GET should be used (POST is only for translation)
+      response = google_api_call(SERVICE,PARAMS,DetectResponse,true)
+      raise UnreliableDetection if !response.is_reliable  
+      response.language # return value
+    end
+  end
+  
+  # to handle the detection response
+  class DetectResponse < ParsedResponse
+    attr_reader :language, :is_reliable, :confidence
+    def initialize(string)
+      super(string)      
+      @language = @response_data['language']
+      @is_reliable = @response_data['isReliable']
+      @confidence = @response_data['confidence']
+    end
+  end
+end

data/lib/google_translate/languages.rb

@@ -0,0 +1,45 @@
+module GoogleTranslate
+
+ARABIC = "ar"
+BULGARIAN = "bg"
+CATALAN = "ca"
+CHINESE = "zh"
+CHINESE_SIMPLIFIED = "zh-CN"
+CHINESE_TRADITIONAL = "zh-TW"
+CROATIAN = "cr"
+CZECH = "cs"
+DANISH = "da"
+DUTCH = "nl"
+ENGLISH = "en"
+FILIPINO = "tl"
+FINNISH = "fi"
+FRENCH = "fr"
+GERMAN = "de"
+GREEK = "el"
+HEBREW = "iw"
+HINDI = "hi"
+INDONESIAN = "id"
+ITALIAN = "it"
+JAPANESE = "ja"
+KOREAN = "ko"
+LATVIAN = "lv"
+LITHUANIAN = "lt"
+NORWEGIAN = "no"
+POLISH = "pl"
+PORTUGESE = "pt"
+ROMANIAN = "ro"
+RUSSIAN = "ru"
+SERBIAN = "sr"
+SLOVAK = "sk"
+SLOVENIAN = "sl"
+SPANISH = "es"
+SWEDISH = "sv"
+UKRANIAN = "uk"
+VIETNAMESE = "vi"
+
+LANGUAGES = [ARABIC, BULGARIAN, CATALAN, CHINESE, CHINESE_SIMPLIFIED,CHINESE_TRADITIONAL,
+ CROATIAN, CZECH, DANISH, DUTCH, ENGLISH, FILIPINO, FRENCH, GERMAN, GREEK, HEBREW,
+ ITALIAN, JAPANESE, KOREAN, LATVIAN, LITHUANIAN, NORWEGIAN, POLISH, PORTUGESE,
+ ROMANIAN, RUSSIAN, SERBIAN, SLOVAK, SLOVENIAN, SPANISH, SWEDISH, UKRANIAN, VIETNAMESE]
+
+end

data/lib/google_translate/parsed_response.rb

@@ -0,0 +1,12 @@
+module GoogleTranslate
+  # superclass for parsing the response: contains the common elements
+  class ParsedResponse
+    #attr_reader :status, :details
+    def initialize(string)
+      json = JSON.parse(string)
+      #@status = json['responseStatus']
+      #@details = json['responseDetails']
+      @response_data = json['responseData']
+    end
+  end
+end

data/lib/google_translate/translator.rb

@@ -0,0 +1,49 @@
+module GoogleTranslate
+  # manage translation of a given string from a given language to another language
+  # <b>How to use</b>:
+  #   translator = Translator.new("en","fr") # so several translations can be performed with this new object
+  #   result = translator.translate("nice day today") # returns "belle journÃe aujourd'hui"
+  class Translator
+    include ApiCall
+    
+    SERVICE = "translate"
+    PARAMS = {"v" => "#{VERSION}"}
+
+    # initialize the translator with the language to translate from (from) and the language to translate to (to)
+    def initialize(from,to)
+      raise InvalidLanguage if !is_language?(from)
+      raise InvalidLanguage if !is_language?(to)
+      @from = from
+      @to = to
+    end
+
+    # translate a string in the given languages
+    # options so far:
+    # - html: if html encoding is desirable (for immediate display on a web page for instance) 
+    #           then this option needs to have a true value (:html => true)
+    def translate(text,options = {})
+      PARAMS["langpair"] = "#{@from}%7C#{@to}"
+      PARAMS["q"] = CGI.escape(text)
+      response = google_api_call(SERVICE, PARAMS, TranslationResponse)
+      translation = options[:html] ? response.translation : CGI.unescapeHTML(response.translation)
+      translation # return value
+    end
+
+  private
+    def is_language?(lang)
+      return true if lang == ""
+      LANGUAGES.include?(lang)
+    end
+  end
+  
+  # to handle the translation response
+  class TranslationResponse < ParsedResponse
+    attr_reader :translation
+    def initialize(string)
+      super(string)      
+      # here we unescape html escaped characters BUT if it's required to keep html format,
+      # an extra option should be added
+      @translation = @response_data['translatedText'] if @response_data
+    end
+  end
+end

data/spec/detect_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe GoogleTranslate, 'detect' do
+  it "should detect the language of a string" do
+    LanguageDetect.detect("il fait beau aujourd'hui").should be == "fr"
+  end
+   
+  it "should raise an error if no string" do
+    lambda {
+      LanguageDetect.detect(nil)
+    }.should raise_error(NoGivenString)
+  end
+  
+  it "should raise an error if language not recognized" do
+    lambda {
+      LanguageDetect.detect("bliiiioaarg oqsdkqsdf")
+    }.should raise_error(UnreliableDetection)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+gem 'rspec', '~> 1.1.3'
+require 'spec'
+
+# add lib directory
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+require 'google_translate'
+include GoogleTranslate
+
+

data/spec/translate_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe GoogleTranslate, 'translate' do
+  it "should raise an error if the from language is missing or doesn't exist" do
+    lambda {
+      Translator.new(nil,'en')
+    }.should raise_error(InvalidLanguage)
+  end
+  
+  it "should raise an error if the to language is missing or doen't exist" do
+    lambda {
+      Translator.new('en','wk') # wookie speak
+    }.should raise_error(InvalidLanguage)
+  end
+  
+  it "should translate a string" do
+    translator = Translator.new('en','fr')
+    result = translator.translate("nice day today")
+    result.should be == "belle journée aujourd'hui"
+  end
+  
+  it "should raise an error if no response" do
+    translator = Translator.new('en','fr')
+    translator.stubs(:open).yields(StringIO.new) # stub empty response
+    lambda {
+      result = translator.translate("nice day today")      
+    }.should raise_error(GoogleUnavailable)
+  end
+  
+  # think how to handle this ... should it give a signal if the 
+  # translation == the input ?
+  it "should not translate if untranslateable string" do
+    translator = Translator.new('en','fr')
+    result = translator.translate("blaargh")
+    result.should be == "blaargh"
+  end
+  
+  it "should leave html encoding if required" do
+    translator = Translator.new('en','fr')
+    result = translator.translate("nice day today", :html => true)
+    result.should be == "belle journée aujourd'hui"
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: crutch-google_translate
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Elise Huard
+- Michal Barla
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Google Translate Ruby API - based on google documentation
+email: michal.barla@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- lib/google_translate
+- lib/google_translate/api_call.rb
+- lib/google_translate/exceptions.rb
+- lib/google_translate/language_detect.rb
+- lib/google_translate/languages.rb
+- lib/google_translate/parsed_response.rb
+- lib/google_translate/translator.rb
+- lib/google_translate.rb
+- spec/detect_spec.rb
+- spec/spec_helper.rb
+- spec/translate_spec.rb
+has_rdoc: true
+homepage: http://github.com/crutch/google_translate
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Google Translate Ruby API
+test_files: []
+