zendesk2 0.0.13 → 0.0.14

data/README.md

@@ -20,47 +20,52 @@ Or install it yourself as:
 
 Default credentials will be read in from `~/.zendesk2` file in YAML format.
 
-	---
-	:subdomain: zendeskdev
-	:username: zendeskedge@example.com
-	:password: wickedsecurepassword
+```yaml
+---
+:subdomain: zendeskdev
+:username: zendeskedge@example.com
+:password: wickedsecurepassword
+```
 
 ### Creating the client
 
 Either the absolute url or the subdomain is required.  Username and password is always required.
-
-	Zendesk2::Client.new(subdomain: "engineyard", username: "orchestra", password: "gwoo")
-	=> #<Zendesk2::Client::Real:0x007f99da1f9430 @url="https://engineyard.zendesk.com/api/v2", @username="orchestra", @password="gwoo", …>
-
+```ruby
+Zendesk2::Client.new(subdomain: "engineyard", username: "orchestra", password: "gwoo")
+=> #<Zendesk2::Client::Real:0x007f99da1f9430 @url="https://engineyard.zendesk.com/api/v2", @username="orchestra", @password="gwoo", …>
+```
 or
-
-	=> #<Zendesk2::Client::Real:0x007fd1bae486b0 @url="http://support.cloud.engineyard.com", @username="mate", @password="bambilla", …>
-
+```ruby
+Zendesk2::Client.new(url: "http://support.cloud.engineyard.com", username: "mate", password: "bambilla")
+=> #<Zendesk2::Client::Real:0x007fd1bae486b0 @url="http://support.cloud.engineyard.com", @username="mate", @password="bambilla", …>
+```
 ### Resources
 
 #### Collections
 
 Currently support resources
 
+* Categories
 * User
 * Ticket
 * Organization
+* Forums
 
 All collection are accessed like so:
-
-    client.users.all
-     =>   <Zendesk2::Client::Users
-    count=1779,
-    next_page_link="https://dev.zendesk.com/api/v2/users.json?page=2",
-    previous_page_link=nil
-    [
-      <Zendesk2::Client::User
-        id=125394183,
-        url="https://dev.zendesk.com/api/v2/users/125394183.json",
-        ...
-       >
-    ]
-
+```ruby
+client.users.all
+=>   <Zendesk2::Client::Users
+	count=1779,
+	next_page_link="https://dev.zendesk.com/api/v2/users.json?page=2",
+	previous_page_link=nil
+	[
+		<Zendesk2::Client::User
+			id=125394183,
+			url="https://dev.zendesk.com/api/v2/users/125394183.json",
+      ...
+		>
+	]
+```
 Collections also respond to `create` and `new`
 
 	client.users.create(email: "ohhai@example.org", name: "lulz")

data/lib/zendesk2/attributes.rb

@@ -0,0 +1,23 @@
+module Zendesk2::Attributes
+  def assoc_reader(name, options={})
+    assoc_key  = options[:key] || "#{name}_id"
+    collection = options[:collection] || "#{name}s"
+    define_method(name) do
+      self.connection.send(collection).get(self.send(assoc_key))
+    end
+  end
+
+  def assoc_writer(name, options={})
+    assoc_key = options[:key] || "#{name}_id"
+    define_method("#{name}=") do |assoc|
+      self.send("#{assoc_key}=", assoc.id)
+    end
+  end
+
+  def assoc_accessor(name, options={})
+    assoc_reader(name, options)
+    assoc_writer(name, options)
+  end
+
+  # TODO: collection
+end

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

@@ -0,0 +1,12 @@
+class Zendesk2::Client::Categories < Cistern::Collection
+  include Zendesk2::PagedCollection
+  include Zendesk2::Searchable
+
+  model Zendesk2::Client::Category
+
+  self.collection_method= :get_categories
+  self.collection_root= "categories"
+  self.model_method= :get_category
+  self.model_root= "category"
+  self.search_type= "category"
+end

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

