google_translate_scraper 0.1.1 → 1.0.0

data/README.md

@@ -12,7 +12,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -22,11 +22,11 @@ Or install it yourself as:
 
 1- require 'google_translate_scraper'
 
-2- translator = GoogleTranslateScraper::Translator.new
+2- response = GoogleTranslateScraper.translate(:source_language => 'en', :target_language => 'sv', :search_text => 'hey')
 
-3- translations = translations = translator.translate( source_language  = "en", target_language = "sv", search_phrase = "sup fool" ) 
+3- response.translations.first
 
-NOTE: source and target language values must be a string containg the ISO 639-1 letter code for that language. For a list see here: http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
+NOTE: source and target language values must be a string containg the ISO 639-1 two letter code for that language. For a list see here: http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
 
 ## Contributing
 

data/lib/google_translate_scraper.rb

@@ -1,6 +1,12 @@
 require "google_translate_scraper/version"
-require "google_translate_scraper/translator"
+require "google_translate_scraper/models/translator"
+require "google_translate_scraper/models/error"
+require "google_translate_scraper/models/translation"
+require "google_translate_scraper/models/response"
 
 module GoogleTranslateScraper
-  # Your code goes here...
+
+  def self.translate args
+    Models::Translator.new(args).translate
+  end
 end

data/lib/google_translate_scraper/models/error.rb

@@ -0,0 +1,17 @@
+module GoogleTranslateScraper
+  module Models
+
+    class Error
+
+      attr_accessor :message
+
+      def initialize(arguments = {})
+        arguments.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/google_translate_scraper/models/response.rb

@@ -0,0 +1,14 @@
+module GoogleTranslateScraper
+  module Models
+
+    class Response
+
+      attr_accessor :errors, :translations
+
+      def initialize
+        @errors = []
+        @translations = []
+      end
+    end
+  end
+end

data/lib/google_translate_scraper/models/translation.rb

@@ -0,0 +1,15 @@
+module GoogleTranslateScraper
+  module Models
+
+    class Translation
+
+      attr_accessor :source_language, :target_language, :search_text, :translated_text
+
+      def initialize(arguments = {})
+        arguments.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+  end
+end

data/lib/google_translate_scraper/models/translator.rb

@@ -0,0 +1,96 @@
+module GoogleTranslateScraper
+  module Models
+    require 'net/http'
+    require 'nokogiri'
+
+    class Translator
+
+      attr_accessor :source_language, :target_language, :search_text, :response
+
+      def initialize(arguments)
+        arguments.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+        @response = Response.new
+      end
+
+      def translate
+        if valid?
+          populate_translations
+        end
+        response
+      end
+
+      def required_variables
+        %w[source_language target_language search_text]
+      end
+
+      private
+
+      def valid?
+        validate_required_variables
+      end
+
+      def validate_required_variables
+        required_variables.each do |required_instance_variable|
+          add_error("Required argument missing: #{required_instance_variable}") unless instance_variable_get "@#{required_instance_variable}"
+        end
+        response.errors.size > 0 ? false : true
+      end
+
+      def populate_translations
+        fetch_from_google
+        add_error("No translations were found. Google might have changed their HTML") unless @response.translations.size > 0
+      end
+
+      def page
+        # set POST variables
+        js = "n"
+        prev = "_t"
+        hv = "en"
+        ie = "UTF-8"
+        layout = "2"
+        eotf = "1"
+        file = ""
+
+        http_response =  Net::HTTP.post_form(URI.parse('http://translate.google.com/'), {:sl => source_language, :tl => target_language, :js => js, :prev => prev, hv => hv, :ie =>
+            ie , :layout => layout, :eotf => eotf, :text => search_text, :file => file})
+        html_string = http_response.body
+        Nokogiri::HTML(html_string)
+      end
+
+      def fetch_from_google
+        translation = get_dictionary_translation(page)
+        add_translation(get_non_dictionary_translation(page).text) if response.translations.size == 0
+      end
+
+      # when there are multiple translations
+      def get_dictionary_translation html_doc
+        translations = Array.new
+        translation = html_doc.xpath("//span[@id='result_box']")
+        translation.each do |t|
+          add_translation t.text
+        end
+        translations
+      end
+
+      # when there is a phrase with no dictionary translation i.e multiple possible translations
+      def get_non_dictionary_translation html_doc
+        html_doc.xpath('//*[@id="result_box"]/span')
+      end
+
+      def add_translation translated_text
+        response.translations << Translation.new(
+            :source_language => @source_language,
+            :target_language => @target_language,
+            :search_text => @search_text,
+            :translated_text => translated_text
+        )
+      end
+
+      def add_error error_message
+        response.errors << Error.new(:message => error_message)
+      end
+    end
+  end
+end

data/lib/google_translate_scraper/version.rb

