zendesk2 1.9.0 → 1.10.0

data/lib/zendesk2/create_forum.rb

@@ -1,30 +1,31 @@
+# frozen_string_literal: true
 class Zendesk2::CreateForum
   include Zendesk2::Request
 
   request_method :post
-  request_path { |_| "/forums.json" }
-  request_body { |r| {"forum" => r.forum_params } }
+  request_path { |_| '/forums.json' }
+  request_body { |r| { 'forum' => r.forum_params } }
 
   def self.accepted_attributes
-    %w[name description category_id organization_id locale_id locked position forum_type access]
+    %w(name description category_id organization_id locale_id locked position forum_type access)
   end
 
   def forum_params
-    Cistern::Hash.slice(params.fetch("forum"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('forum'), *self.class.accepted_attributes)
   end
 
   def mock
     identity = cistern.serial_id
 
     record = {
-      "id"         => identity,
-      "url"        => url_for("/forums/#{identity}.json"),
-      "created_at" => Time.now.iso8601,
-      "updated_at" => Time.now.iso8601,
-    }.merge(Cistern::Hash.slice(params.fetch("forum"), *self.class.accepted_attributes))
+      'id'         => identity,
+      'url'        => url_for("/forums/#{identity}.json"),
+      'created_at' => Time.now.iso8601,
+      'updated_at' => Time.now.iso8601,
+    }.merge(Cistern::Hash.slice(params.fetch('forum'), *self.class.accepted_attributes))
 
     cistern.data[:forums][identity] = record
 
-    mock_response({"forum" => record}, {status: 201})
+    mock_response({ 'forum' => record }, { status: 201 })
   end
 end

data/lib/zendesk2/create_group.rb

@@ -1,31 +1,32 @@
+# frozen_string_literal: true
 class Zendesk2::CreateGroup
   include Zendesk2::Request
 
   request_method :post
-  request_path { |_| "/groups.json" }
-  request_body { |r|  { "group" => r.group_params } }
+  request_path { |_| '/groups.json' }
+  request_body { |r| { 'group' => r.group_params } }
 
   def self.accepted_attributes
-    %w[name]
+    %w(name)
   end
 
   def group_params
-    @_group_params ||= Cistern::Hash.slice(params.fetch("group"), *self.class.accepted_attributes)
+    @_group_params ||= Cistern::Hash.slice(params.fetch('group'), *self.class.accepted_attributes)
   end
 
-  def mock(params={})
+  def mock(_params = {})
     identity = cistern.serial_id
 
     record = {
-      "id"         => identity,
-      "url"        => url_for("/groups/#{identity}.json"),
-      "created_at" => Time.now.iso8601,
-      "updated_at" => Time.now.iso8601,
-      "deleted"    => false,
+      'id'         => identity,
+      'url'        => url_for("/groups/#{identity}.json"),
+      'created_at' => Time.now.iso8601,
+      'updated_at' => Time.now.iso8601,
+      'deleted'    => false,
     }.merge(group_params)
 
-    self.data[:groups][identity] = record
+    data[:groups][identity] = record
 
-    mock_response({"group" => record}, {status: 201})
+    mock_response({ 'group' => record }, { status: 201 })
   end
 end

data/lib/zendesk2/create_membership.rb

@@ -1,57 +1,58 @@
+# frozen_string_literal: true
 class Zendesk2::CreateMembership
   include Zendesk2::Request
 
   request_method :post
-  request_path { |r|  "/users/#{r.user_id}/organization_memberships.json" }
-  request_body { |r| { "organization_membership" => r.membership_params } }
+  request_path { |r| "/users/#{r.user_id}/organization_memberships.json" }
+  request_body { |r| { 'organization_membership' => r.membership_params } }
 
   def self.accepted_params
-    %w[user_id organization_id default]
+    %w(user_id organization_id default)
   end
 
   def membership_params
