zendesk2 1.9.0 → 1.10.0

data/lib/zendesk2/search.rb

@@ -1,29 +1,30 @@
+# frozen_string_literal: true
 class Zendesk2::Search
   include Zendesk2::Request
 
   request_method :get
   request_body { |r| { query: r.query } }
-  request_path { |_| "/search.json" }
+  request_path { |_| '/search.json' }
 
   page_params!
 
   attr_reader :query
 
-  def _mock(query, params={})
+  def _mock(query, params = {})
     @query = query
     setup(params)
     mock
   end
 
-  def _real(query, params={})
+  def _real(query, params = {})
     @query = query
     setup(params)
     real
   end
 
   def mock
-    terms = Hash[query.split(" ").map { |t| t.split(":") }]
-    type  = terms.delete("type")
+    terms = Hash[query.split(' ').map { |t| t.split(':') }]
+    type  = terms.delete('type')
 
     collection = if type.nil?
                    cistern.data.values
@@ -31,8 +32,8 @@ class Zendesk2::Search
                    cistern.data[pluralize(type).to_sym]
                  end
 
-    results = collection.values.select { |v| terms.all?{ |term, condition| v[term].to_s == condition.to_s } }
+    results = collection.values.select { |v| terms.all? { |term, condition| v[term].to_s == condition.to_s } }
 
-    page(results, params: {"query" => query}, root: "results")
+    page(results, params: { 'query' => query }, root: 'results')
   end
 end

data/lib/zendesk2/search_organization.rb

@@ -1,40 +1,40 @@
+# frozen_string_literal: true
 class Zendesk2::SearchOrganization
   include Zendesk2::Request
 
   request_method :get
-  request_path { "/search.json" }
-  request_body { |r| { "query" => r.query } }
+  request_path { '/search.json' }
+  request_body { |r| { 'query' => r.query } }
 
   attr_reader :query
 
   page_params!
 
-  def _mock(query, params={})
+  def _mock(query, params = {})
     @query = query
     setup(params)
     mock
   end
 
-  def _real(query, params={})
+  def _real(query, params = {})
     @query = query
     setup(params)
     real
   end
 
   def mock
-    terms = Hash[query.split(" ").map { |t| t.split(":") }]
-    terms.delete("type") # context already provided
+    terms = Hash[query.split(' ').map { |t| t.split(':') }]
+    terms.delete('type') # context already provided
 
-    collection = self.data[:organizations].values
+    collection = data[:organizations].values
 
     # organization name is fuzzy matched
-    if organization_name = terms.delete("name")
-      terms.merge!("name" => "*#{organization_name}*")
-    end
+    organization_name = terms.delete('name')
+    organization_name && terms['name'] = "*#{organization_name}*"
 
-    compiled_terms = terms.inject({}) do |r,(term, raw_condition)|
-      condition = if raw_condition.include?("*")
-                    Regexp.compile(raw_condition.gsub("*", ".*"), Regexp::IGNORECASE)
+    compiled_terms = terms.inject({}) do |r, (term, raw_condition)|
+      condition = if raw_condition.include?('*')
+                    Regexp.compile(raw_condition.gsub('*', '.*'), Regexp::IGNORECASE)
                   else
                     raw_condition
                   end
@@ -47,6 +47,6 @@ class Zendesk2::SearchOrganization
       end
     end
 
-    page(results, params: {"query" => query}, root: "results")
+    page(results, params: { 'query' => query }, root: 'results')
   end
 end

data/lib/zendesk2/search_user.rb

@@ -1,56 +1,36 @@
+# frozen_string_literal: true
 class Zendesk2::SearchUser
   include Zendesk2::Request
 
   request_method :get
-  request_path { "/search.json" }
-  request_body { |r| { "query" => r.query } }
+  request_path { '/search.json' }
+  request_body { |r| { 'query' => r.query } }
 
   attr_reader :query
 
   page_params!
 
-  def _mock(query, params={})
+  def _mock(query, params = {})
     @query = query
     setup(params)
     mock
   end
 
-  def _real(query, params={})
+  def _real(query, params = {})
     @query = query
     setup(params)
     real
   end
 
   def mock