@@ -0,0 +1,38 @@
+class Zendesk2::Client::Category < Cistern::Model
+  PARAMS = %w[id name description position]
+
+  identity  :id, type: :integer         # ro[yes] mandatory[no]  Automatically assigned during creation
+  attribute :url, type: :string         # ro[yes] mandatory[no]  The API url of this category
+  attribute :name, type: :string        # ro[no]  mandatory[yes] The name of the category
+  attribute :description, type: :string # ro[no]  mandatory[no]  The description of the category
+  attribute :position, type: :integer   # ro[no]  mandatory[no]  The position of this category relative to other categories
+  attribute :created_at, type: :date    # ro[yes] mandatory[no]  The time the category was created
+  attribute :updated_at, type: :date    # ro[yes] mandatory[no]  The time of the last update of the category
+
+  def destroy
+    requires :id
+
+    connection.destroy_category("id" => self.id)
+  end
+
+  def destroyed?
+    !self.reload
+  end
+
+  def save
+    data = if new_record?
+             requires :name
+             connection.create_category(params).body["category"]
+           else
+             requires :id
+             connection.update_category(params).body["category"]
+           end
+    merge_attributes(data)
+  end
+
+  private
+
+  def params
+    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+  end
+end

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

@@ -0,0 +1,50 @@
+class Zendesk2::Client::Forum < Cistern::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
+  attribute :description,       type: :string  # ro no mandatory no  A description of the forum
+  attribute :category_id,       type: :integer # ro no mandatory no  Category this forum is in
+  attribute :organization_id,   type: :integer # ro no mandatory no  Organization this forum is restricted to
+  attribute :locale_id,         type: :integer # ro no mandatory no  User locale id this forum is restricted to
+  attribute :locked,            type: :boolean # ro no mandatory no  Whether this forum is locked such that new entries and comments cannot be made
+  attribute :unanswered_topics, type: :integer # ro yes mandatory no  Contains the number of unanswered questions if this forum's topics are questions.
+  attribute :position,          type: :integer # ro no mandatory no  The position of this forum relative to other forums in the same category
+  attribute :forum_type,        type: :string  # ro no mandatory no  The type of the topics in this forum, valid values: "articles", "ideas" or "questions"
+  attribute :access,            type: :string  # ro no mandatory no  Who has access to this forum, valid values: "everybody", "logged-in users" or "agents only"
+  attribute :created_at,        type: :date    # ro yes mandatory no  The time the forum was created
+  attribute :updated_at,        type: :date    # ro yes mandatory no  The time of the last update of the forum
+
+  assoc_accessor :organization
+  assoc_accessor :category
+
+  def destroy
+    requires :identity
+
+    connection.destroy_forum("id" => self.identity)
+  end
+
+  def destroyed?
+    !self.reload
+  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
+
+  private
+
+  def params
+    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+  end
+end

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

@@ -0,0 +1,12 @@
+class Zendesk2::Client::Forums < Cistern::Collection
+  include Zendesk2::PagedCollection
+  include Zendesk2::Searchable
+
+  model Zendesk2::Client::Forum
+
+  self.collection_method= :get_forums
+  self.collection_root= "forums"
+  self.model_method= :get_forum
+  self.model_root= "forum"
+  self.search_type= "forum"
+end

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

@@ -1,5 +1,7 @@
 class Zendesk2::Client::Organization < Cistern::Model
+  PARAMS = %w[id details domain_names external_id group_id shared_comments shared_tickets tags name notes]
   identity :id,               type: :integer
+  attribute :url,             type: :string
   attribute :created_at,      type: :time
   attribute :details,         type: :string
   attribute :domain_names,    type: :array
@@ -56,7 +58,7 @@ class Zendesk2::Client::Organization < Cistern::Model
   private
 
   def params
