roust 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a329790a5839a6b93c0d313c917c4c000f9e2a7
-  data.tar.gz: 8bcafe4ef3bb915df0eebec3b839932726862a1b
+  metadata.gz: cef798971363e9cf2f7413d94e90b84573281480
+  data.tar.gz: f6310fab56e67982258e61b0c038aac6b44a266d
 SHA512:
-  metadata.gz: 6782ef99b98042e6a70a1d4e3e25b7ea221fbbbf4132343ef877eb8af8cf3a188b710283388132f76b3d16048a9e81055e0f9af7dbd9f6eb4f158e224809a54f
-  data.tar.gz: d6d9576b2fefd81e07782030a3fa9cccfb4e2db8a999915d720b136f898ec50f937f5d7a1b5891d045f6b02db4bca2a185a75541435e187b2c5cecdd990653ca
+  metadata.gz: 14173684c35624ecc5ff42142de0c26b9a233c42f96c9f8a5fa43134f23b2a77ccca45d498541b41a6538d2eebd3f05eeb4935cab549d9fcc1bb29feb5ec354d
+  data.tar.gz: 6e64614597cc7f8c3df383e75bfdba00f05b425b768b79bc9a922adcf8f6893de2c34b49aeab65c78cb7dfa535557c7c413b54bf248f53c367cd1dfb48ee838a

data/Gemfile

@@ -9,4 +9,5 @@ group :development do
   gem 'colorize'
   gem 'rake'
   gem 'webmock'
+  gem 'pry'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roust (1.2.0)
+    roust (1.3.0)
       activesupport (>= 4.1.0)
       httparty (>= 0.13.1)
       mail (>= 2.5.4)
@@ -16,6 +16,7 @@ GEM
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
     addressable (2.3.5)
+    coderay (1.0.9)
     colorize (0.5.8)
     crack (0.4.1)
       safe_yaml (~> 0.9.0)
@@ -28,10 +29,15 @@ GEM
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
+    method_source (0.8.2)
     mime-types (1.25.1)
     minitest (5.3.3)
     multi_xml (0.5.5)
     polyglot (0.3.4)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rake (10.1.0)
     rspec (2.9.0)
       rspec-core (~> 2.9.0)
@@ -42,6 +48,7 @@ GEM
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.9.0)
     safe_yaml (0.9.7)
+    slop (3.4.6)
     thread_safe (0.3.3)
     treetop (1.4.15)
       polyglot
@@ -57,6 +64,7 @@ PLATFORMS
 
 DEPENDENCIES
   colorize
+  pry
   rake
   roust!
   rspec

data/README.md

