taskmapper-pivotal 0.8.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "taskmapper", "~> 0.8"
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8"
+  gem "jeweler", "~> 1.6"
+  gem "simplecov", "~> 0.5", :platforms => :ruby_19
+  gem "rcov", "~> 1.0", :platforms => :ruby_18
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activeresource (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    hashie (1.2.0)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    rcov (1.0.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    taskmapper (0.8.0)
+      activeresource (~> 3.0)
+      activesupport (~> 3.0)
+      hashie (~> 1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.6)
+  rcov (~> 1.0)
+  rspec (~> 2.8)
+  simplecov (~> 0.5)
+  taskmapper (~> 0.8)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009-2010 The Hybrid Group
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+NONE
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,17 @@
+# taskmapper-pivotal
+
+Description goes here.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 The Hybrid Group. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "taskmapper-pivotal"
+    gem.summary = %Q{This is a taskmapper provider for interacting with Pivotal Tracker}
+    gem.description = %Q{This is a taskmapper provider for interacting with Pivotal Tracker .}
+    gem.email = "hong.quach@abigfisch.com"
+    gem.homepage = "http://ticket.rb"
+    gem.authors = ["HybridGroup"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "taskmapper-kanbanpad#{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.8.0

data/lib/pivotal/pivotal-api.rb

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'active_support'
+require 'active_resource'
+
+module PivotalAPI
+  class Error < StandardError; end
+  class << self
+    # Sets up basic authentication credentials for all the resources.
+    def authenticate(user, password)
+      Token.user = user
+      Token.password = password
+      self.token = Token.get(:active)['guid']
+      Token.user = nil
+      Token.password = nil
+    end
+
+    # Sets the API token for all the resources.
+    def token=(value)
+      resources.each do |klass|
+        klass.headers['X-TrackerToken'] = value
+      end
+      @token = value
+    end
+
+    def resources
+      @resources ||= []
+    end
+  end
+
+  class Base < ActiveResource::Base
+    self.site = 'https://www.pivotaltracker.com/services/v3/'
+    self.format = ActiveResource::Formats::XmlFormat
+    def self.inherited(base)
+      PivotalAPI.resources << base
+      super
+    end
+  end
+
+  class Project < Base
+    def stories(options = {})
+      Story.find(:all, :params => options.merge!(:project_id => self.id))
+    end
+  end
+
+  class Token < Base
+  end
+
+  class Activity < Base
+    self.site += 'projects/:project_id/'
+  end
+
+  class Membership < Base
+    self.site += 'projects/:project_id/'
+  end
+
+  class Iteration < Base
+    self.site += 'projects/:project_id/'
+  end
+
+  class Story < Base
+    self.site += 'projects/:project_id/'
+  end
+
+  class Note < Base
+    self.site += 'projects/:project_id/stories/:story_id/'
+  end
+
+  class Task < Base
+    self.site += 'projects/:project_id/stories/:story_id/'
+  end
+
+  class AllActivity < Base
+  end
+end

data/lib/provider/comment.rb

@@ -0,0 +1,70 @@
+module TaskMapper::Provider
+  module Pivotal
+    # The comment class for taskmapper-pivotal
+    # * author
+    # * body => text
+    # * id => position in the versions array (set by the initializer)
+    # * created_at => noted_at
+    # * updated_at => noted_at
+    # * ticket_id (actually the story id)
+    # * project_id
+    class Comment < TaskMapper::Provider::Base::Comment
+      API = PivotalAPI::Note
+
+      # A custom find_by_id
+      # The "comment" id is it's index in the versions array. An id of 0 therefore exists and
+      # should be the first ticket (original)
+      def self.find_by_id(project_id, ticket_id, id)
+        self.new(project_id, ticket_id, PivotalAPI::Note.find(id, :params => {:project_id => project_id, :story_id => ticket_id}))
+      end
+
+      # A custom find_by_attributes
+      #
+      def self.find_by_attributes(project_id, ticket_id, attributes = {})
+        self.search(project_id, ticket_id, attributes).collect { |comment| self.new(project_id, ticket_id, comment) }
+      end
+
+      # A custom searcher
+      #
+      # It returns a custom result because we need the original story to make a comment.
+      def self.search(project_id, ticket_id, options = {}, limit = 1000)
+        comments = PivotalAPI::Note.find(:all, :params => {:project_id => project_id, :story_id => ticket_id})
+        search_by_attribute(comments, options, limit)
+      end
+
+      # A custom creator
+      # We didn't really need to do much other than change the :ticket_id attribute to :story_id
+      def self.create(project_id, ticket_id, *options)
+        first = options.first
+        first[:story_id] ||= ticket_id
+        first[:project_id] ||= project_id
+        first[:text] ||= first.delete(:body) || first.delete('body')
+        note = PivotalAPI::Note.new(first)
+        note.save
+        self.new(project_id, ticket_id, note)
+      end
+
+      def initialize(project_id, ticket_id, *object)
+        if object.first
+          object = object.first
+          unless object.is_a? Hash
+            hash = {:id => object.id,
+                    :body => object.text,
+                    :update_at => object.noted_at,
+                    :created_at => object.noted_at,
+                    :project_id => project_id,
+                    :ticket_id => ticket_id
+                    }
+          else
+            hash = object
+          end
+          super hash
+        end
+      end
+
+      def body=(bod)
+        self.text = bod
+      end
+    end
+  end
+end

data/lib/provider/pivotal.rb

@@ -0,0 +1,37 @@
+module TaskMapper::Provider
+  # This is the Pivotal Tracker Provider for taskmapper
+  module Pivotal
+    include TaskMapper::Provider::Base
+    TICKET_API = PivotalAPI::Story
+    PROJECT_API = PivotalAPI::Project
+    
+    # This is for cases when you want to instantiate using TaskMapper::Provider::Lighthouse.new(auth)
+    def self.new(auth = {})
+      TaskMapper.new(:pivotal, auth)
+    end
+    
+    # The authorize and initializer for this provider
+    def authorize(auth = {})
+      @authentication ||= TaskMapper::Authenticator.new(auth)
+      auth = @authentication
+      if auth.token.empty?
+        raise "You should pass a token for authentication"
+      end
+      if auth.token
+        PivotalAPI.token = auth.token
+      elsif auth.username && auth.password
+        PivotalAPI.authenticate(auth.username, auth.password)
+      end
+    end
+
+    def valid?
+      begin
+        PROJECT_API.find(:first)
+        true
+      rescue
+        false
+      end
+    end
+    
+  end
+end

data/lib/provider/project.rb

@@ -0,0 +1,55 @@
+module TaskMapper::Provider
+  module Pivotal
+    # Project class for taskmapper-pivotal
+    # 
+    # 
+    class Project < TaskMapper::Provider::Base::Project
+      API = PivotalAPI::Project
+      # The finder method
+      # 
+      # It accepts all the find functionalities defined by taskmapper
+      #
+      # + find() and find(:all) - Returns all projects on the account
+      # + find(<project_id>) - Returns the project based on the id
+      # + find(:first, :name => <project_name>) - Returns the first project based on the attribute
+      # + find(:name => <project name>) - Returns all projects based on the attribute
+      attr_accessor :prefix_options
+      alias_method :stories, :tickets
+      alias_method :story, :ticket
+
+      # Save this project
+      def save
+        warn 'Warning: Pivotal does not allow editing of project attributes. This method does nothing.'
+        true
+      end
+
+      def initialize(*options)
+        super(*options)
+        self.id = self.id.to_i
+      end
+
+      # Delete this project
+      def destroy
+        result = self.system_data[:client].destroy
+        result.is_a?(Net::HTTPOK)
+      end
+
+      def ticket!(*options)
+        options.first.merge!(:project_id => self.id)
+        Ticket.create(options.first)
+      end
+
+      # copy from
+      def copy(project)
+        project.tickets.each do |ticket|
+          copy_ticket = self.ticket!(:name => ticket.title, :description => ticket.description)
+          ticket.comments.each do |comment|
+            copy_ticket.comment!(:text => comment.body)
+            sleep 1
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/provider/ticket.rb

@@ -0,0 +1,124 @@
+module TaskMapper::Provider
+  module Pivotal
+    # Ticket class for taskmapper-pivotal
+    # * id
+    # * status
+    # * priority
+    # * title => name
+    # * resolution
+    # * created_at
+    # * updated_at
+    # * description => text
+    # * assignee
+    # * requestor
+    # * project_id (prefix_options[:project_id])
+    class Ticket < TaskMapper::Provider::Base::Ticket
+      @@allowed_states = ['new', 'open', 'resolved', 'hold', 'invalid']
+
+      attr_accessor :prefix_options
+      API = PivotalAPI::Story
+
+
+      # The saver
+      def save(*options)
+        pt_ticket = @system_data[:client]
+        self.keys.each do |key|
+          pt_ticket.send(key + '=', self.send(key)) if self.send(key) != pt_ticket.send(key)
+        end
+        pt_ticket.save
+      end
+
+      def destroy(*options)
+        @system_data[:client].destroy.is_a?(Net::HTTPOK)
+      end
+
+      def project_id
+        self.prefix_options[:project_id]
+      end
+
+      def requestor
+        self.requested_by
+      end
+
+      def title
+        self.name
+      end
+
+      def title=(title)
+        self.name=title
+      end
+
+      def status
+        self.current_state
+      end
+
+      def priority
+        self.estimate
+      end
+
+      def resolution
+        self.current_state
+      end
+
+      def assignee
+        self.owned_by
+      end
+
+      def comment!(*options)
+        Comment.create(self.project_id, self.id, options.first)
+      end
+      # The closer
+      def close(resolution = 'resolved')
+        resolution = 'resolved' unless @@allowed_states.include?(resolution)
+        ticket = PivotalAPI::Ticket.find(self.id, :params => {:project_id => self.prefix_options[:project_id]})
+        ticket.state = resolution
+        ticket.save
+      end
+
+      class << self
+
+        def find_by_attributes(project_id, attributes = {})
+          date_to_search = attributes[:updated_at] || attributes[:created_at]
+          tickets = []
+          unless date_to_search.nil?
+            tickets = search_by_datefields(project_id, date_to_search)
+          else
+            tickets += API.find(:all, :params => {:project_id => project_id, :filter => filter(attributes)}).map { |xticket| self.new xticket }
+          end
+          tickets.flatten
+        end
+
+        def filter(attributes = {})
+          filter = ""
+          attributes.each_pair do |key, value|
+            filter << "#{key}:#{value} "
+          end
+          filter.strip!
+        end
+
+        def create(options)
+          super translate options, {:title => :name, 
+                                    :requestor => :requested_by,
+                                    :status => :current_state, 
+                                    :estimate => :priority,
+                                    :assignee => :owned_by}
+        end
+
+        private
+        def search_by_datefields(project_id, date_to_search)
+          date_to_search = date_to_search.strftime("%Y/%m/%d")
+          tickets = []
+          PivotalAPI::Activity.find(:all, :params => {:project_id => project_id, :occurred_since_date => date_to_search}).each do |activity|
+            tickets = activity.stories.map { |xstory| self.new xstory }
+          end
+          tickets
+        end
+
+        def translate(hash, mapping)
+          Hash[hash.map { |k, v| [mapping[k] ||= k, v]}]
+        end
+      end
+    end
+
+  end
+end

data/lib/taskmapper-pivotal.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/pivotal/pivotal-api'
+
+%w{ pivotal ticket project comment }.each do |f|
+  require File.dirname(__FILE__) + '/provider/' + f + '.rb';
+end
+

data/spec/comments_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "TaskMapper::Provider::Pivotal::Comment" do
+  before(:all) do
+    headers = {'X-TrackerToken' => '000000'}
+    wheaders = headers.merge('Content-Type' => 'application/xml')
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get '/services/v3/projects/93790.xml', headers, fixture_for('projects/93790'), 200
+      mock.get '/services/v3/projects/93790/stories.xml', headers, fixture_for('stories'), 200
+      mock.get '/services/v3/projects/93790/stories.xml?filter=', headers, fixture_for('stories'), 200
+      mock.get '/services/v3/projects/93790/stories/4056827.xml', headers, fixture_for('stories/4056827'), 200
+      mock.get '/services/v3/projects/93790/stories/4056827/notes.xml', headers, fixture_for('notes'), 200
+      mock.get '/services/v3/projects/93790/stories/4056827/notes/1946635.xml', headers, fixture_for('notes/1946635'), 200
+      mock.post '/services/v3/projects/93790/stories/4056827/notes.xml', wheaders, fixture_for('notes/1946635'), 200
+      mock.put '/services/v3/projects/93790/stories/4056827.xml', wheaders, '', 200
+    end
+    @project_id = 93790
+    @ticket_id = 4056827
+    @comment_id = 1946635
+  end
+  
+  before(:each) do
+    @taskmapper = TaskMapper.new(:pivotal, :token => '000000')
+    @project = @taskmapper.project(@project_id)
+    @ticket = @project.ticket(4056827)
+    @klass = TaskMapper::Provider::Pivotal::Comment
+  end
+  
+  it "should be able to load all comments" do
+    @comments = @ticket.comments
+    @comments.should be_an_instance_of(Array)
+    @comments.first.should be_an_instance_of(@klass)
+  end
+  
+  it "should be able to load all comments based on 'id's" do
+    @comments = @ticket.comments([@comment_id])
+    @comments.should be_an_instance_of(Array)
+    @comments.first.should be_an_instance_of(@klass)
+    @comments.first.id.should == @comment_id
+  end
+  
+  it "should be able to load all comments based on attributes" do
+    @comments = @ticket.comments(:id => @comment_id)
+    @comments.should be_an_instance_of(Array)
+    @comments.first.should be_an_instance_of(@klass)
+  end
+  
+  it "should be able to load a comment based on id" do
+    @comment = @ticket.comment(@comment_id)
+    @comment.should be_an_instance_of(@klass)
+    @comment.id.should == @comment_id
+  end
+  
+  it "should be able to load a comment based on attributes" do
+    @comment = @ticket.comment(:id => @comment_id)
+    @comment.should be_an_instance_of(@klass)
+  end
+  
+  it "should return the class" do
+    @ticket.comment.should == @klass
+  end
+  
+  it "should be able to create a comment" do # which as mentioned before is technically a ticket update
+    @comment = @ticket.comment!(:body => 'hello there boys and girls')
+    @comment.should be_an_instance_of(@klass)
+  end
+end

data/spec/fixtures/activities.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<activities type="array">
+  <activity>
+    <id type="integer">86811411</id>
+    <version type="integer">3</version>
+    <event_type>story_create</event_type>
+    <occurred_at type="datetime">2011/06/09 23:29:12 UTC</occurred_at>
+    <author>Clutch Test</author>
+    <project_id type="integer">136096</project_id>
+    <description>Clutch Test added &quot;Let's see with another story&quot;</description>
+    <stories type="array">
+      <story>
+        <id type="integer">14398445</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/136096/stories/14398445</url>
+        <name>Let's see with another story</name>
+        <story_type>feature</story_type>
+        <current_state>unscheduled</current_state>
+      </story>
+    </stories>
+  </activity>
+  <activity>
+    <id type="integer">86747595</id>
+    <version type="integer">2</version>
+    <event_type>story_create</event_type>
+    <occurred_at type="datetime">2011/06/09 20:06:46 UTC</occurred_at>
+    <author>Clutch Test</author>
+    <project_id type="integer">136096</project_id>
+    <description>Clutch Test added &quot;Hello, This is clutch&quot;</description>
+    <stories type="array">
+      <story>
+        <id type="integer">14389955</id>
+        <url>http://www.pivotaltracker.com/services/v3/projects/136096/stories/14389955</url>
+        <name>Hello, This is clutch</name>
+        <story_type>feature</story_type>
+        <current_state>unscheduled</current_state>
+      </story>
+    </stories>
+  </activity>
+</activities>

data/spec/fixtures/notes/1946635.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<note>
+  <id type="integer">1946635</id>
+  <text>note</text>
+  <author>Hong Quach</author>
+  <noted_at type="datetime">2010/07/03 08:09:38 UTC</noted_at>
+</note>

data/spec/fixtures/notes.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<notes type="array">
+  <note>
+    <id type="integer">1946635</id>
+    <text>note</text>
+    <author>Hong Quach</author>
+    <noted_at type="datetime">2010/07/03 08:09:38 UTC</noted_at>
+  </note>
+  <note>
+    <id type="integer">1946719</id>
+    <text>etuhanoeth naou</text>
+    <author>Hong Quach</author>
+    <noted_at type="datetime">2010/07/03 09:57:03 UTC</noted_at>
+  </note>
+</notes>