zendesk2 1.9.0 → 1.10.0

data/lib/zendesk2/help_center/translations.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::HelpCenter::Translations
   include Zendesk2::Collection
 
@@ -7,9 +8,9 @@ class Zendesk2::HelpCenter::Translations
   model Zendesk2::HelpCenter::Translation
 
   self.collection_method = :get_help_center_translations
-  self.collection_root   = "translations"
+  self.collection_root   = 'translations'
   self.model_method      = :get_help_center_translation
-  self.model_root        = "translation"
+  self.model_root        = 'translation'
 
   attribute :source_id, type: :integer
   attribute :source_type, type: :string

data/lib/zendesk2/help_center/update_help_center_access_policy.rb

@@ -1,25 +1,26 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateHelpCenterAccessPolicy
   include Zendesk2::Request
 
   request_method :put
-  request_body { |r| { "access_policy" => r.access_policy_params } }
-  request_path { |r|
+  request_body { |r| { 'access_policy' => r.access_policy_params } }
+  request_path do |r|
     "/help_center/sections/#{r.section_id}/access_policy.json"
-  }
+  end
 
   def self.accepted_attributes
-    %w[viewable_by managable_by restricted_to_group_ids restricted_to_organization_ids required_tags]
+    %w(viewable_by managable_by restricted_to_group_ids restricted_to_organization_ids required_tags)
   end
 
   def access_policy_params
-    @_section_params ||= Cistern::Hash.slice(params.fetch("access_policy"), *Zendesk2::UpdateHelpCenterAccessPolicy.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('access_policy'), *Zendesk2::UpdateHelpCenterAccessPolicy.accepted_attributes)
   end
 
   def section_id
-    params.fetch("section_id")
+    params.fetch('section_id')
   end
 
   def mock
-    mock_response("access_policy" => self.find!(:help_center_access_policies, section_id).merge!(access_policy_params))
+    mock_response('access_policy' => find!(:help_center_access_policies, section_id).merge!(access_policy_params))
   end
 end

data/lib/zendesk2/help_center/update_help_center_article.rb

@@ -1,25 +1,23 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateHelpCenterArticle
   include Zendesk2::Request
 
   request_method :put
-  request_body { |r| { "article" => r.article_params } }
-  request_path { |r|
-    if locale = r.article_params["locale"]
-      "/help_center/#{locale}/articles/#{r.article_id}.json"
-    else
-      "/help_center/articles/#{r.article_id}.json"
-    end
-  }
+  request_body { |r| { 'article' => r.article_params } }
+  request_path do |r|
+    locale = r.article_params['locale']
+    locale ? "/help_center/#{locale}/articles/#{r.article_id}.json" : "/help_center/articles/#{r.article_id}.json"
+  end
 
   def article_params
-    @_article_params ||= Cistern::Hash.slice(params.fetch("article"), *Zendesk2::CreateHelpCenterArticle.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('article'), *Zendesk2::CreateHelpCenterArticle.accepted_attributes)
   end
 
   def article_id
-    params.fetch("article").fetch("id")
+    params.fetch('article').fetch('id')
   end
 
   def mock
-    mock_response("article" => self.find!(:help_center_articles, article_id).merge!(article_params))
+    mock_response('article' => find!(:help_center_articles, article_id).merge!(article_params))
   end
 end

data/lib/zendesk2/help_center/update_help_center_category.rb

@@ -1,25 +1,23 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateHelpCenterCategory
   include Zendesk2::Request
 
   request_method :put
-  request_body { |r| { "category" => r.category_params } }
-  request_path { |r|
-    if locale = r.category_params["locale"]
-      "/help_center/#{locale}/categories/#{r.category_id}.json"
-    else
-      "/help_center/categories/#{r.category_id}.json"
-    end
-  }
+  request_body { |r| { 'category' => r.category_params } }
+  request_path do |r|
+    locale = r.category_params['locale']
+    locale ? "/help_center/#{locale}/categories/#{r.category_id}.json" : "/help_center/categories/#{r.category_id}.json"
+  end
 
   def category_params
-    @_category_params ||= Cistern::Hash.slice(params.fetch("category"), *Zendesk2::CreateHelpCenterCategory.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('category'), *Zendesk2::CreateHelpCenterCategory.accepted_attributes)
   end
 
   def category_id
