zendesk2 0.0.15 → 0.0.16

data/README.md

@@ -30,15 +30,19 @@ Default credentials will be read in from `~/.zendesk2` file in YAML format.
 ### Creating the client
 
 Either the absolute url or the subdomain is required.  Username and password is always required.
+
 ```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
+
 ```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
@@ -46,13 +50,14 @@ Zendesk2::Client.new(url: "http://support.cloud.engineyard.com", username: "mate
 Currently support resources
 
 * Categories
-* User
-* Ticket
-* Organization
 * Forums
+* Organization
+* Ticket
 * Topics
+* User
 
 All collection are accessed like so:
+
 ```ruby
 client.users.all
 => <Zendesk2::Client::Users
@@ -67,7 +72,9 @@ client.users.all
     >
   ]
 ```
+
 Collections also respond to `create` and `new`
+
 ```ruby
 client.users.create(email: "ohhai@example.org", name: "lulz")
 => <Zendesk2::Client::User
@@ -90,9 +97,11 @@ client.users.new(email: "ohhai@example.org")
   ...
   >
 ```
+
 #### Paging
 
 Paged collections respond to `next_page` and `previous_page` when appropriate.  `page_size` and `page` can be passed directly to the collection to control size and index.
+
 ```ruby
 page = client.users.all("per_page" => 1, "page" => 4)
 => <Zendesk2::Client::Users
@@ -109,6 +118,7 @@ page = client.users.all("per_page" => 1, "page" => 4)
     >
   ]
 ```
+
 ```ruby
 page.next_page
 => <Zendesk2::Client::Users
@@ -125,6 +135,7 @@ page.next_page
     >
   ]
 ```
+
 ```ruby
 page.previous_page
 => <Zendesk2::Client::Users
@@ -141,13 +152,16 @@ page.previous_page
     >
   ]
 ```
+
 #### Models
 
 All models respond to `destroy` and `save` if applicable.  `save` performs a 'create' operation if there is no identity provided or an 'update' if there is an identity.
+
 ```ruby
 Zendesk2::Client::Ticket.new.save        # performs a create
 Zendesk2::Client::Ticket.new(id: 1).save # performs an update
 ```
+
 Attributes can be enumerated by the `attributes` method.
 
 ## Releasing

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

@@ -0,0 +1,45 @@
+class Zendesk2::Client::TopicComment < Cistern::Model
+  extend Zendesk2::Attributes
+
+  PARAMS = %w[id topic_id user_id body informative]
+
+  identity  :id,          type: :integer # ro[integer] mandatory [yes] Automatically assigned upon creation
+  attribute :url,         type: :string  # ro[yes]     mandatory [no]  The API url of this topic comment
+  attribute :topic_id,    type: :integer # ro[no]      mandatory [yes] The id of the topic this comment was made on
+  attribute :user_id,     type: :integer # ro[no]      mandatory [yes] The id of the user making the topic comment
+  attribute :body,        type: :string  # ro[no]      mandatory [yes] The comment body
+  attribute :informative, type: :boolean # ro[no]      mandatory [no]  If the comment has been flagged as informative
+  attribute :attachments, type: :array   # ro[yes]     mandatory [no]  Attachments to this comment as Attachment objects
+  attribute :created_at,  type: :date    # ro[yes]     mandatory [no]  The time the topic_comment was created
+  attribute :updated_at,  type: :date    # ro[yes]     mandatory [no]  The time of the last update of the topic_comment
+
+  assoc_accessor :user
+  assoc_accessor :topic
+
+  def destroy
+    requires :identity
+
+    connection.destroy_topic_comment("id" => self.identity)
+  end
+
+  def destroyed?
+    !self.reload
+  end
+
+  def save
+    data = if new_record?
+             requires :topic_id, :user_id, :body
+             connection.create_topic_comment(params).body["topic_comment"]
+           else
+             requires :identity
+             connection.update_topic_comment(params).body["topic_comment"]
+           end
+    merge_attributes(data)
+  end
+
+  private
+
+  def params
+    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+  end
+end

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

@@ -0,0 +1,12 @@
+class Zendesk2::Client::TopicComments < Cistern::Collection
+  include Zendesk2::PagedCollection
+  include Zendesk2::Searchable
+
+  model Zendesk2::Client::TopicComment
+
+  self.collection_method= :get_topic_comments
+  self.collection_root= "topic_comments"
+  self.model_method= :get_topic_comment
+  self.model_root= "topic_comment"
+  self.search_type= "topic_comment"
+end

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

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

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

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

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

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

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

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

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

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

data/lib/zendesk2/client.rb

@@ -9,6 +9,8 @@ class Zendesk2::Client < Cistern::Service
   collection :forums
   model :topic
   collection :topics
+  model :topic_comment
+  collection :topic_comments
   model :organization
   collection :organizations
   model :ticket
@@ -19,12 +21,14 @@ class Zendesk2::Client < Cistern::Service
   request :create_category
   request :create_forum
   request :create_topic
+  request :create_topic_comment
   request :create_organization
   request :create_ticket
   request :create_user
   request :destroy_category
   request :destroy_forum
   request :destroy_topic
+  request :destroy_topic_comment
   request :destroy_organization
   request :destroy_ticket
   request :destroy_user
@@ -32,6 +36,7 @@ class Zendesk2::Client < Cistern::Service
   request :get_category
   request :get_forum
   request :get_topic
+  request :get_topic_comment
   request :get_organization
   request :get_organization_tickets
   request :get_organization_users
@@ -40,6 +45,7 @@ class Zendesk2::Client < Cistern::Service
   request :get_categories
   request :get_forums
   request :get_topics
+  request :get_topic_comments
   request :get_organizations
   request :get_requested_tickets
   request :get_ccd_tickets
@@ -49,6 +55,7 @@ class Zendesk2::Client < Cistern::Service
   request :update_category
   request :update_forum
   request :update_topic
+  request :update_topic_comment
   request :update_organization
   request :update_ticket
   request :update_user
@@ -121,12 +128,13 @@ class Zendesk2::Client < Cistern::Service
 
     def self.data
       @data ||= {
-        :users         => {},
-        :organizations => {},
-        :tickets       => {},
-        :forums        => {},
-        :topics        => {},
-        :categories    => {},
+        :users          => {},
+        :organizations  => {},
+        :tickets        => {},
+        :forums         => {},
+        :topics         => {},
+        :categories     => {},
+        :topic_comments => {},
       }
     end
 
@@ -206,8 +214,9 @@ class Zendesk2::Client < Cistern::Service
     end
 
     def pluralize(word)
-      [[/y$/, 'ies'], [/$/, 's']].find{|regex, replace| word.gsub!(regex, replace) if word.match(regex)}
-      word
+      pluralized = word.dup
+      [[/y$/, 'ies'], [/$/, 's']].find{|regex, replace| pluralized.gsub!(regex, replace) if pluralized.match(regex)}
+      pluralized
     end
 
     def response(options={})

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

data/spec/topic_comments_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "topic_comments" do
+  let(:client) { create_client }
+  let(:user) { client.users.create(email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid, verified: true) }
+  let(:forum) { client.forums.create(name: Zendesk2.uuid) }
+  let(:topic) { client.topics.create(title: Zendesk2.uuid, body: Zendesk2.uuid, forum: forum) }
+  it_should_behave_like "a resource",
+    :topic_comments,
+    lambda { {body: Zendesk2.uuid, topic_id: topic.id, user_id: user.id} },
+    lambda { {body: Zendesk2.uuid} }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-31 00:00:00.000000000 Z
+date: 2012-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cistern
@@ -101,6 +101,8 @@ files:
 - lib/zendesk2/client/models/ticket.rb
 - lib/zendesk2/client/models/tickets.rb
 - lib/zendesk2/client/models/topic.rb
+- lib/zendesk2/client/models/topic_comment.rb
+- lib/zendesk2/client/models/topic_comments.rb
 - lib/zendesk2/client/models/topics.rb
 - lib/zendesk2/client/models/user.rb
 - lib/zendesk2/client/models/users.rb
@@ -109,12 +111,14 @@ files:
 - lib/zendesk2/client/requests/create_organization.rb
 - lib/zendesk2/client/requests/create_ticket.rb
 - lib/zendesk2/client/requests/create_topic.rb
+- lib/zendesk2/client/requests/create_topic_comment.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_topic.rb
+- lib/zendesk2/client/requests/destroy_topic_comment.rb
 - lib/zendesk2/client/requests/destroy_user.rb
 - lib/zendesk2/client/requests/get_categories.rb
 - lib/zendesk2/client/requests/get_category.rb
@@ -130,6 +134,8 @@ files:
 - lib/zendesk2/client/requests/get_ticket.rb
 - lib/zendesk2/client/requests/get_tickets.rb
 - lib/zendesk2/client/requests/get_topic.rb
+- lib/zendesk2/client/requests/get_topic_comment.rb
+- lib/zendesk2/client/requests/get_topic_comments.rb
 - lib/zendesk2/client/requests/get_topics.rb
 - lib/zendesk2/client/requests/get_user.rb
 - lib/zendesk2/client/requests/get_users.rb
@@ -139,6 +145,7 @@ files:
 - lib/zendesk2/client/requests/update_organization.rb
 - lib/zendesk2/client/requests/update_ticket.rb
 - lib/zendesk2/client/requests/update_topic.rb
+- lib/zendesk2/client/requests/update_topic_comment.rb
 - lib/zendesk2/client/requests/update_user.rb
 - lib/zendesk2/error.rb
 - lib/zendesk2/logger.rb
@@ -152,6 +159,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/client_helper.rb
 - spec/tickets_spec.rb
+- spec/topic_comments_spec.rb
 - spec/topics_spec.rb
 - spec/users_spec.rb
 - zendesk2.gemspec
@@ -187,6 +195,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/client_helper.rb
 - spec/tickets_spec.rb
+- spec/topic_comments_spec.rb
 - spec/topics_spec.rb
 - spec/users_spec.rb
 has_rdoc: