zendesk2 1.5.17 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52ed002a3f7df6b685aa4ffdcfdbeb6cd340c4be
-  data.tar.gz: 40af00481679a1a46dc7918799b0e53a5585a96e
+  metadata.gz: 0ab381ae9ac2abcdb319cb7485c1046957320739
+  data.tar.gz: 33c6c9c16c1b2dcef4de822d621f1b9d326b6c8c
 SHA512:
-  metadata.gz: 7eeb1c7b41485340eee8a062677b8aeb79fe67a0420289bc9ac8d9b6a28fc2da6566c57b3b12f5e8bd6a70e4c68827e44dd5459e867cd11f4fcb962a94d05670
-  data.tar.gz: cffdca2347b876fe1a787879b78d74b7fb3a742d36bc3ad192065b7a8f50fb2964388933bd72c2cc19acb7b6ebe5f9f78e5f3a9d302c9f6f7a1ebaf7655ef523
+  metadata.gz: b6aab81be23583b46b17345738dab3d3fcbec5723be5014fb2ec9058ca8a3de7dd58de77f86e09c7a6e1274b2f4e0f536b703b1cf8ee76758ab31f31d91c5aa4
+  data.tar.gz: 70d741ec4a91b0803e1f1dba2541d23a1f6e78bfb984314b53153e281a0091f7dd8e3905b731e64b0075e003e610e0d2941d0c6184b3d5f386a0be61bea6ddfb

data/lib/zendesk2/client/collection.rb

@@ -61,7 +61,7 @@ class Zendesk2::Client::Collection
   # @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))}
+    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)
@@ -85,4 +85,8 @@ class Zendesk2::Client::Collection
   rescue Zendesk2::Error
     nil
   end
+
+  def new(attributes={})
+    super(self.attributes.merge(attributes))
+  end
 end

data/lib/zendesk2/client/collections/help_center/articles.rb

@@ -11,4 +11,26 @@ class Zendesk2::Client::HelpCenter::Articles < Zendesk2::Client::Collection
   self.search_type       = nil
   self.search_request    = :search_help_center_articles
 
+  attribute :section_id, type: :integer
+  attribute :category_id, type: :integer
+
+  scopes << :section_id
+  scopes << :category_id
+
+  def collection_page(params={})
+    collection_method = if category_id
+                          :get_help_center_categories_articles
+                        elsif section_id
+                          :get_help_center_sections_articles
+                        else
+                          :get_help_center_articles
+                        end
+
+    body = service.send(collection_method, Cistern::Hash.stringify_keys(self.attributes.merge(params))).body
+
+    self.load(body[collection_root]) # 'results' is the key for paged searches
+    self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+    self
+  end
+
 end

data/lib/zendesk2/client/collections/help_center/sections.rb

@@ -8,4 +8,22 @@ class Zendesk2::Client::HelpCenter::Sections < Zendesk2::Client::Collection
   self.collection_root   = "sections"
   self.model_method      = :get_help_center_section
   self.model_root        = "section"
+
+  attribute :category_id, type: :integer
+
+  scopes << :category_id
+
+  def collection_page(params={})
+    collection_method = if category_id
+                          :get_help_center_categories_sections
+                        else
+                          :get_help_center_sections
+                        end
+
+    body = service.send(collection_method, Cistern::Hash.stringify_keys(self.attributes.merge(params))).body
+
+    self.load(body[collection_root]) # 'results' is the key for paged searches
+    self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+    self
+  end
 end

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

@@ -27,6 +27,24 @@ class Zendesk2::Client::HelpCenter::Category < Zendesk2::Client::Model
   # @return [String] The API url of this category
   attribute :url, type: :string # ro:yes required:no
 
+  def articles
+    requires :identity
+
+    service.help_center_articles(category_id: self.identity)
+  end
+
+  def destroy!
+    requires :identity
+
+    service.destroy_help_center_category("category" => { "id" => self.identity })
+  end
+
+  def sections
+    requires :identity
+
+    service.help_center_sections(category_id: self.identity)
+  end
+
   def save!
     response = if new_record?
                  requires :name, :locale
@@ -40,10 +58,4 @@ class Zendesk2::Client::HelpCenter::Category < Zendesk2::Client::Model
 
     merge_attributes(response.body["category"])
   end
-
-  def destroy!
-    requires :identity
-
-    service.destroy_help_center_category("category" => { "id" => self.identity })
-  end
 end

data/lib/zendesk2/client/models/help_center/section.rb

@@ -34,6 +34,12 @@ class Zendesk2::Client::HelpCenter::Section < Zendesk2::Client::Model
   # @return [Zendesk2::Client::HelpCenter::Category] category containing this section
   assoc_accessor :category, collection: :help_center_categories
 
+  def destroy!
+    requires :identity
+
+    service.destroy_help_center_section("section" => { "id" => self.identity })
+  end
+
   def save!
     response = if new_record?
                  requires :name, :locale, :category_id
@@ -48,9 +54,10 @@ class Zendesk2::Client::HelpCenter::Section < Zendesk2::Client::Model
     merge_attributes(response.body["section"])
   end
 
-  def destroy!
+  def articles
     requires :identity
 
-    service.destroy_help_center_section("section" => { "id" => self.identity })
+    service.help_center_articles(section_id: self.identity)
   end
+
 end

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