-    terms = Hash[query.split(" ").map { |t| t.split(":") }]
-    terms.delete("type") # context already provided
+    terms = Hash[query.split(' ').map { |t| t.split(':') }]
+    terms.delete('type') # context already provided
 
-    collection = self.data[:users].values
+    collection = searchable_collection(terms)
 
-    # create a copy of each user mapped to a specific user identity
-    collection = collection.map do |user|
-      self.data[:identities].values.select { |i| i["type"] == "email" && i["user_id"] == user["id"] }.map do |identity|
-        user.merge("email" => identity["value"])
-      end
-    end.flatten
-
-    # allow searching by organization name
-    collection = collection.map do |user|
-      if organization = self.data[:organizations][user["organization_id"].to_i]
-        user.merge("organization" => organization["name"])
-      else
-        user
-      end
-    end
-
-    # organization name is fuzzy matched
-    if organization_name = terms.delete("organization")
-      terms.merge!("organization" => "*#{organization_name}*")
-    end
-
-    compiled_terms = terms.inject({}) do |r,(term, raw_condition)|
-      condition = if raw_condition.include?("*")
-                    Regexp.compile(raw_condition.gsub("*", ".*"), Regexp::IGNORECASE)
+    compiled_terms = terms.inject({}) do |r, (term, raw_condition)|
+      condition = if raw_condition.include?('*')
+                    Regexp.compile(raw_condition.gsub('*', '.*'), Regexp::IGNORECASE)
                   else
                     raw_condition
                   end
@@ -64,14 +44,38 @@ class Zendesk2::SearchUser
     end
 
     # return the unmunged data
-    results = munged_results.map { |u|
-      identities = self.data[:identities].values.select { |i| i["user_id"] == u["id"] }
+    results = munged_results.map do |u|
+      identities = data[:identities].values.select { |i| i['user_id'] == u['id'] }
+      identity = identities.find { |i| i['type'] == 'email' && i['primary'] } ||
+                 identities.find { |i| i['type'] == 'email' }
+      u.merge!('email' => identity['value']) if identity
+    end
 
-      if identity = identities.find { |i| i["type"] == "email" && i["primary"] } || identities.find { |i| i["type"] == "email" }
-        u.merge!("email" => identity["value"])
+    page(results, params: { 'query' => query }, root: 'results')
+  end
+
+  private
+
+  def searchable_collection(terms)
+    collection = data[:users].values
+
+    # create a copy of each user mapped to a specific user identity
+    collection = collection.map do |user|
+      data[:identities].values.select { |i| i['type'] == 'email' && i['user_id'] == user['id'] }.map do |identity|
+        user.merge('email' => identity['value'])
       end
-    }
+    end.flatten
+
+    # allow searching by organization name
+    collection = collection.map do |user|
+      organization = data[:organizations][user['organization_id'].to_i]
+      organization ? user.merge('organization' => organization['name']) : user
+    end
+
+    # organization name is fuzzy matched
+    organization_name = terms.delete('organization')
+    organization_name && terms['organization'] = "*#{organization_name}*"
 
-    page(results, params: {"query" => query}, root: "results")
+    collection
   end
 end

data/lib/zendesk2/searchable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+# Defines {#search} on relevant collections
 module Zendesk2::Searchable
   def self.included(klass)
     klass.send(:extend, Zendesk2::Searchable::Attributes)
@@ -17,39 +19,47 @@ module Zendesk2::Searchable
   #
   # @param [String, Hash] seach terms.  This will be converted to a qualified Zendesk search String
   # @see http://developer.zendesk.com/documentation/rest_api/search.html
-  def search(terms, params={})
-    query = if terms.is_a?(Hash)
-              terms.merge!("type" => self.class.search_type) if self.class.search_type
-              terms.merge(self.class.scopes.inject({}) { |r,k|
-                val = public_send(k)
-                val.nil? ? r : r.merge(k.to_s => val)
-              }).map { |k,v| "#{k}:#{v}" }.join(" ")
-            else
-              additional_terms = []
-              additional_terms = ["type:#{self.class.search_type}"] if self.class.search_type
-              additional_terms += self.class.scopes.inject([]) { |r,k|
-                val = public_send(k)
-                val.nil? ? r : ["#{k}:#{val}"]
-              }
-
-              additional_terms.inject(terms.to_s) do |qualified_search, qualification|
-                if !qualified_search.include?(qualification)
-                  "#{qualified_search} #{qualification}"
-                else
-                  qualified_search
-                end
-              end
-            end
+  def search(terms, params = {})
+    query = (terms.is_a?(Hash) ? search_by_hash(terms) : search_by_string(terms))
 
     body = cistern.send(self.class.search_request, query, params).body
+    data = body.delete('results')
 
-    if data = body.delete("results")
-      self.load(data)
-      self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page").merge("filtered" => true))
+    if data
+      load(data)
+      merge_attributes(Cistern::Hash.slice(body, 'count', 'next_page', 'previous_page').merge('filtered' => true))
       self
     end
   end
 
+  private
+
+  def search_by_hash(terms)
+    terms['type'] = self.class.search_type if self.class.search_type
+    terms.merge(self.class.scopes.inject({}) do |r, k|
+      val = public_send(k)
+      val.nil? ? r : r.merge(k.to_s => val)
+    end,).map { |k, v| "#{k}:#{v}" }.join(' ',)
+  end
+
+  def search_by_string(terms)
+    additional_terms = []
+    additional_terms = ["type:#{self.class.search_type}"] if self.class.search_type
+    additional_terms += self.class.scopes.inject([]) do |r, k|
+      val = public_send(k)
+      val.nil? ? r : ["#{k}:#{val}"]
+    end
+
+    additional_terms.inject(terms.to_s) do |qualified_search, qualification|
+      if !qualified_search.include?(qualification)
+        "#{qualified_search} #{qualification}"
+      else
+        qualified_search
+      end
+    end
+  end
+
+  # define {#search_request} for atypical searches
   module Attributes
     attr_accessor :search_type
     attr_writer :search_request

data/lib/zendesk2/ticket.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::Ticket
   include Zendesk2::Model
 
@@ -27,7 +28,8 @@ class Zendesk2::Ticket
   attribute :has_incidents, type: :boolean
   # @return [Integer] The organization of the requester
   attribute :organization_id, type: :integer
-  # @return [String] Priority, defines the urgency with which the ticket should be addressed: "urgent", "high", "normal", "low"
+  # @return [String] Priority, defines the urgency with which the ticket should be addressed:
+  #   "urgent", "high", "normal", "low"
   attribute :priority, type: :string
   # @return [Integer] The problem this incident is linked to, if any
   attribute :problem_id, type: :integer
@@ -67,17 +69,17 @@ class Zendesk2::Ticket
     data = if new_record?
              requires :subject, :description
 
-             create_attributes = self.attributes.dup
+             create_attributes = attributes.dup
 
-             if with_requester = (@requester || nil) && Zendesk2.stringify_keys(@requester)
-               create_attributes.merge!("requester" => with_requester)
-             end
+             with_requester = (@requester || nil) && Zendesk2.stringify_keys(@requester)
 
-             cistern.create_ticket("ticket" => create_attributes).body["ticket"]
+             with_requester && create_attributes['requester'] = with_requester
+
+             cistern.create_ticket('ticket' => create_attributes).body['ticket']
            else
              requires :identity
 
-             cistern.update_ticket("ticket" => self.attributes).body["ticket"]
+             cistern.update_ticket('ticket' => attributes).body['ticket']
            end
 
     merge_attributes(data)
@@ -86,7 +88,7 @@ class Zendesk2::Ticket
   def destroy!
     requires :identity
 
-    cistern.destroy_ticket("ticket" => {"id" => self.identity})
+    cistern.destroy_ticket('ticket' => { 'id' => identity })
   end
 
   # Adds a ticket comment
@@ -96,26 +98,26 @@ class Zendesk2::Ticket
   # @option options [Array] :attachments Attachment to upload with comment
   # @option options [Boolean] :public (true)
   # @return [Zendesk2::TicketComment]
