/scoutie

Easy to use rake task to check JSON API calls

Primary LanguageRubyMIT LicenseMIT

Scoutie

A rake task to check the status code of a JSON request

alt tag

Installation

Add this line to your application's Gemfile:

gem 'scoutie'

And then execute:

$ bundle

Or install it yourself as:

$ gem install scoutie

Usage

Have a JSON API you want to test as you're coding along?

Simply run:

$ rake scoutie[url]

and Scoutie will return a response code and recommendation on proceeding.

Examples

$ rake scoutie["http://jsonip.com"]                                                                                                                                          ⏎ ✱ ◼
Response: 200
Sweet! You're golden to use that API.

$ rake scoutie["https://www.yammer.com/api/v1/subscriptions/to_user/:id.json"]                                                                                                 ✱ ◼
Response: 401
Nice try! Someone is missing an authorization token.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/scoutie/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request