zendesk2 1.8.1 → 1.9.0

data/lib/zendesk2/help_center.rb

@@ -1,11 +1,15 @@
 module Zendesk2::HelpCenter; end
 
+require 'zendesk2/help_center/translation_source'
+
 require 'zendesk2/help_center/create_help_center_article'
 require 'zendesk2/help_center/create_help_center_category'
 require 'zendesk2/help_center/create_help_center_section'
+require 'zendesk2/help_center/create_help_center_translation'
 require 'zendesk2/help_center/destroy_help_center_article'
 require 'zendesk2/help_center/destroy_help_center_category'
 require 'zendesk2/help_center/destroy_help_center_section'
+require 'zendesk2/help_center/destroy_help_center_translation'
 require 'zendesk2/help_center/get_help_center_access_policy'
 require 'zendesk2/help_center/get_help_center_article'
 require 'zendesk2/help_center/get_help_center_articles'
@@ -16,17 +20,22 @@ require 'zendesk2/help_center/get_help_center_category'
 require 'zendesk2/help_center/get_help_center_section'
 require 'zendesk2/help_center/get_help_center_sections'
 require 'zendesk2/help_center/get_help_center_sections_articles'
+require 'zendesk2/help_center/get_help_center_translation'
+require 'zendesk2/help_center/get_help_center_translations'
 require 'zendesk2/help_center/search_help_center_articles'
 require 'zendesk2/help_center/update_help_center_access_policy'
 require 'zendesk2/help_center/update_help_center_article'
 require 'zendesk2/help_center/update_help_center_category'
 require 'zendesk2/help_center/update_help_center_section'
+require 'zendesk2/help_center/update_help_center_translation'
 
 require 'zendesk2/help_center/access_policy'
 require 'zendesk2/help_center/article'
 require 'zendesk2/help_center/category'
 require 'zendesk2/help_center/section'
+require 'zendesk2/help_center/translation'
 
 require 'zendesk2/help_center/articles'
 require 'zendesk2/help_center/categories'
 require 'zendesk2/help_center/sections'
+require 'zendesk2/help_center/translations'

data/lib/zendesk2/help_center/access_policy.rb

@@ -20,7 +20,7 @@ class Zendesk2::HelpCenter::AccessPolicy
   def save!
     requires :section_id
 
-    response = service.update_help_center_access_policy("access_policy" => self.attributes, "section_id" => self.section_id)
+    response = cistern.update_help_center_access_policy("access_policy" => self.attributes, "section_id" => self.section_id)
     merge_attributes(response.body["access_policy"])
   end
 end

data/lib/zendesk2/help_center/article.rb

@@ -45,15 +45,21 @@ class Zendesk2::HelpCenter::Article
 
   assoc_accessor :section, collection: :help_center_sections
 
+  def translations
+    requires :identity
+
+    cistern.help_center_translations(source_id: self.identity, source_type: "Article")
+  end
+
   def save!
     response = if new_record?
                  requires :title, :locale, :section_id
 
-                 service.create_help_center_article("article" => self.attributes)
+                 cistern.create_help_center_article("article" => self.attributes)
                else
                  requires :identity
 
-                 service.update_help_center_article("article" => self.attributes)
+                 cistern.update_help_center_article("article" => self.attributes)
                end
 
     merge_attributes(response.body["article"])
@@ -62,6 +68,6 @@ class Zendesk2::HelpCenter::Article
   def destroy!
     requires :identity
 
-    service.destroy_help_center_article("article" => { "id" => self.identity })
+    cistern.destroy_help_center_article("article" => { "id" => self.identity })
   end
 end

data/lib/zendesk2/help_center/articles.rb

@@ -28,7 +28,7 @@ class Zendesk2::HelpCenter::Articles
                           :get_help_center_articles
                         end
 
-    body = service.send(collection_method, Cistern::Hash.stringify_keys(self.attributes.merge(params))).body
+    body = cistern.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"))

data/lib/zendesk2/help_center/category.rb

@@ -32,30 +32,36 @@ class Zendesk2::HelpCenter::Category
   def articles
     requires :identity
 
-    service.help_center_articles(category_id: self.identity)
+    cistern.help_center_articles(category_id: self.identity)
   end
 
   def destroy!
     requires :identity
 
-    service.destroy_help_center_category("category" => { "id" => self.identity })
+    cistern.destroy_help_center_category("category" => { "id" => self.identity })
   end
 
   def sections
     requires :identity
 
-    service.help_center_sections(category_id: self.identity)
+    cistern.help_center_sections(category_id: self.identity)
+  end
+
+  def translations
+    requires :identity
+
+    cistern.help_center_translations(source_id: self.identity, source_type: "Category")
   end
 
   def save!
     response = if new_record?
                  requires :name, :locale
 
-                 service.create_help_center_category("category" => self.attributes)
+                 cistern.create_help_center_category("category" => self.attributes)
                else
                  requires :identity
 
