taskmapper-zendesk 0.5.0

data/lib/provider/zendesk.rb

@@ -0,0 +1,40 @@
+require 'taskmapper'
+module TaskMapper::Provider
+  # This is the Zendesk Provider for taskmapper
+  module Zendesk
+    include TaskMapper::Provider::Base
+    #PROJECT_API = ZendeskAPI::Organization
+    
+    # This is for cases when you want to instantiate using TaskMapper::Provider::Yoursystem.new(auth)
+    def self.new(auth = {})
+      TaskMapper.new(:zendesk, auth)
+    end
+    
+    # The authorize and initializer for this provider
+    def authorize(auth = {})
+      @authentication ||= TaskMapper::Authenticator.new(auth)
+      auth = @authentication
+      if (auth.account.nil? and auth.username.nil? and auth.password.nil?)
+        raise "Please provide at least an url (subdomain), username and password)"
+      end
+      ZendeskAPI.authenticate(auth.account, auth.username, auth.password)
+    end
+
+    def projects(*options)
+      [Project.new({:account => @authentication.account, :username => @authentication.username, :name => "#{@authentication.account}-project"})]
+    end
+
+    def project(*options)
+      unless options.empty?
+        Project.new({:account => @authentication.account, :username => @authentication.username, :name => "#{@authentication.account}-project"})
+      else
+        TaskMapper::Provider::Zendesk::Project
+      end
+    end
+
+    def valid?
+        ZendeskAPI::Search.find(:first, :params => {:query => "status:open"})
+    end
+
+  end
+end

data/lib/taskmapper-zendesk.rb

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

data/lib/zendesk/zendesk-api.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'active_support'
+require 'active_resource'
+
+module ZendeskAPI
+  class Error < StandardError; end
+
+  class << self
+
+    def authenticate(account, username, password)
+      @username = username
+      @password = password
+      self::Base.user = username
+      self::Base.password = password
+      self::Base.site = "http://#{account}.zendesk.com"
+    end
+
+    def resources
+      @resources ||= []
+    end
+
+  end
+
+  class Base < ActiveResource::Base
+    self.format = :json
+    def self.inherited(base)
+      ZendeskAPI.resources << base
+      super
+    end
+  end
+
+  class Search < Base
+
+    def self.collection_path(prefix_options = {}, query_options = nil) 
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}search.#{format.extension}#{query_string(query_options)}"
+    end
+
+    def self.element_path(id, prefix_options = {}, query_options = nil)
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}search.#{format.extension}#{query_string(query_options)}"
+    end
+
+  end
+
+  class Ticket < Base
+  end
+
+  class User < Base
+  end
+
+end

data/spec/comments_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TaskMapper::Provider::Zendesk::Comment do
+
+  before(:all) do 
+    @project_id = 'hybridgroup-project'
+    @ticket_id = 1
+    headers = {'Authorization' => 'Basic cmFmYWVsQGh5YnJpZGdyb3VwLmNvbToxMjM0NTY=','Accept' => 'application/json'}
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get '/tickets/1.json', headers, fixture_for('ticket','json'), 200
+      mock.get '/users/26218414.json', headers, fixture_for('users/55030073', 'json'), 200
+      mock.get '/users/26220353.json', headers, fixture_for('users/55030073', 'json'), 200
+    end
+  end
+
+  before(:each) do 
+    @taskmapper = TaskMapper.new(:zendesk, :account => 'hybridgroup', :username => 'rafael@hybridgroup.com', :password => '123456')
+    project = @taskmapper.project(@project_id)
+    @ticket = project.ticket(@ticket_id)
+    @klass = TaskMapper::Provider::Zendesk::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 an array of id's" do 
+    comments = @ticket.comments([1])
+    comments.should be_an_instance_of(Array)
+    comments.first.should be_an_instance_of(@klass)
+    comments.first.id.should == 1
+  end
+
+  it "should be able to load all comments based on attributes" do
+    comments = @ticket.comments(:ticket_id => @ticket.id)
+    comments.should be_an_instance_of(Array)
+    comments.first.should be_an_instance_of(@klass)
+    comments.first.id.should == 1
+  end
+
+  it "should be able to load a comment based on id" do
+    comment = @ticket.comment(1)
+    comment.should be_an_instance_of(@klass)
+    comment.id.should == 1
+  end
+
+  it "should be able to load a ticket based on attributes" do 
+    comment = @ticket.comment(:ticket_id => 1)
+    comment.should be_an_instance_of(@klass)
+    comment.id.should == 1
+  end
+
+end

data/spec/fixtures/ticket.json

