zendesk2 1.9.0 → 1.10.0

data/lib/zendesk2/destroy_category.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyCategory
   include Zendesk2::Request
 
@@ -5,7 +6,7 @@ class Zendesk2::DestroyCategory
   request_path { |r| "/categories/#{r.category_id}.json" }
 
   def category_id
-    params.fetch("category").fetch("id")
+    params.fetch('category').fetch('id')
   end
 
   def mock

data/lib/zendesk2/destroy_forum.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyForum
   include Zendesk2::Request
 
@@ -5,7 +6,7 @@ class Zendesk2::DestroyForum
   request_path { |r| "/forums/#{r.forum_id}.json" }
 
   def forum_id
-    params.fetch("forum").fetch("id")
+    params.fetch('forum').fetch('id')
   end
 
   def mock

data/lib/zendesk2/destroy_group.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyGroup
   include Zendesk2::Request
 
@@ -5,11 +6,11 @@ class Zendesk2::DestroyGroup
   request_path { |r| "/groups/#{r.group_id}.json" }
 
   def group_id
-    params.fetch("group").fetch("id")
+    params.fetch('group').fetch('id')
   end
 
   def mock
-    find!(:groups, group_id, params).merge!("deleted" => true)
+    find!(:groups, group_id, params)['deleted'] = true
 
     mock_response(nil)
   end

data/lib/zendesk2/destroy_membership.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyMembership
   include Zendesk2::Request
 
@@ -5,18 +6,19 @@ class Zendesk2::DestroyMembership
   request_path { |r| "/organization_memberships/#{r.membership_id}.json" }
 
   def membership_id
-    params.fetch("membership").fetch("id").to_i
+    params.fetch('membership').fetch('id').to_i
   end
 
   def mock
     membership = delete!(:memberships, membership_id)
 
-    primary_organization = self.data[:memberships].values.find { |m| m["user_id"] == membership["user_id"] && m["default"] } ||
-      self.data[:memberships].values.find { |m| m["user_id"] == membership["user_id"] }
+    primary_organization = data[:memberships].values.find do |m|
+      m['user_id'] == membership['user_id'] && m['default']
+    end || data[:memberships].values.find { |m| m['user_id'] == membership['user_id'] }
 
     if primary_organization
-      primary_organization.merge!("default" => true)
-      self.find!(:users, membership["user_id"].to_i).merge!("organization_id" => primary_organization["organization_id"])
+      primary_organization['default'] = true
+      find!(:users, membership['user_id'].to_i)['organization_id'] = primary_organization['organization_id']
     end
 
     mock_response(nil)

data/lib/zendesk2/destroy_organization.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyOrganization
   include Zendesk2::Request
 
@@ -5,11 +6,11 @@ class Zendesk2::DestroyOrganization
   request_path { |r| "/organizations/#{r.organization_id}.json" }
 
   def organization_id
-    params.fetch("organization").fetch("id")
+    params.fetch('organization').fetch('id')
   end
 
   def mock
-    self.delete!(:organizations, organization_id)
+    delete!(:organizations, organization_id)
 
     mock_response(nil)
   end

data/lib/zendesk2/destroy_ticket.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyTicket
   include Zendesk2::Request
 
@@ -5,11 +6,11 @@ class Zendesk2::DestroyTicket
   request_path { |r| "/tickets/#{r.ticket_id}.json" }
 
   def ticket_id
-    @_ticket_id ||= params.fetch("ticket").fetch("id")
+    @_ticket_id ||= params.fetch('ticket').fetch('id')
   end
 
   def mock
-    self.delete!(:tickets, ticket_id)
+    delete!(:tickets, ticket_id)
 
     mock_response(nil)
   end

data/lib/zendesk2/destroy_ticket_field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyTicketField
   include Zendesk2::Request
 
@@ -5,11 +6,11 @@ class Zendesk2::DestroyTicketField
   request_path { |r| "/ticket_fields/#{r.ticket_field_id}.json" }
 
   def ticket_field_id
