yammdesk 0.0.1

data/README.md

@@ -0,0 +1,29 @@
+# Yammdesk
+
+
+## WARNING
+WARNING: THIS SOFTWARE IS ALPHA. It has bugs which may set fire to your wife. If you do not have a wife, it may seek out the equivalent and set fire to that. I strongly suggest you do not use it until this notice disappears.
+
+## Description
+
+A two-way interface between Yammer, and your ticketing system. Currently only Web Help Desk is supported, but there are plans to include Zendesk.
+
+## Installation
+
+    $ gem install yammdesk
+
+Use the configuration template provided in the templates folder to create a conf file in the folder you will be running the script from.
+
+## Usage
+
+Run SyncTicketing.rb to sync Yammer <=> Ticketing System.
+
+Alternatively, you can use the methods provided to write your own solution.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO

@@ -0,0 +1,8 @@
+# TODO
+
+Many things are broken ;)
+
+* Ensure that tokens are not passed via URL
+* Refactor API call methods into one method that can be called for all jobs.
+* Ensure regular expressions that re-write the API call responses catch _all_ abnormal text (HTML) and re-write them to plain text.
+* Look into using ['rich'] Yammer message response instead of ['plain'], to get around the Yammer user name change bug (which means that if a Yammer user changes their name, any messages they send will not be found when searching the ticketing system).

data/bin/SyncTicketing.rb

@@ -0,0 +1,132 @@
+#!/usr/bin/env ruby
+
+require 'yammdesk'
+require 'colorize'
+require 'cgi'
+
+beginning = Time.now
+yamm = Yammdesk::Yammer.new
+whd = Yammdesk::WHD.new
+yamm_results = yamm.get
+yamm_results.sort_by { |id| }
+
+
+yamm_results.each { |m|
+  id = m['id']
+  replied_to_id = m["replied_to_id"]
+  thread_id = m["thread_id"]
+  body = m["body"]["plain"]
+  
+  thread_exists = whd.thread_exists?(thread_id)
+  thread_starter = yamm.is_thread_starter?(id, thread_id)
+
+  # TODO: Write these methods
+  # ticket_closed = WHD.ticket_closed?(thread_id)
+  #
+  if thread_exists && !thread_starter
+    puts "Thread is not a thread starter, AND ticket exists".yellow
+    puts "thread_exists = #{thread_exists}\nthread_starter = #{thread_starter}".yellow
+    puts "thread_id = #{thread_id}".yellow
+    puts "messag id = #{id}".yellow
+    puts "body = #{body}\n".yellow
+
+    ticket_id = whd.search(thread_id)
+    if !whd.note_exists?(ticket_id, body)
+      puts "Thread is not a thread starter, AND ticket exists, AND note does not exist".blue
+      puts "thread_exists = #{thread_exists}\nthread_starter = #{thread_starter}".blue
+      puts "thread_id = #{thread_id}".blue
+      puts "messag id = #{id}".blue
+      puts "body = #{body}\n".blue
+      
+      whd.update_ticket(ticket_id, body)
+    end
+  elsif !thread_exists && thread_starter
+    puts "Thread does not exist, AND is thread_starter".green
+    puts "thread_exists = #{thread_exists}\nthread_starter = #{thread_starter}".green
+    puts "thread_id = #{thread_id}".green
+    puts "messag id = #{id}".green
+    puts "body = #{body}".green
+
+    whd.create_ticket(thread_id, body)
+
+    ticket_id = whd.search(thread_id)
+    thread_replies = yamm.get_thread_replies(thread_id)
+    thread_replies.sort_by { |id| }
+    thread_replies.each { |m|
+      id = m['id']
+      replied_to_id = m["replied_to_id"]
+      thread_id = m["thread_id"]
+      body = m["body"]["plain"]
+
+      if !yamm.is_thread_starter?(id, thread_id)
+        whd.update_ticket(ticket_id, body)
+      end
+    }
+  elsif !thread_exists && !thread_starter
+    puts "Thread does not exist AND this is not a thread starter".red
+    puts "thread_exists = #{thread_exists}\nthread_starter = #{thread_starter}".red
+    puts "thread_id = #{thread_id}".red
+    puts "messag id = #{id}".red
+    puts "body = #{body}\n".red
+
+    missing_thread_starter = yamm.get_thread_starter(thread_id)
+
+    id = missing_thread_starter['id']
+    replied_to_id = missing_thread_starter["replied_to_id"]
+    thread_id = missing_thread_starter["thread_id"]
+    body = missing_thread_starter["body"]["plain"]
+      
+    # We found a missing thread starter from a reply returned by the YAPI
+    # Let's create a ticket from the ID we found then:
+    whd.create_ticket(thread_id, body)
+
+    # ... and get all the replies
+    ticket_id = whd.search(thread_id)
+
+    thread_replies = yamm.get_thread_replies(thread_id)
+    thread_replies.sort_by { |id| }
+    thread_replies.each { |m|
+      id = m['id']
+      replied_to_id = m["replied_to_id"]
+      thread_id = m["thread_id"]
+      body = m["body"]["plain"]
+
+      if !yamm.is_thread_starter?(id, thread_id)
+        whd.update_ticket(ticket_id, body)
+      end
+    }
+  else
+    puts "Thread exists AND this is a thread starter\n".red
+  end
+}
+
+
+# Now check for updated tickets, and push to Yammer
+whd_tickets = whd.get
+whd_tickets.sort_by { |id| }
+
+whd_tickets.each { |t|
+  yamm_id = t['shortSubject']
+  ticket_id = t['id']
+  whd_id = whd.search(yamm_id)
+  yamm_replies = yamm.get_thread_replies(yamm_id)
+  whd_notes = whd.get_notes(ticket_id)
+  
+  whd_notes.each { | note |
+    puts "Now searching for note:\n#{note}\n".red
+
+    if yamm.reply_exists?(note, yamm_replies)
+      puts "Ticket: #{ticket_id}\n"
+      puts "Thread from WHD: #{yamm_id}\n"
+      puts "Nothin' doin'. The note is already a comment on Yammer:\n" + "#{note}\n\n".blue
+    else
+      puts "Ticket: #{ticket_id}\n"
+      puts "Thread from WHD: #{yamm_id}\n"
+      puts "Didn't find the note in the thread. Updating it with the new reply:\n" + "#{note}\n\n".green
+      yamm.update_thread(yamm_id, note)
+    end
+  }
+
+}
+
+puts "Application run completed in #{Time.now - beginning} seconds\n"

