caius-gtranslate 0.9.1

data/Changelog.md

@@ -0,0 +1,28 @@
+# GTranslate Changelog
+
+## v 0.9.0 (2009-02-15)
+
+Added String and Array extensions.
+
+## v 0.8.8 (2009-02-14)
+
+Added specs.
+Renamed to "gtranslate" for requiring purposes.
+
+## v 0.7.0 (2009-02-14)
+
+Converted into a rubygem.
+
+## v0.6.0 (2009-01-12)
+
+Added to_english using language detection (thanks to James Rose)
+
+## v0.5.0 (2009-01-04)
+
+Added lang_code to return the short code for a language.
+Added the ability to use en_to_fr instead of english_to_french
+Updated Examples accordingly.
+
+## v0.4.0 (2009-01-04)
+
+Initial Release

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('gtranslate', '0.9.1') do | config | 
+  config.description = <<-EOF
+    GTranslate uses the Google translate API to translate a phrase from one language to another.
+  EOF
+  config.summary = "Translates a phrase from one language to another"
+  config.url = 'http://github.com/caius/gtranslate'
+  config.author = 'Caius Durling'
+  config.email = 'dev@caius.name'
+  config.ignore_pattern = ['tmp/*', 'script/*']
+  config.development_dependencies = ["httparty"]
+  
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each do | rake_file | 
+  load rake_file
+end

data/Readme.md

@@ -0,0 +1,39 @@
+# GTranslate
+
+Library that wraps the Google Translate API. Translates a phrase from one language to another.
+
+
+## Install
+
+  gem install caius-gtranslate --source http://gems.github.com
+
+
+## Usage
+
+Fairly simple to use. Run `rake doc` for full examples.
+
+	Google::Translate.english_to_french( "Hello" ) # => "Bonjour"
+
+You can use language detection too:
+
+	Google::Translate.to_english( "Bonjour" ) # => "Hello"
+
+You can replace `Translate` with `Tr` for brevity as well
+
+  Google::Tr.english_to_french( "Hello" ) # => "Bonjour"
+
+
+## Licence
+
+Licenced under the MIT Licence
+
+Copyright (c) 2008 Caius Durling  
+Portions Copyright (c) 2008 James Rose
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+See <http://www.caius.name/> for contact details.  

