dict 0.3.1 → 0.3.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dict (0.3.0)
+    dict (0.3.1)
       nokogiri (~> 1.5.5)
       slop (~> 3.3.2)
 

data/lib/dict/cli/runner.rb

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 
+# Class, which provides using application in Command Line Interface.
+
 require 'dict/dict'
 require 'dict/version'
 require 'slop'
@@ -54,6 +56,7 @@ Search WORD in dict, an open source dictionary aggregator.
       MSG = "Usage: dict WORD [OPTIONS]\nTry `dict --help for more information.\n"
       VERSION = "dict version #{Dict::VERSION}\nSearch WORD in dict, an open source dictionary aggregator.\nCopyright (C) 2012 by Mateusz Czerwiński, Michał Podlecki,\nAleksander Gozdek, Rafał Ośko, Jan Borwin, Kosma Dunikowski\nMentors: Grzegorz Kołodziejski, Michał Kwiatkowski\nMade during intership at Ragnarson http://ragnarson.com\nHosted by Shelly Cloud https://shellycloud.com\nLicense: MIT\nHomepage: https://github.com/Ragnarson/dict-gem\nSources dictionaries: http://dict.pl, http://pl.wiktionary.org" 
 
+      # Returns only translations of the given word, without example sentences.
       def clean_translation(opts, word)
         translation = get_translations(opts, word)
         string = String.new

data/lib/dict/dict.rb

@@ -1,11 +1,13 @@
 # -*- coding: utf-8 -*-
 
 require 'dict/wiktionary'
+require 'dict/glosbe'
+
 require "yaml"
 
 module Dict
   class << self
-    # returns hash with structure as showed below
+    # Returns hash with structure as showed below
     # { 'DICTIONARY_NAME' => { 'TRANSLATION' => ['EXAMPLE', ...], ... }, ... }
     def get_all_dictionaries_translations(word)
       dictionaries = Hash.new
@@ -16,34 +18,36 @@ module Dict
       dictionaries
     end
 
-    # prints translations from all dictionaries
+    # Prints translations from all dictionaries.
     def print_all_dictionaries_translations(word)
       available_dictionaries.each do |dictionary|
         print_single_dictionary_translations(word, dictionary)
       end
     end
 
-    # returns hash with structure as showed below
+    # Returns hash with structure as showed below
     # { 'TRANSLATION' => ['EXAMPLE', ...], ... }
     def get_single_dictionary_translations(word, dictionary)
       case dictionary
-      when 'wiktionary'
-        Wiktionary.new(word).translate.translations
-      else Dictionary.message
+        when 'wiktionary'
+          Wiktionary.new(word).translate.translations
+        when 'glosbe'
+          Glosbe.new(word).translate.translations
+        else Dictionary.message
       end
     rescue Dictionary::ConnectError
       "Couldn't connect to the dictionary."
     end
 
-    # prints translations from single dictionary
+    # Prints translations from single dictionary.
     def print_single_dictionary_translations(word, dictionary)
       puts "Word '#{word.upcase}' translations from #{dictionary.upcase} dictionary."
       puts get_single_dictionary_translations(word, dictionary).to_yaml
     end
 
-    # returns array of currently available dictionaries
+    # Returns array of currently available dictionaries.
     def available_dictionaries
-      ['wiktionary']
+      ['wiktionary', 'glosbe']
     end
   end
 end

data/lib/dict/dictionary.rb

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 
+# It is a base class for classes fetching results from Web dictionaries.
+
 require 'open-uri'
 require 'dict/result'
 
@@ -15,7 +17,7 @@ module Dict
       @result = Dict::Result.new(@word)
     end
 
-    # returns hash with structure as showed below
+    # Returns hash with structure as showed below
     # { 'TRANSLATION' => ['EXAMPLE', ...], ... }
     def make_hash_results(arr)
       hash = arr.each_slice(2).inject({}) do |h, (key, value)|
@@ -29,12 +31,12 @@ module Dict
       hash
     end
     
-    # returns an instance of URI::HTTP class
+    # Returns an instance of URI::HTTP class.
     def uri(url, word = nil)
       word == nil ? URI(URI.escape(url)) : URI(URI.escape(url + word.downcase.tr(' ', '_')))
     end
 
-    # checks if word was given correctly
+    # Checks if word was given correctly.
     def check_arguments(word)
       raise ArgumentError.new("No given word") if word.empty?
     end

