zendesk2 0.2.0 → 0.2.1

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

@@ -1,33 +1,30 @@
+# @abstract subclass and implement audit event specific attributes
 class Zendesk2::Client::AuditEvent < Cistern::Model
   extend Zendesk2::Attributes
   extend Forwardable
 
-  # @return [Integer] Automatically assigned when creating events
-  identity :id, type: :integer
-  # @return [String] Has the value Comment
+  def self.all
+    @all ||= []
+  end
+
+  def self.inherited(klass)
+    all << klass
+  end
+
+  def self.for(attributes)
+    event_class = "Zendesk2::Client::Ticket#{attributes["type"]}"
+    if klass = all.find{|k| k.name == event_class}
+      klass.new(attributes)
+    else # handle unrecognized audit events
+      attributes.reject{|k,v| k == :connection}
+    end
+  end
+
+  # @return [String] has the event value
   attribute :type, type: :string
-  # @return [String] The actual comment made by the author
-  attribute :body, type: :string
-  # @return [String] The actual comment made by the author formatted to HTML
-  attribute :html_body, type: :string
-  # @return [Boolean] If this is a public comment or an internal agents only note
-  attribute :public, type: :boolean
-  # @return [Boolean] If this comment is trusted or marked as being potentially fraudulent
-  attribute :trusted, type: :boolean
-  # @return [Integer] The id of the author of this comment
-  attribute :author_id, type: :integer
-  # @return [Array] The attachments on this comment as Attachment objects
-  attribute :attachments, type: :array
 
   # @return [Zendesk2::Client::TicketAudit] audit that includes this event
   attr_accessor :ticket_audit
 
   def_delegators :ticket_audit, :created_at
-
-  # @return [Zendesk2::Client::User] event author
-  def author
-    requires :author_id
-
-    self.connection.users.get(self.author_id)
-  end
 end

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

@@ -6,7 +6,7 @@ class Zendesk2::Client::Organization < Zendesk2::Model
   attribute :created_at,      type: :time
   attribute :details,         type: :string
   attribute :domain_names,    type: :array
-  attribute :external_id,     type: :integer
+  attribute :external_id,     type: :string
   attribute :group_id,        type: :integer
   attribute :shared_comments, type: :boolean
   attribute :shared_tickets,  type: :boolean

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

@@ -23,6 +23,6 @@ class Zendesk2::Client::TicketAudit < Cistern::Model
   end
 
   def events
-    (self.attributes[:events] || []).map{|ae| self.connection.audit_event(ae.merge(ticket_audit: self))}
+    (self.attributes[:events] || []).map{|ae| Zendesk2::Client::AuditEvent.for(ae.merge(ticket_audit: self, connection: self.connection))}
   end
 end

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

@@ -0,0 +1,13 @@
+class Zendesk2::Client
+  class TicketChange < AuditEvent
+    # @return [Integer] Automatically assigned when creating events
+    identity :id, type: :integer
+
+    # @return [String] The name of the field that was changed
+    attribute :field_name, type: :string
+    # @return [String] The name of the field that was changed
+    attribute :value, type: :string
+    # @return [Array] The previous value of the field that was changed
+    attribute :previous_value, type: :array, parser: lambda{|v, _| [*v]}
+  end
+end

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

@@ -0,0 +1,26 @@
+class Zendesk2::Client
+  class TicketComment < AuditEvent
+    # @return [Integer] Automatically assigned when creating events
+    identity :id, type: :integer
+
+    # @return [String] The actual comment made by the author
+    attribute :body, type: :string
+    # @return [String] The actual comment made by the author formatted to HTML
+    attribute :html_body, type: :string
+    # @return [Boolean] If this is a public comment or an internal agents only note
+    attribute :public, type: :boolea
+    # @return [Boolean] If this comment is trusted or marked as being potentially fraudulent
+    attribute :trusted, type: :boolean
+    # @return [Integer] The id of the author of this comment
+    attribute :author_id, type: :integer
+    # @return [Array] The attachments on this comment as Attachment objects
+    attribute :attachments, type: :array
+
+    # @return [Zendesk2::Client::User] event author
+    def author
+      requires :author_id
+
+      self.connection.users.get(self.author_id)
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+class Zendesk2::Client
+  class TicketCommentPrivacyChange < AuditEvent
+
+    # @return [integer] Automatically assigned when creating events
+    identity :id, type: :integer
+
+    # @return [Integer] The id if the comment that changed privacy
+    attribute :comment_id, type: :integer
+    # @return [Boolean] Tells if the comment was made public or private
+    attribute :public, type: :boolean
+
+    # @return [Zendesk2::Client::TicketComment] ticket comment pertaining to this privacy change
+    def comment
+      requires :comment_id
+
+      self.connection.ticket_comments.get(self.comment_id)
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+class Zendesk2::Client
+  class TicketCreate < AuditEvent
+    # @return [integer] Automatically assigned when creating events
+    identity :id, type: :integer
+
+    # @return [string] The name of the field that was set
+    attribute :field_name, type: :string
+    # @return [Array] The value of the field that was set
+    attribute :value, parser: lambda{|v, _| [*v]}
+  end
+end

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

