tsenart-pivotal-tracker 0.4.0

data/lib/pivotal-tracker/story.rb

@@ -0,0 +1,148 @@
+module PivotalTracker
+  class Story
+    include HappyMapper
+
+    class << self
+      def all(project, options={})
+        params = PivotalTracker.encode_options(options)
+        stories = parse(Client.connection["/projects/#{project.id}/stories#{params}"].get)
+        stories.each { |s| s.project_id = project.id }
+        return stories
+      end
+
+      def find(param, project_id)
+        begin
+          story = parse(Client.connection["/projects/#{project_id}/stories/#{param}"].get)
+          story.project_id = project_id
+        rescue RestClient::ExceptionWithResponse
+          story = nil
+        end
+        return story
+      end
+    end
+
+    tag "story"
+
+    element :id, Integer
+    element :url, String
+    element :created_at, DateTime
+    element :accepted_at, DateTime
+    element :project_id, Integer
+
+    element :name, String
+    element :description, String
+    element :story_type, String
+    element :estimate, Integer
+    element :current_state, String
+    element :requested_by, String
+    element :owned_by, String
+    element :labels, String
+    element :jira_id, Integer
+    element :jira_url, String
+    element :other_id, Integer
+    element :integration_id, Integer
+    element :deadline, DateTime # Only available for Release stories
+
+    has_many :attachments, Attachment, :tag => 'attachments'
+
+    def initialize(attributes={})
+      if attributes[:owner]
+        self.project_id = attributes.delete(:owner).id
+      end
+      update_attributes(attributes)
+    end
+
+    def create
+      return self if project_id.nil?
+      response = Client.connection["/projects/#{project_id}/stories"].post(self.to_xml, :content_type => 'application/xml')
+      new_story = Story.parse(response)
+      new_story.project_id = project_id
+      return new_story
+    end
+
+    def update(attrs={})
+      update_attributes(attrs)
+      response = Client.connection["/projects/#{project_id}/stories/#{id}"].put(self.to_xml, :content_type => 'application/xml')
+      return Story.parse(response)
+    end
+
+    def delete
+      Client.connection["/projects/#{project_id}/stories/#{id}"].delete
+    end
+
+    def notes
+      @notes ||= Proxy.new(self, Note)
+    end
+
+    def tasks
+      @tasks ||= Proxy.new(self, Task)
+    end
+
+    def upload_attachment(filename)
+      Attachment.parse(Client.connection["/projects/#{project_id}/stories/#{id}/attachments"].post(:Filedata => File.new(filename)))
+    end
+
+    def move_to_project(new_project)
+      move = true
+      old_project_id = self.project_id
+      target_project = -1
+      case new_project.class.to_s
+        when 'PivotalTracker::Story'
+          target_project = new_project.project_id
+        when 'PivotalTracker::Project'
+          target_project = new_project.id
+        when 'String'
+          target_project = new_project.to_i
+        when 'Fixnum', 'Integer'
+          target_project = new_project
+        else
+          move = false
+      end
+      if move
+        move_builder = Nokogiri::XML::Builder.new do |story|
+          story.story {
+            story.project_id "#{target_project}"
+                  }
+        end
+        Story.parse(Client.connection["/projects/#{old_project_id}/stories/#{id}"].put(move_builder.to_xml, :content_type => 'application/xml'))
+      end
+    end
+
+    protected
+
+      def to_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.story {
+            xml.name "#{name}"
+            xml.description "#{description}"
+            xml.story_type "#{story_type}"
+            xml.estimate "#{estimate}"
+            xml.current_state "#{current_state}"
+            xml.requested_by "#{requested_by}"
+            xml.owned_by "#{owned_by}"
+            xml.labels "#{labels}"
+            xml.project_id "#{project_id}"
+            # See spec
+            # xml.jira_id "#{jira_id}"
+            # xml.jira_url "#{jira_url}"
+            xml.other_id "#{other_id}"
+            xml.integration_id "#{integration_id}"
+            xml.created_at DateTime.parse(created_at.to_s).to_s if created_at
+            xml.accepted_at DateTime.parse(accepted_at.to_s).to_s if accepted_at
+            xml.deadline DateTime.parse(deadline.to_s).to_s if deadline
+          }
+        end
+        return builder.to_xml
+      end
+
+      def update_attributes(attrs)
+        attrs.each do |key, value|
+          self.send("#{key}=", value.is_a?(Array) ? value.join(',') : value )
+        end
+      end
+  end
+
+  class Story
+    include Validation
+  end
+end

