zendesk2 1.9.0 → 1.10.0

data/lib/zendesk2/create_topic.rb

@@ -1,30 +1,31 @@
+# frozen_string_literal: true
 class Zendesk2::CreateTopic
   include Zendesk2::Request
 
   request_method :post
-  request_body { |r| { "topic" => r.topic_params } }
-  request_path { |_| "/topics.json" }
+  request_body { |r| { 'topic' => r.topic_params } }
+  request_path { |_| '/topics.json' }
 
   def self.accepted_attributes
-    %w[title body submitter_id updater_id forum_id locked pinned highlighted position tags]
+    %w(title body submitter_id updater_id forum_id locked pinned highlighted position tags)
   end
 
   def topic_params
-    @_topic_params ||= Cistern::Hash.slice(params.fetch("topic"), *self.class.accepted_attributes)
+    @_topic_params ||= Cistern::Hash.slice(params.fetch('topic'), *self.class.accepted_attributes)
   end
 
   def mock
     identity = cistern.serial_id
 
     record = {
-      "id"         => identity,
-      "url"        => url_for("/topics/#{identity}.json"),
-      "created_at" => Time.now.iso8601,
-      "updated_at" => Time.now.iso8601,
+      'id'         => identity,
+      'url'        => url_for("/topics/#{identity}.json"),
+      'created_at' => Time.now.iso8601,
+      'updated_at' => Time.now.iso8601,
     }.merge(topic_params)
 
-    self.data[:topics][identity] = record
+    data[:topics][identity] = record
 
-    mock_response("topic" => record)
+    mock_response('topic' => record)
   end
 end

data/lib/zendesk2/create_topic_comment.rb

@@ -1,35 +1,36 @@
+# frozen_string_literal: true
 class Zendesk2::CreateTopicComment
   include Zendesk2::Request
 
   request_method :post
   request_path { |r| "/topics/#{r.topic_id}/comments.json" }
-  request_body { |r| { "topic_comment" => r.topic_comment_params } }
+  request_body { |r| { 'topic_comment' => r.topic_comment_params } }
 
   def self.accepted_attributes
-    %w[user_id body informative]
+    %w(user_id body informative)
   end
 
   def topic_id
-    params.fetch("topic_comment").fetch("topic_id").to_i
+    params.fetch('topic_comment').fetch('topic_id').to_i
   end
 
   def topic_comment_params
-    Cistern::Hash.slice(params.fetch("topic_comment"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('topic_comment'), *self.class.accepted_attributes)
   end
 
   def mock
     identity = cistern.serial_id
 
     record = {
-      "id"         => identity,
-      "url"        => url_for("/topics/#{topic_id}/comments/#{identity}.json"),
-      "created_at" => Time.now.iso8601,
-      "updated_at" => Time.now.iso8601,
-      "topic_id"   => self.topic_id,
+      'id'         => identity,
+      'url'        => url_for("/topics/#{topic_id}/comments/#{identity}.json"),
+      'created_at' => Time.now.iso8601,
+      'updated_at' => Time.now.iso8601,
+      'topic_id'   => topic_id,
     }.merge(topic_comment_params)
 
-    self.data[:topic_comments][identity] = record
+    data[:topic_comments][identity] = record
 
-    mock_response("topic_comment" => record)
+    mock_response('topic_comment' => record)
   end
 end

data/lib/zendesk2/create_user.rb

@@ -1,68 +1,81 @@
+# frozen_string_literal: true
 class Zendesk2::CreateUser
   include Zendesk2::Request
 
   request_method :post
-  request_path { |_| "/users.json" }
-  request_body { |r| { "user" => r.user_params } }
+  request_path { |_| '/users.json' }
+  request_body { |r| { 'user' => r.user_params } }
 
   def self.accepted_attributes
-    %w[name email organization_id external_id alias verified locate_id time_zone phone signature details notes role custom_role_id moderator ticket_restriction only_private_comments user_fields]
+    %w(name email organization_id external_id alias verified locate_id time_zone phone signature details notes role
+       custom_role_id moderator ticket_restriction only_private_comments user_fields)
   end
 
   def user_params
-    Cistern::Hash.slice(params.fetch("user"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('user'), *self.class.accepted_attributes)
   end
 
   def mock
     user_id = cistern.serial_id
 
-    user = params.fetch("user")
-
-    if organization_id = user["organization_id"]
-      self.find!(:organizations, organization_id)
-    end
+    user = params.fetch('user')
+    organization_id = user['organization_id']
+    organization_id && find!(:organizations, organization_id)
 
     record = {
-      "id"         => user_id,
-      "url"        => url_for("/users/#{user_id}.json"),
-      "created_at" => Time.now.iso8601,
-      "updated_at" => Time.now.iso8601,
-      "role"       => "end-user",
-      "active"     => true,
+      'id'         => user_id,
+      'url'        => url_for("/users/#{user_id}.json"),
+      'created_at' => Time.now.iso8601,
+      'updated_at' => Time.now.iso8601,
+      'role'       => 'end-user',
+      'active'     => true,
     }.merge(user_params)
 
-    if record["external_id"] && self.data[:users].values.find { |o| o["external_id"].to_s.downcase == record["external_id"].to_s.downcase }
-      error!(:invalid, details: {"name" => [ { "description" => "External has already been taken" } ]})
+    external_id = record['external_id']
+    matching_external_id = external_id && data[:users].values.find do |o|
+      o['external_id'].to_s.casecmp(external_id.to_s.downcase).zero?
+    end
+
+    if matching_external_id
+      error!(:invalid, details: { 'name' => [{ 'description' => 'External has already been taken' }] })
     end
 
-    if (email = record["email"]) && self.data[:identities].find { |k,i| i["type"] == "email" && i["value"].to_s.downcase == email.downcase }
-      error!(:invalid, :details => {
-        "email" => [ {
-          "description" => "Email: #{email} is already being used by another user"
-        }]})
-    else
-      user_identity_id = cistern.serial_id
+    email = record['email']
+    matching_identity = email && data[:identities].values.find do |i|
+      i['type'] == 'email' && i['value'].to_s.casecmp(email.downcase).zero?
+    end
+
+    if matching_identity
+      error!(:invalid, details: {
+               'email' => [{
+                 'description' => "Email: #{email} is already being used by another user",
+               },],
+             })
+    end
 
-      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"      => record["email"],
-        "verified"   => false,
-        "primary"    => true,
-        "user_id"    => user_id,
-      }
+    user_identity_id = cistern.serial_id
 
-      self.data[:identities][user_identity_id] = user_identity
-      self.data[:users][user_id] = record.reject { |k,v| k == "email" }
+    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'      => record['email'],
+      'verified'   => false,
+      'primary'    => true,
+      'user_id'    => user_id,
+    }
 
-      if organization_id
-        cistern.create_membership("membership" => { "user_id" => user_id, "organization_id" => organization_id, "default" => true } )
-      end
+    data[:identities][user_identity_id] = user_identity
+    data[:users][user_id] = record.reject { |k, _v| k == 'email' }
 
-      mock_response({"user" => record}, {status: 201})
+    if organization_id
+      cistern.create_membership(
+        'membership' => { 'user_id' => user_id, 'organization_id' => organization_id, 'default' => true }
+      )
     end
+
+    mock_response({ 'user' => record }, { status: 201 })
   end
 end

data/lib/zendesk2/create_user_field.rb

@@ -1,42 +1,43 @@
+# frozen_string_literal: true
 class Zendesk2::CreateUserField
   include Zendesk2::Request
 
   request_method :post
-  request_path { |_| "/user_fields.json" }
-  request_body { |r| { "user_field" => r.user_field_params } }
+  request_path { |_| '/user_fields.json' }
+  request_body { |r| { 'user_field' => r.user_field_params } }
 
   def self.accepted_attributes
-    %w[key type title description position active, regexp_for_validation tag custom_field_options]
+    %w(key type title description position active regexp_for_validation tag custom_field_options)
   end
 
   def user_field_params
