gsa_auctions

GsaAuctions

Ruby access to the GSA Auctions API.

From http://gsa.github.io/auctions_api:

The Auctions API is a GET API which has currently one operation. The operation will retrieve GSA Auctions, auctions data.

A couple basic notes: The rate limits for the API are currently 5,000 calls/day and 5 calls per 5 seconds. As we go forward and understand the impact of usage of the API, we will adjust the limits accordingly as well as allow for individual users with specific needs to have customized rate limits appropriate to their use.

You can get a free API key at https://api.data.gov/signup/.

Installation

Add this line to your application's Gemfile:

gem 'gsa_auctions'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gsa_auctions

Usage

client = GsaAuctions::Client.new(api_key: GsaAuctions::Protocol::DEMO_KEY)
response = client.get_api(format: 'xml')

# do something with response.body

Contributing

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

Testing

$ rspec spec

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.