@@ -0,0 +1,21 @@
+class Zendesk2::Client::GetHelpCenterCategoriesArticles < Zendesk2::Client::Request
+  request_path { |r|
+    "/help_center/categories/#{r.category_id}/articles.json"
+  }
+
+  page_params!
+
+  def category_id
+    Integer(
+      params.fetch("category_id")
+    )
+  end
+
+  def mock
+    self.find!(:help_center_categories, category_id)
+
+    mock_response("articles" => self.data[:help_center_articles].values.select { |s|
+      self.data[:help_center_sections].fetch(s["section_id"])["category_id"] == category_id
+    })
+  end
+end

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

@@ -0,0 +1,19 @@
+class Zendesk2::Client::GetHelpCenterCategoriesSections < Zendesk2::Client::Request
+  request_path { |r|
+    "/help_center/categories/#{r.category_id}/sections.json"
+  }
+
+  page_params!
+
+  def category_id
+    Integer(
+      params.fetch("category_id")
+    )
+  end
+
+  def mock
+    self.find!(:help_center_categories, category_id)
+
+    mock_response("sections" => self.data[:help_center_sections].values.select { |s| s["category_id"] == category_id })
+  end
+end

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

@@ -0,0 +1,19 @@
+class Zendesk2::Client::GetHelpCenterSectionsArticles < Zendesk2::Client::Request
+  request_path { |r|
+    "/help_center/sections/#{r.section_id}/articles.json"
+  }
+
+  page_params!
+
+  def section_id
+    Integer(
+      params.fetch("section_id")
+    )
+  end
+
+  def mock
+    self.find!(:help_center_sections, section_id)
+
+    mock_response("articles" => self.data[:help_center_articles].values.select { |s| s["section_id"] == section_id })
+  end
+end

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "1.5.17"
+  VERSION = "1.6.1"
 end

data/spec/help_center/categories_spec.rb

@@ -9,4 +9,23 @@ describe "help_center/categories" do
     :update_params => lambda { { name: mock_uuid } },
     :search        => false,
   }
+
+  context "with a category, sections, and articles" do
+    let!(:category) { client.help_center_categories.create!(name: mock_uuid, locale: "en-us") }
+    let!(:section)  { category.sections.create!(name: mock_uuid, locale: "en-us") }
+    let!(:articles) { 2.times.map { section.articles.create(title: mock_uuid, locale: "en-us") } }
+
+    before {
+      client.help_center_categories.create!(name: mock_uuid, locale: "en-us").
+      sections.create!(name: mock_uuid, locale: "en-us").articles.create!(title: mock_uuid, locale: "en-us")
+    }
+
+    it "lists sections within a category" do
+      expect(category.sections.all).to contain_exactly(section)
+    end
+
+    it "lists articles within a category" do
+      expect(category.articles.all).to match_array(articles)
+    end
+  end
 end

data/spec/help_center/sections_spec.rb

@@ -3,9 +3,10 @@ require 'spec_helper'
 describe "help_center/sections" do
   let(:client)   { create_client }
   let!(:category) do
-    client.help_center_categories.create!(name: mock_uuid,
-                                          locale: "en-us",
-                                         )
+    client.help_center_categories.create!(
+      name: mock_uuid,
+      locale: "en-us",
+    )
   end
 
   include_examples "zendesk resource", {
@@ -14,4 +15,19 @@ describe "help_center/sections" do
     :update_params => lambda { { name: mock_uuid } },
     :search        => false,
   }
+
+  context "with a category, sections, and articles" do
+    let!(:category) { client.help_center_categories.create!(name: mock_uuid, locale: "en-us") }
+    let!(:section)  { category.sections.create!(name: mock_uuid, locale: "en-us") }
+    let!(:articles) { 2.times.map { section.articles.create(title: mock_uuid, locale: "en-us") } }
+
+    before {
+      client.help_center_categories.create!(name: mock_uuid, locale: "en-us").
+      sections.create!(name: mock_uuid, locale: "en-us").articles.create!(title: mock_uuid, locale: "en-us")
+    }
+
+    it "lists articles within a section" do
+      expect(section.articles.all).to match_array(articles)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 1.5.17
+  version: 1.6.1
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cistern
@@ -175,9 +175,12 @@ files:
 - lib/zendesk2/client/requests/get_help_center_article.rb
 - lib/zendesk2/client/requests/get_help_center_articles.rb
 - lib/zendesk2/client/requests/get_help_center_categories.rb
+- lib/zendesk2/client/requests/get_help_center_categories_articles.rb
+- lib/zendesk2/client/requests/get_help_center_categories_sections.rb
 - lib/zendesk2/client/requests/get_help_center_category.rb
 - lib/zendesk2/client/requests/get_help_center_section.rb
 - lib/zendesk2/client/requests/get_help_center_sections.rb
+- lib/zendesk2/client/requests/get_help_center_sections_articles.rb
 - lib/zendesk2/client/requests/get_membership.rb
 - lib/zendesk2/client/requests/get_memberships.rb
 - lib/zendesk2/client/requests/get_organization.rb
@@ -276,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Zendesk V2 API client
@@ -302,4 +305,3 @@ test_files:
 - spec/user_fields_spec.rb
 - spec/user_identities_spec.rb
 - spec/users_spec.rb
-has_rdoc: