zendesk2 1.5.6 → 1.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae7794df49e6001b5afe94bf42032f484e7064a5
-  data.tar.gz: 1d8cc12a0ddd74b1a247e7844a116523a34f31d2
+  metadata.gz: 75b7edcb167743af22e5cc652acb0a0f38b4aa5a
+  data.tar.gz: 68e451d5857884091f5144e0b26f2b9ae38eb59f
 SHA512:
-  metadata.gz: f9d325750f39bee7408bd0c39a56a732285d325e0bb90320f07cd0ca2e918492fa8b2dd50e87000cf2622a58524996c586adff07ac54dd53435c31d9318c23eb
-  data.tar.gz: 95be3f9e5c3c53e072ee82a9b752d25e402afc0765f0b34774ebf624044e7b4515d78de9abdffeb272c595aa5481b6a1b9c2bd68db8375208634670233940c06
+  metadata.gz: ce3d74e5cd45d2220f095ed2075835c803a8f6440aaf807e3aeffa0f8f734ba2a3e29b99960ec026ba6bfdffa6de3912961118e5a051e359421a53d187bb0209
+  data.tar.gz: 52927456134f282b29c4beaeaca81541030df75a4b7354781d43e3ce5a7edf2e170e67e88903352cf0ff5a8cd917727f32b948756247c432b992d8c2300a9b17

data/lib/zendesk2/client/collections/tickets.rb

@@ -4,9 +4,27 @@ class Zendesk2::Client::Tickets < Zendesk2::Client::Collection
 
   model Zendesk2::Client::Ticket
 
-  self.collection_method = :get_tickets
+  attribute :requester_id
+  attribute :collaborator_id
+
   self.collection_root   = "tickets"
   self.model_method      = :get_ticket
   self.model_root        = "ticket"
   self.search_type       = "ticket"
+
+  def collection_page(params={})
+    collection_method = if requester_id
+                          :get_requested_tickets
+                        elsif collaborator_id
+                          :get_ccd_tickets
+                        else
+                          :get_tickets
+                        end
+
+    body = service.send(collection_method, Cistern::Hash.stringify_keys(self.attributes.merge(params))).body
+
+    self.load(body[collection_root]) # 'results' is the key for paged seraches
+    self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+    self
+  end
 end

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

@@ -78,7 +78,10 @@ class Zendesk2::Client::User < Zendesk2::Client::Model
 
   def destroy!
     requires :identity
-    raise "don't nuke yourself" if self.email == service.username
+
+    if self.email == service.username
+      raise "don't nuke yourself"
+    end
 
     merge_attributes(
       service.destroy_user("user" => {"id" => self.identity}).body["user"]
@@ -160,19 +163,15 @@ class Zendesk2::Client::User < Zendesk2::Client::Model
   def tickets
     requires :identity
 
-    service.tickets.load(
-      service.get_requested_tickets("user_id" => self.identity).body["tickets"]
-    )
+    service.tickets(requester_id: self.identity)
   end
   alias requested_tickets tickets
 
-  # @return [Zendesk2::Client::Tickets] tickets this user is CC'eD
+  # @return [Zendesk2::Client::Tickets] tickets this user is CC'd
   def ccd_tickets
     requires :identity
 
-    service.tickets.load(
-      service.get_ccd_tickets("user_id" => self.identity).body["tickets"]
-    )
+    service.tickets(collaborator_id: self.identity)
   end
 
   # @return [Zendesk2::Client::UserIdentities] the identities of this user

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

@@ -1,14 +1,14 @@
 class Zendesk2::Client::GetCcdTickets < Zendesk2::Client::Request
-  request_path { |r| "/users/#{r.user_id}/tickets/ccd.json" }
+  request_path { |r| "/users/#{r.collaborator_id}/tickets/ccd.json" }
 
   page_params!
 
-  def user_id
-    params.fetch("user_id").to_i
+  def collaborator_id
+    params.fetch("collaborator_id").to_i
   end
 
   def mock
-    tickets = service.data[:tickets].values.select { |u| u["collaborator_ids"].include?(user_id) }
+    tickets = service.data[:tickets].values.select { |u| u["collaborator_ids"].include?(collaborator_id) }
 
     page(tickets, root: "tickets")
   end

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

@@ -1,15 +1,15 @@
 class Zendesk2::Client::GetRequestedTickets < Zendesk2::Client::Request
   request_method :get
-  request_path { |r| "/users/#{r.user_id}/tickets/requested.json" }
+  request_path { |r| "/users/#{r.requester_id}/tickets/requested.json" }
 
   page_params!
 
-  def user_id
-    params.fetch("user_id").to_i
+  def requester_id
+    params.fetch("requester_id").to_i
   end
 
   def mock(params={})
-    tickets = self.data[:tickets].values.select { |u| u["requester_id"] == user_id }
+    tickets = self.data[:tickets].values.select { |u| u["requester_id"] == requester_id }
 
     page(tickets, root: "tickets")
   end

data/lib/zendesk2/paged_collection.rb

@@ -45,37 +45,42 @@ module Zendesk2::PagedCollection
   end
 
   # Attempt creation of resource and explode if unsuccessful
+  #
   # @raise [Zendesk2::Error] if creation was unsuccessful
-  # @return [Cistern::Model]
+  # @return [Zendesk::Client::Model]
   def create!(attributes={})
     model = self.new(attributes.merge(Zendesk2.stringify_keys(self.attributes)))
     model.save!
   end
 
   # Quietly attempt creation of resource. Check {#new_record?} and {#errors} for success
+  #
   # @see {#create!} to raise an exception on failure
-  # @return [Cistern::Model, FalseClass]
+  # @return [Zendesk::Client::Model, FalseClass]
   def create(attributes={})
     model = self.new(attributes.merge(Zendesk2.stringify_keys(self.attributes)))
     model.save
   end
 
+  # Iterate over all pages and collect every entry
+  #
+  # @return [Array<Zendesk2::Client::Model>] all entries in all pages
+  def all_entries
+    each_entry.to_a
+  end
+
   # Fetch a collection of resources
   def all(params={})
-    if params["filtered"] && (url = params["url"])
-      query = Faraday::NestedParamsEncoder.decode(URI.parse(url).query)
-      search(query.delete("query"), query)
+    if search_query?(params)
+      search_page(params)
     else
-      scoped_attributes = self.class.scopes.inject({}){|r,k| r.merge(k.to_s => send(k))}.merge(params)
-      body = service.send(collection_method, scoped_attributes).body
-
-      self.load(body[collection_root]) # 'results' is the key for paged seraches
-      self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+      collection_page(params)
     end
     self
   end
 
   # Fetch a single of resource
+  #
   # @overload get!(identity)
   #   fetch a un-namespaced specific record or a namespaced record under the current {#scopes}
   #   @param [Integer] identity identity of the record
@@ -91,12 +96,14 @@ module Zendesk2::PagedCollection
   # @return [Zendesk2::Model] fetched resource corresponding to value of {Zendesk2::Collection#model}
   def get!(identity_or_hash)
     scoped_attributes = self.class.scopes.inject({}){|r,k| r.merge(k.to_s => send(k))}
+
     if identity_or_hash.is_a?(Hash)
       scoped_attributes.merge!(identity_or_hash)
-    else scoped_attributes.merge!("id" => identity_or_hash)
+    else
+      scoped_attributes.merge!("id" => identity_or_hash)
     end
 
-    scoped_attributes = {model_root => scoped_attributes}
+    scoped_attributes = { model_root => scoped_attributes }
 
     if data = self.service.send(model_method, scoped_attributes).body[self.model_root]
       new(data)
@@ -104,6 +111,7 @@ module Zendesk2::PagedCollection
   end
 
   # Quiet version of {#get!}
+  #
   # @see #get!
   # @return [Zendesk2::Model] Fetched model when successful
   # @return [NilClass] return nothing if record cannot be found
@@ -120,4 +128,24 @@ module Zendesk2::PagedCollection
       @scopes ||= []
     end
   end
+
+  protected
+
+  def search_query?(params)
+    !!params["filtered"] && !!params["url"]
+  end
+
+  def search_page(params)
+    query = Faraday::NestedParamsEncoder.decode(URI.parse(params.fetch("url")).query)
+
+    search(query.delete("query"), query)
+  end
+
+  def collection_page(params)
+    scoped_attributes = self.class.scopes.inject({}) { |r, k| r.merge(k.to_s => send(k)) }.merge(params)
+    body = service.send(collection_method, scoped_attributes).body
+
+    self.load(body[collection_root]) # 'results' is the key for paged seraches
+    self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+  end
 end

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "1.5.6"
+  VERSION = "1.5.7"
 end

data/spec/users_spec.rb

@@ -73,15 +73,18 @@ describe "users" do
     end
 
     it "should get requested tickets" do
-      ticket = client.tickets.create!(requester: user, subject: mock_uuid, description: mock_uuid)
+      another_user = client.users.create!(email: mock_email, name: mock_uuid)
 
-      expect(user.requested_tickets).to include ticket
+      another_user.tickets.create!(collaborators: [user], subject: mock_uuid, description: mock_uuid)
+      ticket = user.tickets.create!(requester: user, subject: mock_uuid, description: mock_uuid)
+
+      expect(user.requested_tickets).to contain_exactly(ticket)
     end
 
     it "should get ccd tickets", mock_only: true do
       ticket = client.tickets.create!(collaborators: [user], subject: mock_uuid, description: mock_uuid)
 
-      expect(user.ccd_tickets).to include ticket
+      expect(user.ccd_tickets).to contain_exactly(ticket)
     end
 
     it "cannot destroy a user with a ticket" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 1.5.7
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cistern