-                 service.update_help_center_category("category" => self.attributes)
+                 cistern.update_help_center_category("category" => self.attributes)
                end
 
     merge_attributes(response.body["category"])

data/lib/zendesk2/help_center/create_help_center_article.rb

@@ -24,7 +24,7 @@ class Zendesk2::CreateHelpCenterArticle
   end
 
   def mock
-    identity = service.serial_id
+    identity = cistern.serial_id
 
     locale = params["locale"] ||= "en-us"
     position = self.data[:help_center_articles].values.select { |a| a["section_id"] == section_id }.size
@@ -33,7 +33,7 @@ class Zendesk2::CreateHelpCenterArticle
       "id"                => identity,
       "url"               => url_for("/help_center/#{locale}/articles/#{identity}.json"),
       "html_url"          => html_url_for("/hc/#{locale}/articles/#{identity}.json"),
-      "author_id"         => service.current_user["id"],
+      "author_id"         => cistern.current_user["id"],
       "comments_disabled" => false,
       "label_names"       => [],
       "draft"             => false,

data/lib/zendesk2/help_center/create_help_center_category.rb

@@ -14,7 +14,7 @@ class Zendesk2::CreateHelpCenterCategory
   end
 
   def mock
-    identity = service.serial_id
+    identity = cistern.serial_id
 
     locale = params["locale"] ||= "en-us"
     position = self.data[:help_center_categories].size
@@ -23,7 +23,7 @@ class Zendesk2::CreateHelpCenterCategory
       "id"          => identity,
       "url"         => url_for("/help_center/#{locale}/categories/#{identity}.json"),
       "html_url"    => html_url_for("/hc/#{locale}/categories/#{identity}.json"),
-      "author_id"   => service.current_user["id"],
+      "author_id"   => cistern.current_user["id"],
       "position"    => position,
       "created_at"  => Time.now.iso8601,
       "updated_at"  => Time.now.iso8601,

data/lib/zendesk2/help_center/create_help_center_section.rb

@@ -18,7 +18,7 @@ class Zendesk2::CreateHelpCenterSection
   end
 
   def mock
-    identity = service.serial_id
+    identity = cistern.serial_id
 
     locale = params["locale"] ||= "en-us"
     position = self.data[:help_center_sections].values.select { |a| a["category_id"] == category_id }.size
@@ -27,7 +27,7 @@ class Zendesk2::CreateHelpCenterSection
       "id"                => identity,
       "url"               => url_for("/help_center/#{locale}/sections/#{identity}.json"),
       "html_url"          => html_url_for("/hc/#{locale}/sections/#{identity}.json"),
-      "author_id"         => service.current_user["id"],
+      "author_id"         => cistern.current_user["id"],
       "comments_disabled" => false,
       "label_names"       => [],
       "draft"             => false,
@@ -44,7 +44,7 @@ class Zendesk2::CreateHelpCenterSection
       "outdated"          => false,
     }.merge(section_params)
 
-    service.data[:help_center_sections][identity] = record
+    cistern.data[:help_center_sections][identity] = record
 
     access_policy = {
       "viewable_by"                     => "everyone",
@@ -54,7 +54,7 @@ class Zendesk2::CreateHelpCenterSection
       "required_tags"                   => [],
       "section_id"                      => identity
     }
-    service.data[:help_center_access_policies][identity] = access_policy
+    cistern.data[:help_center_access_policies][identity] = access_policy
 
     mock_response("section" => record)
   end

data/lib/zendesk2/help_center/create_help_center_translation.rb

@@ -0,0 +1,37 @@
+class Zendesk2::CreateHelpCenterTranslation
+  include Zendesk2::Request
+  include Zendesk2::HelpCenter::TranslationSource::Request
+
+  request_method :post
+  request_path { |r| "/help_center/#{r.source_type_url}/#{r.source_id}/translations/#{r.locale}.json" }
+  request_body { |r| { "translation" => r.translation_params } }
+
+  def self.accepted_attributes
+    %w[locale title body outdated draft]
+  end
+
+  def translation_params
+    Cistern::Hash.slice(params.fetch("translation"), *self.class.accepted_attributes)
+  end
+
+  def mock
+    identity = cistern.serial_id
+
+    record = {
+      "id"                => identity,
+      "url"               => url_for("/help_center/#{source_type_url}/#{source_id}/translation/#{locale}.json"),
+      "html_url"          => html_url_for("/hc/#{locale}/#{source_type_url}/#{source_id}"),
+      "created_at"        => Time.now.iso8601,
+      "updated_at"        => Time.now.iso8601,
+      "title"             => params.fetch("translation").fetch("title"),
+      "body"              => (params.fetch("translation")["body"] || ""),
+      "outdated"          => false,
+      "draft"             => false,
+      "locale"            => locale,
+    }.merge(translation_params)
+
+    cistern.data[:help_center_translations][mock_translation_key] = record
+
+    mock_response("translation" => record)
+  end
+end

data/lib/zendesk2/help_center/destroy_help_center_translation.rb