-    params.fetch("category").fetch("id")
+    params.fetch('category').fetch('id')
   end
 
   def mock
-    mock_response("category" => self.find!(:help_center_categories, self.category_id).merge!(category_params))
+    mock_response('category' => find!(:help_center_categories, category_id).merge!(category_params))
   end
 end

data/lib/zendesk2/help_center/update_help_center_post.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+class Zendesk2::UpdateHelpCenterPost
+  include Zendesk2::Request
+
+  request_method :put
+  request_body { |r| { 'post' => r.post_params } }
+  request_path { |r| "/community/posts/#{r.post_id}.json" }
+
+  def post_params
+    Cistern::Hash.slice(params.fetch('post'), *Zendesk2::CreateHelpCenterPost.accepted_attributes)
+  end
+
+  def post_id
+    params.fetch('post').fetch('id')
+  end
+
+  def mock
+    mock_response('post' => find!(:help_center_categories, post_id).merge!(post_params))
+  end
+end

data/lib/zendesk2/help_center/update_help_center_section.rb

@@ -1,25 +1,23 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateHelpCenterSection
   include Zendesk2::Request
 
   request_method :put
-  request_body { |r| { "section" => r.section_params } }
-  request_path { |r|
-    if locale = r.section_params["locale"]
-      "/help_center/#{locale}/sections/#{r.section_id}.json"
-    else
-      "/help_center/sections/#{r.section_id}.json"
-    end
-  }
+  request_body { |r| { 'section' => r.section_params } }
+  request_path do |r|
+    locale = r.section_params['locale']
+    locale ? "/help_center/#{locale}/sections/#{r.section_id}.json" : "/help_center/sections/#{r.section_id}.json"
+  end
 
   def section_params
-    @_section_params ||= Cistern::Hash.slice(params.fetch("section"), *Zendesk2::CreateHelpCenterSection.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('section'), *Zendesk2::CreateHelpCenterSection.accepted_attributes)
   end
 
   def section_id
-    params.fetch("section").fetch("id")
+    params.fetch('section').fetch('id')
   end
 
   def mock
-    mock_response("section" => self.find!(:help_center_sections, section_id).merge!(section_params))
+    mock_response('section' => find!(:help_center_sections, section_id).merge!(section_params))
   end
 end

data/lib/zendesk2/help_center/update_help_center_topic.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+class Zendesk2::UpdateHelpCenterTopic
+  include Zendesk2::Request
+
+  request_method :put
+  request_body { |r| { 'topic' => r.topic_params } }
+  request_path { |r| "/community/topics/#{r.topic_id}.json" }
+
+  def topic_params
+    Cistern::Hash.slice(params.fetch('topic'), *Zendesk2::CreateHelpCenterTopic.accepted_attributes)
+  end
+
+  def topic_id
+    params.fetch('topic').fetch('id')
+  end
+
+  def mock
+    mock_response('topic' => find!(:help_center_categories, topic_id).merge!(topic_params))
+  end
+end

data/lib/zendesk2/help_center/update_help_center_translation.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateHelpCenterTranslation
   include Zendesk2::Request
   include Zendesk2::HelpCenter::TranslationSource::Request
 
   request_method :put
-  request_body { |r| { "translation" => r.translation_params } }
+  request_body { |r| { 'translation' => r.translation_params } }
   request_path { |r| "/help_center/#{r.source_type_url}/#{r.source_id}/translations/#{r.locale}.json" }
 
   def translation_params
-    @_translation_params ||= Cistern::Hash.slice(params.fetch("translation"), *Zendesk2::CreateHelpCenterTranslation.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('translation'), *Zendesk2::CreateHelpCenterTranslation.accepted_attributes)
   end
 
   def mock
-    mock_response("translation" => self.find!(:help_center_translations, mock_translation_key).merge!(translation_params))
+    mock_response('translation' => find!(:help_center_translations, mock_translation_key).merge!(translation_params))
   end
 end

data/lib/zendesk2/logger.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::Logger < Faraday::Response::Middleware
   extend Forwardable
 
@@ -9,14 +10,14 @@ class Zendesk2::Logger < Faraday::Response::Middleware
   def_delegators :@logger, :debug, :info, :warn, :error, :fatal
 
   def call(env)