-    writable_attributes = Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), "id", "details", "domain_names", "external_id", "group_id", "shared_comments", "shared_tickets", "tags", "name", "notes")
+    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

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

@@ -1,5 +1,6 @@
 class Zendesk2::Client::Organizations < Cistern::Collection
   include Zendesk2::PagedCollection
+  include Zendesk2::Searchable
 
   model Zendesk2::Client::Organization
 
@@ -7,16 +8,5 @@ class Zendesk2::Client::Organizations < Cistern::Collection
   self.collection_root= "organizations"
   self.model_method= :get_organization
   self.model_root= "organization"
-
-  def current
-    new(connection.get_current_organization.body["organization"])
-  end
-
-  def search(parameters)
-    body = connection.search(parameters.merge("type" => "organization")).body
-    if data = body.delete("results")
-      load(data)
-    end
-    merge_attributes(body)
-  end
+  self.search_type= "organization"
 end

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

@@ -1,4 +1,8 @@
 class Zendesk2::Client::Ticket < Cistern::Model
+  extend Zendesk2::Attributes
+
+  PARAMS = %w[external_id via requester_id submitter_id assignee_id organization_id subject description fields recipient status collaborator_ids]
+
   identity :id,                type: :id
   attribute :external_id
   attribute :via
@@ -23,6 +27,10 @@ class Zendesk2::Client::Ticket < Cistern::Model
   attribute :tags,             type: :array
   attribute :fields,           type: :array
 
+  assoc_reader :organization
+  assoc_accessor :requester
+  assoc_reader :submitter
+
   def save
     if new_record?
       requires :subject, :description
@@ -53,22 +61,10 @@ class Zendesk2::Client::Ticket < Cistern::Model
     !self.reload
   end
 
-  def requester=(requester)
-    self.requester_id= requester.id
-  end
-
-  def requester
-    self.connection.users.get(self.requester_id)
-  end
-
-  def submitter
-    self.connection.users.get(submitter_id)
-  end
-
   private
 
   def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), "external_id", "via", "requester_id", "submitter_id", "assignee_id", "organization_id", "subject", "description", "fields", "recipient", "status", "collaborator_ids")
+    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
   end
 
 end

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

@@ -1,5 +1,6 @@
 class Zendesk2::Client::Tickets < Cistern::Collection
   include Zendesk2::PagedCollection
+  include Zendesk2::Searchable
 
   model Zendesk2::Client::Ticket
 
@@ -7,12 +8,5 @@ class Zendesk2::Client::Tickets < Cistern::Collection
   self.collection_root= "tickets"
   self.model_method= :get_ticket
   self.model_root= "ticket"
-
-  def search(term)
-    body = connection.search_ticket("query" => term).body
-    if data = body.delete("results")
-      load(data)
-    end
-    merge_attributes(body)
-  end
+  self.search_type= "ticket"
 end

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

@@ -1,4 +1,8 @@
 class Zendesk2::Client::User < Cistern::Model
+  extend Zendesk2::Attributes
+
+  PARAMS = %w[name email organization_id external_id alias verified locate_id time_zone phone signature details notes role custom_role_id moderator ticket_restriction only_private_comments]
+
   identity :id,                     type: :id
   attribute :url
   attribute :external_id
@@ -29,6 +33,8 @@ class Zendesk2::Client::User < Cistern::Model
   attribute :photo
   attribute :authenticity_token
 
+  assoc_accessor :organization
+
   def save
     if new_record?
       requires :name, :email
@@ -101,18 +107,10 @@ class Zendesk2::Client::User < Cistern::Model
     connection.tickets.load(data)
   end
 
-  def organization=(organization)
-    self.organization_id= organization.id
-  end
-
-  def organization
-    self.connection.organizations.get(self.organization_id)
-  end
-
   private
 
   def params
