lita-zendesk 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ed3bd3957808a547668213958374125fed8ebe9
-  data.tar.gz: 9126e0044a74c67b1c20a9d8c5bc79f6a16c0735
+  metadata.gz: f63a7f1bbf0fd4a6a93e619e1f763fd63e995393
+  data.tar.gz: 8d74f5d3f2c59e1b9a505b63eb3d510460ce51b0
 SHA512:
-  metadata.gz: c6624b406255735ca9e35fb5e5ec8c7e908f1b96c421867b75970b26500407949ee668c4158744215596cba0fdcc0a5ec24c47cd66ce321cb0fbd21b3b924ba3
-  data.tar.gz: 06e78b27d1ee692b105de17f597909031676a2d657242581803ff160b86f29f1dde2c6058ff7426c1519401db33a1f8e4c86db349c8d393c18f269a8c1135f7d
+  metadata.gz: 21f85ea9ec84d9e7cc735408da833d378e7939d319957ed8fe20b17104bd058bb6231fc1ad748095fa505ec186c5f5830059c1018153f36b23827489e95d1c84
+  data.tar.gz: 8500af1c1e8f18900892da420e741130335b3147a29fb197623af66669da48291faf197df75a24abf1ca977c045b47c5a5e1d92939524eba1238e43e4ac71858

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 CHANGELOG
 ---------
+- **0.0.6** - 2016-09-05
+  - Make routes case insensitive
+  - Add additional logging
 - **0.0.5** - 2016-08-31
   - Add free form ticket search
 - **0.0.2-0.0.4** - 2015-08-30 - 31

data/README.md

@@ -35,6 +35,9 @@ Lita.configure do |config|
   config.handlers.zendesk.password = 'my_zendesk_password'
   config.handlers.zendesk.token = 'my_zendesk_token'
 
+  # Optional config
+  config.handlers.zendesk.use_command = false # defaults to true
+
 end
 ```
 

data/lib/lita/handlers/zendesk.rb

@@ -2,10 +2,11 @@ require 'base64'
 require 'faraday'
 require 'faraday_middleware'
 
+require 'pp'
+
 module Lita
   module Handlers
     class Zendesk < Handler
-      is_command = false
 
       VERSION_URL = 'api/v2'
       QUERY_SEARCH_PREFIX = 'search.json?query='
@@ -19,6 +20,8 @@ module Lita
       QUERY_TICKETS_UNSOLVED = 'search.json?query=status<solved+type:ticket'
       QUERY_USERS = 'users'
 
+      config :use_command, types: [TrueClass, FalseClass], default: true
+
       config :subdomain, type: String, required: true
       config :auth_type, type: String, default: 'password' # or token
       config :user, type: String, required: true
@@ -66,94 +69,95 @@ module Lita
 
       # General
 
-      route(/^(?:zd|zendesk)\s+connection\s*$/, :zd_instance_info, command: true, help: { 'zd connection' => 'returns information on the Zendesk connection' })
+      route(/^(?:zd|zendesk)\s+connection\s*$/i, :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' })
+      route(/^(?:zd|zendesk)\s+search\s+tickets?\s+(\S.*?)\s*$/i, :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' })
+      route(/^(?:zd|zendesk)(\s+unsolved)?\s+tickets?\s*$/i, :unsolved_tickets, command: true, help: { 'zd tickets' => 'returns the total count of all unsolved tickets' })
       def unsolved_tickets(response)
         ticket_count response, QUERY_TICKETS_UNSOLVED, 'unsolved'
       end
 
-      route(/^(?:zd|zendesk)\s+(all|total)\s+tickets?\s*$/, :total_tickets, command: true, help: { 'zd all tickets' => 'returns the count of all tickets' })
+      route(/^(?:zd|zendesk)\s+(all|total)\s+tickets?\s*$/i, :total_tickets, command: true, help: { 'zd all tickets' => 'returns the count of all tickets' })
       def total_tickets(response)
         ticket_count response, QUERY_TICKETS_ALL, 'total'
       end
 
-      route(/^(?:zd|zendesk)\s+pending\s+tickets?\s*$/, :pending_tickets, command: true, help: { 'zd pending tickets' => 'returns a count of tickets that are pending' })
+      route(/^(?:zd|zendesk)\s+pending\s+tickets?\s*$/i, :pending_tickets, command: true, help: { 'zd pending tickets' => 'returns a count of tickets that are pending' })
       def pending_tickets(response)
         ticket_count response, QUERY_TICKETS_PENDING, 'pending'
       end
 
-      route(/^(?:zd|zendesk)\s+new\s+tickets?\s*$/, :new_tickets, command: true, help: { 'zd new tickets' => 'returns the count of all new (unassigned) tickets' })
+      route(/^(?:zd|zendesk)\s+new\s+tickets?\s*$/i, :new_tickets, command: true, help: { 'zd new tickets' => 'returns the count of all new (unassigned) tickets' })
       def new_tickets(response)
         ticket_count response, QUERY_TICKETS_NEW, 'new'
       end
 
-      route(/^(?:zd|zendesk)\s+escalated\s+tickets?\s*$/, :escalated_tickets, command: true, help: { 'zd escalated tickets' => 'returns a count of tickets with escalated tag that are open or pending' })
+      route(/^(?:zd|zendesk)\s+escalated\s+tickets?\s*$/i, :escalated_tickets, command: true, help: { 'zd escalated tickets' => 'returns a count of tickets with escalated tag that are open or pending' })
       def escalated_tickets(response)
         ticket_count response, QUERY_TICKETS_ESCALATED, 'escalated'
       end
 
-      route(/^(?:zd|zendesk)\s+open\s+tickets?\s*$/, :open_tickets, command: true, help: { 'zd open tickets' => 'returns the count of all open tickets' })
+      route(/^(?:zd|zendesk)\s+open\s+tickets?\s*$/i, :open_tickets, command: true, help: { 'zd open tickets' => 'returns the count of all open tickets' })
       def open_tickets(response)
         ticket_count response, QUERY_TICKETS_OPEN, 'open'
       end
 
-      route(/^(?:zd|zendesk)\s+on\s+hold\s+tickets?\s*$/, :onhold_tickets, command: true, help: { 'zd on hold tickets' => 'returns the count of all on hold tickets' })
+      route(/^(?:zd|zendesk)\s+on\s+hold\s+tickets?\s*$/i, :onhold_tickets, command: true, help: { 'zd on hold tickets' => 'returns the count of all on hold tickets' })
       def onhold_tickets(response)
         ticket_count response, QUERY_TICKETS_HOLD, 'on hold'
       end
 
       # Ticket Lists
 
-      route(/^(?:zd|zendesk)\s+list(\s+unsolved)?\s+tickets?\s*$/, :unsolved_tickets_list, command: true, help: { 'zd list tickets' => 'returns a list of unsolved tickets' })
+      route(/^(?:zd|zendesk)\s+list(\s+unsolved)?\s+tickets?\s*$/i, :unsolved_tickets_list, command: true, help: { 'zd list tickets' => 'returns a list of unsolved tickets' })
       def unsolved_tickets_list(response)
         ticket_list response, QUERY_TICKETS_UNSOLVED, 'unsolved'
       end
 
-      route(/^(?:zd|zendesk)\s+list\s+(all|total)\s+tickets?\s*$/, :total_tickets_list, command: true, help: { 'zd list all tickets' => 'returns a list of all tickets' })
+      route(/^(?:zd|zendesk)\s+list\s+(all|total)\s+tickets?\s*$/i, :total_tickets_list, command: true, help: { 'zd list all tickets' => 'returns a list of all tickets' })
       def total_tickets_list(response)
         ticket_list response, QUERY_TICKETS_ALL, 'total'
       end
 
-      route(/^(?:zd|zendesk)\s+list\s+pending\s+tickets?\s*$/, :pending_tickets_list, command: true, help: { 'zd list pending tickets' => 'returns a list of pending tickets' })
+      route(/^(?:zd|zendesk)\s+list\s+pending\s+tickets?\s*$/i, :pending_tickets_list, command: true, help: { 'zd list pending tickets' => 'returns a list of pending tickets' })
       def pending_tickets_list(response)
         ticket_list response, QUERY_TICKETS_PENDING, 'pending'
       end
 
-      route(/^(?:zd|zendesk)\s+list\s+new\s+tickets?\s*$/, :new_tickets_list, command: true, help: { 'zd list new tickets' => 'returns a list of new tickets' })
+      route(/^(?:zd|zendesk)\s+list\s+new\s+tickets?\s*$/i, :new_tickets_list, command: true, help: { 'zd list new tickets' => 'returns a list of new tickets' })
       def new_tickets_list(response)
         ticket_list response, QUERY_TICKETS_NEW, 'new'
       end
 
-      route(/^(?:zd|zendesk)\s+list\s+escalated\s+tickets?\s*$/, :escalated_tickets_list, command: true, help: { 'zd list esclated tickets' => 'returns a list of escalated tickets' })
+      route(/^(?:zd|zendesk)\s+list\s+escalated\s+tickets?\s*$/i, :escalated_tickets_list, command: true, help: { 'zd list esclated tickets' => 'returns a list of escalated tickets' })
       def escalated_tickets_list(response)
         ticket_list response, QUERY_TICKETS_ESCALATED, 'escalated'
       end
 
-      route(/^(?:zd|zendesk)\s+list\s+open\s+tickets?\s*$/, :open_tickets_list, command: true, help: { 'zd list open tickets' => 'returns a list of open tickets' })
+      route(/^(?:zd|zendesk)\s+list\s+open\s+tickets?\s*$/i, :open_tickets_list, command: true, help: { 'zd list open tickets' => 'returns a list of open tickets' })
       def open_tickets_list(response)
         ticket_list response, QUERY_TICKETS_OPEN, 'open'
       end
 
-      route(/^(?:zd|zendesk)\s+list\s+on\s+hold\s+tickets?\s*$/, :onhold_tickets_list, command: true, help: { 'zd list onhold tickets' => 'returns a list of on hold tickets' })
+      route(/^(?:zd|zendesk)\s+list\s+on\s+hold\s+tickets?\s*$/i, :onhold_tickets_list, command: true, help: { 'zd list onhold tickets' => 'returns a list of on hold tickets' })
       def onhold_tickets_list(response)
         ticket_list response, QUERY_TICKETS_HOLD, 'on hold'
       end
 
       # Ticket Details
 
-      route(/^(?:zd|zendesk)\s+ticket\s+(\d+)\s*$/, :ticket_details, command: true, help: { 'zd ticket <ID>' => 'returns information about the specified ticket' })
+      route(/^(?:zd|zendesk)\s+ticket\s+(\d+)\s*$/i, :ticket_details, command: true, help: { 'zd ticket <ID>' => 'returns information about the specified ticket' })
       def ticket_details(response)
+        Lita.logger.info "#{logger_prefix}Processing Zendesk Ticket Details"
         ticket_id = response.matches[0][0]
         url = "#{QUERY_TICKETS_ALL}/#{ticket_id}.json"
         res = zendesk_request url
@@ -171,6 +175,7 @@ module Lita
       private
 
       def ticket_count(response, url, ticket_type = '')
+        Lita.logger.info "#{logger_prefix}Processing Zendesk Ticket Count"
         res = zendesk_request url
         ticket_count = res.body['count']
         ticket_word  = ticket_count == 1 ? 'ticket' : 'tickets'
@@ -179,6 +184,7 @@ module Lita
       end
 
       def ticket_search(response, url, query)
+        Lita.logger.info "#{logger_prefix}Processing Zendesk Ticket Search"
         url += query
         res = zendesk_request url
         tickets = res.body['results']
@@ -192,6 +198,7 @@ module Lita
       end
 
       def ticket_list(response, url, ticket_type = '')
+        Lita.logger.info "#{logger_prefix}Processing Zendesk Ticket List"
         res = zendesk_request url
         tickets = res.body['results']
         tickets.each do |ticket|
@@ -207,6 +214,10 @@ module Lita
       def tickets(count)
         count == 1 ? 'ticket' : 'tickets'
       end
+
+      def logger_prefix
+        " -- #{self.class.name}: "
+      end
     end
 
     Lita.register_handler(Zendesk)

data/lita-zendesk.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-zendesk'
-  spec.date          = '2016-08-31'
-  spec.version       = '0.0.5'
+  spec.date          = '2016-09-05'
+  spec.version       = '0.0.6'
   spec.authors       = ['John Wang']
   spec.email         = ['johncwang@gmail.com']
   spec.description   = %q{A Zendesk handler for Lita.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-zendesk
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday