roust 1.0.0

data/spec/mocks/ticket-1-history-short.txt

@@ -0,0 +1,71 @@
+RT/3.4.6 200 Ok
+
+# 67/67 (/total)
+
+1: Ticket created by eve
+2: Status changed from 'open' to 'resolved' by eve
+3: Comments added by eve
+8342: Correspondence added by build@us.example
+8343: Status changed from 'resolved' to 'open' by RT_System
+8344: Correspondence added by build@us.example
+8345: Status changed from 'open' to 'open' by RT_System
+8489: Comments added by eve
+8490: Status changed from 'open' to 'resolved' by eve
+9044: Correspondence added by build@us.example
+9045: Status changed from 'resolved' to 'open' by RT_System
+9046: Correspondence added by build@us.example
+9047: Status changed from 'open' to 'open' by RT_System
+9048: Correspondence added by build@us.example
+9049: Status changed from 'open' to 'open' by RT_System
+9050: Correspondence added by build@us.example
+9051: Status changed from 'open' to 'open' by RT_System
+9052: Correspondence added by build@us.example
+9053: Status changed from 'open' to 'open' by RT_System
+9054: Correspondence added by build@us.example
+9055: Status changed from 'open' to 'open' by RT_System
+9196: Comments added by eve
+9197: Given to john by eve
+9205: Queue changed from dev-request to zz-spare9 by eve
+9384: Ticket deleted by john
+11905: Correspondence added by build@us.example
+11906: Status changed from 'dead' to 'open' by RT_System
+12424: Ticket deleted by john
+831334: Status changed from 'deleted' to 'resolved' by ed
+831335: Outgoing email recorded by RT_System
+1194030: Member  added by RT_System
+1194050: Member  added by RT_System
+1194077: Member  added by RT_System
+1194097: Member  added by RT_System
+5241431: Status changed from 'resolved' to 'open' by dave
+5241432: Outgoing email recorded by RT_System
+5241434: Status changed from 'open' to 'resolved' by dave
+5241435: Outgoing email recorded by RT_System
+13820886: Member ticket #1318622 added by alice
+13820896: Member ticket #1318622 deleted by alice
+13820968: Member ticket #1318622 added by alice
+13821080: Member ticket #1318622 deleted by alice
+13821608: Member ticket #1318622 added by alice
+13821626: Member ticket #1318622 deleted by alice
+13825728: Member ticket #1318622 added by alice
+13825732: Member ticket #1318622 deleted by alice
+13825768: Member ticket #1318622 added by alice
+13825804: Member ticket #1318622 deleted by alice
+13825808: Member ticket #1318622 added by alice
+13825848: Member ticket #1318622 deleted by alice
+13825900: Member ticket #1318622 added by alice
+13826056: Dependency by ticket #1318622 added by alice
+13826060: Dependency by ticket #1318622 deleted by alice
+13826084: Dependency by ticket #1318622 added by alice
+13826236: Dependency by ticket #1318622 deleted by alice
+13826564: Dependency by ticket #1318622 added by alice
+13826586: Dependency by ticket #1318622 deleted by alice
+13826698: Member ticket #1318622 deleted by alice
+13827384: Member ticket #1318622 added by bob
+13827490: Member ticket #1318622 deleted by alice
+13827574: Member ticket #1318622 added by alice
+13827764: Member ticket #1318622 deleted by alice
+13829160: Member ticket #1318622 added by bob
+13829214: Member ticket #1318622 deleted by bob
+18722474: Member ticket #1784812 added by erin
+18722620: Member ticket #1784812 added by erin
+18722792: Member ticket #1784812 deleted by erin

data/spec/mocks/ticket-1-show.txt

@@ -0,0 +1,31 @@
+RT/3.4.6 200 Ok
+
+id: ticket/1
+Queue: support
+Owner: bob
+Creator: alice
+Subject: Heavy packet loss
+Status: open
+Priority: 101
+InitialPriority: 101
+FinalPriority: 100
+
+Requestors: carol@them.example, chuck@them.example,
+            craig@them.example
+
+Cc: dan@us.example, dave@them.example
+
+AdminCc: erin@us.example, eve@us.example,
+         frank@us.example, oscar@us.example,
+         peggy@us.example, trent@us.example
+
+Created: Tue Dec 11 07:59:31 2012
+Starts: Not set
+Started: Not set
+Due: Wed Dec 12 20:58:48 2012
+Resolved: Wed Jan 16 16:33:15 2013
+Told: Mon Jan 07 15:27:09 2013
+LastUpdated: Wed Nov 06 09:33:43 2013
+TimeEstimated: 0
+TimeWorked: 12 hours
+TimeLeft: 0

data/spec/mocks/ticket-search-1-or-2.txt

@@ -0,0 +1,4 @@
+RT/3.4.6 200 Ok
+
+1: tell Nestor password for ROAR website
+2: Blum

data/spec/mocks/user-dan@us.example.txt

@@ -0,0 +1,21 @@
+RT/3.4.6 200 Ok
+
+id: user/160000
+Name: dan
+Password: ********
+EmailAddress: dan@us.example
+RealName: Dan Smith
+NickName: dan
+Gecos: dan
+Zip: quote
+MobilePhone: 0400123456
+PagerPhone: DESC
+
+Signature: Dan Smith
+           Engineer
+           Example Org
+           tel: 1300 000 123
+           mob: 0400 123 456
+           fax: 02 9000 1234
+
+Lang: en

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'pathname'
+lib = Pathname.new(__FILE__).parent.parent.join('lib').to_s
+$: << lib
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+
+  # Rspec 3 forward compatibility
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end
+

