language-translator 0.1.5 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1dcf8eeb8ca7bdd51ece6cd887c96075f4b63f9456887b723af6f4540cf1881c
+  data.tar.gz: 8fff57087807702af24a22452024dd83aba24754fb0cd925b7cef3f79b671abb
+SHA512:
+  metadata.gz: 8fbb593e9783625e2ca912db3fa66ca68c0ba927079b6efb35613dca9a9110f5df398bd3f5d1f90ec4710fbf7c98359b343e722342a9c2b959cc8552d001d347
+  data.tar.gz: 7c607fd9a3e7dc30085a33cc8ffbaca290f8adeaf15fae8bb7f14452204a270196571ce4ac7c6de75cffe75569cb42f2344e62bbc50cb63ef2b035a454d9fc18

data/README.rdoc

@@ -1,23 +1,47 @@
-= Translator 
+= Translator
 
 == Description
-Ruby gem to translate a string from one language to another using google api.
+Ruby gem to translate a string from one language to another using Google's public translate endpoint
+(`https://translate.googleapis.com/translate_a/single`). The integration does **not** require an API key.
 
 == Installation
 
 gem install language-translator
 
-== Usage 
+== Usage
 
-  require 'rubygems' 
-  require 'translator' 
+  require 'rubygems'
+  require 'translator'
 
-  #To translate 'Hello World' to Hindi
-  tr = Translator.new()
-  tr.translate( 'Hello, World', 'hi')     #=> "नमस्ते, दुनिया"
+  tr = Translator.new
 
-  #To translate "नमस्ते, दुनिया" to English
-  tr.translate('नमस्ते, दुनिया', 'en','hi')       #=> "Hello World"
+  # translate from English to Hindi
+  tr.translate('Hello, World', 'hi', 'en')  #=> "नमस्ते, दुनिया"
 
-  #From Unknown language to english, from 0.1.2
-  tr.to_en('नमस्ते, दुनिया')                    #=> "Hello World"
+  # translate from Japanese to English
+  tr.translate('こんにちは世界', 'en', 'ja')  #=> "Hello world"
+
+  # let Google auto-detect the source language (to English)
+  tr.to_en('¡Hola, mundo!')                #=> "Hello world"
+
+== Running tests
+
+All HTTP calls are mocked via Mocha. You can run the suite without network access:
+
+  ruby -Itest test/translator_test.rb
+
+== Trying it in IRB
+
+To experiment interactively without installing the gem:
+
+  irb -I lib
+  irb(main):001:0> require 'translator'
+  => true
+  irb(main):002:0> Translator.new.translate('Hello world', 'es', 'en')
+  => "Hola Mundo"
+
+== Supported languages
+
+`Translator::SUPPORTED_LANG_CODES` tracks every language code currently available through Google Translate
+(including legacy aliases like `iw` and `pt-PT`). Call `Translator::SUPPORTED_LANG_CODES.sort` if you need to
+inspect or display the full list.

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('language-translator', '0.1.2') do |p|
+Echoe.new('language-translator', '0.1.5') do |p|
   p.description    = "Ruby gem to translate a string from one language to another using google api."
   p.url            = "http://github.com/anilyanduri/language-translator"
   p.author         = "Anil Yanduri"

data/language-translator.gemspec

@@ -2,9 +2,10 @@
 
 Gem::Specification.new do |s|
   s.name = %q{language-translator}
-  s.version = "0.1.5"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.required_ruby_version = Gem::Requirement.new(">= 2.6")
   s.authors = ["Anil Yanduri"]
   s.date = %q{2011-05-05}
   s.description = %q{Ruby gem to translate from one language to another using google api. }
@@ -14,8 +15,8 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/anilyanduri/language-translator}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Language-translator", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{language-translator}
-  s.rubygems_version = %q{1.3.5}
+  s.license = "MIT"
+  s.rubygems_version = %q{3.5.22}
   s.summary = %q{Ruby gem to translate from one language to another using google api.}
   s.test_files = ["test/translator_test.rb", "test/test_helper.rb"]
 
