RubyGems - rt-client - Versions diffs - 0.5.0 → 0.6.4 - Mend

rt-client 0.5.0 → 0.6.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

data/rt/client.rb CHANGED Viewed

@@ -2,178 +2,160 @@
 require "rubygems"
 require "rest_client"
-require "tmail"
-require "iconv"
-require 'mime/types' # requires both nokogiri and rcov.  Yuck.
-require 'date'
-require 'pp'
-## A ruby library API to Request Tracker's REST interface. Requires the
-## rubygems rest-client, tmail and mime-types to be installed.  You can
-## create a file name .rtclientrc in the same directory as client.rb with a
-## default server/user/pass to connect to RT as, so that you don't have to
-## specify it/update it in lots of different scripts.
+##A ruby library API to Request Tracker's REST interface. Requires the
+##rubygems rest-client, mail and mime-types to be installed.  You can
+##create a file name .rtclientrc in the same directory as client.rb with a
+##default server/user/pass to connect to RT as, so that you don't have to
+##specify it/update it in lots of different scripts.
 ##
 ## Thanks to Brian McArdle for patch dealing with spaces in Custom Fields.
 ## To reference custom fields in RT that have spaces with rt-client, use an
-## underscore in the rt-client code for the hash key.
-#
-## TODO: Streaming, chunking attachments in compose method
+## underscore in the rt-client code, e.g. "CF.{Has_Space}"
+##
+## Thanks to Robert Vinson for 1.9.x compatibility when I couldn't be buggered
+## and a great job of refactoring the old mess into something with much fewer
+## dependencies.
+##
+##TODO: Streaming, chunking attachments in compose method
 #
 # See each method for sample usage.  To use this, "gem install rt-client" and
 #
 #  require "rt/client"
 class RT_Client
