zendesk2 1.9.0 → 1.10.0

data/lib/zendesk2/topic_comments.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::TopicComments
   include Zendesk2::Collection
 
@@ -9,10 +10,10 @@ class Zendesk2::TopicComments
   attribute :topic_id, type: :integer
 
   self.collection_method = :get_topic_comments
-  self.collection_root   = "topic_comments"
+  self.collection_root   = 'topic_comments'
   self.model_method      = :get_topic_comment
-  self.model_root        = "topic_comment"
-  self.search_type       = "topic_comment"
+  self.model_root        = 'topic_comment'
+  self.search_type       = 'topic_comment'
 
   scopes << :topic_id
 end

data/lib/zendesk2/topics.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::Topics
   include Zendesk2::Collection
 
@@ -7,8 +8,8 @@ class Zendesk2::Topics
   model Zendesk2::Topic
 
   self.collection_method = :get_topics
-  self.collection_root   = "topics"
+  self.collection_root   = 'topics'
   self.model_method      = :get_topic
-  self.model_root        = "topic"
-  self.search_type       = "topic"
+  self.model_root        = 'topic'
+  self.search_type       = 'topic'
 end

data/lib/zendesk2/update_category.rb

@@ -1,21 +1,23 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateCategory
   include Zendesk2::Request
 
   request_method :put
-  request_body { |r| { "category" => Cistern::Hash.except(r.category, "id") } }
+  request_body { |r| { 'category' => Cistern::Hash.except(r.category, 'id') } }
   request_path { |r| "/categories/#{r.category_id}.json" }
 
   def category
-    self.params.fetch("category")
+    params.fetch('category')
   end
 
   def category_id
-    category.fetch("id")
+    category.fetch('id')
   end
 
   def mock
-    mock_response(
-      "category" => find!(:categories, category_id).merge!(Cistern::Hash.slice(category, *Zendesk2::CreateCategory.accepted_attributes))
-    )
+    category_data = find!(:categories, category_id)
+    category_data.merge!(Cistern::Hash.slice(category, *Zendesk2::CreateCategory.accepted_attributes))
+
+    mock_response('category' => category_data)
   end
 end

data/lib/zendesk2/update_forum.rb

@@ -1,21 +1,22 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateForum
   include Zendesk2::Request
 
   request_method :put
   request_path { |r| "/forums/#{r.forum_id}.json" }
-  request_body { |r| { "forum" => r.forum_params } }
+  request_body { |r| { 'forum' => r.forum_params } }
 
   def forum_params
-    Cistern::Hash.slice(params.fetch("forum"), *Zendesk2::CreateForum.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('forum'), *Zendesk2::CreateForum.accepted_attributes)
   end
 
   def forum_id
-    params.fetch("forum").fetch("id")
+    params.fetch('forum').fetch('id')
   end
 
   def mock
     mock_response(
-      "forum" => find!(:forums, forum_id).merge!(forum_params),
+      'forum' => find!(:forums, forum_id).merge!(forum_params)
     )
   end
 end

data/lib/zendesk2/update_group.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateGroup
   include Zendesk2::Request
 
   request_method :put
   request_path { |r| "/groups/#{r.group_id}.json" }
-  request_body { |r| { "group" => r.group_params } }
+  request_body { |r| { 'group' => r.group_params } }
 
   def group_params
-    @_group_params ||= Cistern::Hash.slice(params.fetch("group"), *Zendesk2::CreateGroup.accepted_attributes)
+    @_group_params ||= Cistern::Hash.slice(params.fetch('group'), *Zendesk2::CreateGroup.accepted_attributes)
   end
 
   def group_id
-    @_group_id ||= params.fetch("group").fetch("id")
+    @_group_id ||= params.fetch('group').fetch('id')
   end
 
   def mock
-    mock_response("group" => find!(:groups, group_id).merge!(group_params))
+    mock_response('group' => find!(:groups, group_id).merge!(group_params))
   end
 end

data/lib/zendesk2/update_organization.rb

@@ -1,38 +1,47 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateOrganization
   include Zendesk2::Request
 
   request_method :put
   request_path { |r| "/organizations/#{r.organization_id}.json" }
-  request_body { |r| { "organization" => r.organization_params } }
+  request_body { |r| { 'organization' => r.organization_params } }
 
   def organization_params
     @_organization_params ||= Cistern::Hash.slice(organization, *Zendesk2::CreateOrganization.accepted_attributes)
   end
 
   def organization
-    params.fetch("organization")
+    params.fetch('organization')
   end
 
   def organization_id
-    organization.fetch("id").to_i
+    organization.fetch('id').to_i
   end
 
   def mock
-    record = self.find!(:organizations, organization_id)
+    record = find!(:organizations, organization_id)
 
     other_organizations = cistern.data[:organizations].dup
     other_organizations.delete(organization_id)
 
-    if organization["name"] && other_organizations.values.find { |o| o["name"].downcase == organization["name"].downcase }
-      error!(:invalid, details: {"name" => [ { "description" => "Name: has already been taken" } ]})
+    other_named_organization = other_organizations.values.find do |o|
+      o['name'].casecmp(organization['name'].to_s.downcase).zero?
     end
 
-    if organization["external_id"] && other_organizations.values.find { |o| o["external_id"].to_s.downcase == organization["external_id"].to_s.downcase }
-      error!(:invalid, details: {"name" => [ { "description" => "External has already been taken" } ]})
+    if organization['name'] && other_named_organization
+      error!(:invalid, details: { 'name' => [{ 'description' => 'Name: has already been taken' }] })
+    end
+
+    other_external_organization = other_organizations.values.find do |o|
+      o['external_id'].to_s.casecmp(organization['external_id'].to_s.downcase).zero?
+    end
+
+    if organization['external_id'] && other_external_organization
+      error!(:invalid, details: { 'name' => [{ 'description' => 'External has already been taken' }] })
     end
 
     record.merge!(organization_params)
 
-    mock_response("organization" => record)
+    mock_response('organization' => record)
   end
 end

data/lib/zendesk2/update_request.rb

@@ -1,18 +1,19 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateRequest
   include Zendesk2::Client
 
   request_method :put
-  request_path { |r| "/requests/#{id}.json" }
-  request_params { |r| { "request" => r.params } }
+  request_path { |_r| "/requests/#{id}.json" }
+  request_params { |r| { 'request' => r.params } }
 
   def request_id
-    @_request_id ||= params.delete("id")
+    @_request_id ||= params.delete('id')
   end
 
-  def mock(params={})
+  def mock(params = {})
     ticket = find!(:tickets, request_id)
     ticket.merge!(params)
 
-    mock_response("request" => ticket)
+    mock_response('request' => ticket)
   end
 end

data/lib/zendesk2/update_ticket.rb

@@ -1,76 +1,77 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateTicket
   include Zendesk2::Request
 
   request_method :put
   request_path { |r| "/tickets/#{r.ticket_id}.json"  }
-  request_body { |r| { "ticket" => r.ticket_params } }
+  request_body { |r| { 'ticket' => r.ticket_params } }
 
   def self.accepted_attributes
-    Zendesk2::CreateTicket.accepted_attributes + ["comment"]
+    Zendesk2::CreateTicket.accepted_attributes + ['comment']
   end
 
   def ticket_params
-    @_ticket_params ||= Cistern::Hash.slice(params.fetch("ticket"), *self.class.accepted_attributes)
+    @_ticket_params ||= Cistern::Hash.slice(params.fetch('ticket'), *self.class.accepted_attributes)
   end
 
   def ticket_id
-    params.fetch("ticket").fetch("id")
+    params.fetch('ticket').fetch('id')
   end
 
   def mock
