zendesk2 1.9.0 → 1.10.0

data/lib/zendesk2/help_center/get_help_center_topic.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+class Zendesk2::GetHelpCenterTopic
+  include Zendesk2::Request
+
+  request_path { |r| "/community/topics/#{r.topic_id}.json" }
+
+  def topic_id
+    params.fetch('topic').fetch('id')
+  end
+
+  def mock
+    mock_response('topic' => find!(:help_center_topics, topic_id))
+  end
+end

data/lib/zendesk2/help_center/get_help_center_topics.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+class Zendesk2::GetHelpCenterTopics
+  include Zendesk2::Request
+
+  request_path { |_r| '/community/topics.json' }
+
+  def mock
+    resources(:help_center_topics, root: 'topics')
+  end
+end

data/lib/zendesk2/help_center/get_help_center_translation.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
 class Zendesk2::GetHelpCenterTranslation
   include Zendesk2::Request
   include Zendesk2::HelpCenter::TranslationSource::Request
 
   request_method :get
-  request_path { |r|
+  request_path do |r|
     "/help_center/#{r.source_type_url}/#{r.source_id}/translations/#{r.locale}.json"
-  }
+  end
 
-  def mock(params={})
-    mock_response("translation" => self.find!(:help_center_translations, mock_translation_key))
+  def mock(_params = {})
+    mock_response('translation' => find!(:help_center_translations, mock_translation_key))
   end
 end

data/lib/zendesk2/help_center/get_help_center_translations.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 class Zendesk2::GetHelpCenterTranslations
   include Zendesk2::Request
   include Zendesk2::HelpCenter::TranslationSource::Request
 
   request_path { |r| "/help_center/#{r.source_type_url}/#{r.source_id}/translations.json" }
-  request_params { |r| r.translation_params }
+  request_params(&:translation_params)
 
   page_params!
 
@@ -11,15 +12,15 @@ class Zendesk2::GetHelpCenterTranslations
     new_params = Cistern::Hash.slice(params, :outdated, :draft)
 
     # Extract locales and dedup "locale"
-    locales = params["locales"] || []
-    locales << params["locale"] unless !params["locale"] || params["locale"].empty?
+    locales = params['locales'] || []
+    locales << params['locale'] unless !params['locale'] || params['locale'].empty?
     locales.uniq!
-    new_params["locales"] = locales.join(",") unless locales.empty?
+    new_params['locales'] = locales.join(',') unless locales.empty?
 
-    return new_params
+    new_params
   end
 
   def mock
-    page(:help_center_translations, root: "translations")
+    page(:help_center_translations, root: 'translations')
   end
 end

data/lib/zendesk2/help_center/post.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+class Zendesk2::HelpCenter::Post
+  include Zendesk2::Model
+
+  extend Zendesk2::Attributes
+
+  # Automatically assigned when the post is created
+  identity :id, type: :integer
+
+  # API url of the post
+  attribute :url
+  # The community url of the post
+  attribute :html_url
+  # The title of the post
+  attribute :title
+  # The details of the post
+  attribute :details
+  # The id of the author of the post. *Writable on create by Help Center managers -- see Create Post
+  attribute :author_id, type: :integer
+  # When true, pins the post to the top of its topic
+  attribute :pinned, type: :boolean
+  # Whether the post is featured
+  attribute :featured, type: :boolean
+  # Whether further comments are allowed
+  attribute :closed, type: :boolean
+  # Possible values: "planned", "not_planned" , "answered", or "completed"
+  attribute :status
+  # The total sum of votes on the post
+  attribute :vote_sum, type: :integer
+  # The number of votes cast on the post
+  attribute :vote_count, type: :integer
+  # The number of comments on the post
+  attribute :comment_count, type: :integer
+  # The number of followers of the post
+  attribute :follower_count, type: :integer
+  # The id of the topic that the post belongs to
+  attribute :topic_id, type: :integer
+  # Post
+  attribute :created_at, type: :time
+  # When the post was last updated
+  attribute :updated_at, type: :time
+
+  def destroy!
+    requires :identity
+
+    cistern.destroy_help_center_post('post' => { 'id' => identity })
+  end
+
+  def save!
+    response = if new_record?
+                 requires :title, :details, :topic_id
+
+                 cistern.create_help_center_post('post' => attributes)
+               else
+                 requires :identity
+
+                 cistern.update_help_center_post('post' => attributes)
+               end
+
+    merge_attributes(response.body['post'])
+  end
+
+  def author
+    author_id && cistern.users.get!(author_id)
+  end
+
+  def topic
+    requires :topic_id
+
+    cistern.help_center_topics.get!(topic_id)
+  end
+end

