Contents

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[0,GOOGLE_STRING_LIMIT])
      response = google_api_call(SERVICE, PARAMS, TranslationResponse)
      translation = options[:html].nil? ? 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

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
crutch-google_translate-0.0.4	lib/google_translate/translator.rb