-    writable_attributes = Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), "name", "email", "organization_id", "external_id", "alias", "verified", "locate_id", "time_zone", "phone", "signature", "details", "notes", "role", "custom_role_id", "moderator", "ticket_restriction", "only_private_comments")
+    writable_attributes = Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
     writable_attributes.delete("organization_id") if writable_attributes["organization_id"] == 0
     writable_attributes.delete("custom_role_id") if writable_attributes["custom_role_id"] == 0
     writable_attributes

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

@@ -1,5 +1,6 @@
 class Zendesk2::Client::Users < Cistern::Collection
   include Zendesk2::PagedCollection
+  include Zendesk2::Searchable
 
   model Zendesk2::Client::User
 
@@ -7,16 +8,9 @@ class Zendesk2::Client::Users < Cistern::Collection
   self.collection_root= "users"
   self.model_method= :get_user
   self.model_root= "user"
+  self.search_type= "user"
 
   def current
     new(connection.get_current_user.body["user"])
   end
-
-  def search(term)
-    body = connection.search_user("query" => term).body
-    if data = body.delete("results")
-      load(data)
-    end
-    merge_attributes(body)
-  end
 end

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

@@ -0,0 +1,32 @@
+class Zendesk2::Client
+  class Real
+    def create_category(params={})
+      request(
+        :body   => {"category" => params},
+        :method => :post,
+        :path   => "/categories.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def create_category(params={})
+      identity = self.class.new_id
+
+      record = {
+        "id"         => identity,
+        "url"        => url_for("/categories/#{identity}.json"),
+        "created_at" => Time.now.iso8601,
+        "updated_at" => Time.now.iso8601,
+      }.merge(params)
+
+      self.data[:categories][identity]= record
+
+      response(
+        :method => :post,
+        :body   => {"category" => record},
+        :path   => "/categories.json"
+      )
+    end
+  end # Mock
+end

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

@@ -0,0 +1,33 @@
+class Zendesk2::Client
+  class Real
+    def create_forum(params={})
+      request(
+        :body   => {"forum" => params},
+        :method => :post,
+        :path   => "/forums.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def create_forum(params={})
+      identity = self.class.new_id
+
+      record = {
+        "id"         => identity,
+        "url"        => url_for("/forums/#{identity}.json"),
+        "created_at" => Time.now.iso8601,
+        "updated_at" => Time.now.iso8601,
+      }.merge(params)
+
+      path = "/forums.json"
+      self.data[:forums][identity]= record
+
+      response(
+        :method => :post,
+        :body   => {"forum" => record},
+        :path   => path,
+      )
+    end
+  end # Mock
+end

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

@@ -21,13 +21,32 @@ class Zendesk2::Client
         "active"     => true,
       }.merge(params)
 
-      self.data[:users][identity]= record
+      path = "/users.json"
+      if record["email"] && self.data[:users].find{|k,u| u["email"] == record["email"] && k != identity}
+        response(
+          :method => :put,
+          :path   => path,
+          :status => 422,
+          :body   => {
+            "error"       => "RecordInvalid",
+            "description" => "Record validation errors", "details" => {
+              "email"       => [ {
+                "type"        => "#{record["email"]} is already being used by another user",
+                "description" => "Email: #{record["email"]} is already being used by another user"
+              } ]
+            }
+          }
+        )
+      else
 
-      response(
-        :method => :post,
-        :body   => {"user" => record},
-        :path   => "/users.json"
-      )
+        self.data[:users][identity]= record
+
+        response(
+          :method => :post,
+          :body   => {"user" => record},
+          :path   => path,
+        )
+      end
     end
   end # Mock
 end

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

@@ -0,0 +1,27 @@
+class Zendesk2::Client
+  class Real
+    def destroy_category(params={})
+      id = params["id"]
+
+      request(
+        :method => :delete,
+        :path   => "/categories/#{id}.json"
+      )
+    end
+  end
+
+  class Mock
+    def destroy_category(params={})
+      id   = params["id"]
+      body = self.data[:categories].delete(id)
+
+      response(
+        :method => :delete,
+        :path   => "/categories/#{id}.json",
+        :body   => {
+          "category" => body,
+        },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+class Zendesk2::Client
+  class Real
+    def destroy_forum(params={})
+      id = params["id"]
+
+      request(
+        :method => :delete,
+        :path   => "/forums/#{id}.json"
+      )
+    end
+  end
+
+  class Mock
+    def destroy_forum(params={})
+      id   = params["id"]
+      path = "/forums/#{id}.json"
+
+      body = self.data[:forums].delete(id)
+      response(
+        :method => :delete,
+        :path   => path,
+        :body   => {
+          "forum" => body,
+        },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+class Zendesk2::Client
+  class Real
+    def get_categories(params={})
+      page_params = Zendesk2.paging_parameters(params)
+
+      request(
+        :params  => page_params,
+        :method  => :get,
+        :path    => "/categories.json",
+      )
+    end
+  end
+  class Mock
+    def get_categories(params={})
+      page(params, :categories, "/categories.json", "categories")
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+class Zendesk2::Client
+  class Real
+    def get_category(params={})
+      id = params["id"]
+
+      request(
+        :method => :get,
+        :path   => "/categories/#{id}.json"
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_category(params={})
+      id   = params["id"]
+      if body = self.data[:categories][id]
+
+        response(
+          :path  => "/categories/#{id}.json",
+          :body  => {
+            "category" => body
+          },
+        )
+      else 
+        response(
+          :path   => "/categories/#{id}.json",
+          :status => 404
+        )
+      end
+    end
+  end # Mock
+end

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

@@ -0,0 +1,26 @@
+class Zendesk2::Client
+  class Real
+    def get_forum(params={})
+      id = params["id"]
+
+      request(
+        :method => :get,
+        :path => "/forums/#{id}.json"
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_forum(params={})
+      id   = params["id"]
+      body = self.data[:forums][id]
+
+      response(
+        :path  => "/forums/#{id}.json",
+        :body  => {
+          "forum" => body
+        },
+      )
+    end
+  end # Mock
+end

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

@@ -0,0 +1,18 @@
+class Zendesk2::Client
+  class Real
+    def get_forums(params={})
+      page_params = Zendesk2.paging_parameters(params)
+
+      request(
+        :params  => page_params,
+        :method  => :get,
+        :path    => "/forums.json",
+      )
+    end
+  end
+  class Mock
+    def get_forums(params={})
+      page(params, :forums, "/forums.json", "forums")
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ class Zendesk2::Client
       term = query.map{|k,v| "#{k}:#{v}"}.join(" ")
       request(
         :method => :get,
-        :params => {query: term},
+        :params => {query: "\"#{term}\""},
         :path   => "/search.json",
       )
     end
@@ -13,7 +13,7 @@ class Zendesk2::Client
   class Mock
     def search(query)
       type       = query.delete("type")
-      collection = type.nil? ? self.data.values : self.data["#{type}s".to_sym]
+      collection = type.nil? ? self.data.values : self.data[pluralize(type).to_sym]
 
       results = collection.select{|k,v| query.all?{|term, condition| v[term.to_s] == condition}}.values
 

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

@@ -0,0 +1,29 @@
+class Zendesk2::Client
+  class Real
+    def update_category(params={})
+      id = params.delete("id")
+
+      request(
+        :method => :put,
+        :path   => "/categories/#{id}.json",
+        :body   => {
+          "category" => params
+        },
+      )
+    end
+  end
+  class Mock
+    def update_category(params={})
+      id   = params.delete("id")
+      body = self.data[:categories][id].merge!(params)
+
+      response(
+        :method => :put,
+        :path   => "/categories/#{id}.json",
+        :body   => {
+          "category" => body
+        },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+class Zendesk2::Client
+  class Real
+    def update_forum(params={})
+      id = params.delete("id")
+
+      request(
+        :method => :put,
+        :path   => "/forums/#{id}.json",
+        :body   => {
+          "forum" => params
+        },
+      )
+    end
+  end
+  class Mock
+    def update_forum(params={})
+      id   = params.delete("id")
+      path = "/forums/#{id}.json"
+
+      body = self.data[:forums][id].merge!(params)
+      response(
+        :method => :put,
+        :path   => path,
+        :body   => {
+          "forum" => body
+        },
+      )
+    end
+  end
+end

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

@@ -15,15 +15,32 @@ class Zendesk2::Client
   class Mock
     def update_user(params={})
       id   = params.delete("id")
-      body = self.data[:users][id].merge!(params)
-
-      response(
-        :method => :put,
-        :path   => "/users/#{id}.json",
-        :body   => {
-          "user" => body
-        },
-      )
+      path = "/users/#{id}.json"
+      if params["email"] && self.data[:users].find{|k,u| u["email"] == params["email"] && k != id}
+        response(
+          :method => :put,
+          :path   => path,
+          :status => 422,
+          :body   => {
+            "error"       => "RecordInvalid",
+            "description" => "Record validation errors", "details" => {
+            "email"       => [ {
+                "type"        => "#{params["email"]} is already being used by another user",
+                "description" => "Email: #{params["email"]} is already being used by another user"
+              } ]
+            }
+          }
+        )
+      else
+        body = self.data[:users][id].merge!(params)
+        response(
+          :method => :put,
+          :path   => path,
+          :body   => {
+            "user" => body
+          },
+        )
+      end
     end
   end
 end

data/lib/zendesk2/client.rb

@@ -3,6 +3,10 @@ class Zendesk2::Client < Cistern::Service
   model_path "zendesk2/client/models"
   request_path "zendesk2/client/requests"
 
+  model :category
+  collection :categories
+  model :forum
+  collection :forums
   model :organization
   collection :organizations
   model :ticket
@@ -10,24 +14,34 @@ class Zendesk2::Client < Cistern::Service
   model :user
   collection :users
 
+  request :create_category
+  request :create_forum
   request :create_organization
   request :create_ticket
   request :create_user
+  request :destroy_category
+  request :destroy_forum
   request :destroy_organization
   request :destroy_ticket
   request :destroy_user
   request :get_current_user
+  request :get_category
+  request :get_forum
   request :get_organization
   request :get_organization_tickets
   request :get_organization_users
   request :get_ticket
   request :get_user
+  request :get_categories
+  request :get_forums
   request :get_organizations
   request :get_requested_tickets
   request :get_ccd_tickets
   request :get_tickets
   request :get_users
   request :search
+  request :update_category
+  request :update_forum
   request :update_organization
   request :update_ticket
   request :update_user
@@ -36,7 +50,7 @@ class Zendesk2::Client < Cistern::Service
 
   class Real
 
-    attr_reader :username, :url, :token
+    attr_accessor :username, :url, :token, :logger
 
     def initialize(options={})
       url = options[:url] || begin
@@ -52,7 +66,7 @@ class Zendesk2::Client < Cistern::Service
 
       @url  = URI.parse(url).to_s
 
-      logger             = options[:logger]
+      @logger            = options[:logger] || Logger.new(nil)
       adapter            = options[:adapter] || :net_http
       connection_options = options[:connection_options] || {ssl: {verify: false}}
       @username          = options[:username] || Zendesk2.defaults[:username]
@@ -65,13 +79,13 @@ class Zendesk2::Client < Cistern::Service
         # response
         builder.use Faraday::Request::BasicAuthentication, @username, password
         builder.use Faraday::Response::RaiseError
-        builder.use Zendesk2::Logger, logger if logger
         builder.response :json
 
         # request
         builder.request :multipart
         builder.request :json
 
+        builder.use Zendesk2::Logger, @logger
         builder.adapter adapter
       end
     end
@@ -103,6 +117,8 @@ class Zendesk2::Client < Cistern::Service
         :users         => {},
         :organizations => {},
         :tickets       => {},
+        :forums        => {},
+        :categories    => {},
       }
     end
 
@@ -181,6 +197,11 @@ class Zendesk2::Client < Cistern::Service
       )
     end
 
+    def pluralize(word)
+      [[/y$/, 'ies'], [/$/, 's']].find{|regex, replace| word.gsub!(regex, replace) if word.match(regex)}
+      word
+    end
+
     def response(options={})
       method = options[:method] || :get
       status = options[:status] || 200

data/lib/zendesk2/searchable.rb

@@ -0,0 +1,17 @@
+module Zendesk2::Searchable
+  def self.included(klass)
+    klass.send(:extend, Zendesk2::Searchable::Attributes)
+  end
+
+  def search(parameters)
+    body = connection.search(parameters.merge("type" => self.class.search_type)).body
+    if data = body.delete("results")
+      load(data)
+    end
+    merge_attributes(body)
+  end
+
+  module Attributes
+    attr_accessor :search_type
+  end
+end

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "0.0.13"
+  VERSION = "0.0.14"
 end

data/lib/zendesk2.rb

@@ -8,11 +8,14 @@ require 'faraday_middleware'
 
 # stdlib
 require 'time'
+require 'logger'
 
 module Zendesk2
+  autoload :Attributes, 'zendesk2/attributes'
   autoload :Error, 'zendesk2/error'
   autoload :Client, 'zendesk2/client'
   autoload :PagedCollection, 'zendesk2/paged_collection'
+  autoload :Searchable, 'zendesk2/searchable'
   autoload :Logger, 'zendesk2/logger'
 
   def self.defaults

data/spec/categories_spec.rb

@@ -0,0 +1,9 @@
+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} }
+end

data/spec/forums_spec.rb

@@ -0,0 +1,9 @@
+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} }
+end