@@ -55,6 +55,10 @@ rt.history("1", :format => "long") # => [{"id"=>"1", "ticket"=>"1", "timetaken"=
 
 # 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", … }
 ```
 
 

data/lib/roust/version.rb

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

data/lib/roust.rb

@@ -46,7 +46,7 @@ class Roust
   def show(id)
     response = self.class.get("/ticket/#{id}/show")
 
-    body, status = handle_response(response)
+    body, status = explode_response(response)
 
     if match = body.match(/^# (Ticket (\d+) does not exist\.)/)
       return { 'error' => match[1] }
@@ -136,7 +136,7 @@ class Roust
       },
     )
 
-    body, status = handle_response(response)
+    body, status = explode_response(response)
 
     case body
     when /^# Could not create ticket/
@@ -155,28 +155,7 @@ class Roust
   end
 
   def update(id, attrs)
-    default_attrs = {
-      'id' => "ticket/#{id}"
-    }
-    attrs = default_attrs.merge(attrs).stringify_keys!
-
-    content = attrs.map { |k,v|
-      # Don't lowercase strings if they're already camel cased.
-      k = case
-      when k.is_a?(Symbol)
-        k.to_s
-      when k == 'id'
-        k
-      when k =~ /^[a-z]/
-        k.capitalize
-      else
-        k
-      end
-
-      v = v.join(', ') if v.respond_to?(:join)
-
-      "#{k}: #{v}"
-    }.join("\n")
+    content = compose_content('ticket', id, attrs)
 
     response = self.class.post(
       "/ticket/#{id}/edit",
@@ -185,7 +164,7 @@ class Roust
       },
     )
 
-    body, status = handle_response(response)
+    body, status = explode_response(response)
 
     case body
     when /^# You are not allowed to modify ticket \d+/
@@ -236,7 +215,7 @@ class Roust
 
     response = self.class.get("/ticket/#{id}/history", :query => params)
 
-    body, status = handle_response(response)
+    body, status = explode_response(response)
 
     case format
     when 'short'
@@ -246,14 +225,14 @@ class Roust
     end
   end
 
-  # id can be numeric (e.g. 28) or textual (e.g. john)
-  def user(id)
-    response = self.class.get("/user/#{id}")
+  # 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)
+    body, status = explode_response(response)
     case body
-    when /No user named/
-     nil
+    when /No queue named/
+      nil
     else
       body.gsub!(/\n\s*\n/,"\n") # remove blank lines for Mail
       message = Mail.new(body)
@@ -265,14 +244,14 @@ class Roust
     end
   end
 
-  # id can be numeric (e.g. 28) or textual (e.g. sales)
-  def queue(id)
-    response = self.class.get("/queue/#{id}")
+  # id can be numeric (e.g. 28) or textual (e.g. john)
+  def user_show(id)
+    response = self.class.get("/user/#{id}")
 
-    body, status = handle_response(response)
+    body, status = explode_response(response)
     case body
-    when /No queue named/
-      nil
+    when /No user named/
+     nil
     else
       body.gsub!(/\n\s*\n/,"\n") # remove blank lines for Mail
       message = Mail.new(body)
@@ -284,8 +263,62 @@ class Roust
     end
   end
 
+  alias :user :user_show
+
+  def user_update(id, attrs)
+    content = compose_content('user', id, attrs)
+
+    response = self.class.post(
+      "/user/#{id}/edit",
+      :body => {
+        :content => content
+      },
+    )
+
+    body, status = explode_response(response)
+
+    case body
+    when /^# You are not allowed to modify user \d+/
+      { 'error' => body.strip }
+    when /^# Syntax error/
+      { 'error' => body.strip }
+    when /^# User (.+) updated/
+      id = body[/^# User (.+) updated/, 1]
+      user_show(id)
+    else
+      # We should never hit this, but if we do, just pass it through and
+      # surprise the user (!!!).
+      body
+    end
+  end
+
   private
-  def handle_response(response)
+  def compose_content(type, id, attrs)
+    default_attrs = {
+      'id' => [ type, id ].join('/')
+    }
+    attrs = default_attrs.merge(attrs).stringify_keys!
+
+    content = attrs.map { |k,v|
+      # Don't lowercase strings if they're already camel cased.
+      k = case
+      when k.is_a?(Symbol)
+        k.to_s
+      when k == 'id'
+        k
+      when k =~ /^[a-z]/
+        k.capitalize
+      else
+        k
+      end
+
+      v = v.join(', ') if v.respond_to?(:join)
+
+      "#{k}: #{v}"
+    }.join("\n")
+  end
+
+  def explode_response(response)
     body   = response.body
     status = body[/RT\/\d+\.\d+\.\d+\s(\d{3}\s.*)\n/, 1]
 

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

@@ -0,0 +1,21 @@
+RT/3.4.6 200 Ok
+
+id: user/160000
+Name: dan
+Password: ********
+EmailAddress: dan@us.example
+RealName: Daniel 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/mocks/user-dan@us.example-edit.txt

@@ -0,0 +1,3 @@
+RT/3.4.6 200 Ok
+
+# User dan@us.example updated.

data/spec/roust_spec.rb

@@ -47,6 +47,12 @@ describe "Roust" do
                  :body    => mocks_path.join('user-nil.txt').read,
                  :headers => {})
 
+    stub_request(:post, "http://rt.example.org/REST/1.0/user/dan@us.example/edit").
+         with(:body => "content=id%3A%20user%2Fdan%40us.example%0ARealName%3A%20Daniel%20Smith").
+         to_return(:status => 200,
+                   :body   => mocks_path.join('user-dan@us.example-edit.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,
@@ -56,6 +62,7 @@ describe "Roust" do
        to_return(:status => 200,
                  :body    => mocks_path.join('queue-nil.txt').read,
                  :headers => {})
+
   end
 
   describe 'authentication' do
@@ -130,13 +137,13 @@ describe "Roust" do
   end
 
   describe 'user' do
-    it "can lookup user details" 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")
+      user = rt.user_show('dan@us.example')
       attrs.each do |attr|
         user[attr].should_not be_nil, "#{attr} key doesn't exist"
       end
@@ -146,9 +153,27 @@ describe "Roust" do
       rt = Roust.new(@credentials)
       rt.authenticated?.should be_true
 
-      queue = rt.user('nil')
+      queue = rt.user_show('nil')
       queue.should be_nil
     end
+
+    it 'can modify an existing user' do
+      mocks_path = Pathname.new(__FILE__).parent.join('mocks')
+      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-after-edit.txt').read,
+                   :headers => {})
+
+      rt = Roust.new(@credentials)
+      rt.authenticated?.should be_true
+
+      attrs = %w(name realname gecos nickname emailaddress id lang password)
+
+      attrs = { 'RealName' => 'Daniel Smith' }
+      user  = rt.user_update('dan@us.example', attrs)
+
+      user['realname'].should == 'Daniel Smith'
+    end
   end
 
   describe 'queue' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roust
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Lindsay Holmwood
@@ -77,6 +77,8 @@ files:
 - 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-after-edit.txt
+- spec/mocks/user-dan@us.example-edit.txt
 - spec/mocks/user-dan@us.example.txt
 - spec/mocks/user-nil.txt
 - spec/roust_spec.rb
@@ -112,6 +114,8 @@ test_files:
 - 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-after-edit.txt
+- spec/mocks/user-dan@us.example-edit.txt
 - spec/mocks/user-dan@us.example.txt
 - spec/mocks/user-nil.txt
 - spec/roust_spec.rb