zendesk2 1.9.0 → 1.10.0

data/lib/zendesk2/help_center/article.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::HelpCenter::Article
   include Zendesk2::Model
 
@@ -6,7 +7,8 @@ class Zendesk2::HelpCenter::Article
   # @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)
+  # @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
@@ -18,7 +20,8 @@ class Zendesk2::HelpCenter::Article
   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)
+  # @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
@@ -48,26 +51,26 @@ class Zendesk2::HelpCenter::Article
   def translations
     requires :identity
 
-    cistern.help_center_translations(source_id: self.identity, source_type: "Article")
+    cistern.help_center_translations(source_id: identity, source_type: 'Article')
   end
 
   def save!
     response = if new_record?
                  requires :title, :locale, :section_id
 
-                 cistern.create_help_center_article("article" => self.attributes)
+                 cistern.create_help_center_article('article' => attributes)
                else
                  requires :identity
 
-                 cistern.update_help_center_article("article" => self.attributes)
+                 cistern.update_help_center_article('article' => attributes)
                end
 
-    merge_attributes(response.body["article"])
+    merge_attributes(response.body['article'])
   end
 
   def destroy!
     requires :identity
 
-    cistern.destroy_help_center_article("article" => { "id" => self.identity })
+    cistern.destroy_help_center_article('article' => { 'id' => identity })
   end
 end

data/lib/zendesk2/help_center/articles.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::HelpCenter::Articles
   include Zendesk2::Collection
 
@@ -7,9 +8,9 @@ class Zendesk2::HelpCenter::Articles
   model Zendesk2::HelpCenter::Article
 
   self.collection_method = :get_help_center_articles
-  self.collection_root   = "articles"
+  self.collection_root   = 'articles'
   self.model_method      = :get_help_center_article
-  self.model_root        = "article"
+  self.model_root        = 'article'
   self.search_type       = nil
   self.search_request    = :search_help_center_articles
 
@@ -19,7 +20,7 @@ class Zendesk2::HelpCenter::Articles
   scopes << :section_id
   scopes << :category_id
 
-  def collection_page(params={})
+  def collection_page(params = {})
     collection_method = if category_id
                           :get_help_center_categories_articles
                         elsif section_id
@@ -28,11 +29,10 @@ class Zendesk2::HelpCenter::Articles
                           :get_help_center_articles
                         end
 
-    body = cistern.send(collection_method, Cistern::Hash.stringify_keys(self.attributes.merge(params))).body
+    body = cistern.send(collection_method, Cistern::Hash.stringify_keys(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"))
+    load(body[collection_root]) # 'results' is the key for paged searches
+    merge_attributes(Cistern::Hash.slice(body, 'count', 'next_page', 'previous_page'))
     self
   end
-
 end

data/lib/zendesk2/help_center/categories.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::HelpCenter::Categories
   include Zendesk2::Collection
 
@@ -7,7 +8,7 @@ class Zendesk2::HelpCenter::Categories
   model Zendesk2::HelpCenter::Category
 
   self.collection_method = :get_help_center_categories
-  self.collection_root   = "categories"
+  self.collection_root   = 'categories'
   self.model_method      = :get_help_center_category
-  self.model_root        = "category"
+  self.model_root        = 'category'
 end

data/lib/zendesk2/help_center/category.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::HelpCenter::Category
   include Zendesk2::Model
 
@@ -32,38 +33,38 @@ class Zendesk2::HelpCenter::Category
   def articles
     requires :identity
 
-    cistern.help_center_articles(category_id: self.identity)
+    cistern.help_center_articles(category_id: identity)
   end
 
   def destroy!
     requires :identity
 
-    cistern.destroy_help_center_category("category" => { "id" => self.identity })
+    cistern.destroy_help_center_category('category' => { 'id' => identity })
   end
 
   def sections
     requires :identity
 
-    cistern.help_center_sections(category_id: self.identity)
+    cistern.help_center_sections(category_id: identity)
   end
 
   def translations
     requires :identity
 
-    cistern.help_center_translations(source_id: self.identity, source_type: "Category")
+    cistern.help_center_translations(source_id: identity, source_type: 'Category')
   end
 
   def save!
     response = if new_record?
                  requires :name, :locale
 
-                 cistern.create_help_center_category("category" => self.attributes)
+                 cistern.create_help_center_category('category' => attributes)
                else
                  requires :identity
 
-                 cistern.update_help_center_category("category" => self.attributes)
+                 cistern.update_help_center_category('category' => attributes)
                end
 
-    merge_attributes(response.body["category"])
+    merge_attributes(response.body['category'])
   end
 end

data/lib/zendesk2/help_center/create_help_center_article.rb

@@ -1,57 +1,59 @@
+# frozen_string_literal: true
 class Zendesk2::CreateHelpCenterArticle
   include Zendesk2::Request
 
   request_method :post
-  request_body { |r| { "article" => r.article_params } }
-  request_path { |r|
-    if locale = r.article_params["locale"]
+  request_body { |r| { 'article' => r.article_params } }
+  request_path do |r|
+    locale = r.article_params['locale']
+    if locale
       "/help_center/#{locale}/sections/#{r.section_id}/articles.json"
     else
       "/help_center/sections/#{r.section_id}/articles.json"
     end
-  }
+  end
 
   def self.accepted_attributes
-    %w[author_id body comments_disabled draft label_names locale position promoted section_id title]
+    %w(author_id body comments_disabled draft label_names locale position promoted section_id title)
   end
 
   def article_params
-    @_article_params ||= Cistern::Hash.slice(params.fetch("article"), *self.class.accepted_attributes)
+    @_article_params ||= Cistern::Hash.slice(params.fetch('article'), *self.class.accepted_attributes)
   end
 
   def section_id
-    params.fetch("article").fetch("section_id")
+    params.fetch('article').fetch('section_id')
   end
 
   def mock
     identity = cistern.serial_id
 
-    locale = params["locale"] ||= "en-us"
-    position = self.data[:help_center_articles].values.select { |a| a["section_id"] == section_id }.size
+    locale = params['locale'] ||= 'en-us'
+    position = 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"         => cistern.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,
+      'id'                => identity,
+      'url'               => url_for("/help_center/#{locale}/articles/#{identity}.json"),
+      'html_url'          => html_url_for("/hc/#{locale}/articles/#{identity}.json"),
+      'author_id'         => cistern.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(article_params)
 
-    self.data[:help_center_articles][identity] = record
+    data[:help_center_articles][identity] = record
 
-    mock_response("article" => record)
+    mock_response('article' => record)
   end
 end

data/lib/zendesk2/help_center/create_help_center_category.rb

@@ -1,37 +1,38 @@
+# frozen_string_literal: true
 class Zendesk2::CreateHelpCenterCategory
   include Zendesk2::Request
 
   request_method :post
-  request_path { |_| "/help_center/categories.json" }
-  request_body { |r| {"category" => r.category_params} }
+  request_path { |_| '/help_center/categories.json' }
+  request_body { |r| { 'category' => r.category_params } }
 
   def self.accepted_attributes
-    %w[category_id description locale name position sorting]
+    %w(category_id description locale name position sorting)
   end
 
   def category_params
-    Cistern::Hash.slice(params.fetch("category"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('category'), *self.class.accepted_attributes)
   end
 
   def mock
     identity = cistern.serial_id
 
-    locale = params["locale"] ||= "en-us"
-    position = self.data[:help_center_categories].size
+    locale = params['locale'] ||= 'en-us'
+    position = 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"   => cistern.current_user["id"],
-      "position"    => position,
-      "created_at"  => Time.now.iso8601,
-      "updated_at"  => Time.now.iso8601,
-      "description" => "",
+      'id'          => identity,
+      'url'         => url_for("/help_center/#{locale}/categories/#{identity}.json"),
+      'html_url'    => html_url_for("/hc/#{locale}/categories/#{identity}.json"),
+      'author_id'   => cistern.current_user['id'],
+      'position'    => position,
+      'created_at'  => Time.now.iso8601,
+      'updated_at'  => Time.now.iso8601,
+      'description' => '',
     }.merge(category_params)
 
-    self.data[:help_center_categories][identity] = record
+    data[:help_center_categories][identity] = record
 
-    mock_response("category" => record)
+    mock_response('category' => record)
   end
 end

data/lib/zendesk2/help_center/create_help_center_post.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+class Zendesk2::CreateHelpCenterPost
+  include Zendesk2::Request
+
+  request_method :post
+  request_path { |_| '/community/posts.json' }
+  request_body { |r| { 'post' => r.post_params } }
+
+  def self.accepted_attributes
+    %w(title details author_id topic_id pinned featured closed status created_at)
+  end
+
+  def post_params
+    Cistern::Hash.slice(params.fetch('post'), *self.class.accepted_attributes)
+  end
+
+  def mock
+    identity = cistern.serial_id
+
+    record = {
+      'id'             => identity,
+      'url'            => url_for("/community/posts/#{identity}.json"),
+      'html_url'       => html_url_for("/hc/posts/#{identity}.json"),
+      'created_at'     => Time.now.iso8601,
+      'updated_at'     => Time.now.iso8601,
+      'vote_count'     => 0,
+      'vote_sum'       => 0,
+      'comment_count'  => 0,
+      'follower_count' => 0,
+      'details'        => '',
+    }.merge(post_params)
+
+    data[:help_center_posts][identity] = record
+
+    mock_response('post' => record)
+  end
+end

data/lib/zendesk2/help_center/create_help_center_section.rb

@@ -1,61 +1,62 @@
+# frozen_string_literal: true
 class Zendesk2::CreateHelpCenterSection
   include Zendesk2::Request
 
   request_method :post
   request_path { |r| "/help_center/categories/#{r.category_id}/sections.json" }
-  request_body { |r| { "section" => r.section_params } }
+  request_body { |r| { 'section' => r.section_params } }
 
   def self.accepted_attributes
-    %w[category_id description locale name position sorting]
+    %w(category_id description locale name position sorting)
   end
 
   def section_params
-    Cistern::Hash.slice(params.fetch("section"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('section'), *self.class.accepted_attributes)
   end
 
   def category_id
-    params.fetch("section").fetch("category_id")
+    params.fetch('section').fetch('category_id')
   end
 
   def mock
     identity = cistern.serial_id
 
-    locale = params["locale"] ||= "en-us"
-    position = self.data[:help_center_sections].values.select { |a| a["category_id"] == category_id }.size
+    locale = params['locale'] ||= 'en-us'
+    position = 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"         => cistern.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,
+      'id'                => identity,
+      'url'               => url_for("/help_center/#{locale}/sections/#{identity}.json"),
+      'html_url'          => html_url_for("/hc/#{locale}/sections/#{identity}.json"),
+      'author_id'         => cistern.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(section_params)
 
     cistern.data[:help_center_sections][identity] = record
 
     access_policy = {
-      "viewable_by"                     => "everyone",
-      "managable_by"                    => "staff",
-      "restricted_to_group_ids"         => [],
-      "restricted_to_organization_ids"  => [],
-      "required_tags"                   => [],
-      "section_id"                      => identity
+      'viewable_by'                     => 'everyone',
+      'managable_by'                    => 'staff',
+      'restricted_to_group_ids'         => [],
+      'restricted_to_organization_ids'  => [],
+      'required_tags'                   => [],
+      'section_id'                      => identity,
     }
     cistern.data[:help_center_access_policies][identity] = access_policy
 
-    mock_response("section" => record)
+    mock_response('section' => record)
   end
 end

data/lib/zendesk2/help_center/create_help_center_topic.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+class Zendesk2::CreateHelpCenterTopic
+  include Zendesk2::Request
+
+  request_method :post
+  request_path { |_| '/community/topics.json' }
+  request_body { |r| { 'topic' => r.topic_params } }
+
+  def self.accepted_attributes
+    %w(name position description)
+  end
+
+  def topic_params
+    Cistern::Hash.slice(params.fetch('topic'), *self.class.accepted_attributes)
+  end
+
+  def mock
+    identity = cistern.serial_id
+
+    position = data[:help_center_topics].size
+
+    record = {
+      'id'          => identity,
+      'url'         => url_for("/communit/topics/#{identity}.json"),
+      'html_url'    => html_url_for("/hc/topics/#{identity}.json"),
+      'position'    => position,
+      'created_at'  => Time.now.iso8601,
+      'updated_at'  => Time.now.iso8601,
+      'description' => '',
+    }.merge(topic_params)
+
+    data[:help_center_topics][identity] = record
+
+    mock_response('topic' => record)
+  end
+end