rt-client 0.6.4 → 0.6.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec6bec56c3684933cf883aa29967fbd037c2f5b5
+  data.tar.gz: 62d27a2c55a33d8647601fb22ae951c407ee6f04
+SHA512:
+  metadata.gz: 6db4f242a6d547c87248daaa8b80f1b170461a1432aa4c34016eaa90f207f261f68e4f8a771aa2c93387d3bf4079f949a51049abc6475b18f6d0317cd1347e9a
+  data.tar.gz: b1e599f20d38cc691af50637c1b1bfa4560b8a4368775a283473f719b6c474fcae7dbfa20261404fb9866ec97fcd1a03dad1fb69d6e50f7c08860ca7039cd0c8

data/.yardopts

@@ -0,0 +1,2 @@
+--title RT Client
+*.rb

data/rt/client.rb

@@ -3,36 +3,42 @@
 require "rubygems"
 require "rest_client"
 
+## Author:: Tom Lahti
+## Copyright:: Copyright (c) 2013 Tom Lahti
+## License:: Apache 2.0
+
+#{<img src="https://badge.fury.io/rb/rt-client.png" alt="Gem Version" />}[http://badge.fury.io/rb/rt-client]
 ##A ruby library API to Request Tracker's REST interface. Requires the
-##rubygems rest-client, mail and mime-types to be installed.  You can
+##rubygem rest-client 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, e.g. "CF.{Has_Space}"
+##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, 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.
+##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.6.4"
+	UA = "Mozilla/5.0 ruby RT Client Interface 0.6.8"
 	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
+	# 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
@@ -57,7 +63,7 @@ class RT_Client
 	#  cookies=<directory>
 	def initialize(*params)
 		@boundary = "----xYzZY#{rand(1000000).to_s}xYzZY"
-		@version = "0.4.0"
+		@version = "0.6.8"
 		@status = "Not connected"
 		@server = "http://localhost/"
 		@user = "rt_user"
@@ -102,7 +108,7 @@ class RT_Client
 		end
 
 
-		site = RestClient::Resource.new(@resource, :headers => headers, :timeout => 120)
+		site = RestClient::Resource.new(@resource, :headers => headers, :timeout => 240)
 		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
@@ -180,33 +186,33 @@ class RT_Client
     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",
-	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
+  # 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
+  # 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"
@@ -295,7 +301,7 @@ class RT_Client
   # Find RT user details from an email address
   #
   # rt.usersearch(:EmailAddress => 'some@email.com')
-  # => {"name"=>"rtlogin", "realname"=>"John Smith", "address1"=>"123 Main", etc }
+  # -> {"name"=>"rtlogin", "realname"=>"John Smith", "address1"=>"123 Main", etc }
   def usersearch(field_hash)
     if field_hash.has_key? :EmailAddress
       email = field_hash[:EmailAddress]
@@ -467,6 +473,7 @@ class RT_Client
         h = resp.split("\n").select{ |l| l =~ /^\d+:/ }
       else
         h = resp.split("\n").select{ |l| l =~ /^\d+: [^Comments]/ }
+        h.select!{ |l| l !~ /Outgoing email about a comment/ }
       end
       list = h.map { |l| l.split(":") }
     else
@@ -538,6 +545,7 @@ 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
@@ -740,7 +748,7 @@ class RT_Client
 	end
 
         # helper to convert responses from RT REST to a hash
-	def response_to_h(resp)
+	def response_to_h(resp) # :nodoc:
 		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
 
@@ -774,7 +782,7 @@ class RT_Client
 	# :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:
+	def compose(fields) # :nodoc:
 		if fields.class != Hash
 			raise "RT_Client.compose requires parameters as a hash."
 		end

metadata

@@ -1,67 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rt-client
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.6.4
+version: !ruby/object:Gem::Version
+  version: 0.6.8
 platform: ruby
-authors: 
+authors:
 - Tom Lahti
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-07-31 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :runtime
-  version_requirements: *id001
-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"
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |2
+      RT_Client is a ruby object that accesses the REST interface version 1.0
+      of a Request Tracker instance.  See http://www.bestpractical.com/ for
+      Request Tracker.
 email: tlahti@dmsolutions.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- ".yardopts"
 - rt/client.rb
 - rt/rtxmlsrv.rb
-homepage: 
-licenses: []
-
+homepage: http://rubygems.org/gems/rt-client
+licenses:
+- APACHE-2.0
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --inline-source
-- --main
+rdoc_options:
+- "--inline-source"
+- "--main"
 - RT_Client
-require_paths: 
-- .
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+require_paths:
+- "."
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
+    - !ruby/object:Gem::Version
       version: 1.8.6
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
 - A working installation of RT with the REST 1.0 interface
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby object for RT access via REST
 test_files: []
-
+has_rdoc: true