lita-zendesk 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c98df925470543243c15a83d4fdcfb992700608
-  data.tar.gz: 5e6e5433eb861b713218f3d484baa41850bd0848
+  metadata.gz: 0ed3bd3957808a547668213958374125fed8ebe9
+  data.tar.gz: 9126e0044a74c67b1c20a9d8c5bc79f6a16c0735
 SHA512:
-  metadata.gz: e63a6e6268461a45dc92601236f85db370df275e52fde5c1f418f3513835598e7a73052d81900555c663b26cf4db412b43460b43ce30e8062db8c595054378a5
-  data.tar.gz: 76230b57b6a39cb7a72c3f911a4fda96bb3040eba1589d3d5911d3d829f266c825568f410d1d4971d3c8a91ea7cbcd21f7c6df1115d483f1ce449b619dde403b
+  metadata.gz: c6624b406255735ca9e35fb5e5ec8c7e908f1b96c421867b75970b26500407949ee668c4158744215596cba0fdcc0a5ec24c47cd66ce321cb0fbd21b3b924ba3
+  data.tar.gz: 06e78b27d1ee692b105de17f597909031676a2d657242581803ff160b86f29f1dde2c6058ff7426c1519401db33a1f8e4c86db349c8d393c18f269a8c1135f7d

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 CHANGELOG
 ---------
-- **2016-08-30**: 0.0.1
+- **0.0.5** - 2016-08-31
+  - Add free form ticket search
+- **0.0.2-0.0.4** - 2015-08-30 - 31
+  - Various bugfixes
+- **0.0.1** - 2016-08-30
   - Initial commit

data/README.md

@@ -44,6 +44,8 @@ end
 
 ```
 Lita > @lita help
+Lita: zd connection - returns information on the Zendesk connection
+Lita: zd search tickets <QUERY> - returns search results
 Lita: zd tickets - returns the total count of all unsolved tickets
 Lita: zd all tickets - returns the count of all tickets
 Lita: zd pending tickets - returns a count of tickets that are pending
@@ -75,7 +77,11 @@ Lita
 
 * https://www.lita.io/
 
-Ported and adapted from `hubot-scripts/zendesk.coffee`:
+Zendesk Search API
+
+* https://developer.zendesk.com/rest_api/docs/core/search
+
+Ported and enhanced from `hubot-scripts/zendesk.coffee`:
 
 * https://github.com/github/hubot-scripts/blob/master/src/scripts/zendesk.coffee
 

data/lib/lita/handlers/zendesk.rb

@@ -8,6 +8,8 @@ module Lita
       is_command = false
 
       VERSION_URL = 'api/v2'
+      QUERY_SEARCH_PREFIX = 'search.json?query='
+      QUERY_TICKETS_SEARCH = 'search.json?query=type:ticket '
       QUERY_TICKETS_ALL = 'tickets'
       QUERY_TICKETS_ESCALATED = 'search.json?query=tags:escalated+status:open+status:pending+type:ticket'
       QUERY_TICKETS_HOLD = 'search.json?query=status:hold+type:ticket'
@@ -23,7 +25,8 @@ module Lita
       config :token, type: String, default: ''
       config :password, type: String, default: ''
 
-      def init
+      def check_client(reload = false)
+        return if @conn && !reload
         @base_url = base_url
         @version_url = "#{@base_url}/#{VERSION_URL}"
         @tickets_url = "#{@base_url}/tickets"
@@ -54,45 +57,25 @@ module Lita
       end
 
       def zendesk_request(url)
-        init unless @conn
+        check_client
         if url.index('http') != 0
           url = "#{@version_url}/#{url}"
         end
         @conn.get url
       end
 
-      def ticket_count(response, url, ticket_type = '')
-        res = zendesk_request url
-        ticket_count = res.body['count']
-        ticket_word  = ticket_count == 1 ? 'ticket' : 'tickets'
-        ticket_desc  = ticket_type == '' ? '' : "#{ticket_type} "
-        response.reply "#{ticket_count} #{ticket_desc}#{ticket_word}."
-      end
-
-      def ticket_list(response, url, ticket_type = '')
-        res = zendesk_request url
-        tickets = res.body['results']
-        tickets.each do |ticket|
-          response.reply "Ticket #{ticket['id']} is #{ticket['status']}: #{@tickets_url}/#{ticket['id']} - #{ticket['subject']}"
-        end
-        ticket_length = tickets.length
-        ticket_count = res.body['count']
-        ticket_word  = ticket_count == 1 ? 'ticket' : 'tickets'
-        ticket_desc  = ticket_type == '' ? '' : "#{ticket_type} "
-        response.reply "Listing #{ticket_length} of #{ticket_count} #{ticket_desc}#{ticket_word}."
-      end
-
-      def tickets(count)
-        count == 1 ? 'ticket' : 'tickets'
-      end
-
-      # Info
+      # General
 
       route(/^(?:zd|zendesk)\s+connection\s*$/, :zd_instance_info, command: true, help: { 'zd connection' => 'returns information on the Zendesk connection' })
       def zd_instance_info(response)
         response.reply "Using Zendesk instance at: #{base_url}"
       end
 
+      route(/^(?:zd|zendesk)\s+search\s+tickets?\s+(\S.*?)\s*$/, :search_tickets, command: true, help: { 'zd search tickets <QUERY>' => 'returns search results' })
+      def search_tickets(response)
+        ticket_search response, QUERY_TICKETS_SEARCH, response.matches[0][0]
+      end
+
       # Ticket Counts
 
       route(/^(?:zd|zendesk)(\s+unsolved)?\s+tickets?\s*$/, :unsolved_tickets, command: true, help: { 'zd tickets' => 'returns the total count of all unsolved tickets' })
@@ -184,6 +167,46 @@ module Lita
         message += "\nDescription:\n-----\n#{data['ticket']['description']}\n-----\n"
         response.reply message
       end
+
+      private
+
+      def ticket_count(response, url, ticket_type = '')
+        res = zendesk_request url
+        ticket_count = res.body['count']
+        ticket_word  = ticket_count == 1 ? 'ticket' : 'tickets'
+        ticket_desc  = ticket_type == '' ? '' : "#{ticket_type} "
+        response.reply "#{ticket_count} #{ticket_desc}#{ticket_word}."
+      end
+
+      def ticket_search(response, url, query)
+        url += query
+        res = zendesk_request url
+        tickets = res.body['results']
+        tickets.each do |ticket|
+          response.reply "Ticket #{ticket['id']} is #{ticket['status']}: #{@tickets_url}/#{ticket['id']} - #{ticket['subject']}"
+        end
+        ticket_length = tickets.length
+        ticket_count = res.body['count']
+        ticket_word  = ticket_count == 1 ? 'result' : 'results'
+        response.reply "Listing #{ticket_length} of #{ticket_count} matching #{ticket_word}."
+      end
+
+      def ticket_list(response, url, ticket_type = '')
+        res = zendesk_request url
+        tickets = res.body['results']
+        tickets.each do |ticket|
+          response.reply "Ticket #{ticket['id']} is #{ticket['status']}: #{@tickets_url}/#{ticket['id']} - #{ticket['subject']}"
+        end
+        ticket_length = tickets.length
+        ticket_count = res.body['count']
+        ticket_word  = ticket_count == 1 ? 'ticket' : 'tickets'
+        ticket_desc  = ticket_type == '' ? '' : "#{ticket_type} "
+        response.reply "Listing #{ticket_length} of #{ticket_count} #{ticket_desc}#{ticket_word}."
+      end
+
+      def tickets(count)
+        count == 1 ? 'ticket' : 'tickets'
+      end
     end
 
     Lita.register_handler(Zendesk)

data/lita-zendesk.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-zendesk'
   spec.date          = '2016-08-31'
-  spec.version       = '0.0.4'
+  spec.version       = '0.0.5'
   spec.authors       = ['John Wang']
-  spec.email         = ["johncwang@gmail.com"]
+  spec.email         = ['johncwang@gmail.com']
   spec.description   = %q{A Zendesk handler for Lita.}
   spec.summary       = %q{A Zendesk handler for the Lita chatbot.}
   spec.homepage      = 'https://github.com/grokify/lita-zendesk'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-zendesk
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - John Wang