-    comment = params.fetch("ticket").delete("comment")
+    comment = params.fetch('ticket').delete('comment')
 
-    body = self.find!(:tickets, ticket_id).merge!(ticket_params)
+    body = find!(:tickets, ticket_id).merge!(ticket_params)
 
     if comment
       comment_id = cistern.serial_id
 
       comment_data = cistern.data[:ticket_comments][comment_id] = {
-        "id"          => comment_id,
-        "type"        => "Comment",
-        "author_id"   => cistern.current_user["id"],
-        "body"        => comment["body"],
-        "html_body"   => "<p>#{comment["body"]}</p>",
-        "public"      => comment["public"].nil? ? true : comment["public"],
-        "trusted"     => comment["trusted"].nil? ? true : comment["trusted"],
-        "attachments" => comment["attachments"] || [],
-        "ticket_id"   => ticket_id,
+        'id'          => comment_id,
+        'type'        => 'Comment',
+        'author_id'   => cistern.current_user['id'],
+        'body'        => comment['body'],
+        'html_body'   => "<p>#{comment['body']}</p>",
+        'public'      => comment['public'].nil? ? true : comment['public'],
+        'trusted'     => comment['trusted'].nil? ? true : comment['trusted'],
+        'attachments' => comment['attachments'] || [],
+        'ticket_id'   => ticket_id,
       }
 
       audit_id = cistern.serial_id
 
       audit = {
-        "id"         => audit_id,
-        "ticket_id"  => ticket_id,
-        "created_at" => Time.now,
-        "author_id"  => cistern.current_user["id"],
-        "via"        => {
-          "channel" => "api",
-          "source"  => {
-            "form" => {},
-            "to"   => {},
-            "rel"  => nil,
-          }
+        'id'         => audit_id,
+        'ticket_id'  => ticket_id,
+        'created_at' => Time.now,
+        'author_id'  => cistern.current_user['id'],
+        'via'        => {
+          'channel' => 'api',
+          'source'  => {
+            'form' => {},
+            'to'   => {},
+            'rel'  => nil,
+          },
         },
-        "metadata" => {
-          "system" => {
-            "client"     => Zendesk2::USER_AGENT,
-            "ip_address" => "127.0.0.1",
-            "location"   => "Oakland, CA, United States",
-            "latitude"   => 37.83449999999999,
-            "longitude"  => -122.2647,
+        'metadata' => {
+          'system' => {
+            'client'     => Zendesk2::USER_AGENT,
+            'ip_address' => '127.0.0.1',
+            'location'   => 'Oakland, CA, United States',
+            'latitude'   => 37.83449999999999,
+            'longitude'  => -122.2647,
           },
-          "custom" => {},
+          'custom' => {},
         },
-        "events" => [comment_data]
+        'events' => [comment_data],
       }
 
-      self.data[:ticket_audits][audit_id] = audit
+      data[:ticket_audits][audit_id] = audit
     end
 
     mock_response(
-      "ticket" => body,
-      "audit"  => audit,
+      'ticket' => body,
+      'audit'  => audit
     )
   end
 end

data/lib/zendesk2/update_ticket_field.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateTicketField
   include Zendesk2::Request
 
   request_method :put
   request_path { |r| "/ticket_fields/#{r.ticket_field_id}.json" }
-  request_body { |r| { "ticket_field" => r.ticket_field_params } }
+  request_body { |r| { 'ticket_field' => r.ticket_field_params } }
 
   def ticket_field_id
-    params.fetch("ticket_field").fetch("id")
+    params.fetch('ticket_field').fetch('id')
   end
 
   def ticket_field_params
-    Cistern::Hash.slice(params.fetch("ticket_field"), *Zendesk2::CreateTicketField.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('ticket_field'), *Zendesk2::CreateTicketField.accepted_attributes)
   end
 
   def mock
-    mock_response("ticket_field" => self.find!(:ticket_fields, ticket_field_id).merge!(ticket_field_params))
+    mock_response('ticket_field' => find!(:ticket_fields, ticket_field_id).merge!(ticket_field_params))
   end
 end

data/lib/zendesk2/update_topic.rb

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

data/lib/zendesk2/update_user.rb

@@ -1,60 +1,68 @@
+# frozen_string_literal: true
 class Zendesk2::UpdateUser
   include Zendesk2::Request
 
   request_method :put
   request_path { |r| "/users/#{r.user_id}.json" }
-  request_body { |r| {"user" => r.user_params } }
+  request_body { |r| { 'user' => r.user_params } }
 
   def user_params
-    @_user_params ||= Cistern::Hash.slice(params.fetch("user"), *Zendesk2::CreateUser.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('user'), *Zendesk2::CreateUser.accepted_attributes)
   end
 
   def user_id
-    @_user_id ||= params.fetch("user").fetch("id").to_i
+    @_user_id ||= params.fetch('user').fetch('id').to_i
   end
 
   def mock
-    email = user_params["email"]
+    update_params = user_params
+
+    email = update_params['email']
 
     other_users = cistern.data[:users].dup
     other_users.delete(user_id)
 
-    external_id = user_params["external_id"]
+    external_id = update_params['external_id']
 
-    if external_id && other_users.values.find { |o| o["external_id"].to_s.downcase == external_id.to_s.downcase }
-      error!(:invalid, details: {"name" => [ { "description" => "External has already been taken" } ]})
+    if external_id && other_users.values.find { |o| o['external_id'].to_s.casecmp(external_id.to_s.downcase).zero? }
+      error!(:invalid, details: { 'name' => [{ 'description' => 'External has already been taken' }] })
     end
 
-    existing_identity = cistern.data[:identities].values.find { |i| i["type"] == "email" && i["value"] == email }
+    existing_identity = cistern.data[:identities].values.find { |i| i['type'] == 'email' && i['value'] == email }
 
     if !email
       # nvm
-    elsif existing_identity && existing_identity["user_id"] != user_id
+    elsif existing_identity
       # email not allowed to conflict across users
-      error!(:invalid, details: { "email" => [ {
-        "description" => "Email #{params["email"]} is already being used by another user",
-      } ] })
-    elsif existing_identity && existing_identity["user_id"] == user_id
-      # no-op email already used
+      existing_identity['user_id'] != user_id &&
+        error!(:invalid, details: { 'email' => [{
+                 'description' => "Email #{params['email']} is already being used by another user",
+               },], })
     else
-      # add a new identity
-      user_identity_id = cistern.serial_id
-
-      user_identity = {
-        "id"         => user_identity_id,
-        "url"        => url_for("/users/#{user_id}/identities/#{user_identity_id}.json"),
-        "created_at" => Time.now.iso8601,
-        "updated_at" => Time.now.iso8601,
-        "type"       => "email",
-        "value"      => email,
-        "verified"   => false,
-        "primary"    => false,
-        "user_id"    => user_id,
-      }
-
-      cistern.data[:identities][user_identity_id] = user_identity
+      add_user_identity(email)
     end
 
-    mock_response("user" => self.find!(:users, user_id).merge!(user_params))
+    mock_response('user' => find!(:users, user_id).merge!(update_params))
+  end
+
+  private
+
+  def add_user_identity(email)
+    # add a new identity
+    user_identity_id = cistern.serial_id
+
+    user_identity = {
+      'id'         => user_identity_id,
+      'url'        => url_for("/users/#{user_id}/identities/#{user_identity_id}.json"),
+      'created_at' => Time.now.iso8601,
+      'updated_at' => Time.now.iso8601,
+      'type'       => 'email',
+      'value'      => email,
+      'verified'   => false,
+      'primary'    => false,
+      'user_id'    => user_id,
+    }
+
+    cistern.data[:identities][user_identity_id] = user_identity
   end
 end