roust 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 968edcfd5087edc2cbd40b101c4bdf216b4bd2c5
-  data.tar.gz: c02c15afb304d95da146cb8c31814f013405922b
+  metadata.gz: 7a329790a5839a6b93c0d313c917c4c000f9e2a7
+  data.tar.gz: 8bcafe4ef3bb915df0eebec3b839932726862a1b
 SHA512:
-  metadata.gz: 8a01186666603fd75969fd3a21245547b8834b5e8269342a9f9ef797a712c5924a94041ff842199e2eb1a9f8611dd65e366a15d1646dabc62bef928a4a587ee1
-  data.tar.gz: 83c4391e331f0f58cd3ccf69b2dc1f96a9ea7013bf3e8b9f135efcdb693058c1cb37e983d483aa2110bbd0aa9019ff03ace536940e721bd45de053565ebebdd3
+  metadata.gz: 6782ef99b98042e6a70a1d4e3e25b7ea221fbbbf4132343ef877eb8af8cf3a188b710283388132f76b3d16048a9e81055e0f9af7dbd9f6eb4f158e224809a54f
+  data.tar.gz: d6d9576b2fefd81e07782030a3fa9cccfb4e2db8a999915d720b136f898ec50f937f5d7a1b5891d045f6b02db4bca2a185a75541435e187b2c5cecdd990653ca

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roust (1.1.0)
+    roust (1.2.0)
       activesupport (>= 4.1.0)
       httparty (>= 0.13.1)
       mail (>= 2.5.4)

data/lib/roust/version.rb

@@ -1,3 +1,3 @@
 class Roust
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/roust.rb

@@ -246,13 +246,33 @@ class Roust
     end
   end
 
-  def user(email)
-    response = self.class.get("/user/#{email}")
+  # id can be numeric (e.g. 28) or textual (e.g. john)
+  def user(id)
+    response = self.class.get("/user/#{id}")
 
     body, status = handle_response(response)
     case body
     when /No user named/
-      {}
+     nil
+    else
+      body.gsub!(/\n\s*\n/,"\n") # remove blank lines for Mail
+      message = Mail.new(body)
+      Hash[message.header.fields.map {|header|
+        key   = header.name.to_s.downcase
+        value = header.value.to_s
+        [ key, value ]
+      }]
+    end
+  end
+
+  # id can be numeric (e.g. 28) or textual (e.g. sales)
+  def queue(id)
+    response = self.class.get("/queue/#{id}")
+
+    body, status = handle_response(response)
+    case body
+    when /No queue named/
+      nil
     else
       body.gsub!(/\n\s*\n/,"\n") # remove blank lines for Mail
       message = Mail.new(body)

data/spec/mocks/queue-13.txt

@@ -0,0 +1,11 @@
+RT/3.4.6 200 Ok
+
+id: queue/28
+Name: support
+Description: Bulletproof Networks Support
+CorrespondAddress: support@bulletproof.net.au
+CommentAddress: rt-comment@bulletproof.net
+InitialPriority: 101
+FinalPriority: 100
+DefaultDueIn: 1
+

data/spec/mocks/queue-nil.txt

@@ -0,0 +1,5 @@
+RT/3.4.6 200 Ok
+
+# No queue named nil exists.
+
+id: queue/nil

data/spec/mocks/user-nil.txt

@@ -0,0 +1,5 @@
+RT/3.4.6 200 Ok
+
+# No user named nil exists.
+
+id: user/nil

data/spec/roust_spec.rb

@@ -0,0 +1,177 @@
+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/index.html").
+      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=%2Bid&query%5Bquery%5D=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 => {})
+
+    stub_request(:get, "http://rt.example.org/REST/1.0/user/nil").
+       to_return(:status  => 200,
+                 :body    => mocks_path.join('user-nil.txt').read,
+                 :headers => {})
+
+    stub_request(:get, "http://rt.example.org/REST/1.0/queue/13").
+       to_return(:status => 200,
+                 :body    => mocks_path.join('queue-13.txt').read,
+                 :headers => {})
+
+    stub_request(:get, "http://rt.example.org/REST/1.0/queue/nil").
+       to_return(:status => 200,
+                 :body    => mocks_path.join('queue-nil.txt').read,
+                 :headers => {})
+  end
+
+  describe 'authentication' do
+    it "authenticates on instantiation" do
+      rt = Roust.new(@credentials)
+      rt.authenticated?.should be_true
+    end
+  end
+
+  describe 'tickets' do
+    it "can list tickets matching a query" do
+      rt = Roust.new(@credentials)
+      rt.authenticated?.should be_true
+
+      results = rt.search(: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
+  end
+
+  describe 'user' do
+    it "can lookup 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
+
+    it 'returns nil for unknown users' do
+      rt = Roust.new(@credentials)
+      rt.authenticated?.should be_true
+
+      queue = rt.user('nil')
+      queue.should be_nil
+    end
+  end
+
+  describe 'queue' do
+    it "can lookup queue details" do
+      rt = Roust.new(@credentials)
+      rt.authenticated?.should be_true
+
+      attrs = %w(id name description correspondaddress commentaddress) +
+              %w(initialpriority finalpriority defaultduein)
+
+      queue = rt.queue('13')
+      attrs.each do |attr|
+        queue[attr].should_not be_nil, "#{attr} key doesn't exist"
+      end
+
+    end
+
+    it 'returns nil for unknown queues' do
+      rt = Roust.new(@credentials)
+      rt.authenticated?.should be_true
+
+      queue = rt.queue('nil')
+      queue.should be_nil
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roust
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Lindsay Holmwood
@@ -71,13 +71,16 @@ files:
 - lib/roust.rb
 - lib/roust/version.rb
 - roust.gemspec
+- spec/mocks/queue-13.txt
+- spec/mocks/queue-nil.txt
 - 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/mocks/user-nil.txt
+- spec/roust_spec.rb
 - spec/spec_helper.rb
-- spec/ticket_spec.rb
 homepage: http://github.com/bulletproofnetworks/roust
 licenses:
 - Apache 2.0
@@ -103,10 +106,13 @@ signing_key:
 specification_version: 4
 summary: Ruby client for RT's REST API
 test_files:
+- spec/mocks/queue-13.txt
+- spec/mocks/queue-nil.txt
 - 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/mocks/user-nil.txt
+- spec/roust_spec.rb
 - spec/spec_helper.rb
-- spec/ticket_spec.rb

data/spec/ticket_spec.rb

@@ -1,124 +0,0 @@
-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/index.html").
-      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=%2Bid&query%5Bquery%5D=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.search(: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