zendesk2 0.0.14 → 0.0.15

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.rspec

data/README.md

@@ -7,9 +7,9 @@ Ruby client for the [Zendesk V2 API](http://developer.zendesk.com/documentation/
 ## Installation
 
 Add this line to your application's Gemfile:
-
-    gem 'zendesk2'
-
+```ruby
+gem 'zendesk2'
+```
 Or install it yourself as:
 
     $ gem install zendesk2
@@ -50,107 +50,110 @@ Currently support resources
 * Ticket
 * Organization
 * Forums
+* Topics
 
 All collection are accessed like so:
 ```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",
+=> <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`
+```ruby
+client.users.create(email: "ohhai@example.org", name: "lulz")
+=> <Zendesk2::Client::User
+  id=234020811,
+  ...
+  url="https://engineyarddev.zendesk.com/api/v2/users/234020811.json",
+  ...
+  email="ohhai@example.org",
+  >
+```
 
-	client.users.create(email: "ohhai@example.org", name: "lulz")
-	 =>   <Zendesk2::Client::User
-    id=234020811,
-    ...
-    url="https://engineyarddev.zendesk.com/api/v2/users/234020811.json",
-    ...
-    email="ohhai@example.org",
-    >
-
-
-	client.users.new(email: "ohhai@example.org")
-	=>    <Zendesk2::Client::User
-    id=nil,
-    ...
-    url=nil,
-    ...
-    email="ohhai@example.org",
-    ...
-    >
-
+```ruby
+client.users.new(email: "ohhai@example.org")
+=> <Zendesk2::Client::User
+  id=nil,
+  ...
+  url=nil,
+  ...
+  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.
-
-    page = client.users.all("per_page" => 1, "page" => 4)
-	 =>   <Zendesk2::Client::Users
-    count=1780,
-    next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1",
-    previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1"
-    [
-      <Zendesk2::Client::User
-        id=217761652,
-        url="https://dev.zendesk.com/api/v2/users/217761652.json",
-        external_id=nil,
-        name="Guy Dude",
-        ...
-       >
-    ]
-
-    page.next_page
-	 =>   <Zendesk2::Client::Users
-    count=1780,
-    next_page_link="https://dev.zendesk.com/api/v2/users.json?page=6&per_page=1",
-    previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=4&per_page=1"
-    [
-      <Zendesk2::Client::User
-        id=217761742,
-        url="https://dev.zendesk.com/api/v2/users/217761742.json",
-        ...
-        name="epitaphical osteofibrous",
-        ...
-        >
-     ]
-
-    page.previous_page
-	 =>   <Zendesk2::Client::Users
-    count=1780,
-    next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1",
-    previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1"
-    [
-      <Zendesk2::Client::User
-        id=217761652,
-        url="https://dev.zendesk.com/api/v2/users/217761652.json",
-        ...
-        name="Guy Dude",
-        ...
-      >
-    ]
-
+```ruby
+page = client.users.all("per_page" => 1, "page" => 4)
+=> <Zendesk2::Client::Users
+  count=1780,
+  next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1",
+  previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1"
+  [
+    <Zendesk2::Client::User
+      id=217761652,
+      url="https://dev.zendesk.com/api/v2/users/217761652.json",
+      external_id=nil,
+      name="Guy Dude",
+      ...
+    >
+  ]
+```
+```ruby
+page.next_page
+=> <Zendesk2::Client::Users
+  count=1780,
+  next_page_link="https://dev.zendesk.com/api/v2/users.json?page=6&per_page=1",
+  previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=4&per_page=1"
+  [
+    <Zendesk2::Client::User
+      id=217761742,
+      url="https://dev.zendesk.com/api/v2/users/217761742.json",
+      ...
+      name="epitaphical osteofibrous",
+      ...
+    >
+  ]
+```
+```ruby
+page.previous_page
+=> <Zendesk2::Client::Users
+  count=1780,
+  next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1",
+  previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1"
+  [
+    <Zendesk2::Client::User
+      id=217761652,
+      url="https://dev.zendesk.com/api/v2/users/217761652.json",
+      ...
+      name="Guy Dude",
+      ...
+    >
+  ]
+```
 #### 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.
-
-	Zendesk2::Client::Ticket.new.save        # performs a create
-	Zendesk2::Client::Ticket.new(id: 1).save # performs an update
-
+```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
 
-
-  	$ gem install gem-release
-  	$ gem bump -trv (major|minor|patch)
+    $ gem install gem-release
+    $ gem bump -trv (major|minor|patch)
 
 ## Contributing
 

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

@@ -0,0 +1,53 @@
+class Zendesk2::Client::Topic < Cistern::Model
+  extend Zendesk2::Attributes
+
+  PARAMS = %w[id title body submitter_id updater_id forum_id locked pinned highlighted position tags]
+
+  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 topic
+  attribute :title,        type: :string  # ro[no] mandatory[yes]   The title of the topic
+  attribute :body,         type: :string  # ro[no] mandatory[yes] The unescaped body of the topic
+  attribute :topic_type,   type: :string  # ro[yes] mandatory[no] The type of topic. Either "articles", "ideas" or "questions"
+  attribute :submitter_id, type: :integer # ro[no] mandatory[no]  The id of the user who submitted the topic
+  attribute :updater_id,   type: :integer # ro[no] mandatory[no]  The id of the person to last update the topic
+  attribute :forum_id,     type: :integer # ro[no] mandatory[no]  Forum that the topic is associated to
+  attribute :locked,       type: :boolean # ro[no] mandatory[no]  Whether comments are allowed
+  attribute :pinned,       type: :boolean # ro[no] mandatory[no]  If the topic is marked as pinned and hence eligible to show up on the front page
+  attribute :highlighted,  type: :boolean # ro[no] mandatory[no]    Set to true to highlight a topic within its forum
+  attribute :answered,     type: :boolean # ro[yes] mandatory[no]   Set to true if the topic is a question and it has been marked as answered.
+  attribute :position,     type: :integer # ro[no] mandatory[no]  The position of this topic relative to other topics in the same forum
+  attribute :tags,         type: :array   # ro[no] mandatory[no]  The tags set on the topic
+  attribute :created_at,   type: :date    # ro[yes] mandatory[no] The time the topic was created
+
+  assoc_accessor :submitter, collection: :users
+  assoc_accessor :updater, collection: :users
+  assoc_accessor :forum
+
+
+  def destroy
+    requires :identity
+
+    connection.destroy_topic("id" => self.identity)
+  end
+
+  def destroyed?
+    !self.reload
+  end
+
+  def save
+    data = if new_record?
+             requires :title, :body
+             connection.create_topic(params).body["topic"]
+           else
+             requires :identity
+             connection.update_topic(params).body["topic"]
+           end
+    merge_attributes(data)
+  end
+
+  private
+
+  def params
+    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+  end
+end

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

@@ -0,0 +1,12 @@
+class Zendesk2::Client::Topics < Cistern::Collection
+  include Zendesk2::PagedCollection
+  include Zendesk2::Searchable
+
+  model Zendesk2::Client::Topic
+
+  self.collection_method= :get_topics
+  self.collection_root= "topics"
+  self.model_method= :get_topic
+  self.model_root= "topic"
+  self.search_type= "topic"
+end

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

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

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

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

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

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

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

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

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

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

data/lib/zendesk2/client.rb

@@ -7,6 +7,8 @@ class Zendesk2::Client < Cistern::Service
   collection :categories
   model :forum
   collection :forums
+  model :topic
+  collection :topics
   model :organization
   collection :organizations
   model :ticket
@@ -16,17 +18,20 @@ class Zendesk2::Client < Cistern::Service
 
   request :create_category
   request :create_forum
+  request :create_topic
   request :create_organization
   request :create_ticket
   request :create_user
   request :destroy_category
   request :destroy_forum
+  request :destroy_topic
   request :destroy_organization
   request :destroy_ticket
   request :destroy_user
   request :get_current_user
   request :get_category
   request :get_forum
+  request :get_topic
   request :get_organization
   request :get_organization_tickets
   request :get_organization_users
@@ -34,6 +39,7 @@ class Zendesk2::Client < Cistern::Service
   request :get_user
   request :get_categories
   request :get_forums
+  request :get_topics
   request :get_organizations
   request :get_requested_tickets
   request :get_ccd_tickets
@@ -42,6 +48,7 @@ class Zendesk2::Client < Cistern::Service
   request :search
   request :update_category
   request :update_forum
+  request :update_topic
   request :update_organization
   request :update_ticket
   request :update_user
@@ -118,6 +125,7 @@ class Zendesk2::Client < Cistern::Service
         :organizations => {},
         :tickets       => {},
         :forums        => {},
+        :topics        => {},
         :categories    => {},
       }
     end