-  def comment(text, options={})
+  def comment(text, options = {})
     requires :identity
 
     options[:public] = true if options[:public].nil?
 
-    comment = Zendesk2.stringify_keys(options).merge("body" => text)
+    comment = Zendesk2.stringify_keys(options).merge('body' => text)
 
     cistern.ticket_comments.new(
       cistern.update_ticket(
-        "ticket" => {
-          "id"      => self.identity,
-          "comment" => comment,
+        'ticket' => {
+          'id'      => identity,
+          'comment' => comment,
         }
-      ).body["audit"]["events"].first
+      ).body['audit']['events'].first
     )
   end
 
   # @return [Array<Zendesk2::User>] All users CCD on this ticket
   def collaborators
-    self.collaborator_ids.map { |cid| self.cistern.users.get(cid) }
+    collaborator_ids.map { |cid| cistern.users.get(cid) }
   end
 
   # Update list of users to be CCD on this ticket
@@ -126,16 +128,16 @@ class Zendesk2::Ticket
 
   # @return [Zendesk2::TicketAudits] all audits for this ticket
   def audits
-    self.cistern.ticket_audits(ticket_id: self.identity).all
+    cistern.ticket_audits(ticket_id: identity).all
   end
 
   # @return [Zendesk2::TicketMetric] metrics for this ticket
   def metrics
-    Zendesk2::TicketMetric.new(self.cistern.get_ticket_metric("ticket_id" => self.identity).body["ticket_metric"])
+    Zendesk2::TicketMetric.new(cistern.get_ticket_metric('ticket_id' => identity).body['ticket_metric'])
   end
 
   # @return [Array<Zendesk2::TicketComment>] all comments for this ticket
   def comments
-    self.cistern.ticket_comments(ticket_id: self.identity).all
+    cistern.ticket_comments(ticket_id: identity).all
   end
 end

data/lib/zendesk2/ticket_audit.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::TicketAudit
   include Zendesk2::Model
 
@@ -21,12 +22,12 @@ class Zendesk2::TicketAudit
   def ticket
     requires :ticket_id
 
-    self.cistern.tickets.get(self.ticket_id)
+    cistern.tickets.get(ticket_id)
   end
 
   def events
-    (self.attributes[:events] || []).map { |ae|
-      Zendesk2::AuditEvent.for(ae.merge(ticket_audit: self, cistern: self.cistern))
-    }
+    (attributes[:events] || []).map do |ae|
+      Zendesk2::AuditEvent.for(ae.merge(ticket_audit: self, cistern: cistern))
+    end
   end
 end

data/lib/zendesk2/ticket_audits.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::TicketAudits
   include Zendesk2::Collection
 
@@ -8,30 +9,28 @@ class Zendesk2::TicketAudits
   attribute :ticket_id, type: :integer
 
   self.collection_method = :get_ticket_audits
-  self.collection_root   = "audits"
+  self.collection_root   = 'audits'
   self.model_method      = :get_ticket_audit
-  self.model_root        = "audit"
+  self.model_root        = 'audit'
 
   def ticket
-    self.cistern.tickets.get(self.ticket_id)
+    cistern.tickets.get(ticket_id)
   end
 
-  def all(params={})
+  def all(params = {})
     requires :ticket_id
 
-    body = cistern.send(collection_method, {"ticket_id" => self.ticket_id}.merge(params)).body
+    body = cistern.send(collection_method, { 'ticket_id' => ticket_id }.merge(params)).body
 
-    collection = self.clone.load(body[collection_root])
-    collection.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+    collection = clone.load(body[collection_root])
+    collection.merge_attributes(Cistern::Hash.slice(body, 'count', 'next_page', 'previous_page'))
     collection
   end
 
   def get(id)
     requires :ticket_id
-
-    if data = self.cistern.send(model_method, {"ticket_id" => self.ticket_id, "id" => id}).body[self.model_root]
-      new(data)
-    end
+    data = cistern.send(model_method, 'ticket_id' => ticket_id, 'id' => id).body[model_root]
+    new(data) if data
   rescue Zendesk2::Error
     nil
   end