zendesk2 1.9.0 → 1.10.0

data/lib/zendesk2/ticket_change.rb

@@ -1,13 +1,12 @@
-class Zendesk2
-  class TicketChange < AuditEvent
-    # @return [Integer] Automatically assigned when creating events
-    identity :id, type: :integer
+# frozen_string_literal: true
+class Zendesk2::TicketChange < Zendesk2::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
+  # @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: ->(v, _) { [*v] }
 end

data/lib/zendesk2/ticket_comment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::TicketComment < Zendesk2::AuditEvent
   # @return [Integer] Automatically assigned when creating events
   identity :id, type: :integer
@@ -19,6 +20,6 @@ class Zendesk2::TicketComment < Zendesk2::AuditEvent
   def author
     requires :author_id
 
-    self.cistern.users.get(self.author_id)
+    cistern.users.get(author_id)
   end
 end

data/lib/zendesk2/ticket_comment_privacy_change.rb

@@ -1,19 +1,17 @@
-class Zendesk2
-  class TicketCommentPrivacyChange < AuditEvent
+# frozen_string_literal: true
+class Zendesk2::TicketCommentPrivacyChange < AuditEvent
+  # @return [integer] Automatically assigned when creating events
+  identity :id, type: :integer
 
-    # @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 [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::TicketComment] ticket comment pertaining to this privacy change
+  def comment
+    requires :comment_id
 
-    # @return [Zendesk2::TicketComment] ticket comment pertaining to this privacy change
-    def comment
-      requires :comment_id
-
-      self.cistern.ticket_comments.get(self.comment_id)
-    end
+    cistern.ticket_comments.get(comment_id)
   end
 end

data/lib/zendesk2/ticket_comments.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::TicketComments
   include Zendesk2::Collection
 
@@ -8,19 +9,19 @@ class Zendesk2::TicketComments
   attribute :ticket_id, type: :integer
 
   self.collection_method = :get_ticket_comments
-  self.collection_root   = "comments"
+  self.collection_root   = 'comments'
 
   def ticket
-    self.cistern.tickets.get(self.ticket_id)
+    cistern.tickets.get(ticket_id)
   end
 
-  def all(params={})
+  def all(params = {})
     requires :ticket_id
 
