urbanlexicophile 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'nokogiri'
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.5.0)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  nokogiri
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Dave Kerr
+
+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.rdoc

@@ -0,0 +1,57 @@
+= UrbanLexicophile
+
+UrbanLexicophile allows you to retrieve definitions of terms from UrbanDictionary.com
+
+== Installation
+
+  gem install urbanlexicophile
+
+== Note on Usage
+
+UrbanDictionary.com does not provider a public API, please be mindful of this if you use this gem. It works by scraping each page for the definitions. It's probably better if you don't use this gem for anything but personal research, but if you do use it for otherwise please be considerate and cache results and give credit and a link to UrbanDictionary.com
+
+== Usage
+
+First, call this to get an array of all definitions:
+  definitions = UrbanLexicophile.define("urban dictionary")
+
+Then you can iterate through them in the usual manner:
+  definitions.each do |definition|
+    # display all information about each definition
+    puts definition.title
+    puts definition.definition
+    puts definition.example
+    puts definition.author
+  end
+
+As the definitions are returned as an array, you could just do this if you only one the most popular definition:
+  most_popular = definition.first
+
+If there are no definitions for the desired term, the return is just an empty array.
+
+== Dependencies
+
+* Nokogiri
+
+== TODO
+
+* Retrieve vote information about each definition and implement Definition.score()
+* Retrieve the Urban Word of the Day
+* Retrieve information about definition authors
+
+
+== Contributing to UrbanLexicophile
+ 
+* 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) 2011 Dave Kerr. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+# 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 = "urbanlexicophile"
+  gem.homepage = "http://github.com/DaveKerr/urbanlexicophile"
+  gem.version = "0.1.0"
+  gem.license = "MIT"
+  gem.summary = "A way of retrieving UrbanDictionary.com definitions."
+  gem.description = "A way of retrieving UrbanDictionary.com definitions. Gives you access to all definitions of a term and associated data."
+  gem.email = "dave.kerr@gmail.com"
+  gem.authors = ["Dave Kerr"]
+  gem.add_dependency 'nokogiri'
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "urbanlexicophile #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/urbanlexicophile/definition.rb

@@ -0,0 +1,11 @@
+class UrbanLexicophile
+  class Definition
+    attr_accessor :upvotes, :downvotes, :title, :definition, :example, :author
+    
+    def score
+      return upvotes-downvotes
+    end
+    
+    
+  end
+end

data/lib/urbanlexicophile/reader.rb

@@ -0,0 +1,119 @@
+require 'open-uri'
+
+class UrbanLexicophile
+  class Reader
+    
+    def lookup_term(term)
+      @address = "http://www.urbandictionary.com/define.php?term="
+      url = @address + term.gsub(" ", "+")
+     
+      definitions = []
+      
+      # perform the search
+       @ng = Nokogiri::HTML(open(url+"&page=1"))
+
+      #determine if search has a defined term
+      if self.term_defined?
+        #get definitions from first page of definitions
+        
+        definitions = get_all_definitions
+        
+        # same again for check for more pages
+        page = 1
+        while @ng.css("a.next_page").count > 0
+          page += 1
+          @ng = Nokogiri::HTML(open(url+"&page=#{page.to_s}"))
+          definitions += get_all_definitions
+        end
+      end     
+      
+
+      
+      return definitions
+    end
+    
+    def get_all_definitions
+
+      table = @ng.css("#entries")
+      
+      # a definition takes up at least 2 <tr> and has no semantic separator between definitions
+      # to make it even harder, some definitions have more than 2 <tr>s
+      # this is a best attempt at discovering definitions, and passing them to get_one_definition for parsing
+      
+      finished_definitions = []
+      definition_in_progress = []
+      
+      table.css("tr").each do |row|
+        
+        # check if the row is an index. If it is, clear out the in_progress definition and parese the first line
+        if is_index_row? row
+          definition_in_progress = []
+          definition_in_progress << parse_title_row(row)
+
+        elsif is_definition_row? row
+          definition_in_progress << parse_definition_row(row)
+          finished_definitions << build_definition_object(definition_in_progress)
+
+        end
+        
+      end
+      
+      return finished_definitions # should be an array of complete Definition objects
+       
+    end
+    
+    
+    def term_defined?
+      if @ng.css("#not_defined_yet").count > 1
+        return false 
+      else
+        return true
+      end
+    end
+    
+    def is_index_row?(row)
+      if row.css("td.index").count > 0
+        return true 
+      else
+        return false
+      end
+    end
+    
+    def is_definition_row?(row)
+      if row.css("div.definition").count > 0
+        return true
+      else
+        return false
+      end
+    end
+    
+    def parse_title_row(row)
+      
+      title = row.css(".word").first.content.to_s.strip
+      return {:title => title}
+    end
+    
+    def parse_definition_row(row)
+      
+      definition = row.css(".definition").first.content.to_s.strip
+      example = row.css(".example").first.content.to_s.strip
+      author = row.css(".greenery a.author").first.content.to_s.strip
+      
+      return {:definition => definition, :example => example, :author => author}
+    end
+    
+    def build_definition_object(def_array)
+      title_details = def_array.first
+      definition_details = def_array.last
+      
+      definition = Definition.new
+      definition.title = title_details[:title]
+      definition.author = definition_details[:author]
+      definition.definition = definition_details[:definition]
+      definition.example = definition_details[:example]
+      
+      return definition
+    end
+    
+  end
+end

data/lib/urbanlexicophile.rb

@@ -0,0 +1,20 @@
+require 'nokogiri'
+require File.expand_path('../urbanlexicophile/definition', __FILE__)
+require File.expand_path('../urbanlexicophile/reader', __FILE__)
+
+class UrbanLexicophile
+   module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+  
+  def self.define(term)
+    reader = UrbanLexicophile::Reader.new
+    definitions = reader.lookup_term(term)
+    return definitions
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'urbanlexicophile'
+
+class Test::Unit::TestCase
+end

data/test/test_urbanlexicophile.rb

@@ -0,0 +1,30 @@
+require 'helper'
+
+class TestUrbanLexicophile < Test::Unit::TestCase
+  should "define() should return an array of definitions" do
+    a = UrbanLexicophile.define("lol")
+    unless a.is_a?(Array) && a.first.is_a?(UrbanLexicophile::Definition)
+      flunk "Returned value is not an array"
+    end
+  end
+  
+  should "non existing definitions should be handled gracefully" do
+    begin 
+      UrbanLexicophile.define("dfgsf nwe ask2j 9")
+    rescue
+      flunk "Yeah, that's broke"
+    end
+  end
+  
+  should "everything should just work " do
+    begin
+      a = UrbanLexicophile.define("okay")
+      puts "Definition for #{a.first.title}:"
+      puts "\t #{a.first.definition}"
+      puts "\t Usage: #{a.first.example}"
+      puts "\t Author: #{a.first.author}"
+    rescue
+      flunk "Something is broken :("
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: urbanlexicophile
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dave Kerr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70133494235960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70133494235960
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70133494221460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133494221460
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70133494217180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70133494217180
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70133494206060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70133494206060
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70133494195220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133494195220
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70133494100120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70133494100120
+description: A way of retrieving UrbanDictionary.com definitions. Gives you access
+  to all definitions of a term and associated data.
+email: dave.kerr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/urbanlexicophile.rb
+- lib/urbanlexicophile/definition.rb
+- lib/urbanlexicophile/reader.rb
+- test/helper.rb
+- test/test_urbanlexicophile.rb
+homepage: http://github.com/DaveKerr/urbanlexicophile
+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: -574315987937456029
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A way of retrieving UrbanDictionary.com definitions.
+test_files: []