Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 82 lines (50 sloc) 3.668 kB
4e36d24 @jsmestad updated readme
authored
1 = pivotal-tracker.rb
2
3 Ruby wrapper for Pivotal Tracker API, no frameworks required. Simply Ruby.
4
91d28ab @tomazy Added Travis CI build status image
tomazy authored
5 {<img src="https://secure.travis-ci.org/jsmestad/pivotal-tracker.png" />}[http://travis-ci.org/jsmestad/pivotal-tracker]
6
aa41646 @jsmestad updated README
authored
7 == Features
8
9 * Compatible with Pivotal Tracker API version 3
10 * ActiveRecord-style Wrapper API
11 * Support for SSL protected repositories
12
13 == Overview
14
15 PivotalTracker::Client.token('myusername@email.com', 'secretpassword') # Automatically fetch API Token
16 PivotalTracker::Client.token = 'jkfduisj97823974j2kl24899234' # Manually set API Token
a72d6c3 Added upload_attachment method to Story
Jon Mischo authored
17
aa41646 @jsmestad updated README
authored
18 @projects = PivotalTracker::Project.all # return all projects
edd20b7 @jsmestad fix typo in find since it takes integers not strings, updated readme …
authored
19 @a_project = PivotalTracker::Project.find(84739) # find project with a given ID
a72d6c3 Added upload_attachment method to Story
Jon Mischo authored
20
aa41646 @jsmestad updated README
authored
21 @a_project.stories.all # return all stories for "a_project"
22 @a_project.stories.all(:label => 'overdue', :story_type => ['bug', 'chore']) # return all stories that match the passed filters
edd20b7 @jsmestad fix typo in find since it takes integers not strings, updated readme …
authored
23 @a_project.stories.find(847762630) # find story with a given ID
a72d6c3 Added upload_attachment method to Story
Jon Mischo authored
24
edd20b7 @jsmestad fix typo in find since it takes integers not strings, updated readme …
authored
25 @a_project.stories.create(:name => 'My Story', :story_type => 'feature') # create a story for this project
26
ffc8342 Added and corrected examples in README.rdoc
Jon Mischo authored
27 # all tracker defined filters are allowed, as well as :limit & :offset for pagination
28
29 # The below pattern below is planned to be added to the final release:
30
31 @a_project.stories << PivotalTracker::Story.new(84739, :name => 'Ur Story') # same as earlier story creation, useful for copying/cloning from proj
32
33
08473fc De-tabbed code and updated docs.
leon authored
34 @story = @a_project.stories.find(847762630)
35 @story.notes.all # return all notes (comments) for a story
ffc8342 Added and corrected examples in README.rdoc
Jon Mischo authored
36 @story.notes.create(:text => 'A new comment', :noted_at => '06/29/2010 05:00 EST') # add a new note
37
a72d6c3 Added upload_attachment method to Story
Jon Mischo authored
38
b6a9807 Added usage info for attachments
Jon Mischo authored
39 @story.attachments # return an array of all attachment items (data only, not the files)
a72d6c3 Added upload_attachment method to Story
Jon Mischo authored
40 @story.upload_attachment(file_path) # add a file attachment to @story that can be found at file_path
08473fc De-tabbed code and updated docs.
leon authored
41
aa41646 @jsmestad updated README
authored
42
ffc8342 Added and corrected examples in README.rdoc
Jon Mischo authored
43 # All 4 examples below return a PivotalTracker::Story from the new project, with the same story ID
44
45 @story.move_to_project(123456) # move @story to the project with ID 123456
46 @story.move_to_project('123456') # same as above
47 @story.move_to_project(@project) # move @story to @project
48 @story.move_to_project(@another_story) # move @story into the same project as @another_story
2dd38f5 @jsmestad update README to reflect non-working feature
authored
49
50
96f953c @tomazy Updates README.rdoc (tracker_host)
tomazy authored
51 # Connect to custom API endpoint
52 PivotalTracker::Client.tracker_host = 'www.my-pivotal-tracker.com'
2dd38f5 @jsmestad update README to reflect non-working feature
authored
53
aa41646 @jsmestad updated README
authored
54 The API is based on the following this gist: http://gist.github.com/283120
894331d @jsmestad updated README for rdoc.info link
authored
55
4e36d24 @jsmestad updated readme
authored
56 == Getting Started
57
58 * Installing:
59
0554b63 @jsmestad missed indentation
authored
60 $ gem install pivotal-tracker
4e36d24 @jsmestad updated readme
authored
61
aa41646 @jsmestad updated README
authored
62 * Contributing (requires Bundler >= 0.9.7):
4e36d24 @jsmestad updated readme
authored
63
0554b63 @jsmestad missed indentation
authored
64 $ git clone git://github.com/jsmestad/pivotal-tracker
65 $ cd pivotal-tracker
aa41646 @jsmestad updated README
authored
66 $ bundle install
67 $ bundle exec rake
a72d6c3 Added upload_attachment method to Story
Jon Mischo authored
68
aa41646 @jsmestad updated README
authored
69 == Additional Information
1e83416 @jsmestad rdoc formatting
authored
70
888ff12 @supertaz Updated README with more information
supertaz authored
71 * Wiki: http://wiki.github.com/jsmestad/pivotal-tracker
72 * Documentation: http://rdoc.info/projects/jsmestad/pivotal-tracker
73 * Pivotal API v3 Docs: http://www.pivotaltracker.com/help/api?version=v3
1e83416 @jsmestad rdoc formatting
authored
74
6af5096 @supertaz Fixed a problem in Story.initialize and now all tests pass
supertaz authored
75 == Contributors along the way
1e83416 @jsmestad rdoc formatting
authored
76
0554b63 @jsmestad missed indentation
authored
77 * Justin Smestad (http://github.com/jsmestad)
1e83416 @jsmestad rdoc formatting
authored
78 * Josh Nichols (http://github.com/technicalpickles)
edd20b7 @jsmestad fix typo in find since it takes integers not strings, updated readme …
authored
79 * Terence Lee (http://github.com/hone)
a72d6c3 Added upload_attachment method to Story
Jon Mischo authored
80 * Jon Mischo (http://github.com/supertaz)
888ff12 @supertaz Updated README with more information
supertaz authored
81 * Gabor Ratky (http://github.com/rgabo)
Something went wrong with that request. Please try again.