ybur-yug/nerd_apis

An unofficial collection of API's for nerdy sites

Unofficial Nerd APIs

In the Wild

The example application in the example_app directory hits all 3 of these API's locally and displays the link. There is a tutorial on getting the basic functionality included in the README. In order to just get it to run, do the following:

bundle

bundle exec volt s

And navigate to localhost:3000

Structure

lib/scraper.rb

This is intended to incapsulate the scraper for each site being API-ified

lib/apis.rb

The module containing each individual API. The goal of this module/its classes is to have a minimal LOC setup for the APIs made.

lib/stories.rb

This wraps the JSON that we hope to return in a Rubyish OO manner for maximum separation from the business logic of the scraping operations performed

server.rb

This contains the server itself, a simple sinatra/rack application

Routes

/lobsters/frontpage/:page GET

/lobsters/recent/:page GET

/proggit GET

/datatau GET

/reddit GET

Usage

$ bundle install #in route directory
$ cd example_app
$ bundle

Now that you have bundle installed both applications, start the sinatra server and the volt server:

$ bundle exec ruby server.rb
$ cd example_app
$ bundle exec volt s

Todos

• Better response codes + routing/error handling
• Utilize Mechanize's cookie jar to get the cookie that can filter displayed stories
• View comments
• Allow user login and profile updating
• Mock tests with VCR or webmock (simpler alternative)
• (and much more)

Contributing

1. Fork, and make a branch
2. Code!
3. Test!
4. PR!