@@ -29,4 +30,3 @@ Gem::Specification.new do |s|
   else
   end
 end
-

data/lib/translator.rb

@@ -1,5 +1,6 @@
 require 'net/http'
 require 'json'
+require 'uri'
 
 class UnSupportedLanguage < RuntimeError
   attr :msg
@@ -10,44 +11,78 @@ end
 
 class Translator
 
-  Site_Url = 'ajax.googleapis.com'
-  Request_Uri = "/ajax/services/language/translate"
-  SUPPORTED_LANG_CODES = ['sr','lt','lv','iw','cy','ga','id','de','zh-TW','es','sl','ko','it','eu','az','af','sk','pt-PT','no','gl','bg','ar','tr','fa','mk','el','da','yi','ur','uk','ro','ja','zh','sw','mt','ms','is','ka','en','hr','ca','th','ru','hy','vi','tl','sv','hu','hi','fi','sq','pl','fr','et','nl','cs','zh-CN','be']
+  Site_Url = 'translate.googleapis.com'
+  Request_Uri = "/translate_a/single"
+  SUPPORTED_LANG_CODES = [
+    'af', 'sq', 'am', 'ar', 'hy', 'az', 'eu', 'be', 'bn', 'bs', 'bg', 'ca',
+    'ceb', 'ny', 'zh-CN', 'zh-TW', 'co', 'hr', 'cs', 'da', 'nl', 'en', 'eo',
+    'et', 'fil', 'fi', 'fr', 'fy', 'gl', 'ka', 'de', 'el', 'gu', 'ht', 'ha',
+    'haw', 'iw', 'he', 'hi', 'hmn', 'hu', 'is', 'ig', 'id', 'ga', 'it', 'ja',
+    'jw', 'kn', 'kk', 'km', 'rw', 'ko', 'ku', 'ky', 'lo', 'la', 'lv', 'lt',
+    'lb', 'mk', 'mg', 'ms', 'ml', 'mt', 'mi', 'mr', 'mn', 'my', 'ne', 'no',
+    'or', 'ps', 'fa', 'pl', 'pt', 'pt-PT', 'pa', 'ro', 'ru', 'sm', 'gd',
+    'sr', 'st', 'sn', 'sd', 'si', 'sk', 'sl', 'so', 'es', 'su', 'sw', 'sv',
+    'tg', 'ta', 'tt', 'te', 'th', 'tr', 'tk', 'uk', 'ur', 'ug', 'uz', 'vi',
+    'cy', 'xh', 'yi', 'yo', 'zu'
+  ]
 
-  # method to translate from one language to another
-  def translate( text, to, from='en' )
-    
+  # Public: Translate text using Google's HTTPS endpoint.
+  #
+  # text - String containing the source text.
+  # to   - Language code for the target language (see SUPPORTED_LANG_CODES).
+  # from - Optional source language code. Provide an empty string to let Google auto-detect.
+  #
+  # Returns the translated String or nil if Google returns an empty result.
+  def translate(text, to, from='en')
     begin
       raise UnSupportedLanguage unless SUPPORTED_LANG_CODES.include?(to)
       raise UnSupportedLanguage unless SUPPORTED_LANG_CODES.include?(from) unless from.empty? # letting to translate from unknown language
-      
-      http = Net::HTTP.new(Site_Url, 80)
-
-      request = Net::HTTP::Post.new(Request_Uri)
-      
-      request.set_form_data({'v'=>1.0, 'langpair'=>"#{from}|#{to}", 'q'=>"#{text}"})
-
-      response = http.request(request)
-      
-      json_response_body = JSON.parse( response.body )
-        
-      if json_response_body['responseStatus'] == 200
-        json_response_body['responseData']['translatedText']
-      else
-        puts json_response_body['responseDetails']
-        raise StandardError, response['responseDetails']
-      end
+
+      response = Net::HTTP.get_response(request_uri(text, to, from))
+      raise StandardError, "Translation API responded with #{response.code}" unless response.code.to_i == 200
+
+      parse_translation_response(response.body)
     rescue UnSupportedLanguage
       raise UnSupportedLanguage.new
     rescue => err_msg
       puts "#{err_msg}"
     end
