to_lang 0.0.1 → 0.1.0

data/.gitignore

@@ -1,3 +1,5 @@
 pkg/*
 *.gem
 .bundle
+Gemfile.lock
+coverage/*

data/README.textile

@@ -1,14 +1,14 @@
 h1. to_lang
 
-*to_lang* is a Ruby gem that uses the Google Translate API to allow you to perform a translation directly on a string.
+*to_lang* is a Ruby library that adds language translation methods to strings, backed by the Google Translate API.
 
-h2. Usage
+h2. Installation
+
+Simply run @gem install to_lang@.
 
-To use *to_lang*, require the library, then call @ToLang.start@ with your Google Translate API key to initialize the connector and include the methods in @String@. Then you have access to @String#translate@.
+h2. Usage
 
-bq. *translate(to, *options)*
-_to_ (required): a string indicating the language to translate to, e.g. "es"
-_options[:from]_ (optional): a string indicating the language of the original string, used when automatic language detection is not accurate
+To use *to_lang*, require the library, then call @ToLang.start@ with your Google Translate API key. At this point you will have access to all the new translation methods, which take the form @to_language@, where "language" is the language you wish to translate to. Google Translate attempts to detect the source language, but you can specify it explicitly by calling methods in the form @to_language_from_source_language@, where "source_language" is the source language. These methods are generated dynamically and will not appear in a call to @String.new.methods@ until they have been called once. Strings will, however, @respond_to?@ these methods prior to their dynamic definition.
 
 h2. Examples
 
@@ -19,21 +19,79 @@ ToLang.start('YOUR_GOOGLE_TRANSLATE_API_KEY')
 
 Translate some text to Spanish:
 
-bq. "Very cool gem!".translate('es')
-# "Muy fresco joya!"
+bq. "Very cool gem!".to_spanish
+=> "Muy fresco joya!"
+
+A case where the source language is ambiguous:
+
+bq. "a pie".to_spanish
+=> "a pie"
+"a pie".to_spanish_from_english
+=> "un pastel"
+
+h2. Supported Languages
 
-If the source string is of an ambiguous language, the translation might not work as expected. In this case, you can specify the source language explicitly with the @:from@ option:
+*to_lang* adds the following methods to strings. Each of these methods can be called with an explicit source language by appending @_to_source_language@ to the method name.
 
-bq. "a pie".translate('es')
-# "a pie"
-"a pie".translate('es', :from => 'en')
-# "un pastel"
+* to_afrikaans
+* to_albanian
+* to_arabic
+* to_basque
+* to_belarusian
+* to_bulgarian
+* to_catalan
+* to_simplified_chinese
+* to_traditional_chinese
+* to_croatian
+* to_czech
+* to_danish
+* to_dutch
+* to_english
+* to_estonian
+* to_filipino
+* to_finnish
+* to_french
+* to_galician
+* to_german
+* to_greek
+* to_haitian_creole
+* to_hebrew
+* to_hindi
+* to_hungarian
+* to_icelandic
+* to_indonesian
+* to_irish
+* to_italian
+* to_japanese
+* to_latvian
+* to_lithuanian
+* to_macedonian
+* to_malay
+* to_maltese
+* to_norwegian
+* to_persian
+* to_polish
+* to_portuguese
+* to_romanian
+* to_russian
+* to_serbian
+* to_slovak
+* to_slovenian
+* to_spanish
+* to_swahili
+* to_swedish
+* to_thai
+* to_turkish
+* to_ukrainian
+* to_vietnamese
+* to_welsh
+* to_yiddish
 
 h2. Roadmap
 
-- Add tests for current code. *to_lang* is in its infancy so use at your own risk.
-- Add automagic sugar methods for translating to specific languages, such as @to_spanish@ and @to_spanish_from_english@
+- Add complete documentation for the library.
+- Add Unicode support for Ruby 1.8. *to_lang* currently works safely only under 1.9.
 
 h2. Feedback and Contributions
 
-Feedback is appreciated, as are patch contributions. Feel free to fork the project and send me a pull request.
+Feedback is greatly appreciated, as are patch contributions. Feel free to fork the project and send me a pull request.

data/Rakefile

@@ -1,2 +1,7 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/to_lang/codemap.rb

@@ -0,0 +1,57 @@
+module ToLang
+  CODEMAP = {
+    'afrikaans' => 'af',
+    'albanian' => 'sq',
+    'arabic' => 'ar',
+    'basque' => 'eu',
+    'belarusian' => 'be',
+    'bulgarian' => 'bg',
+    'catalan' => 'ca',
+    'simplified_chinese' => 'zh-CN',
+    'traditional_chinese' => 'zh-TW',
+    'croatian' => 'hr',
+    'czech' => 'cs',
+    'danish' => 'da',
+    'dutch' => 'nl',
+    'english' => 'en',
+    'estonian' => 'et',
+    'filipino' => 'tl',
+    'finnish' => 'fi',
+    'french' => 'fr',
+    'galician' => 'gl',
+    'german' => 'de',
+    'greek' => 'el',
+    'haitian_creole' => 'ht',
+    'hebrew' => 'iw',
+    'hindi' => 'hi',
+    'hungarian' => 'hu',
+    'icelandic' => 'is',
+    'indonesian' => 'id',
+    'irish' => 'ga',
+    'italian' => 'it',
+    'japanese' => 'ja',
+    'latvian' => 'lv',
+    'lithuanian' => 'lt',
+    'macedonian' => 'mk',
+    'malay' => 'ms',
+    'maltese' => 'mt',
+    'norwegian' => 'no',
+    'persian' => 'fa',
+    'polish' => 'pl',
+    'portuguese' => 'pt',
+    'romanian' => 'ro',
+    'russian' => 'ru',
+    'serbian' => 'sr',
+    'slovak' => 'sk',
+    'slovenian' => 'sl',
+    'spanish' => 'es',
+    'swahili' => 'sw',
+    'swedish' => 'sv',
+    'thai' => 'th',
+    'turkish' => 'tr',
+    'ukrainian' => 'uk',
+    'vietnamese' => 'vi',
+    'welsh' => 'cy',
+    'yiddish' => 'yi',
+  }
+end

data/lib/to_lang/connector.rb

@@ -1,10 +1,9 @@
+require 'rubygems'
 require 'httparty'
 require 'uri'
 
 module ToLang
   class Connector
-    include HTTParty
-
     API_URL = "https://www.googleapis.com/language/translate/v2"
 
     attr_reader :key
@@ -13,27 +12,19 @@ module ToLang
       @key = key
     end
 
-    def request(q, target, *args)
-      response = self.class.get request_url(q, target, *args)
+    def request(q, target, options = {})
+      response = HTTParty.get request_url(q, target, options)
+      raise response.parsed_response["error"]["message"] if response.parsed_response["error"] && response.parsed_response["error"]["message"]
       response.parsed_response["data"]["translations"][0]["translatedText"]
     end
 
     private
 
-    def request_url(q, target, *args)
-      options = extract_options(*args)
+    def request_url(q, target, options)
       source = options[:from]
       url = "#{API_URL}?key=#{@key}&q=#{URI.escape(q)}&target=#{target}"
       url += "&source=#{source}" if source
       url
     end
-
-    def extract_options(*args)
-      if args.last.is_a? Hash
-        args.pop
-      else
-        {}
-      end
-    end
   end
 end

data/lib/to_lang/version.rb

@@ -1,3 +1,3 @@
 module ToLang
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/to_lang.rb

@@ -1,17 +1,58 @@
+require File.expand_path("../to_lang/codemap", __FILE__)
 require File.expand_path("../to_lang/connector", __FILE__)
 
 module ToLang
-  def self.start(key)
-    @@connector = ToLang::Connector.new(key)
+  class << self
+    attr_reader :connector
 
-    String.send(:include, InstanceMethods)
-  end
+    def start(key)
+      return false if defined?(@connector) && !@connector.nil?
+      @connector = ToLang::Connector.new(key)
+      String.send(:include, StringMethods)
+      add_magic_methods
+      true
+    end
+
+    private
+
+    def add_magic_methods
+      String.class_eval do
+        def method_missing(method, *args, &block)
+          if method.to_s =~ /^to_(.*)_from_(.*)$/ && CODEMAP[$1] && CODEMAP[$2]
+            new_method_name = "to_#{$1}_from_#{$2}".to_sym
+
+            self.class.send(:define_method, new_method_name, Proc.new {
+              translate(CODEMAP[$1], :from => CODEMAP[$2])
+            })
 
-  def self.connector
-    @@connector
+            send new_method_name
+          elsif method.to_s =~ /^to_(.*)$/ && CODEMAP[$1]
+            new_method_name = "to_#{$1}".to_sym
+
+            self.class.send(:define_method, new_method_name, Proc.new {
+              translate(CODEMAP[$1])
+            })
+
+            send new_method_name
+          else
+            super
+          end
+        end
+
+        def respond_to?(method, include_private = false)
+          if method.to_s =~ /^to_(.*)_from_(.*)$/ && CODEMAP[$1] && CODEMAP[$2]
+            true
+          elsif method.to_s =~ /^to_(.*)$/ && CODEMAP[$1]
+            true
+          else
+            super
+          end
+        end
+      end
+    end
   end
 
-  module InstanceMethods
+  module StringMethods
     def translate(target, *args)
       ToLang.connector.request(self, target, *args)
     end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+require File.expand_path('../../lib/to_lang', __FILE__)

data/spec/to_lang/connector_spec.rb

@@ -0,0 +1,58 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe ToLang::Connector do
+  before :all do
+    @connector = ToLang::Connector.new('apikey')
+  end
+
+  it "stores a key when initialized" do
+    @connector.key.should_not be_nil
+  end
+
+  context "when sent :request" do
+    def stub_response(parsed_response)
+      mock_response = mock('HTTParty::Response', :parsed_response => parsed_response)
+      HTTParty.stub(:get).and_return(mock_response)
+    end
+
+    def stub_good_response(translated_text)
+      parsed_response = { "data" => { "translations" => [ { "translatedText" => translated_text } ] } }
+      stub_response(parsed_response)
+    end
+
+    def stub_bad_response(error_message)
+      parsed_response = { "error" => { "message" => error_message } }
+      stub_response(parsed_response)
+    end
+
+    context "with only a target language" do
+      it "returns the translated string" do
+        stub_good_response "hola mundo"
+        @connector.request("hello world", "es").should == "hola mundo"
+      end
+    end
+
+    context "with an ambiguous source language" do
+      context "and no source language specified" do
+        it "returns the same string" do
+          stub_good_response "a pie"
+          @connector.request("a pie", "es").should == "a pie"
+        end
+      end
+
+      context "and a source language specified" do
+        it "returns the translated string" do
+          stub_good_response "un pastel"
+          @connector.request("a pie", "es", :from => "en").should == "un pastel"
+        end
+      end
+    end
+
+    context "with a bad language pair" do
+      it "raises an exception" do
+        stub_bad_response "Bad language pair: en|en"
+        expect { @connector.request("a pie", "en", :from => "en") }.to raise_error(RuntimeError, "Bad language pair: en|en")
+      end
+    end
+  end
+end

data/spec/to_lang_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe ToLang do
+  context "when sent :start" do
+    before :all do
+      ToLang.start('apikey')
+    end
+
+    it "returns false if :start was already called" do
+      ToLang.start('apikey').should == false
+    end
+
+    it "stores a ToLang::Connector object" do
+      ToLang.connector.should be_an_instance_of ToLang::Connector
+    end
+
+    it "mixes StringMethods into String" do
+      String.should include ToLang::StringMethods
+    end
+  end
+end
+
+describe "A string" do
+  context "after ToLang has received :start" do
+    before :all do
+      ToLang.start('apikey')
+    end
+
+    it "responds to :translate" do
+      String.new.should respond_to :translate
+    end
+
+    context "when sent :translate" do
+      it "calls ToLang::Connector#request" do
+        ToLang.connector.stub(:request)
+        ToLang.connector.should_receive(:request).with("hello world", "es")
+        "hello world".translate("es")
+      end
+    end
+
+    ToLang::CODEMAP.each do |language, code|
+      it "will respond_to :to_#{language}" do
+        "hello_world".should respond_to "to_#{language}"
+      end
+
+      it "will respond to :to_#{language}_from_english" do
+        "hello_world".should respond_to "to_#{language}_from_english"
+      end
+
+      it "translates to #{language} when sent :to_#{language}" do
+        ToLang.connector.stub(:request)
+        ToLang.connector.should_receive(:request).with("hello world", code)
+        "hello world".send("to_#{language}")
+      end
+
+      it "translates to #{language} from english when sent :to_#{language}_from_english" do
+        ToLang.connector.stub(:request)
+        ToLang.connector.should_receive(:request).with("hello world", code, :from => 'en')
+        "hello world".send("to_#{language}_from_english")
+      end
+    end
+
+    context "when a magic method has been called once" do
+      before :each do
+        ToLang.connector.stub(:request)
+        "hello world".to_spanish
+        "hello world".to_spanish_from_english
+      end
+
+      it "defines the method and does not call :method_missing the next time" do
+        string = "hello world"
+        string.should_not_receive(:method_missing)
+        string.to_spanish
+        string.to_spanish_from_english
+      end
+    end
+  end
+end

data/to_lang.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "to_lang/version"
+require File.expand_path("../lib/to_lang/version", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "to_lang"
@@ -8,16 +7,16 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Jimmy Cuadra"]
   s.email       = ["jimmy@jimmycuadra.com"]
-  s.homepage    = "http://github.com/jimmycuadra/to_lang"
-  s.summary     = %q{A Ruby client for the Google Translate API built directly into String}
-  s.description = %q{A Ruby client for the Google Translate API built directly into String}
-
-  s.rubyforge_project = "to_lang"
-
+  s.homepage    = "https://github.com/jimmycuadra/to_lang"
+  s.summary     = %q{Adds language translation methods to strings, backed by the Google Translate API}
+  s.description = %q{Adds language translation methods to strings, backed by the Google Translate API}
+  s.rubyforge_project = s.name
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "httparty", "~> 0.6.1"
+  s.add_dependency "httparty", "~> 0.6"
+  s.add_development_dependency "rspec", "~> 2.3"
+  s.add_development_dependency "simplecov", "~> 0.3"
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: to_lang
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jimmy Cuadra
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-02 00:00:00 -08:00
+date: 2010-12-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,15 +25,41 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 0
         - 6
-        - 1
-        version: 0.6.1
+        version: "0.6"
   type: :runtime
   version_requirements: *id001
-description: A Ruby client for the Google Translate API built directly into String
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  type: :development
+  version_requirements: *id003
+description: Adds language translation methods to strings, backed by the Google Translate API
 email: 
 - jimmy@jimmycuadra.com
 executables: []
@@ -46,15 +71,18 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - README.textile
 - Rakefile
 - lib/to_lang.rb
+- lib/to_lang/codemap.rb
 - lib/to_lang/connector.rb
 - lib/to_lang/version.rb
+- spec/spec_helper.rb
+- spec/to_lang/connector_spec.rb
+- spec/to_lang_spec.rb
 - to_lang.gemspec
 has_rdoc: true
-homepage: http://github.com/jimmycuadra/to_lang
+homepage: https://github.com/jimmycuadra/to_lang
 licenses: []
 
 post_install_message: 
@@ -67,7 +95,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -76,7 +103,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -86,6 +112,8 @@ rubyforge_project: to_lang
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A Ruby client for the Google Translate API built directly into String
-test_files: []
-
+summary: Adds language translation methods to strings, backed by the Google Translate API
+test_files: 
+- spec/spec_helper.rb
+- spec/to_lang/connector_spec.rb
+- spec/to_lang_spec.rb

data/Gemfile.lock

@@ -1,19 +0,0 @@
-PATH
-  remote: .
-  specs:
-    to_lang (0.0.1)
-      httparty (~> 0.6.1)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    crack (0.1.8)
-    httparty (0.6.1)
-      crack (= 0.1.8)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  httparty (~> 0.6.1)
-  to_lang!