data/spec/shared/resource.rb

@@ -12,6 +12,7 @@ shared_examples "a resource" do |_collection, _params, _update_params|
     before(:each) do
       2.times.each { collection.create(instance_exec(&_params)) }
     end
+
     it "by retrieving the first page" do
       collection.all("per_page" => "1").size.should == 1
     end
@@ -42,11 +43,17 @@ shared_examples "a resource" do |_collection, _params, _update_params|
   end
 
   it "by destroy a record" do
+    pending if _collection == :forums
     record = collection.create(params)
     record.identity.should_not be_nil
     record.destroy
     record.should be_destroyed
   end
 
-  it "should search"
+  # Search index takes 2-3 minutes according to the docs
+  it "should search" do
+    pending unless Zendesk2::Client.mocking?
+    record = collection.create(params)
+    collection.search(params).should include(record)
+  end
 end

data/spec/users_spec.rb

@@ -5,7 +5,7 @@ describe "users" do
   it_should_behave_like "a resource", 
     :users,
     lambda { {email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid, verified: true} },
-    lambda { {name: Zendesk2.uuid} }
+  lambda { {name: Zendesk2.uuid} }
 
   it "should get current user" do
     current_user = client.users.current
@@ -15,6 +15,14 @@ describe "users" do
 
   describe do
     let(:user) { client.users.create(email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid) }