-    
   end
 
-  # added in 0.1.2 to support from unknown to english
+  # Public: Convenience helper to translate from an unknown language to English.
+  #
+  # Equivalent to translate(text, "en", "") which triggers auto language detection.
   def to_en(text)
     translate( text, "en", "" )
   end
 
+  private
+
+  def request_uri(text, to, from)
+    query_params = {
+      'client' => 'gtx',
+      'dt' => 't',
+      'sl' => from.to_s.empty? ? 'auto' : from,
+      'tl' => to,
+      'q' => text
+    }
+
+    URI::HTTPS.build(
+      host: Site_Url,
+      path: Request_Uri,
+      query: URI.encode_www_form(query_params)
+    )
+  end
+
+  def parse_translation_response(body)
+    json_response_body = JSON.parse(body)
+    translations = json_response_body[0]
+    raise StandardError, "Translation API returned unexpected payload" unless translations.is_a?(Array)
+
+    translated_text = translations.map { |segment| segment[0] }.join
+    translated_text.empty? ? nil : translated_text
+  rescue JSON::ParserError => e
+    raise StandardError, "Translation API returned invalid JSON: #{e.message}"
+  end
+
 end

data/test/test_helper.rb

@@ -2,4 +2,4 @@ require 'test/unit'
 $:.unshift File.dirname(__FILE__) + '/../lib'
 require 'rubygems'
 require 'translator'
-require 'mocha'
+require 'mocha/test_unit'

data/test/translator_test.rb

@@ -1,52 +1,61 @@
-require File.dirname(__FILE__) + '/test_helper'
+require_relative 'test_helper'
 class TranslatorTest < Test::Unit::TestCase
-  
-   def test_translate_from_english_to_other
-    tr = Translator.new()
-    assert_equal("नमस्ते दुनिया", tr.translate("Hello world", "hi", "en"))
-    assert_equal("Bonjour tout le monde", tr.translate("Hello world", "fr", "en"))
-    assert_equal("Hallo Welt", tr.translate("Hello world", "de", "en"))
-    assert_equal("Ciao a tutti", tr.translate("Hello world", "it", "en"))
-    assert_equal("こんにちは、世界", tr.translate("Hello world", "ja", "en"))
-    assert_equal("Dia duit domhan", tr.translate("Hello world", "ga", "en"))
-    assert_equal("Olá mundo", tr.translate("Hello world", "pt-PT", "en"))
-    assert_equal("Привет мир", tr.translate("Hello world", "ru", "en"))
-    assert_equal("¡Hola, mundo", tr.translate("Hello world", "es", "en"))
-    assert_equal("مرحبا العالم", tr.translate("Hello world", "ar", "en"))
-  end
-  
-  def test_translate_from_other_to_english
-    tr = Translator.new()
-    assert_equal("Hello World", tr.translate("नमस्ते दुनिया", "en","hi") )
-    assert_equal("Hello world", tr.translate("世界您好", "en", "zh-CN"))
-    assert_equal("Hello world", tr.translate("Dia duit domhan", "en", "ga"))
-    assert_equal("Hello world", tr.translate("こんにちは、世界", "en", "ja"))
-    assert_equal("Hello world", tr.translate("안녕하세요 세상", "en", "ko"))
-    assert_equal("Hello world", tr.translate("Olá mundo", "en", "pt-PT"))
-    assert_equal("Hello world", tr.translate("Привет мир", "en", "ru"))
-    assert_equal("Hello world", tr.translate("¡Hola, mundo", "en", "es"))
-    assert_equal("Hello world", tr.translate("مرحبا العالم", "en", "ar"))
-  end
-  
+  def setup
+    @translator = Translator.new
+  end
+
+  def test_translate_from_english_to_other
+    expect_translation_request("Hello world", from: "en", to: "fr", translated_text: "Bonjour le monde")
+    assert_equal("Bonjour le monde", @translator.translate("Hello world", "fr", "en"))
+  end
+
   def test_translate_from_other_to_english