@@ -0,0 +1 @@
+{"nice_id":1,"initially_assigned_at":"2011/01/31 14:09:12 -0400","entry_id":null,"created_at":"2011/01/31 14:09:12 -0400","resolution_time":null,"priority_id":1,"current_tags":null,"assignee_id":26218414,"channel":null,"updated_at":"2011/01/31 14:09:12 -0400","ticket_type_id":3,"status_updated_at":"2011/01/31 14:09:12 -0400","solved_at":null,"original_recipient_address":null,"external_id":null,"assigned_at":"2011/01/31 14:09:12 -0400","via_id":0,"subject":"Testing","recipient":null,"group_id":121752,"comments":[{"created_at":"2011/01/31 14:09:12 -0400","via_id":0,"value":"Testing","type":"Comment","is_public":true,"author_id":26218414,"attachments":[]}],"linkings":[],"submitter_id":26218414,"base_score":18,"latest_recipients":null,"due_date":null,"current_collaborators":null,"status_id":1,"description":"Testing","ticket_field_entries":[],"problem_id":null,"score":18,"organization_id":457249,"updated_by_type_id":0,"requester_id":26218414}

data/spec/fixtures/tickets.json

@@ -0,0 +1 @@
+[{"nice_id":1,"initially_assigned_at":"2011/01/31 14:09:12 -0400","entry_id":null,"created_at":"2011/01/31 14:09:12 -0400","resolution_time":null,"priority_id":1,"current_tags":null,"assignee_id":26218414,"channel":null,"updated_at":"2011/01/31 14:09:12 -0400","ticket_type_id":3,"status_updated_at":"2011/01/31 14:09:12 -0400","solved_at":null,"original_recipient_address":null,"external_id":null,"assigned_at":"2011/01/31 14:09:12 -0400","via_id":0,"subject":"Testing","recipient":null,"group_id":121752,"comments":[{"created_at":"2011/01/31 14:09:12 -0400","via_id":0,"value":"Testing","type":"Comment","is_public":true,"author_id":26218414,"attachments":[]}],"linkings":[],"submitter_id":26218414,"base_score":18,"latest_recipients":null,"due_date":null,"current_collaborators":null,"status_id":1,"description":"Testing","ticket_field_entries":[],"problem_id":null,"score":18,"organization_id":457249,"updated_by_type_id":0,"requester_id":26218414},{"nice_id":2,"initially_assigned_at":"2011/01/31 14:30:31 -0400","entry_id":null,"created_at":"2011/01/31 14:30:31 -0400","resolution_time":null,"priority_id":0,"current_tags":null,"assignee_id":26218414,"channel":null,"updated_at":"2011/01/31 14:30:31 -0400","ticket_type_id":0,"status_updated_at":"2011/01/31 14:30:31 -0400","solved_at":null,"original_recipient_address":null,"external_id":null,"assigned_at":"2011/01/31 14:30:31 -0400","via_id":4,"subject":"Welcome to Zendesk, You've Got a Ticket!","recipient":"support@hybridgroup.zendesk.com","group_id":121752,"comments":[{"created_at":"2011/01/31 14:30:31 -0400","via_id":4,"value":"You've got a new ticket!\n\nTo help you get started learning how your zendesk simplifies ticket workflow, I emailed you at support@hybridgroup.zendesk.com and this ticket was created in your zendesk. Neat!\n\nYou can answer this ticket in one of two ways:\n\nBy Email: If you are looking at this in your email inbox, simply hit \"Reply\"\n\nBy Zendesk: If you are looking at this ticket in your zendesk:\n\n* Enter a comment (e.g. \"How am I doing?\")\n* Change status from Open to Pending (now, you’re waiting for me to get back to you!)\n* Click submit\n\nEither way, both your reply and follow-ups will be added to the ticket history and organized in your zendesk.\n\nYou’re eligible for 24-hour support throughout your trial. Please don’t hesitate to call or email our customer advocate team:\n\n*(e) support@zendesk.com\n*(p) +1 415.418.7506\n\nThank you for using Zendesk,\n\nKelly\nCustomer Advocate at Zendesk","type":"Comment","is_public":true,"author_id":26220353,"attachments":[]}],"linkings":[],"submitter_id":26220353,"base_score":108,"latest_recipients":null,"due_date":null,"current_collaborators":null,"status_id":1,"description":"You've got a new ticket!\n\nTo help you get started learning how your zendesk simplifies ticket workflow, I emailed you at support@hybridgroup.zendesk.com and this ticket was created in your zendesk. Neat!\n\nYou can answer this ticket in one of two ways:\n\nBy Email: If you are looking at this in your email inbox, simply hit \"Reply\"\n\nBy Zendesk: If you are looking at this ticket in your zendesk:\n\n* Enter a comment (e.g. \"How am I doing?\")\n* Change status from Open to Pending (now, you’re waiting for me to get back to you!)\n* Click submit\n\nEither way, both your reply and follow-ups will be added to the ticket history and organized in your zendesk.\n\nYou’re eligible for 24-hour support throughout your trial. Please don’t hesitate to call or email our customer advocate team:\n\n*(e) support@zendesk.com\n*(p) +1 415.418.7506\n\nThank you for using Zendesk,\n\nKelly\nCustomer Advocate at Zendesk","ticket_field_entries":[],"problem_id":null,"score":108,"organization_id":null,"updated_by_type_id":1,"requester_id":26220353}]