+    after(:all) { user.destroy }
+
+    it "should update organization" do
+      organization = client.organizations.create(name: Zendesk2.uuid)
+      user.organization= organization
+      user.save.should be_true
+      user.organization.should == organization
+    end
 
     it "should get requested tickets" do
       ticket = client.tickets.create(requester: user, subject: Zendesk2.uuid, description: Zendesk2.uuid)
@@ -36,6 +44,12 @@ describe "users" do
       user.should_not be_destroyed
     end
 
+    it "should hate non-unique emails" do
+      email = "zendesk2+#{Zendesk2.uuid}@example.org"
+      client.users.create(email: email, name: Zendesk2.uuid)
+      lambda { client.users.create(email: email, name: Zendesk2.uuid) }.should raise_exception(Zendesk2::Error)
+    end
+
     it "should form login url"
   end
 end

data/zendesk2.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["me@joshualane.com"]
   gem.description   = %q{Zendesk V2 API client}
   gem.summary       = %q{Zendesk V2 API client}
-  gem.homepage      = ""
+  gem.homepage      = "http://joshualane.com/zendesk2"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-12 00:00:00.000000000 Z
+date: 2012-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cistern
@@ -91,21 +91,34 @@ files:
 - README.md
 - Rakefile
 - lib/zendesk2.rb
