zendesk2 0.3.0 → 0.3.1

data/lib/zendesk2/client/models/ticket.rb

@@ -115,9 +115,14 @@ class Zendesk2::Client::Ticket < Zendesk2::Model
     self.connection.ticket_audits(ticket_id: self.identity).all
   end
 
-  # @return [Array<Zendesk2::Client::AuditEvent>] audit events of type 'Comment'
+  # @return [Zendesk2::Client::TicketMetric] metrics for this ticket
+  def metrics
+    Zendesk2::Client::TicketMetric.new(self.connection.get_ticket_metric("ticket_id" => self.identity).body["ticket_metric"])
+  end
+
+  # @return [Array<Zendesk2::Client::TicketComment>] all comments for this ticket
   def comments
-    audits.map{|audit| audit.events.select{|e| e.type == "Comment"}}.flatten
+    self.connection.ticket_comments(ticket_id: self.identity).all
   end
 
   private

data/lib/zendesk2/client/models/ticket_comments.rb

@@ -0,0 +1,23 @@
+class Zendesk2::Client::TicketComments < Zendesk2::Collection
+
+  model Zendesk2::Client::TicketComment
+
+  attribute :ticket_id, type: :integer
+
+  self.collection_method = :get_ticket_comments
+  self.collection_root   = "comments"
+
+  def ticket
+    self.connection.tickets.get(self.ticket_id)
+  end
+
+  def all(params={})
+    requires :ticket_id
+
+    body = connection.send(collection_method, {"ticket_id" => self.ticket_id}.merge(params)).body
+
+    collection = self.clone.load(body[collection_root])
+    collection.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+    collection
+  end
+end

data/lib/zendesk2/client/models/ticket_metric.rb

@@ -0,0 +1,54 @@
+class Zendesk2::Client::TicketMetric < Cistern::Model
+  extend Zendesk2::Attributes
+
+  # @return [Integer] Automatically assigned
+  identity :id, type: :integer
+  # @return [Integer] The ID of the associated ticket
+  attribute :ticket_id, type: :integer
+  # @return [Time] The time the audit was created
+  attribute :created_at, type: :time
+  # @return [Time] The time the audit was last updated
+  attribute :updated_at, type: :time
+
+  # @return [Integer] Number of groups this ticket passed through
+  attribute :group_stations, type: :integer
+  # @return [Integer] Number of assignees this ticket had
+  attribute :assignee_stations, type: :integer
+  # @return [Integer] Total number of times the ticket was reopened
+  attribute :reopens, type: :integer
+  # @return [Integer] Total number of times ticket was replied to
+  attribute :replies, type: :integer
+
+  # @return [Time] When the assignee last updated the ticket
+  attribute :assignee_updated_at, type: :time
+  # @return [Time] When the requester last updated the ticket
+  attribute :requester_updated_at, type: :time
+  # @return [Time] When the status was last updated
+  attribute :status_updated_at, type: :time
+  # @return [Time] When the ticket was initially assigned
+  attribute :initially_assigned_at, type: :time
+  # @return [Time] When the ticket was last assigned
+  attribute :assigned_at, type: :time
+  # @return [Time] When the ticket was solved
+  attribute :solved_at, type: :time
+  # @return [Time] When the latest comment was added
+  attribute :latest_comment_added_at, type: :time
+
+  # @return [Hash] Number of minutes to the first resolution time inside and out of business hours
+  attribute :first_resolution_time_in_minutes
+  # @return [Hash] Number of minutes to the first reply inside and out of business hours
+  attribute :reply_time_in_minutes
+  # @return [Hash] Number of minutes to the full resolution inside and out of business hours
+  attribute :full_resolution_time_in_minutes
+  # @return [Hash] Number of minutes the agent spent waiting inside and out of business hours
+  attribute :agent_wait_time_in_minutes
+  # @return [Hash] Number of minutes the requester spent waiting inside and out of business hours
+  attribute :requester_wait_time_in_minutes
+
+  def ticket
+    requires :ticket_id
+
+    self.connection.tickets.get(self.ticket_id)
+  end
+
+end

data/lib/zendesk2/client/models/ticket_metrics.rb

@@ -0,0 +1,10 @@
+class Zendesk2::Client::TicketMetrics < Zendesk2::Collection
+  model Zendesk2::Client::TicketMetric
+
+  attribute :ticket_id, type: :integer
+
+  self.collection_method = :get_ticket_metrics
+  self.collection_root   = "ticket_metrics"
+  self.model_method      = :get_ticket_metric
+  self.model_root        = "ticket_metric"
+end

data/lib/zendesk2/client/requests/get_ticket_comments.rb