-    params.fetch("ticket_field").fetch("id")
+    params.fetch('ticket_field').fetch('id')
   end
 
   def mock
-    self.delete!(:ticket_fields, ticket_field_id)
+    delete!(:ticket_fields, ticket_field_id)
 
     mock_response(nil)
   end

data/lib/zendesk2/destroy_topic.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyTopic
   include Zendesk2::Request
 
@@ -5,11 +6,11 @@ class Zendesk2::DestroyTopic
   request_path { |r| "/topics/#{r.topic_id}.json" }
 
   def topic_id
-    params.fetch("topic").fetch("id")
+    params.fetch('topic').fetch('id')
   end
 
   def mock
-    self.delete!(:topics, topic_id)
+    delete!(:topics, topic_id)
 
     mock_response(nil)
   end

data/lib/zendesk2/destroy_topic_comment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyTopicComment
   include Zendesk2::Request
 
@@ -5,15 +6,15 @@ class Zendesk2::DestroyTopicComment
   request_path { |r| "/topics/#{r.topic_id}/comments/#{r.topic_comment_id}.json" }
 
   def topic_id
-    params.fetch("topic_comment").fetch("topic_id")
+    params.fetch('topic_comment').fetch('topic_id')
   end
 
   def topic_comment_id
-    params.fetch("topic_comment").fetch("id")
+    params.fetch('topic_comment').fetch('id')
   end
 
   def mock
-    self.delete!(:topic_comments, topic_comment_id)
+    delete!(:topic_comments, topic_comment_id)
 
     mock_response(nil)
   end

data/lib/zendesk2/destroy_user.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyUser
   include Zendesk2::Request
 
@@ -5,23 +6,23 @@ class Zendesk2::DestroyUser
   request_path { |r| "/users/#{r.user_id}.json" }
 
   def user_id
-    @_user_id ||= params.fetch("user").fetch("id").to_i
+    @_user_id ||= params.fetch('user').fetch('id').to_i
   end
 
   def mock
-    ticket_count = cistern.data[:tickets].values.select { |t| t["requester_id"].to_i == user_id }.size
+    ticket_count = cistern.data[:tickets].values.select { |t| t['requester_id'].to_i == user_id }.size
 
     if ticket_count < 1
-      cistern.data[:identities].each { |k,v| cistern.data[:identities].delete(k) if v["user_id"] == user_id }
+      cistern.data[:identities].each { |k, v| cistern.data[:identities].delete(k) if v['user_id'] == user_id }
 
-      mock_response("user" => self.delete!(:users, user_id))
+      mock_response('user' => delete!(:users, user_id))
     else
-      error!(:invalid, "details" => {
-        "base" => [{
-          "type"        => "User is requester on #{ticket_count} ticket(s) that are not closed.",
-          "description" => "Base User is requester on #{ticket_count} ticket(s) that are not closed."
-        }]
-      })
+      error!(:invalid, 'details' => {
+               'base' => [{
+                 'type'        => "User is requester on #{ticket_count} ticket(s) that are not closed.",
+                 'description' => "Base User is requester on #{ticket_count} ticket(s) that are not closed.",
+               },],
+             })
     end
   end
 end

data/lib/zendesk2/destroy_user_field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyUserField
   include Zendesk2::Request
 
@@ -5,10 +6,10 @@ class Zendesk2::DestroyUserField
   request_path { |r| "/user_fields/#{r.user_field_id}.json" }
 
   def user_field_id
-    params.fetch("user_field").fetch("id")
+    params.fetch('user_field').fetch('id')
   end
 
   def mock
-    mock_response("user_field" => self.delete!(:user_fields, user_field_id))
+    mock_response('user_field' => delete!(:user_fields, user_field_id))
   end
 end

data/lib/zendesk2/destroy_user_identity.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyUserIdentity
   include Zendesk2::Request
 