-    info("#{env[:method]} => #{env[:url].to_s}")
+    info("#{env[:method]} => #{env[:url]}")
     debug('request') { dump_headers env[:request_headers] }
     debug('request.body') { env[:body] }
     super
   end
 
   def on_complete(env)
-    info("#{env[:status]} <= #{env[:url].to_s}")
+    info("#{env[:status]} <= #{env[:url]}")
     debug('response') { dump_headers env[:response_headers] }
     debug('response.body') { env[:body] }
   end

data/lib/zendesk2/mark_membership_default.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::MarkMembershipDefault
   include Zendesk2::Request
 
@@ -5,19 +6,19 @@ class Zendesk2::MarkMembershipDefault
   request_path { |r| "/users/#{r.user_id}/organization_memberships/#{r.identity}/make_default.json" }
 
   def identity
-    params.fetch("membership").fetch("id")
+    params.fetch('membership').fetch('id')
   end
 
   def user_id
-    params.fetch("membership").fetch("user_id").to_i
+    params.fetch('membership').fetch('user_id').to_i
   end
 
   def mock
-    if (membership = self.find!(:memberships, identity)) && (membership["user_id"] == user_id)
+    if (membership = find!(:memberships, identity)) && (membership['user_id'] == user_id)
       # only one user can be default
-      other_user_memberships = self.data[:memberships].values.select { |m| m["user_id"]== user_id }
-      other_user_memberships.each { |i| i["default"] = false }
-      membership["default"] = true
+      other_user_memberships = data[:memberships].values.select { |m| m['user_id'] == user_id }
+      other_user_memberships.each { |i| i['default'] = false }
+      membership['default'] = true
 
       mock_response(params)
     else

data/lib/zendesk2/mark_user_identity_primary.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::MarkUserIdentityPrimary
   include Zendesk2::Request
 
@@ -5,21 +6,21 @@ class Zendesk2::MarkUserIdentityPrimary
   request_method :put
 
   def user_id
-    params.fetch("user_identity").fetch("user_id")
+    params.fetch('user_identity').fetch('user_id')
   end
 
   def user_identity_id
-    params.fetch("user_identity").fetch("id")
+    params.fetch('user_identity').fetch('id')
   end
 
   def mock
-    user_identity = self.find!(:identities, user_identity_id)
+    user_identity = find!(:identities, user_identity_id)
 
     # only one user can be primary
-    other_user_identities = cistern.data[:identities].values.select { |i| i["user_id"] == user_id }
-    other_user_identities.map { |i| i["primary"] = false }
+    other_user_identities = cistern.data[:identities].values.select { |i| i['user_id'] == user_id }
+    other_user_identities.map { |i| i['primary'] = false }
 
-    user_identity.merge!("primary" => true)
+    user_identity['primary'] = true
 
     mock_response(nil)
   end

data/lib/zendesk2/membership.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::Membership
   include Zendesk2::Model
 
@@ -26,11 +27,11 @@ class Zendesk2::Membership
     data = if new_record?
              requires :organization_id, :user_id
 
-             cistern.create_membership("membership" => self.attributes).body["organization_membership"]
+             cistern.create_membership('membership' => attributes).body['organization_membership']
            else
              requires :identity
 
-             raise ArgumentError, "update not implemented"
+             raise ArgumentError, 'update not implemented'
            end
 
     merge_attributes(data)
@@ -39,17 +40,18 @@ class Zendesk2::Membership
   def destroy!
     requires :identity
 
-    cistern.destroy_membership("membership" => { "id" => self.identity })
+    cistern.destroy_membership('membership' => { 'id' => identity })
   end
 
   def default!
     requires :identity, :user_id
 
-    self.cistern.mark_membership_default(
-      "membership" => {
-        "user_id" => self.user_id,
-        "id"      => self.identity
-      })
+    cistern.mark_membership_default(
+      'membership' => {
+        'user_id' => user_id,
+        'id'      => identity,
+      }
+    )
 
     self.default = true
   end

data/lib/zendesk2/memberships.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::Memberships
   include Zendesk2::Collection
 
@@ -12,27 +13,32 @@ class Zendesk2::Memberships
   assoc_accessor :organization
   assoc_accessor :user
 
-  self.collection_root = "organization_memberships"
+  self.collection_root = 'organization_memberships'
   self.model_method    = :get_membership
-  self.model_root      = "organization_membership"
+  self.model_root      = 'organization_membership'
 
