gtranslate-two 0.1.3 → 0.1.4

data/Gemfile

@@ -1,7 +1,5 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+gem "json"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -6,6 +6,7 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    json (1.4.6)
     rake (0.8.7)
     rcov (0.9.9)
     shoulda (2.11.3)
@@ -16,5 +17,6 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.5.2)
+  json
   rcov
   shoulda

data/README.rdoc

@@ -2,7 +2,7 @@
 
 This is a simple Ruby gem designed to use Google Translate API v2 - unlike other gems which use the first version of the API.
 
-Also unlike other available gems, this one requires the use of an API key, which you can get from the {Google APIs console} [https://code.google.com/apis/console/].
+Also unlike other available gems, this one requires the use of an API key, which you can get from the {Google APIs console}[https://code.google.com/apis/console/].
 
 == Usage
 

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/gtranslate-two.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gtranslate-two}
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marcin Wyszynski"]
-  s.date = %q{2011-01-23}
+  s.date = %q{2011-02-23}
   s.description = %q{This is a super-simple Ruby client for Google Translate API v2. You will need the developer key to work with it.}
   s.email = %q{marcin.pixie@gmail.com}
   s.extra_rdoc_files = [
@@ -46,17 +46,20 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
+      s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
+    s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])

data/lib/glanguage.rb

@@ -1,4 +1,5 @@
 module GLanguage
+  
   Afrikaans	= 'af'
   Albanian = 'sq'
   Arabic = 'ar'
@@ -51,4 +52,18 @@ module GLanguage
   Vietnamese = 'vi'
   Welsh = 'cy'
   Yiddish = 'yi'
+  
+  # This method will look up a particular symbol and
+  # try to return a correspondind constant as a string
+  def self.lookup(symbol)
+    result = self.constants.select do |const|
+      eval("self::#{const}").eql?(symbol)
+    end
+    if result.empty?
+      raise NameError, "Looks like '#{symbol}' is not a symbol of a supported language"
+    else
+      result.to_s
+    end
+  end
+  
 end

data/lib/gtranslate-two.rb

@@ -1,27 +1,67 @@
 require File.join(File.dirname(__FILE__), 'gtranslatorresult')
 require File.join(File.dirname(__FILE__), 'glanguage')
-require 'rubygems'
-require 'open-uri'
 require 'json'
+require 'net/https'
+require 'uri'
 
 class GTranslator
   
   @@key = nil
   
-  def self.key; @@key; end
-  def self.key=(key); @@key = key; end
+  def self.key
+    @@key
+  end
+  
+  def self.key=(key)
+    @@key = key
+  end
   
-  def self.detect_language(query); translate(query, 'en').source; end
+  def self.detect_language(query)
+    translate(query, 'en').source
+  end
   
   def self.translate(query, target, source=nil)
+    
+    # Step 1a: make an array of required parameters to send to the Google Translate server
     options = { :q => query, :target => target, :key => @@key } 
+    
+    # Step 1b: Add the optional source parameter if it has been explicitly specified
     options[:source] = source if source
+    
+    # Step 1c: Serialize the hash for the POST request
     params = URI.escape(options.collect{|k,v| "#{k}=#{v}"}.join('&'))
-    url = "https://www.googleapis.com/language/translate/v2?#{params}"
-    result = JSON.parse(open(url).read)['data']['translations'].collect do |params|
-      GTranslatorResult.new(query, target, params, source)
+    
+    # Step 2a: Get the Google Translate host address
+    uri = URI.parse('https://www.googleapis.com/language/translate/v2')
+    
+    # Step 2b: Create a new HTTP client from the provided host address
+    http = Net::HTTP.new(uri.host, uri.port)
+    
+    # Step 2c: Force the HTTP client to use SSL and assign a proper certificate
+    http.use_ssl = true
+    http.ssl_timeout = 2
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    store = OpenSSL::X509::Store.new
+    store.set_default_paths
+    http.cert_store = store
+    
+    # Step 2d: Make an actual POST request and grab the response and it's body
+    response, body = http.post(uri.path, params, { 'X-HTTP-Method-Override' => 'GET' })
+    
+    # Step 3a: If the response indicates an HTTP OK code (200), parse the body as JSON
+    if response.is_a?(Net::HTTPOK)
+      # Step 3b: The JSON response has 1 or more 'translations' - out of each one...
+      result = JSON.parse(body)['data']['translations'].collect do |params|
+        #... create a new GTranslatorResult object
+        GTranslatorResult.new(query, target, params, source)
+      end
+      # Step 4a: If all went well, return the resulting GTranslatorResult or an array of those 
+      #          if more than one translation has been returned
+      return result.size == 1 ? result.first : result
+    else
+      # Step 4b: Otherwise, return the error response (generally, a Net::HTTPBadRequest)
+      response
     end