data/lib/pivotal-tracker/task.rb

@@ -0,0 +1,53 @@
+module PivotalTracker
+  class Task
+    include HappyMapper
+
+    class << self
+      def all(story, options={})
+        tasks = parse(Client.connection["/projects/#{story.project_id}/stories/#{story.id}/tasks"].get)
+        tasks.each { |t| t.project_id, t.story_id = story.project_id, story.id }
+        return tasks
+      end
+    end
+
+    attr_accessor :project_id, :story_id
+
+    element :id, Integer
+    element :description, String
+    element :position, Integer
+    element :complete, Boolean
+    element :created_at, DateTime
+
+    def create
+      response = Client.connection["/projects/#{project_id}/stories/#{story_id}/tasks"].post(self.to_xml, :content_type => 'application/xml')
+      return Task.parse(response)
+    end
+
+    def update
+      response = Client.connection["/projects/#{project_id}/stories/#{story_id}/tasks/#{id}"].put(self.to_xml, :content_type => 'application/xml')
+      return Task.parse(response)
+    end
+
+    def delete
+      Client.connection["/projects/#{project_id}/stories/#{story_id}/tasks/#{id}"].delete
+    end
+
+    protected
+
+      def to_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.task {
+            xml.description "#{description}"
+            # xml.position "#{position}"
+            xml.complete "#{complete}"
+          }
+        end
+        return builder.to_xml
+      end
+
+  end
+
+  class Task
+    include Validation
+  end
+end

data/lib/pivotal-tracker/validation.rb

@@ -0,0 +1,68 @@
+module PivotalTracker
+
+  class Errors
+    include Enumerable
+    attr_reader :errors
+
+    alias :messages :errors
+
+    def initialize
+      @errors = []
+    end
+
+    def each
+      @errors.each do |error|
+        yield error
+      end
+    end
+
+    def empty?
+      @errors.empty?
+    end
+
+    def add_from_xml(xml)
+      Nokogiri::XML(xml).xpath("/errors/error").each do |error|
+        @errors << error.text
+      end
+    end
+  end
+
+  module Validation
+
+    def self.included(klass)
+      klass.class_eval do
+        if klass.instance_methods.include?(:create)
+          alias_method :create_without_validations, :create
+          alias_method :create, :create_with_validations
+        end
+
+        if klass.instance_methods.include?(:update)
+          alias_method :update_without_validations, :update
+          alias_method :update, :update_with_validations
+        end
+      end
+    end
+
+    def create_with_validations
+      begin
+        create_without_validations
+      rescue RestClient::UnprocessableEntity => e
+        errors.add_from_xml e.response
+        self
+      end
+    end
+
+    def update_with_validations(attrs={})
+      begin
+        update_without_validations attrs
+      rescue RestClient::UnprocessableEntity => e
+        errors.add_from_xml e.response
+        self
+      end
+    end
+
+    def errors
+      @errors ||= Errors.new
+    end
+  end
+end

data/lib/pivotal-tracker.rb

