zendesk2 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 279574410b23569961ce3ebf883b5b34cbe2010f
-  data.tar.gz: 586cea4bcc15a218d53fa0e0422e32c04734431f
+  metadata.gz: d6b82a5a48123f485de6ede8d43e13a302538888
+  data.tar.gz: 6e1df0272327038e7b5b476ee56611e580324a05
 SHA512:
-  metadata.gz: 69d5003ad442219c61c602a412c7a983ebbace73c9d43d73b479f8c76f54c51cb74912c40fec279523388a8b35139360e79ed7a50b48806339db0823d846d1b5
-  data.tar.gz: 75e9f81026df83afdcbe0bf588490e3b5fcea9ec99200b9762e2a9f1763ec09300879a1d9a460a770b43cad877c21b876f39dcc189b437615ff7858a3c56e779
+  metadata.gz: 986b90b437821c2b751d66f31c6e74736e0bfe603bb4cb05e40a9f64a170ade9df31f38cf937e99871a7248c7a363c85c3ec010e23295f74d98edb837b7a57bc
+  data.tar.gz: 94f4606077f53d047ba69058a34e414727399e91e7ac074890afef445d846efe2e52b9b40e22b80045a637911e3a3fb646d42f50393d402d3015be3dc9570905

data/README.md

@@ -1,6 +1,6 @@
 # Zendesk2
 
