roust 1.8.1 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4b39b8c377e3ff0189444fc873909125f5c8a6c
-  data.tar.gz: 397ca6c7c0d04ce9ae323e03c7e98f4f4551c938
+  metadata.gz: 66c9350b75b1aac09b2b1d5c17401654d9b336bb
+  data.tar.gz: 2255b4b1690b40658e610c0b52ced4cd8de75e97
 SHA512:
-  metadata.gz: 25d96d2bbb5c5545772e05fcc8c6541e44b010c3a06a9ebaa9e0802b7ddeaa66e285d1dbd1be0448fbfc4ff6bcc1a8826cd8df3c9dc8d4795c5a94146b4283c4
-  data.tar.gz: 21ee9e8dffa21cf36b97866d2a51e2f35189a8a0c127ca167fa0b1090dd26293cde9fdd2417e046707567234e11894cc80b7d95a3eed6744e65ee397d596df67
+  metadata.gz: 01fd887c2725ef17cc14873c5677c3d7991e3c4fdeb7f3252ad1e59c72485a3b335b3e1a973f8f75c76e17a4d7bcc74de62697aa7ab4539a698ad44babe5b8bf
+  data.tar.gz: 94a0c365649b4ccbe28b417877223ada824fbae37d3e4a84c7fea8f0c2829b0e32ebfa01b6ac2bc40048315b4257f96c5fbf4858bc0eb069348db144360b255c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roust (1.8.1)
+    roust (1.8.2)
       activesupport (>= 4.0.10)
       httparty (>= 0.13.1)
       mail (>= 2.5.4)
@@ -9,11 +9,11 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.1.8)
-      i18n (~> 0.6, >= 0.6.9)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.1)
+      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     addressable (2.3.6)
     ast (2.0.0)
@@ -27,13 +27,13 @@ GEM
     httparty (0.13.3)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
-    i18n (0.6.11)
-    json (1.8.1)
+    i18n (0.7.0)
+    json (1.8.2)
     mail (2.6.3)
       mime-types (>= 1.16, < 3)
     method_source (0.8.2)
     mime-types (2.4.3)
-    minitest (5.4.3)
+    minitest (5.5.1)
     multi_xml (0.5.5)
     parser (2.2.0.pre.8)
       ast (>= 1.1, < 3.0)

data/README.md

@@ -12,6 +12,7 @@ Features
 - 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
 
 Installing
 ----------
@@ -77,6 +78,23 @@ attrs = {
 
 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", … }

data/lib/roust/ticket.rb

@@ -82,6 +82,35 @@ class Roust
         end
     end
 
+    def ticket_comment(id, attrs)
+      attrs['Text'].gsub!(/\n/, "\n ") if attrs['Text'] # insert a space on continuation lines.
+      content = compose_content('ticket', id, attrs)
+
+      unless content.match(/Action: (comment|correspond)/i)
+        raise "'Action' must be one of 'Comment' or 'Correspond'"
+      end
+
+      response = self.class.post(
+        "/ticket/#{id}/comment",
+        :body => {
+          :content => content
+        },
+      )
+
+        body, _ = explode_response(response)
+
+        case body
+        when /^# Message recorded/
+          ticket_show(id)
+        when /^# You are not allowed to modify ticket \d+/
+          raise Unauthorized, body
+        when /^# Syntax error/
+          raise SyntaxError, body
+        else
+          raise UnhandledResponse, body
+        end
+    end
+
     def ticket_search(attrs)
       params = {
         :format  => 's',

data/lib/roust/version.rb

@@ -1,3 +1,3 @@
 class Roust
-  VERSION = '1.8.1'
+  VERSION = '1.8.2'
 end

data/spec/mocks/ticket-100-comment.txt

@@ -0,0 +1,3 @@
+RT/3.4.6 200 Ok
+
+# Message recorded.

data/spec/roust/ticket_spec.rb

@@ -60,6 +60,16 @@ describe Roust do
                   :body    => mocks_path.join('ticket-100-update.txt').read,
                   :headers => {})
 
+    stub_request(:post, "http://rt.example.org/REST/1.0/ticket/100/comment")
+      .with { |request|
+        query = WebMock::Util::QueryMapper.query_to_values(request.body)
+        require 'pry'
+
+        true
+      }.to_return(:status => 200,
+                  :body    => mocks_path.join('ticket-100-comment.txt').read,
+                  :headers => {})
+
     stub_request(:get, 'http://rt.example.org/REST/1.0/ticket/100/show')
       .to_return(:status  => 200,
                  :body    => mocks_path.join('ticket-100-show.txt').read,
@@ -206,6 +216,36 @@ describe Roust do
         }
     end
 
+    it 'can comment on a ticket' do
+      attrs = {
+        'action' => 'comment',
+        'text'   => 'this is a test comment'
+      }
+      ticket = @rt.ticket_comment(100, attrs)
+
+      expect(WebMock).to have_requested(:post, "rt.example.org/REST/1.0/ticket/100/comment")
+        .with { |request|
+          query = WebMock::Util::QueryMapper.query_to_values(request.body)
+          query['content'] =~ /Action: comment/ &&
+          query['content'] =~ /Text: this is a test comment/
+        }
+    end
+
+    it 'can correspond on a ticket' do
+      attrs = {
+        'action' => 'correspond',
+        'text'   => 'this is a test piece of correspondence'
+      }
+      ticket = @rt.ticket_comment(100, attrs)
+
+      expect(WebMock).to have_requested(:post, "rt.example.org/REST/1.0/ticket/100/comment")
+        .with { |request|
+          query = WebMock::Util::QueryMapper.query_to_values(request.body)
+          query['content'] =~ /Action: correspond/ &&
+          query['content'] =~ /Text: this is a test piece of correspondence/
+        }
+    end
+
     it 'adds links' do
       attrs = {
         'RefersTo' => [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roust
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.2
 platform: ruby
 authors:
 - Lindsay Holmwood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -84,6 +84,7 @@ files:
 - spec/mocks/ticket-1-history-short.txt
 - spec/mocks/ticket-1-show-unauthenticated.txt
 - spec/mocks/ticket-1-show.txt
+- spec/mocks/ticket-100-comment.txt
 - spec/mocks/ticket-100-show.txt
 - spec/mocks/ticket-100-update.txt
 - spec/mocks/ticket-150-links-update.txt
@@ -131,4 +132,34 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby client for RT's REST API
-test_files: []
+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-unauthenticated.txt
+- spec/mocks/ticket-1-show.txt
+- spec/mocks/ticket-100-comment.txt
+- spec/mocks/ticket-100-show.txt
+- spec/mocks/ticket-100-update.txt
+- spec/mocks/ticket-150-links-update.txt
+- spec/mocks/ticket-150-links.txt
+- spec/mocks/ticket-151-links-update.txt
+- spec/mocks/ticket-151-links.txt
+- spec/mocks/ticket-3-links.txt
+- spec/mocks/ticket-99-show.txt
+- spec/mocks/ticket-create.txt
+- spec/mocks/ticket-search-1-or-2-long.txt
+- spec/mocks/ticket-search-1-or-2.txt
+- spec/mocks/ticket-search-that-does-not-exist.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-erin@us.example-create.txt
+- spec/mocks/user-erin@us.example.txt
+- spec/mocks/user-nil.txt
+- spec/roust/authentication_spec.rb
+- spec/roust/queue_spec.rb
+- spec/roust/ticket_spec.rb
+- spec/roust/user_spec.rb
+- spec/spec_helper.rb