Ruby interface to urbandictionary.com
HTML Ruby
Latest commit a03678b Feb 23, 2016 @ryangreenberg Release version 1.1.0
Permalink
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.travis.yml
CHANGELOG.md
Gemfile
LICENSE.md
README.md
Rakefile
urban_dictionary.gemspec

README.md

Urban Dictionary

urban_dictionary is a Ruby gem to access word definitions and examples from Urban Dictionary. It also provides a command-line tool for getting definitions.

Build Status

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, or nil if the word is not found. 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

Specify the output format with --format. The default is plain; json is also supported.

> urban_dictionary --format=json one hundred | jq .
{
  "word": "one hundred",
  "entries": [
    {
      "definition": "keepin it real to the fullest and super tight.",
      "example": "end of the convo\nLuke: aight man, peace\nQ: kool homie, keep it one hundred (100)"
    },
    ...
}

Tests

Run examples with:

rspec