Bidsketch
The bidsketch gem is a ruby wrapper for interacting with the Bidsketch API.
Installation
Add this line to your application's Gemfile:
gem 'bidsketch'
And then execute:
$ bundle
Or install it yourself as:
$ gem install bidsketch
Getting Started
You will need a Bidsketch API key. For instructions on finding your API key: http://help.bidsketch.com/article/76-using-the-bidsketch-api
Authentication
Bidsketch.api_key = 'YOUR API KEY'
Alternatively you can set your API key as an environment variable:
ENV['BIDSKETCH_API_KEY'] = 'YOUR API KEY'
Clients
To get all clients:
Bidsketch::Client.all
To get a particular client:
Bidsketch::Client.find(id)
Fees
To get all fees:
Bidsketch::Fee.all
To get a particular fee:
Bidsketch::Fee.find(id)
Proposals
To get all proposals:
Bidsketch::Proposal.all
To get a particular proposal:
Bidsketch::Proposal.find(id)
Sections
To get all sections
Bidsketch::Section.all
To get a particular section:
Bidsketch::Section.find(id)
Templates
To get all templates:
Bidsketch::Template.all
To get a particular template:
Bidsketch::Template.find(id)
Contributing
- Fork it ( https://github.com/citizens/bidsketch-ruby/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