ludo-roart 0.1.13 → 0.1.14

data/README.rdoc

@@ -68,6 +68,26 @@ If you are using Best Practical's Request Tracker (RT) and you need to interact
     ticket = Ticket.find(23452)
     ticket.comment("This is a lovely Ticket", :time_worked => 45, :cc => 'someone@example.com'))
 
+* Attachments
+
+RT REST does support attachments on ticket create and update.
+Comments have to be used instead.
+
+Forum link http://www.gossamer-threads.com/lists/rt/users/106049
+Wiki link http://requesttracker.wikia.com/wiki/REST#Ticket_Attachments
+
+    ticket = Ticket.find(23452)
+
+    # File path
+    ticket.comment("This is a comment", :attachments => "/tmp/filename.txt")
+
+    # Attachment as a file descriptor
+    ticket.comment("This is a comment", :attachments => File.open("/tmp/filename.txt", "rb"))
+
+    # Attachment as a ActionDispatch::Http::UploadedFile instance
+    ticket.comment("This is a comment", :attachments => [params[:attachment_1], params[:attachment_2]])
+
+
 
 == REQUIREMENTS:
 

data/lib/roart/core/hash.rb

@@ -1,23 +1,17 @@
 class Hash
-   def to_content_format
-    fields = []
-
-    self.each do |key, values|
-      next if values.nil?
-
-      key_name = 
+  def to_content_format
+    fields = self.map do |key,value|
+      unless value.nil?
+        value = Roart::ContentFormatter.format_string(value.to_s)
         if key.to_s.match(/^cf_.+/)
-          "CF-#{key.to_s[3..key.to_s.length].gsub(/_/, " ").camelize.humanize}"
+          "CF-#{key.to_s[3..key.to_s.length].gsub(/_/, " ").camelize.humanize}: #{value}"
         elsif key.to_s.match(/^CF-.+/)
-          "#{key.to_s}"
+          "#{key.to_s}: #{value}"
+        elsif key.to_s.match(/^[a|A]ttachments/)
+          "Attachment: #{value.join(",")}" if value.kind_of?(Array)
         else
-          "#{key.to_s.camelize}"
+          "#{key.to_s.camelize}: #{value}"
         end
-
-      values = [values] unless values.is_a?(Array)
-      values.each do |value|
-        value = Roart::ContentFormatter.format_string(value.to_s)
-        fields << "#{key_name}: #{value}"
       end
     end
     content = fields.compact.sort.join("\n")

data/lib/roart/ticket.rb

@@ -67,12 +67,27 @@ module Roart
     # Example:
     #   tix = Ticket.find(1000)
     #   tix.comment("This is a comment", :time_worked => 45, :cc => 'someone@example.com')
+    #
+    #   Attachments
+    #   tix.comment("This is a comment", :attachments => "/tmp/filename.txt")
+    #
+    #   Attachment as a file descriptor
+    #   tix.comment("This is a comment", :attachments => File.open("/tmp/filename.txt", "rb"))
+    #
+    #   Attachment as a ActionDispatch::Http::UploadedFile instance
+    #   tix.comment("This is a comment", :attachments => [params[:attachment_1], params[:attachment_2]])
+    #
     def comment(comment, opt = {})
       comment = {:text => comment, :action => 'Correspond'}.merge(opt)
 
       uri = "#{self.class.connection.server}/REST/1.0/ticket/#{self.id}/comment"
-      payload = comment.to_content_format
-      resp = self.class.connection.post(uri, :content => payload)
+
+      attachments = Roart::Attachment.detect(comment[:attachments])
+
+      comment.merge!(:attachment => attachments.map(&:name).join(",")) unless attachments.empty?
+
+      resp = self.class.connection.post(uri, {:content => comment.to_content_format}.merge(attachments.to_payload))
+
       resp = resp.split("\n")
       raise TicketSystemError, "Ticket Comment Failed" unless resp.first.include?("200")
       !!resp[2].match(/^# Message recorded/)
@@ -96,7 +111,6 @@ module Roart
         uri = "#{self.class.connection.server}/REST/1.0/ticket/new"
         payload = @attributes.to_content_format
         resp = self.class.connection.post(uri, :content => payload)
-
         process_save_response(resp, :create)
       end
 

data/roart.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ludo-roart}
-  s.version = "0.1.13"
+  s.version = "0.1.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["PJ Davis"]
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.description = %q{Interface for working with Request Tracker (RT) tickets inspired by ActiveRecord.}
   s.email = %q{pj.davis@gmail.com}
   s.extra_rdoc_files = ["History.txt", "README.rdoc", "spec/test_data/full_history.txt", "spec/test_data/search_ticket.txt", "spec/test_data/single_history.txt", "spec/test_data/ticket.txt"]