@@ -5,14 +6,14 @@ class Zendesk2::DestroyUserIdentity
   request_method :delete
 
   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
-    mock_response("identity" => self.delete!(:identities, user_identity_id))
+    mock_response('identity' => delete!(:identities, user_identity_id))
   end
 end

data/lib/zendesk2/destroy_view.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::DestroyView
   include Zendesk2::Request
 
@@ -5,11 +6,11 @@ class Zendesk2::DestroyView
   request_path { |r| "/views/#{r.view_id}.json" }
 
   def view_id
-    @_view_id ||= params.fetch("view").fetch("id")
+    @_view_id ||= params.fetch('view').fetch('id')
   end
 
   def mock
-    self.delete!(:views, view_id)
+    delete!(:views, view_id)
 
     mock_response(nil)
   end

data/lib/zendesk2/error.rb

@@ -1,5 +1,5 @@
+# frozen_string_literal: true
 class Zendesk2::Error < StandardError
-
   attr_reader :wrapped_exception, :response
   def initialize(wrapped_exception)
     @wrapped_exception = wrapped_exception

data/lib/zendesk2/forum.rb

@@ -1,22 +1,40 @@
+# frozen_string_literal: true
 class Zendesk2::Forum
   include Zendesk2::Model
 
   extend Zendesk2::Attributes
 
-  identity :id,                 type: :integer # ro yes mandatory no  Automatically assigned upon creation
-  attribute :url,               type: :string  # ro yes mandatory no  The API url of this forum
-  attribute :name,              type: :string  # ro no mandatory yes The name of the forum
-  attribute :description,       type: :string  # ro no mandatory no  A description of the forum
-  attribute :category_id,       type: :integer # ro no mandatory no  Category this forum is in
-  attribute :organization_id,   type: :integer # ro no mandatory no  Organization this forum is restricted to
-  attribute :locale_id,         type: :integer # ro no mandatory no  User locale id this forum is restricted to
-  attribute :locked,            type: :boolean # ro no mandatory no  Whether this forum is locked such that new entries and comments cannot be made
-  attribute :unanswered_topics, type: :integer # ro yes mandatory no  Contains the number of unanswered questions if this forum's topics are questions.
-  attribute :position,          type: :integer # ro no mandatory no  The position of this forum relative to other forums in the same category
-  attribute :forum_type,        type: :string  # ro no mandatory no  The type of the topics in this forum, valid values: "articles", "ideas" or "questions"
-  attribute :access,            type: :string  # ro no mandatory no  Who has access to this forum, valid values: "everybody", "logged-in users" or "agents only"
-  attribute :created_at,        type: :time    # ro yes mandatory no  The time the forum was created
-  attribute :updated_at,        type: :time    # ro yes mandatory no  The time of the last update of the forum
+  # @return [Fixnum] Automatically assigned upon creation
+  identity :id, type: :integer # ro: yes, required: no
+
+  # @return [String] The API url of this forum
+  attribute :url, type: :string # ro: yes, required: no
+  # @return [String] The name of the forum
+  attribute :name, type: :string # ro: no, required: yes
+  # @return [String] A description of the forum
+  attribute :description, type: :string # ro: no, required: no
+  # @return [Fixnum] Category this forum is in
+  attribute :category_id, type: :integer # ro: no, required: no
+  # @return [Fixnum] Organization this forum is restricted to
+  attribute :organization_id, type: :integer # ro: no, required: no
+  # @return [Fixnum] User locale id this forum is restricted to
+  attribute :locale_id, type: :integer # ro: no, required: no
+  # @return [Boolean] Whether this forum is locked such that new entries and comments cannot be made
+  attribute :locked, type: :boolean # ro: no, required: no
+  # @return [Fixnum] Contains the number of unanswered questions if this forum's topics are questions.
+  attribute :unanswered_topics, type: :integer # ro: yes, required: no
+  # @return [Fixnum] The position of this forum relative to other forums in the same category
+  attribute :position, type: :integer # ro: no, required: no
+  # @return [String] The type of the topics in this forum, valid values: "articles", "ideas" or "questions"
+  attribute :forum_type, type: :string # ro: no, required: no
+  # @return [String] Who has access to this forum, valid values: "everybody", "logged-in users" or "agents only"
+  attribute :access, type: :string # ro: no, required: no
+  # @return [Array] Restrict access to end-users and organizations with all these tags
+  attribute :tags, type: :array # ro: no, required: no
+  # @return [Time] The time the forum was created
+  attribute :created_at, type: :time # ro: yes, required: no
+  # @return [Time] The time of the last update of the forum
+  attribute :updated_at, type: :time # ro: yes, required: no
 
   assoc_accessor :organization
   assoc_accessor :category
