pivotal_tracker 0.2.1 → 0.3.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = pivotal_tracker
 
-This is a simple ruby wrapper for the Pivotal Tracker V2 API utilizing HTTParty and Crack::XML.
+This is a simple ruby wrapper for the Pivotal Tracker V3 API utilizing HTTParty and Crack::XML.
 
 == Setup
 
@@ -27,8 +27,8 @@ Notice that all data returned is parsed and built into Mash objects/arrays for y
   
 == Currently implemented methods (More to come!)
 
-* get_all_activities 
-* get_all_project_activities(project_id)
+* get_all_activities(options = {}) 
+* get_all_project_activities(project_id, options = {})
 * get_all_projects
 * get_project(project_id)
 * create_project(name, options = {})
@@ -36,8 +36,18 @@ Notice that all data returned is parsed and built into Mash objects/arrays for y
 * get_project_membership(project_id, membership_id)
 * add_project_membership(project_id, role, email, options = {})
 * remove_project_membership(project_id, membership_id)
-* get_all_project_iterations(project_id)
-* get_all_project_stories(project_id)
+* get_all_project_iterations(project_id, options = {})
+* get_all_project_stories(project_id, options = {})
+  * Filter by passing in a filter hash: 
+    {:filter => {:type => "bug", :id => "1,2,5"}}
+  * Read more on filtering here: http://www.pivotaltracker.com/help#howcanasearchberefined
+* add_project_story(project_id, story)
+* update_project_story(project_id, story_id, story)
+* delete_project_story(project_id, story_id)
+* add_project_story_note(project_id, story_id, text)
+* move_project_story(project_id, story_id, direction, target_story_id)
+  * direction can be either "before" or "after"
+
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "pivotal_tracker"
-    gem.summary = %Q{Ruby wrapper for the Pivotal Tracker V2 API}
+    gem.summary = %Q{Ruby wrapper for the Pivotal Tracker V3 API}
     gem.email = "joslyn.esser@gmail.com"
     gem.homepage = "http://github.com/joslynesser/pivotal_tracker"
     gem.authors = ["Joslyn Esser"]

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/pivotal_tracker.rb

@@ -10,17 +10,17 @@ class PivotalTracker
   def initialize(api_token, options = {})
     self.class.headers 'X-TrackerToken' => api_token
     use_ssl = options.delete(:ssl)
-    self.class.base_uri "http#{'s' if use_ssl}://www.pivotaltracker.com/services/v2"
+    self.class.base_uri "http#{'s' if use_ssl}://www.pivotaltracker.com/services/v3"
   end
   
-  def get_all_activities
-    response = self.class.get("/activities")
+  def get_all_activities(options = {})
+    response = self.class.get("/activities", :query => options)
     raise_errors(response)
     parse_response(response, 'activities')
   end
   
-  def get_all_project_activities(project_id)
-    response = self.class.get("/projects/#{project_id}/activities")
+  def get_all_project_activities(project_id, options = {})
+    response = self.class.get("/projects/#{project_id}/activities", :query => options)
     raise_errors(response)
     parse_response(response, 'activities')
   end
@@ -67,17 +67,51 @@ class PivotalTracker
     parse_response(response, 'membership')
   end
   
-  def get_all_project_iterations(project_id)
-    response = self.class.get("/projects/#{project_id}/iterations")
+  def get_all_project_iterations(project_id, options = {})
+    response = self.class.get("/projects/#{project_id}/iterations", :query => options)
     raise_errors(response)
     parse_response(response, 'iterations')
   end
   
-  def get_all_project_stories(project_id)
-    response = self.class.get("/projects/#{project_id}/stories")
+  def get_all_project_stories(project_id, options = {})
+    if options[:filter]
+      options[:filter] = options[:filter].inject([]) {|f,(key,value)| f << "#{key}:#{value}"}.join(' ')
+    end
+
+    response = self.class.get("/projects/#{project_id}/stories", :query => options)
     raise_errors(response)
     parse_response(response, 'stories')
   end
+
+  def add_project_story(project_id, story)
+    response = self.class.post("/projects/#{project_id}/stories", :body => {:story => story})
+    raise_errors(response)
+    parse_response(response, 'story')
+  end
+
+  def update_project_story(project_id, story_id, story)
+    response = self.class.put("/projects/#{project_id}/stories/#{story_id}", :body => {:story => story})
+    raise_errors(response)
+    parse_response(response, 'story')
+  end
+
+  def delete_project_story(project_id, story_id)
+    response = self.class.delete("/projects/#{project_id}/stories/#{story_id}")
+    raise_errors(response)
+    parse_response(response, 'story')
+  end
+
+  def add_project_story_note(project_id, story_id, text)
+    response = self.class.post("/projects/#{project_id}/stories/#{story_id}/notes", :body => {:note => {:text => text}})
+    raise_errors(response)
+    parse_response(response, 'note')
+  end
+  
+  def move_project_story(project_id, story_id, direction, target_story_id)
+    response = self.class.post("/projects/#{project_id}/stories/#{story_id}/moves", :body => {:move => {:move => direction, :target => target_story_id}})
+    raise_errors(response)
+    parse_response(response, 'story')
+  end
     
   private
   
@@ -91,8 +125,10 @@ class PivotalTracker
           raise PivotalTracker::General, "(#{response.code}): #{response.message}"
         when 404
           raise PivotalTracker::ResourceNotFound, "(#{response.code}): #{response.message}"
+        when 422
+          raise PivotalTracker::ResourceInvalid, "(#{response.code}): #{response['errors'].inspect if response['errors']}"
         when 500
-          raise PivotalTracker::InformPivotal, "Pivotal Tracker had an internal error. Please let them know. (#{response.code}): #{response.message}"
+          raise PivotalTracker::InformPivotal, "Pivotal Tracker had an internal error. Please let them know. (#{response.code}): #{response.message} - #{response['message'] if response}"
         when 502..503
           raise PivotalTracker::Unavailable, "(#{response.code}): #{response.message}"
       end

data/lib/pivotal_tracker/error.rb

@@ -13,4 +13,5 @@ class PivotalTracker::Unauthorized      < PivotalTracker::Error; end
 class PivotalTracker::General           < StandardError; end
 class PivotalTracker::Unavailable       < StandardError; end
 class PivotalTracker::InformPivotal     < StandardError; end
-class PivotalTracker::ResourceNotFound  < StandardError; end
+class PivotalTracker::ResourceNotFound  < StandardError; end
+class PivotalTracker::ResourceInvalid  < StandardError; end