-  def all(params={})
+  def all(params = {})
     requires_one :user_id, :organization_id
 
-    body = if self.user_id && self.organization_id
+    body = if user_id && organization_id
              {
-               "organization_memberships" => [
-                 cistern.get_membership("user_id" => self.user_id, "organization_id" => self.organization_id).body["organization_membership"]
-               ]
+               'organization_memberships' => [
+                 cistern.get_membership(
+                   'user_id' => user_id,
+                   'organization_id' => organization_id,
+                 ).body['organization_membership'],
+               ],
              }
-           elsif self.user_id
-             cistern.get_user_memberships({"membership" => { "user_id" => self.user_id }}.merge(params)).body
+           elsif user_id
+             request_params = { 'membership' => { 'user_id' => user_id } }.merge(params)
+             cistern.get_user_memberships(request_params).body
            else
-             cistern.get_organization_memberships({"membership" => { "organization_id" => self.organization_id }}.merge(params)).body
+             request_params = { 'membership' => { 'organization_id' => organization_id } }.merge(params)
+             cistern.get_organization_memberships(request_params).body
            end
 
-    self.load(body[collection_root])
-    self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+    load(body[collection_root])
+    merge_attributes(Cistern::Hash.slice(body, 'count', 'next_page', 'previous_page'))
     self
   end
 

data/lib/zendesk2/mock.rb

@@ -1,32 +1,36 @@
+# frozen_string_literal: true
 class Zendesk2::Mock
   attr_reader :username, :url, :token, :jwt_token
   attr_accessor :last_request
 
   def self.data
-    @data ||= Hash.new { |h,k| h[k] = {
-      :categories                   => {},
-      :forums                       => {},
-      :groups                       => {},
-      :help_center_access_policies  => {},
-      :help_center_articles         => {},
-      :help_center_categories       => {},
-      :help_center_sections         => {},
-      :help_center_translations     => {},
-      :identities                   => {},
-      :memberships                  => {},
-      :organizations                => {},
-      :ticket_audits                => {},
-      :ticket_comments              => {},
-      :ticket_fields                => {},
-      :ticket_metrics               => {},
-      :tickets                      => {},
-      :topic_comments               => {},
-      :topics                       => {},
-      :user_fields                  => {},
-      :users                        => {},
-      :views                        => {},
-    }
-    }
+    @data ||= Hash.new do |h, k|
+      h[k] = {
+        categories: {},
+        forums: {},
+        groups: {},
+        help_center_access_policies: {},
+        help_center_articles: {},
+        help_center_categories: {},
+        help_center_posts: {},
+        help_center_sections: {},
+        help_center_topics: {},
+        help_center_translations: {},
+        identities: {},
+        memberships: {},
+        organizations: {},
+        ticket_audits: {},
+        ticket_comments: {},
+        ticket_fields: {},
+        ticket_metrics: {},
+        tickets: {},
+        topic_comments: {},
+        topics: {},
+        user_fields: {},
+        users: {},
+        views: {},
+      }
+    end
   end
 
   def self.serial_id
@@ -51,27 +55,28 @@ class Zendesk2::Mock
     self.class.serial_id
   end
 
-  def initialize(options={})
+  def initialize(options = {})
     @url                 = options[:url]
     @path                = URI.parse(url).path
-    @username, @password = options[:username], options[:password]
+    @username = options[:username]
+    @password = options[:password]
     @token               = options[:token]
     @jwt_token           = options[:jwt_token]
 
-    @current_user ||= self.data[:users].values.find { |u|
-      @username == u["name"]
-    } || self.create_user(
-      "user" => {"email" => @username, "name" => @username}
-    ).body["user"]
+    @current_user ||= data[:users].values.find do |u|
+      @username == u['name']
+    end || create_user(
+      'user' => { 'email' => @username, 'name' => @username }
+    ).body['user']
 
-    @current_user_identity ||= self.data[:identities].values.first
+    @current_user_identity ||= data[:identities].values.first
   end
 
   # Lazily re-seeds data after reset
   # @return [Hash] current user response
   def current_user
-    self.data[:users][@current_user["id"]]               ||= @current_user
-    self.data[:identities][@current_user_identity["id"]] ||= @current_user_identity
+    data[:users][@current_user['id']]               ||= @current_user
+    data[:identities][@current_user_identity['id']] ||= @current_user_identity
 
     @current_user
   end