data/lib/dict/glosbe.rb

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+
+require 'nokogiri'
+require 'dict/dictionary'
+
+GLOSBE_PL = 'http://glosbe.com/pl/en/' # polish - english
+GLOSBE_EN = 'http://glosbe.com/en/pl/' # english - polish
+
+module Dict
+  class Glosbe < Dictionary
+    # returns an Dict::Result object 
+    def translate
+      begin
+        if is_polish?(doc = get_content(GLOSBE_PL, @word))
+          add_translations(get_translations(doc))
+          add_examples(get_examples(doc, 'en'))
+        else
+          doc = get_content(GLOSBE_EN, @word) 
+          add_translations(get_translations(doc))
+          add_examples(get_examples(doc, 'pl'))
+        end
+
+        @result
+      rescue OpenURI::HTTPError
+        raise Dictionary::ConnectError
+      end
+    end
+
+    private
+
+    # checks if given word is polish
+    def is_polish?(doc)
+      doc.at_css('.content_box_rounded p').nil?
+    end
+
+    # returns a html structure of visited site
+    def get_content(url, word)
+      Nokogiri::HTML(open(uri(url, word))).css('.wordDetails')
+    end
+
+    # returns array with structure as shown below from the given dictionary link
+    # ['TRANSLATION1', 'TRANSLATION2', ...]
+    def get_translations(doc)
+      doc.css('.phrase-container > .translation').each { |translation| translations.push(translation.text.downcase) }
+      translations
+    end
+
+    # add obtained translations to Dict::Result object
+    def add_translations(translations)
+      translations.each { |translation| @result.add_translation(@result.term, translation) }
+    end
+
+    # returns array with structure as shown below from the given dictionary link
+    # ['EXAMPLE1', 'EXAMPLE2', ...]
+    # the default length of given example is 60 characters
+    def get_examples(doc, lang, length = 60)
+      doc.css(".tranlastionMemory td[lang=#{lang}]").each { |example| examples.push(example.text.capitalize) if example.text.length < length }
+      examples
+    end
+
+    # add obtained examples to Dict::Result object
+    def add_examples(examples)
+      examples.each { |example| @result.add_example(@result.term, example) }
+    end
+  end
+end

data/lib/dict/result.rb

@@ -1,3 +1,6 @@
+# Objects of this class are returned by methods retrieving translations 
+# from Web dictionaries.
+
 module Dict
   class Result
     attr_reader :term, :translations, :examples

data/lib/dict/version.rb

@@ -1,3 +1,3 @@
 module Dict
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/lib/dict/wiktionary.rb

@@ -1,12 +1,14 @@
 # -*- coding: utf-8 -*-
 
+# Class fetching translations of given word from wiktionary.org.
+
 require 'nokogiri'
 require 'dict/dictionary'
 
 module Dict
   class Wiktionary < Dictionary
 
-    # Returns an Dict::Result object
+    # Returns an Dict::Result object.
 	  def translate
       translations.each { |item| @result.add_translation(@result.term, item) }
 

data/spec/dict/lib_dict_cli_runner_spec.rb

@@ -36,12 +36,12 @@ end
 
 
 describe "get_translations" do
-  it "should return results from wiktionary and dictpl for word 'słowik'" do
+  it "should return results from wiktionary and glosbe for word 'słowik'" do
     VCR.use_cassette('translations_slownik_cassette') do
       stub_const("ARGV", ["słowik"])
       runner = Dict::CLI::Runner.new
       opts = runner.parse_parameters
-      runner.get_translations(opts, "słowik").should == {"wiktionary"=>{"słowik"=>["nightingale"]}}
+      runner.get_translations(opts, "słowik").should == {"wiktionary" => {"słowik" => ["nightingale"]}, "glosbe" => {"słowik" => ["nightingale", "bulbul"]}}
     end
   end
 
@@ -65,8 +65,8 @@ describe "get_translations" do
 end
 
 describe "CLI::Runner" do
-  HELP_MSG = "Usage: dict WORD [OPTIONS]\nSearch WORD in dict, an open source dictionary aggregator.\n\n    -h, --help         Display this help message\n    -t, --time         Set timeout in seconds. Default: 300\n    -d, --dict         Select desired dictionary. Available options: wiktionary\n    -v, --version      Information about gem, authors, license\n    -c, --clean        Remove examples from translation"
-  DICT_MSG = "Missing argument. Expected: wiktionary"
+  HELP_MSG = "Usage: dict WORD [OPTIONS]\nSearch WORD in dict, an open source dictionary aggregator.\n\n    -h, --help         Display this help message\n    -t, --time         Set timeout in seconds. Default: 300\n    -d, --dict         Select desired dictionary. Available options: wiktionary, glosbe\n    -v, --version      Information about gem, authors, license\n    -c, --clean        Remove examples from translation"
+  DICT_MSG = "Missing argument. Expected: wiktionary, glosbe"
   TIME_MSG = "Missing argument. Expected: number of seconds"
   T_MSG = "Wrong time value."
 
@@ -108,10 +108,12 @@ describe "CLI::Runner" do
   end
 
   it "should return string when you use --clean parameter" do
