taskmapper-basecamp 0.5.0

data/lib/provider/comment.rb

@@ -0,0 +1,63 @@
+module TaskMapper::Provider
+  module Basecamp
+    # The comment class for taskmapper-basecamp
+    #
+    # Do any mapping between taskmapper and your system's comment model here
+    # versions of the ticket.
+    #
+    class Comment < TaskMapper::Provider::Base::Comment
+      # declare needed overloaded methods here
+      API = BasecampAPI::Comment
+
+      def initialize(*object)
+        if object.first
+          object = object.first
+          unless object.is_a? Hash
+            hash = {:id => object.id,
+                    :body => object.body,
+                    :author => object.author_name,
+                    :created_at => object.created_at,
+                    :project_id => object.project_id,
+                    :ticket_id => object.ticket_id}
+          else
+            hash = object
+          end
+          super hash
+        end
+      end
+
+      def self.find_by_id(project_id, ticket_id, id)
+        basecamp_comment = self::API.find(id, :params => {:todo_item_id => ticket_id})
+        self.new basecamp_comment.attributes.merge!(:project_id => project_id, :ticket_id => ticket_id)
+      end
+
+      def self.find_by_attributes(project_id, ticket_id, attributes = {})
+        self.search(project_id, ticket_id, attributes)
+      end
+
+      def self.search(project_id, ticket_id, options = {}, limit = 1000)
+        comments = API.find(:all, :params => {:todo_item_id => ticket_id}).collect {|c| self.new(c.attributes.merge!(:project_id => project_id, :ticket_id => ticket_id)) }
+        search_by_attribute(comments, options, limit)
+      end
+      
+      def self.create(ticket_id, attributes)
+        new_comment = API.new attributes.merge(:todo_item_id => ticket_id)
+        new_comment.save
+        
+        reloaded_comment = find_bc_comment(ticket_id, new_comment.id)
+        self.new reloaded_comment.attributes.merge!(:ticket_id => ticket_id) 
+      end
+      
+      def save
+        bc_comment = self.class.find_bc_comment ticket_id, id
+        bc_comment.body = self.body
+        bc_comment.save
+      end
+      
+      private
+        def self.find_bc_comment(ticket_id, id)
+          API.find id, :params => { :todo_item_id => ticket_id }
+        end      
+    end
+  end
+end

data/lib/provider/project.rb

@@ -0,0 +1,94 @@
+module TaskMapper::Provider
+  module Basecamp
+    # Project class for taskampper-basecamp
+    #
+    # Remaps 
+    #
+    # description => announcement
+    # created_at => created_on
+    # updated_at => last_changed_on
+    class Project < TaskMapper::Provider::Base::Project
+      API = BasecampAPI::Project
+
+      def initialize(*object) 
+        if object.first 
+          object = object.first
+          unless object.is_a? Hash
+            hash = {:id => object.id,
+                    :created_at => created_on,
+                    :updated_at => updated_on,
+                    :description => object.announcement,
+                    :name => object.name}
+
+          else
+            hash = object
+          end
+          super hash
+        end
+      end
+      
+      def description
+        announcement
+      end
+      
+      def description=(desc)
+        announcement = desc
+      end
+      
+      def created_at
+        begin
+          created_on.to_time
+        rescue
+          created_on
+        end
+      end
+      
+      def created_at=(created)
+        created_on = created
+      end
+      
+      def updated_at
+        begin
+          last_changed_on.to_time
+        rescue
+          last_changed_on
+        end
+      end
+      
+      def updated_at=(updated)
+        last_changed_on = updated
+      end
+      
+      def ticket!(attributes_hash)
+        provider_parent(self.class)::Ticket.create attributes_hash.merge :project_id => id
+      end
+      
+      def self.find_by_id(id)
+        self.new API.find(id)
+      end
+
+      def self.find_by_attributes(attributes = {})
+        self.search(attributes)
+      end
+
+      def self.search(options = {}, limit = 1000)
+        projects = API.find(:all).collect { |project| self.new project }
+        search_by_attribute(projects, options, limit)
+      end
+      
+      # copy from this.copy(that) copies that into this
+      def copy(project)
+        project.tickets.each do |ticket|
+          copy_ticket = self.ticket!(:title => ticket.title, :description => ticket.description)
+          ticket.comments.each do |comment|
+            copy_ticket.comment!(:body => comment.body)
+            sleep 1
+          end
+        end
+      end
+
+    end
+  end
+end
+
+