+- lib/zendesk2/attributes.rb
 - lib/zendesk2/client.rb
+- lib/zendesk2/client/models/categories.rb
+- lib/zendesk2/client/models/category.rb
+- lib/zendesk2/client/models/forum.rb
+- lib/zendesk2/client/models/forums.rb
 - lib/zendesk2/client/models/organization.rb
 - lib/zendesk2/client/models/organizations.rb
 - lib/zendesk2/client/models/ticket.rb
 - lib/zendesk2/client/models/tickets.rb
 - lib/zendesk2/client/models/user.rb
 - lib/zendesk2/client/models/users.rb
+- lib/zendesk2/client/requests/create_category.rb
+- lib/zendesk2/client/requests/create_forum.rb
 - lib/zendesk2/client/requests/create_organization.rb
 - lib/zendesk2/client/requests/create_ticket.rb
 - lib/zendesk2/client/requests/create_user.rb
+- lib/zendesk2/client/requests/destroy_category.rb
+- lib/zendesk2/client/requests/destroy_forum.rb
 - lib/zendesk2/client/requests/destroy_organization.rb
 - lib/zendesk2/client/requests/destroy_ticket.rb
 - lib/zendesk2/client/requests/destroy_user.rb
+- lib/zendesk2/client/requests/get_categories.rb
+- lib/zendesk2/client/requests/get_category.rb
 - lib/zendesk2/client/requests/get_ccd_tickets.rb
 - lib/zendesk2/client/requests/get_current_user.rb
