lita-zendesk 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f63a7f1bbf0fd4a6a93e619e1f763fd63e995393
-  data.tar.gz: 8d74f5d3f2c59e1b9a505b63eb3d510460ce51b0
+  metadata.gz: 38716ec59f092963728bc33ed8856579870eda1a
+  data.tar.gz: 967a1bba6739466e7522a8c7bb4c3327b2ef7612
 SHA512:
-  metadata.gz: 21f85ea9ec84d9e7cc735408da833d378e7939d319957ed8fe20b17104bd058bb6231fc1ad748095fa505ec186c5f5830059c1018153f36b23827489e95d1c84
-  data.tar.gz: 8500af1c1e8f18900892da420e741130335b3147a29fb197623af66669da48291faf197df75a24abf1ca977c045b47c5a5e1d92939524eba1238e43e4ac71858
+  metadata.gz: 9684aee6cc7da35e3bbef1ba930842d51b8464e6e6cc753e9f99f15c68cb02e8e6b2f90c8e81b760ff4ff40c9617f3443a9a4b990f391a632e6368ecf0235052
+  data.tar.gz: 3c906b02640c45574f335bee74a7a7032b8f44499c917a31358c65ff72a2021a6e3d4e4d013a92f86df91094cd17d383fc1b99d5432f738f207a0a0eb7524d76

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 CHANGELOG
 ---------
+- **0.1.0** - 2015-09-12
+  - Additions
+    - Add comments to ticket details
+    - Add ticket requester to ticket details
+    - Add use of official Zendesk SDK
+  - Breaking Changes
+    - Update config to match Zendesk SDK, `user` is now `username`
 - **0.0.6** - 2016-09-05
   - Make routes case insensitive
   - Add additional logging

data/README.md

@@ -11,7 +11,7 @@ Lita Zendesk Handler
 [![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
 [![License][license-svg]][license-link]
 
-`lita-zendesk` is an handler for [Lita](https://www.lita.io/) that allows you to use the robot with [Zendesk](https://zendesk.com/) ticket queries.
+`lita-zendesk` is a handler for [Lita](https://www.lita.io/) that allows you to use the robot with [Zendesk](https://zendesk.com/) ticket queries.
 
 ## Installation
 
@@ -23,27 +23,23 @@ gem "lita-zendesk"
 
 ## Configuration
 
-Both Token and Password authentication are supported using the `config.handlers.zendesk.auth_type` property which can be set to `token` or `password`.
+Both Token and Password authentication are supported.
 
 ``` ruby
 Lita.configure do |config|
 
   # Zendesk user info
   config.handlers.zendesk.subdomain = 'my_zendesk_subdomain'
-  config.handlers.zendesk.auth_type = 'password'   # set to 'password' or 'token'
-  config.handlers.zendesk.user = 'my_zendesk_user' # required for both 'password' and 'token'
-  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
+  config.handlers.zendesk.username = 'my_zendesk_username'
+  config.handlers.zendesk.token = 'my_zendesk_token'       # Use token or password
+  config.handlers.zendesk.password = 'my_zendesk_password' # Use token or password
 
 end
 ```
 
 ## Usage
 
-`zd` or `zendesk` both work for signaling the handler.
+`zd` or `zendesk` both work for triggering the handler.
 
 ```
 Lita > @lita help
@@ -62,7 +58,7 @@ Lita: zd list pending tickets - returns a list of pending tickets
 Lita: zd list new tickets - returns a list of new tickets
 Lita: zd list esclated tickets - returns a list of escalated tickets
 Lita: zd list open tickets - returns a list of open tickets
-Lita: zd list onhold tickets - returns a list of on hold tickets
+Lita: zd list on hold tickets - returns a list of on hold tickets
 Lita: zd ticket <ID> - returns information about the specified ticket
 ```
 

data/lib/lita/handlers/zendesk.rb

@@ -1,70 +1,48 @@
-require 'base64'
-require 'faraday'
-require 'faraday_middleware'
-
-require 'pp'
+require 'zendesk_api'
 
 module Lita
   module Handlers
     class Zendesk < Handler
 
-      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'
-      QUERY_TICKETS_OPEN = 'search.json?query=status:open+type:ticket'
-      QUERY_TICKETS_NEW = 'search.json?query=status:new+type:ticket'
-      QUERY_TICKETS_PENDING = 'search.json?query=status:pending+type:ticket'
-      QUERY_TICKETS_UNSOLVED = 'search.json?query=status<solved+type:ticket'
+      API_VERSION_URL_PATH = 'api/v2'
+      WEB_TICKETS_URL_PATH = 'tickets'
+      QUERY_TICKETS_ALL = 'type:ticket'
+      QUERY_TICKETS_ESCALATED = 'type:ticket tags:escalated status:open status:pending'
+      QUERY_TICKETS_HOLD = 'type:ticket status:hold'
+      QUERY_TICKETS_OPEN = 'type:ticket status:open'
+      QUERY_TICKETS_NEW = 'type:ticket status:new'
+      QUERY_TICKETS_PENDING = 'type:ticket status:pending'
+      QUERY_TICKETS_UNSOLVED = 'type:ticket status<solved'
       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
+      config :username, type: String, required: true
       config :token, type: String, default: ''
       config :password, type: String, default: ''
 
-      def check_client(reload = false)
-        return if @conn && !reload
-        @base_url = base_url
-        @version_url = "#{@base_url}/#{VERSION_URL}"
-        @tickets_url = "#{@base_url}/tickets"
-
-        if config.auth_type == 'password'
-          @conn = Faraday.new(url: @version_url) do |faraday|
-            faraday.headers['Authorization'] = "Basic #{basic_credentials}"
-            faraday.response :json                    # JSON response
-            faraday.response :logger                  # log requests to STDOUT
-            faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
-          end
-        else
-          @conn = Faraday.new(url: @version_url) do |faraday|
-            faraday.response :json                    # JSON response
-            faraday.response :logger                  # log requests to STDOUT
-            faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
-          end
-          @conn.basic_auth("#{config.user}/token", config.token) 
+      config :max_results, type: Integer, default: 10
+
+      def client
+        return @_client if @_client
+        Lita.logger.info "#{logger_prefix}Connecting Zendesk Client to #{api_version_url}"
+        @_client = ZendeskAPI::Client.new do |client|
+          client.url = api_version_url.to_s
+          client.username = config.username || config.user
+          client.token = config.token
+          client.password = config.password
         end
       end
 
       def base_url
-        "https://#{config.subdomain.to_s}.zendesk.com"
+        "https://#{config.subdomain}.zendesk.com"
       end
 
-      def basic_credentials
-        Base64.encode64("#{config.user}:#{config.password}").gsub(/\s/,'')
+      def api_version_url
+        uri_join base_url, API_VERSION_URL_PATH
       end
 
-      def zendesk_request(url)
-        check_client
-        if url.index('http') != 0
-          url = "#{@version_url}/#{url}"
-        end
-        @conn.get url
+      def web_tickets_url
+        uri_join base_url, WEB_TICKETS_URL_PATH
       end
 
       # General
@@ -76,7 +54,7 @@ module Lita
 
       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]
+        ticket_search response, response.matches[0][0]
       end
 
       # Ticket Counts
@@ -111,7 +89,7 @@ module Lita
         ticket_count response, QUERY_TICKETS_OPEN, 'open'
       end
 
-      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' })
+      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
@@ -148,73 +126,134 @@ module Lita
         ticket_list response, QUERY_TICKETS_OPEN, 'open'
       end
 
-      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' })
+      route(/^(?:zd|zendesk)\s+list\s+on\s*hold\s+tickets?\s*$/i, :onhold_tickets_list, command: true, help: { 'zd list on hold 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*$/i, :ticket_details, command: true, help: { 'zd ticket <ID>' => 'returns information about the specified ticket' })
-      def ticket_details(response)
+      route(/^(?:zd|zendesk)\s+ticket\s+(\d+)\s*$/i, :ticket_details_with_comments, command: true, help: { 'zd ticket <ID>' => 'returns information about the specified ticket' })
+      def ticket_details_with_comments(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
-        data = res.body
-
-        message = "Ticket #{data['ticket']['id']}: #{@tickets_url}/#{data['ticket']['id']}"
-        message += "\nStatus: #{data['ticket']['status'].upcase}"
-        message += "\nUpdated: " + data['ticket']['updated_at']
-        message += "\nAdded: #{data['ticket']['created_at']}"
-        message += "\nSubject: #{data['ticket']['subject']}"
-        message += "\nDescription:\n-----\n#{data['ticket']['description']}\n-----\n"
-        response.reply message
+        ticket_id = response.matches[0][0].to_i
+        begin
+          ticket = client.ticket.find!(id: ticket_id)
+          response.reply get_text_for_ticket_with_comments(ticket)
+        rescue => e
+          Lita.logger.warn "#{logger_prefix}#{e}"
+          response.reply "Error processing ticket #{ticket_id}"
+        end
       end
 
       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'
-        ticket_desc  = ticket_type == '' ? '' : "#{ticket_type} "
-        response.reply "#{ticket_count} #{ticket_desc}#{ticket_word}."
+      def get_text_for_ticket(ticket, include_description = true)
+        Lita.logger.info "#{logger_prefix}Processing Zendesk ticket details for [#{ticket.id}]"
+        unless ticket.is_a? ZendeskAPI::Ticket
+          raise 'ticket is not a ZendeskAPI::Ticket'
+        end
+        message = "# Ticket #{ticket.id}: #{ticket_url_web(ticket.id)}"
+        message += "\n- Subject: #{ticket.subject}"
+        message += "\n- Status: #{ticket.status}"
+        message += "\n- Updated: #{ticket.updated_at}"
+        message += "\n- Created: #{ticket.created_at}"
+        message += "\n- Requester: #{user_display(ticket.requester)}"  
+        message += "\n- Description: #{ticket.description}" if include_description
+        return message
       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']
-        tickets.each do |ticket|
-          response.reply "Ticket #{ticket['id']} is #{ticket['status']}: #{@tickets_url}/#{ticket['id']} - #{ticket['subject']}"
+      def get_text_for_ticket_comments(ticket)
+        Lita.logger.info "#{logger_prefix}Processing Zendesk ticket comments for [#{ticket.id}]"
+        unless ticket.is_a? ZendeskAPI::Ticket
+          raise 'ticket is not a ZendeskAPI::Ticket'
+        end
+        comments_text = []
+        ticket.audits.each_with_index do |audit,i|
+          if (comment = audit.events.detect {|e| e.type.downcase == 'comment'})
+            author_text = user_display comment.author
+            comment_text = "## Comment: #{author_text}"
+            comment_text += "\n- Created: #{audit.created_at}"
+            comment_text += "\n- Comment: #{comment.body}"
+            comments_text.push comment_text
+          end
+        end
+        return comments_text.reverse.join("\n")
+      end
+
+      def get_text_for_ticket_with_comments(ticket)
+        Lita.logger.info "#{logger_prefix}Processing Zendesk ticket details for [#{ticket.id}] with comments"
+        message = get_text_for_ticket ticket, false
+        comments = get_text_for_ticket_comments ticket
+        if !comments.nil? && comments.length>0
+          message += "\n#{comments}"
+        end
+        return message
+      end
+
+      def ticket_count(response, query, ticket_type = '')
+        Lita.logger.info "#{logger_prefix}Processing Zendesk Ticket Count Query [#{query}]"
+        begin
+          ticket_count = client.search!(query: query).count
+          Lita.logger.info "#{logger_prefix}Ticket count #{ticket_count}"
+          ticket_desc  = ticket_type == '' ? '' : "#{ticket_type} "
+          ticket_word  = ticket_count == 1 ? 'ticket' : 'tickets'
+          response.reply "#{ticket_count} #{ticket_desc}#{ticket_word}."
+        rescue
+          response.reply "A Zendesk error has been encountered."
         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 = '')
-        Lita.logger.info "#{logger_prefix}Processing Zendesk Ticket List"
-        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
+
+      def ticket_search(response, raw_query)
+        Lita.logger.info "#{logger_prefix}Processing Zendesk Ticket Search"
+        tickets = client.search!(query: "#{QUERY_TICKETS_ALL} #{raw_query}")
+        serp_count = reply_tickets response, tickets
+        response.reply "Listing #{serp_count} of #{tickets.count} #{ticket_word(tickets.count)} matching #{raw_query}."
+      end
+
+      def ticket_list(response, query, ticket_status = '')
+        Lita.logger.info "#{logger_prefix}Processing Zendesk ticket list query"
+        tickets = client.search!(query: query)
+        serp_count = reply_tickets response, tickets
+        ticket_desc = ticket_status == '' ? '' : "#{ticket_status} "
+        response.reply "Listing #{serp_count} of #{tickets.count} #{ticket_desc}#{ticket_word(tickets.count)}."
+      end
+
+      def reply_tickets(response, tickets)
+        serp_count = 0
+        tickets.each_with_index do |ticket, i|
+          break if i >= config.max_results
+          serp_count += 1
+          response.reply "Ticket #{ticket.id} is #{ticket.status}: #{ticket_url_web(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}."
+        return serp_count
       end
 
-      def tickets(count)
+      def ticket_url_web(ticket_id)
+        uri_join web_tickets_url.to_s, ticket_id.to_s
+      end
+
+      def ticket_word(count)
         count == 1 ? 'ticket' : 'tickets'
       end
 
+      def user_display(user)
+        parts = []
+        if user.name.to_s.length > 0
+          parts.push user.name
+        end
+        if user.email.to_s.length > 0
+          if parts.length < 1 || user.email != user.name
+            parts.push "(#{user.email})"
+          end
+        end
+        user_text = parts.join(' ')
+      end
+
+      def uri_join(*args)
+        args.join('/').gsub(/\/\s*\//, '/').gsub(/\/+/, '/').gsub(/^(https?:\/)/i, '\1/')
+      end
+
       def logger_prefix
         " -- #{self.class.name}: "
       end

data/lita-zendesk.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-zendesk'
-  spec.date          = '2016-09-05'
-  spec.version       = '0.0.6'
+  spec.date          = '2016-09-13'
+  spec.version       = '0.1.0'
   spec.authors       = ['John Wang']
   spec.email         = ['johncwang@gmail.com']
   spec.description   = %q{A Zendesk handler for Lita.}
@@ -15,9 +15,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'faraday', '~> 0.9', '>= 0.9'
-  spec.add_runtime_dependency 'faraday_middleware', '~> 0', '>= 0'
   spec.add_runtime_dependency 'lita', '>= 4.4.3'
+  spec.add_runtime_dependency 'zendesk_api', '>= 1.14.0', '~> 1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'pry-byebug'

metadata

@@ -1,69 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: lita-zendesk
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-05 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: lita
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 4.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 4.4.3
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: zendesk_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+        version: 1.14.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: lita
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.4.3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.4.3
+        version: 1.14.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement