pivotal-tracker-api

A Pivotal Tracker API gem that can be used to interface with the Pivotal Tracker API v5.

Basic Example

# Use your personal Pivotal token
def set_token
  # This will set the @token in the Client class. Class caching must be enabled for the token to persist.
  # config.cache_classes = true
  PivotalAPI::Service.set_token(your_token_here)
end

# Authenticate a user using email / pass
def get_user_token
  email = params[:email]
  pass = params[:pass]
  # This will set the @token in the Client class. Class caching must be enabled for the token to persist.
  # config.cache_classes = true
  token = PivotalAPI::Client.token(email, pass)
  # do something with the token
end

# Get all of the users Projects
def projects
  @projects = PivotalAPI::Service.all_projects(PivotalAPI::Project.fields)
end

# Get only 1 of the users Projects
def project
  @project = PivotalAPI::Service.one_project(params[:project_id], PivotalAPI::Project.fields)
end

# Get a Projects Stories by a specific Label
def stories_by_label
  project_label   = params[:project_label]
  @project_label  = CGI.escape(project_label) if project_label
  @stories = PivotalAPI::Service.all_stories(@project_label, @project, PivotalAPI::Story.fields) if @project_label
end

# Get an Iteration and it's Stories
def get_iteration
  @project_id = params[:project_id]
  @iteration  = PivotalAPI::Service.iterations(@project_id, 'current')
  @stories    = @iteration.stories
end

For additional infomation on how to interface with this gem and use it to communicate with the Pivotal Tracker API v5 see the PivotalAPI::Service class.

Contributing to pivotal-tracker-api

Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
Fork the project.
Start a feature/bugfix branch.
Commit and push until you are happy with your contribution.
Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

pivotal-tracker-api

Basic Example

Contributing to pivotal-tracker-api

Copyright