@@ -0,0 +1,15 @@
+class Zendesk2::Client
+  class TicketNotification < AuditEvent
+    # @return [Integer] Automatically assigned when creating events
+    identity :id, type: :integer
+
+    # @return [String] The message sent to the recipients
+    attribute :body, type: :string
+    # @return [Array] A array of simple object holding the ids and names of the recipients of this notification
+    attribute :recipients, type: :array
+    # @return [String] The subject of the message sent to the recipients
+    attribute :subject, type: :string
+    # @return [Hash] A reference to the trigger that created this notification
+    attribute :via
+  end
+end

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

@@ -0,0 +1,36 @@
+class Zendesk2::Client
+  class TicketVoiceComment < AuditEvent
+    # @return [integer] Automatically assigned when creating events
+    identity :id, type: :integer
+
+    # @return [Array] The attachments on this comment as Attachment objects
+    attribute :attachments, type: :array
+    # @return [Integer] The id of the author of this comment
+    attribute :author_id, type: :integer
+    # @return [String] The actual comment made by the author
+    attribute :body, type: :string
+    # @return [String] A hash of properties about the call
+    attribute :data, type: :string
+    # @return [String] A formatted version of the phone number which dialed the call
+    attribute :formatted_from, type: :string
+    # @return [String] A formatted version of the phone number which answered the call
+    attribute :formatted_to, type: :string
+    # @return [String] The actual comment made by the author formatted to HTML
+    attribute :html_body, type: :string
+    # @return [Boolean] If this is a public comment or an internal agents only note
+    attribute :public, type: :boolean
+    # @return [Boolean] If true, the ticket requester can see this comment
+    attribute :public, type: :boolean
+    # @return [Boolean] If this comment is trusted or marked as being potentially fraudulent
+    attribute :trusted, type: :boolean
+    # @return [String] Has the value VoiceComment
+    attribute :type, type: :string
+
+    # @return [Zendesk2::Client::User] event author
+    def author
+      requires :author_id
+
+      self.connection.users.get(self.author_id)
+    end
+  end
+end

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

@@ -119,13 +119,14 @@ class Zendesk2::Client::User < Zendesk2::Model
   end
 
   # @return [Zendesk2::Client::Tickets] tickets this user requested
-  def requested_tickets
+  def tickets
     requires :identity
 
     data = connection.get_requested_tickets("id" => self.identity).body["tickets"]
 
     connection.tickets.load(data)
   end
+  alias requested_tickets tickets
 
   # @return [Zendesk2::Client::Tickets] tickets this user is CC'eD
   def ccd_tickets

data/lib/zendesk2/client.rb

@@ -4,6 +4,8 @@ class Zendesk2::Client < Cistern::Service
   model_path "zendesk2/client/models"
   request_path "zendesk2/client/requests"
 
+  require 'zendesk2/client/models/audit_event' # so special
+
   collection :categories
   collection :forums
   collection :groups
@@ -14,13 +16,18 @@ class Zendesk2::Client < Cistern::Service
   collection :topics
   collection :users
   collection :user_identities
-  model :audit_event
   model :category
   model :forum
   model :group
   model :organization
   model :ticket
   model :ticket_audit
+  model :ticket_change
+  model :ticket_comment
+  model :ticket_comment_privacy_change
+  model :ticket_create
+  model :ticket_notification
+  model :ticket_voice_comment
   model :topic
   model :topic_comment
   model :user

data/lib/zendesk2/model.rb

@@ -1,4 +1,4 @@
-# @abstract subclass and implement {#save!}
+# @abstract subclass and implement {#save!} and {#destroy!}
 class Zendesk2::Model < Cistern::Model
   attr_accessor :errors
 

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/tickets_spec.rb

@@ -33,6 +33,8 @@ describe "tickets" do
 
       event = events.first
       event.body.should == body
+      event.should be_a(Zendesk2::Client::TicketComment)
+      event.ticket_audit.should == audit
     end
 
     it "lists comments" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,17 +9,17 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-26 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cistern
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.0
     none: false
+  prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -29,13 +29,13 @@ dependencies:
     none: false
 - !ruby/object:Gem::Dependency
   name: faraday
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
+  prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -45,13 +45,13 @@ dependencies:
     none: false
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
+  prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -61,13 +61,13 @@ dependencies:
     none: false
 - !ruby/object:Gem::Dependency
   name: addressable
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
+  prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -105,6 +105,12 @@ files:
 - lib/zendesk2/client/models/ticket.rb
 - lib/zendesk2/client/models/ticket_audit.rb
 - lib/zendesk2/client/models/ticket_audits.rb
+- 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_create.rb
+- lib/zendesk2/client/models/ticket_notification.rb
+- lib/zendesk2/client/models/ticket_voice_comment.rb
 - lib/zendesk2/client/models/tickets.rb
 - lib/zendesk2/client/models/topic.rb
 - lib/zendesk2/client/models/topic_comment.rb
@@ -210,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Zendesk V2 API client
@@ -227,4 +233,3 @@ test_files:
 - spec/topics_spec.rb
 - spec/user_identities_spec.rb
 - spec/users_spec.rb
-has_rdoc: