zendesk2 1.4.2 → 1.5.3

data/lib/zendesk2/{model.rb → client/model.rb}

@@ -1,5 +1,4 @@
-# @abstract subclass and implement {#save!} and {#destroy!}
-class Zendesk2::Model < Cistern::Model
+class Zendesk2::Client::Model
   attr_accessor :errors
 
   # @abstract override in subclass
@@ -29,6 +28,11 @@ class Zendesk2::Model < Cistern::Model
 
   # re-define Cistern::Attributes#missing_attributes to require non-blank
   def missing_attributes(args)
-    ([:connection] | args).select{|arg| val = send("#{arg}"); val.nil? || val == "" }
+    ([:service] | args).select{|arg| val = send("#{arg}"); val.nil? || val == "" }
+  end
+
+  def update!(attributes)
+    merge_attributes(attributes)
+    save!
   end
 end

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

@@ -1,5 +1,5 @@
 # @abstract subclass and implement audit event specific attributes
-class Zendesk2::Client::AuditEvent < Cistern::Model
+class Zendesk2::Client::AuditEvent < Zendesk2::Client::Model
   extend Zendesk2::Attributes
   extend Forwardable
 
@@ -16,7 +16,7 @@ class Zendesk2::Client::AuditEvent < Cistern::Model
     if klass = all.find{|k| k.name == event_class}
       klass.new(attributes)
     else # handle unrecognized audit events
-      attributes.reject{|k,v| k == :connection}
+      attributes.reject{|k,v| k == :service}
     end
   end
 

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

@@ -1,5 +1,4 @@
-class Zendesk2::Client::Category < Zendesk2::Model
-  PARAMS = %w[id name description position]
+class Zendesk2::Client::Category < Zendesk2::Client::Model
 
   # @return [Integer] Automatically assigned during creation
   identity :id, type: :integer
@@ -18,27 +17,28 @@ class Zendesk2::Client::Category < Zendesk2::Model
   attribute :url, type: :string
 
   def destroy!
-    requires :id
+    requires :identity
 
-    connection.destroy_category("id" => self.id)
+    service.destroy_category("category" => {"id" => self.identity})
   end
 
   def save!
     data = if new_record?
              requires :name
 
-             connection.create_category(params).body["category"]
+             service.create_category(params).body["category"]
            else
              requires :identity
 
-             connection.update_category(params).body["category"]
+             service.update_category(params).body["category"]
            end
+
     merge_attributes(data)
   end
 
-  private
+  protected
 
   def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+    {"category" => Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *Zendesk2::Client::CreateCategory.accepted_attributes)}
   end
 end

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

@@ -1,8 +1,6 @@
-class Zendesk2::Client::Forum < Zendesk2::Model
+class Zendesk2::Client::Forum < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
-  PARAMS = %w[id name description category_id organization_id locale_id locked position forum_type access]
-
   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 forum
   attribute :name,              type: :string  # ro no mandatory yes The name of the forum
@@ -24,23 +22,20 @@ class Zendesk2::Client::Forum < Zendesk2::Model
   def destroy!
     requires :identity
 
-    connection.destroy_forum("id" => self.identity)
+    service.destroy_forum("forum" => {"id" => self.identity})
   end
 
   def save!
-    data = if new_record?
-             requires :name
-             connection.create_forum(params).body["forum"]
-           else
-             requires :identity
-             connection.update_forum(params).body["forum"]
-           end
-    merge_attributes(data)
-  end
+    response = if new_record?
+                 requires :name
+
+                 service.create_forum("forum" => self.attributes)
+               else
+                 requires :identity
 
-  private
+                 service.update_forum("forum" => self.attributes)
+               end
 
-  def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+    merge_attributes(response.body["forum"])
   end
 end

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

@@ -1,8 +1,6 @@
-class Zendesk2::Client::Group < Zendesk2::Model
+class Zendesk2::Client::Group < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
-  PARAMS = %w[name]
-
   # @return [Integer] Automatically assigned when creating groups
   identity :id, type: :integer
 
@@ -20,11 +18,13 @@ class Zendesk2::Client::Group < Zendesk2::Model
   def save!
     data = if new_record?
              requires :name
-             connection.create_group(params).body["group"]
+
+             service.create_group("group" => self.attributes)
            else
              requires :identity
-             connection.update_group(params.merge("id" => self.identity)).body["group"]
-           end
+
+             service.update_group("group" => self.attributes)
+           end.body["group"]
 
     merge_attributes(data)
   end
@@ -32,17 +32,12 @@ class Zendesk2::Client::Group < Zendesk2::Model
   def destroy!
     requires :identity
 
-    connection.destroy_group("id" => self.identity)
+    service.destroy_group("group" => {"id" => self.identity})
+
     self.deleted = true
   end
 
   def destroyed?
     self.deleted
   end
-
-  private
-
-  def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
-  end
 end

data/lib/zendesk2/client/models/help_center/article.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::HelpCenter::Article < Zendesk2::Model
+class Zendesk2::Client::HelpCenter::Article < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
   # @return [Integer] Automatically assigned when the article is created
@@ -44,26 +44,22 @@ class Zendesk2::Client::HelpCenter::Article < Zendesk2::Model
   assoc_accessor :section, collection: :help_center_sections
 
   def save!
-    requires :title, :locale, :section_id
+    response = if new_record?
+                 requires :title, :locale, :section_id
 
-    data = if new_record?
-             connection.create_help_center_article(params).body["article"]
-           else
-             connection.update_help_center_article(dirty_attributes.merge("id" => self.identity)).body["article"]
-           end
+                 service.create_help_center_article("article" => self.attributes)
+               else
+                 requires :identity
 
-    merge_attributes(data)
-  end
-
-  def destroy!
-    requires :id
+                 service.update_help_center_article("article" => self.attributes)
+               end
 
-    connection.destroy_help_center_article(id)
+    merge_attributes(response.body["article"])
   end
 
-  private
+  def destroy!
+    requires :identity
 
-  def params
-    Cistern::Hash.slice(self.attributes, :author_id, :body, :comments_disabled, :draft, :label_names, :locale, :position, :promoted, :section_id, :title)
+    service.destroy_help_center_article("article" => { "id" => self.identity })
   end
 end

data/lib/zendesk2/client/models/help_center/category.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::HelpCenter::Category < Zendesk2::Model
+class Zendesk2::Client::HelpCenter::Category < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
   # @return [Integer] Automatically assigned when creating categories
@@ -28,26 +28,22 @@ class Zendesk2::Client::HelpCenter::Category < Zendesk2::Model
   attribute :url, type: :string # ro:yes required:no
 
   def save!
-    requires :name, :locale
+    response = if new_record?
+                 requires :name, :locale
 
-    data = if new_record?
-             connection.create_help_center_category(params).body["category"]
-           else
-             connection.update_help_center_category(dirty_attributes.merge("id" => self.identity)).body["category"]
-           end
+                 service.create_help_center_category("category" => self.attributes)
+               else
+                 requires :identity
 
-    merge_attributes(data)
-  end
-
-  def destroy!
-    requires :id
+                 service.update_help_center_category("category" => self.attributes)
+               end
 
-    connection.destroy_help_center_category(id)
+    merge_attributes(response.body["category"])
   end
 
-  private
+  def destroy!
+    requires :identity
 
-  def params
-    Cistern::Hash.slice(self.attributes, :category_id, :description, :locale, :name, :position, :sorting)
+    service.destroy_help_center_category("category" => { "id" => self.identity })
   end
 end

data/lib/zendesk2/client/models/help_center/section.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::HelpCenter::Section < Zendesk2::Model
+class Zendesk2::Client::HelpCenter::Section < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
   # @return [Integer] Automatically assigned when creating subscriptions
@@ -35,26 +35,22 @@ class Zendesk2::Client::HelpCenter::Section < Zendesk2::Model
   assoc_accessor :category, collection: :help_center_categories
 
   def save!
-    requires :name, :locale, :category_id
+    response = if new_record?
+                 requires :name, :locale, :category_id
 
-    data = if new_record?
-             connection.create_help_center_section(params).body["section"]
-           else
-             connection.update_help_center_section(dirty_attributes.merge("id" => self.identity)).body["section"]
-           end
+                 service.create_help_center_section("section" => self.attributes)
+               else
+                 requires :identity
 
-    merge_attributes(data)
-  end
-
-  def destroy!
-    requires :id
+                 service.update_help_center_section("section" => self.attributes)
+               end
 
-    connection.destroy_help_center_section(id)
+    merge_attributes(response.body["section"])
   end
 
-  private
+  def destroy!
+    requires :identity
 
-  def params
-    Cistern::Hash.slice(self.attributes, :category_id, :description, :locale, :name, :position, :sorting)
+    service.destroy_help_center_section("section" => { "id" => self.identity })
   end
 end

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

@@ -1,8 +1,6 @@
-class Zendesk2::Client::Membership < Zendesk2::Model
+class Zendesk2::Client::Membership < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
-  PARAMS = %w[user_id organization_id default]
-
   # @return [Integer] Automatically assigned upon creation
   identity :id, type: :integer
 
@@ -26,31 +24,31 @@ class Zendesk2::Client::Membership < Zendesk2::Model
     data = if new_record?
              requires :organization_id, :user_id
 
-             connection.create_membership(params).body["organization_membership"]
+             service.create_membership("membership" => self.attributes).body["organization_membership"]
            else
              requires :identity
 
              raise ArgumentError, "update not implemented"
            end
+
     merge_attributes(data)
   end
 
   def destroy!
     requires :identity
 
-    connection.destroy_membership("id" => self.identity)
+    service.destroy_membership("membership" => { "id" => self.identity })
   end
 
   def default!
     requires :identity, :user_id
 
-    self.connection.mark_membership_default("user_id" => self.user_id, "id" => self.identity)
-    self.default = true
-  end
-
-  private
+    self.service.mark_membership_default(
+      "membership" => {
+        "user_id" => self.user_id,
+        "id"      => self.identity
+      })
 
-  def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+    self.default = true
   end
 end

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

@@ -1,5 +1,4 @@
-class Zendesk2::Client::Organization < Zendesk2::Model
-  PARAMS = %w[id details domain_names external_id group_id organization_fields shared_comments shared_tickets tags name notes]
+class Zendesk2::Client::Organization < Zendesk2::Client::Model
 
   # @return [integer] Automatically assigned when creating organization
   identity :id, type: :integer # ro[yes] required[no]
@@ -34,51 +33,45 @@ class Zendesk2::Client::Organization < Zendesk2::Model
   def destroy!
     requires :identity
 
-    connection.destroy_organization("id" => self.identity)
+    service.destroy_organization("organization" => {"id" => self.identity})
   end
 
   def save!
     data = if new_record?
              requires :name
 
-             connection.create_organization(params).body["organization"]
+             service.create_organization("organization" => self.attributes)
            else
              requires :identity
 
-             connection.update_organization(params).body["organization"]
-           end
+             service.update_organization("organization" => self.attributes)
+           end.body["organization"]
+
     merge_attributes(data)
   end
 
   # @return [Zendesk2::Client::Users] users associated with this organization
   def users
     requires :identity
-    data = connection.get_organization_users("id" => self.identity).body["users"]
 
-    connection.users.load(data)
+    service.users.load(
+      service.get_organization_users("organization" => {"id" => self.identity}).body["users"]
+    )
   end
 
   # @return [Zendesk2::Client::Memberships] memberships associated with this organization
   def memberships
     requires :identity
 
-    connection.memberships(organization: self)
+    service.memberships(organization: self)
   end
 
   # @return [Zendesk2::Client::Tickets] tickets associated with this organization
   def tickets
     requires :identity
-    data = connection.get_organization_tickets("id" => self.identity).body["tickets"]
-
-    connection.tickets.load(data)
-  end
-
-  private
 
-  def params
-    writable_attributes = Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
-    writable_attributes.delete("external_id") if writable_attributes["external_id"].to_s == "0"
-    writable_attributes.delete("group_id") if writable_attributes["group_id"].to_s == "0"
-    writable_attributes
+    service.tickets.load(
+      service.get_organization_tickets("organization_id" => self.identity).body["tickets"]
+    )
   end
 end

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

@@ -1,8 +1,6 @@
-class Zendesk2::Client::Ticket < Zendesk2::Model
+class Zendesk2::Client::Ticket < Zendesk2::Client::Model
   extend Zendesk2::Attributes
 
-  PARAMS = %w[external_id via priority requester_id submitter_id assignee_id organization_id subject description custom_fields recipient status collaborator_ids tags]
-
   # @return [Integer] Automatically assigned when creating tickets
   identity :id, type: :integer
   # @return [Integer] What agent is currently assigned to the ticket
@@ -67,13 +65,17 @@ class Zendesk2::Client::Ticket < Zendesk2::Model
     data = if new_record?
              requires :subject, :description
 
-             with_requester = (@requester || nil) && Zendesk2.stringify_keys(@requester)
+             create_attributes = self.attributes.dup
+
+             if with_requester = (@requester || nil) && Zendesk2.stringify_keys(@requester)
+               create_attributes.merge!("requester" => with_requester)
+             end
 
-             connection.create_ticket(params.merge("requester" => with_requester)).body["ticket"]
+             service.create_ticket("ticket" => create_attributes).body["ticket"]
            else
              requires :identity
 
-             connection.update_ticket(params.merge("id" => self.identity)).body["ticket"]
+             service.update_ticket("ticket" => self.attributes).body["ticket"]
            end
 
     merge_attributes(data)
@@ -82,7 +84,7 @@ class Zendesk2::Client::Ticket < Zendesk2::Model
   def destroy!
     requires :identity
 
-    connection.destroy_ticket("id" => self.identity)
+    service.destroy_ticket("ticket" => {"id" => self.identity})
   end
 
   # Adds a ticket comment
@@ -96,16 +98,22 @@ class Zendesk2::Client::Ticket < Zendesk2::Model
     requires :identity
 
     options[:public] = true if options[:public].nil?
+
     comment = Zendesk2.stringify_keys(options).merge("body" => text)
 
-    connection.ticket_comments.new(
-      connection.update_ticket("id" => self.identity, "comment" => comment).body["audit"]["events"].first
+    service.ticket_comments.new(
+      service.update_ticket(
+        "ticket" => {
+          "id"      => self.identity,
+          "comment" => comment,
+        }
+      ).body["audit"]["events"].first
     )
   end
 
   # @return [Array<Zendesk2::Client::User>] All users CCD on this ticket
   def collaborators
-    self.collaborator_ids.map{|cid| self.connection.users.get(cid)}
+    self.collaborator_ids.map { |cid| self.service.users.get(cid) }
   end
 
   # Update list of users to be CCD on this ticket
@@ -116,22 +124,16 @@ class Zendesk2::Client::Ticket < Zendesk2::Model
 
   # @return [Zendesk2::Client::TicketAudits] all audits for this ticket
   def audits
-    self.connection.ticket_audits(ticket_id: self.identity).all
+    self.service.ticket_audits(ticket_id: self.identity).all
   end
 
   # @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"])
+    Zendesk2::Client::TicketMetric.new(self.service.get_ticket_metric("ticket_id" => self.identity).body["ticket_metric"])
   end
 
   # @return [Array<Zendesk2::Client::TicketComment>] all comments for this ticket
   def comments
-    self.connection.ticket_comments(ticket_id: self.identity).all
-  end
-
-  private
-
-  def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+    self.service.ticket_comments(ticket_id: self.identity).all
   end
 end