@@ -0,0 +1,22 @@
+class Zendesk2::Client
+  class Real
+    def get_ticket_comments(params={})
+      ticket_id = params["ticket_id"]
+      request(
+        :method => :get,
+        :path => "/tickets/#{ticket_id}/comments.json"
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_ticket_comments(params={})
+      ticket_id = params["ticket_id"]
+
+      page(params,
+           :ticket_comments,
+           "/tickets/#{ticket_id}/comments.json",
+           "comments")
+    end
+  end # Mock
+end

data/lib/zendesk2/client/requests/get_ticket_metric.rb

@@ -0,0 +1,43 @@
+class Zendesk2::Client
+  class Real
+    def get_ticket_metric(params={})
+      id        = params["id"]
+      ticket_id = params["ticket_id"]
+      if id
+        request(
+          :method => :get,
+          :path => "/ticket_metrics/#{id}.json"
+        )
+      else
+        request(
+          :method => :get,
+          :path => "/tickets/#{ticket_id}/metrics.json"
+        )
+      end
+    end
+  end # Real
+
+  class Mock
+    def get_ticket_metric(params={})
+      id        = params["id"]
+      ticket_id = params["ticket_id"]
+
+      path = "/tickets_metrics/#{id}.json"
+
+      if body = self.data[:ticket_metrics][id]
+        response(
+          :path => path,
+          :body => {
+            "ticket_metric" => body
+          },
+        )
+      else
+        response(
+          :path   => path,
+          :status => 404,
+          :body   => {"error" => "RecordNotFound", "description" => "Not found"},
+        )
+      end
+    end
+  end # Mock
+end

data/lib/zendesk2/client/requests/get_ticket_metrics.rb

@@ -0,0 +1,22 @@
+class Zendesk2::Client
+  class Real
+    def get_ticket_metrics(params={})
+      page_params = Zendesk2.paging_parameters(params)
+
+      request(
+        :params => page_params,
+        :method => :get,
+        :path   => "/ticket_metrics.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_ticket_metrics(params={})
+      page(params,
+           :ticket_metrics,
+           "/ticket_metrics.json",
+           "metrics")
+    end
+  end
+end

data/lib/zendesk2/client/requests/update_ticket.rb

@@ -18,6 +18,18 @@ class Zendesk2::Client
       body      = self.data[:tickets][ticket_id].merge!(params)
 
       if comment = params["comment"]
+        comment_id = self.class.new_id
+        comment_data = self.data[:ticket_comments][comment_id] = {
+            "id"          => comment_id,
+            "type"        => "Comment",
+            "author_id"   => current_user["id"],
+            "body"        => comment["body"],
+            "html_body"   => "<p>#{comment["body"]}</p>",
+            "public"      => comment["public"].nil? ? true : comment["public"],
+            "trusted"     => comment["trusted"].nil? ? true : comment["trusted"],
+            "attachments" => comment["attachments"] || [],
+        }
+
         audit_id = self.class.new_id
         self.data[:ticket_audits][audit_id] = {
           "id"         => audit_id,
@@ -42,16 +54,7 @@ class Zendesk2::Client
             },
             "custom" => {},
           },
-          "events" => [
-            "id"          => self.class.new_id,
-            "type"        => "Comment",
-            "author_id"   => current_user["id"],
-            "body"        => comment["body"],
-            "html_body"   => "<p>#{comment["body"]}</p>",
-            "public"      => comment["public"].nil? ? true : comment["public"],
-            "trusted"     => comment["trusted"].nil? ? true : comment["trusted"],
-            "attachments" => comment["attachments"] || [],
-          ]
+          "events" => [comment_data]
         }
       end
 

data/lib/zendesk2/client.rb

@@ -11,7 +11,9 @@ class Zendesk2::Client < Cistern::Service
   collection :groups
   collection :organizations
   collection :ticket_audits
+  collection :ticket_metrics
   collection :tickets
+  collection :ticket_comments
   collection :topic_comments
   collection :topics
   collection :users
@@ -22,6 +24,7 @@ class Zendesk2::Client < Cistern::Service
   model :organization
   model :ticket
   model :ticket_audit
+  model :ticket_metric
   model :ticket_change
   model :ticket_comment
   model :ticket_comment_privacy_change
@@ -70,6 +73,9 @@ class Zendesk2::Client < Cistern::Service
   request :get_ticket
   request :get_ticket_audit
   request :get_ticket_audits
+  request :get_ticket_comments
+  request :get_ticket_metric
+  request :get_ticket_metrics
   request :get_tickets
   request :get_topic
   request :get_topic_comment
@@ -171,6 +177,8 @@ class Zendesk2::Client < Cistern::Service
         :identities     => {},
         :organizations  => {},
         :ticket_audits  => {},
+        :ticket_comments => {},
+        :ticket_metrics => {},
         :tickets        => {},
         :topic_comments => {},
         :topics         => {},

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -125,7 +125,10 @@ files:
 - lib/zendesk2/client/models/ticket_change.rb
 - lib/zendesk2/client/models/ticket_comment.rb
 - lib/zendesk2/client/models/ticket_comment_privacy_change.rb
+- lib/zendesk2/client/models/ticket_comments.rb
 - lib/zendesk2/client/models/ticket_create.rb
+- lib/zendesk2/client/models/ticket_metric.rb
+- lib/zendesk2/client/models/ticket_metrics.rb
 - lib/zendesk2/client/models/ticket_notification.rb
 - lib/zendesk2/client/models/ticket_voice_comment.rb
 - lib/zendesk2/client/models/tickets.rb
@@ -174,6 +177,9 @@ files:
 - lib/zendesk2/client/requests/get_ticket.rb
 - lib/zendesk2/client/requests/get_ticket_audit.rb
 - lib/zendesk2/client/requests/get_ticket_audits.rb
+- lib/zendesk2/client/requests/get_ticket_comments.rb
+- lib/zendesk2/client/requests/get_ticket_metric.rb
+- lib/zendesk2/client/requests/get_ticket_metrics.rb
 - lib/zendesk2/client/requests/get_tickets.rb
 - lib/zendesk2/client/requests/get_topic.rb
 - lib/zendesk2/client/requests/get_topic_comment.rb
@@ -254,3 +260,4 @@ test_files:
 - spec/topics_spec.rb
 - spec/user_identities_spec.rb
 - spec/users_spec.rb
+has_rdoc: