zendesk2 0.4.4 → 0.4.5

data/lib/zendesk2/collection.rb

@@ -3,8 +3,6 @@
 class Zendesk2::Collection < Cistern::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
 
@@ -13,21 +11,6 @@ class Zendesk2::Collection < Cistern::Collection
   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]
@@ -50,7 +33,7 @@ class Zendesk2::Collection < Cistern::Collection
     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.merge_attributes(Cistern::Hash.slice(body, "count"))
     self
   end
 

data/lib/zendesk2/paged_collection.rb

@@ -0,0 +1,100 @@
+# @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

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

data/lib/zendesk2.rb

@@ -14,13 +14,15 @@ require 'time'
 require 'yaml'
 
 module Zendesk2
-  autoload :Attributes, 'zendesk2/attributes'
-  autoload :Error, 'zendesk2/error'
-  autoload :Client, 'zendesk2/client'
-  autoload :Searchable, 'zendesk2/searchable'
-  autoload :Logger, 'zendesk2/logger'
-  autoload :Model, 'zendesk2/model'
-  autoload :Collection, 'zendesk2/collection'
+  require 'zendesk2/attributes'
+  require 'zendesk2/attributes'
+  require 'zendesk2/error'
+  require 'zendesk2/client'
+  require 'zendesk2/searchable'
+  require 'zendesk2/logger'
+  require 'zendesk2/model'
+  require 'zendesk2/collection'
+  require 'zendesk2/paged_collection'
 
   def self.defaults
     @defaults ||= if File.exists?(File.expand_path("~/.zendesk2"))

data/spec/categories_spec.rb

@@ -2,8 +2,10 @@ require 'spec_helper'
 
 describe "categories" do
   let(:client) { create_client }
-  it_should_behave_like "a resource",
-    :categories,
-    lambda { {name: Zendesk2.uuid} },
-    lambda { {name: Zendesk2.uuid} }
+
+  include_examples "zendesk resource", {
+    :collection    => lambda { client.categories },
+    :create_params => lambda { { name: Zendesk2.uuid } },
+    :update_params => lambda { { name: Zendesk2.uuid } },
+  }
 end

data/spec/forums_spec.rb

@@ -2,8 +2,11 @@ require 'spec_helper'
 
 describe "forums" do
   let(:client) { create_client }
-  it_should_behave_like "a resource",
-    :forums,
-    lambda { {name: Zendesk2.uuid} },
-    lambda { {name: Zendesk2.uuid} }
+
+  include_examples "zendesk resource", {
+    :collection      => lambda { client.forums },
+    :create_params   => lambda { { name: Zendesk2.uuid } },
+    :update_params   => lambda { { name: Zendesk2.uuid } },
+    :delayed_destroy => true,
+  }
 end

data/spec/groups_spec.rb

@@ -2,9 +2,12 @@ require 'spec_helper'
 
 describe "groups" do
   let(:client) { create_client }
-  it_should_behave_like "a resource", :groups,
-    lambda { {name: Zendesk2.uuid} },
-    lambda { {name: Zendesk2.uuid} }
+
+  include_examples "zendesk resource", {
+    :collection    => lambda { client.groups },
+    :create_params => lambda { { name: Zendesk2.uuid } },
+    :update_params => lambda { { name: Zendesk2.uuid } },
+  }
 
   it "should list assignable groups" do
     client.groups.create(name: Zendesk2.uuid) # assignable by default

data/spec/memberships_spec.rb

@@ -6,11 +6,11 @@ describe "memberships" do
   let(:organization)   { client.organizations.create!(name: Zendesk2.uuid) }
 
   include_examples "zendesk resource", {
-    :params       => lambda { {organization_id: organization.id, user_id: user.id} },
-    :collection   => lambda { client.memberships(user: user) },
-    :paged        => false,
-    :update       => false,
-    :search       => false,
+    :create_params => lambda { {organization_id: organization.id, user_id: user.id} },
+    :collection    => lambda { client.memberships(user: user) },
+    :paged         => false,
+    :update        => false,
+    :search        => false,
   }
 
   it "should be marked as default" do