-    @_membership_params ||= Cistern::Hash.slice(params.fetch("membership"), *self.class.accepted_params)
+    @_membership_params ||= Cistern::Hash.slice(params.fetch('membership'), *self.class.accepted_params)
   end
 
   def user_id
-    params.fetch("membership").fetch("user_id").to_i
+    params.fetch('membership').fetch('user_id').to_i
   end
 
   def organization_id
-    params.fetch("membership").fetch("organization_id").to_i
+    params.fetch('membership').fetch('organization_id').to_i
   end
 
   def mock
     user = find!(:users, user_id)
     find!(:organizations, organization_id,
-          :error   => :invalid,
-          :details => {
-            "organization" => [ { "description" => "Organization cannot be blank" } ],
+          error: :invalid,
+          details: {
+            'organization' => [{ 'description' => 'Organization cannot be blank' }],
           })
 
-    if self.data[:memberships].values.find { |m| m["user_id"] == user_id && m["organization_id"] == organization_id }
-      error!(:invalid, description: { "user_id" => [ { "description" => "User has already been taken" } ] })
+    if data[:memberships].values.find { |m| m['user_id'] == user_id && m['organization_id'] == organization_id }
+      error!(:invalid, description: { 'user_id' => [{ 'description' => 'User has already been taken' }] })
     end
 
     resource_id = cistern.serial_id
 
-    default_membership = !self.data[:memberships].values.find { |m| m["user_id"] == user_id && m["default"] }
+    default_membership = !data[:memberships].values.find { |m| m['user_id'] == user_id && m['default'] }
 
     resource = {
-      "id"              => resource_id,
-      "user_id"         => user_id,
-      "organization_id" => organization_id,
-      "default"         => default_membership,
+      'id'              => resource_id,
+      'user_id'         => user_id,
+      'organization_id' => organization_id,
+      'default'         => default_membership,
     }
 
-    self.data[:memberships][resource_id] = resource
+    data[:memberships][resource_id] = resource
 
-    primary_organization = self.data[:memberships].values.find { |m| m["user_id"] == user_id && m["default"] }
+    primary_organization = data[:memberships].values.find { |m| m['user_id'] == user_id && m['default'] }
 
     if primary_organization
-      user.merge!("organization_id" => primary_organization["organization_id"])
+      user['organization_id'] = primary_organization['organization_id']
     end
 
-    mock_response("organization_membership" => resource)
+    mock_response('organization_membership' => resource)
   end
 end

data/lib/zendesk2/create_organization.rb

@@ -1,42 +1,48 @@
+# frozen_string_literal: true
 class Zendesk2::CreateOrganization
   include Zendesk2::Request
 
   request_method :post
-  request_path { |_| "/organizations.json" }
-  request_body { |r|  { "organization" => r.organization_params } }
+  request_path { |_| '/organizations.json' }
+  request_body { |r| { 'organization' => r.organization_params } }
 
   def self.accepted_attributes
-    %w[details domain_names external_id group_id organization_fields shared_comments shared_tickets tags name notes]
+    %w(details domain_names external_id group_id organization_fields shared_comments shared_tickets tags name notes)
   end
 
   def organization_params
-    @_organization_params ||= Cistern::Hash.slice(params.fetch("organization"), *self.class.accepted_attributes)
+    @_organization_params ||= Cistern::Hash.slice(params.fetch('organization'), *self.class.accepted_attributes)
   end
 
   def mock
     identity = cistern.serial_id
 
     record = {
-      "id"         => identity,
-      "url"        => url_for("/organizations/#{identity}.json"),
-      "created_at" => Time.now.iso8601,
-      "updated_at" => Time.now.iso8601,
-    }.merge(self.organization_params)
-
-    unless record["name"]
-      error!(:invalid, details: { "name" => [ { "description" => "Name cannot be blank" } ]})
+      'id'         => identity,
+      'url'        => url_for("/organizations/#{identity}.json"),
+      'created_at' => Time.now.iso8601,
+      'updated_at' => Time.now.iso8601,
+    }.merge(organization_params)
+
+    unless record['name']
+      error!(:invalid, details: { 'name' => [{ 'description' => 'Name cannot be blank' }] })
     end
 