-  UA = "Mozilla/5.0 ruby RT Client Interface 0.5.0"
-  attr_reader :status, :site, :version, :cookies, :server, :user, :cookie
-  # Create a new RT_Client object. Load up our stored cookie and check it.
-  # Log into RT again if needed and store the new cookie.  You can specify
-  # login and cookie storage directories in 3 different ways:
-  #  1. Explicity during object creation
-  #  2. From a .rtclientrc file in the working directory of your ruby program
-  #  3. From a .rtclientrc file in the same directory as the library itself
-  #
-  # These are listed in order of priority; if you have explicit parameters,
-  # they are always used, even if you have .rtclientrc files.  If there
-  # is both an .rtclientrc in your program's working directory and
-  # in the library directory, the one from your program's working directory
-  # is used.  If no parameters are specified either explicity or by use
-  # of a .rtclientrc, then the defaults of "rt_user", "rt_pass" are used
-  # with a default server of "http://localhost", and cookies are stored
-  # in the directory where the library resides.
-  #
-  #  rt= RT_Client.new( :server  => "https://tickets.ambulance.com/",
-  #                     :user    => "rt_user",
-  #                     :pass    => "rt_pass",
-  #                     :cookies => "/my/cookie/dir" )
-  #
-  #  rt= RT_Client.new # use defaults from .rtclientrc
-  #
-  # .rtclientrc format:
-  #  server=<RT server>
-  #  user=<RT user>
-  #  pass=<RT password>
-  #  cookies=<directory>
-  def initialize(*params)
-    @boundary = "----xYzZY#{rand(1000000).to_s}xYzZY"
-    @version = "0.4.0"
-    @status = "Not connected"
-    @server = "http://localhost/"
-    @user = "rt_user"
-    @pass = "rt_pass"
-    @cookies = Dir.pwd
-    config_file = Dir.pwd + "/.rtclientrc"
-    config = ""
-    if File.file?(config_file)
-      config = File.read(config_file)
-    else
-      config_file = File.dirname(__FILE__) + "/.rtclientrc"
-      config = File.read(config_file) if File.file?(config_file)
-    end
-    @server = $~[1] if config =~ /\s*server\s*=\s*(.*)$/i
-    @user = $~[1] if config =~ /^\s*user\s*=\s*(.*)$/i
-    @pass = $~[1] if config =~ /^\s*pass\s*=\s*(.*)$/i
-    @cookies = $~[1] if config =~ /\s*cookies\s*=\s*(.*)$/i
-    @resource = "#{@server}REST/1.0/"
-    if params.class == Array && params[0].class == Hash
-      param = params[0]
-      @user = param[:user] if param.has_key? :user
-      @pass = param[:pass] if param.has_key? :pass
-      if param.has_key? :server
-        @server = param[:server]
-        @server += "/" if @server !~ /\/$/
-        @resource = "#{@server}REST/1.0/"
-      end
-      @cookies  = param[:cookies] if param.has_key? :cookies
-    end
-    @login = { :user => @user, :pass => @pass }
-    cookiejar = "#{@cookies}/RT_Client.#{@user}.cookie" # cookie location
-    cookiejar.untaint
-    if File.file? cookiejar
-      @cookie = File.read(cookiejar).chomp
-      headers = { 'User-Agent'   => UA,
-                  'Content-Type' => "application/x-www-form-urlencoded",
-                  'Cookie'       => @cookie }
-    else
-      headers = { 'User-Agent'   => UA,
-                  'Content-Type' => "application/x-www-form-urlencoded" }
-      @cookie = ""
-    end
+	UA = "Mozilla/5.0 ruby RT Client Interface 0.6.4"
+	attr_reader :status, :site, :version, :cookies, :server, :user, :cookie
-    site = RestClient::Resource.new(@resource, :headers => headers, :timeout => 120)
-    data = site.post "" # a null post just to check that we are logged in
-    if @cookie.length == 0 or data =~ /401/ # we're not logged in
-      data = site.post @login, :headers => headers
-#      puts data
-      @cookie = data.headers[:set_cookie].to_s.split('; ')[0]
-      # write the new cookie
-      if @cookie !~ /nil/
-        f = File.new(cookiejar,"w")
-        f.puts @cookie
-        f.close
-      end
-    end
-    headers = { 'User-Agent'   => UA,
-                'Content-Type' => "multipart/form-data; boundary=#{@boundary}",
-                'Cookie'       => @cookie }
-    @site = RestClient::Resource.new(@resource, :headers => headers)
-    @status = data
-    self.untaint
-  end
+	# Create a new RT_Client object. Load up our stored cookie and check it.
+	# Log into RT again if needed and store the new cookie.  You can specify
+	# login and cookie storage directories in 3 different ways:
+	#  1. Explicity during object creation
+	#  2. From a .rtclientrc file in the working directory of your ruby program
+	#  3. From a .rtclientrc file in the same directory as the library itself
+	#
+	# These are listed in order of priority; if you have explicit parameters,
+	# they are always used, even if you have .rtclientrc files.  If there
+	# is both an .rtclientrc in your program's working directory and
+	# in the library directory, the one from your program's working directory
+	# is used.  If no parameters are specified either explicity or by use
+	# of a .rtclientrc, then the defaults of "rt_user", "rt_pass" are used
+	# with a default server of "http://localhost", and cookies are stored
+	# in the directory where the library resides.
+	#
+	#  rt= RT_Client.new( :server  => "https://tickets.ambulance.com/",
+	#                     :user    => "rt_user",
+	#                     :pass    => "rt_pass",
+	#                     :cookies => "/my/cookie/dir" )
+	#
+	#  rt= RT_Client.new # use defaults from .rtclientrc
+	#
+	# .rtclientrc format:
+	#  server=<RT server>
+	#  user=<RT user>
+	#  pass=<RT password>
+	#  cookies=<directory>
+	def initialize(*params)
+		@boundary = "----xYzZY#{rand(1000000).to_s}xYzZY"
+		@version = "0.4.0"
+		@status = "Not connected"
+		@server = "http://localhost/"
+		@user = "rt_user"
+		@pass = "rt_pass"
+		@cookies = Dir.pwd
+		config_file = Dir.pwd + "/.rtclientrc"
+		config = ""
+		if File.file?(config_file)
+			config = File.read(config_file)
+		else
+			config_file = File.dirname(__FILE__) + "/.rtclientrc"
+			config = File.read(config_file) if File.file?(config_file)
+		end
+		@server = $~[1] if config =~ /\s*server\s*=\s*(.*)$/i
+		@user = $~[1] if config =~ /^\s*user\s*=\s*(.*)$/i
+		@pass = $~[1] if config =~ /^\s*pass\s*=\s*(.*)$/i
+		@cookies = $~[1] if config =~ /\s*cookies\s*=\s*(.*)$/i
+		@resource = "#{@server}REST/1.0/"
+		if params.class == Array && params[0].class == Hash
+			param = params[0]
+			@user = param[:user] if param.has_key? :user
+			@pass = param[:pass] if param.has_key? :pass
+			if param.has_key? :server
+				@server = param[:server]
+				@server += "/" if @server !~ /\/$/
+				@resource = "#{@server}REST/1.0/"
+			end
+			@cookies  = param[:cookies] if param.has_key? :cookies
+		end
+		@login = { :user => @user, :pass => @pass }
+		cookiejar = "#{@cookies}/RT_Client.#{@user}.cookie" # cookie location
+		cookiejar.untaint
+		if File.file? cookiejar
+			@cookie = File.read(cookiejar).chomp
+			headers = { 'User-Agent'   => UA,
+			'Content-Type' => "application/x-www-form-urlencoded",
+			'Cookie'       => @cookie }
+		else
+			headers = { 'User-Agent'   => UA,
+			'Content-Type' => "application/x-www-form-urlencoded" }
+			@cookie = ""
+		end
-  # gets the detail for a single ticket/user.  If its a ticket, its without
-  # history or attachments (to get those use the history method) .  If no
-  # type is specified, ticket is assumed.  takes a single parameter
-  # containing the ticket/user id, and returns a hash of RT Fields => values
-  #
-  #  hash = rt.show(822)
-  #  hash = rt.show("822")
-  #  hash = rt.show("ticket/822")
-  #  hash = rt.show(:id => 822)
-  #  hash = rt.show(:id => "822")
-  #  hash = rt.show(:id => "ticket/822")
-  #  hash = rt.show("user/#{login}")
-  #  email = rt.show("user/somebody")["emailaddress"]
-  def show(id)
-    id = id[:id] if id.class == Hash
-    id = id.to_s
-    type = "ticket"
-    sid = id
-    if id =~ /(\w+)\/(.+)/
-      type = $~[1]
-      sid = $~[2]
-    end
-    reply = {}
-    if type.downcase == 'user'
-      resp = @site["#{type}/#{sid}"].get
-    else
-      resp = @site["#{type}/#{sid}/show"].get
-    end
-    resp.gsub!(/RT\/\d+\.\d+\.\d+\s\d{3}\s.*\n\n/,"") # toss the HTTP response
-    resp.gsub!(/\n\n/,"\n") # remove double spacing, TMail stops at a blank line
-    while resp.match(/CF\.\{[\w_ ]*[ ]+[\w ]*\}/) #replace CF spaces with underscores
-      resp.gsub!(/CF\.\{([\w_ ]*)([ ]+)([\w ]*)\}/, 'CF.{\1_\3}')
-    end
-    return {:error => resp, }  if resp =~ /does not exist./
-    th = TMail::Mail.parse(resp)
-    resp += "\nrtclientend:" # to make the pattern match on the last key in the response
-    th.each_header do |k,v|
-      reply["#{k}"] = v.to_s
-      kk = k.gsub(/\{/,"\\\{")
-      kk.gsub!(/\}/,"\\\}")
-      pattern = "^" + kk + ": (.*?)^[\\w\\.\\{\\}]+:"
-      temp = resp.match(/#{pattern}/mi) # TMail strips line breaks
-      reply["#{k}"] = temp[1].rstrip if temp.class != NilClass
-    end
-    reply
-  end
-  # gets a list of ticket links for a ticket.
+		site = RestClient::Resource.new(@resource, :headers => headers, :timeout => 120)
+		data = site.post "" # a null post just to check that we are logged in
+		if @cookie.length == 0 or data =~ /401/ # we're not logged in
+			data = site.post @login, :headers => headers
+			#      puts data
+			@cookie = data.headers[:set_cookie].first.split('; ')[0]
+			# write the new cookie
+			if @cookie !~ /nil/
+				f = File.new(cookiejar,"w")
+				f.puts @cookie
+				f.close
+			end
+		end
+		headers = { 'User-Agent'   => UA,
+		   'Content-Type' => "multipart/form-data; boundary=#{@boundary}",
+		'Cookie'       => @cookie }
+		@site = RestClient::Resource.new(@resource, :headers => headers)
+		@status = data
+		self.untaint
+	end
+	# gets the detail for a single ticket/user.  If its a ticket, its without
+	# history or attachments (to get those use the history method) .  If no
+	# type is specified, ticket is assumed.  takes a single parameter
+	# containing the ticket/user id, and returns a hash of RT Fields => values
+	#
+	#  hash = rt.show(822)
+	#  hash = rt.show("822")
+	#  hash = rt.show("ticket/822")
+	#  hash = rt.show(:id => 822)
+	#  hash = rt.show(:id => "822")
+	#  hash = rt.show(:id => "ticket/822")
+	#  hash = rt.show("user/#{login}")
+	#  email = rt.show("user/somebody")["emailaddress"]
+	def show(id)
+		id = id[:id] if id.class == Hash
+		id = id.to_s
+		type = "ticket"
+		sid = id
+		if id =~ /(\w+)\/(.+)/
+			type = $~[1]
+			sid = $~[2]
+		end
+		reply = {}
+		if type.downcase == 'user'
+			resp = @site["#{type}/#{sid}"].get
+		else
+			resp = @site["#{type}/#{sid}/show"].get
+		end
+		reply = response_to_h(resp)
+	end
+	# gets a list of ticket links for a ticket.
   # takes a single parameter containing the ticket id,
   # and returns a hash of RT Fields => values
   #
@@ -194,47 +176,37 @@ class RT_Client
     end
     reply = {}
     resp = @site["ticket/#{sid}/links/show"].get
-    resp.gsub!(/RT\/\d+\.\d+\.\d+\s\d{3}\s.*\n\n/,"") # toss the HTTP response
-    resp.gsub!(/\n\n/,"\n") # remove double spacing, TMail stops at a blank line
-    while resp.match(/CF\.\{[\w_ ]*[ ]+[\w ]*\}/) #replace CF spaces with underscores
-      resp.gsub!(/CF\.\{([\w_ ]*)([ ]+)([\w ]*)\}/, 'CF.{\1_\3}')
-    end
     return {:error => resp, }  if resp =~ /does not exist./
-    th = TMail::Mail.parse(resp)
-    th.each_header do |k,v|
-      reply["#{k}"] = v.to_s
-    end
-    reply
+    reply = response_to_h(resp)
   end
-  # Creates a new ticket.  Requires a hash that contains RT form fields as
-  # the keys.  Capitalization is important; use :Queue, not :queue.  You
-  # will need at least :Queue to create a ticket.  For a full list of fields
-  # you can use, try "/opt/rt3/bin/rt edit ticket/1". Returns the newly
-  # created ticket number, or a complete REST response.
-  #
-  #  id = rt.create( :Queue   => "Customer Service",
-  #                  :Cc      => "somebody\@email.com",
-  #                  :Subject => "I've fallen and I can't get up",
-  #                  :Text    => "I think my hip is broken.\nPlease help.",
-  #                  :"CF.{CustomField}" => "Urgent",
-  #                  :Attachment => "/tmp/broken_hip.jpg" )
-  def create(field_hash)
-    field_hash[:id] = "ticket/new"
-    payload = compose(field_hash)
-    puts "Payload for new ticket:"
-    puts payload
-    resp = @site['ticket/new/edit'].post payload
-    new_id = resp.match(/Ticket\s*(\d+)/)
-    if new_id.class == MatchData
-      new_ticket = new_id[1]
-    else
-      new_ticket = resp
-    end
-    new_ticket # return the ticket number, or the full REST response
-  end
-  # create a new user.  Requires a hash of RT fields => values. Returns
+	# Creates a new ticket.  Requires a hash that contains RT form fields as
+	# the keys.  Capitalization is important; use :Queue, not :queue.  You
+	# will need at least :Queue to create a ticket.  For a full list of fields
+	# you can use, try "/opt/rt3/bin/rt edit ticket/1". Returns the newly
+	# created ticket number, or a complete REST response.
+	#
+	#  id = rt.create( :Queue   => "Customer Service",
+	#                  :Cc      => "somebody\@email.com",
+	#                  :Subject => "I've fallen and I can't get up",
+	#                  :Text    => "I think my hip is broken.\nPlease help.",
+	#                  :"CF.{CustomField}" => "Urgent",
+	def create(field_hash)
+		field_hash[:id] = "ticket/new"
+		payload = compose(field_hash)
+		puts "Payload for new ticket:"
+		puts payload
+		resp = @site['ticket/new/edit'].post payload
+		new_id = resp.match(/Ticket\s*(\d+)/)
+		if new_id.class == MatchData
+			new_ticket = new_id[1]
+		else
+			new_ticket = resp
+		end
+		new_ticket # return the ticket number, or the full REST response
+	end
+	# create a new user.  Requires a hash of RT fields => values. Returns
   # the newly created user ID, or the full REST response if there is an error.
   # For a full list of possible parameters that you can specify, look at
   # "/opt/rt/bin/rt edit user/1"
@@ -331,14 +303,8 @@ class RT_Client
       raise "RT_Client.usersearch requires a user email in the 'EmailAddress' key."
     end
     resp = @site["user/#{email}"].get
-    resp.gsub!(/RT\/\d+\.\d+\.\d+\s\d{3}\s.*\n\n/,"") # toss the HTTP response
-    reply = {}
     return reply if resp =~ /No user named/
-    th = TMail::Mail.parse(resp)
-    th.each_header do |k,v|
-      reply["#{k}"] = v.to_s
-    end
-    reply
+    reply = response_to_h(resp)
   end
   # correspond on a ticket.  Requires a hash, which must have an :id key
@@ -363,98 +329,93 @@ class RT_Client
     payload = compose(field_hash)
     @site["ticket/#{id}/comment"].post payload
   end
-  # Get a list of tickets matching some criteria.
-  # Takes a string Ticket-SQL query and an optional "order by" parameter.
-  # The order by is an RT field, prefix it with + for ascending
-  # or - for descending.
-  # Returns a nested array of arrays containing [ticket number, subject]
-  # The outer array is in the order requested.
-  #
-  #  hash = rt.list(:query => "Queue = 'Sales'")
-  #  hash = rt.list("Queue='Sales'")
-  #  hash = rt.list(:query => "Queue = 'Sales'", :order => "-Id")
-  #  hash = rt.list("Queue='Sales'","-Id")
-  def list(*params)
-    query = params[0]
-    order = ""
-    if params.size > 1
-      order = params[1]
-    end
-    if params[0].class == Hash
-      params = params[0]
-      query = params[:query] if params.has_key? :query
-      order = params[:order] if params.has_key? :order
-    end
-    reply = []
-    resp = @site["search/ticket/?query=#{URI.escape(query)}&orderby=#{order}&format=s"].get
-    raise "Invalid query (#{query})" if resp =~ /Invalid query/
-    resp = resp.split("\n") # convert to array of lines
-    resp.each do |line|
-      f = line.match(/^(\d+):\s*(.*)/)
-      reply.push [f[1],f[2]] if f.class == MatchData
-    end
-    reply
-  end
-  # A more extensive(expensive) query then the list method.  Takes the same
-  # parameters as the list method; a string Ticket-SQL query and optional
-  # order, but returns a lot more information.  Instead of just the ID and
-  # subject, you get back an array of hashes, where each hash represents
-  # one ticket, indentical to what you get from the show method (which only
-  # acts on one ticket).  Use with caution; this can take a long time to
-  # execute.
-  #
-  #  array = rt.query("Queue='Sales'")
-  #  array = rt.query(:query => "Queue='Sales'",:order => "+Id")
-  #  array = rt.query("Queue='Sales'","+Id")
-  #  => array[0] = { "id" => "123", "requestors" => "someone@..", etc etc }
-  #  => array[1] = { "id" => "126", "requestors" => "someone@else..", etc etc }
-  #  => array[0]["id"] = "123"
-  def query(*params)
-    query = params[0]
-    order = ""
-    if params.size > 1
-      order = params[1]
-    end
-    if params[0].class == Hash
-      params = params[0]
-      query = params[:query] if params.has_key? :query
-      order = params[:order] if params.has_key? :order
-    end
-    replies = []
-    resp = @site["search/ticket/?query=#{URI.escape(query)}&orderby=#{order}&format=l"].get
-    return replies if resp =~/No matching results./
-    raise "Invalid query (#{query})" if resp =~ /Invalid query/
-    resp.gsub!(/RT\/\d+\.\d+\.\d+\s\d{3}\s.*\n\n/,"") # strip HTTP response
-    tickets = resp.split("\n--\n") # -- occurs between each ticket
-    tickets.each do |ticket|
-      ticket.gsub!(/^\n/,"") # strip leading blank lines
-      ticket.gsub!(/\n\n/,"\n") # remove blank lines for TMail
-      while ticket.match(/CF\.\{[\w_ ]*[ ]+[\w ]*\}/) #replace CF spaces with underscores
-        ticket.gsub!(/CF\.\{([\w_ ]*)([ ]+)([\w ]*)\}/, 'CF.{\1_\3}')
-      end
-      th = TMail::Mail.parse(ticket)
-      reply = {}
-      th.each_header do |k,v|
-        case k
-          when 'created','due','told','lastupdated','started'
-            begin
-              vv = DateTime.parse(v.to_s)
-              reply["#{k}"] = vv.strftime("%Y-%m-%d %H:%M:%S")
-            rescue ArgumentError
-              reply["#{k}"] = v.to_s
-            end
-          else
-            reply["#{k}"] = v.to_s
-        end
-      end
-      replies.push reply
-    end
-    replies
-  end
-  # Get a list of history transactions for a ticket.  Takes a ticket ID and
+	# Get a list of tickets matching some criteria.
+	# Takes a string Ticket-SQL query and an optional "order by" parameter.
+	# The order by is an RT field, prefix it with + for ascending
+	# or - for descending.
+	# Returns a nested array of arrays containing [ticket number, subject]
+	# The outer array is in the order requested.
+	#
+	#  hash = rt.list(:query => "Queue = 'Sales'")
+	#  hash = rt.list("Queue='Sales'")
+	#  hash = rt.list(:query => "Queue = 'Sales'", :order => "-Id")
+	#  hash = rt.list("Queue='Sales'","-Id")
+	def list(*params)
+		query = params[0]
+		order = ""
+		if params.size > 1
+			order = params[1]
+		end
+		if params[0].class == Hash
+			params = params[0]
+			query = params[:query] if params.has_key? :query
+			order = params[:order] if params.has_key? :order
+		end
+		reply = []
+		resp = @site["search/ticket/?query=#{URI.escape(query)}&orderby=#{order}&format=s"].get
+		raise "Invalid query (#{query})" if resp =~ /Invalid query/
+		resp = resp.split("\n") # convert to array of lines
+		resp.each do |line|
+			f = line.match(/^(\d+):\s*(.*)/)
+			reply.push [f[1],f[2]] if f.class == MatchData
+		end
+		reply
+	end
+	# A more extensive(expensive) query then the list method.  Takes the same
+	# parameters as the list method; a string Ticket-SQL query and optional
+	# order, but returns a lot more information.  Instead of just the ID and
+	# subject, you get back an array of hashes, where each hash represents
+	# one ticket, indentical to what you get from the show method (which only
+	# acts on one ticket).  Use with caution; this can take a long time to
+	# execute.
+	#
+	#  array = rt.query("Queue='Sales'")
+	#  array = rt.query(:query => "Queue='Sales'",:order => "+Id")
+	#  array = rt.query("Queue='Sales'","+Id")
+	#  => array[0] = { "id" => "123", "requestors" => "someone@..", etc etc }
+	#  => array[1] = { "id" => "126", "requestors" => "someone@else..", etc etc }
+	#  => array[0]["id"] = "123"
+	def query(*params)
+		query = params[0]
+		order = ""
+		if params.size > 1
+			order = params[1]
+		end
+		if params[0].class == Hash
+			params = params[0]
+			query = params[:query] if params.has_key? :query
+			order = params[:order] if params.has_key? :order
+		end
+		replies = []
+		resp = @site["search/ticket/?query=#{URI.escape(query)}&orderby=#{order}&format=l"].get
+		return replies if resp =~/No matching results./
+		raise "Invalid query (#{query})" if resp =~ /Invalid query/
+		resp.gsub!(/RT\/\d+\.\d+\.\d+\s\d{3}\s.*\n\n/,"") # strip HTTP response
+		tickets = resp.split("\n--\n") # -- occurs between each ticket
+		tickets.each do |ticket|
+			ticket_h = response_to_h(ticket)
+			reply = {}
+			ticket_h.each do |k,v|
+				case k
+				when 'created','due','told','lastupdated','started'
+					begin
+						vv = DateTime.parse(v.to_s)
+						reply["#{k}"] = vv.strftime("%Y-%m-%d %H:%M:%S")
+					rescue ArgumentError
+						reply["#{k}"] = v.to_s
+					end
+				else
+					reply["#{k}"] = v.to_s
+				end
+			end
+			replies.push reply
+		end
+		replies
+	end
+	# Get a list of history transactions for a ticket.  Takes a ticket ID and
   # an optional format parameter.  If the format is ommitted, the short
   # format is assumed.  If the short format is requested, it returns an
   # array of 2 element arrays, where each 2-element array is [ticket_id,
@@ -496,6 +457,11 @@ class RT_Client
     id = id.to_s
     id = $~[1] if id =~ /ticket\/(\d+)/
     resp = @site["ticket/#{id}/history?format=#{format[0,1]}"].get
+    resp.gsub!(0x1C.chr,'[FS]')
+    resp.gsub!(0x1D.chr,'[GS]')
+    resp.gsub!(0x1E.chr,'[RS]')
+    resp.gsub!(0x1F.chr,'[US]')
     if format[0,1] == "s"
       if comments
         h = resp.split("\n").select{ |l| l =~ /^\d+:/ }
@@ -510,13 +476,14 @@ class RT_Client
       while resp.match(/CF\.\{[\w_ ]*[ ]+[\w ]*\}/) #replace CF spaces with underscores
         resp.gsub!(/CF\.\{([\w_ ]*)([ ]+)([\w ]*)\}/, 'CF.{\1_\3}')
       end
       items = resp.split("\n--\n")
       list = []
       items.each do |item|
-        th = TMail::Mail.parse(item)
+        th = response_to_h(item)
         next if not comments and th["type"].to_s =~ /Comment/ # skip comments
         reply = {}
-        th.each_header do |k,v|
+        th.each do |k,v|
           attachments = []
           case k
             when "attachments"
@@ -540,7 +507,7 @@ class RT_Client
               end
             when "content"
               reply["content"] = v.to_s
-              temp = item.match(/^Content: (.*?)^\w+:/m) # TMail strips line breaks
+              temp = item.match(/^Content: (.*?)^\w+:/m)
               reply["content"] = temp[1] if temp.class != NilClass
             else
               reply["#{k}"] = v.to_s
@@ -571,7 +538,6 @@ class RT_Client
       id = params[:id] if params.has_key? :id
       history = params[:history] if params.has_key? :history
     end
-    reply = {}
     resp = @site["ticket/#{id}/history/id/#{history}"].get
     return reply if resp =~ /not related/ # history id must be related to the ticket id
     resp.gsub!(/RT\/\d+\.\d+\.\d+\s\d{3}\s.*\n\n/,"") # toss the HTTP response
@@ -580,9 +546,9 @@ class RT_Client
     while resp.match(/CF\.\{[\w_ ]*[ ]+[\w ]*\}/) #replace CF spaces with underscores
       resp.gsub!(/CF\.\{([\w_ ]*)([ ]+)([\w ]*)\}/, 'CF.{\1_\3}')
     end
-    th = TMail::Mail.parse(resp)
+    th = response_to_h(resp)
     attachments = []
-    th.each_header do |k,v|
+    th.each do |k,v|
       case k
         when "attachments"
           temp = resp.match(/Attachments:\s*(.*)[^\w|$]/m)
@@ -605,7 +571,7 @@ class RT_Client
           end
         when "content"
           reply["content"] = v.to_s
-          temp = resp.match(/^Content: (.*?)^\w+:/m) # TMail strips line breaks
+          temp = resp.match(/^Content: (.*?)^\w+:/m)
           reply["content"] = temp[1] if temp.class != NilClass
         else
           reply["#{k}"] = v.to_s
@@ -635,7 +601,7 @@ class RT_Client
     while resp.match(/CF\.\{[\w_ ]*[ ]+[\w ]*\}/) #replace CF spaces with underscores
       resp.gsub!(/CF\.\{([\w_ ]*)([ ]+)([\w ]*)\}/, 'CF.{\1_\3}')
     end
-    th = TMail::Mail.parse(resp)
+    th = response_to_h(resp)
     list = []
     pattern = /(\d+:\s.*?\)),/
     match = pattern.match(th['attachments'].to_s)