data/lib/provider/ticket.rb

@@ -0,0 +1,162 @@
+module TaskMapper::Provider
+  module Basecamp
+    # Ticket class for taskmapper-basecamp
+    #
+    #
+    # * status => completed (either completed or incomplete)
+    # * priority => position
+    # * title => TodoList#name - TodoItem#content (up to 100 characters)
+    # * resolution => completed (either completed or '')
+    # * updated_at => completed_on
+    # * description => content
+    # * assignee => responsible_party_name (read-only)
+    # * requestor => creator_name (read-only)
+    # * project_id
+    class Ticket < TaskMapper::Provider::Base::Ticket
+      def initialize(*options)
+        @system_data ||= {}
+        @cache ||= {}
+        first = options.first
+        case first
+        when Hash
+          super(first.to_hash)
+        else
+          @system_data[:client] = first
+          super(first.attributes)
+        end
+      end
+
+      class << self
+
+        def find_by_id(project_id, id)
+          find_by_attributes(project_id, {:id => id}).first
+        end
+
+        def find_by_attributes(project_id, attributes = {})
+          search(project_id, attributes)
+        end
+
+        def search(project_id, options = {}, limit = 1000)
+          tickets = todo_items(project_id).map {|ti| self.new ti.attributes.merge :project_id => project_id }
+          search_by_attribute(tickets, options, limit)
+        end
+
+        # It expects a single hash
+        def create(attributes_hash)
+          todo_item_hash = create_todo_item_hash attributes_hash
+          todo_item = create_todo_item todo_item_hash
+
+          return nil unless todo_item.save
+
+          todo_item.project_id = attributes_hash[:project_id]
+          todo_item.todo_list_id = todo_item_hash[:todo_list_id]
+          self.new(todo_item)
+        end
+
+        private
+        def all_todo_lists
+          BasecampAPI::TodoListWithItems.find(:all, :params => {:responsible_party => ''})
+        end
+
+        def project_todo_lists(project_id)
+          all_todo_lists.select {|l| l.project_id == project_id }
+        end
+
+        def todo_items(project_id)
+          project_todo_lists(project_id).map { |l| l.todo_items }.flatten
+        end
+
+
+        def create_todo_item_hash(ticket_hash)
+          a = ticket_hash
+          validate_ticket_hash a
+          todo_item_hash = {
+            :content => a[:title],
+            :position => a[:priority] || 1,
+            :todo_list_id => a[:todo_list_id] || create_todo_list({
+            :project_id => a[:project_id], 
+            :name => "#{a[:title]} list"}).id
+          }
+        end
+
+        def create_todo_item(attributes_hash)
+          BasecampAPI::TodoItem.new(attributes_hash)
+        end
+
+        def validate_ticket_hash(attributes_hash)
+          title = attributes_hash[:title]
+          raise ArgumentError.new "Title is required" if title.nil? or title.empty?
+        end
+
+        def create_todo_list(attributes)
+          BasecampAPI::TodoList.create(attributes)
+        end
+      end
+
+      def copy_to(todo_item)
+        todo_item.completed = status
+        todo_item.position = priority
+        todo_item.name = title
+        todo_item.content = title
+        todo_item.completed = resolution
+        todo_item.responsible_party_name = assignee
+        todo_item.creator_name = requestor
+        todo_item
+      end
+
+      def save
+        todo_item = BasecampAPI::TodoItem.find id, :params => { :todo_list_id => todo_list_id }
+        copy_to(todo_item).save
+      end
+
+      def todo_list_id
+        self['todo_list_id'].to_i
+      end
+
+      def status
+        self.completed ? 'completed' : 'incomplete'
+      end
+
+      def priority
+        self.position
+      end
+
+      def priority=(pri)
+        self.position = pri
+      end
+
+      def title
+        self.content
+      end
+
+      def title=(titl)
+        self.content = titl
+      end
+
+      def updated_at=(comp)
+        self.completed_on = comp
+      end
+
+      def description
+        self.content
+      end
+
+      def description=(desc)
+        self.content = desc
+      end
+
+      def assignee
+        self.responsible_party_name
+      end
+
+      def requestor
+        self.creator_name
+      end
+
+      def comment!(attributes)
+        Comment.create id, attributes
+      end
+
+    end
+  end
+end