-    body = cistern.send(collection_method, {"ticket_id" => self.ticket_id}.merge(params)).body
+    body = cistern.send(collection_method, { 'ticket_id' => 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 = clone.load(body[collection_root])
+    collection.merge_attributes(Cistern::Hash.slice(body, 'count', 'next_page', 'previous_page'))
     collection
   end
 end

data/lib/zendesk2/ticket_create.rb

@@ -1,11 +1,10 @@
-class Zendesk2
-  class TicketCreate < AuditEvent
-    # @return [integer] Automatically assigned when creating events
-    identity :id, type: :integer
+# frozen_string_literal: true
+class Zendesk2::TicketCreate < Zendesk2::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
+  # @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: ->(v, _) { [*v] }
 end

data/lib/zendesk2/ticket_field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::TicketField
   include Zendesk2::Model
 
@@ -49,12 +50,12 @@ class Zendesk2::TicketField
     data = if new_record?
              requires :type, :title
 
-             cistern.create_ticket_field("ticket_field" => self.attributes)
+             cistern.create_ticket_field('ticket_field' => attributes)
            else
              requires :identity
 
-             cistern.update_ticket_field("ticket_field" => self.attributes)
-           end.body["ticket_field"]
+             cistern.update_ticket_field('ticket_field' => attributes)
+           end.body['ticket_field']
 
     merge_attributes(data)
   end
@@ -62,6 +63,6 @@ class Zendesk2::TicketField
   def destroy!
     requires :identity
 
-    cistern.destroy_ticket_field("ticket_field" => { "id" => self.identity })
+    cistern.destroy_ticket_field('ticket_field' => { 'id' => identity })
   end
 end

data/lib/zendesk2/ticket_fields.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::TicketFields
   include Zendesk2::Collection
 
@@ -8,8 +9,8 @@ class Zendesk2::TicketFields
   attribute :count, type: :integer
 
   self.collection_method = :get_ticket_fields
-  self.collection_root   = "ticket_fields"
+  self.collection_root   = 'ticket_fields'
   self.model_method      = :get_ticket_field
-  self.model_root        = "ticket_field"
-  self.search_type       = "ticket_field"
+  self.model_root        = 'ticket_field'
+  self.search_type       = 'ticket_field'
 end

data/lib/zendesk2/ticket_metric.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::TicketMetric < Cistern::Model
   extend Zendesk2::Attributes
 
@@ -48,7 +49,6 @@ class Zendesk2::TicketMetric < Cistern::Model
   def ticket
     requires :ticket_id
 
-    self.cistern.tickets.get(self.ticket_id)
+    cistern.tickets.get(ticket_id)
   end
-
 end

data/lib/zendesk2/ticket_metrics.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 class Zendesk2::TicketMetrics < Zendesk2::PagedCollection
   model Zendesk2::TicketMetric
 
   attribute :ticket_id, type: :integer
 
   self.collection_method = :get_ticket_metrics
-  self.collection_root   = "ticket_metrics"
+  self.collection_root   = 'ticket_metrics'
   self.model_method      = :get_ticket_metric
-  self.model_root        = "ticket_metric"
+  self.model_root        = 'ticket_metric'
 end

data/lib/zendesk2/ticket_notification.rb

@@ -1,15 +1,14 @@
-class Zendesk2
-  class TicketNotification < AuditEvent
-    # @return [Integer] Automatically assigned when creating events
-    identity :id, type: :integer
+# frozen_string_literal: true
+class Zendesk2::TicketNotification < Zendesk2::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
+  # @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

data/lib/zendesk2/ticket_voice_comment.rb

@@ -1,34 +1,33 @@
-class Zendesk2
-  class TicketVoiceComment < AuditEvent
-    # @return [Integer] Automatically assigned when creating events
-    identity :id, type: :integer
+# frozen_string_literal: true
+class Zendesk2::TicketVoiceComment < Zendesk2::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 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 [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 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::User] event author
-    def author
-      requires :author_id
+  # @return [Zendesk2::User] event author
+  def author
+    requires :author_id
 
-      self.cistern.users.get(self.author_id)
-    end
+    cistern.users.get(author_id)
   end
 end

data/lib/zendesk2/tickets.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::Tickets
   include Zendesk2::Collection
 
@@ -14,12 +15,12 @@ class Zendesk2::Tickets
   assoc_accessor :requester
   assoc_accessor :collaborator
 
-  self.collection_root = "tickets"
+  self.collection_root = 'tickets'
   self.model_method    = :get_ticket
-  self.model_root      = "ticket"
-  self.search_type     = "ticket"
+  self.model_root      = 'ticket'
+  self.search_type     = 'ticket'
 
-  def collection_page(params={})
+  def collection_page(params = {})
     collection_method = if requester_id
                           :get_requested_tickets
                         elsif collaborator_id
@@ -30,10 +31,10 @@ class Zendesk2::Tickets
                           :get_tickets
                         end
 
-    body = cistern.send(collection_method, Cistern::Hash.stringify_keys(self.attributes.merge(params))).body
+    body = cistern.send(collection_method, Cistern::Hash.stringify_keys(attributes.merge(params))).body
 
-    self.load(body[collection_root]) # 'results' is the key for paged searches
-    self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+    load(body[collection_root]) # 'results' is the key for paged searches
+    merge_attributes(Cistern::Hash.slice(body, 'count', 'next_page', 'previous_page'))
     self
   end
 

data/lib/zendesk2/topic.rb

@@ -1,24 +1,51 @@
+# frozen_string_literal: true
 class Zendesk2::Topic
   include Zendesk2::Model
 
   extend Zendesk2::Attributes
 
-  identity :id, type: :integer # ro[yes] mandatory[no]   Automatically assigned upon creation
-
-  attribute :url,          type: :string  # ro[yes] mandatory[no]   The API url of this topic
-  attribute :title,        type: :string  # ro[no] mandatory[yes]   The title of the topic
-  attribute :body,         type: :string  # ro[no] mandatory[yes] The unescaped body of the topic
-  attribute :topic_type,   type: :string  # ro[yes] mandatory[no] The type of topic. Either "articles", "ideas" or "questions"
-  attribute :submitter_id, type: :integer # ro[no] mandatory[no]  The id of the user who submitted the topic
-  attribute :updater_id,   type: :integer # ro[no] mandatory[no]  The id of the person to last update the topic
-  attribute :forum_id,     type: :integer # ro[no] mandatory[no]  Forum that the topic is associated to
-  attribute :locked,       type: :boolean # ro[no] mandatory[no]  Whether comments are allowed
-  attribute :pinned,       type: :boolean # ro[no] mandatory[no]  If the topic is marked as pinned and hence eligible to show up on the front page
-  attribute :highlighted,  type: :boolean # ro[no] mandatory[no]    Set to true to highlight a topic within its forum
-  attribute :answered,     type: :boolean # ro[yes] mandatory[no]   Set to true if the topic is a question and it has been marked as answered.
-  attribute :position,     type: :integer # ro[no] mandatory[no]  The position of this topic relative to other topics in the same forum
-  attribute :tags,         type: :array   # ro[no] mandatory[no]  The tags set on the topic
-  attribute :created_at,   type: :time    # ro[yes] mandatory[no] The time the topic was created
+  # @return [integer] Automatically assigned upon creation
+  identity :id, type: :integer # ro: yes, required: no
+
+  # @return [string] The API url of this topic
+  attribute :url, type: :string # ro: yes, required: no
+  # @return [string] The title of the topic
+  attribute :title, type: :string # ro: no, required: yes
+  # @return [string] The unescaped body of the topic
+  attribute :body, type: :string # ro: no, required: yes
+  # @return [string] The type of topic. Either "articles", "ideas" or "questions"
+  attribute :topic_type, type: :string # ro: yes, required: no
+  # @return [integer] The id of the user who submitted the topic
+  attribute :submitter_id, type: :integer # ro: no, required: no
+  # @return [integer] The id of the person to last update the topic
+  attribute :updater_id, type: :integer # ro: no, required: no
+  # @return [integer] Forum that the topic is associated to
+  attribute :forum_id, type: :integer # ro: no, required: no
+  # @return [boolean] Whether comments are allowed
+  attribute :locked, type: :boolean # ro: no, required: no
+  # @return [boolean] If the topic is marked as pinned and hence eligible to show up on the front page
+  attribute :pinned, type: :boolean # ro: no, required: no
+  # @return [boolean] Set to true to highlight a topic within its forum
+  attribute :highlighted, type: :boolean # ro: no, required: no
+  # @return [boolean] Set to true if the topic is a question and it has been marked as answered.
+  attribute :answered, type: :boolean # ro: yes, required: no
+  # @return [integer] The number of comments on this topic
+  attribute :comments_count, type: :integer # ro: yes, required: no
+  # @return [array] The search phrases set on the topic
+  attribute :search_phrases, type: :array # ro: no, required: no
+  # @return [integer] The position of this topic relative to other topics in the same forum when the topics are
+  #   ordered manually
+  attribute :position, type: :integer # ro: no, required: no
+  # @return [array] The tags set on the topic
+  attribute :tags, type: :array # ro: no, required: no
+  # @return [date] The time the topic was created
+  attribute :created_at, type: :date # ro: yes, required: no
+  # @return [date] The time of the last update of the topic
+  attribute :updated_at, type: :date # ro: yes, required: no
+  # @return [array] The attachments on this comment as Attachment objects
+  attribute :attachments, type: :array # ro: yes, required: no
+  # @return [array] List of upload tokens for adding attachments
+  attribute :uploads, type: :array # ro: no, required: no
 
   assoc_accessor :submitter, collection: :users
   assoc_accessor :updater, collection: :users
@@ -27,24 +54,24 @@ class Zendesk2::Topic
   def destroy!
     requires :identity
 
-    cistern.destroy_topic("topic" => {"id" => self.identity})
+    cistern.destroy_topic('topic' => { 'id' => identity })
   end
 
   def save!
     data = if new_record?
              requires :title, :body
 
-             cistern.create_topic("topic" => self.attributes)
+             cistern.create_topic('topic' => attributes)
            else
              requires :identity
 
-             cistern.update_topic("topic" => self.attributes)
-           end.body["topic"]
+             cistern.update_topic('topic' => attributes)
+           end
 
-    merge_attributes(data)
+    merge_attributes(data.body['topic'])
   end
 
   def comments
-    self.topic_comments(topic_id: topic_id)
+    topic_comments(topic_id: topic_id)
   end
 end

data/lib/zendesk2/topic_comment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::TopicComment
   include Zendesk2::Model
 
@@ -29,30 +30,32 @@ class Zendesk2::TopicComment
   def destroy!
     requires :identity
 
-    cistern.destroy_topic_comment("topic_comment" => { "id" => self.identity, "topic_id" => self.topic_id })
+    cistern.destroy_topic_comment('topic_comment' => { 'id' => identity, 'topic_id' => topic_id })
   end
 
   def save!
     response = if new_record?
                  requires :topic_id, :user_id, :body
 
-                 cistern.create_topic_comment("topic_comment" => self.attributes)
+                 cistern.create_topic_comment('topic_comment' => attributes)
                else
                  requires :identity
 
-                 cistern.update_topic_comment("topic_comment" => self.attributes)
+                 cistern.update_topic_comment('topic_comment' => attributes)
                end
 
-    merge_attributes(response.body["topic_comment"])
+    merge_attributes(response.body['topic_comment'])
   end
 
   def reload
     requires :identity
 
-    if data = self.cistern.topic_comments("topic_id" => topic_id).get(identity)
-      new_attributes = data.attributes
-      merge_attributes(new_attributes)
-      self
-    end
+    data = cistern.topic_comments('topic_id' => topic_id).get(identity)
+
+    return unless data
+
+    new_attributes = data.attributes
+    merge_attributes(new_attributes)
+    self
   end
 end