data/pivotal_tracker.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pivotal_tracker}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joslyn Esser"]
-  s.date = %q{2009-12-04}
+  s.date = %q{2010-02-05}
   s.email = %q{joslyn.esser@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "spec/fixtures/iterations.xml",
      "spec/fixtures/membership.xml",
      "spec/fixtures/memberships.xml",
+     "spec/fixtures/note.xml",
      "spec/fixtures/project.xml",
      "spec/fixtures/projects.xml",
      "spec/fixtures/stories.xml",
@@ -41,7 +42,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Ruby wrapper for the Pivotal Tracker V2 API}
+  s.summary = %q{Ruby wrapper for the Pivotal Tracker V3 API}
   s.test_files = [
     "spec/pivotal_tracker_spec.rb",
      "spec/spec_helper.rb"

data/spec/fixtures/activities.xml

@@ -2,18 +2,38 @@
 <activities type="array">
   <activity>
     <id type="integer">1031</id>
-    <project>Sample Project</project>
-    <story>More power to shields</story>
+    <version type="integer">175</version>
+    <event_type>story_update</event_type>
+    <occurred_at type="datetime">2009/12/14 14:12:09 PST</occurred_at>
+    <author>James Kirk</author>
+    <project_id type="integer">26</project_id>
     <description>James Kirk accepted &quot;More power to shields&quot;</description>
-    <author>James Kirk </author>
-    <when>06/01/2009 08:22 AM</when>
+    <stories>
+      <story>
+        <id type="integer">109</id>
+        <url>https://www.pivotaltracker.com/services/v3/projects/26/stories/109</url>
+        <lighthouse_id>43</lighthouse_id>
+        <lighthouse_url>http://mylighthouseapp.com/projects/100/tickets/43</lighthouse_url>
+        <accepted_at type="datetime">2009/12/14 22:12:09 UTC</accepted_at>
+        <current_state>accepted</current_state>
+      </story>
+    </stories>
   </activity>
   <activity>
     <id type="integer">1030</id>
-    <project>Another Sample Project</project>
-    <story>Warp speed</story>
-    <description>Montgomery Scott rejected &quot;Warp speend&quot; with comments: &quot;Warp speed isn't working&quot;</description>
+    <version type="integer">175</version>
+    <event_type>story_update</event_type>
+    <occurred_at type="datetime">2009/12/14 14:12:09 PST</occurred_at>
     <author>Montgomery Scott</author>
-    <when>06/01/2009 12:22 AM</when>
+    <project_id type="integer">28</project_id>
+    <description>Montgomery Scott rejected &quot;Warp speed&quot; with comments: &quot;Warp speed isn't working&quot;</description>
+    <stories>
+      <story>
+        <id type="integer">119</id>
+        <url>https://www.pivotaltracker.com/services/v3/projects/28/stories/119</url>
+        <accepted_at type="datetime">2009/12/14 22:12:09 UTC</accepted_at>
+        <current_state>rejected</current_state>
+      </story>
+    </stories>
   </activity>
 </activities>

data/spec/fixtures/note.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<note>
+  <id type="integer">42</id>
+  <text>new note via API</text>
+  <author>Spock (young)</author>
+  <noted_at type="datetime">2009/01/16 18:53:51 UTC</noted_at>
+</note>

data/spec/fixtures/project.xml

@@ -1,18 +1,38 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project>
-  <id>27</id>
-  <name>Cardassian War Plans</name>
+  <id>1</id>
+  <name>Sample Project</name>
   <iteration_length type="integer">2</iteration_length>
   <week_start_day>Monday</week_start_day>
   <point_scale>0,1,2,3</point_scale>
+  <account>James Kirks Account</account>
   <velocity_scheme>Average of 4 iterations</velocity_scheme>
+  <current_velocity>10</current_velocity>
   <initial_velocity>10</initial_velocity>
   <number_of_done_iterations_to_show>12</number_of_done_iterations_to_show>
+  <labels>shields,transporter</labels>
   <allow_attachments>true</allow_attachments>
   <public>false</public>
   <use_https>true</use_https>
   <bugs_and_chores_are_estimatable>false</bugs_and_chores_are_estimatable>
   <commit_mode>false</commit_mode>
+  <last_activity_at type="datetime">2010/01/16 17:39:10 CST</last_activity_at>
   <memberships>
+    <membership>
+      <id>1006</id>
+      <person>
+        <email>kirkybaby@earth.ufp</email>
+        <name>James T. Kirk</name>
+        <initials>JTK</initials>
+      </person>
+      <role>Owner</role>
+    </membership>
   </memberships>
-</project>
+  <integrations>
+    <integration>
+      <id>4532</id>
+      <title>Lighthouse Sample Integration</title>
+      <active type="boolean">true</active>
+    </integration>
+  </integrations>
+</project>

data/spec/pivotal_tracker_spec.rb

@@ -35,11 +35,23 @@ describe PivotalTracker do
         activities.first.description.should == "James Kirk accepted \"More power to shields\""
       end
       
+      it "should filter recent activities" do
+        stub_get('/activities?newer_than_version=170', 'activities.xml')
+        activities = @tracker.get_all_activities(:newer_than_version => 170)
+        activities.first.description.should == "James Kirk accepted \"More power to shields\""
+      end
+      
       it "should get all recent activities for a given project" do
         stub_get('/projects/1/activities', 'activities.xml')
         activities = @tracker.get_all_project_activities(1)
         activities.first.description.should == "James Kirk accepted \"More power to shields\""
       end
+      
+      it "should filter recent activities for a given project" do
+        stub_get('/projects/1/activities?limit=50', 'activities.xml')
+        activities = @tracker.get_all_project_activities(1, :limit => 50)
+        activities.first.description.should == "James Kirk accepted \"More power to shields\""
+      end
     end
     
     describe "Projects" do
@@ -53,13 +65,19 @@ describe PivotalTracker do
       it "should get a project" do
         stub_get("/projects/27", 'project.xml')
         project = @tracker.get_project(27)
-        project.name.should == 'Cardassian War Plans'
+        project.name.should == 'Sample Project'
       end
       
       it "should create a project" do
         stub_post('/projects', 'project.xml')
         project = @tracker.create_project('Cardassian War Plans')
-        project.name.should == 'Cardassian War Plans'
+        project.name.should == 'Sample Project'
+      end
+      
+      it "should create a project with options" do
+        stub_post('/projects', 'project.xml')
+        project = @tracker.create_project('Cardassian War Plans', :no_owner => true)
+        project.name.should == 'Sample Project'
       end
     end
   
@@ -101,7 +119,9 @@ describe PivotalTracker do
       end
       
       it "should get iterations by limit and offset" do
-        pending
+        stub_get('/projects/1/iterations?offset=1&limit=2', 'iterations.xml')
+        iterations = @tracker.get_all_project_iterations(1, :offset => 1, :limit => 2)
+        iterations.first.stories.first.story_type.should == 'feature'
       end
     end
     
@@ -112,16 +132,46 @@ describe PivotalTracker do
         stories.first.owned_by.should == 'Montgomery Scott'
       end
       
-      it "should get all stories for a project based on a given filter" do
-        pending
+      it "should get all stories for a project based on a given filter hash" do
+        stub_get("/projects/1/stories\?filter=type%3Afeature", 'stories.xml')
+        stories = @tracker.get_all_project_stories(1, :filter => {:type => 'feature'})
+        stories.first.owned_by.should == 'Montgomery Scott'
       end
       
       it "should get all stories for a project paginated by a limit and offset" do
-        pending
+        stub_get("/projects/1/stories\?limit=10&offset=20", 'stories.xml')
+        stories = @tracker.get_all_project_stories(1, :limit => 10, :offset => 20)
+        stories.first.owned_by.should == 'Montgomery Scott'
       end
       
       it "should create a new story for a given project" do
-        pending
+        stub_post('/projects/1/stories', 'story.xml')
+        story = @tracker.add_project_story(1, {})
+        story.name.should == 'Fire torpedoes'
+      end
+
+      it "should update an existing story for a given project and story" do
+        stub_put('/projects/1/stories/12', 'story.xml')
+        story = @tracker.update_project_story(1, 12, :name => "Fire torpedoes")
+        story.name.should == 'Fire torpedoes'
+      end
+
+      it "removes an existing story for a given project" do
+        stub_delete('/projects/1/stories/12', 'story.xml')
+        story = @tracker.delete_project_story(1, 12)
+        story.name.should == 'Fire torpedoes'
+      end
+
+      it "should create a new note for a given project and story" do
+        stub_post('/projects/1234/stories/5678/notes', 'note.xml')
+        note = @tracker.add_project_story_note(1234, 5678, 'new note via API')
+        note.text.should == 'new note via API'
+      end
+      
+      it "should move a story before or after another story" do
+        stub_post('/projects/1/stories/1234/moves', 'story.xml')
+        story = @tracker.move_project_story(1, 1234, "after", 5678)
+        story.name.should == 'Fire torpedoes'
       end
     end
   end

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ require 'fakeweb'
 require 'ruby-debug'
 
 Spec::Runner.configure do |config|
-  
+  config.before(:each) { FakeWeb.clean_registry }
 end
 
 FakeWeb.allow_net_connect = false
@@ -21,7 +21,7 @@ def fixture_file(filename)
 end
 
 def pivotal_tracker_url(url)
-  url =~ /^http/ ? url : "http://www.pivotaltracker.com/services/v2#{url}"
+  url =~ /^http/ ? url : "http://www.pivotaltracker.com/services/v3#{url}"
 end
  
 def stub_get(url, filename, status=nil)
@@ -41,4 +41,4 @@ end
  
 def stub_delete(url, filename)
   FakeWeb.register_uri(:delete, pivotal_tracker_url(url), :body => fixture_file(filename))
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pivotal_tracker
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Joslyn Esser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-04 00:00:00 -08:00
+date: 2010-02-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -75,6 +75,7 @@ files:
 - spec/fixtures/iterations.xml
 - spec/fixtures/membership.xml
 - spec/fixtures/memberships.xml
+- spec/fixtures/note.xml
 - spec/fixtures/project.xml
 - spec/fixtures/projects.xml
 - spec/fixtures/stories.xml
@@ -109,7 +110,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Ruby wrapper for the Pivotal Tracker V2 API
+summary: Ruby wrapper for the Pivotal Tracker V3 API
 test_files: 
 - spec/pivotal_tracker_spec.rb
 - spec/spec_helper.rb