data/lib/taskmapper-basecamp.rb

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

data/spec/comments_spec.rb

@@ -0,0 +1,103 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TaskMapper::Provider::Basecamp::Comment do
+  let(:project_id) { 5220065 }
+  let(:ticket_id) {133184178 }
+  let(:tm) { TaskMapper.new(:basecamp, :domain => 'ticketmaster.basecamphq.com', :token => '000000') }
+  let(:comment_class) { TaskMapper::Provider::Basecamp::Comment }
+  let(:comment_id) { 74197051 }
+
+  before(:each) do
+    @headers = {'Authorization' => 'Basic MDAwMDAwOkJhc2VjYW1w'}
+    gheaders = @headers.merge 'Accept' => 'application/xml'
+    
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get '/projects/5220065.xml', @headers, fixture_for('projects/5220065'), 200
+      mock.get '/todo_lists.xml?responsible_party=', @headers, fixture_for('todo_list_with_items'), 200
+    end
+    @project = tm.project(project_id)
+    @ticket = @project.ticket(ticket_id)
+  end
+
+  describe "Retrieving comments" do 
+    before(:each) do 
+      ActiveResource::HttpMock.respond_to do |mock|
+        mock.get '/todo_items/133184178/comments.xml', @headers, fixture_for('comments'), 200
+        mock.get '/todo_items/133184178/comments/74197051.xml', @headers, fixture_for('comments/74197051'), 200
+        mock.get '/todo_items/133184178/comments/74197096.xml', @headers, fixture_for('comments/74197096'), 200
+      end
+    end
+
+    context "when #comments is call to a ticket instance" do 
+      subject { @ticket.comments } 
+      it { should be_an_instance_of(Array) }    
+      it { subject.first.should be_an_instance_of(comment_class) }
+    end
+
+    context "when #comments is call to a ticket instance with an array of id's as parameters" do 
+      subject { @ticket.comments([74197051, 74197096]) }
+      it { should be_an_instance_of(Array) }
+      it { subject.first.should be_an_instance_of(comment_class) }
+      it { subject.first.id.should be_eql(74197051) }
+      it { subject.last.id.should be_eql(74197096) }
+    end
+
+    context "when #comments is call to a ticket instance with comments attributes as parameters" do 
+      subject { @ticket.comments(:id => comment_id) }
+      it { should be_an_instance_of(Array) }
+      it { subject.first.should be_an_instance_of(comment_class) }
+      it { subject.first.id.should be_eql(comment_id) }
+    end
+  end
+
+  describe "Retrieve a single comment from a ticket" do 
+    before(:each) do 
+      ActiveResource::HttpMock.respond_to do |mock|
+        mock.get '/todo_items/133184178/comments.xml', @headers, fixture_for('comments'), 200
+        mock.get '/todo_items/133184178/comments/74197051.xml', @headers, fixture_for('comments/74197051'), 200
+      end
+    end
+
+    context "when #comment is call with a comment id" do 
+      subject { @ticket.comment(comment_id) }
+      it { should be_an_instance_of(comment_class) }
+      it { subject.id.should be_eql(comment_id) }
+    end
+
+    context "when #comment is call with an attribute" do 
+      subject { @ticket.comment(:id => comment_id) }
+      it { should be_an_instance_of(comment_class) }
+      it { subject.id.should be_eql(comment_id) }
+    end
+  end
+
+  describe "Create and update a comment for a ticket" do 
+    before(:each) do 
+      pheaders = @headers.merge 'Content-Type'=>'application/xml'
+      ActiveResource::HttpMock.respond_to do |mock|
+        mock.get '/todo_items/133184178/comments/74197051.xml', @headers, fixture_for('comments/74197051'), 200
+        mock.get '/todo_items/133184178/comments.xml', @headers, fixture_for('comments'), 200
+        mock.put '/todo_items/133184178/comments/74197051.xml', @headers, '', 200
+        mock.post '/todo_items/133184178/comments.xml', pheaders, fixture_for('comments/74197051'), 200
+      end
+    end
+
+    context "when a comment is changed and then called the #save on it" do 
+      it do 
+        comment = @ticket.comment(comment_id) 
+        comment.body = "updated comment"
+        comment.save.should be_true
+        comment.body.should be_eql("updated comment")
+      end
+    end
+
+    context "when #comment! is call" do 
+      subject { @ticket.comment!(:body => 'hello there boys and girls') }
+      it { should be_an_instance_of(comment_class) }
+      it { subject.body.should_not be_nil }
+      it { subject.id.should_not be_nil }
+      it { subject.ticket_id.should_not be_nil }
+    end
+  end
+
+end