@@ -694,9 +660,9 @@ class RT_Client
     while resp.match(/CF\.\{[\w_ ]*[ ]+[\w ]*\}/) #replace CF spaces with underscores
       resp.gsub!(/CF\.\{([\w_ ]*)([ ]+)([\w ]*)\}/, 'CF.{\1_\3}')
     end
-    headers = TMail::Mail.parse(resp)
+    headers = response_to_h(resp)
     reply = {}
-    headers.each_header do |k,v|
+    headers.each do |k,v|
       reply["#{k}"] = v.to_s
     end
     content = resp.match(/Content:\s+(.*)/m)[1]
@@ -765,63 +731,84 @@ class RT_Client
     end
   end
-  # don't give up the password when the object is inspected
-  def inspect # :nodoc:
-    mystr = super()
-    mystr.gsub!(/(.)pass=.*?([,\}])/,"\\1pass=<hidden>\\2")
-    mystr
-  end
-  private
-  # Private helper for composing RT's "forms".  Requires a hash where the
-  # keys are field names for an RT form.  If there's a :Text key, the value
-  # is modified to insert whitespace on continuation lines.  If there's an
-  # :Attachment key, the value is assumed to be a comma-separated list of
-  # filenames to attach.  It returns a multipart MIME body complete
-  # with boundaries and headers, suitable for an HTTP POST.
-  def compose(fields) # :doc:
-    body = ""
-    if fields.class != Hash
-      raise "RT_Client.compose requires parameters as a hash."
-    end
-    # fixup Text field for RFC822 compliance
-    if fields.has_key? :Text
-      fields[:Text].gsub!(/\n/,"\n ") # insert a space on continuation lines.
-    end
-    # attachments
-    if fields.has_key? :Attachments
-      fields[:Attachment] = fields[:Attachments]
-      fields.delete :Attachments
-    end
-    if fields.has_key? :Attachment
-      filenames = fields[:Attachment].split(',')
-      i = 0
-      filenames.each do |v|
-        filename = File.basename(v)
-        mime_type = MIME::Types.type_for(v)[0]
-        i += 1
-        param_name = "attachment_#{i.to_s}"
-        body << "--#{@boundary}\r\n"
-        body << "Content-Disposition: form-data; "
-        body << "name=\"#{URI.escape(param_name.to_s)}\"; "
-        body << "filename=\"#{URI.escape(filename)}\"\r\n"
-        body << "Content-Type: #{mime_type.simplified}\r\n\r\n"
-        body << File.read(v) # oh dear, lets hope you have lots of RAM
-      end
-      # strip paths from filenames
-      fields[:Attachment] = filenames.map {|f| File.basename(f)}.join(',')
-    end
-    field_array = fields.map { |k,v| "#{k}: #{v}" }
-    content = field_array.join("\n") # our form
-    # add the form to the end of any attachments
-    body << "--#{@boundary}\r\n"
-    body << "Content-Disposition: form-data; "
-    body << "name=\"content\";\r\n\r\n"
-    body << content << "\r\n"
-    body << "--#{@boundary}--\r\n"
-    body
-  end
+	# don't give up the password when the object is inspected
+	def inspect # :nodoc:
+		mystr = super()
+		mystr.gsub!(/(.)pass=.*?([,\}])/,"\\1pass=<hidden>\\2")
+		mystr
+	end
+        # helper to convert responses from RT REST to a hash
+	def response_to_h(resp)
+		resp.gsub!(/RT\/\d+\.\d+\.\d+\s\d{3}\s.*\n\n/,"") # toss the HTTP response
+		#resp.gsub!(/\n\n/,"\n") # remove double spacing, TMail stops at a blank line
+		# unfold folded fields
+		# A newline followed by one or more spaces is treated as a
+		# single space
+		resp.gsub!(/\n +/, " ")
+		#replace CF spaces with underscores
+		while resp.match(/CF\.\{[\w_ ]*[ ]+[\w ]*\}/)
+			resp.gsub!(/CF\.\{([\w_ ]*)([ ]+)([\w ]*)\}/, 'CF.{\1_\3}')
+		end
+		return {:error => resp }  if resp =~ /does not exist./
+		# convert fields to key value pairs
+		ret = {}
+		resp.each_line do |ln|
+			next unless ln =~ /^.+?:/
+			ln_a = ln.split(/:/,2)
+			ln_a.map! {|item| item.strip}
+			ln_a[0].downcase!
+			ret[ln_a[0]] = ln_a[1]
+		end
+		return ret
+	end
+	# Helper for composing RT's "forms".  Requires a hash where the
+	# keys are field names for an RT form.	If there's a :Text key, the value
+	# is modified to insert whitespace on continuation lines.  If there's an
+	# :Attachment key, the value is assumed to be a comma-separated list of
+	# filenames to attach.	It returns a hash to be used with rest-client's
+	# payload class
+	def compose(fields) # :doc:
+		if fields.class != Hash
+			raise "RT_Client.compose requires parameters as a hash."
+		end
+		payload = { :multipart => true }
+		# attachments
+		if fields.has_key? :Attachments
+			fields[:Attachment] = fields[:Attachments]
+			fields.delete :Attachments
+		end
+		if fields.has_key? :Attachment
+			filenames = fields[:Attachment].split(',')
+			attachment_num = 1
+			filenames.each do |f|
+				payload["attachment_#{attachment_num.to_s}"] = File.new(f)
+				attachment_num += 1
+			end
+			# strip paths from filenames
+			fields[:Attachment] = filenames.map {|f| File.basename(f)}.join(',')
+		end
+		# fixup Text field for RFC822 compliance
+		if fields.has_key? :Text
+			fields[:Text].gsub!(/\n/,"\n ") # insert a space on continuation lines.
+		end
+		field_array = fields.map { |k,v| "#{k}: #{v}" }
+		content = field_array.join("\n") # our form
+		payload["content"] = content
+		return payload
+	end
 end