@@ -0,0 +1,40 @@
+require 'cgi'
+require 'rest_client'
+require 'happymapper'
+require 'nokogiri'
+
+
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'validation')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'extensions')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'proxy')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'client')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'project')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'attachment')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'story')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'task')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'membership')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'activity')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'iteration')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'note')
+
+module PivotalTracker
+
+  # define error types
+  class ProjectNotSpecified < StandardError; end
+
+  def self.encode_options(options)
+    options_strings = options.inject({}) do |m, (k,v)|
+      if [:limit, :offset].include?(k.to_sym)
+        m.update k => v
+      elsif k.to_sym == :search
+        m.update :filter => v
+      else
+        filter_query = %{#{k}:#{[v].flatten.join(",")}}
+        m.update :filter => (m[:filter] ? "#{m[:filter]} #{filter_query}" : filter_query)
+      end
+    end.map {|k,v| "#{k}=#{CGI.escape(v.to_s)}"}
+
+    %{?#{options_strings.join("&")}} unless options_strings.empty?
+  end
+
+end

data/lib/pivotal_tracker.rb

@@ -0,0 +1,2 @@
+require "pivotal-tracker"
+

data/pivotal-tracker.gemspec

@@ -0,0 +1,121 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pivotal-tracker}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Justin Smestad}, %q{Josh Nichols}, %q{Terence Lee}]
+  s.date = %q{2011-07-07}
+  s.email = %q{justin.smestad@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/pivotal-tracker.rb",
+     "lib/pivotal-tracker/activity.rb",
+     "lib/pivotal-tracker/attachment.rb",
+     "lib/pivotal-tracker/client.rb",
+     "lib/pivotal-tracker/extensions.rb",
+     "lib/pivotal-tracker/iteration.rb",
+     "lib/pivotal-tracker/membership.rb",
+     "lib/pivotal-tracker/note.rb",
+     "lib/pivotal-tracker/project.rb",
+     "lib/pivotal-tracker/proxy.rb",
+     "lib/pivotal-tracker/story.rb",
+     "lib/pivotal-tracker/task.rb",
+     "lib/pivotal-tracker/validation.rb",
+     "lib/pivotal_tracker.rb",
+     "pivotal-tracker.gemspec",
+     "spec/fixtures/activity.xml",
+     "spec/fixtures/created_note.xml",
+     "spec/fixtures/created_story.xml",
+     "spec/fixtures/iterations_all.xml",
+     "spec/fixtures/iterations_backlog.xml",
+     "spec/fixtures/iterations_current.xml",
+     "spec/fixtures/iterations_done.xml",
+     "spec/fixtures/memberships.xml",
+     "spec/fixtures/notes.xml",
+     "spec/fixtures/project.xml",
+     "spec/fixtures/project_activity.xml",
+     "spec/fixtures/projects.xml",
+     "spec/fixtures/stale_fish.yml",
+     "spec/fixtures/stories.xml",
+     "spec/fixtures/tasks.xml",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/support/stale_fish_fixtures.rb",
+     "spec/unit/pivotal-tracker/activity_spec.rb",
+     "spec/unit/pivotal-tracker/attachment_spec.rb",
+     "spec/unit/pivotal-tracker/client_spec.rb",
+     "spec/unit/pivotal-tracker/iteration_spec.rb",
+     "spec/unit/pivotal-tracker/membership_spec.rb",
+     "spec/unit/pivotal-tracker/note_spec.rb",
+     "spec/unit/pivotal-tracker/project_spec.rb",
+     "spec/unit/pivotal-tracker/story_spec.rb",
+     "spec/unit/pivotal-tracker/task_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/jsmestad/pivotal-tracker}
+  s.rdoc_options = [%q{--charset=UTF-8}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Ruby wrapper for the Pivotal Tracker API}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/support/stale_fish_fixtures.rb",
+     "spec/unit/pivotal-tracker/activity_spec.rb",
+     "spec/unit/pivotal-tracker/attachment_spec.rb",
+     "spec/unit/pivotal-tracker/client_spec.rb",
+     "spec/unit/pivotal-tracker/iteration_spec.rb",
+     "spec/unit/pivotal-tracker/membership_spec.rb",
+     "spec/unit/pivotal-tracker/note_spec.rb",
+     "spec/unit/pivotal-tracker/project_spec.rb",
+     "spec/unit/pivotal-tracker/story_spec.rb",
+     "spec/unit/pivotal-tracker/task_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, ["~> 1.6.0"])
+      s.add_runtime_dependency(%q<happymapper>, [">= 0.3.2"])
+      s.add_runtime_dependency(%q<builder>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0.9.26"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<stale_fish>, ["~> 1.3.0"])
+    else
+      s.add_dependency(%q<rest-client>, ["~> 1.6.0"])
+      s.add_dependency(%q<happymapper>, [">= 0.3.2"])
+      s.add_dependency(%q<builder>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0.9.26"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<stale_fish>, ["~> 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, ["~> 1.6.0"])
+    s.add_dependency(%q<happymapper>, [">= 0.3.2"])
+    s.add_dependency(%q<builder>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0.9.26"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<stale_fish>, ["~> 1.3.0"])
+  end
+end
+

data/spec/fixtures/activity.xml

@@ -0,0 +1,177 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<activities type="array">
+  <activity>
+    <id type="integer">24492385</id>
+    <version type="integer">206</version>
+    <event_type>story_create</event_type>
+    <occurred_at type="datetime">2010/07/29 19:13:04 UTC</occurred_at>
+    <author>Test Suite Access</author>
+    <project_id type="integer">102622</project_id>
+    <description>Test Suite Access added &quot;Create stuff&quot;</description>
+    <stories>
+      <story>
+        <id type="integer">4492080</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/102622/stories/4492080</url>
+        <name>Create stuff</name>
+        <story_type>feature</story_type>
+        <current_state>unscheduled</current_state>
+      </story>
+    </stories>
+  </activity>
+  <activity>
+    <id type="integer">24492375</id>
+    <version type="integer">205</version>
+    <event_type>story_create</event_type>
+    <occurred_at type="datetime">2010/07/29 19:13:01 UTC</occurred_at>
+    <author>Test Suite Access</author>
+    <project_id type="integer">102622</project_id>
+    <description>Test Suite Access added &quot;Create stuff&quot;</description>
+    <stories>
+      <story>
+        <id type="integer">4492078</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/102622/stories/4492078</url>
+        <name>Create stuff</name>
+        <story_type>feature</story_type>
+        <current_state>unscheduled</current_state>
+      </story>
+    </stories>
+  </activity>
+  <activity>
+    <id type="integer">24492239</id>
+    <version type="integer">200</version>
+    <event_type>story_create</event_type>
+    <occurred_at type="datetime">2010/07/29 19:11:43 UTC</occurred_at>
+    <author>Test Suite Access</author>
+    <project_id type="integer">102622</project_id>
+    <description>Test Suite Access added &quot;Create stuff&quot;</description>
+    <stories>
+      <story>
+        <id type="integer">4492060</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/102622/stories/4492060</url>
+        <name>Create stuff</name>
+        <story_type>feature</story_type>
+        <current_state>unscheduled</current_state>
+      </story>
+    </stories>
+  </activity>
+  <activity>
+    <id type="integer">24492220</id>
+    <version type="integer">199</version>
+    <event_type>story_create</event_type>
+    <occurred_at type="datetime">2010/07/29 19:11:38 UTC</occurred_at>
+    <author>Test Suite Access</author>
+    <project_id type="integer">102622</project_id>
+    <description>Test Suite Access added &quot;Create stuff&quot;</description>
+    <stories>
+      <story>
+        <id type="integer">4492059</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/102622/stories/4492059</url>
+        <name>Create stuff</name>
+        <story_type>feature</story_type>
+        <current_state>unscheduled</current_state>
+      </story>
+    </stories>
+  </activity>
+  <activity>
+    <id type="integer">24491968</id>
+    <version type="integer">194</version>
+    <event_type>story_create</event_type>
+    <occurred_at type="datetime">2010/07/29 19:09:26 UTC</occurred_at>
+    <author>Test Suite Access</author>
+    <project_id type="integer">102622</project_id>
+    <description>Test Suite Access added &quot;Create stuff&quot;</description>
+    <stories>
+      <story>
+        <id type="integer">4491973</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/102622/stories/4491973</url>
+        <name>Create stuff</name>
+        <story_type>feature</story_type>
+        <current_state>unscheduled</current_state>
+      </story>
+    </stories>
+  </activity>
+  <activity>
+    <id type="integer">24491959</id>
+    <version type="integer">193</version>
+    <event_type>story_create</event_type>
+    <occurred_at type="datetime">2010/07/29 19:09:24 UTC</occurred_at>
+    <author>Test Suite Access</author>
+    <project_id type="integer">102622</project_id>
+    <description>Test Suite Access added &quot;Create stuff&quot;</description>
+    <stories>
+      <story>
+        <id type="integer">4491971</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/102622/stories/4491971</url>
+        <name>Create stuff</name>
+        <story_type>feature</story_type>
+        <current_state>unscheduled</current_state>
+      </story>
+    </stories>
+  </activity>
+  <activity>
+    <id type="integer">24491880</id>
+    <version type="integer">192</version>
+    <event_type>story_update</event_type>
+    <occurred_at type="datetime">2010/07/29 19:08:43 UTC</occurred_at>
+    <author>Jon</author>
+    <project_id type="integer">102622</project_id>
+    <description>Jon edited &quot;Movable Story&quot;</description>
+    <stories>
+      <story>
+        <id type="integer">4490874</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/102622/stories/4490874</url>
+        <estimate type="integer">0</estimate>
+      </story>
+    </stories>
+  </activity>
+  <activity>
+    <id type="integer">24491859</id>
+    <version type="integer">191</version>
+    <event_type>story_update</event_type>
+    <occurred_at type="datetime">2010/07/29 19:08:36 UTC</occurred_at>
+    <author>Jon</author>
+    <project_id type="integer">102622</project_id>
+    <description>Jon edited &quot;Movable Story&quot;</description>
+    <stories>
+      <story>
+        <id type="integer">4490874</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/102622/stories/4490874</url>
+        <current_state>unstarted</current_state>
+      </story>
+    </stories>
+  </activity>
+  <activity>
+    <id type="integer">24491236</id>
+    <version type="integer">158</version>
+    <event_type>story_update</event_type>
+    <occurred_at type="datetime">2010/07/29 19:04:29 UTC</occurred_at>
+    <author>Jon</author>
+    <project_id type="integer">102622</project_id>
+    <description>Jon edited &quot;Movable Story&quot;</description>
+    <stories>
+      <story>
+        <id type="integer">4490874</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/102622/stories/4490874</url>
+        <name>Movable Story</name>
+      </story>
+    </stories>
+  </activity>
+  <activity>
+    <id type="integer">24490623</id>
+    <version type="integer">153</version>
+    <event_type>story_create</event_type>
+    <occurred_at type="datetime">2010/07/29 18:58:45 UTC</occurred_at>
+    <author>Test Suite Access</author>
+    <project_id type="integer">102622</project_id>
+    <description>Test Suite Access added &quot;Create stuff&quot;</description>
+    <stories>
+      <story>
+        <id type="integer">4491800</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/102622/stories/4491800</url>
+        <name>Create stuff</name>
+        <story_type>feature</story_type>
+        <current_state>unscheduled</current_state>
+      </story>
+    </stories>
+  </activity>
+</activities>

data/spec/fixtures/created_note.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<story>
+  <id type="integer">4492112</id>
+  <project_id type="integer">102622</project_id>
+  <story_type>feature</story_type>
+  <url>http://www.pivotaltracker.com/story/show/4492112</url>
+  <estimate type="integer">-1</estimate>
+  <current_state>unscheduled</current_state>
+  <description></description>
+  <name>Create stuff</name>
+  <requested_by>Test Suite Access</requested_by>
+  <created_at type="datetime">2010/07/29 19:15:16 UTC</created_at>
+  <updated_at type="datetime">2010/07/29 19:15:16 UTC</updated_at>
+</story>

data/spec/fixtures/created_story.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<story>
+  <id type="integer">4492111</id>
+  <project_id type="integer">102622</project_id>
+  <story_type>feature</story_type>
+  <url>http://www.pivotaltracker.com/story/show/4492111</url>
+  <estimate type="integer">-1</estimate>
+  <current_state>unscheduled</current_state>
+  <description></description>
+  <name>Create stuff</name>
+  <requested_by>Test Suite Access</requested_by>
+  <created_at type="datetime">2010/07/29 19:15:13 UTC</created_at>
+  <updated_at type="datetime">2010/07/29 19:15:13 UTC</updated_at>
+</story>