-[![Build Status](https://secure.travis-ci.org/lanej/zendesk2.png)](http://travis-ci.org/lanej/zendesk2)
+[![Build Status](https://travis-ci.org/lanej/zendesk2.svg?branch=master)](http://travis-ci.org/lanej/zendesk2)
 [![Gem Version](https://fury-badge.herokuapp.com/rb/zendesk2.png)](http://badge.fury.io/rb/zendesk2)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/lanej/zendesk2)
 [![Dependency Status](https://gemnasium.com/lanej/zendesk2.png)](https://gemnasium.com/lanej/zendesk2)

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

@@ -0,0 +1,13 @@
+class Zendesk2::Client::HelpCenter::Articles < Zendesk2::PagedCollection
+  include Zendesk2::Searchable
+
+  model Zendesk2::Client::HelpCenter::Article
+
+  self.collection_method = :get_help_center_articles
+  self.collection_root   = "articles"
+  self.model_method      = :get_help_center_article
+  self.model_root        = "article"
+  self.search_type       = nil
+  self.search_request    = :search_help_center_articles
+
+end

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

@@ -0,0 +1,10 @@
+class Zendesk2::Client::HelpCenter::Categories < Zendesk2::PagedCollection
+  include Zendesk2::Searchable
+
+  model Zendesk2::Client::HelpCenter::Category
+
+  self.collection_method = :get_help_center_categories
+  self.collection_root   = "categories"
+  self.model_method      = :get_help_center_category
+  self.model_root        = "category"
+end

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

@@ -0,0 +1,10 @@
+class Zendesk2::Client::HelpCenter::Sections < Zendesk2::PagedCollection
+  include Zendesk2::Searchable
+
+  model Zendesk2::Client::HelpCenter::Section
+
+  self.collection_method = :get_help_center_sections
+  self.collection_root   = "sections"
+  self.model_method      = :get_help_center_section
+  self.model_root        = "section"
+end

data/lib/zendesk2/client/help_center.rb

@@ -0,0 +1 @@
+module Zendesk2::Client::HelpCenter; end

data/lib/zendesk2/client/mock.rb

@@ -6,21 +6,24 @@ class Zendesk2::Client < Cistern::Service
 
     def self.data
       @data ||= {
-        :categories      => {},
-        :forums          => {},
-        :groups          => {},
-        :identities      => {},
-        :memberships     => {},
-        :organizations   => {},
-        :ticket_audits   => {},
-        :ticket_comments => {},
-        :ticket_fields   => {},
-        :ticket_metrics  => {},
-        :tickets         => {},
-        :topic_comments  => {},
-        :topics          => {},
-        :user_fields     => {},
-        :users           => {},
+        :categories             => {},
+        :forums                 => {},
+        :groups                 => {},
+        :help_center_articles   => {},
+        :help_center_categories => {},
+        :help_center_sections   => {},
+        :identities             => {},
+        :memberships            => {},
+        :organizations          => {},
+        :ticket_audits          => {},
+        :ticket_comments        => {},
+        :ticket_fields          => {},
+        :ticket_metrics         => {},
+        :tickets                => {},
+        :topic_comments         => {},
+        :topics                 => {},
+        :user_fields            => {},
+        :users                  => {},
       }
     end
 
@@ -57,6 +60,10 @@ class Zendesk2::Client < Cistern::Service
       @current_user
     end
 
+    def html_url_for(path)
+      File.join(@url, path.to_s)
+    end
+
     def url_for(path)
       File.join(@url, "/api/v2", path.to_s)
     end

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

@@ -0,0 +1,69 @@
+class Zendesk2::Client::HelpCenter::Article < Zendesk2::Model
+  extend Zendesk2::Attributes
+
+  # @return [Integer] Automatically assigned when the article is created
+  identity :id, type: :integer # ro:yes required:no
+
+  # @return [Integer] The id of the user who wrote the article (set to the user who made the request on create by default)
+  attribute :author_id, type: :integer # ro:no required:no
+  # @return [String] The body of the article
+  attribute :body, type: :string # ro:no required:no
+  # @return [Boolean] True if comments are disabled; false otherwise
+  attribute :comments_disabled, type: :boolean # ro:no required:no
+  # @return [Time] The time at which the article was created
+  attribute :created_at, type: :time # ro:yes required:no
+  # @return [Boolean] True if the translation for the current locale is a draft; false otherwise. false by default
+  attribute :draft, type: :boolean # ro:no required:no
+  # @return [String] The url of the article in Help Center
+  attribute :html_url, type: :string # ro:yes required:no
+  # @return [String] An array of label names associated with this article. By default no label names are used (only available on certain plans)
+  attribute :label_names, type: :string # ro:no required:no
+  # @return [String] The locale that the article is being displayed in
+  attribute :locale, type: :string # ro:no required:yes
+  # @return [Boolean] Whether the article is out of date
+  attribute :outdated, type: :boolean # ro:yes required:no
+  # @return [Integer] The position of this article in the article list. '0' by default
+  attribute :position, type: :integer # ro:no required:no
+  # @return [Boolean] True if this article is promoted; false otherwise. false by default
+  attribute :promoted, type: :boolean # ro:no required:no
+  # @return [Integer] The id of the section to which this article belongs
+  attribute :section_id, type: :integer # ro:no required:no
+  # @return [String] The source (default) locale of the article
+  attribute :source_locale, type: :string # ro:yes required:no
+  # @return [String] The title of the article
+  attribute :title, type: :string # ro:no required:yes
+  # @return [Time] The time at which the article was last updated
+  attribute :updated_at, type: :time # ro:yes required:no
+  # @return [String] The API url of the article
+  attribute :url, type: :string # ro:yes required:no
+  # @return [Integer] The number of votes cast on this article
+  attribute :vote_count, type: :integer # ro:yes required:no
+  # @return [Integer] The total sum of votes on this article
+  attribute :vote_sum, type: :integer # ro:yes required:no
+
+  assoc_accessor :section, collection: :help_center_sections
+
+  def save!
+    requires :title, :locale, :section_id
+
+    data = if new_record?
+             connection.create_help_center_article(params).body["article"]
+           else
+             connection.update_help_center_article(dirty_attributes.merge("id" => self.identity)).body["article"]
+           end
+
+    merge_attributes(data)
+  end
+
+  def destroy!
+    requires :id
+
+    connection.destroy_help_center_article(id)
+  end
+
+  private
+
+  def params
+    Cistern::Hash.slice(self.attributes, :author_id, :body, :comments_disabled, :draft, :label_names, :locale, :position, :promoted, :section_id, :title)
+  end
+end

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

@@ -0,0 +1,53 @@
+class Zendesk2::Client::HelpCenter::Category < Zendesk2::Model
+  extend Zendesk2::Attributes
+
+  # @return [Integer] Automatically assigned when creating categories
+  identity :id, type: :integer # ro:yes required:no
+
+  # @return [Time] The time at which the category was created
+  attribute :created_at, type: :time # ro:yes required:no
+  # @return [String] The description of the category
+  attribute :description, type: :string # ro:no required:no
+  # @return [String] The url of this category in Help Center
+  attribute :html_url, type: :string # ro:yes required:no
+  # @return [String] The locale that the category is displayed in
+  attribute :locale, type: :string # ro:no required:yes
+  # @return [String] The name of the category
+  attribute :name, type: :string # ro:no required:yes
+  # @return [Boolean] Whether the category is out of date
+  attribute :outdated, type: :boolean # ro:yes required:no
+  # @return [Integer] The position of this category relative to other categories
+  attribute :position, type: :integer # ro:no required:no
+  # @return [String] The source (default) locale of the category
+  attribute :source_locale, type: :string # ro:yes required:no
+  # @return [Array] The ids of all translations of this category
+  attribute :translation_ids, type: :array # ro:yes required:no
+  # @return [Time] The time at which the category was last updated
+  attribute :updated_at, type: :time # ro:yes required:no
+  # @return [String] The API url of this category
+  attribute :url, type: :string # ro:yes required:no
+
+  def save!
+    requires :name, :locale
+
+    data = if new_record?
+             connection.create_help_center_category(params).body["category"]
+           else
+             connection.update_help_center_category(dirty_attributes.merge("id" => self.identity)).body["category"]
+           end
+
+    merge_attributes(data)
+  end
+
+  def destroy!
+    requires :id
+
+    connection.destroy_help_center_category(id)
+  end
+
+  private
+
+  def params
+    Cistern::Hash.slice(self.attributes, :category_id, :description, :locale, :name, :position, :sorting)
+  end
+end

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

@@ -0,0 +1,60 @@
+class Zendesk2::Client::HelpCenter::Section < Zendesk2::Model
+  extend Zendesk2::Attributes
+
+  # @return [Integer] Automatically assigned when creating subscriptions
+  identity :id, type: :integer
+
+  # @return [Integer] The id of the category to which this section belongs
+  attribute :category_id, type: :integer # ro:no required:no
+  # @return [Time] The time at which the section was created
+  attribute :created_at, type: :datetime # ro:yes required:no
+  # @return [String] The description of the section
+  attribute :description, type: :string # ro:no required:no
+  # @return [String] The url of this section in HC
+  attribute :html_url, type: :string # ro:yes required:no
+  # @return [String] The locale in which the section is displayed
+  attribute :locale, type: :string # ro:no required:yes
+  # @return [String] The name of the section
+  attribute :name, type: :string # ro:no required:yes
+  # @return [Boolean] Whether the section is out of date
+  attribute :outdated, type: :boolean # ro:yes required:no
+  # @return [Integer] The position of this section in the section list. By default the section is added to the end of the list
+  attribute :position, type: :integer # ro:no required:no
+  # @return [String] The sorting of articles within this section. By default it's set to manual. See sorting below.
+  attribute :sorting, type: :string # ro:no required:no
+  # @return [String] The source (default) locale of the section
+  attribute :source_locale, type: :string # ro:yes required:no
+  # @return [Array] The ids of all translations of this section
+  attribute :translation_ids, type: :array # ro:yes required:no
+  # @return [Time] The time at which the section was last updated
+  attribute :updated_at, type: :datetime # ro:yes required:no
+  # @return [string] The API url of this section
+  attribute :url, type: :string # ro:yes required:no
+
+  # @return [Zendesk2::Client::HelpCenter::Category] category containing this section
+  assoc_accessor :category, collection: :help_center_categories
+
+  def save!
+    requires :name, :locale, :category_id
+
+    data = if new_record?
+             connection.create_help_center_section(params).body["section"]
+           else
+             connection.update_help_center_section(dirty_attributes.merge("id" => self.identity)).body["section"]
+           end
+
+    merge_attributes(data)
+  end
+
+  def destroy!
+    requires :id
+
+    connection.destroy_help_center_section(id)
+  end
+
+  private
+
+  def params
+    Cistern::Hash.slice(self.attributes, :category_id, :description, :locale, :name, :position, :sorting)
+  end
+end

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

@@ -0,0 +1,61 @@
+class Zendesk2::Client
+  class Real
+    def create_help_center_article(params={})
+      section_id = require_parameters(params, "section_id")
+      path = if locale = params["locale"]
+              "/help_center/#{locale}/sections/#{section_id}/articles.json"
+            else
+              "/help_center/sections/#{section_id}/articles.json"
+            end
+
+
+      request(
+        :body   => {"article" => params},
+        :method => :post,
+        :path   => path,
+      )
+    end
+  end # Real
+
+  class Mock
+    def create_help_center_article(params={})
+      params = Cistern::Hash.stringify_keys(params)
+
+      identity = self.class.new_id
+
+      section_id = *require_parameters(params, "section_id")
+
+      locale = params["locale"] ||= "en-us"
+      position = self.data[:help_center_articles].values.select { |a| a["section_id"] == section_id }.size
+
+      record = {
+        "id"                => identity,
+        "url"               => url_for("/help_center/#{locale}/articles/#{identity}.json"),
+        "html_url"          => html_url_for("/hc/#{locale}/articles/#{identity}.json"),
+        "author_id"         => current_user["id"],
+        "comments_disabled" => false,
+        "label_names"       => [],
+        "draft"             => false,
+        "promoted"          => false,
+        "position"          => position,
+        "vote_sum"          => 0,
+        "vote_count"        => 0,
+        "section_id"        => section_id,
+        "created_at"        => Time.now.iso8601,
+        "updated_at"        => Time.now.iso8601,
+        "title"             => "",
+        "body"              => "",
+        "source_locale"     => locale,
+        "outdated"          => false,
+      }.merge(params)
+
+      self.data[:help_center_articles][identity] = record
+
+      response(
+        :method => :post,
+        :body   => {"article" => record},
+        :path   => "/sections/#{section_id}.json"
+      )
+    end
+  end # Mock
+end # Zendesk2::Client

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

@@ -0,0 +1,47 @@
+class Zendesk2::Client
+  class Real
+    def create_help_center_category(params={})
+      params = Cistern::Hash.stringify_keys(params)
+
+      require_parameters(params, "name")
+
+      request(
+        :body   => {"category" => params},
+        :method => :post,
+        :path   => "/help_center/categories.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def create_help_center_category(params={})
+      params = Cistern::Hash.stringify_keys(params)
+
+      require_parameters(params, "name")
+
+      identity = self.class.new_id
+
+      locale = params["locale"] ||= "en-us"
+      position = self.data[:help_center_categories].size
+
+      record = {
+        "id"          => identity,
+        "url"         => url_for("/help_center/#{locale}/categories/#{identity}.json"),
+        "html_url"    => html_url_for("/hc/#{locale}/categories/#{identity}.json"),
+        "author_id"   => current_user["id"],
+        "position"    => position,
+        "created_at"  => Time.now.iso8601,
+        "updated_at"  => Time.now.iso8601,
+        "description" => "",
+      }.merge(params)
+
+      self.data[:help_center_categories][identity] = record
+
+      response(
+        :method => :post,
+        :body   => {"category" => record},
+        :path   => "/categories.json"
+      )
+    end
+  end # Mock
+end # Zendesk2::Client

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

@@ -0,0 +1,55 @@
+class Zendesk2::Client
+  class Real
+    def create_help_center_section(params={})
+      category_id = require_parameters(params, "category_id")
+
+      request(
+        :body   => {"section" => params},
+        :method => :post,
+        :path   => "/help_center/categories/#{category_id}/sections.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def create_help_center_section(params={})
+      params = Cistern::Hash.stringify_keys(params)
+
+      identity = self.class.new_id
+
+      category_id = require_parameters(params, "category_id")
+
+      locale = params["locale"] ||= "en-us"
+      position = self.data[:help_center_sections].values.select { |a| a["category_id"] == category_id }.size
+
+      record = {
+        "id"                => identity,
+        "url"               => url_for("/help_center/#{locale}/sections/#{identity}.json"),
+        "html_url"          => html_url_for("/hc/#{locale}/sections/#{identity}.json"),
+        "author_id"         => current_user["id"],
+        "comments_disabled" => false,
+        "label_names"       => [],
+        "draft"             => false,
+        "promoted"          => false,
+        "position"          => position,
+        "vote_sum"          => 0,
+        "vote_count"        => 0,
+        "category_id"       => category_id,
+        "created_at"        => Time.now.iso8601,
+        "updated_at"        => Time.now.iso8601,
+        "name"              => "",
+        "body"              => "",
+        "source_locale"     => locale,
+        "outdated"          => false,
+      }.merge(params)
+
+      self.data[:help_center_sections][identity] = record
+
+      response(
+        :method => :post,
+        :body   => {"section" => record},
+        :path   => "/sections/#{category_id}.json"
+      )
+    end
+  end # Mock
+end # Zendesk2::Client

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

@@ -0,0 +1,22 @@
+class Zendesk2::Client
+  class Real
+    def destroy_help_center_article(id)
+      request(
+        :method => :delete,
+        :path   => "/help_center/articles/#{id}.json"
+      )
+    end
+  end
+
+  class Mock
+    def destroy_help_center_article(id)
+      response(
+        :method => :delete,
+        :path   => "/help_center/articles/#{id}.json",
+        :body   => {
+          "article" => self.find!(:help_center_articles, id),
+        },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+class Zendesk2::Client
+  class Real
+    def destroy_help_center_category(id)
+      request(
+        :method => :delete,
+        :path   => "/help_center/categories/#{id}.json"
+      )
+    end
+  end
+
+  class Mock
+    def destroy_help_center_category(id)
+      response(
+        :method => :delete,
+        :path   => "/help_center/categories/#{id}.json",
+        :body   => {
+          "category" => self.find!(:help_center_categories, id),
+        },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+class Zendesk2::Client
+  class Real
+    def destroy_help_center_section(id)
+      request(
+        :method => :delete,
+        :path   => "/help_center/sections/#{id}.json"
+      )
+    end
+  end
+
+  class Mock
+    def destroy_help_center_section(id)
+      response(
+        :method => :delete,
+        :path   => "/help_center/sections/#{id}.json",
+        :body   => {
+          "section" => self.find!(:help_center_sections, id),
+        },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+class Zendesk2::Client
+  class Real
+    def get_help_center_article(params={})
+      id     = require_parameters(params, "id")
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/articles/#{id}.json"
+             else
+               "/help_center/articles/#{id}.json"
+             end
+
+
+      request(
+        :method => :get,
+        :path   => path,
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_help_center_article(params={})
+      id = require_parameters(params, "id")
+
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/articles/#{id}.json"
+             else
+               "/help_center/articles/#{id}.json"
+             end
+
+      response(
+        :path => path,
+        :body => {
+          "article" => self.find!(:help_center_articles, id.to_i)
+        },
+      )
+    end
+  end # Mock
+end

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

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

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

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

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

@@ -0,0 +1,41 @@
+class Zendesk2::Client
+  class Real
+    def get_help_center_category(params={})
+      id     = require_parameters(params, "id")
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/categories/#{id}.json"
+             else
+               "/help_center/categories/#{id}.json"
+             end
+
+
+      request(
+        :method => :get,
+        :path   => path,
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_help_center_category(params={})
+      id = require_parameters(params, "id")
+
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/categories/#{id}.json"
+             else
+               "/help_center/categories/#{id}.json"
+             end
+
+      response(
+        :path => path,
+        :body => {
+          "category" => self.find!(:help_center_categories, id.to_i)
+        },
+      )
+    end
+  end # Mock
+end

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

@@ -0,0 +1,41 @@
+class Zendesk2::Client
+  class Real
+    def get_help_center_section(params={})
+      id     = require_parameters(params, "id")
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/sections/#{id}.json"
+             else
+               "/help_center/sections/#{id}.json"
+             end
+
+
+      request(
+        :method => :get,
+        :path   => path,
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_help_center_section(params={})
+      id = require_parameters(params, "id")
+
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/sections/#{id}.json"
+             else
+               "/help_center/sections/#{id}.json"
+             end
+
+      response(
+        :path => path,
+        :body => {
+          "section" => self.find!(:help_center_sections, id.to_i)
+        },
+      )
+    end
+  end # Mock
+end

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

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

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

@@ -0,0 +1,26 @@
+class Zendesk2::Client
+  class Real
+    def search_help_center_articles(query)
+      request(
+        :method => :get,
+        :params => {query: query},
+        :path   => "/help_center/articles/search.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def search_help_center_articles(query)
+      terms = Hash[query.split(" ").map { |t| t.split(":") }]
+
+      collection = self.data[:help_center_articles].values
+
+      results = collection.select { |v| terms.all?{ |term, condition| v[term.to_s].to_s == condition.to_s } }
+
+      response(
+        :path => "/search.json",
+        :body => {"results" => results},
+      )
+    end
+  end # Mock
+end

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

@@ -0,0 +1,48 @@
+class Zendesk2::Client
+  class Real
+    def update_help_center_article(params={})
+      id     = require_parameters(params, "id")
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/articles/#{id}.json"
+             else
+               "/help_center/articles/#{id}.json"
+             end
+
+      request(
+        :method => :put,
+        :path   => path,
+        :body   => {
+          "article" => params
+        },
+      )
+    end
+  end
+  class Mock
+    def update_help_center_article(params={})
+      params = Cistern::Hash.stringify_keys(params)
+
+      require_parameters(params, "id")
+
+      id     = params.delete("id")
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/articles/#{id}.json"
+             else
+               "/help_center/articles/#{id}.json"
+             end
+
+      body = self.data[:help_center_articles][id.to_i].merge!(params)
+
+      response(
+        :method => :put,
+        :path   => path,
+        :body   => {
+          "article" => body,
+        },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+class Zendesk2::Client
+  class Real
+    def update_help_center_category(params={})
+      id     = require_parameters(params, "id")
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/categories/#{id}.json"
+             else
+               "/help_center/categories/#{id}.json"
+             end
+
+      request(
+        :method => :put,
+        :path   => path,
+        :body   => {
+          "category" => params
+        },
+      )
+    end
+  end
+  class Mock
+    def update_help_center_category(params={})
+      params = Cistern::Hash.stringify_keys(params)
+
+      require_parameters(params, "id")
+
+      id     = params.delete("id")
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/categories/#{id}.json"
+             else
+               "/help_center/categories/#{id}.json"
+             end
+
+      body = self.data[:help_center_categories][id.to_i].merge!(params)
+
+      response(
+        :method => :put,
+        :path   => path,
+        :body   => {
+          "category" => body,
+        },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+class Zendesk2::Client
+  class Real
+    def update_help_center_section(params={})
+      id     = require_parameters(params, "id")
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/sections/#{id}.json"
+             else
+               "/help_center/sections/#{id}.json"
+             end
+
+      request(
+        :method => :put,
+        :path   => path,
+        :body   => {
+          "section" => params
+        },
+      )
+    end
+  end
+  class Mock
+    def update_help_center_section(params={})
+      params = Cistern::Hash.stringify_keys(params)
+
+      require_parameters(params, "id")
+
+      id     = params.delete("id")
+      locale = params["locale"]
+
+      path = if locale
+               "/help_center/#{locale}/sections/#{id}.json"
+             else
+               "/help_center/sections/#{id}.json"
+             end
+
+      body = self.data[:help_center_sections][id.to_i].merge!(params)
+
+      response(
+        :method => :put,
+        :path   => path,
+        :body   => {
+          "section" => body,
+        },
+      )
+    end
+  end
+end

data/lib/zendesk2/client.rb

@@ -5,23 +5,28 @@ class Zendesk2::Client < Cistern::Service
   model_path      "zendesk2/client/models"
   request_path    "zendesk2/client/requests"
 
-  # might be nice if cistern took care of this
+  # @fixme might be nice if cistern took care of this
   [
     [:collection, collection_path],
     [:model,      model_path],
     [:request,    request_path],
   ].each do |type, path|
-    Dir[File.expand_path(File.join("../..", path, "*.rb"), __FILE__)].sort.each do |file|
-      send(type, File.basename(file, ".rb"))
+    Dir[File.expand_path(File.join("../..", path, "**/*.rb"), __FILE__)].sort.each do |file|
+      send(type, file.gsub(/.*#{path}\/(.*)\.rb/, "\\1"), require: file)
     end
   end
 
   recognizes :url, :logger, :adapter, :username, :password, :token, :jwt_token
 
   module Shared
-    def require_parameters(params, *requirements)
+    def require_parameters(_params, *requirements)
+      params = Cistern::Hash.stringify_keys(_params)
+
       if (missing = requirements - params.keys).any?
         raise ArgumentError, "missing parameters: #{missing.join(", ")}"
+      else
+        values = params.values_at(*requirements)
+        requirements.size == 1 ? values.first : values
       end
     end
   end
@@ -29,3 +34,4 @@ end
 
 require 'zendesk2/client/real'
 require 'zendesk2/client/mock'
+require 'zendesk2/client/help_center'

data/lib/zendesk2/model.rb

@@ -5,7 +5,7 @@ class Zendesk2::Model < Cistern::Model
   # @abstract override in subclass
   # @raise [Zendesk2::Error] if unsuccessful
   def save!
-    raise NotImplementError
+    raise NotImplementedError
   end
 
   # calls {#save!} and sets {#errors} if unsuccessful and applicable

data/lib/zendesk2/searchable.rb

@@ -16,11 +16,12 @@ module Zendesk2::Searchable
   # @see http://developer.zendesk.com/documentation/rest_api/search.html
   def search(terms)
     query = if terms.is_a?(Hash)
-              terms.merge("type" => self.class.search_type).
-                merge(self.class.scopes.inject({}){|r,k| r.merge(k.to_s => public_send(k))}).
+              terms.merge!("type" => self.class.search_type) if self.class.search_type
+              terms.merge(self.class.scopes.inject({}){|r,k| r.merge(k.to_s => public_send(k))}).
                 map { |k,v| "#{k}:#{v}" }.join(" ")
             else
-              additional_terms = ["type:#{self.class.search_type}"]
+              additional_terms = []
+              additional_terms = ["type:#{self.class.search_type}"] if self.class.search_type
               additional_terms += self.class.scopes.inject([]) { |r,k| ["#{k}:#{public_send(k)}"] }
 
               additional_terms.inject(terms.to_s) do |qualified_search, qualification|

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end

data/spec/help_center/articles_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe "help_center/articles" do
+  let(:client)   { create_client }
+  let!(:section) do
+    category = client.help_center_categories.create!(name: Zendesk2.uuid,
+                                                     locale: "en-us",
+                                                    )
+    client.help_center_sections.create!(:name     => Zendesk2.uuid,
+                                        :locale   => "en-us",
+                                        :category => category,
+                                       )
+  end
+
+  include_examples "zendesk resource", {
+    :collection    => lambda { client.help_center_articles },
+    :create_params => lambda { { title: Zendesk2.uuid, locale: "en-us", section: section } },
+    :update_params => lambda { { title: Zendesk2.uuid } },
+    :search_params => lambda { Cistern::Hash.slice(create_params, :title) },
+    :search        => true,
+  }
+end

data/spec/help_center/categories_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "help_center/categories" do
+  let(:client)   { create_client }
+
+  include_examples "zendesk resource", {
+    :collection    => lambda { client.help_center_categories },
+    :create_params => lambda { { name: Zendesk2.uuid, locale: "en-us" } },
+    :update_params => lambda { { name: Zendesk2.uuid } },
+    :search        => false,
+  }
+end

data/spec/help_center/sections_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe "help_center/sections" do
+  let(:client)   { create_client }
+  let!(:category) do
+    client.help_center_categories.create!(name: Zendesk2.uuid,
+                                          locale: "en-us",
+                                         )
+  end
+
+  include_examples "zendesk resource", {
+    :collection    => lambda { client.help_center_sections },
+    :create_params => lambda { { name: Zendesk2.uuid, locale: "en-us", category: category } },
+    :update_params => lambda { { name: Zendesk2.uuid } },
+    :search        => false,
+  }
+end

data/spec/shared/zendesk_resource.rb

@@ -56,7 +56,7 @@ shared_examples "zendesk resource" do |options={}|
     if options.fetch(:update, true)
       it "should be updated" do
         @record = collection.create!(create_params)
-        record.merge_attributes(update_params)
+        update_params.each { |k,v| record.send("#{k}=", v) }
         record.save
         update_params.each {|k,v| expect(record.send(k)).to eq(v)}
       end

data/zendesk2.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.version       = Zendesk2::VERSION
 
   gem.add_dependency "addressable", "~> 2.2"
-  gem.add_dependency "cistern", "~> 0.9", ">= 0.9.2"
+  gem.add_dependency "cistern", "~> 0.11"
   gem.add_dependency "faraday", "~> 0.9"
   gem.add_dependency "faraday_middleware", "~> 0.9"
   gem.add_dependency "jwt", "~> 1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2014-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,20 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +101,9 @@ files:
 - lib/zendesk2/client/collections/categories.rb
 - lib/zendesk2/client/collections/forums.rb
 - lib/zendesk2/client/collections/groups.rb
+- lib/zendesk2/client/collections/help_center/articles.rb
+- lib/zendesk2/client/collections/help_center/categories.rb
+- lib/zendesk2/client/collections/help_center/sections.rb
 - lib/zendesk2/client/collections/memberships.rb
 - lib/zendesk2/client/collections/organizations.rb
 - lib/zendesk2/client/collections/ticket_audits.rb
@@ -119,11 +116,15 @@ files:
 - lib/zendesk2/client/collections/user_fields.rb
 - lib/zendesk2/client/collections/user_identities.rb
 - lib/zendesk2/client/collections/users.rb
+- lib/zendesk2/client/help_center.rb
 - lib/zendesk2/client/mock.rb
 - lib/zendesk2/client/models/audit_event.rb
 - lib/zendesk2/client/models/category.rb
 - lib/zendesk2/client/models/forum.rb
 - lib/zendesk2/client/models/group.rb
+- lib/zendesk2/client/models/help_center/article.rb
+- lib/zendesk2/client/models/help_center/category.rb
+- lib/zendesk2/client/models/help_center/section.rb
 - lib/zendesk2/client/models/membership.rb
 - lib/zendesk2/client/models/organization.rb
 - lib/zendesk2/client/models/ticket.rb
@@ -145,6 +146,9 @@ files:
 - lib/zendesk2/client/requests/create_category.rb
 - lib/zendesk2/client/requests/create_forum.rb
 - lib/zendesk2/client/requests/create_group.rb
+- lib/zendesk2/client/requests/create_help_center_article.rb
+- lib/zendesk2/client/requests/create_help_center_category.rb
+- lib/zendesk2/client/requests/create_help_center_section.rb
 - lib/zendesk2/client/requests/create_membership.rb
 - lib/zendesk2/client/requests/create_organization.rb
 - lib/zendesk2/client/requests/create_ticket.rb
@@ -157,6 +161,9 @@ files:
 - lib/zendesk2/client/requests/destroy_category.rb
 - lib/zendesk2/client/requests/destroy_forum.rb
 - lib/zendesk2/client/requests/destroy_group.rb
+- lib/zendesk2/client/requests/destroy_help_center_article.rb
+- lib/zendesk2/client/requests/destroy_help_center_category.rb
+- lib/zendesk2/client/requests/destroy_help_center_section.rb
 - lib/zendesk2/client/requests/destroy_membership.rb
 - lib/zendesk2/client/requests/destroy_organization.rb
 - lib/zendesk2/client/requests/destroy_ticket.rb
@@ -176,6 +183,12 @@ files:
 - lib/zendesk2/client/requests/get_forums.rb
 - lib/zendesk2/client/requests/get_group.rb
 - lib/zendesk2/client/requests/get_groups.rb
+- 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_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_membership.rb
 - lib/zendesk2/client/requests/get_organization.rb
 - lib/zendesk2/client/requests/get_organization_by_external_id.rb
@@ -207,10 +220,14 @@ files:
 - lib/zendesk2/client/requests/mark_membership_default.rb
 - lib/zendesk2/client/requests/mark_user_identity_primary.rb
 - lib/zendesk2/client/requests/search.rb
+- lib/zendesk2/client/requests/search_help_center_articles.rb
 - lib/zendesk2/client/requests/search_user.rb
 - lib/zendesk2/client/requests/update_category.rb
 - lib/zendesk2/client/requests/update_forum.rb
 - lib/zendesk2/client/requests/update_group.rb
+- lib/zendesk2/client/requests/update_help_center_article.rb
+- lib/zendesk2/client/requests/update_help_center_category.rb
+- lib/zendesk2/client/requests/update_help_center_section.rb
 - lib/zendesk2/client/requests/update_organization.rb
 - lib/zendesk2/client/requests/update_request.rb
 - lib/zendesk2/client/requests/update_ticket.rb
@@ -230,6 +247,9 @@ files:
 - spec/categories_spec.rb
 - spec/forums_spec.rb
 - spec/groups_spec.rb
+- spec/help_center/articles_spec.rb
+- spec/help_center/categories_spec.rb
+- spec/help_center/sections_spec.rb
 - spec/memberships_spec.rb
 - spec/organizations_spec.rb
 - spec/shared/zendesk_resource.rb
@@ -271,6 +291,9 @@ test_files:
 - spec/categories_spec.rb
 - spec/forums_spec.rb
 - spec/groups_spec.rb
+- spec/help_center/articles_spec.rb
+- spec/help_center/categories_spec.rb
+- spec/help_center/sections_spec.rb
 - spec/memberships_spec.rb
 - spec/organizations_spec.rb
 - spec/shared/zendesk_resource.rb