roust 1.7.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0fd7ec9d960d69cac7e4728a7fed55ee4cdd0bb
-  data.tar.gz: 170095fffdbaf6911552314acda4cd04f71698fb
+  metadata.gz: adb62caf4380e165a89d2f82f76d73d547714e53
+  data.tar.gz: 9e4df8a5696550388821a139258f317f31866469
 SHA512:
-  metadata.gz: f986a4c50c33eb97157162d367e5ecfc9273c572146d3fa429dca28a4346bf88fbe14c03ff24f679534c9af560cf67ff80246fcecf84054c5d0557f5ea62154a
-  data.tar.gz: 419951703eaad4a2813cad671f50710f87da264981b4de72e92b0cbd85b5d05e4f69a5a408cbec10f138e3f4cfff8eda231336eaf872df45f0d4962d635be8c3
+  metadata.gz: a66ae81eb10c83712f7bf3adfe96d4e6d01ca764eb15bbfc5164c2e9cec56e3c30d78e9c645a73cdd85d23e690f2921e55cd983d2d28261a08415f997021b314
+  data.tar.gz: d72f69e97951c026451cef70e2c5c2cd1a11963ed2a2c2bbe954e2e2c3b9263a2b0594c97bf6ab38ecbe1034630a792f1fb87539515c32a445be7d18f984ee30

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    roust (1.7.2)
-      activesupport (>= 4.1.0)
+    roust (1.8.0)
+      activesupport (>= 4.0.10)
       httparty (>= 0.13.1)
       mail (>= 2.5.4)
 

data/README.md

@@ -55,11 +55,28 @@ rt.history("1", :format => "short") # => [["1", "Ticket created by alice"], ["2"
 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 test ticket',
-  'Queue' => 'sales'
+  'Subject' => 'A new subject'
+  'Owner'   => 'alice'
 }
-rt.create(attrs) # => { 'Subject' => 'a test ticket', 'Queue' => 'sales', … }
+
+rt.ticket_update(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

@@ -136,21 +136,148 @@ class Roust
       end
     end
 
-    def ticket_links(id)
+    def ticket_links_show(id)
       response = self.class.get("/ticket/#{id}/links")
       body, _ = explode_response(response)
 
       hash = body_to_hash(body)
       id = hash.delete('id').split('/')[1]
       cleaned_hash = hash.map do |k, v|
-        ids = v.split(/\s*,\s*/).map {|url| url.split('/').last }
+        ids = v.split(/\s*,\s*/).map do |url|
+          url =~ /^fsck\.com\-/ ? url.split('/').last : url
+        end
         [ k, ids ]
       end
 
       Hash[cleaned_hash].merge('id' => id)
     end
 
-    # TODO(auxesis): add method for updating ticket links
+    # Add links on a ticket.
+    #
+    # @param id [Fixnum] the id of the ticket to add links on.
+    # @param attrs [Hash] the links to add.
+    # @return [Hash] all the links on the ticket after the add action.
+    #
+    # Example attrs:
+    #
+    #   {
+    #     "RefersTo" => [
+    #       "http://us.example",
+    #       "http://them.example",
+    #     ]
+    #   }
+    #
+    def ticket_links_add(id, attrs)
+      # Get the current links state
+      current_links = ticket_links_show(id)
+      current_links.delete('id')
+      desired_links = Marshal.load(Marshal.dump(current_links))
+
+      # Build up the desired link state
+      attrs.each do |k,v|
+        desired_links[k] ||= []
+        v.each do |link|
+          desired_links[k] << link
+        end
+        desired_links[k].uniq!
+      end
+
+      # Remove all links before we add any new ones. Fucking RT API.
+      ticket_links_remove(id, current_links)
+
+      # Work out how many times we'll need to make the same request until we
+      # get the desired state.
+      tries = desired_links.max_by {|k,v| v.size }.last.size
+
+      tries.times do
+        content = compose_content('ticket', id, desired_links)
+
+        response = self.class.post(
+          "/ticket/#{id}/links",
+          :body => {
+            :content => content
+          }
+        )
+
+        body, _ = explode_response(response)
+
+        case body
+        when /^# Links for ticket (\d+) updated/
+          id = $1
+          #ticket_links_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
+
+      ticket_links_show(id)
+    end
+
+    # Remove links on a ticket.
+    #
+    # @param id [Fixnum] the id of the ticket to remove links on.
+    # @param attrs [Hash] the links to remove.
+    # @return [Hash] all the links on the ticket after the remove action.
+    #
+    # Example attrs:
+    #
+    #   {
+    #     "DependsOn" => [
+    #       "http://us.example",
+    #       "http://them.example",
+    #     ],
+    #     "RefersTo" => [
+    #       "http://others.example",
+    #     ],
+    #   }
+    #
+    def ticket_links_remove(id, attrs)
+      # Get the current links state
+      current_links = ticket_links_show(id)
+      desired_links = Marshal.load(Marshal.dump(current_links))
+
+      # Build up the desired link state
+      attrs.each do |k,v|
+        v.each do |link|
+          desired_links[k].delete(link) if desired_links[k]
+        end
+      end
+
+      # Work out how many times we'll need to make the same request until we
+      # get the desired state.
+      tries = attrs.empty? ? 0 : attrs.max_by {|k,v| v.size }.last.size
+
+      tries.times do
+        content = compose_content('ticket', id, desired_links)
+
+        response = self.class.post(
+          "/ticket/#{id}/links",
+          :body => {
+            :content => content
+          }
+        )
+
+        body, _ = explode_response(response)
+
+        case body
+        when /^# Links for ticket (\d+) updated/
+          id = $1
+        when /^# You are not allowed to modify ticket \d+/
+          raise Unauthorized, body
+        when /^# Syntax error/
+          raise SyntaxError, body
+        else
+          raise UnhandledResponse, body
+        end
+      end
+
+      ticket_links_show(id)
+    end
+
     # TODO(auxesis): add method for listing ticket attachments
     # TODO(auxesis): add method for getting a ticket attachment
     # TODO(auxesis): add method for commenting on a ticket

data/lib/roust/version.rb

@@ -1,3 +1,3 @@
 class Roust
-  VERSION = '1.7.2'
+  VERSION = '1.8.0'
 end

data/roust.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'mail',                '>= 2.5.4'
   s.add_runtime_dependency 'httparty',            '>= 0.13.1'
-  s.add_runtime_dependency 'activesupport',       '>= 4.1.0'
+  s.add_runtime_dependency 'activesupport',       '>= 4.0.10'
 end

data/spec/mocks/ticket-150-links-update.txt

@@ -0,0 +1,3 @@
+RT/3.4.6 200 Ok
+
+# Links for ticket 150 updated

data/spec/mocks/ticket-150-links.txt

@@ -0,0 +1,12 @@
+RT/3.4.6 200 Ok
+
+id: ticket/150/links
+
+RefersTo: http://google.com/,
+          http://google.com.au/,
+          http://google.co.uk/,
+          http://google.ca/,
+
+DependsOn: http://amazon.com/,
+           http://amazon.co.uk/
+

data/spec/mocks/ticket-151-links-update.txt

@@ -0,0 +1,3 @@
+RT/3.4.6 200 Ok
+
+# Links for ticket 151 updated

data/spec/mocks/ticket-151-links.txt

@@ -0,0 +1,4 @@
+RT/3.4.6 200 Ok
+
+id: ticket/151/links
+

data/spec/roust/ticket_spec.rb

@@ -65,6 +65,26 @@ describe Roust do
                  :body    => mocks_path.join('ticket-100-show.txt').read,
                  :headers => {})
 
+    stub_request(:get, "http://rt.example.org/REST/1.0/ticket/150/links")
+      .to_return(:status  => 200,
+                 :body    => mocks_path.join('ticket-150-links.txt').read,
+                 :headers => {})
+
+    stub_request(:post, "http://rt.example.org/REST/1.0/ticket/150/links")
+      .to_return(:status  => 200,
+                 :body    => mocks_path.join('ticket-150-links-update.txt').read,
+                 :headers => {})
+
+    stub_request(:get, "http://rt.example.org/REST/1.0/ticket/151/links")
+      .to_return(:status  => 200,
+                 :body    => mocks_path.join('ticket-151-links.txt').read,
+                 :headers => {})
+
+    stub_request(:post, "http://rt.example.org/REST/1.0/ticket/151/links")
+      .to_return(:status  => 200,
+                 :body    => mocks_path.join('ticket-151-links-update.txt').read,
+                 :headers => {})
+
     @rt = Roust.new(credentials)
     expect(@rt.authenticated?).to eq(true)
   end
@@ -147,7 +167,7 @@ describe Roust do
     end
 
     it 'can list linked tickets on individual tickets' do
-      links = @rt.ticket_links('3')
+      links = @rt.ticket_links_show('3')
 
       expect(links['id']).to eq('3')
 
@@ -169,7 +189,7 @@ describe Roust do
       end
     end
 
-    it 'transforms attribute case when creating or updating tickets' do
+    it 'transforms attribute case when manipulating principals' do
       attrs = {
         'requestors' => 'alice@them.example,bob@them.example',
         'cc'         => 'charlie@them.example',
@@ -185,5 +205,45 @@ describe Roust do
           query['content'] =~ /AdminCc:/
         }
     end
+
+    it 'adds links' do
+      attrs = {
+        'RefersTo' => [
+          'http://google.com/',
+          'http://google.com.au/',
+          'http://google.co.uk/',
+          'http://google.ca/',
+        ],
+        'DependsOn' => [
+          'http://amazon.com/',
+          'http://amazon.co.uk/',
+        ]
+      }
+      ticket = @rt.ticket_links_add(150, attrs)
+
+      expect(ticket['RefersTo'].size).to eq(attrs['RefersTo'].size)
+      expect(ticket['DependsOn'].size).to eq(attrs['DependsOn'].size)
+    end
+
+    it 'removes links' do
+      attrs = {
+        'RefersTo' => [
+          'http://google.com/',
+          'http://google.com.au/',
+          'http://google.co.uk/',
+          'http://google.ca/',
+        ],
+        'DependsOn' => [
+          'http://amazon.com/',
+          'http://amazon.co.uk/',
+        ]
+      }
+      ticket = @rt.ticket_links_remove(151, attrs)
+
+      expect(ticket['RefersTo']).to eq(nil)
+      expect(ticket['DependsOn']).to eq(nil)
+    end
+
+    it 'transforms attribute case when manipulating links'
   end
 end

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ require 'pathname'
 lib = Pathname.new(__FILE__).parent.parent.join('lib').to_s
 $LOAD_PATH << lib
 require 'webmock/rspec'
+require 'pry'
 
 RSpec.configure do |config|
   # Use color not only in STDOUT but also in pagers and files

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roust
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.8.0
 platform: ruby
 authors:
 - Lindsay Holmwood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-08 00:00:00.000000000 Z
+date: 2014-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.0.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.0.10
 description: Roust is a Ruby API client to access Request Tracker's REST interface.
 email:
 - lindsay@holmwood.id.au
@@ -86,6 +86,10 @@ files:
 - spec/mocks/ticket-1-show.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
@@ -136,6 +140,10 @@ test_files:
 - spec/mocks/ticket-1-show.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