@@ -1,3 +1,3 @@
 module GoogleTranslateScraper
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/spec/google_translate_scraper_spec.rb

@@ -1,31 +1,9 @@
 require 'spec_helper'
 
 describe GoogleTranslateScraper do
-  it 'should return an array' do
-     translator = GoogleTranslateScraper::Translator.new
-     results = translator.translate("en", "sv", "Hello")
-     results.should be_a_kind_of Array
-  end
-  
-  # dictionary translations
-  it 'should return an array of Swedish translations for an English word' do
-     translator = GoogleTranslateScraper::Translator.new
-     results = translator.translate("en", "sv", "Hello")
-     results.size.should > 1
-  end
-  
-  # non-dictinary translations
-  it 'should return a Swedish translations for a short English sentence' do
-     translator = GoogleTranslateScraper::Translator.new
-     results = translator.translate("en", "sv", "Hello there")
-     results.size.should eql 1
-     results[0].should eql"Hallå där"
-  end
-  
-  it 'should return a Swedish translations for a long English sentence' do
-    translator = GoogleTranslateScraper::Translator.new
-    results = translator.translate("en","sv","Hi how are you? I'm good how are you?")
-    results.size.should eql 1
-    results[0].should eql"Hej hur mår du? Jag är bra hur mår du?"
+
+  it "scrapes and translates google translate" do
+    response = subject.translate(:source_language => 'en', :target_language => 'sv', :search_text => 'hey')
+    response.translations.first.translated_text.should == 'hej'
   end
 end

data/spec/models/error_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe GoogleTranslateScraper::Models::Error do
+
+  describe "attributes" do
+
+    it "has a message" do
+      subject.respond_to?(:message).should == true
+    end
+  end
+
+  describe "initialize" do
+
+    let(:arguments) { {:message => "You didn't provide a source language my man!"} }
+
+    it "sets all instance variables given" do
+
+      translation = subject.class.new(arguments)
+      arguments.keys.each do |key|
+        translation.send(key).should == arguments[key]
+      end
+    end
+  end
+
+end

data/spec/models/response_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe GoogleTranslateScraper::Models::Response do
+
+  describe "errors" do
+
+    before do
+      subject.errors << GoogleTranslateScraper::Models::Error.new(:message => "You did something wrong!")
+    end
+
+    it "is iterable" do
+      subject.errors.respond_to?(:each).should == true
+    end
+
+    it "is a list of error objects" do
+      subject.errors.first.class.should == GoogleTranslateScraper::Models::Error
+    end
+  end
+
+  describe "translations" do
+
+    before do
+      subject.translations << GoogleTranslateScraper::Models::Translation.new(:source_language => 'sv', :target_language => 'en', :search_text => 'Hej', :translated_text => 'Hey')
+    end
+
+    it "is iterable" do
+      subject.translations.respond_to?(:each).should == true
+    end
+
+    it "is a list of translation objects" do
+      subject.translations.first.class.should == GoogleTranslateScraper::Models::Translation
+    end
+
+  end
+
+end

data/spec/models/translation_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe GoogleTranslateScraper::Models::Translation do
+
+  describe "attributes" do
+
+    %w[ source_language target_language search_text translated_text ].each do |attribute|
+      it "has a #{attribute}" do
+        subject.respond_to?(attribute).should == true
+      end
+    end
+  end
+
+  describe "initialize" do
+
+    let(:arguments) { {:source_language => 'sv', :target_language => 'en', :search_text => 'Hej!'} }
+
+    it "sets all instance variables given" do
+
+      translation = subject.class.new(arguments)
+      arguments.keys.each do |key|
+        translation.send(key).should == arguments[key]
+      end
+    end
+  end
+
+end