-    stub_const("ARGV",["słowik","--clean"])
-    runner = Dict::CLI::Runner.new
-    opts = runner.parse_parameters
-    runner.clean_translation(opts, ARGV[0]).should == "słowik : nightingale"
+    VCR.use_cassette('slowik_runner_cassette') do
+      stub_const("ARGV",["słowik","--clean"])
+      runner = Dict::CLI::Runner.new
+      opts = runner.parse_parameters
+      runner.clean_translation(opts, ARGV[0]).should == "słowik : nightingale, nightingale, bulbul"
+    end
   end
 
 

data/spec/dict/lib_dict_spec.rb

@@ -10,16 +10,19 @@ describe Dict do
     arr.size.should_not == 0
   end
 
-  it "should return array of available services, which contains wiktionary and dictpl" do
-    Dict.available_dictionaries.should == ['wiktionary']
+  it "should return array of available services, which contains wiktionary and glosbe" do
+    Dict.available_dictionaries.should == ['wiktionary', 'glosbe']
   end
 
   it "should return hash with translations from all dictionaries" do
     wiktionary = stub(:translate => stub(:translations => {'WORD' => 'WIKTIONARY_RESULTS'}))
     Dict::Wiktionary.should_receive(:new).with('WORD').and_return(wiktionary)
 
+    glosbe = stub(:translate => stub(:translations => {'WORD' => 'GLOSBE_RESULTS'}))
+    Dict::Glosbe.should_receive(:new).with('WORD').and_return(glosbe)
+
     results = Dict::get_all_dictionaries_translations('WORD')
-    results.should == {'wiktionary' => {'WORD' => 'WIKTIONARY_RESULTS'}}
+    results.should == {'wiktionary' => {'WORD' => 'WIKTIONARY_RESULTS'}, 'glosbe' => {'WORD' => 'GLOSBE_RESULTS'}}
   end
 
   it "should return whatever Wiktionary returns embedded in a hash" do
@@ -27,4 +30,10 @@ describe Dict do
     Dict::Wiktionary.should_receive(:new).with('WORD').and_return(wiktionary)
     Dict.get_single_dictionary_translations('WORD', 'wiktionary').should == 'WIKTIONARY_RESULTS'
   end
+  
+  it "should return whatever Glosbe returns embedded in a hash" do
+    glosbe = stub(:translate => stub( :translations => 'GLOSBE_RESULTS'))
+    Dict::Glosbe.should_receive(:new).with('WORD').and_return(glosbe)
+    Dict.get_single_dictionary_translations('WORD', 'glosbe').should == 'GLOSBE_RESULTS'
+  end
 end

data/spec/dict/lib_glosbe_spec.rb

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*
+
+require_relative './vcr_setup'
+require 'dict/glosbe'
+
+describe Dict::Glosbe do
+
+  it "should raise no given word exception" do
+    expect { Dict::Glosbe.new }.to raise_error ArgumentError
+  end
+
+  it "should return a Result object" do
+    VCR.use_cassette('glosbe_translations_woda_cassette') do
+      g = Dict::Glosbe.new('woda').translate
+      g.should be_a(Dict::Result)
+    end
+  end
+
+  it "should return translations of polish word 'woda' to english with its examples" do
+    VCR.use_cassette('glosbe_translations_woda_cassette') do
+      g = Dict::Glosbe.new('woda').translate
+      g.translations.should == {"woda"=>["water", "aqua"]}
+      g.examples.should == {"woda"=>["Details of food and water quality", "Mineral waters, soft drinks and juices (nd", "Fishing for herring in area iia (ec waters", "Bind him, cast him into the slop- pool at low tide!"]}
+    end
+  end
+
+  it "should return translations of english word 'atomic' to polish with its examples" do
+    VCR.use_cassette('glosbe_translations_atomic_cassette') do
+      g = Dict::Glosbe.new('atomic').translate
+      g.translations.should == {"atomic"=>["atomowy", "niepodzielny", "atomistyczny", "jednolity"]}
+      g.examples.should == {"atomic"=>["Spektrofotometr absorpcji atomowej", "Atom w lewo", "Pomiary metodą absorpcji atomowej"]}
+    end
+  end
+ end

data/spec/dict/lib_wiktionary_spec.rb

@@ -38,6 +38,8 @@ describe Dict::Wiktionary do
   end
   
   it "should remove html tags from translations of 'dragon' word" do
-    Dict::Wiktionary.new("dragon").translate.translations.should eq({'dragon' => ['smok']})
+    VCR.use_cassette('translations_dragon_cassette') do
+      Dict::Wiktionary.new("dragon").translate.translations.should eq({'dragon' => ['smok']})
+    end
   end
 end