data/lib/yammdesk.rb

@@ -0,0 +1,15 @@
+require "yammdesk/version"
+
+module Yammdesk
+  require_relative 'yammdesk/yammer'
+  require 'yaml'
+  require 'net/http'
+  require 'openssl'
+  require 'uri'
+  require 'json'
+  require 'nokogiri'
+  
+  
+  OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+  CONFIG = YAML.load_file("config.yml") unless defined? CONFIG
+end

data/lib/yammdesk/version.rb

@@ -0,0 +1,3 @@
+module Yammdesk
+  VERSION = "0.0.1"
+end

data/lib/yammdesk/whd.rb

@@ -0,0 +1,158 @@
+module Yammdesk
+  
+  class WHD
+
+    require 'yaml'
+    require 'net/http'
+    require 'openssl'
+    require 'uri'
+    require 'json'
+    require 'colorize'
+    
+    CONFIG = YAML.load_file("config.yml") unless defined? CONFIG
+    
+    
+    def initialize
+      @url = CONFIG['whd']['url']
+      @token = CONFIG['whd']['tech_token']
+      @uri = URI(@url)
+      current_dir = File.dirname(__FILE__)
+      @post_file = JSON.parse(IO.read("#{current_dir}/../../templates/create_ticket.json"))
+      @update_file = JSON.parse(IO.read("#{current_dir}/../../templates/update_ticket.json"))
+    end   
+    
+    def get
+      Net::HTTP.start(@uri.host, @uri.port) do |http|
+        response = http.get(@url +  "Tickets/?list=group&apiKey=#{@token}")
+        # response = http.get(@url + "Tickets/?list=group", :params => {:apiKey => @token})
+        @data = JSON.parse(response.body)
+      end
+    end
+    
+    def thread_exists?(thread_id)
+      url = @url + "Tickets?qualifier=(subject%3D'#{thread_id}')&apiKey=#{@token}"
+      uri = URI(url)
+      
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        response = http.get(url)
+        get_data = JSON.parse(response.body)
+        
+        if get_data.empty?
+          return false
+        else
+          return true
+        end
+      end
+    end
+    
+    def note_exists?(ticket_id, yamm_body)
+      yamm_body = CGI.unescapeHTML(yamm_body)
+      url = @url +  "TicketNotes?jobTicketId=#{ticket_id}&apiKey=#{@token}"
+      uri = URI(url)
+      
+      Net::HTTP.start(@uri.host, @uri.port) do |http|
+        response = http.get(url)
+        get_data = JSON.parse(response.body)
+        
+        if note = get_data.find { |note| CGI.unescapeHTML(note['mobileNoteText']) }
+          return true
+        else
+          return false
+      end
+      end
+    end
+    
+    def get_notes(ticket_id)
+      url = @url +  "TicketNotes?jobTicketId=#{ticket_id}&apiKey=#{@token}"
+      uri = URI(url)
+      
+      Net::HTTP.start(@uri.host, @uri.port) do |http|
+        response = http.get(url)
+      get_data = JSON.parse(response.body)
+        
+        @whd_entries = []
+        
+        get_data.each { |h|
+          note = CGI.unescapeHTML(h['mobileNoteText'])
+          note = note.gsub('<br/> ', "\n") 
+          note = Nokogiri::HTML.parse(note)
+          note = note.text
+          
+          @whd_entries << note
+        }
+        
+        return @whd_entries
+    end
+    end
+    
+    def search(thread_id)
+      url = @url + "Tickets?qualifier=(subject%3D'#{thread_id}')&apiKey=#{@token}"
+      uri = URI(url)
+      
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        response = http.get(url)
+        #puts "DEBUG: #{response.code}, #{response.body}"
+        
+        get_data = JSON.parse(response.body)
+        #data = (get_data[0] || {}).to_hash
+        data = get_data[0].to_hash
+        ticket_id = data["id"]
+        
+        return ticket_id
+      end
+  end
+    
+    def put(options = {})
+      ticket_id = options[:ticket_id]
+      put_data = options[:put_data]
+      
+      Net::HTTP.start(@uri.host, @uri.port) do |http|
+        response = http.request_put(@url + "Tickets/#{ticket_id}/?apiKey=#{@token}", put_data)
+        @data = JSON.parse(response.body)
+      end
+    end
+    
+    def last_ticket
+      last_ticket = "10559118"
+    end
+    
+    def update_ticket(ticket_id, message)
+      @update_file["ticketId"] = ticket_id
+      @update_file["jobticket"]["id"] = ticket_id
+      @update_file["noteText"] = message
+      post_data = @update_file.to_s
+    url = @url + "TechNotes?apiKey=#{@token}"
+      uri = URI(url)
+      
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body = post_data
+    
+      response = Net::HTTP.new(uri.host, uri.port).start { |http|
+        res = http.request(request)
+        # puts "CODE: #{res.code} with BODY: #{res.body}\n".white
+      }
+    end
+    
+    def create_ticket(thread_id, body)
+      @post_file["subject"] = "#{thread_id}"
+      @post_file["detail"] = body
+      post_data = @post_file.to_s
+      
+      url = @url + "Tickets?apiKey=#{@token}"
+      uri = URI(url)
+      
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body = post_data
+      
+      response = Net::HTTP.new(uri.host, uri.port).start { |http| http.request(request) }
+      
+      # DEBUG
+      # puts "Creating ticket for thread: ".yellow + "#{thread_id}\n" + "with message: ".yellow + "#{post_data}\n" +
+      #  "using put URL: ".yellow + "#{url}\n\n"
+      # DEBUG
+      
+    end
+    
+  end
+end
+