data/spec/fixtures/tickets.xml

@@ -0,0 +1,145 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<records type="array" count="2">
+  <record>
+    <assigned-at type="datetime">2011-01-31T14:09:12-04:00</assigned-at>
+    <assignee-id type="integer">26218414</assignee-id>
+    <base-score type="integer">12</base-score>
+    <created-at type="datetime">2011-01-31T14:09:12-04:00</created-at>
+    <current-collaborators nil="true"></current-collaborators>
+    <current-tags nil="true"></current-tags>
+    <description>Testing</description>
+    <due-date type="datetime" nil="true"></due-date>
+    <entry-id type="integer" nil="true"></entry-id>
+    <external-id nil="true"></external-id>
+    <group-id type="integer">121752</group-id>
+    <initially-assigned-at type="datetime">2011-01-31T14:09:12-04:00</initially-assigned-at>
+    <latest-recipients nil="true"></latest-recipients>
+    <nice-id type="integer">1</nice-id>
+    <organization-id type="integer">457249</organization-id>
+    <original-recipient-address nil="true"></original-recipient-address>
+    <priority-id type="integer">1</priority-id>
+    <recipient nil="true"></recipient>
+    <requester-id type="integer">26218414</requester-id>
+    <resolution-time type="integer" nil="true"></resolution-time>
+    <solved-at type="datetime" nil="true"></solved-at>
+    <status-id type="integer">1</status-id>
+    <status-updated-at type="datetime">2011-01-31T14:09:12-04:00</status-updated-at>
+    <subject>Testing</subject>
+    <submitter-id type="integer">26218414</submitter-id>
+    <ticket-type-id type="integer">3</ticket-type-id>
+    <updated-at type="datetime">2011-01-31T14:09:12-04:00</updated-at>
+    <updated-by-type-id type="integer">0</updated-by-type-id>
+    <via-id type="integer">0</via-id>
+    <score type="integer">12</score>
+    <problem-id nil="true"></problem-id>
+    <comments type="array">
+      <comment>
+        <author-id type="integer">26218414</author-id>
+        <created-at type="datetime">2011-01-31T14:09:12-04:00</created-at>
+        <is-public type="boolean">true</is-public>
+        <type>Comment</type>
+        <value>Testing</value>
+        <via-id type="integer">0</via-id>
+        <attachments type="array"/>
+      </comment>
+    </comments>
+    <linkings type="array"/>
+    <ticket-field-entries type="array"/>
+    <channel nil="true"></channel>
+  </record>
+  <record>
+    <assigned-at type="datetime">2011-01-31T14:30:31-04:00</assigned-at>
+    <assignee-id type="integer">26218414</assignee-id>
+    <base-score type="integer">72</base-score>
+    <created-at type="datetime">2011-01-31T14:30:31-04:00</created-at>
+    <current-collaborators nil="true"></current-collaborators>
+    <current-tags nil="true"></current-tags>
+    <description>You've got a new ticket!
+
+To help you get started learning how your zendesk simplifies ticket workflow, I emailed you at support@hybridgroup.zendesk.com and this ticket was created in your zendesk. Neat!
+
+You can answer this ticket in one of two ways:
+
+By Email: If you are looking at this in your email inbox, simply hit &quot;Reply&quot;
+
+By Zendesk: If you are looking at this ticket in your zendesk:
+
+* Enter a comment (e.g. &quot;How am I doing?&quot;)
+* Change status from Open to Pending (now, you&#8217;re waiting for me to get back to you!)
+* Click submit
+
+Either way, both your reply and follow-ups will be added to the ticket history and organized in your zendesk.
+
+You&#8217;re eligible for 24-hour support throughout your trial. Please don&#8217;t hesitate to call or email our customer advocate team:
+
+*(e) support@zendesk.com
+*(p) +1 415.418.7506
+
+Thank you for using Zendesk,
+
+Kelly
+Customer Advocate at Zendesk</description>
+    <due-date type="datetime" nil="true"></due-date>
+    <entry-id type="integer" nil="true"></entry-id>
+    <external-id nil="true"></external-id>
+    <group-id type="integer">121752</group-id>
+    <initially-assigned-at type="datetime">2011-01-31T14:30:31-04:00</initially-assigned-at>
+    <latest-recipients nil="true"></latest-recipients>
+    <nice-id type="integer">2</nice-id>
+    <organization-id type="integer" nil="true"></organization-id>
+    <original-recipient-address nil="true"></original-recipient-address>
+    <priority-id type="integer">0</priority-id>
+    <recipient>support@hybridgroup.zendesk.com</recipient>
+    <requester-id type="integer">26220353</requester-id>
+    <resolution-time type="integer" nil="true"></resolution-time>
+    <solved-at type="datetime" nil="true"></solved-at>
+    <status-id type="integer">1</status-id>
+    <status-updated-at type="datetime">2011-01-31T14:30:31-04:00</status-updated-at>
+    <subject>Welcome to Zendesk, You've Got a Ticket!</subject>
+    <submitter-id type="integer">26220353</submitter-id>
+    <ticket-type-id type="integer">0</ticket-type-id>
+    <updated-at type="datetime">2011-01-31T14:30:31-04:00</updated-at>
+    <updated-by-type-id type="integer">1</updated-by-type-id>
+    <via-id type="integer">4</via-id>
+    <score type="integer">72</score>
+    <problem-id nil="true"></problem-id>
+    <comments type="array">
+      <comment>
+        <author-id type="integer">26220353</author-id>
+        <created-at type="datetime">2011-01-31T14:30:31-04:00</created-at>
+        <is-public type="boolean">true</is-public>
+        <type>Comment</type>
+        <value>You've got a new ticket!
+
+To help you get started learning how your zendesk simplifies ticket workflow, I emailed you at support@hybridgroup.zendesk.com and this ticket was created in your zendesk. Neat!
+
+You can answer this ticket in one of two ways:
+
+By Email: If you are looking at this in your email inbox, simply hit &quot;Reply&quot;
+
+By Zendesk: If you are looking at this ticket in your zendesk:
+
+* Enter a comment (e.g. &quot;How am I doing?&quot;)
+* Change status from Open to Pending (now, you&#8217;re waiting for me to get back to you!)
+* Click submit
+
+Either way, both your reply and follow-ups will be added to the ticket history and organized in your zendesk.
+
+You&#8217;re eligible for 24-hour support throughout your trial. Please don&#8217;t hesitate to call or email our customer advocate team:
+
+*(e) support@zendesk.com
+*(p) +1 415.418.7506
+
+Thank you for using Zendesk,
+
+Kelly
+Customer Advocate at Zendesk</value>
+        <via-id type="integer">4</via-id>
+        <attachments type="array"/>
+      </comment>
+    </comments>
+    <linkings type="array"/>
+    <ticket-field-entries type="array"/>
+    <channel nil="true"></channel>
+  </record>
+</records>

data/spec/fixtures/tickets/2.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ticket>
+  <assigned-at>2007-06-03T22:15:44Z</assigned-at>
+  <assignee-id>4</assignee-id>
+  <assignee-updated-at/>
+  <created-at>2007-06-03T20:15:44Z</created-at>
+  <subject></subject>
+  <description>My printer is not working</description>
+  <external-id/>
+  <group-id>2</group-id>
+  <id>2</id>
+  <linked-id/>
+  <priority-id>3</priority-id>
+  <submitter-id>3</submitter-id>
+  <status-id>1</status-id>
+  <status-updated-at>2007-06-03T22:15:44Z</status-updated-at>
+  <requester-id>3</requester-id>
+  <requester-updated-at>2007-06-03T22:15:44Z</requester-updated-at>
+  <ticket-type-id>2</ticket-type-id>
+  <updated-at>2007-06-03T20:15:45Z</updated-at>
+  <via-id>0</via-id>
+  <current-tags>printer hp</current-tags>
+  <score>28</score>
+  <comments type="array">
+    <comment>
+      <author-id>3</author-id>
+      <created-at>2007-06-03T20:15:45Z</created-at>
+      <is-public>true</is-public>
+      <value>This is a comment</value>
+      <via-id>0</via-id>
+      <via-reference-id/>
+    </comment>
+    <comment>
+      <author-id>5</author-id>
+      <created-at>2007-06-04T10:07:02Z</created-at>
+      <is-public>true</is-public>
+      <value>Make sure it is plugged in</value>
+      <via-id>0</via-id>
+      <via-reference-id/>
+    </comment>
+  </comments>
+  <ticket-field-entries type="array">
+    <ticket-field-entry>
+      <ticket-field-id>139</ticket-field-id>
+      <value>Please contact me by phone during work hours</value>
+    </ticket-field-entry>
+    <ticket-field-entry>
+      <ticket-field-id>141</ticket-field-id>
+      <value>true</value>
+    </ticket-field-entry>
+  </ticket-field-entries>
+</ticket>

data/spec/fixtures/tickets/5.xml

@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ticket>
+  <assigned-user-id type="integer" nil="true"></assigned-user-id>
+  <attachments-count type="integer">0</attachments-count>
+  <closed type="boolean">false</closed>
+  <created-at type="datetime">2010-07-03T05:01:48Z</created-at>
+  <creator-id type="integer">67916</creator-id>
+  <milestone-due-on type="datetime" nil="true"></milestone-due-on>
+  <milestone-id type="integer" nil="true"></milestone-id>
+  <number type="integer">5</number>
+  <permalink>tehantuehn</permalink>
+  <priority type="integer">3</priority>
+  <project-id type="integer">54448</project-id>
+  <raw-data type="binary" encoding="base64" nil="true"></raw-data>
+  <state>new</state>
+  <tag nil="true"></tag>
+  <title>tehantuehn</title>
+  <updated-at type="datetime">2010-07-08T02:11:21Z</updated-at>
+  <user-id type="integer">67916</user-id>
+  <user-name>Kia Kroas</user-name>
+  <creator-name>Kia Kroas</creator-name>
+  <url>http://ticketmaster.lighthouseapp.com/projects/54448/tickets/5</url>
+  <original-body>cheuasoht atesuhn</original-body>
+  <latest-body>cheuasoht atesuhn</latest-body>
+  <original-body-html>&lt;div&gt;&lt;p&gt;cheuasoht atesuhn&lt;/p&gt;&lt;/div&gt;</original-body-html>
+  <versions type="array">
+    <version type="Ticket::Version">
+      <assigned-user-id type="integer" nil="true"></assigned-user-id>
+      <attachments-count type="integer">0</attachments-count>
+      <body>cheuasoht atesuhn</body>
+      <body-html>&lt;div&gt;&lt;p&gt;cheuasoht atesuhn&lt;/p&gt;&lt;/div&gt;</body-html>
+      <closed type="boolean">false</closed>
+      <created-at type="datetime">2010-07-03T05:01:48Z</created-at>
+      <creator-id type="integer">67916</creator-id>
+      <diffable-attributes type="yaml">--- {}
+
+</diffable-attributes>
+      <milestone-id type="integer" nil="true"></milestone-id>
+      <number type="integer">5</number>
+      <permalink>tehantuehn</permalink>
+      <priority type="integer">3</priority>
+      <project-id type="integer">54448</project-id>
+      <state>new</state>
+      <tag nil="true"></tag>
+      <title>tehantuehn</title>
+      <updated-at type="datetime">2010-07-03T05:01:51Z</updated-at>
+      <user-id type="integer">67916</user-id>
+      <user-name>Kia Kroas</user-name>
+      <creator-name>Kia Kroas</creator-name>
+      <url>http://ticketmaster.lighthouseapp.com/projects/54448/tickets/5</url>
+    </version>
+    <version type="Ticket::Version">
+      <assigned-user-id type="integer" nil="true"></assigned-user-id>
+      <attachments-count type="integer">0</attachments-count>
+      <body>New Body</body>
+      <body-html>&lt;div&gt;&lt;p&gt;New Body&lt;/p&gt;&lt;/div&gt;</body-html>
+      <closed type="boolean">false</closed>
+      <created-at type="datetime">2010-07-08T02:11:17Z</created-at>
+      <creator-id type="integer">67916</creator-id>
+      <diffable-attributes type="yaml">--- {}
+
+</diffable-attributes>
+      <milestone-id type="integer" nil="true"></milestone-id>
+      <number type="integer">5</number>
+      <permalink>tehantuehn</permalink>
+      <priority type="integer">3</priority>
+      <project-id type="integer">54448</project-id>
+      <state>new</state>
+      <tag nil="true"></tag>
+      <title>tehantuehn</title>
+      <updated-at type="datetime">2010-07-08T02:11:21Z</updated-at>
+      <user-id type="integer">67916</user-id>
+      <user-name>Kia Kroas</user-name>
+      <creator-name>Kia Kroas</creator-name>
+      <url>http://ticketmaster.lighthouseapp.com/projects/54448/tickets/5</url>
+    </version>
+  </versions>
+</ticket>