PivotalApi
This gem allows you to easily use the Pivotal Tracker v5 API.
It’s powered by Faraday and Virtus.
Installation
Add this line to your application's Gemfile:
gem 'pivotal-api', '~> 0.3.0'And then execute:
$ bundle installOr install it yourself as:
$ gem install pivotal-apiBasic Usage
client = PivotalApi::Client.new(token: 'my-api-token') # Create API client
user_email = client.me.email # Get authenticated user's email
require 'pivotal-api'
require 'awesome_print'
client = PivotalApi::Client.new token: ENV['PIVOTAL_TRACKER_API_KEY']
projects = client.projects.all # Get all projects
project = client.projects.get(123456) # Find project with given ID
client.projects.stories.all 12345 # Get all stories for a project
client.projects.stories.all 12345, with_state: :unscheduled, limit: 10 # Get 10 unscheduled stories for a project
client.projects.stories.all 12345, filter: 'requester:OWK label:"jedi stuff"' # Get all stories that match the given filters
client.projects.stories.get 12345, 847762630 # Find a story with the given ID
client.projects.stories.create 12345, name: 'Destroy death star' # Create a story with the name 'Destroy death star'
client.projects.stories.get 12345, 4235423
client.projects.stories.tasks.all 12345, 85721980
client.projects.stories.tasks.get 12345, 85721980, 28279392
client.projects.memberships.all 12345
client.projects.memberships.get 12345, 5015540
client.projects.iterations.all 12345
epics = client.projects.epics.all 12345 # Get all epics for a project
epic = epics.first
epic = client.projects.epics.get 12345, 1603542
label = epic.label # Get an epic's labelContributing
Currently this client supports read-only access to Pivotal Tracker. We will be extending it as our use cases require, but are always happy to accept contributions.
- Fork it
- 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 new Pull Request