-    return result.size == 1 ? result.first : result
   end
-
+  
 end

data/test/test_gtranslate-two.rb

@@ -1,7 +1,99 @@
 require 'helper'
 
 class TestGtranslateTwo < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  
+  source = GLanguage::English
+  target = GLanguage::Danish
+  query = 'Hello world!'
+  expected_danish_translation = 'Hej Verden!'
+  correct_key = 'AIzaSyCb2FdHRnpzFMei4qYAD6AOwgjOAYS1ZlY'
+  
+  # Eliminating unexpected behaviors
+  
+  should 'frown on an incorrect language' do
+    assert_raise(NameError, 'Oh noes, you should not be able to translate from Klingon') do
+      target = GLanguage::Klingon
+    end
   end
+  
+  should 'not lookup an incorrect language' do
+    assert_raise(NameError, 'Oh noes, you should not be able to look up Klingon') do
+      result = GLanguage.lookup('kl')
+    end
+  end
+  
+  should 'not work with an incorrect key' do 
+    GTranslator.key = 'test_key'
+    result = GTranslator.translate(query, target, source)
+    assert_instance_of(Net::HTTPBadRequest, result, 'Oh noes, you can translate with an incorrect key')
+  end
+  
+  should 'not work no parameters' do
+    GTranslator.key = correct_key
+    assert_raise(ArgumentError, 'Oh noes, you should not be able to translate without parameters') do
+      result = GTranslator.translate()
+    end
+  end
+  
+  should 'not work just one parameter' do
+    GTranslator.key = correct_key
+    assert_raise(ArgumentError, 'Oh noes, you should not be able to translate without parameters') do
+      result = GTranslator.translate(query)
+    end
+  end
+  
+  should 'not work with a manually entered crazy language' do
+    GTranslator.key = correct_key
+    result = GTranslator.translate(query, 'kl')
+    assert_instance_of(Net::HTTPBadRequest, result, 'Oh noes, you could attempt to translate from an unsupported language')
+  end
+  
+  # Checking for expected behaviors
+  
+  should 'be able to set and return an API key' do
+    GTranslator.key = 'test_key'
+    assert_equal GTranslator.key, 'test_key', 'Oh noes, key saved incorrectly'
+  end
+  
+  should 'be able to return a translation with both source and target langauge provided' do
+    GTranslator.key = correct_key
+    result = GTranslator.translate(query, target, source)
+    assert(
+      result.is_a?(GTranslatorResult) || result.first.is_a?(GTranslatorResult), 
+      'Result is neither a GTranslatorResult nor an Array of those'
+    )
+  end
+  
+  should 'provide a correct translation with both source and target langauge provided' do
+    GTranslator.key = correct_key
+    result = GTranslator.translate(query, target, source)
+    assert_equal result.translation, expected_danish_translation, 'Oh noes, translation incorrect'
+  end
+  
+  should 'be able to return a translation with only the target langauge provided' do
+    GTranslator.key = correct_key
+    result = GTranslator.translate(query, target)
+    assert(
+      result.is_a?(GTranslatorResult) || result.first.is_a?(GTranslatorResult), 
+      'Result is neither a GTranslatorResult nor an Array of those'
+    )
+  end
+  
+  should 'provide a correct translation with only the target langauge provided' do
+    GTranslator.key = correct_key
+    result = GTranslator.translate(query, target)
+    assert_equal result.translation, expected_danish_translation, 'Oh noes, translation incorrect'
+  end
+  
+  should 'correctly detect a language' do
+    GTranslator.key = correct_key
+    result = GTranslator.detect_language(query)
+    assert_equal result, source, 'Oh noes, translation incorrect'
+  end
+  
+  should 'look up the language constant correctly' do
+    result = GLanguage.lookup(GLanguage::Danish)
+    assert_equal result, 'Danish', 'Oh noes, lookup failed'
+  end
+  
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gtranslate-two
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Marcin Wyszynski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-23 00:00:00 +00:00
+date: 2011-02-23 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,12 +28,26 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  name: shoulda
+  type: :runtime
+  name: json
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: shoulda
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,9 +61,9 @@ dependencies:
   type: :development
   name: bundler
   prerelease: false
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,9 +77,9 @@ dependencies:
   type: :development
   name: jeweler
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,7 +91,7 @@ dependencies:
   type: :development
   name: rcov
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id005
 description: This is a super-simple Ruby client for Google Translate API v2. You will need the developer key to work with it.
 email: marcin.pixie@gmail.com
 executables: []