data/spec/ticket_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+require 'roust'
+
+describe "Roust" do
+  before do
+    @credentials = {
+      :server   => 'http://rt.example.org',
+      :username => 'admin',
+      :password => 'password'
+    }
+    mocks_path = Pathname.new(__FILE__).parent.join('mocks')
+
+    stub_request(:post, "http://rt.example.org/REST/1.0/").
+      with(:body => {
+            "user"=>"admin",
+            "pass"=>"password",
+           }).
+      to_return(:status => 200, :body => "", :headers => {})
+
+
+    stub_request(:get, "http://rt.example.org/REST/1.0/ticket/1/show").
+      to_return(:status  => 200,
+                :body    => mocks_path.join('ticket-1-show.txt').read,
+                :headers => {})
+
+    stub_request(:get, "http://rt.example.org/REST/1.0/search/ticket/?format=s&orderby=&query=id%20=%201%20or%20id%20=%202").
+       to_return(:status  => 200,
+                 :body    => mocks_path.join('ticket-search-1-or-2.txt').read,
+                 :headers => {})
+
+    stub_request(:get, "http://rt.example.org/REST/1.0/ticket/1/history?format=s").
+       to_return(:status  => 200,
+                 :body    => mocks_path.join('ticket-1-history-short.txt').read,
+                 :headers => {})
+
+    stub_request(:get, "http://rt.example.org/REST/1.0/ticket/1/history?format=l").
+       to_return(:status  => 200,
+                 :body    => mocks_path.join('ticket-1-history-long.txt').read,
+                 :headers => {})
+
+    stub_request(:get, "http://rt.example.org/REST/1.0/user/dan@us.example").
+       to_return(:status  => 200,
+                 :body    => mocks_path.join('user-dan@us.example.txt').read,
+                 :headers => {})
+  end
+
+  it "authenticates on instantiation" do
+    rt = Roust.new(@credentials)
+    rt.authenticated?.should be_true
+  end
+
+  it "can list tickets matching a query" do
+    rt = Roust.new(@credentials)
+    rt.authenticated?.should be_true
+
+    results = rt.list(:query => "id = 1 or id = 2")
+    results.size.should == 2
+    results.each do |result|
+      result.size.should == 2
+    end
+  end
+
+  it "can fetch metadata on individual tickets" do
+    rt = Roust.new(@credentials)
+    rt.authenticated?.should be_true
+
+    ticket = rt.show("1")
+    ticket.should_not be_nil
+
+    attrs = %w(id subject queue) +
+            %w(requestors cc admincc owner creator) +
+            %w(resolved status) +
+            %w(starts started timeleft due timeworked timeestimated) +
+            %w(lastupdated created told) +
+            %w(priority finalpriority initialpriority)
+
+    attrs.each do |attr|
+      ticket[attr].should_not be_nil, "#{attr} key doesn't exist"
+    end
+
+    %w(requestors cc admincc).each do |field|
+      ticket[field].size.should > 1
+    end
+  end
+
+  it "can fetch transactions on individual tickets" do
+    rt = Roust.new(@credentials)
+    rt.authenticated?.should be_true
+
+    short = rt.history("1", :format => "short")
+
+    short.size.should > 1
+    short.each do |txn|
+      txn.size.should == 2
+      txn.first.should match(/^\d+$/)
+      txn.last.should  match(/^\w.*\w$/)
+    end
+
+    #attrs = %w(ticket data oldvalue creator timetaken) +
+    #        %w(id type field newvalue content description) +
+    #        %w(attachments created)
+    attrs = %w(ticket data oldvalue timetaken) +
+            %w(id type field newvalue content description)
+
+    long = rt.history("1", :format => "long")
+    long.size.should > 0
+    long.each do |txn|
+      attrs.each do |attr|
+        txn[attr].should_not be_nil, "#{attr} key doesn't exist"
+      end
+    end
+  end
+
+  it "can find user details" do
+    rt = Roust.new(@credentials)
+    rt.authenticated?.should be_true
+
+    attrs = %w(name realname gecos nickname emailaddress id lang password)
+
+    user = rt.user("dan@us.example")
+    attrs.each do |attr|
+      user[attr].should_not be_nil, "#{attr} key doesn't exist"
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: roust
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lindsay Holmwood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: archive-tar-minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Roust is a Ruby API client that accesses the REST interface version 1.0
+  of a Request Tracker instance. See http://www.bestpractical.com/ for Request Tracker.
+email:
+- lindsay@holmwood.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- examples/example.rb
+- lib/roust.rb
+- lib/roust/rtxmlsrv.rb
+- lib/roust/version.rb
+- roust.gemspec
+- spec/mocks/ticket-1-history-long.txt
+- spec/mocks/ticket-1-history-short.txt
+- spec/mocks/ticket-1-show.txt
+- spec/mocks/ticket-search-1-or-2.txt
+- spec/mocks/user-dan@us.example.txt
+- spec/spec_helper.rb
+- spec/ticket_spec.rb
+homepage: http://github.com/bulletproofnetworks/roust
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for RT's REST API
+test_files:
+- spec/mocks/ticket-1-history-long.txt
+- spec/mocks/ticket-1-history-short.txt
+- spec/mocks/ticket-1-show.txt
+- spec/mocks/ticket-search-1-or-2.txt
+- spec/mocks/user-dan@us.example.txt
+- spec/spec_helper.rb
+- spec/ticket_spec.rb