data/spec/fixtures/comments/74197051.json

@@ -0,0 +1 @@
+{"comment":{"attachments_count":0,"author_id":5654019,"body":"<div>Hello There<br /></div>","commentable_id":62509330,"commentable_type":"TodoItem","created_at":"2010-07-23 23:13:39 UTC","emailed_from":null,"id":74197051,"author_name":"Kia Kroas","attachments":[]}}

data/spec/fixtures/comments/74197051.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<comment>
+  <attachments-count type="integer">0</attachments-count>
+  <author-id type="integer">5654019</author-id>
+  <body>&lt;div&gt;Hello There&lt;br /&gt;&lt;/div&gt;</body>
+  <commentable-id type="integer">62509330</commentable-id>
+  <commentable-type>TodoItem</commentable-type>
+  <created-at type="datetime">2010-07-23T23:13:39Z</created-at>
+  <emailed-from nil="true"></emailed-from>
+  <id type="integer">74197051</id>
+  <author-name>Kia Kroas</author-name>
+  <attachments type="array"/>
+</comment>
+

data/spec/fixtures/comments/74197096.json

@@ -0,0 +1 @@
+{"comment":{"attachments_count":0,"author_id":5654019,"body":"<div>Something's off.<br /></div>","commentable_id":62509330,"commentable_type":"TodoItem","created_at":"2010-07-23 23:14:24 UTC","emailed_from":null,"id":74197096,"author_name":"Kia Kroas","attachments":[]}}

data/spec/fixtures/comments/74197096.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<comment>
+  <attachments-count type="integer">0</attachments-count>
+  <author-id type="integer">5654019</author-id>
+  <body>&lt;div&gt;Something's off.&lt;br /&gt;&lt;/div&gt;</body>
+  <commentable-id type="integer">62509330</commentable-id>
+  <commentable-type>TodoItem</commentable-type>
+  <created-at type="datetime">2010-07-23T23:14:24Z</created-at>
+  <emailed-from nil="true"></emailed-from>
+  <id type="integer">74197096</id>
+  <author-name>Kia Kroas</author-name>
+  <attachments type="array"/>
+</comment>
+

data/spec/fixtures/comments.json