-    tr = Translator.new()
-    assert_equal("Hello World", tr.to_en("नमस्ते दुनिया"))
-    assert_equal("Hello world", tr.to_en("世界您好"))
-    assert_equal("Hello world", tr.to_en("Dia duit domhan"))
-    assert_equal("Hello world", tr.to_en("こんにちは、世界"))
-    assert_equal("Hello world", tr.to_en("안녕하세요 세상"))
-    assert_equal("Hello world", tr.to_en("Olá mundo"))
-    assert_equal("Hello world", tr.to_en("Привет мир"))
-    assert_equal("Hello world", tr.to_en("¡Hola, mundo"))
-    assert_equal("Hello world", tr.to_en("مرحبا العالم"))
-  end
-  
+    expect_translation_request("こんにちは世界", from: "ja", to: "en", translated_text: "Hello world")
+    assert_equal("Hello world", @translator.translate("こんにちは世界", "en", "ja"))
+  end
+
+  def test_translate_to_english_from_unknown_language
+    expect_translation_request("¡Hola, mundo!", from: "", to: "en", translated_text: "Hello world")
+    assert_equal("Hello world", @translator.to_en("¡Hola, mundo!"))
+  end
+
   def test_unsupported_translate
     assert_raise UnSupportedLanguage do
-      tr = Translator.new()
-      tr.translate("你好世界", 'zh', 'hz')
+      @translator.translate("你好世界", 'zh', 'hz')
     end
   end
-  
-end
 
+  def test_api_failure_returns_nil
+    expect_failed_translation_request("Hello world", from: "en", to: "de")
+    assert_nil(@translator.translate("Hello world", "de", "en"))
+  end
+
+  private
+
+  def expect_translation_request(text, from:, to:, translated_text:)
+    response = stub(:code => '200', :body => build_google_response(text, translated_text))
+    Net::HTTP.expects(:get_response).with { |uri| uri_matches?(uri, text, from, to) }.returns(response)
+  end
+
+  def expect_failed_translation_request(text, from:, to:)
+    response = stub(:code => '500', :body => 'Internal Server Error')
+    Net::HTTP.expects(:get_response).with { |uri| uri_matches?(uri, text, from, to) }.returns(response)
+  end
+
+  def build_google_response(original_text, translated_text)
+    [[[translated_text, original_text, nil, nil, 1]]].to_json
+  end
+
+  def uri_matches?(uri, text, from, to)
+    params = URI.decode_www_form(uri.query).to_h
+    source_language = from.empty? ? 'auto' : from
+
+    uri.host == Translator::Site_Url &&
+      uri.path == Translator::Request_Uri &&
+      params['client'] == 'gtx' &&
+      params['dt'] == 't' &&
+      params['q'] == text &&
+      params['sl'] == source_language &&
+      params['tl'] == to
+  end
+end

metadata

@@ -1,34 +1,23 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: language-translator
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 5
-  version: 0.1.5
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Anil Yanduri
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-05 00:00:00 +05:30
-default_executable: 
+date: 2011-05-05 00:00:00.000000000 Z
 dependencies: []
-
-description: "Ruby gem to translate from one language to another using google api. "
+description: 'Ruby gem to translate from one language to another using google api. '
 email: anilkumaryln@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - lib/translator.rb
-files: 
+files:
 - MIT-LICENSE
 - Manifest
 - README.rdoc
@@ -37,46 +26,35 @@ files:
 - lib/translator.rb
 - test/test_helper.rb
 - test/translator_test.rb
-has_rdoc: true
 homepage: http://github.com/anilyanduri/language-translator
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
+rdoc_options:
+- "--line-numbers"
+- "--inline-source"
+- "--title"
 - Language-translator
-- --main
+- "--main"
 - README.rdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 11
-      segments: 
-      - 1
-      - 2
-      version: "1.2"
+    - !ruby/object:Gem::Version
+      version: '1.2'
 requirements: []
-
-rubyforge_project: language-translator
-rubygems_version: 1.3.7
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 3
 summary: Ruby gem to translate from one language to another using google api.
-test_files: 
+test_files:
 - test/translator_test.rb
 - test/test_helper.rb