data/spec/models/translator_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe GoogleTranslateScraper::Models::Translator do
+
+  let(:arguments) {{:source_language => 'en', :target_language => 'sv', :search_text => 'hey'}}
+  let(:subject) { GoogleTranslateScraper::Models::Translator.new(arguments)}
+
+  describe "format of response" do
+
+    it "returns a Response object" do
+      response = subject.translate
+      response.class.should == GoogleTranslateScraper::Models::Response
+    end
+  end
+
+  describe "successful translation" do
+
+    context "word/dictionary translation" do
+
+      let(:arguments) {{:source_language => 'en', :target_language => 'sv', :search_text => 'cat'}}
+      let(:subject) { GoogleTranslateScraper::Models::Translator.new(arguments).translate }
+
+      it "returns a translation" do
+        subject.translations.first.translated_text.should == 'katt'
+      end
+
+    end
+
+    context "phrase/non-dictionary translation" do
+
+      let(:arguments) {{:source_language => 'en', :target_language => 'sv', :search_text => 'the little cat'}}
+      let(:subject) { GoogleTranslateScraper::Models::Translator.new(arguments).translate }
+
+      it "returns a translation" do
+        subject.translations.size.should == 1
+        subject.translations.first.translated_text.should == 'den lilla katten'
+      end
+
+    end
+  end
+
+  describe "non-successful translation" do
+
+    let(:arguments) { {:source_language => 'en', :target_language => 'sv', :search_text => 'hello my friend'} }
+    let(:subject) { GoogleTranslateScraper::Models::Translator.new(arguments)}
+
+      context "a required argument was missing" do
+
+        it "returns an error" do
+          subject.instance_variable_set("@source_language", nil)
+          response = subject.translate
+          response.errors.first.message.should == "Required argument missing: source_language"
+        end
+      end
+
+      context "multiple arguments are missing" do
+
+        it "returns multiple errors" do
+          subject.instance_variable_set("@source_language", nil)
+          subject.instance_variable_set("@target_language", nil)
+          response = subject.translate
+          response.errors.size.should == 2
+        end
+      end
+
+      context "no translations were found" do
+
+        it "returns an error" do
+          subject.stub(:fetch_from_google)
+          response = subject.translate
+          response.errors.first.message.should == "No translations were found. Google might have changed their HTML"
+        end
+      end
+  end
+end

metadata

@@ -1,62 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: google_translate_scraper
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Seb Glazebrook
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-08 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 39
-        segments: 
-        - 2
-        - 10
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.10.0
   type: :development
-  version_requirements: *id002
-description: "\"This gem scraps GoogleTranslate and returns the translation for the given search phrase. If multiple translations are available, multiple are returned.\""
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+description: ! '"This gem scraps GoogleTranslate and returns the translation for the
+  given search phrase. If multiple translations are available, multiple are returned."'
+email:
 - me@sebglazebrook.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -64,43 +58,45 @@ files:
 - Rakefile
 - google_translate_scraper.gemspec
 - lib/google_translate_scraper.rb
-- lib/google_translate_scraper/translator.rb
+- lib/google_translate_scraper/models/error.rb
+- lib/google_translate_scraper/models/response.rb
+- lib/google_translate_scraper/models/translation.rb
+- lib/google_translate_scraper/models/translator.rb
 - lib/google_translate_scraper/version.rb
 - spec/google_translate_scraper_spec.rb
+- spec/models/error_spec.rb
+- spec/models/response_spec.rb
+- spec/models/translation_spec.rb
+- spec/models/translator_spec.rb
 - spec/spec_helper.rb
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.9
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: "\"This gem scrapes Google Translate and their results.\""
-test_files: 
+summary: ! '"This gem scrapes Google Translate and their results."'
+test_files:
 - spec/google_translate_scraper_spec.rb
+- spec/models/error_spec.rb
+- spec/models/response_spec.rb
+- spec/models/translation_spec.rb
+- spec/models/translator_spec.rb
 - spec/spec_helper.rb

data/lib/google_translate_scraper/translator.rb

@@ -1,62 +0,0 @@
-module GoogleTranslateScraper
-require 'net/http'  
-require 'nokogiri'
-    
-  class Translator
-    
-    @@input_language = nil
-    @@target_language = nil
-    @@text = nil
-    
-    def translate(input_language, target_language, text )
-      @@input_language = input_language
-      @@target_language = target_language
-      @@text = text
-      get_translation
-    end
-    
-    def get_translation
-      # set POST variables
-      js = "n"
-      prev = "_t"
-      hv = "en"   # i think this is the language of the website
-      ie = "UTF-8"
-      layout = "2"
-      eotf = "1"
-      file = ""
-
-      # download the webpage
-      http_response =  Net::HTTP.post_form(URI.parse('http://translate.google.com/'), {"sl" => @@input_language, "tl" => @@target_language, "js" => "n", "prev" => "_t", "hv" => "en", "ie" =>
-        "UTF-8" , "layout" => "2", "eotf" => "1", "text" => @@text, "file" => ""})
-      # get the string
-      html_string = http_response.body
-      # convert string to a Nokogiri document file
-      html_doc = Nokogiri::HTML(html_string)
-      # find the translation
-      translation = Array.new
-      translation = get_dictionary_translation(html_doc)
-      # check for non-dictionary translations
-      if translation.empty?
-        translation[0] = get_non_dictionary_translation(html_doc).text
-      end
-      return translation
-      
-    end  
-    
-    # when there are multiple translations
-    def get_dictionary_translation html_doc
-      translations = Array.new
-      translation = html_doc.xpath('//div[@id="gt-res-dict"]/ol/li/div/div')
-      translation.each do |t|
-        translations.push t.text
-      end
-      translations
-    end
-  
-    # when there is a phrase with no dictionary translation i.e multiple possible translations
-    def get_non_dictionary_translation html_doc
-      translation = html_doc.xpath('//*[@id="result_box"]/span')                                  
-    end
-    
-  end
-end