@@ -50,4 +50,30 @@ describe "memberships" do
     user.memberships.to_a.should == [user_membership]
     another_user.memberships.size.should == 2
   end
+
+  describe "create_membership" do
+    it "should error when organization does not exist" do
+      expect {
+        client.create_membership("user_id" => user.identity, "organization_id" => 99)
+      }.to raise_exception(Zendesk2::Error, /RecordInvalid/)
+    end
+
+    it "should error when missing parameters" do
+      expect { client.create_membership({}) }.to raise_exception(ArgumentError, "missing parameters: user_id, organization_id")
+    end
+
+    it "should error when creating a duplicate membership" do
+      client.create_membership("user_id" => user.identity, "organization_id" => organization.identity)
+
+      expect {
+        client.create_membership("user_id" => user.identity, "organization_id" => organization.identity)
+      }.to raise_exception(Zendesk2::Error, /RecordInvalid/)
+    end
+
+    it "should error when user does not exist" do
+      expect {
+        client.create_membership("user_id" => 99, "organization_id" => organization.identity)
+      }.to raise_exception(Zendesk2::Error, /RecordNotFound/)
+    end
+  end
 end

data/spec/organizations_spec.rb

@@ -2,9 +2,12 @@ require 'spec_helper'
 
 describe "organizations" do
   let(:client) { create_client }
-  it_should_behave_like "a resource", :organizations,
-    lambda { {name: Zendesk2.uuid} },
-    lambda { {name: Zendesk2.uuid} }
+
+  include_examples "zendesk resource", {
+    :collection    => lambda { client.organizations },
+    :create_params => lambda { { name: Zendesk2.uuid } },
+    :update_params => lambda { { name: Zendesk2.uuid } },
+  }
 
   describe "with an organization" do
     let(:organization) { client.organizations.create(name: Zendesk2.uuid) }

data/spec/shared/zendesk_resource.rb

@@ -1,64 +1,82 @@
 shared_examples "zendesk resource" do |options={}|
-  let(:collection)    { instance_exec(&options[:collection]) }
-  let(:params)        { instance_exec(&options[:params]) || {} }
-  let(:update_params) { instance_exec(&options[:update_params]) }
-  let(:fetch_params)  { options[:fetch_params] || lambda { |r| r.identity } }
+  context "as a resource" do
+    let!(:collection)   { instance_exec(&options[:collection]) }
+    let(:create_params) { instance_exec(&options[:create_params]) || {} }
+    let(:update_params) { instance_exec(&options[:update_params]) }
+    let(:fetch_params)  { options[:fetch_params] || lambda { |r| r.identity } }
 
-  it "should be created" do
-    record = collection.create!(params)
-    record.identity.should_not be_nil
-  end
+    let(:record) { @record }
+    after(:each) { @record && @record.destroy }
 
-  it "should be fetched" do
-    record = collection.create!(params)
-    collection.get!(fetch_params.call(record)).should == record
-  end
+    it "should be created" do
+      @record = collection.create!(create_params)
+      record.identity.should_not be_nil
+    end
 
-  if options.fetch(:paged, true)
-    context "paging" do
-      before(:each) do
-        3.times.each { collection.create!(instance_exec(&_params)) }
-      end
+    it "should be fetched" do
+      @record = collection.create!(create_params)
+      collection.get!(fetch_params.call(record)).should == record
+    end
 
-      it "should retrieve first page" do
-        collection.all("per_page" => "1").size.should == 1
-      end
+    if options.fetch(:paged, true)
+      context "paging" do
+        before(:each) do
+          @resources = 3.times.map { collection.create!(instance_exec(&options[:create_params])) }
+        end
 
-      it "should retrieve next page" do
-        first_page = collection.all("per_page" => 1)
-        second_page = collection.all("per_page" => 1).next_page
-        second_page.should_not == first_page
-      end
+        after(:each) { @resources.each { |r| r.destroy } }
+
+        it "should retrieve first page" do
+          collection.all("per_page" => "1").size.should == 1
+        end
+
+        it "should retrieve next page" do
+          first_page = collection.all("per_page" => 1)
+          second_page = collection.all("per_page" => 1).next_page
+          second_page.should_not == first_page
+        end
 
-      it "should retreive previous page" do
-        first_page = collection.all("per_page" => "1")
-        previous_to_second_page = collection.all("per_page" => 1).next_page.previous_page
-        previous_to_second_page.should == first_page
+        it "should retreive previous page" do
+          first_page = collection.all("per_page" => "1")
+          previous_to_second_page = collection.all("per_page" => 1).next_page.previous_page
+          previous_to_second_page.should == first_page
+        end
+      end
+    else
+      context "paging" do
+        it "should not be present" do
+          collection.class.attributes.should_not have_key(:next_page_link)
+          collection.class.attributes.should_not have_key(:previous_page_link)
+          collection.class.attributes.should have_key(:count)
+        end
       end
     end
-  end
 
-  if options.fetch(:update, true)
-    it "should be updated" do
-      record = collection.create!(params)
-      record.merge_attributes(update_params)
-      record.save
-      update_params.each {|k,v| record.send(k).should == v}
+    if options.fetch(:update, true)
+      it "should be updated" do
+        @record = collection.create!(create_params)
+        record.merge_attributes(update_params)
+        record.save
+        update_params.each {|k,v| record.send(k).should == v}
+      end
     end
-  end
 
-  it "should be destroyed" do
-    record = collection.create!(params)
-    record.identity.should_not be_nil
-    record.destroy
-    record.should be_destroyed
-  end
+    it "should be destroyed" do
+      @record = collection.create!(create_params)
+      record.identity.should_not be_nil
+      record.destroy
 
-  if options.fetch(:search, true) && Zendesk2::Client.mocking?
-    # Search index takes 2-3 minutes according to the docs
-    it "should search" do
-      record = collection.create!(params)
-      collection.search(params).should include(record)
+      if !options.fetch(:delayed_destroy, false) && !Zendesk2::Client.mocking?
+        record.should be_destroyed
+      end
+    end
+
+    if options.fetch(:search, true) && Zendesk2::Client.mocking?
+      # Search index takes 2-3 minutes according to the docs
+      it "should search" do
+        @record = collection.create!(create_params)
+        collection.search(create_params).should include(record)
+      end
     end
   end
 end

data/spec/ticket_fields_spec.rb

@@ -3,7 +3,10 @@ require 'spec_helper'
 describe "ticket_fields" do
   let(:client) { create_client }
 
-  it_should_behave_like "a resource", :ticket_fields,
-    lambda { { title: Zendesk2.uuid, type: "text" } },
-    lambda { { title: Zendesk2.uuid } }
+  include_examples "zendesk resource", {
+    :collection    => lambda { client.ticket_fields },
+    :create_params => lambda { { title: Zendesk2.uuid, type: "text" } },
+    :update_params => lambda { { title: Zendesk2.uuid } },
+    :paged         => false,
+  }
 end

data/spec/tickets_spec.rb

@@ -2,9 +2,12 @@ require 'spec_helper'
 
 describe "tickets" do
   let(:client) { create_client }
-  it_should_behave_like "a resource", :tickets,
-    lambda { {subject: Zendesk2.uuid, description: Zendesk2.uuid} },
-    lambda { {subject: Zendesk2.uuid} }
+
+  include_examples "zendesk resource", {
+    :collection => lambda { client.tickets },
+    :create_params => lambda { {subject: Zendesk2.uuid, description: Zendesk2.uuid} },
+    :update_params => lambda { {subject: Zendesk2.uuid} },
+  }
 
   describe "when creating a ticket" do
     let!(:requester_email) { "#{Zendesk2.uuid}@example.org" }