data/rt/rtxmlsrv.rb CHANGED Viewed

@@ -8,7 +8,6 @@ require "rubygems"             # so we can load gems
 require "rt/client"            # rt-client REST library
 require "xmlrpc/server"        # that's what we're doing
 require "date"                 # for parsing arbitrary date formats
-require "pp"
 PORT=8080
 MAX_CONN=50

metadata CHANGED Viewed

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: rt-client
 version: !ruby/object:Gem::Version
-  hash: 11
-  prerelease: false
-  segments:
-  - 0
-  - 5
-  - 0
-  version: 0.5.0
+  prerelease:
+  version: 0.6.4
 platform: ruby
 authors:
 - Tom Lahti
@@ -15,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00 -07:00
-default_executable:
+date: 2013-07-31 00:00:00 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -26,105 +20,9 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        hash: 25
-        segments:
-        - 0
-        - 9
         version: "0.9"
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency
-  name: tmail
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        hash: 31
-        segments:
-        - 1
-        - 2
-        - 0
-        version: 1.2.0
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        hash: 47
-        segments:
-        - 1
-        - 16
-        version: "1.16"
-  type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency
-  name: archive-tar-minitar
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        hash: 1
-        segments:
-        - 0
-        - 5
-        version: "0.5"
-  type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        hash: 11
-        segments:
-        - 1
-        - 2
-        version: "1.2"
-  type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency
-  name: hoe
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        hash: 51
-        segments:
-        - 1
-        - 9
-        - 0
-        version: 1.9.0
-  type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        hash: 5
-        segments:
-        - 0
-        - 7
-        version: "0.7"
-  type: :runtime
-  version_requirements: *id007
 description: "    RT_Client is a ruby object that accesses the REST interface version 1.0\n    of a Request Tracker instance.  See http://www.bestpractical.com/ for\n    Request Tracker.\n"
 email: tlahti@dmsolutions.com
 executables: []
@@ -136,7 +34,6 @@ extra_rdoc_files: []
 files:
 - rt/client.rb
 - rt/rtxmlsrv.rb
-has_rdoc: true
 homepage:
 licenses: []
@@ -152,25 +49,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      hash: 59
-      segments:
-      - 1
-      - 8
-      - 6
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      hash: 3
-      segments:
-      - 0
       version: "0"
 requirements:
 - A working installation of RT with the REST 1.0 interface
 rubyforge_project:
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key:
 specification_version: 3
 summary: Ruby object for RT access via REST