-    if self.data[:organizations].values.find { |o| o["name"].downcase == record["name"].downcase }
-      error!(:invalid, details: {"name" => [ { "description" => "Name: has already been taken" } ]})
+    if data[:organizations].values.find { |o| o['name'].casecmp(record['name'].downcase).zero? }
+      error!(:invalid, details: { 'name' => [{ 'description' => 'Name: has already been taken' }] })
     end
 
-    if record["external_id"] && self.data[:organizations].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_organization = external_id && data[:organizations].values.find do |o|
+      o['external_id'].to_s.casecmp(external_id.to_s.downcase).zero?
     end
 
-    self.data[:organizations][identity] = record
+    if matching_organization
+      error!(:invalid, details: { 'name' => [{ 'description' => 'External has already been taken' }] })
+    end
+
+    data[:organizations][identity] = record
 
-    mock_response({"organization" => record}, {status: 201})
+    mock_response({ 'organization' => record }, { status: 201 })
   end
 end

data/lib/zendesk2/create_ticket.rb

@@ -1,86 +1,90 @@
+# frozen_string_literal: true
 class Zendesk2::CreateTicket
   include Zendesk2::Request
 
   request_method :post
-  request_path { |_| "/tickets.json" }
-  request_body { |r| {"ticket" => r.ticket_params} }
+  request_path { |_| '/tickets.json' }
+  request_body { |r| { 'ticket' => r.ticket_params } }
 
   def self.accepted_attributes
-    %w[external_id via priority requester requester_id submitter_id assignee_id organization_id subject description custom_fields recipient status collaborator_ids tags]
+    %w(external_id via priority requester requester_id submitter_id assignee_id organization_id subject description
+       custom_fields recipient status collaborator_ids tags)
   end
 
   def ticket_params