data/lib/yammdesk/yammer.rb

@@ -0,0 +1,97 @@
+module Yammdesk
+  class Yammer
+    
+    require 'yaml'
+    require 'net/http'
+    require 'openssl'
+    require 'uri'
+    require 'json'
+    require 'nokogiri'
+    require_relative 'whd'
+    
+    OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+    CONFIG = YAML.load_file("config.yml") unless defined? CONFIG
+    
+    
+    def initialize
+      @url = CONFIG['yammdesk']['url']
+      @token = CONFIG['yammdesk']['token']
+    @uri = URI(@url)
+    end
+    
+    
+    def get
+      Net::HTTP.start(@uri.host, @uri.port, :use_ssl => @uri.scheme == 'https') do |http|
+        response = http.get(@url + "/messages/in_group/872.json?oaccess_token=#{@token}")
+        @data = JSON.parse(response.body)
+        
+        return @data['messages']
+      end
+    end
+    
+    def get_thread_replies(thread_id)
+      Net::HTTP.start(@uri.host, @uri.port, :use_ssl => @uri.scheme == 'https') do |http|
+        response = http.get(@url + "/messages/in_thread/#{thread_id}.json?oaccess_token=#{@token}")
+        @data = JSON.parse(response.body)
+        
+      return @data['messages']
+      end
+    end
+    
+    def get_thread_starter(thread_id)
+      url = @url + "/messages/#{thread_id}.json?oaccess_token=#{@token}"
+      uri = URI(@url)
+      
+      Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        response = http.get(url)
+        @data = JSON.parse(response.body)
+        return @data
+      end
+    end
+    
+    def reply_exists?(whd_note, yamm_replies)
+      if yamm_replies.find { |yamm|
+          body = CGI.unescapeHTML(yamm['body']['plain'])
+          body = body.gsub('<br/> ', "\n") 
+          body = Nokogiri::HTML.parse(body)
+          body = body.text
+          
+          body == whd_note
+        }
+        return true
+      else
+        return false
+      end
+    end
+    
+    def is_thread_starter?(id, thread_id)
+      if id == thread_id
+        true
+      else
+        false
+      end
+    end    
+    
+    def update_thread(thread_id, body)
+      body = CGI::unescapeHTML(body)
+      body = body.gsub('<br/> ', "\n") 
+      body = Nokogiri::HTML.parse(body)
+      body = body.text
+      
+      url = @url + "/messages.json&oaccess_token=#{@token}"
+      uri = URI(url)
+      
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.set_form_data('replied_to_id' => thread_id, 'body' => body)
+      
+      response = https.request(request)
+      puts "DIDN'T FIND:\n#{body}\n\n".white
+    end
+    
+    
+  end
+end