data/lib/zendesk2/help_center/posts.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+class Zendesk2::HelpCenter::Posts
+  include Zendesk2::Collection
+  include Zendesk2::PagedCollection
+
+  model Zendesk2::HelpCenter::Post
+
+  self.collection_method = :get_help_center_posts
+  self.collection_root   = 'posts'
+  self.model_method      = :get_help_center_post
+  self.model_root        = 'post'
+
+  attribute :user_id, type: :integer
+  attribute :topic_id, type: :integer
+
+  scopes << :user_id
+  scopes << :topic_id
+end

data/lib/zendesk2/help_center/search_help_center_articles.rb

@@ -1,29 +1,30 @@
+# frozen_string_literal: true
 class Zendesk2::SearchHelpCenterArticles
   include Zendesk2::Request
 
-  request_path { |_| "/help_center/articles/search.json" }
+  request_path { |_| '/help_center/articles/search.json' }
 
   attr_reader :query
 
-  def _mock(query, params={})
+  def _mock(query, params = {})
     @query = query
     setup(params)
     mock
   end
 
-  def _real(query, params={})
+  def _real(query, params = {})
     @query = query
     setup(params)
     real
   end
 
   def mock
-    terms = Hash[query.split(" ").map { |t| t.split(":") }]
+    terms = Hash[query.split(' ').map { |t| t.split(':') }]
 
-    collection = self.data[:help_center_articles].values
+    collection = data[:help_center_articles].values
 
-    results = collection.select { |v| terms.all?{ |term, condition| v[term.to_s].to_s == condition.to_s } }
+    results = collection.select { |v| terms.all? { |term, condition| v[term.to_s].to_s == condition.to_s } }
 
-    page(results, params: {"query" => query}, root: "results")
+    page(results, params: { 'query' => query }, root: 'results')
   end
 end

data/lib/zendesk2/help_center/section.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::HelpCenter::Section
   include Zendesk2::Model
 
@@ -20,7 +21,8 @@ class Zendesk2::HelpCenter::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
+  # @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
@@ -39,36 +41,34 @@ class Zendesk2::HelpCenter::Section
   def destroy!
     requires :identity
 
-    cistern.destroy_help_center_section("section" => { "id" => self.identity })
+    cistern.destroy_help_center_section('section' => { 'id' => identity })
   end
 
   def save!
     response = if new_record?
                  requires :name, :locale, :category_id
 
-                 cistern.create_help_center_section("section" => self.attributes)
+                 cistern.create_help_center_section('section' => attributes)
                else
                  requires :identity
 
-                 cistern.update_help_center_section("section" => self.attributes)
+                 cistern.update_help_center_section('section' => attributes)
                end
 
-    merge_attributes(response.body["section"])
+    merge_attributes(response.body['section'])
   end
 
   def articles
     requires :identity
 
-    cistern.help_center_articles(section_id: self.identity)
+    cistern.help_center_articles(section_id: identity)
   end
 
   def access_policy
     requires :identity
 
-    response = cistern.get_help_center_access_policy(section_id: self.identity).body["access_policy"]
-    response.merge!({
-      "section_id" => self.identity
-    })
+    response = cistern.get_help_center_access_policy(section_id: identity).body['access_policy']
+    response['section_id'] = identity
 
     cistern.help_center_access_policy(response)
   end
@@ -76,6 +76,6 @@ class Zendesk2::HelpCenter::Section
   def translations
     requires :identity
 
-    cistern.help_center_translations(source_id: self.identity, source_type: "Section")
+    cistern.help_center_translations(source_id: identity, source_type: 'Section')
   end
 end

data/lib/zendesk2/help_center/sections.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::HelpCenter::Sections
   include Zendesk2::Collection
 
@@ -7,25 +8,25 @@ class Zendesk2::HelpCenter::Sections
   model Zendesk2::HelpCenter::Section
 
   self.collection_method = :get_help_center_sections
-  self.collection_root   = "sections"
+  self.collection_root   = 'sections'
   self.model_method      = :get_help_center_section
-  self.model_root        = "section"
+  self.model_root        = 'section'
 
   attribute :category_id, type: :integer
 
   scopes << :category_id
 
-  def collection_page(params={})
+  def collection_page(params = {})
     collection_method = if category_id
                           :get_help_center_categories_sections
                         else
                           :get_help_center_sections
                         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/topic.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+class Zendesk2::HelpCenter::Topic
+  include Zendesk2::Model
+
+  extend Zendesk2::Attributes
+
+  # Automatically assigned when the topic is created
+  identity :id, type: :integer
+
+  # API url of the topic
+  attribute :url
+  # The community url of the topic
+  attribute :html_url
+  # The name of the topic
+  attribute :name
+  # By default an empty string
+  attribute :description
+  # The position of the topic relative to other topics in the community
+  attribute :position, type: :integer
+  # The number of users following the topic
+  attribute :follower_count, type: :integer
+  # When the topic was created
+  attribute :created_at, type: :time
+  # When the topic was last updated
+  attribute :updated_at, type: :time
+
+  def destroy!
+    requires :identity
+
+    cistern.destroy_help_center_topic('topic' => { 'id' => identity })
+  end
+
+  def save!
+    response = if new_record?
+                 requires :name
+
+                 cistern.create_help_center_topic('topic' => attributes)
+               else
+                 requires :identity
+
+                 cistern.update_help_center_topic('topic' => attributes)
+               end
+
+    merge_attributes(response.body['topic'])
+  end
+
+  def posts
+    requires :identity
+
+    cistern.help_center_posts(topic_id: identity)
+  end
+end

data/lib/zendesk2/help_center/topics.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+class Zendesk2::HelpCenter::Topics
+  include Zendesk2::Collection
+
+  model Zendesk2::HelpCenter::Topic
+
+  attribute :count
+
+  self.collection_method = :get_help_center_topics
+  self.collection_root   = 'topics'
+  self.model_method      = :get_help_center_topic
+  self.model_root        = 'topic'
+end

data/lib/zendesk2/help_center/translation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::HelpCenter::Translation
   include Zendesk2::Model
   include Zendesk2::HelpCenter::TranslationSource::Model
@@ -11,7 +12,7 @@ class Zendesk2::HelpCenter::Translation
   attribute :url, type: :string # ro:yes required:no
   # @return [String] The url of the translation in Help Center
   attribute :html_url, type: :string # ro:yes required:no
-  # @return [Integer]	The id of the item that has this translation
+  # @return [Integer] The id of the item that has this translation
   attribute :source_id, type: :integer # ro:yes required:no
   # @return [String] The type of the item that has this translation. Can be Article, Section, or Category
   attribute :source_type, type: :string # ro:yes required:no
@@ -29,20 +30,22 @@ class Zendesk2::HelpCenter::Translation
   def destroy!
     requires :locale, :source_id, :source_type
 
-    cistern.destroy_help_center_translation("translation" => Cistern::Hash.slice(self.attributes, :source_id, :source_type, :locale))
+    cistern.destroy_help_center_translation(
+      'translation' => Cistern::Hash.slice(attributes, :source_id, :source_type, :locale)
+    )
   end
 
   def save!
     response = if new_record?
                  requires :locale, :source_id, :source_type
 
-                 cistern.create_help_center_translation("translation" => self.attributes)
+                 cistern.create_help_center_translation('translation' => attributes)
                else
                  requires :identity
 
-                 cistern.update_help_center_translation("translation" => self.attributes)
+                 cistern.update_help_center_translation('translation' => attributes)
                end
 
-    merge_attributes(response.body["translation"])
+    merge_attributes(response.body['translation'])
   end
 end

data/lib/zendesk2/help_center/translation_source.rb

@@ -1,45 +1,48 @@
+# frozen_string_literal: true
 module Zendesk2::HelpCenter::TranslationSource
+  # allow models to define their source type
   module Model
     def source=(source)
       if source.is_a?(Zendesk2::HelpCenter::Article)
-        self.source_type = "Article"
+        self.source_type = 'Article'
       elsif source.is_a?(Zendesk2::HelpCenter::Section)
-        self.source_type = "Section"
+        self.source_type = 'Section'
       elsif source.is_a?(Zendesk2::HelpCenter::Category)
-        self.source_type = "Category"
+        self.source_type = 'Category'
       end
       self.source_id = source.id
     end
   end
 
+  # allow requests to read common pieces of information about the translation source
   module Request
     def source_id
-      Integer((params["translation"] || params).fetch("source_id"))
+      Integer((params['translation'] || params).fetch('source_id'))
     end
 
     def source_type
-      (params["translation"] || params).fetch("source_type")
+      (params['translation'] || params).fetch('source_type')
     end
 
     def source_type_url
       case source_type
-      when "Article"
-        "articles"
-      when "Section"
-        "sections"
-      when "Category"
-        "categories"
+      when 'Article'
+        'articles'
+      when 'Section'
+        'sections'
+      when 'Category'
+        'categories'
       end
     end
 
     def locale
-      (params["translation"] || params).fetch("locale") || "en-us"
+      (params['translation'] || params).fetch('locale') || 'en-us'
     end
 
     # Since Zendesk2::Request#find! calls .to_i on hash keys, we need an integer
     # key for this.
     def mock_translation_key
-      [source_type, source_id, locale].join("-").each_byte.inject(0) {|char, acc| acc + char }
+      [source_type, source_id, locale].join('-').each_byte.reduce(0) { |a, e| a + e }
     end
   end
 end