An API for Urban Dictionary.
Ruby CSS HTML
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
helpers
public/stylesheets
scrapers
spec
views
.coveralls.yml
.ruby-version
.travis.yml
CHANGELOG.md
Gemfile
Gemfile.lock
LICENSE
Procfile
README.md
Rakefile
app.rb

README.md

urbanscraper

Build Status Code Climate Test Coverage Dependency Status

Urban Dictionary is great. But, it's missing an API. So, this provides one.

This was originally built to provide a data source for a an extension to the Mac quick launch tool, Alfred. It allowed you to request a definition which would then be returned back to you. Alfred 2 changed the way extensions worked, and so UrbanScraper gained a few new methods, allowing the workflow to give 'live' results.

The live version is hosted on Heroku. It's a simple Sinatra application, using Nokogiri for HTML/XML parsing. MiniTest and VCR are used for testing and mocking web requests respectively.

Usage

It is targeted against Ruby 2.0. You'll also need Bundler.

bundle install
bundle exec ruby app.rb

Tests can be run using rake:

rake test

License

Copyright (c) 2011 Nick Charlton. Code under the MIT license.

The content you access is under the conditions of the Urban Dictionary's Terms of Service and owned by those who submitted it.