-    Cistern::Hash.slice(params.fetch("user_field"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('user_field'), *self.class.accepted_attributes)
   end
 
   def mock
     identity = cistern.serial_id
 
     record = {
-      "active"                => true,
-      "collapsed_for_agents"  => false,
-      "created_at"            => Time.now.iso8601,
-      "description"           => params["title"],
-      "editable_in_portal"    => false,
-      "id"                    => identity,
-      "position"              => 9999,
-      "regexp_for_validation" => "",
-      "removable"             => true,
-      "required"              => false,
-      "required_in_portal"    => false,
-      "tag"                   => "",
-      "title_in_portal"       => params["title"],
-      "updated_at"            => Time.now.iso8601,
-      "url"                   => url_for("/user_fields/#{identity}.json"),
-      "visible_in_portal"     => false,
+      'active'                => true,
+      'collapsed_for_agents'  => false,
+      'created_at'            => Time.now.iso8601,
+      'description'           => params['title'],
+      'editable_in_portal'    => false,
+      'id'                    => identity,
+      'position'              => 9999,
+      'regexp_for_validation' => '',
+      'removable'             => true,
+      'required'              => false,
+      'required_in_portal'    => false,
+      'tag'                   => '',
+      'title_in_portal'       => params['title'],
+      'updated_at'            => Time.now.iso8601,
+      'url'                   => url_for("/user_fields/#{identity}.json"),
+      'visible_in_portal'     => false,
     }.merge(user_field_params)
 
     cistern.data[:user_fields][identity] = record
 
-    mock_response("user_field" => record)
+    mock_response('user_field' => record)
   end
 end

data/lib/zendesk2/create_user_identity.rb

@@ -1,43 +1,46 @@
+# frozen_string_literal: true
 class Zendesk2::CreateUserIdentity
   include Zendesk2::Request
 
   request_method :post
   request_path { |r| "/users/#{r.user_id}/identities.json" }
-  request_body { |r| { "identity" => r.user_identity_params } }
+  request_body { |r| { 'identity' => r.user_identity_params } }
 
   def self.accepted_attributes
-    %w[primary verified type value user_id]
+    %w(primary verified type value user_id)
   end
 
   def user_identity_params
-    Cistern::Hash.slice(params.fetch("user_identity"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('user_identity'), *self.class.accepted_attributes)
   end
 
   def user_id
-    params.fetch("user_identity").fetch("user_id").to_i
+    params.fetch('user_identity').fetch('user_id').to_i
   end
 
   def mock
     identity = cistern.serial_id
 
     record = {
-      "id"         => identity,
-      "url"        => url_for("/user/#{user_id}/identities/#{identity}.json"),
-      "created_at" => Time.now.iso8601,
-      "updated_at" => Time.now.iso8601,
-      "verified"   => false,
-      "primary"    => false,
-      "user_id"    => user_id,
+      'id'         => identity,
+      'url'        => url_for("/user/#{user_id}/identities/#{identity}.json"),
+      'created_at' => Time.now.iso8601,
+      'updated_at' => Time.now.iso8601,
+      'verified'   => false,
+      'primary'    => false,
+      'user_id'    => user_id,
     }.merge(user_identity_params)
 
-    record.merge("primary" => true) if cistern.data[:identities].values.find { |ui| ui["user_id"] == user_id }.nil?
+    record.merge('primary' => true) if cistern.data[:identities].values.find { |ui| ui['user_id'] == user_id }.nil?
 
-    if cistern.data[:identities].values.find { |i| i["value"] == record["value"] }
-      error!(:invalid, details: { "value" => [ { "description" => "Value: #{record["value"]} is already being used by another user" } ] })
+    if cistern.data[:identities].values.find { |i| i['value'] == record['value'] }
+      error!(:invalid, details: {
+               'value' => [{ 'description' => "Value: #{record['value']} is already being used by another user" }],
+             })
     end
 
     cistern.data[:identities][identity] = record
 
-    mock_response("identity" => record)
+    mock_response('identity' => record)
   end
 end

data/lib/zendesk2/create_view.rb

@@ -1,98 +1,98 @@
+# frozen_string_literal: true
 class Zendesk2::CreateView
   include Zendesk2::Request
 
   request_method :post
-  request_path { |_| "/views.json" }
-  request_body { |r| { "view" => r.view_params } }
+  request_path { |_| '/views.json' }
+  request_body { |r| { 'view' => r.view_params } }
 
   def self.accepted_attributes
-    %w[title all any active output restriction]
+    %w(title all any active output restriction)
   end
 
   def self.view_columns
     @_view_columns ||= {
-      "assigned"           => "Assigned date",
-      "assignee"           => "Assignee",
-      "brand"              => "Brand",
-      "created"            => "Request date",
-      "description"        => "Subject",
-      "due_date"           => "Due Date",
-      "group"              => "Group",
-      "locale_id"          => "Requester language",
-      "nice_id"            => "ID",
-      "organization"       => "Organization",
-      "priority"           => "Priority",
-      "requester"          => "Requester",
-      "satisfaction_score" => "Satisfaction",
-      "score"              => "Score",
-      "solved"             => "Solved date",
-      "status"             => "Status",
-      "submitter"          => "Submitter",
-      "ticket_form"        => "Ticket form",
-      "type"               => "Ticket type",
-      "updated"            => "Latest update",
-      "updated_assignee"   => "Latest update by assignee",
-      "updated_by_type"    => "Latest updater type (agent/end-user)",
-      "updated_requester"  => "Latest update by requester",
+      'assigned'           => 'Assigned date',
+      'assignee'           => 'Assignee',
+      'brand'              => 'Brand',
+      'created'            => 'Request date',
+      'description'        => 'Subject',
+      'due_date'           => 'Due Date',
+      'group'              => 'Group',
+      'locale_id'          => 'Requester language',
+      'nice_id'            => 'ID',
+      'organization'       => 'Organization',
+      'priority'           => 'Priority',
+      'requester'          => 'Requester',
+      'satisfaction_score' => 'Satisfaction',
+      'score'              => 'Score',
+      'solved'             => 'Solved date',
+      'status'             => 'Status',
+      'submitter'          => 'Submitter',
+      'ticket_form'        => 'Ticket form',
+      'type'               => 'Ticket type',
+      'updated'            => 'Latest update',
+      'updated_assignee'   => 'Latest update by assignee',
+      'updated_by_type'    => 'Latest updater type (agent/end-user)',
+      'updated_requester'  => 'Latest update by requester',
     }.freeze
   end
 
   def view_params
-    @_view_params ||= Cistern::Hash.slice(params.fetch("view"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('view'), *self.class.accepted_attributes)
   end
 
-  # {:status=>422, :headers=>{"server"=>"nginx", "date"=>"Fri, 10 Jul 2015 18:58:50 GMT", "content-type"=>"application/json; charset=UTF-8", "content-length"=>"262", "connection"=>"close", "status"=>"422 Unprocessable Entity", "x-zendesk-api-version"=>"v2", "x-frame-options"=>"SAMEORIGIN", "strict-transport-security"=>"max-age=31536000;", "x-ua-compatible"=>"IE=Edge,chrome=1", "cache-control"=>"no-cache", "x-zendesk-origin-server"=>"app5.pod5.iad1.zdsys.com", "x-request-id"=>"8dec47a7-f80d-4823-c8e2-b8ca3a6b1aa9", "x-runtime"=>"0.106400", "x-rack-cache"=>"invalidate, pass", "x-zendesk-request-id"=>"6efea4cc3c46093df8b1"}, :body=>{"error"=>"RecordInvalid", "description"=>"Record validation errors", "details"=>{"base"=>[{"description"=>"View must test for at least <strong>one</strong> of the following ticket properties in the ALL conditions section: Status, Type, Group, Assignee, Requester."}]}}}
-  # {:status=>400, :headers=>{"server"=>"nginx", "date"=>"Fri, 10 Jul 2015 18:58:39 GMT", "content-type"=>"application/json; charset=UTF-8", "content-length"=>"142", "connection"=>"close", "status"=>"400 Bad Request", "x-zendesk-api-version"=>"v2", "strict-transport-security"=>"max-age=31536000;", "x-ua-compatible"=>"IE=Edge,chrome=1", "cache-control"=>"no-cache", "x-zendesk-origin-server"=>"app5.pod5.iad1.zdsys.com", "x-request-id"=>"55216728-1c4b-49ce-c988-b8ca3a6b1a09", "x-runtime"=>"0.077761", "x-rack-cache"=>"invalidate, pass", "x-zendesk-request-id"=>"a49e204bdb7ceb6d22b2"}, :body=>{"error"=>{"title"=>"Invalid attribute", "message"=>"You passed an invalid value for the value attribute. must be a string"}}}
-  # {:status=>422, :headers=>{"server"=>"nginx", "date"=>"Fri, 10 Jul 2015 18:57:38 GMT", "content-type"=>"application/json; charset=UTF-8", "content-length"=>"326", "connection"=>"close", "status"=>"422 Unprocessable Entity", "x-zendesk-api-version"=>"v2", "x-frame-options"=>"SAMEORIGIN", "strict-transport-security"=>"max-age=31536000;", "x-ua-compatible"=>"IE=Edge,chrome=1", "cache-control"=>"no-cache", "x-zendesk-origin-server"=>"app19.pod5.iad1.zdsys.com", "x-request-id"=>"577927e1-1a98-4642-c636-b8ca3a6bdb18", "x-runtime"=>"0.114688", "x-rack-cache"=>"invalidate, pass", "x-zendesk-request-id"=>"6f646a8ab4e30717d593"}, :body=>{"error"=>"RecordInvalid", "description"=>"Record validation errors", "details"=>{"base"=>[{"description"=>"Organization 1 was deleted and cannot be used"}, {"description"=>"View must test for at least <strong>one</strong> of the following ticket properties in the ALL conditions section: Status, Type, Group, Assignee, Requester."}]}}}
   def mock
-    create_params = view_params.dup
+    create_params = view_params
 
-    if create_params["title"].nil? || create_params["title"] == ""
-      error!(:invalid, :details => {"base" => [{"title" => "Title: cannot be blank"}]})
+    if Zendesk2.blank?(create_params['title'])
+      error!(:invalid, details: { 'base' => [{ 'title' => 'Title: cannot be blank' }] })
     end
 
-    if Array(create_params["any"]).empty? && Array(create_params["all"]).empty?
-      error!(:invalid, :details => {"base" => ["Invalid conditions: You must select at least one condition"]})
+    if Array(create_params['any']).empty? && Array(create_params['all']).empty?
+      error!(:invalid, details: { 'base' => ['Invalid conditions: You must select at least one condition'] })
     end
 
     identity = cistern.serial_id
 
-    output = view_params.delete("output") || {}
-    columns = (output["columns"] || []).inject([]) { |r,c| r << {"id" => c, "name" => self.class.view_columns.fetch(c)} }
+    output = view_params.delete('output') || {}
+    columns = (output['columns'] || []).inject([]) do |a, e|
+      a << { 'id' => e, 'name' => self.class.view_columns.fetch(e) }
+    end
 
     record = {
-      "id"               => identity,
-      "url"              => url_for("/views/#{identity}.json"),
-      "created_at"       => Time.now.iso8601,
-      "updated_at"       => Time.now.iso8601,
-      "active"           => true,
-      "execution"        => {
-        "columns"       => columns,
-        "fields"        => columns,
-        "custom_fields" => [],
-        "group_by"      => create_params["group_by"],
-        "group_order"   => create_params["group_order"],
-        "sort_by"       => create_params["sort_by"],
-        "sort_order"    => create_params["sort_order"],
-        "sort" => {
-          "id"    => create_params["sort_by"],
-          "order" => create_params["sort_order"],
-          "title" => (create_params["sort_by"] && create_params["sort_by"].to_s.upcase),
+      'id'               => identity,
+      'url'              => url_for("/views/#{identity}.json"),
+      'created_at'       => Time.now.iso8601,
+      'updated_at'       => Time.now.iso8601,
+      'active'           => true,
+      'execution'        => {
+        'columns'       => columns,
+        'fields'        => columns,
+        'custom_fields' => [],
+        'group_by'      => create_params['group_by'],
+        'group_order'   => create_params['group_order'],
+        'sort_by'       => create_params['sort_by'],
+        'sort_order'    => create_params['sort_order'],
+        'sort' => {
+          'id'    => create_params['sort_by'],
+          'order' => create_params['sort_order'],
+          'title' => (create_params['sort_by'] && create_params['sort_by'].to_s.upcase),
         },
-        "group" => {
-          "id"    => create_params["group_by"],
-          "order" => create_params["group_order"],
-          "title" => (create_params["group_by"] && create_params["group_by"].to_s.upcase),
+        'group' => {
+          'id'    => create_params['group_by'],
+          'order' => create_params['group_order'],
+          'title' => (create_params['group_by'] && create_params['group_by'].to_s.upcase),
         },
       },
-      "conditions"    => {
-        "any" => Array(create_params["any"]),
-        "all" => Array(create_params["all"]),
+      'conditions' => {
+        'any' => Array(create_params['any']),
+        'all' => Array(create_params['all']),
       },
     }.merge(create_params)
 
     cistern.data[:views][identity] = record
 
-    mock_response("view" => record)
+    mock_response('view' => record)
   end
 end