Roust is a Ruby client for Request Tracker's REST API.
It is a complete fork of rt-client by Tom Lahti, and shares little ancestry.
- Ticket querying using the full RT query language
- Fetching ticket metadata (id, subject, queue, etc)
- Fetching transactions on individual tickets (in long and short form)
- Fetching user details
- Adding comments or correspondence to tickets
- Supports custom HTTP headers (default User-Agent is "Roust")
Ensure you have Ruby >= 2.0 installed, then run:
gem install roust
Or add to your Gemfile:
gem 'roust', :git => 'git@github.com:bulletproofnetworks/roust.git'
require 'roust'
credentials = {
:server => 'http://rt.example.org/',
:username => 'admin',
:password => 's3cr3t'
}
# Optional headers:
headers = {
'Host' => 'custom.example.org',
'User-Agent' => 'Roust in dev environment'
}
rt = Roust.new(credentials, headers)
rt.authenticated? # => true
# Query RT
rt.search(:query => "id = 1 or id = 2") # => [ {"id"=>"1", "Subject"=>"tell Nestor password for ROAR website"}, {"id"=>"2", "Subject"=>"Blum"} ]
rt.search(:query => "id = 1 or id = 2", :verbose => true) # => [ { "Subject"=>"Heavy packet loss", "id"=>"1", "Queue"=>"support", "Owner"=>"bob", "Creator"=>"alice", ... } ]
# Fetch ticket metadata
rt.show("1") # => { {"cc"=>["dan@us.example", "dave@them.example"], "owner"=>"bob", "creator"=>"alice", "status"=>"open", … }
# Fetch ticket transactions
rt.history("1", :format => "short") # => [["1", "Ticket created by alice"], ["2", "Status changed from 'open' to 'resolved' by bob"]]
rt.history("1", :format => "long") # => [{"id"=>"1", "ticket"=>"1", "timetaken"=>"0", "type"=>"Create", "field"=>"", "oldvalue"=>"", "newvalue"=>"", "data"=>"", "description"=>"Ticket created by alice" }, … ]
# Create ticket
body = """This is a multiline
text body"""
attrs = {
'Subject' => 'A test ticket',
'Queue' => 'sales',
'Owner' => 'Nobody',
'Requestors' => 'a@test.com, b@test.com',
'Cc' => 'c@test.com, d@test.com',
'AdminCc' => 'e@test.com, f@test.com',
'Text' => body
}
rt.ticket_create(attrs) # => { 'Subject' => 'a test ticket', 'Queue' => 'sales', … }
# Update ticket
attrs = {
'Subject' => 'A new subject',
'Owner' => 'alice'
}
rt.ticket_update(ticket_id, attrs) # => { 'Subject' => 'a test ticket', 'Queue' => 'sales', … }
# Add comments to a ticket
attrs = {
'Action' => 'comment',
'Text' => 'this is a test comment'
}
rt.ticket_comment(ticket_id, attrs) # => { 'Subject' => 'a test ticket', 'Queue' => 'sales', … }
# Add correspondence to a ticket
attrs = {
'Action' => 'correspond',
'Text' => 'this is a test piece of correspondence, which will email out to requestors'
}
rt.ticket_comment(ticket_id, attrs) # => { 'Subject' => 'a test ticket', 'Queue' => 'sales', … }
# Fetch user details
rt.user("dan@us.example") # => {"id"=>"user/160000", "name"=>"dan", "password"=>"********", "emailaddress"=>"dan@us.example", "realname"=>"Dan Smith", "nickname"=>"dan", … }
# Fetch queue details
rt.queue(1) # => {"id"=>"queue/1", "name"=>"sales", "description"=>"Sales", "correspondaddress"=>"sales@us.example", "commentaddress"=>"rt-comment@us.example", … }
rt.queue('sales') # => {"id"=>"queue/1", "name"=>"sales", "description"=>"Sales", "correspondaddress"=>"sales@us.example", "commentaddress"=>"rt-comment@us.example", … }
To get started, clone the Roust repository locally by running:
git clone git@github.com:bulletproofnetworks/roust.git
Then pull in the dependencies:
bundle
You're now ready to run the tests:
bundle exec rake
Roust has reasonable test coverage of the core features mentioned above. It has some other features that have been ported from the original rt-client implementation that are not tested (and are probably broken). See the TODO section for more details.
- Bump the version in
lib/roust/version.rb
- Run a
bundle
to update any RubyGems dependencies. - git tag the version git tag X.Y.Z
- Build the gem with
rake build
- Push the gem with
rake push
- Attachment fetching