-    @_ticket_params ||= Cistern::Hash.slice(params.fetch("ticket"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('ticket'), *self.class.accepted_attributes)
   end
 
   def mock
-    create_params = ticket_params.dup
+    create_params = ticket_params
 
-    if create_params["description"].nil? || create_params["description"] == ""
-      error!(:invalid, :details => {"base" => [{"description" => "Description: cannot be blank"}]})
-    end
+    Zendesk2.blank?(create_params['description']) &&
+      error!(:invalid, details: { 'base' => [{ 'description' => 'Description: cannot be blank' }] })
 
     requester_id = create_params.delete('requester_id')
 
-    if requester = create_params.delete('requester')
-      if !requester['name'] || requester['name'].size < 1
-        error!(:invalid,
-          :details => {
-            "requester" => [
-              {
-                "description" => "Requester Name:  is too short (minimum is 1 characters)"
-              }
-            ]})
-      end
+    set_requester(create_params.delete('requester'), create_params)
+    custom_fields = get_custom_fields(create_params.delete('custom_fields') || [])
 
-      user_id = if known_user = cistern.users.search(email: requester['email']).first
-                  known_user.identity
-                else
-                  # name is not required in this case
-                  cistern.create_user("user" => requester).body["user"]["id"]
-                end
+    identity = cistern.serial_id
 
-      create_params['requester_id'] = user_id.to_i
-    end
+    record = {
+      'id'               => identity,
+      'url'              => url_for("/tickets/#{identity}.json"),
+      'created_at'       => Time.now.iso8601,
+      'updated_at'       => Time.now.iso8601,
+      'priority'         => nil,
+      'collaborator_ids' => [],
+      'custom_fields'    => custom_fields,
+    }.merge(create_params)
 
-    requested_custom_fields = (create_params.delete("custom_fields") || [])
+    record['requester_id'] ||= (requester_id && requester_id.to_i) || cistern.current_user['id']
+    record['submitter_id'] = cistern.current_user['id'].to_i
 
-    custom_fields = requested_custom_fields.map do |cf|
-      field_id = cf["id"].to_i
+    requester = cistern.data[:users][record['requester_id'].to_i]
 
-      if cistern.data[:ticket_fields][field_id]
-        {"id" => field_id, "value" => cf["value"] }
-      else
-        # @fixme error ?!
-      end
-    end.compact
+    record['organization_id'] ||= requester['organization_id'] if requester
 
-    cistern.data[:ticket_fields].each do |field_id, field|
-      requested_custom_fields.find { |cf| cf["id"] == field_id } ||
-        custom_fields << {"id" => field_id, "value" => nil }
-    end
+    cistern.data[:tickets][identity] = record
 
-    identity = cistern.serial_id
+    mock_response('ticket' => record)
+  end
 
-    record = {
-      "id"               => identity,
-      "url"              => url_for("/tickets/#{identity}.json"),
-      "created_at"       => Time.now.iso8601,
-      "updated_at"       => Time.now.iso8601,
-      "priority"         => nil,
-      "collaborator_ids" => [],
-      "custom_fields"    => custom_fields,
-    }.merge(create_params)
+  private
 
-    record["requester_id"] ||= (requester_id && requester_id.to_i) || cistern.current_user["id"]
-    record["submitter_id"] = cistern.current_user["id"].to_i
+  def set_requester(requester, create_params)
+    return unless requester
 
-    record["organization_id"] ||= if requester = cistern.data[:users][record["requester_id"].to_i]
-                                    requester["organization_id"]
-                                  end
+    Zendesk2.blank?(requester['name']) &&
+      error!(:invalid, details: {
+               'requester' => [
+                 {
+                   'description' => 'Requester Name:  is too short (minimum is 1 characters)',
+                 },
+               ],
+             })
 
-    cistern.data[:tickets][identity] = record
+    known_user = cistern.users.search(email: requester['email']).first
+
+    user_id = (known_user && known_user.identity) || cistern.create_user('user' => requester).body['user']['id']
+
+    create_params['requester_id'] = user_id.to_i
+  end
+
+  def get_custom_fields(requested_custom_fields)
+    custom_fields = requested_custom_fields.map do |cf|
+      field_id = cf['id'].to_i
+
+      if cistern.data[:ticket_fields][field_id]
+        { 'id' => field_id, 'value' => cf['value'] }
+      end
+    end.compact
+
+    cistern.data[:ticket_fields].each do |field_id, _field|
+      requested_custom_fields.find { |cf| cf['id'] == field_id } ||
+        custom_fields << { 'id' => field_id, 'value' => nil }
+    end
 
-    mock_response("ticket" => record)
+    custom_fields
   end
 end

data/lib/zendesk2/create_ticket_field.rb

@@ -1,42 +1,44 @@
+# frozen_string_literal: true
 class Zendesk2::CreateTicketField
   include Zendesk2::Request
 
   request_method :post
-  request_path { |_| "/ticket_fields.json" }
-  request_body { |r| { "ticket_field" => r.ticket_field_params } }
+  request_path { |_| '/ticket_fields.json' }
+  request_body { |r| { 'ticket_field' => r.ticket_field_params } }
 
   def self.accepted_attributes
-    %w[type title description position active required collapsed_for_agents regexp_for_validation title_in_portal visible_in_portal editable_in_portal required_in_portal tag custom_field_options]
+    %w(type title description position active required collapsed_for_agents regexp_for_validation title_in_portal
+       visible_in_portal editable_in_portal required_in_portal tag custom_field_options)
   end
 
   def ticket_field_params
-    Cistern::Hash.slice(params.fetch("ticket_field"), *self.class.accepted_attributes)
+    Cistern::Hash.slice(params.fetch('ticket_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("/ticket_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("/ticket_fields/#{identity}.json"),
+      'visible_in_portal'     => false,
     }.merge(ticket_field_params)
 
-    self.data[:ticket_fields][identity] = record
+    data[:ticket_fields][identity] = record
 
-    mock_response("ticket_field" => record)
+    mock_response('ticket_field' => record)
   end
 end