data/bin/gtranslate

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# 
+# Translates a phrase into another language
+# 
+
+=begin
+  
+  `gtranslate french "Hello"` # => "Bonjour"
+  `gtranslate fr Hello # => "Bonjour"
+  
+=end
+require "rubygems"
+require "gtranslate"
+
+def usage
+  puts "USAGE: gtranslate <language_to> <phrase>"
+end
+
+if ARGV.size != 2
+  usage
+  exit!
+end
+
+to, phrase = ARGV
+
+unless Google::Translate.valid_lang?(to)
+  usage
+  exit!
+end
+
+puts "Translating '#{phrase}' to #{to}"
+puts Google::Translate.send("to_#{to}".to_sym, phrase)

data/data/languages.yml

@@ -0,0 +1,173 @@
+# Languages available for translation
+--- 
+:swedish: sv
+:cs: cs
+:mongolian: mn
+:icelandic: is
+:uighur: ug
+:ru: ru
+:ky: ky
+:gl: gl
+:bn: bn
+:tg: tg
+:afrikaans: af
+:ne: ne
+:inuktitut: iu
+:dhivehi: dv
+:serbian: sr
+:german: de
+:bulgarian: bg
+:latvian: lv
+:tagalog: tl
+:oriya: or
+:it: it
+:nl: nl
+:sq: sq
+:sd: sd
+:lt: lt
+:el: el
+:my: my
+:thai: th
+:ps: ps
+:esperanto: eo
+:arabic: ar
+:kannada: kn
+:id: id
+:slovak: sk
+:malay: ms
+:gujarati: gu
+:cherokee: chr
+:bo: bo
+:polish: pl
+:kk: kk
+:et: et
+:hy: hy
+:sl: sl
+:chinese_simplified: zh-CN
+:ml: ml
+:iw: iw
+:uk: uk
+:punjabi: pa
+:korean: ko
+:finnish: fi
+:basque: eu
+:swahili: sw
+:marathi: mr
+:hungarian: hu
+:hr: hr
+:uzbek: uz
+:ro: ro
+:be: be
+:ku: ku
+:fr: fr
+:sv: sv
+:is: is
+:danish: da
+:mn: mn
+:ug: ug
+:sanskrit: sa
+:laothian: lo
+:georgian: ka
+:bihari: bh
+:tamil: ta
+:norwegian: "no"
+:dv: dv
+:af: af
+:iu: iu
+:sr: sr
+:lv: lv
+:de: de
+:bg: bg
+:telugu: te
+:or: or
+:japanese: ja
+:english: en
+:amharic: am
+:sinhalese: si
+:catalan: ca
+:macedonian: mk
+:guarani: gn
+:th: th
+:persian: fa
+:kn: kn
+:eo: eo
+:ar: ar
+:sk: sk
+:ms: ms
+:gu: gu
+:chinese: zh
+:turkish: tr
+:pl: pl
+:azerbaijani: az
+:khmer: km
+:filipino: tl
+:spanish: es
+:hindi: hi
+:chinese_traditional: zh-TW
+:maltese: mt
+:urdu: ur
+:pa: pa
+:ko: ko
+:fi: fi
+:eu: eu
+:sw: sw
+:mr: mr
+:hu: hu
+:czech: cs
+:uz: uz
+:russian: ru
+:galician: gl
+:bengali: bn
+:kyrgyz: ky
+:tajik: tg
+:nepali: ne
+:indonesian: id
+:da: da
+:vietnamese: vi
+:sa: sa
+:bh: bh
+:lo: lo
+:ka: ka
+:ta: ta
+:no: "no"
+:italian: it
+:dutch: nl
+:albanian: sq
+:tr: tr
+:sindhi: sd
+:lithuanian: lt
+:greek: el
+:burmese: my
+:te: te
+:pashto: ps
+:am: am
+:ja: ja
+:en: en
+:si: si
+:gn: gn
+:ca: ca
+:mk: mk
+:tibetan: bo
+:fa: fa
+:kazakh: kk
+:estonian: et
+:armenian: hy
+:slovenian: sl
+:malayalam: ml
+:hebrew: iw
+:zh: zh
+:ukrainian: uk
+:portuguese: pt-PT
+:tl: tl
+:az: az
+:km: km
+:es: es
+:mt: mt
+:hi: hi
+:croatian: hr
+:ur: ur
+:romanian: ro
+:kurdish: ku
+:french: fr
+:chr: chr
+:belarusian: be

data/gtranslate.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gtranslate}
+  s.version = "0.9.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Caius Durling"]
+  s.date = %q{2009-02-15}
+  s.default_executable = %q{gtranslate}
+  s.description = %q{GTranslate uses the Google translate API to translate a phrase from one language to another.}
+  s.email = %q{dev@caius.name}
+  s.executables = ["gtranslate"]
+  s.extra_rdoc_files = ["bin/gtranslate", "lib/gtranslate/exceptions.rb", "lib/gtranslate/gtranslate.rb", "lib/gtranslate/mixins.rb", "lib/gtranslate.rb", "tasks/rspec.rake"]
+  s.files = ["bin/gtranslate", "Changelog.md", "data/languages.yml", "lib/gtranslate/exceptions.rb", "lib/gtranslate/gtranslate.rb", "lib/gtranslate/mixins.rb", "lib/gtranslate.rb", "Manifest", "Rakefile", "Readme.md", "spec/array_mixin_spec.rb", "spec/gtranslate_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/string_mixin_spec.rb", "tasks/rspec.rake", "gtranslate.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/caius/gtranslate}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Gtranslate", "--main", "Readme.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{gtranslate}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Translates a phrase from one language to another}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<httparty>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+end

data/lib/gtranslate.rb

@@ -0,0 +1,17 @@
+GEM_ROOT = File.expand_path(File.dirname(__FILE__) + "/../") unless Kernel.const_defined?(:GEM_ROOT)
+
+require "yaml"
+require "rubygems"
+begin
+  require "httparty"
+rescue LoadError => e
+  puts "You need to install the '#{e.message.scan(/-- (.*)$/).flatten.first}' gem."
+  exit!
+end
+
+
+require GEM_ROOT + "/lib/gtranslate/gtranslate"
+require GEM_ROOT + "/lib/gtranslate/exceptions"
+
+module Google
+end

data/lib/gtranslate/exceptions.rb

@@ -0,0 +1,14 @@
+module Google
+  module Translate
+
+    class NoPhrasePassed < Exception
+    end
+    
+    class InvalidLanguage < Exception
+    end
+    
+    class LanguageDetectionFailed < Exception
+    end
+
+  end
+end

data/lib/gtranslate/gtranslate.rb

@@ -0,0 +1,70 @@
+module Google
+  # 
+  # Call a method of the following type:
+  #   {language from}_to_{language to}
+  # 
+  # Or to have the language from automagically detected:
+  #   to_{language to}
+  # 
+  # Eg:
+  #   english_to_french
+  #   to_french
+  # 
+  module Translate
+    # Loads the lanuages in from a data file
+    LANGS = YAML.load_file(GEM_ROOT + "/data/languages.yml")
+
+    # Setup HTTParty stuff
+    include HTTParty
+    base_uri "http://ajax.googleapis.com/ajax/services/language/translate"
+    default_params :v => "1.0", :hl => "en"
+    format :json
+    
+    # Does the magic to figure out if its a valid call or not
+    def self.method_missing(method, *args)
+      # TODO: cache methods once they are called once
+      if find = method.to_s.match(/(\w+?)?_?to_(\w+)/)
+        # Grab the captures
+        langs = find.captures
+        
+        # Figure out if each language is a valid one
+        # if the first one is nil, let it pass
+        langs.each_with_index do |lang, i|
+          raise InvalidLanguage, "#{lang}" unless (lang.nil? && i == 0) || valid_lang?(lang)
+        end
+        
+        # Make sure the phrase is passed in
+        raise NoPhrasePassed, "Pass a phrase to translate" if args.nil? || args.blank? || args.first.empty?
+        
+        # Figure out what the from language should be
+        from = (langs.first.nil? ? "" : LANGS[langs.first])
+                
+        # And fetch/return the actual translation!
+        get_translation :from => from, :to => LANGS[langs.last.to_sym], :phrase => args.first
+      else
+        super
+      end
+    end
+    
+    # Takes a string or symbol and returns BOOL
+    def self.valid_lang? lang
+      LANGS.key? lang.to_sym
+    end
+
+    # Returns the short code for the language name
+    def self.lang_code lang
+      LANGS[lang.to_sym]
+    end
+    
+    private
+
+    # Actually does the heavy lifting
+    def self.get_translation opts = {}
+      lang_pair = {:langpair => "#{opts[:from]}|#{opts[:to]}"}
+      get('', :query => {:q => opts[:phrase]}.merge(lang_pair))["responseData"]["translatedText"]
+    end
+  end
+  
+  # And add Tr for anyone lazy
+  const_set "Tr", Translate
+end

data/lib/gtranslate/mixins.rb

@@ -0,0 +1,36 @@
+module Google
+  module Translate
+    
+    # Extends String to add to_* and *_to_*
+    module StringMixin
+      def method_missing(method, *args)
+        if method.to_s[/^((?:\w+)?to_\w+)$/]
+          Google::Tr.send($1.to_sym, self)
+        else
+          super
+        end
+      end
+    end
+    
+    # Extends array to add to_* and *_to_*
+    module ArrayMixin
+      def method_missing(method, *args)
+        if method.to_s[/^((?:\w+)?to_\w+)$/]
+          self.map do |element|
+            if element.is_a?(Array)
+              element.send($1)
+            else
+              Google::Tr.send($1.downcase.to_sym, element)
+            end
+          end
+        else
+          super
+        end
+      end
+    end
+
+  end
+end
+
+String.send(:include, Google::Translate::StringMixin)
+Array.send(:include, Google::Translate::ArrayMixin)

data/spec/array_mixin_spec.rb

@@ -0,0 +1,135 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__) + "/../lib/gtranslate/mixins")
+
+describe Google::Translate do
+
+  describe "array mixin" do
+        
+    it "should translate from a single level array using to_french" do
+      r = ["Hello", "Goodbye"].to_french
+
+      r.should have(2).elements
+      r.first.should == "Bonjour"
+      r.last.should == "Au revoir"
+    end
+
+    it "should translate from a multi level array using to_french" do
+      r = ["Yes", ["Hello", "Hi"], ["Goodbye", "Bye"]].to_french
+
+      r.should have(3).elements
+      r.first.should == "Oui"
+
+      r[1].should have(2).elements
+      r[1].should == ["Bonjour", "Salut"]
+
+      r.last.should have(2).elements
+      r.last.should == ["Au revoir", "Au revoir"]
+    end
+
+    it "should translate from a single level array using to_fr" do
+      r = ["Hello", "Goodbye"].to_fr
+
+      r.should have(2).elements
+      r.first.should == "Bonjour"
+      r.last.should == "Au revoir"
+    end
+
+    it "should translate from a multi level array using to_fr" do
+      r = ["Yes", ["Hello", "Hi"], ["Goodbye", "Bye"]].to_fr
+
+      r.should have(3).elements
+      r.first.should == "Oui"
+
+      r[1].should have(2).elements
+      r[1].should == ["Bonjour", "Salut"]
+
+      r.last.should have(2).elements
+      r.last.should == ["Au revoir", "Au revoir"]
+    end
+
+    it "should translate from a single level array using english_to_french" do
+      r = ["Hello", "Goodbye"].english_to_french
+
+      r.should have(2).elements
+      r.first.should == "Bonjour"
+      r.last.should == "Au revoir"
+    end
+
+    it "should translate from a multi level array using english_to_french" do
+      r = ["Yes", ["Hello", "Hi"], ["Goodbye", "Bye"]].english_to_french
+
+      r.should have(3).elements
+      r.first.should == "Oui"
+
+      r[1].should have(2).elements
+      r[1].should == ["Bonjour", "Salut"]
+
+      r.last.should have(2).elements
+      r.last.should == ["Au revoir", "Au revoir"]
+    end
+
+    it "should translate from a single level array using english_to_fr" do
+      r = ["Hello", "Goodbye"].english_to_fr
+
+      r.should have(2).elements
+      r.first.should == "Bonjour"
+      r.last.should == "Au revoir"
+    end
+
+    it "should translate from a multi level array using english_to_fr" do
+      r = ["Yes", ["Hello", "Hi"], ["Goodbye", "Bye"]].english_to_fr
+
+      r.should have(3).elements
+      r.first.should == "Oui"
+
+      r[1].should have(2).elements
+      r[1].should == ["Bonjour", "Salut"]
+
+      r.last.should have(2).elements
+      r.last.should == ["Au revoir", "Au revoir"]
+    end
+
+    it "should translate from a single level array using en_to_french" do
+      r = ["Hello", "Goodbye"].en_to_french
+
+      r.should have(2).elements
+      r.first.should == "Bonjour"
+      r.last.should == "Au revoir"
+    end
+
+    it "should translate from a multi level array using en_to_french" do
+      r = ["Yes", ["Hello", "Hi"], ["Goodbye", "Bye"]].en_to_french
+
+      r.should have(3).elements
+      r.first.should == "Oui"
+
+      r[1].should have(2).elements
+      r[1].should == ["Bonjour", "Salut"]
+
+      r.last.should have(2).elements
+      r.last.should == ["Au revoir", "Au revoir"]
+    end
+
+    it "should translate from a single level array using en_to_fr" do
+      r = ["Hello", "Goodbye"].en_to_fr
+
+      r.should have(2).elements
+      r.first.should == "Bonjour"
+      r.last.should == "Au revoir"
+    end
+
+    it "should translate from a multi level array using en_to_fr" do
+      r = ["Yes", ["Hello", "Hi"], ["Goodbye", "Bye"]].en_to_fr
+
+      r.should have(3).elements
+      r.first.should == "Oui"
+
+      r[1].should have(2).elements
+      r[1].should == ["Bonjour", "Salut"]
+
+      r.last.should have(2).elements
+      r.last.should == ["Au revoir", "Au revoir"]
+    end
+
+  end
+end

data/spec/gtranslate_spec.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__) + "/spec_helper")
+
+describe Google::Translate do
+  
+  before(:each) do
+    @gt = Google::Translate
+  end
+  
+  it "should return a string" do
+    expect_to_make_get_request
+    r = @gt.to_french("Hello")
+    
+    r.should be_a_kind_of(String)
+    r.should == "translated phrase"
+  end
+    
+  it "should raise when no phrase passed" do
+    lambda {
+      @gt.english_to_french
+    }.should raise_error(Google::Translate::NoPhrasePassed)
+  end
+  
+  it "should raise with invalid from language passed" do
+    lambda {
+      @gt.klingon_to_english("Hello")
+    }.should raise_error(Google::Translate::InvalidLanguage)
+  end
+  
+  def expect_to_make_get_request
+    @gt.should_receive(:get_translation).and_return("translated phrase")
+  end  
+end
+
+describe Google::Tr do
+  it "should match Google::Translate" do
+    Google::Tr.should == Google::Translate
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__) + "/../lib/gtranslate")

data/spec/string_mixin_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__) + "/../lib/gtranslate/mixins")
+
+describe Google::Translate do
+  
+  describe "string mixin" do
+    it "should translate from a string using to_french" do
+      r = "Hello".to_french
+      
+      r.should be_a_kind_of(String)
+      r.should == "Bonjour"
+    end
+    
+    it "should translate from a string using to_fr" do
+      r = "Hello".to_fr
+      
+      r.should be_a_kind_of(String)
+      r.should == "Bonjour"
+    end
+    
+    it "should translate from a string using english_to_french" do
+      r = "Hello".english_to_french
+      
+      r.should be_a_kind_of(String)
+      r.should == "Bonjour"
+    end
+
+    it "should translate from a string using english_to_fr" do
+      r = "Hello".english_to_fr
+
+      r.should be_a_kind_of(String)
+      r.should == "Bonjour"
+    end
+
+   it "should translate from a string using en_to_french" do
+      r = "Hello".en_to_french
+      
+      r.should be_a_kind_of(String)
+      r.should == "Bonjour"
+    end
+    
+   it "should translate from a string using en_to_fr" do
+      r = "Hello".en_to_fr
+      
+      r.should be_a_kind_of(String)
+      r.should == "Bonjour"
+    end    
+  end
+  
+end

data/tasks/rspec.rake

@@ -0,0 +1,24 @@
+# Borrowed from http://github.com/rsim/ruby-plsql/tree/master/tasks/rspec.rake
+# Github++
+begin
+  require "spec"
+rescue LoadError
+  require "rubygems"
+  require "spec"
+end
+
+begin
+  require "spec/rake/spectask"
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+  [sudo] gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/*"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ["--options", "spec/spec.opts"]
+  t.spec_files = FileList["spec/*_spec.rb"]
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: caius-gtranslate
+version: !ruby/object:Gem::Version 
+  version: 0.9.1
+platform: ruby
+authors: 
+- Caius Durling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-15 00:00:00 -08:00
+default_executable: gtranslate
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: GTranslate uses the Google translate API to translate a phrase from one language to another.
+email: dev@caius.name
+executables: 
+- gtranslate
+extensions: []
+
+extra_rdoc_files: 
+- bin/gtranslate
+- lib/gtranslate/exceptions.rb
+- lib/gtranslate/gtranslate.rb
+- lib/gtranslate/mixins.rb
+- lib/gtranslate.rb
+- tasks/rspec.rake
+files: 
+- bin/gtranslate
+- Changelog.md
+- data/languages.yml
+- lib/gtranslate/exceptions.rb
+- lib/gtranslate/gtranslate.rb
+- lib/gtranslate/mixins.rb
+- lib/gtranslate.rb
+- Manifest
+- Rakefile
+- Readme.md
+- spec/array_mixin_spec.rb
+- spec/gtranslate_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/string_mixin_spec.rb
+- tasks/rspec.rake
+- gtranslate.gemspec
+has_rdoc: true
+homepage: http://github.com/caius/gtranslate
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Gtranslate
+- --main
+- Readme.md
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: gtranslate
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Translates a phrase from one language to another
+test_files: []
+