dictionary-rb 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+  gem "nokogiri"
+  gem "thor"
+  gem "highline"
+  gem "redcarpet"
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    diff-lcs (1.1.3)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    multi_json (1.8.4)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    redcarpet (3.0.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    thor (0.16.0)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  highline
+  jeweler (~> 1.8.7)
+  nokogiri
+  rdoc (~> 3.12)
+  redcarpet
+  rspec (~> 2.8.0)
+  thor
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Ankur Goel
+
+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.

data/README.md

@@ -0,0 +1,124 @@
+#dictionary-rb
+
+Provides meanings, similar words, usage examples from [Urban Dictionary](http://urbandictionary.com) and [Dictionary Reference](http://dictionary.reference.com/) with **CLI** support.
+
+##Installation
+
+`gem install dictionary-rb`
+
+##Usage
+--------
+
+```ruby
+require 'dictionary-rb'
+include DictionaryRB
+word = Word.new('pudding')
+word.meaning
+#=> "a thick, soft dessert, typically containing flour or some other thickener, milk, eggs, a flavoring, and sweetener"
+
+#I shall haz more meanings
+word.meanings
+#=> ["a thick, soft dessert, typically containing flour or some other thickener, milk, eggs, a flavoring, and sweetener", "a similar dish unsweetened and served with or as a main dish", "British",.. ]
+
+
+#Find urban dictionary meaning instead:
+word.urban_meaning
+#=> "a desert given to kids who eat their meat"
+
+
+#Do more with them
+word.urban.examples
+#=> ["eat your meat! how can you have any pudding if you dont eat your meat?!", "  Oh, no! Get the pudding,here comes a gang of Leprechauns and children.", "Adrian says, \"I like pudding.\"", "My cousin is a whore...I think I'll name her Pudding."..]
+
+word.dictionary.examples
+#=> ["Turn into an earthen pudding-dish, cover, and cook slowly three and one-half hours.", "Turn in a buttered pudding-dish, and bake thirty-five minutes in a slow oven.", "The proof is in the pudding and if people want to make themselves feel better  for bottle feeding they can go ahead.",..]
+
+word.urban.synonyms
+#=>[ "bill cosby", "pie", "fat", "pudd"]
+```
+
+##CLI
+------
+* To list all tasks   
+  `dictionary help`
+
+* To list help for a task   
+  `dictionary help task_name`   
+  **example** : `dictionary help urban`   
+
+### Using `meaning`
+  
+```bash
+> dictionary meaning boast
+boast - to speak with exaggeration and excessive pride, especially about oneself
+```
+
+####Available options and flags:
+
+```bash
+> dictionary help meaning
+Usage:
+  dictionary meaning WORD
+
+Options:
+  [--words=one two three]  # Specify multiple WORDS in succession
+  [--file]                 # Pass file(s) as argument(s) instead.
+  [--example]              # Generate an example too.
+  [--similar]              # Generate a synonym too.
+  [--urban]                # Give meaning from Urban Dictionary instead.
+  [--write=FILE]           # Also write results to specified FILE
+
+gives dictionary meaning of the WORD
+```
+
+
+```bash
+> dictionary meaning --words boast sly --urban --example
+boast - To gloat or brag about something - He was boasting about his fly girlfriend.
+sly - To do something cunningly, preferably without any one seeing, apart from your best mate to prove you did it - "Hey Jo, see that girl there? Well we danced and she i" Slllly!"ying my child!!!"
+```
+
+### Using `similar`
+
+```bash
+> dictionary similar answer
+answer is similar to - check
+```
+
+####Available options and flags
+
+```bash
+> dictionary help similar
+Usage:
+  dictionary similar WORD
+
+Options:
+  [--words=one two three]  # Specify multiple WORDS in succession
+  [--file]                 # Pass file(s) as arugment(s) instead.
+  [--urban]                # Give similar word from Urban Dictionary
+  [--count=N]              # Gives N similar words
+  [--write=FILE]           # Write results to specified FILE
+
+gives syonyms of word(s)
+```
+
+```bash
+> dictionary similar --words boast --urban --count 2
+boast is similar to - annoying, humble
+```
+
+**Similar tasks are present for "urban" and "examples", use `help` to discover**
+
+
+##Contribution
+
+* Fork the [repository](https://github.com/AnkurGel/dictionary-rb)
+* Have a look at the [API Documentation](). It is pretty well documented with explanations of all methods and modules.
+* Do your changes in your remote branch
+* Create a pull request.
+* Earn a beer! :)
+
+
+##Copyright
+
+Copyright (c) 2014 Ankur Goel.

data/README.rdoc

@@ -0,0 +1,19 @@
+= dictionary-rb
+
+Provides meanings, similar words, usage examples from {Urban Dictionary}[http://urbandictionary.com] and {Dictionary Reference}[http://dictionary.reference.com/] with CLI support.
+
+== Contributing to dictionary-rb
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Ankur Goel. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "dictionary-rb"
+  gem.homepage = "http://github.com/AnkurGel/dictionary-rb"
+  gem.license = "MIT"
+  gem.summary = %Q{Provides urban-dictionary and dictionary-reference meanings.}
+  gem.description = %Q{Provides urban-dictionary and dictionary-reference meanings. Equipped with CLI interface and general-purpose library.}
+  gem.email = "ankurgel@gmail.com"
+  gem.authors = ["Ankur Goel"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/dictionary

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby
+require "thor"
+require "dictionary-rb"
+
+class DictionaryRB_CLI < Thor
+
+  desc "meaning WORD", "gives dictionary meaning of the WORD"
+  option :words, :desc => "Specify multiple WORDS in succession", :type => :array
+  option :file, :type => :boolean, :desc => "Pass file(s) as argument(s) instead."
+  option :example, :type => :boolean, :desc => "Generate an example too."
+  option :similar, :type => :boolean, :desc => "Generate a synonym too."
+  option :urban, :type => :boolean, :desc => "Give meaning from Urban Dictionary instead."
+  option :write, :desc => "Also write results to specified FILE", :banner => "FILE"
+  def meaning(word=nil)
+    if options[:urban]
+      invoke :urban, [word], options
+    else
+      urban_or_dictionary_meaning(word, options, :dictionary)
+    end
+  end
+
+
+  desc "urban WORD", "gives UrbanDictionary meaning of the WORD"
+  option :words, :desc => "Specify multiple WORDS in succession", :type => :array
+  option :file, :type => :boolean, :desc => "Pass file(s) as argument(s) instead."
+  option :example, :type => :boolean, :desc => "Generate an example too."
+  option :similar, :type => :boolean, :desc => "Generate a synonym too."
+  option :write, :desc => "Write results to specified FILE", :banner => "FILE"
+  def urban(word=nil)
+    urban_or_dictionary_meaning(word, options, :urban)
+  end
+
+
+  desc "similar WORD", "gives syonyms of word(s)"
+  option :words, :desc => "Specify multiple WORDS in succession", :type => :array
+  option :file, :type => :boolean, :desc => "Pass file(s) as arugment(s) instead."
+  option :urban, :type => :boolean, :desc => "Give similar word from Urban Dictionary"
+  option :count, :type => :numeric, :desc => "Gives N similar words"
+  option :write, :desc => "Write results to specified FILE", :banner => "FILE"
+  def similar(word=nil)
+    write_file = options[:write] ? File.open(File.expand_path(options[:write]), 'wb') : nil
+    words = options_simplifier(word, options)
+    method = options[:urban] ? :urban : :dictionary
+    words.each do |word|
+      obj = DictionaryRB::Word.new(word).method(method).call
+      results = obj.similar_words.shuffle.first(
+          options[:count] ? options[:count] : 1)
+      say "#{word} is similar to - #{results.join(', ')}"
+      write_file.puts("#{word} is similar to - #{results.join(', ')}") if write_file
+    end
+    write_file.close if write_file
+  end
+
+
+  desc "examples WORD", "gives examples of word(s)"
+  option :words, :desc => "Specify multiple WODS in succession", :type => :array
+  option :file, :type => :boolean, :desc => "Pass file(s) as arugment(s) instead."
+  option :urban, :type => :boolean, :desc => "Give example from Urban Dictionary"
+  option :count, :type => :numeric, :desc => "Given N examples"
+  option :write, :desc => "Write results to specified FILE", :banner => "FILE"
+  def examples(word=nil)
+    write_file = options[:write] ? File.open(File.expand_path(options[:write]), 'wb') : nil
+    words = options_simplifier(word, options)
+    method = options[:urban] ? :urban : :dictionary
+    words.each do |word|
+      obj = DictionaryRB::Word.new(word).method(method).call
+      results = obj.examples.shuffle.first(
+          options[:count] ? options[:count] : 1
+      )
+      say "#{word}'s examples: #{results.join(', ')}"
+      write_file.puts("#{word}'s examples: #{results.join(', ')}") if write_file
+    end
+    write_file.close if write_file
+  end
+
+
+  private
+  def options_simplifier(word, options)
+    if options[:file]
+      files_path = options[:words] ? options[:words] : [word]
+      words = files_to_words files_path
+    elsif options[:words] #no 'file' flag is found, but 'words' options are
+      words = sanitize_options_words(options[:words])
+    else
+      words = [word]
+    end
+    words
+  end
+
+  def urban_or_dictionary_meaning(word, options, method)
+    write_file = options[:write] ? File.open(File.expand_path(options[:write]), 'wb') : nil
+    words = options_simplifier(word, options)
+    words.each do |word|
+      obj = DictionaryRB::Word.new(word).method(method).call
+      meaning = obj.meaning
+      example = options[:example] ? " - " + obj.examples.first : ""
+      similar = options[:similar] ? " - " + obj.similar_words.first : ""
+      say "#{word} - #{meaning}#{example}#{similar}"
+      write_file.puts("#{word} - #{meaning}#{example}#{similar}") if write_file
+    end
+    write_file.close if write_file
+  end
+
+  def files_to_words(files)
+    files.map do |file|
+      file_path = File.expand_path(file)
+      raise ArgumentError, say("Error: File #{file_path} doesn't exists!", :red) unless File.exists?(file_path)
+      File.open(file_path, 'rb').read.split("\n").map do |word|
+        raise ArgumentError, "Error: Not a valid word - #{word}, :red" unless word.strip.match(/^[\w\s]+$/)
+        word
+      end
+    end.flatten.uniq
+  end
+
+  def sanitize_options_words(words)
+    words.map do |word|
+      raise ArgumentError, "Error: Not a valid word - #{word}, :red" unless word.strip.match(/^[\w\s]+$/)
+      word
+    end
+  end
+
+
+end
+
+DictionaryRB_CLI.start

data/dictionary-rb.gemspec

@@ -0,0 +1,83 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "dictionary-rb"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ankur Goel"]
+  s.date = "2014-02-01"
+  s.description = "Provides urban-dictionary and dictionary-reference meanings. Equipped with CLI interface and general-purpose library."
+  s.email = "ankurgel@gmail.com"
+  s.executables = ["dictionary"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/dictionary",
+    "dictionary-rb.gemspec",
+    "lib/dictionary-rb.rb",
+    "lib/dictionary-rb/dictionary.rb",
+    "lib/dictionary-rb/string_patch.rb",
+    "lib/dictionary-rb/urban.rb",
+    "lib/dictionary-rb/word.rb",
+    "spec/dictionary-rb_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/AnkurGel/dictionary-rb"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Provides urban-dictionary and dictionary-reference meanings."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_development_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<thor>, [">= 0"])
+      s.add_development_dependency(%q<highline>, [">= 0"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<thor>, [">= 0"])
+      s.add_dependency(%q<highline>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<thor>, [">= 0"])
+    s.add_dependency(%q<highline>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+  end
+end
+

data/lib/dictionary-rb.rb

@@ -0,0 +1,12 @@
+require 'open-uri'
+require 'nokogiri'
+require 'debugger'
+require 'cgi'
+require 'dictionary-rb/word'
+require 'dictionary-rb/dictionary'
+require 'dictionary-rb/urban'
+require 'dictionary-rb/string_patch'
+
+module DictionaryRB
+
+end

data/lib/dictionary-rb/dictionary.rb

@@ -0,0 +1,86 @@
+module DictionaryRB
+
+  # Parses the page for a word at {http://dictionary.reference.com Reference Dictionary}
+  # and extracts the {#meanings}, {#examples} and {#similar_words} for it.
+  # Lot of take care has been taken to prevent it from hitting the {PREFIX ENDPOINT}
+  # so as to make it quickly generate the other results, once a URL is parsed.
+  class Dictionary
+
+    # The associated word
+    attr_reader :word
+    # Endpoint for Reference Dictionary
+    PREFIX = "http://dictionary.reference.com/browse/"
+
+    # @param word [String] The word for Reference Dictionary
+    # @example
+    #    word = DictionaryRB::Dictionary.new('question')
+    def initialize(word)
+      @word = word if word.is_a? String
+      @word = word.word if word.is_a? Word
+      @examples = Array.new
+    end
+
+    # Fetches and gives meanings for word from Reference Dictionary
+    # @note This method will hit the {PREFIX ENDPOINT} and will consume some time to generate result
+    # @example
+    #    word.meanings
+    #    #=> ["a sentence in an interrogative form, addressed to someone in order to get information in reply",
+    #         "a problem for discussion or under discussion",
+    #         "a matter for investigation",... ]
+    # @see #meaning
+    # @return [Array] containing the meanings for the word
+    def meanings
+      url = PREFIX + CGI::escape(@word)
+      @doc = Nokogiri::HTML(open(url))
+
+      nodes = [@doc.css('.luna-Ent .dndata')]
+      nodes = [@doc.css('.pbk .luna-Ent')] if nodes.flatten.empty?
+
+      (nodes ||= []).push(@doc.css(".td3n2")).flatten!
+      results = nodes.map(&:text).map do |result|
+        result.split ':'
+      end.map { |x| x[0].split(/[.;]/) }.flatten.map(&:strip).reject(&:empty?)
+      @meaning = results.first
+      results
+    end
+
+    # Fetches and gives first meaning for the word
+    # @example
+    #    word.meaning
+    #    #=> "a sentence in an interrogative form, addressed to someone in order to get information in reply"
+    # @see #meanings
+    # @return [String] containing the meaning for the word
+    def meaning
+      meanings.first
+    end
+
+    # Fetches and gives the examples for the word
+    # @example
+    #    word.examples
+    #    #=> ["There is an easy answer to this question, and it involves some good news and  some bad news.",
+    #         "Then there was an awkward silence as though they were waiting for me to answer  another question.",..]
+
+    # @return [Array] containing the examples.
+    def examples
+      @doc ||= Nokogiri::HTML(open(PREFIX + CGI::escape(@word)))
+      @example_results ||= @doc.css('.exsentences').map{ |x| x.text.strip }.reject(&:empty?).flatten
+      @example_results #to prevent above computations on repeated call on object
+    end
+
+    # Fetches and gives synonyms for the word
+    # @example
+    #    word.similar_words
+    #    #=> => ["answer", "inquire", "question mark", "sentence",.. ]
+    # @return [Array] containing similar words
+    def similar_words
+      @doc ||= Nokogiri::HTML(open(PREFIX + CGI::escape(@word)))
+      @similar_words = @doc.css("#relatedwords .fla a").map(&:text).reject(&:empty?)
+      @similar_words
+    end
+    alias_method :synonyms, :similar_words
+
+    def to_s
+      sprintf("Free Dictionary (word: %s, meaning: %s", @word, @meaning)
+    end
+  end
+end

data/lib/dictionary-rb/string_patch.rb

@@ -0,0 +1,21 @@
+class String
+  self.class_eval do
+    %w(meaning urban_meaning to_urban to_dictionary).each do |method|
+      define_method method do
+        if obj=method.match(/^to_(.*)/)
+          DictionaryRB::Word.new(self).method(obj[1]).call
+        else
+          DictionaryRB::Word.new(self).method(method).call
+        end
+      end
+    end
+
+    def to_word
+      DictionaryRB::Word.new(self)
+    end
+  end
+
+  def respond_to?(method)
+    %w(meaning urban_meaning to_urban to_dictionary to_word).include?(method) || super
+  end
+end

data/lib/dictionary-rb/urban.rb

@@ -0,0 +1,78 @@
+module DictionaryRB
+
+  # Parses the page for a word at {http://www.urbandictionary.com/ Urban Dictionary}
+  # and extracts the {#meanings}, {#examples} and {#similar_words} for it.
+  # Lot of take care has been taken to prevent it from hitting the {PREFIX ENDPOINT}
+  # so as to make it quickly generate the other results, once a URL is parsed.
+  class Urban
+
+    #The associated word
+    attr_reader :word
+    # Endpoint for Urban Dictionary
+    PREFIX = "http://www.urbandictionary.com/define.php?term="
+
+    # @param word [String] The word for Urban Dictionary
+    # @example
+    #    word = DictionaryRB::Urban.new('Krunal')
+    def initialize(word)
+      @word = word if word.is_a? String
+      @word = word.word if word.is_a? Word
+    end
+
+    # Fetches and gives the first meaning of the word.
+    # @example
+    #    word.meaning
+    #    #=> "A fuck, nothing more, just a fuck"
+    # @see #meanings
+    # @return [String] containing meaning for the word
+    def meaning
+      meanings.first
+    end
+
+    # Fetches and gives meanings for the word from Urban Dictionary
+    # @example
+    #    word.meanings
+    #    #=> ["A fuck, nothing more, just a fuck",
+    #         "Describes someone as being the sexiest beast alive. Anyone who is blessed with the name Krunal should get a medal.",..]
+    # @see #meaning
+    # @return [Array] containing the meanings for the word.
+    def meanings
+      url = PREFIX + CGI::escape(@word)
+      @doc ||= Nokogiri::HTML(open(url))
+
+      nodes = @doc.css('div#outer.container div.row.three_columns div.span6 div#content div.box div.inner div.meaning')
+      results = nodes.text.split("\n").reject(&:empty?)
+      @meaning = results.first
+      results
+    end
+
+    # Fetches and gives the examples for the word.
+    # @example
+    #    word.examples
+    #    #=> ["I hate that guy, he is a krunal", "Hot chick - God i want ur Krunalness\rKrunal - I know...",]
+    # @return [Array] containing the examples
+    def examples
+      @doc ||= Nokogiri::HTML(open(PREFIX + CGI::escape(@word)))
+      nodes = @doc.css('div#outer.container div.row.three_columns div.span6 div#content div.box div.inner div.example')
+      nodes.text.split("\n").reject(&:empty?)
+    end
+
+    # Fetches and gives synonyms for the word.
+    # @example
+    #    word.synonyms
+    #    #=> ["agam", "indian", "kerpal",.. ]
+    # @see #synonyms
+    # @return [Array] containing synonyms for the word
+    def similar_words
+      @doc ||= Nokogiri::HTML(open(PREFIX + CGI::escape(@word)))
+      nodes = @doc.css('div#outer.container div.row.three_columns div.span6 div#content div.tags a')
+      nodes.map(&:text).reject(&:empty?)
+    end
+
+    alias_method :synonyms, :similar_words
+
+    def to_s
+      sprintf("Urban Dictionary (word: %s, meaning: %s)", @word, @meaning)
+    end
+  end
+end

data/lib/dictionary-rb/word.rb

@@ -0,0 +1,114 @@
+module DictionaryRB
+
+  # Contains the word and offers methods for {Urban} and Reference {Dictionary}
+  # Also provides methods like {#meaning}, {#urban_meaning} etc for direct access.
+  # Lot of precautions has been taken to prevent repeated call on endpoints
+  class Word
+
+    # The associated word
+    attr_reader :word
+    # Urban Dictionary instance
+    attr_reader :urban
+    # Reference Dictionary instance
+    attr_reader :dictionary
+
+
+    # @param word [String] The word for Dictionary
+    # @example
+    #    word = DictionaryRB::Word.new('boast')
+    def initialize(word)
+      @word = word
+    end
+
+    # Gives Reference Dictionary instance object for word
+    # @example
+    #    word.dictionary.synonyms
+    # @see Dictionary
+    # @return [DictionaryRB::Dictionary] the associated object in `Dictionary`
+    def dictionary
+      @dictionary ||= Dictionary.new(@word)
+    end
+
+    # Gives dictionary meaning for the word
+    # @example
+    #    word.dictionary_meaning
+    #    #or
+    #    word.meaning
+    # @note This method will hit the {Dictionary::PREFIX ENDPOINT} and will consume some time to generate result
+    # @return [String] containing meaning from Reference {Dictionary} for the word
+    def dictionary_meaning
+      if @dictionary_meaning.nil?
+        @dictionary = Dictionary.new(@word)
+        meanings = @dictionary.meanings
+        if meanings.is_a? Array and not meanings.empty?
+          @dictionary_meanings = meanings
+          @dictionary_meaning = @dictionary.meaning
+        end
+      end
+      @dictionary_meaning
+    end
+
+    # Fetches all meanings from Reference Dictionary for the word.
+    # It is greedily evaluated to save computation when {#dictionary_meaning} is called.
+    # @example
+    #    word.dictionary_meanings
+    #    #or
+    #    word.meanings
+    # @see #dictionary_meaning
+    # @return [Array] array containing the meanings from Reference {Dictionary} for the word
+    def dictionary_meanings
+      if @dictionary_meanings.nil?
+        dictionary_meaning
+      end
+      @dictionary_meanings
+    end
+
+    # Gives Urban Dictionary instance object for word
+    # @example
+    #    word.urban.synonyms
+    # @see Urban
+    # @return [DictionaryRB::Urban] the associated object in `Urban`
+    def urban
+      @urban ||= Urban.new(@word)
+    end
+
+    # Fetches the first meaning from Urban Dictionary for the word.
+    # @note This method will hit the {Urban::PREFIX ENDPOINT} and will consume some time to generate result
+    # @example
+    #    word.urban_meaning
+    # @see #urban_meanings
+    # @return [String] containing meaning from {Urban} Dictionary for the word
+    def urban_meaning
+      if @urban_meaning.nil?
+        @urban = Urban.new(@word)
+        meanings = @urban.meanings
+        if meanings.is_a?(Array) and not meanings.empty?
+          @urban_meanings = meanings
+          @urban_meaning = @urban.meaning
+        end
+      end
+      @urban_meaning
+    end
+
+    # Fetches all meanings from the Urban Dictionary for the word.
+    # It is greedily evaluated when {#urban_meaning} is called
+    # @example
+    #    word.urban_meanings
+    #    #=> ['brag', 'lie', 'boaster']
+    # @see #urban_meaning
+    # @return [Array] array containing meanings from {Urban} Dictionary for the word
+    def urban_meanings
+      if @urban_meanings.nil?
+        urban_meaning
+      end
+      @urban_meanings
+    end
+
+    alias meaning dictionary_meaning
+    alias meanings dictionary_meanings
+
+    def to_s
+      sprintf("%s", word)
+    end
+  end
+end

data/spec/dictionary-rb_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "DictionaryRb" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'dictionary-rb'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: dictionary-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ankur Goel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides urban-dictionary and dictionary-reference meanings. Equipped
+  with CLI interface and general-purpose library.
+email: ankurgel@gmail.com
+executables:
+- dictionary
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/dictionary
+- dictionary-rb.gemspec
+- lib/dictionary-rb.rb
+- lib/dictionary-rb/dictionary.rb
+- lib/dictionary-rb/string_patch.rb
+- lib/dictionary-rb/urban.rb
+- lib/dictionary-rb/word.rb
+- spec/dictionary-rb_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/AnkurGel/dictionary-rb
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -378285379
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides urban-dictionary and dictionary-reference meanings.
+test_files: []