+- lib/zendesk2/client/requests/get_forum.rb
+- lib/zendesk2/client/requests/get_forums.rb
 - lib/zendesk2/client/requests/get_organization.rb
 - lib/zendesk2/client/requests/get_organization_tickets.rb
 - lib/zendesk2/client/requests/get_organization_users.rb
@@ -116,13 +129,18 @@ files:
 - lib/zendesk2/client/requests/get_user.rb
 - lib/zendesk2/client/requests/get_users.rb
 - lib/zendesk2/client/requests/search.rb
+- lib/zendesk2/client/requests/update_category.rb
+- lib/zendesk2/client/requests/update_forum.rb
 - lib/zendesk2/client/requests/update_organization.rb
 - lib/zendesk2/client/requests/update_ticket.rb
 - lib/zendesk2/client/requests/update_user.rb
 - lib/zendesk2/error.rb
 - lib/zendesk2/logger.rb
 - lib/zendesk2/paged_collection.rb
+- lib/zendesk2/searchable.rb
 - lib/zendesk2/version.rb
+- spec/categories_spec.rb
+- spec/forums_spec.rb
 - spec/organizations_spec.rb
 - spec/shared/resource.rb
 - spec/spec_helper.rb
@@ -130,7 +148,7 @@ files:
 - spec/tickets_spec.rb
 - spec/users_spec.rb
 - zendesk2.gemspec
-homepage: ''
+homepage: http://joshualane.com/zendesk2
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -155,6 +173,8 @@ signing_key:
 specification_version: 3
 summary: Zendesk V2 API client
 test_files:
+- spec/categories_spec.rb
+- spec/forums_spec.rb
 - spec/organizations_spec.rb
 - spec/shared/resource.rb
 - spec/spec_helper.rb