urban_dictionary 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in urban_dictionary.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    urban_dictionary (0.0.1)
+      nokogiri (~> 1.5.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    nokogiri (1.5.2)
+    rake (0.9.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.22)
+  rake
+  urban_dictionary!

data/README.md

@@ -0,0 +1,36 @@
+# Urban Dictionary #
+
+`urban_dictionary` is a Ruby gem to access word definitions and examples from [Urban Dictionary](http://www.urbandictionary.com/). It also provides a command-line tool for getting definitions.
+
+## Installation ##
+
+Run `gem install urban_dictionary`.
+
+## Usage ##
+
+Get words using `UrbanDictionary.define` or `UrbanDictionary.random_word`. These methods return an instance of UrbanDictionary::Word, which has a list of entries. Each entry has a definition and an example.
+
+    require 'urban_dictionary'
+
+    word = UrbanDictionary.define("QED")
+    word.entries.size # => 7
+    word.entries.each do |entry|
+      puts entry.definition
+      puts entry.example
+    end
+
+## Command Line ##
+
+The urban_dictionary gem includes a command-line interface:
+
+    > urban_dictionary super salad
+    super salad
+    -----------
+
+    1. A mythical dish of the best salad ever compiled
+    ...
+    ...
+
+You can use the `--random` flag to get the definition of random word:
+
+    > urban_dictionary --random

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/urban_dictionary

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby -KU
+require 'urban_dictionary'
+require 'optparse'
+
+options = {}
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: urban_dictionary <word or phrase>"
+  opts.version = UrbanDictionary::VERSION
+
+  opts.on("-r", "--random", "Define a random word") do |r|
+    options[:random] = r
+  end
+end
+option_parser.parse(ARGV)
+
+if ARGV.empty? && !options[:random]
+  puts option_parser.help
+  exit(0)
+end
+
+word = if options[:random]
+  UrbanDictionary.random_word
+else
+  UrbanDictionary.define(ARGV.join(" "))
+end
+
+output = []
+output << word
+output << '-' * word.size
+output << ''
+word.entries.each_with_index do |entry, i|
+  output << "#{i + 1}. #{entry.definition}"
+  output << ""
+  output << "Example: #{entry.example}"
+  output << ""
+  output << ""
+end
+puts output.join("\n")

data/lib/urban_dictionary/entry.rb

@@ -0,0 +1,14 @@
+module UrbanDictionary
+  class Entry
+    attr_reader :definition, :example
+
+    def initialize(definition, example)
+      @definition = definition
+      @example = example
+    end
+
+    def to_s
+      "#{definition}\n#{example}"
+    end
+  end
+end

data/lib/urban_dictionary/version.rb

@@ -0,0 +1,3 @@
+module UrbanDictionary
+  VERSION = "0.0.1"
+end

data/lib/urban_dictionary/word.rb

@@ -0,0 +1,35 @@
+require 'nokogiri'
+require 'open-uri'
+
+module UrbanDictionary
+  class Word
+    attr_reader :word, :entries
+
+    # Can raise SocketError if unable to connect to specified URL
+    def self.from_url(url)
+      html = open(url).read
+      doc = Nokogiri::HTML(html)
+
+      word = doc.css('.word').first.content.strip
+      definitions = doc.css('.definition').map{|d| d.content.strip }
+      examples = doc.css('.example').map{|e| e.content.strip }
+      entries = definitions.zip(examples).map{|d,e| Entry.new(d, e)}
+
+      Word.new(word, entries)
+    end
+
+    def initialize(word, entries)
+      @word = word
+      @entries = entries
+    end
+
+    def to_s
+      @word
+    end
+
+    def size
+      @word.size
+    end
+    alias :length :size
+  end
+end

data/lib/urban_dictionary.rb

@@ -0,0 +1,25 @@
+require 'uri'
+require 'net/http'
+
+require 'urban_dictionary/version'
+require 'urban_dictionary/word'
+require 'urban_dictionary/entry'
+
+module UrbanDictionary
+  DEFINE_URL = 'http://www.urbandictionary.com/define.php'
+  RANDOM_URL = 'http://www.urbandictionary.com/random.php'
+
+  def self.define(str)
+    Word.from_url("#{DEFINE_URL}?term=#{URI.encode(str)}")
+  end
+
+  def self.random_word
+    url = URI.parse(RANDOM_URL)
+    req = Net::HTTP::Get.new(url.path)
+    rsp = Net::HTTP.start(url.host, url.port) {|http|
+      http.request(req)
+    }
+
+    Word.from_url(rsp['location'])
+  end
+end

data/urban_dictionary.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "urban_dictionary/version"
+
+Gem::Specification.new do |s|
+  s.name        = "urban_dictionary"
+  s.version     = UrbanDictionary::VERSION
+  s.authors     = ["Ryan Greenberg"]
+  s.email       = ["ryangreenberg@gmail.com"]
+  s.homepage    = ""
+  s.summary     = "Interface to urbandictionary.com"
+  s.description = s.summary
+
+  s.rubyforge_project = "urban_dictionary"
+
+  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_runtime_dependency "nokogiri", "~> 1.5.2"
+
+  s.add_development_dependency "bundler", "~> 1.0.22"
+  s.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: urban_dictionary
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryan Greenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id001
+  prerelease: false
+  name: nokogiri
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 1
+        - 0
+        - 22
+        version: 1.0.22
+  requirement: *id002
+  prerelease: false
+  name: bundler
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  prerelease: false
+  name: rake
+  type: :development
+description: Interface to urbandictionary.com
+email: 
+- ryangreenberg@gmail.com
+executables: 
+- urban_dictionary
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/urban_dictionary
+- lib/urban_dictionary.rb
+- lib/urban_dictionary/entry.rb
+- lib/urban_dictionary/version.rb
+- lib/urban_dictionary/word.rb
+- urban_dictionary.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: urban_dictionary
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Interface to urbandictionary.com
+test_files: []
+