# @abstract Subclass and set #{collection_method}, #{collection_root}, #{model_method}, #{model_root} and #{model} # adds {#create!} method to {Cistern::Collection}. class Zendesk2::PagedCollection < Zendesk2::Collection def self.inherited(klass) klass.send(:attribute, :count) klass.send(:attribute, :next_page_link, {:aliases => "next_page"}) klass.send(:attribute, :previous_page_link, {:aliases => "previous_page"}) klass.send(:extend, ClassMethods) end def collection_method; self.class.collection_method; end def collection_root; self.class.collection_root; end def model_method; self.class.model_method; end def model_root; self.class.model_root; end def new_page page = self.clone %w[count next_page_link previous_page_link].each { |k| page.attributes.delete(k) } page.records = [] page end def next_page new_page.all("url" => next_page_link) if next_page_link end def previous_page new_page.all("url" => previous_page_link) if previous_page_link end # Attempt creation of resource and explode if unsuccessful # @raise [Zendesk2::Error] if creation was unsuccessful # @return [Cistern::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] def create(attributes={}) model = self.new(attributes.merge(Zendesk2.stringify_keys(self.attributes))) model.save end # Fetch a collection of resources def all(params={}) scoped_attributes = self.class.scopes.inject({}){|r,k| r.merge(k.to_s => send(k))}.merge(params) body = connection.send(collection_method, scoped_attributes).body self.load(body[collection_root]) self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page")) 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 # @overload get!(scope) # directly fetch a namespaced record # @param [Hash] scope parameters to fetch record # @example Fetch a record without contextual scoping # self.identities.all("user_id" => 2, "id" => 4) # context defined directly # @example Fetch a record with contextual scoping # self.identities("user_id" => 2).get(4) # context defined in collection # user.identities.get(4) # context defined by encapsulating model # @raise [Zendesk2::Error] if the record cannot be found or other request error # @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) end if data = self.connection.send(model_method, scoped_attributes).body[self.model_root] new(data) end end # Quiet version of {#get!} # @see #get! # @return [Zendesk2::Model] Fetched model when successful # @return [NilClass] return nothing if record cannot be found def get(*args) get!(*args) rescue Zendesk2::Error nil end module ClassMethods attr_accessor :collection_method, :collection_root, :model_method, :model_root def scopes @scopes ||= [] end end end