data/lib/zendesk2/version.rb

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

data/spec/topics_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe "topics" do
+  let(:client) { create_client }
+  let(:forum) { client.forums.create(name: Zendesk2.uuid) }
+  it_should_behave_like "a resource",
+    :topics,
+    lambda { {title: Zendesk2.uuid, body: Zendesk2.uuid, forum_id: forum.id} },
+    lambda { {title: Zendesk2.uuid, body: Zendesk2.uuid} }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-22 00:00:00.000000000 Z
+date: 2012-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cistern
@@ -83,7 +83,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rspec
 - .travis.yml
 - Gemfile
 - Guardfile
@@ -101,17 +100,21 @@ files:
 - lib/zendesk2/client/models/organizations.rb
 - lib/zendesk2/client/models/ticket.rb
 - lib/zendesk2/client/models/tickets.rb
+- lib/zendesk2/client/models/topic.rb
+- lib/zendesk2/client/models/topics.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_topic.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_user.rb
 - lib/zendesk2/client/requests/get_categories.rb
 - lib/zendesk2/client/requests/get_category.rb
@@ -126,6 +129,8 @@ files:
 - lib/zendesk2/client/requests/get_requested_tickets.rb
 - 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_topics.rb
 - lib/zendesk2/client/requests/get_user.rb
 - lib/zendesk2/client/requests/get_users.rb
 - lib/zendesk2/client/requests/search.rb
@@ -133,6 +138,7 @@ files:
 - 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_topic.rb
 - lib/zendesk2/client/requests/update_user.rb
 - lib/zendesk2/error.rb
 - lib/zendesk2/logger.rb
@@ -146,6 +152,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/client_helper.rb
 - spec/tickets_spec.rb
+- spec/topics_spec.rb
 - spec/users_spec.rb
 - zendesk2.gemspec
 homepage: http://joshualane.com/zendesk2
@@ -180,4 +187,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/client_helper.rb
 - spec/tickets_spec.rb
+- spec/topics_spec.rb
 - spec/users_spec.rb
+has_rdoc: 

data/.rspec

@@ -1 +0,0 @@
---color