@@ -0,0 +1 @@
+{"comments":[{"attachments_count":0,"author_id":5654019,"body":"<div>Hello There<br /></div>","commentable_id":62509330,"commentable_type":"TodoItem","created_at":"2010-07-23 23:13:39 UTC","emailed_from":null,"id":74197051,"author_name":"Kia Kroas"},{"attachments_count":0,"author_id":5654019,"body":"<div>Hm, why is the title different?<br /></div>","commentable_id":62509330,"commentable_type":"TodoItem","created_at":"2010-07-23 23:14:06 UTC","emailed_from":null,"id":74197080,"author_name":"Kia Kroas"},{"attachments_count":0,"author_id":5654019,"body":"<div>This doesn't seem right.<br /></div>","commentable_id":62509330,"commentable_type":"TodoItem","created_at":"2010-07-23 23:14:16 UTC","emailed_from":null,"id":74197085,"author_name":"Kia Kroas"},{"attachments_count":0,"author_id":5654019,"body":"<div>Something's off.<br /></div>","commentable_id":62509330,"commentable_type":"TodoItem","created_at":"2010-07-23 23:14:24 UTC","emailed_from":null,"id":74197096,"author_name":"Kia Kroas"}]}

data/spec/fixtures/comments.xml

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<comments type="array" count="4">
+  <comment>
+    <attachments-count type="integer">0</attachments-count>
+    <author-id type="integer">5654019</author-id>
+    <body>&lt;div&gt;Hello There&lt;br /&gt;&lt;/div&gt;</body>
+    <commentable-id type="integer">62509330</commentable-id>
+    <commentable-type>TodoItem</commentable-type>
+    <created-at type="datetime">2010-07-23T23:13:39Z</created-at>
+    <emailed-from nil="true"></emailed-from>
+    <id type="integer">74197051</id>
+    <author-name>Kia Kroas</author-name>
+  </comment>
+  <comment>
+    <attachments-count type="integer">0</attachments-count>
+    <author-id type="integer">5654019</author-id>
+    <body>&lt;div&gt;Hm, why is the title different?&lt;br /&gt;&lt;/div&gt;</body>
+    <commentable-id type="integer">62509330</commentable-id>
+    <commentable-type>TodoItem</commentable-type>
+    <created-at type="datetime">2010-07-23T23:14:06Z</created-at>
+    <emailed-from nil="true"></emailed-from>
+    <id type="integer">74197080</id>
+    <author-name>Kia Kroas</author-name>
+  </comment>
+  <comment>
+    <attachments-count type="integer">0</attachments-count>
+    <author-id type="integer">5654019</author-id>
+    <body>&lt;div&gt;This doesn't seem right.&lt;br /&gt;&lt;/div&gt;</body>
+    <commentable-id type="integer">62509330</commentable-id>
+    <commentable-type>TodoItem</commentable-type>
+    <created-at type="datetime">2010-07-23T23:14:16Z</created-at>
+    <emailed-from nil="true"></emailed-from>
+    <id type="integer">74197085</id>
+    <author-name>Kia Kroas</author-name>
+  </comment>
+  <comment>
+    <attachments-count type="integer">0</attachments-count>
+    <author-id type="integer">5654019</author-id>
+    <body>&lt;div&gt;Something's off.&lt;br /&gt;&lt;/div&gt;</body>
+    <commentable-id type="integer">62509330</commentable-id>
+    <commentable-type>TodoItem</commentable-type>
+    <created-at type="datetime">2010-07-23T23:14:24Z</created-at>
+    <emailed-from nil="true"></emailed-from>
+    <id type="integer">74197096</id>
+    <author-name>Kia Kroas</author-name>
+  </comment>
+</comments>

data/spec/fixtures/project_count.json

@@ -0,0 +1 @@
+{"count":{"active":5,"on_hold":2,"archived":11}}

data/spec/fixtures/project_count.xml

@@ -0,0 +1,5 @@
+<count>
+  <active type="integer">5</active>
+  <on-hold type="integer">2</on-hold>
+  <archived type="integer">11</archived>
+</count>

