DroneApi
Library to access the DroneApi API
Installation
Add this line to your application's Gemfile:
gem 'drone_api'
And then execute:
$ bundle
Or install it yourself as:
$ gem install drone_api
Usage
First, you need a Client
require 'drone_api' client = DroneApi::Client.new
You can also call DroneApi.new:
require 'drone_api' client = DroneApi.new
If you just want all of the strikes:
strikes = client.all
It is an array of Strike instances.
In order to find a specific strike, you can pass in the number.
strike = client.find 1
This will return a single strike (or nil, if nothing is found). You can also pass in an attribute name and value, and it will return a list containing all strikes matching that parameter.
x = c.find :bureau_id => 'YEM001' # Returns an array of 1 element six_deaths = c.find :deaths => 6
There are some find_by_X methods. They are based on the attribute names of the Strike class. (If you're familiar with Rails, think model find methods). The following are equal to the examples above:
x = c.find_by_bureau_id 'YEM001' six_deaths = c.find_by_deaths 6
One think to keep in mind. All these finders return an array except find_by_number. This returns a single instance, just as Client.find does.
The finder methods are:
- find_by_X(value) - Find all where X equals value
- find_X_gte - Finds all where X is greater than [or equal to] value.
- find_X_lte - Finds all where X is less than [or equal to] value.
- find_X_btwn(low, high) - Finds all where X is between low and high.
Contributing
I'm open to all suggestions.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request