@@ -24,20 +42,20 @@ class Zendesk2::Forum
   def destroy!
     requires :identity
 
-    cistern.destroy_forum("forum" => {"id" => self.identity})
+    cistern.destroy_forum('forum' => { 'id' => identity })
   end
 
   def save!
     response = if new_record?
                  requires :name
 
-                 cistern.create_forum("forum" => self.attributes)
+                 cistern.create_forum('forum' => attributes)
                else
                  requires :identity
 
-                 cistern.update_forum("forum" => self.attributes)
+                 cistern.update_forum('forum' => attributes)
                end
 
-    merge_attributes(response.body["forum"])
+    merge_attributes(response.body['forum'])
   end
 end

data/lib/zendesk2/forums.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::Forums
   include Zendesk2::Collection
 
@@ -7,8 +8,8 @@ class Zendesk2::Forums
   model Zendesk2::Forum
 
   self.collection_method = :get_forums
-  self.collection_root   = "forums"
+  self.collection_root   = 'forums'
   self.model_method      = :get_forum
-  self.model_root        = "forum"
-  self.search_type       = "forum"
+  self.model_root        = 'forum'
+  self.search_type       = 'forum'
 end

data/lib/zendesk2/get_assignable_groups.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
 class Zendesk2::GetAssignableGroups
   include Zendesk2::Request
 
   request_method :get
-  request_path { |r| "/groups/assignable.json" }
+  request_path { |_r| '/groups/assignable.json' }
 
   page_params!
 
   def mock
     groups = cistern.data[:groups].values.select { |group| group.select { |g| !g['deleted'] } }
 
-    page(groups, root: "groups")
+    page(groups, root: 'groups')
   end
 end

data/lib/zendesk2/get_categories.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 class Zendesk2::GetCategories
   include Zendesk2::Request
 
   request_method :get
-  request_path { |_| "/categories.json" }
+  request_path { |_| '/categories.json' }
 
   page_params!
 

data/lib/zendesk2/get_category.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::GetCategory
   include Zendesk2::Request
 
@@ -5,12 +6,12 @@ class Zendesk2::GetCategory
   request_path { |r| "/categories/#{r.category_id}.json" }
 
   def category_id
-    params.fetch("category").fetch("id")
+    params.fetch('category').fetch('id')
   end
 
   def mock
     mock_response(
-      "category" => self.find!(:categories, category_id)
+      'category' => find!(:categories, category_id)
     )
   end
 end

data/lib/zendesk2/get_ccd_tickets.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::GetCcdTickets
   include Zendesk2::Request
 
@@ -6,12 +7,12 @@ class Zendesk2::GetCcdTickets
   page_params!
 
   def collaborator_id
-    params.fetch("collaborator_id").to_i
+    params.fetch('collaborator_id').to_i
   end
 
   def mock
-    tickets = cistern.data[:tickets].values.select { |u| u["collaborator_ids"].include?(collaborator_id) }
+    tickets = cistern.data[:tickets].values.select { |u| u['collaborator_ids'].include?(collaborator_id) }
 
-    page(tickets, root: "tickets")
+    page(tickets, root: 'tickets')
   end
 end