data/spec/fixtures/projects/5220065.json

@@ -0,0 +1 @@
+{"project":{"announcement":"Announcement.","created_on":"2010-07-20","id":5220065,"last_changed_on":"2010-07-23 06:31:39 UTC","name":"Ticketmaster-basecamp","show_announcement":false,"show_writeboards":true,"start_page":"log","status":"active","company":{"id":1971191,"name":"Kia Kroas"}}}

data/spec/fixtures/projects/5220065.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project>
+  <announcement>Announcement.</announcement>
+  <created-on type="date">2010-07-20</created-on>
+  <id type="integer">5220065</id>
+  <last-changed-on type="datetime">2010-07-23T06:31:39Z</last-changed-on>
+  <name>Ticketmaster-basecamp</name>
+  <show-announcement type="boolean">false</show-announcement>
+  <show-writeboards type="boolean">true</show-writeboards>
+  <start-page>log</start-page>
+  <status>active</status>
+  <company>
+    <id type="integer">1971191</id>
+    <name>Kia Kroas</name>
+  </company>
+</project>

data/spec/fixtures/projects/create.json

@@ -0,0 +1 @@
+{}

data/spec/fixtures/projects/create.xml

@@ -0,0 +1,2 @@
+
+

data/spec/fixtures/projects.json

@@ -0,0 +1 @@
+{"projects":[{"announcement":"Announcement.","created_on":"2010-07-20","id":5220065,"last_changed_on":"2010-07-23 06:31:39 UTC","name":"Ticketmaster-basecamp","show_announcement":false,"show_writeboards":true,"start_page":"log","status":"active","company":{"id":1971191,"name":"Kia Kroas"}}]}

data/spec/fixtures/projects.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projects type="array">
+  <project>
+    <announcement>Announcement.</announcement>
+    <created-on type="date">2010-07-20</created-on>
+    <id type="integer">5220065</id>
+    <last-changed-on type="datetime">2010-07-23T06:31:39Z</last-changed-on>
+    <name>Ticketmaster-basecamp</name>
+    <show-announcement type="boolean">false</show-announcement>
+    <show-writeboards type="boolean">true</show-writeboards>
+    <start-page>log</start-page>
+    <status>active</status>
+    <company>
+      <id type="integer">1971191</id>
+      <name>Kia Kroas</name>
+    </company>
+  </project>
+</projects>
+

data/spec/fixtures/todo_items/62509330_todo_item.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<todo-item>
+  <comments-count type="integer">0</comments-count>
+  <completed type="boolean">false</completed>
+  <content>hudnthdau</content>
+  <created-at type="datetime">2010-07-21T01:14:34Z</created-at>
+  <updated-at type="datetime">2010-07-20T23:36:49Z</updated-at>
+  <creator-id type="integer">5654019</creator-id>
+  <due-at type="datetime" nil="true"></due-at>
+  <id type="integer">62509330</id>
+  <position type="integer">1</position>
+  <todo-list-id type="integer">9973518</todo-list-id>
+  <created-on type="datetime" deprecated="true">2010-07-21T01:14:34Z</created-on>
+  <creator-name>Kia Kroas</creator-name>
+</todo-item>

data/spec/fixtures/todo_list_9972756.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<todo-list>
+  <completed-count type="integer">0</completed-count>
+  <description>etauhnotehunoteh tnheontu honetuh osneh noe hosneuh toneuh</description>
+  <id type="integer">9972756</id>
+  <milestone-id type="integer" nil="true"></milestone-id>
+  <name>Cheese</name>
+  <position type="integer">2</position>
+  <private type="boolean">false</private>
+  <project-id type="integer">5220065</project-id>
+  <tracked type="boolean">false</tracked>
+  <uncompleted-count type="integer">6</uncompleted-count>
+  <complete>false</complete>
+</todo-list>