@@ -0,0 +1,13 @@
+class Zendesk2::DestroyHelpCenterTranslation
+  include Zendesk2::Request
+  include Zendesk2::HelpCenter::TranslationSource::Request
+
+  request_method :delete
+  request_path { |r| "/help_center/#{r.source_type_url}/#{r.source_id}/translations/#{r.locale}.json" }
+
+  def mock
+    self.delete!(:help_center_translations, mock_translation_key)
+
+    mock_response(nil)
+  end
+end

data/lib/zendesk2/help_center/get_help_center_translation.rb

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

data/lib/zendesk2/help_center/get_help_center_translations.rb

@@ -0,0 +1,25 @@
+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 }
+
+  page_params!
+
+  def translation_params
+    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.uniq!
+    new_params["locales"] = locales.join(",") unless locales.empty?
+
+    return new_params
+  end
+
+  def mock
+    page(:help_center_translations, root: "translations")
+  end
+end

data/lib/zendesk2/help_center/section.rb

@@ -39,18 +39,18 @@ class Zendesk2::HelpCenter::Section
   def destroy!
     requires :identity
 
-    service.destroy_help_center_section("section" => { "id" => self.identity })
+    cistern.destroy_help_center_section("section" => { "id" => self.identity })
   end
 
   def save!
     response = if new_record?
                  requires :name, :locale, :category_id
 
-                 service.create_help_center_section("section" => self.attributes)
+                 cistern.create_help_center_section("section" => self.attributes)
                else
                  requires :identity
 
-                 service.update_help_center_section("section" => self.attributes)
+                 cistern.update_help_center_section("section" => self.attributes)
                end
 
     merge_attributes(response.body["section"])
@@ -59,17 +59,23 @@ class Zendesk2::HelpCenter::Section
   def articles
     requires :identity
 
-    service.help_center_articles(section_id: self.identity)
+    cistern.help_center_articles(section_id: self.identity)
   end
 
   def access_policy
     requires :identity
 
-    response = service.get_help_center_access_policy(section_id: self.identity).body["access_policy"]
+    response = cistern.get_help_center_access_policy(section_id: self.identity).body["access_policy"]
     response.merge!({
       "section_id" => self.identity
     })
 
-    service.help_center_access_policy(response)
+    cistern.help_center_access_policy(response)
+  end
+
+  def translations
+    requires :identity
+
+    cistern.help_center_translations(source_id: self.identity, source_type: "Section")
   end
 end

data/lib/zendesk2/help_center/sections.rb

@@ -22,7 +22,7 @@ class Zendesk2::HelpCenter::Sections
                           :get_help_center_sections
                         end
 
-    body = service.send(collection_method, Cistern::Hash.stringify_keys(self.attributes.merge(params))).body
+    body = cistern.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"))

data/lib/zendesk2/help_center/translation.rb

@@ -0,0 +1,48 @@
+class Zendesk2::HelpCenter::Translation
+  include Zendesk2::Model
+  include Zendesk2::HelpCenter::TranslationSource::Model
+
+  extend Zendesk2::Attributes
+
+  # @return [Integer] Automatically assigned when the translation is created
+  identity :id, type: :integer # ro:yes required:no
+
+  # @return [String] The API url of the 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
+  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
+  # @return [String] The locale of the translation
+  attribute :locale, type: :string # ro:no required:yes
+  # @return [String] The title of the translation
+  attribute :title, type: :string # ro:no required:yes
+  # @return [String] The body of the translation. Empty by default
+  attribute :body, type: :string # ro:no required:no
+  # @return [Boolean] True if the translation is outdated; false otherwise. False by default
+  attribute :outdated, type: :boolean # ro:no required:no
+  # @return [Boolean] True if the translation is a draft; false otherwise. False by default
+  attribute :draft, type: :boolean # ro:no required:no
+
+  def destroy!
+    requires :locale, :source_id, :source_type
+
+    cistern.destroy_help_center_translation("translation" => Cistern::Hash.slice(self.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)
+               else
+                 requires :identity
+
+                 cistern.update_help_center_translation("translation" => self.attributes)
+               end
+
+    merge_attributes(response.body["translation"])
+  end
+end

data/lib/zendesk2/help_center/translation_source.rb

@@ -0,0 +1,45 @@
+module Zendesk2::HelpCenter::TranslationSource
+  module Model
+    def source=(source)
+      if source.is_a?(Zendesk2::HelpCenter::Article)
+        self.source_type = "Article"
+      elsif source.is_a?(Zendesk2::HelpCenter::Section)
+        self.source_type = "Section"
+      elsif source.is_a?(Zendesk2::HelpCenter::Category)
+        self.source_type = "Category"
+      end
+      self.source_id = source.id
+    end
+  end
+
+  module Request
+    def source_id
+      Integer((params["translation"] || params).fetch("source_id"))
+    end
+
+    def 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"
+      end
+    end
+
+    def locale
+      (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 }
+    end
+  end
+end