-  s.files = ["History.txt", "README.rdoc", "Rakefile", "lib/roart.rb", "lib/roart/callbacks.rb", "lib/roart/connection.rb", "lib/roart/connection_adapter.rb", "lib/roart/connection_adapters/mechanize_adapter.rb", "lib/roart/core/hash.rb", "lib/roart/core/content_formatter.rb", "lib/roart/errors.rb", "lib/roart/history.rb", "lib/roart/roart.rb", "lib/roart/ticket.rb", "lib/roart/ticket_page.rb", "lib/roart/validations.rb", "roart.gemspec", "spec/roart/callbacks_spec.rb", "spec/roart/connection_adapter_spec.rb", "spec/roart/connection_spec.rb", "spec/roart/core/hash_spec.rb", "spec/roart/history_spec.rb", "spec/roart/roart_spec.rb", "spec/roart/ticket_page_spec.rb", "spec/roart/ticket_spec.rb", "spec/roart/validation_spec.rb", "spec/roart_spec.rb", "spec/spec_helper.rb", "spec/test_data/full_history.txt", "spec/test_data/search_ticket.txt", "spec/test_data/single_history.txt", "spec/test_data/ticket.txt"]
+  s.files = ["History.txt", "README.rdoc", "Rakefile", "lib/roart.rb", "lib/roart/callbacks.rb", "lib/roart/connection.rb", "lib/roart/connection_adapter.rb", "lib/roart/connection_adapters/mechanize_adapter.rb", "lib/roart/core/hash.rb", "lib/roart/errors.rb", "lib/roart/history.rb", "lib/roart/roart.rb", "lib/roart/ticket.rb", "lib/roart/ticket_page.rb", "lib/roart/validations.rb", "roart.gemspec", "spec/roart/callbacks_spec.rb", "spec/roart/connection_adapter_spec.rb", "spec/roart/connection_spec.rb", "spec/roart/core/hash_spec.rb", "spec/roart/history_spec.rb", "spec/roart/roart_spec.rb", "spec/roart/ticket_page_spec.rb", "spec/roart/ticket_spec.rb", "spec/roart/validation_spec.rb", "spec/roart_spec.rb", "spec/spec_helper.rb", "spec/test_data/full_history.txt", "spec/test_data/search_ticket.txt", "spec/test_data/single_history.txt", "spec/test_data/ticket.txt"]
   s.homepage = %q{http://github.com/pjdavis/roart}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/spec/roart/core/hash_spec.rb

@@ -2,31 +2,39 @@ require File.join(File.dirname(__FILE__), %w[ .. .. spec_helper])
 
 describe 'hash extentions' do
 
-  it 'should format the content correctly' do
-    payload = {:subject => "A New Ticket", :queue => 'My Queue'}
-    payload.to_content_format.include?("Subject: A New Ticket").should be_true
-    payload.to_content_format.include?("Queue: My Queue").should be_true
-  end
-  
-  it 'should handel custom fields' do
-    payload = {:cf_stuff => 'field'}
-    payload.to_content_format.should == "CF-Stuff: field"
-  end
+  describe "#to_content_format" do
+    it 'should format the content correctly' do
+      payload = {:subject => "A New Ticket", :queue => 'My Queue'}
+      payload.to_content_format.include?("Subject: A New Ticket").should be_true
+      payload.to_content_format.include?("Queue: My Queue").should be_true
+    end
 
-  it 'should NOT change custom key when it starts with CF-' do
-    payload = { 'CF-My CustomField wiTout magic' => 'hello' }
-    payload.to_content_format.should == "CF-My CustomField wiTout magic: hello"
-  end
+    it 'should handel custom fields' do
+      payload = {:cf_stuff => 'field'}
+      payload.to_content_format.should == "CF-Stuff: field"
+    end
 
-  it 'should use our content formatter for strings' do
-    payload = {:subject => 'A new ticket', :queue => 'My queue', :text => "A text"}
-    Roart::ContentFormatter.should_receive(:format_string).at_least(:once)
-    payload.to_content_format
-  end
+    it 'should NOT change custom key when it starts with CF-' do
+      payload = { 'CF-My CustomField wiTout magic' => 'hello' }
+      payload.to_content_format.should == "CF-My CustomField wiTout magic: hello"
+    end
+
+    it 'should use our content formatter for strings' do
+      payload = {:subject => 'A new ticket', :queue => 'My queue', :text => "A text"}
+      Roart::ContentFormatter.should_receive(:format_string).at_least(:once)
+      payload.to_content_format
+    end
+
+    it "should not include attachments into content" do
+      payload = {:subject => 'A new ticket', :queue => 'My queue', :text => "A text", :attachments => '/dev/null'}
+      payload.to_content_format.should_not include("Attachment")
+    end
+
+    it "should not include attachments into content" do
+      payload = {:subject => 'A new ticket', :queue => 'My queue', :text => "A text", :attachment => '/dev/null,/dev/zero'}
+      payload.to_content_format.should include("Attachment")
+    end
 
-  it "should return sorted data with the same key multiple times when value is array" do
-    payload = { 'CF-My Day' => %w(Tue Wed Fri), 'CF-My Time' => %w(morning evening) }
-    payload.to_content_format.should == "CF-My Day: Fri\nCF-My Day: Tue\nCF-My Day: Wed\nCF-My Time: evening\nCF-My Time: morning"
   end
 
 end

data/spec/roart/ticket_spec.rb

@@ -549,5 +549,43 @@ describe "Ticket" do
     end
     
   end
-  
+
+  describe ".comment" do
+    before do
+      @ticket_file = File.expand_path("ticket.txt", File.dirname(__FILE__) + "../../test_data")
+      @lorem_file = File.expand_path("lorem.txt", File.dirname(__FILE__) + "../../test_data")
+      @connection = mock('connection', :server => "localhost", :get => IO.read(@ticket_file))
+    end
+
+    it "should add comment into POST request" do
+      @connection.should_receive(:post).with do |uri, payload|
+        payload.should have_key(:content)
+        payload[:content].should include("Text: test comment")
+      end.and_return("RT/4.0.5 200 Ok\n\n# Message recorded\n\n")
+
+      Roart::Ticket.stub(:connection).and_return(@connection)
+
+      @ticket = Roart::Ticket.find(11111)
+
+      @ticket.comment("test comment")
+    end
+
+    it "should add attachment into POST request" do
+      @connection.should_receive(:post).with do |uri, payload|
+        payload.should have_key(:content)
+        payload[:content].should include("Attachment: lorem.txt")
+
+        payload.should have_key("attachment_1")
+        payload["attachment_1"].should be_a(File)
+      end.and_return("RT/4.0.5 200 Ok\n\n# Message recorded\n\n")
+
+      Roart::Ticket.stub(:connection).and_return(@connection)
+
+      @ticket = Roart::Ticket.find(11111)
+
+      @ticket.comment("test comment", :attachments => @lorem_file)
+    end
+
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ludo-roart
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 1
-  - 13
-  version: 0.1.13
+  - 14
+  version: 0.1.14
 platform: ruby
 authors: 
 - PJ Davis
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-15 00:00:00 +03:00
-default_executable: 
+date: 2010-09-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mechanize
@@ -89,7 +88,6 @@ files:
 - lib/roart/connection_adapter.rb
 - lib/roart/connection_adapters/mechanize_adapter.rb
 - lib/roart/core/hash.rb
-- lib/roart/core/content_formatter.rb
 - lib/roart/errors.rb
 - lib/roart/history.rb
 - lib/roart/roart.rb
@@ -112,7 +110,6 @@ files:
 - spec/test_data/search_ticket.txt
 - spec/test_data/single_history.txt
 - spec/test_data/ticket.txt
-has_rdoc: true
 homepage: http://github.com/pjdavis/roart
 licenses: []
 
@@ -143,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: roart
-rubygems_version: 1.5.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Interface for working with Request Tracker (RT) tickets inspired by ActiveRecord

data/lib/roart/core/content_formatter.rb

@@ -1,12 +0,0 @@
-module Roart
-  class ContentFormatter
-    # The following is only based on quick trial&error on my part. The RT Api (at least in 3.6) does not have good documentation.
-    # Strings in a RT request:
-    #  - are not allowed to contain '\r'
-    #  - must use equally padded new-lines to distinguish them from the beginning of a new field (we use 2-space padding)
-    def self.format_string(string)
-      string.gsub("\r", '').gsub("\n", "\n  ")
-    end
-
-  end
-end