Dealmap

Simple Ruby wrapper for the Dealmap API. TheDealMap features deals aggregated from a number of sources, includng Groupon, LivingSocial, Restaurants.com, and more.

Installation

sudo gem install dealmap

Usage

You'll need a Dealmap API key.

Instantiate

require 'dealmap'
client = Dealmap::Client.new(YOUR_API_KEY)

Searching for deals in Brooklyn, NY

deals, total = client.search_deals(:l => "Brooklyn, NY")

Searching for deals in Brooklyn, NY, return 100 results.

deals, total = client.search_deals(:l => "Brooklyn, NY", :ps => 100)

Searching for beer deals in Brooklyn, NY, return 100 results.

deals, total = client.search_deals(:l => "Brooklyn, NY", :ps => 100, :q => "beer")

Searching for beer deals within 10 miles of Brooklyn, NY, return 100 results.

deals, total = client.search_deals(:l => "Brooklyn, NY", :ps => 100, :q => "beer", :d => 10)

Searching for deals based on lat/lng (Brooklyn, NY)

deals, total = client.search_deals(:l => "40.6500000, -73.9500000")

Get deal details

deal = client.deal_details(DEAL_ID)

Dealmap uses a Hashie::Mash for return values, providing a handy hash that supports dot notation:

deal.title
=> "$100 Gift Certificate, Your Price $40"
deal.city
=> "Brooklyn"

Issues

GitHub issue tracking sucks. Submit issues to Lighthouse

Changelog

0.0.3 - March 13, 2011

Initial version

0.0.4 - March 13, 2011

Documentation update

Under the hood

Faraday REST client
Typhoeus HTTP library
Hashie::Mash Magic

How to contribute

Fork the project.
Make your feature addition or bug fix.
Add tests for it. This is important so I don't break it in a future version unintentionally.
Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
Send me a pull request. Bonus points for topic branches.