pjdavis-roart 0.1.0 → 0.1.1

data/History.txt

@@ -1,2 +1,5 @@
+== 0.1.1 / 2009-08-17
+Added History functionality. #histories now loads an array of history objects into memory and you can access them like you would a regular array. A few connivence methods (last, count) have also been added.
+
 == 0.1.0 / 2009-08-13
 Initial Commit. Base functionality added. Can search for tickets, and see all info on tickets. Ticket History not yet implemented.

data/Rakefile

@@ -30,6 +30,6 @@ PROJ.description = "Interface for working with Request Tracker (RT) tickets insp
 PROJ.rdoc.main = 'README.rdoc'
 depend_on 'mechanize'
 
-PROJ.spec.opts << '--color'
+PROJ.spec.opts << '--color --heckle'
 
 # EOF

data/lib/roart/connection.rb

@@ -25,6 +25,10 @@ module Roart
       add_methods!
     end
     
+    def rest_path
+      self.server + '/REST/1.0/'
+    end
+    
     def get(uri)
       @agent.get(uri).body
     end

data/lib/roart/history.rb

@@ -0,0 +1,115 @@
+module Roart
+  
+  module Histories
+    
+    DefaultAttributes = %w(creator type description content created)
+    RequiredAttributes = %w(creator type)
+  
+  end
+  
+  class HistoryArray < Array
+    
+    def ticket
+      @default_options[:ticket]
+    end
+    
+    def all
+      self
+    end
+    
+    def count
+      self.size
+    end
+    
+    def last
+      self[self.size - 1]
+    end
+    
+  end
+  
+  class History
+
+#TODO Figure out why i can't include Roart::MethodFunctions
+    def add_methods!
+      @attributes.each do |key, value|
+        (class << self; self; end).send :define_method, key do
+          return value
+        end
+      end 
+    end
+    
+    class << self
+    
+      def default(options)
+        history = self.dup
+        history.instance_variable_set("@default_options", options)
+        history.all
+      end
+    
+      def ticket
+        @default_options[:ticket]
+      end
+    
+      def all
+        @histories ||= get_all
+      end
+      
+      def default_options
+        @default_options
+      end
+      
+      protected
+      
+      def instantiate(attrs)
+        object = nil
+        if attrs.is_a?(Array)
+          array = Array.new
+          attrs.each do |attr|
+            object = self.allocate
+            object.instance_variable_set("@attributes", attr.merge(self.default_options))
+            object.send("add_methods!")
+            array << object
+          end
+          return array
+        elsif attrs.is_a?(Hash)
+          object = self.allocate
+          object.instance_variable_set("@attributes", attrs.merge(self.default_options))
+          object.send("add_methods!")
+        end
+        object
+      end
+      
+      def get_all
+        page = get_page
+        raise TicketSystemError, "Can't get history." unless page
+        raise TicketSystemInterfaceError, "Error getting history for Ticket: #{ticket.id}." unless page.split("\n")[0].include?("200")
+        history_array = get_histories_from_page(page)
+        history_array
+      end
+      
+      def get_histories_from_page(page)
+        full_history = HistoryArray.new
+        for history in page.split(/^--$/)
+          history = history.split("\n")
+          history.extend(Roart::TicketPage)
+          full_history << self.instantiate(history.to_history_hash)
+        end
+        full_history.instance_variable_set("@default_options", @default_options)
+        full_history
+      end
+      
+      def get_page
+        @default_options[:ticket].class.connection.get(uri_for(@default_options[:ticket]))
+      end
+      
+      def uri_for(ticket)
+        uri = self.default_options[:ticket].class.connection.rest_path + "ticket/#{ticket.id}/history?format=l"
+      end
+      
+    end
+    
+    protected 
+    
+  end
+  
+end

data/lib/roart/roart.rb

@@ -8,4 +8,17 @@ module Roart
     end
   end
   
+  
+  module MethodFunctions
+    
+    def add_methods!
+      @attributes.each do |key, value|
+        (class << self; self; end).send :define_method, key do
+          return value
+        end
+      end 
+    end
+    
+  end
+  
 end

data/lib/roart/ticket.rb

@@ -8,6 +8,8 @@ module Roart
   end
   
   class Ticket
+    
+    include Roart::MethodFunctions
   
     def initialize(attributes)
       Roart::check_keys!(attributes, Roart::Tickets::RequiredAttributes)
@@ -32,6 +34,12 @@ module Roart
       end
     end
     
+    #loads the ticket history from rt
+    #
+    def histories
+      @histories ||= Roart::History.default(:ticket => self)
+    end
+    
     class << self #class methods
       
       # Gives or Sets the connection object for the RT Server.
@@ -96,20 +104,20 @@ module Roart
       
       protected
       
-      def instantiate(ticket)
+      def instantiate(attrs)
         object = nil
-        if ticket.is_a?(Array)
+        if attrs.is_a?(Array)
           array = Array.new
-          ticket.each do |tick|
+          attrs.each do |attr|
             object = self.allocate
-            object.instance_variable_set("@attributes", tick)
+            object.instance_variable_set("@attributes", attr)
             object.send("add_methods!")
             array << object
           end
           return array
-        elsif ticket.is_a?(Hash)
+        elsif attrs.is_a?(Hash)
           object = self.allocate
-          object.instance_variable_set("@attributes", ticket)
+          object.instance_variable_set("@attributes", attrs)
           object.send("add_methods!")
         end
         object
@@ -264,16 +272,6 @@ module Roart
       end
       
     end
-      
-    protected
-    
-    def add_methods!
-      @attributes.each do |key, value|
-        (class << self; self; end).send :define_method, key do
-          return value
-        end
-      end 
-    end
     
   end
     

data/lib/roart/ticket_page.rb

@@ -1,6 +1,8 @@
 module Roart
   
   module TicketPage
+    
+    IntKeys = %w[id]
 
     def to_hash
       hash = Hash.new
@@ -32,6 +34,27 @@ module Roart
       end
       array
     end
+
+# TODO: Don't throw away attachments (/^ {13})
+    def to_history_hash
+      hash = Hash.new
+      self.delete_if{|x| !x.include?(":") && !x.match(/^ {9}/) && !x.match(/^ {13}/)}
+      self.each do |ln|
+        if ln.match(/^ {9}/) && !ln.match(/^ {13}/)
+          hash[:content] << "\n" + ln.strip if hash[:content]
+        elsif ln.match(/^ {13}/)
+          hash[:attachments] << "\n" + ln.strip if hash[:attachments]
+        else
+          ln = ln.split(":")
+          unless ln.size == 1 || ln.first == 'Ticket' # we don't want to override the ticket method.
+            key = ln.delete_at(0).strip.underscore
+            value = ln.join(":").strip
+            hash[key.to_sym] = IntKeys.include?(key) ? value.to_i : value
+          end
+        end
+      end
+      hash
+    end
     
   end
   

data/lib/roart.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 module Roart
 
   # :stopdoc:
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/roart.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roart}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["PJ Davis"]
-  s.date = %q{2009-08-14}
+  s.date = %q{2009-08-17}
   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"]
-  s.files = ["History.txt", "README.rdoc", "Rakefile", "lib/roart.rb", "lib/roart/connection.rb", "lib/roart/core/array.rb", "lib/roart/core/string.rb", "lib/roart/errors.rb", "lib/roart/roart.rb", "lib/roart/ticket.rb", "lib/roart/ticket_page.rb", "roart.gemspec", "spec/roart/connection_spec.rb", "spec/roart/core/array_spec.rb", "spec/roart/core/string_spec.rb", "spec/roart/roart_spec.rb", "spec/roart/ticket_page_spec.rb", "spec/roart/ticket_spec.rb", "spec/roart_spec.rb", "spec/spec_helper.rb", "test/test_roart.rb"]
+  s.extra_rdoc_files = ["History.txt", "README.rdoc", "spec/test_data/full_history.txt", "spec/test_data/single_history.txt"]
+  s.files = ["History.txt", "README.rdoc", "Rakefile", "lib/roart.rb", "lib/roart/connection.rb", "lib/roart/core/array.rb", "lib/roart/core/string.rb", "lib/roart/errors.rb", "lib/roart/history.rb", "lib/roart/roart.rb", "lib/roart/ticket.rb", "lib/roart/ticket_page.rb", "roart.gemspec", "spec/roart/connection_spec.rb", "spec/roart/core/array_spec.rb", "spec/roart/core/string_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_spec.rb", "spec/spec_helper.rb", "spec/test_data/full_history.txt", "spec/test_data/single_history.txt", "test/test_roart.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/pjdavis/roart}
   s.rdoc_options = ["--main", "README.rdoc"]

data/spec/roart/history_spec.rb

@@ -0,0 +1,59 @@
+require File.join(File.dirname(__FILE__), %w[ .. spec_helper])
+
+describe "History" do
+  
+  it 'should have a ticket' do
+    search_array = ['1:subject']
+    search_array.extend(Roart::TicketPage)
+    full_ticket = Roart::Ticket.send(:instantiate, {:id => 1, :subject => 'subject', :full => true})
+    @ticket = Roart::Ticket.send(:instantiate, search_array.to_search_array ).first
+    Roart::History.should_receive(:get_page).and_return('200')    
+
+    history = @ticket.histories
+    history.ticket.should == @ticket
+    
+  end
+  
+  describe 'getting ticket history' do
+    
+    it 'should create the crect URI' do
+      connection = mock('connection', :rest_path => 'REST/1.0/')
+      myclass = mock('class', :connection => connection)
+      ticket = mock(:ticket, :id => 1, :class => myclass)
+      hash = mock(:options_hash, :[] => ticket)
+      Roart::History.should_receive(:default_options).and_return(hash)
+      Roart::History.send(:uri_for, ticket).should == 'REST/1.0/ticket/1/history?format=l'
+    end
+  end
+  
+  describe 'reading history pages' do
+    
+    before do
+      @page = File.open(File.join(File.dirname(__FILE__), %w[ .. test_data full_history.txt])).readlines.join
+      Roart::History.should_receive(:get_page).and_return(@page)
+      @histories = Roart::History.default(:ticket => @ticket)
+    end
+    
+    it 'should have the right number of histories' do
+      @histories.size.should == 5
+    end
+    
+    it 'should have a ticket' do
+      @histories.first.ticket.should == @ticket
+    end
+    
+    it 'should have an id' do
+      @histories.first.id.should == 34725
+    end
+    
+    it 'should return itself for all' do
+      @histories.all.should == @histories
+    end
+    
+    it 'should return the ticket' do
+      @histories.ticket.should == @ticket
+    end
+    
+  end
+  
+end 

data/spec/roart/ticket_page_spec.rb

@@ -46,4 +46,26 @@ describe 'ticket page' do
     
   end
   
+  describe 'ticket history hash' do
+    
+    before do
+      @page = File.open(File.join(File.dirname(__FILE__), %w[ .. test_data single_history.txt])).readlines.join
+      @page = @page.split("\n")
+      @page.extend(Roart::TicketPage)
+    end
+    
+    it 'should give back the hash of history' do
+      @page.to_history_hash.class.should == Hash
+    end
+    
+    it 'should have some content' do
+      @page.to_history_hash[:content].should_not be_nil
+    end
+    
+    it 'should have the create type' do
+      @page.to_history_hash[:type].should == 'Create'
+    end
+    
+  end
+  
 end

data/spec/roart/ticket_spec.rb

@@ -296,4 +296,38 @@ describe "Ticket" do
     
   end
   
+  describe 'histories' do
+    
+    before(:each) do
+      search_array = ['1:subject']
+      search_array.extend(Roart::TicketPage)
+      full_ticket = Roart::Ticket.send(:instantiate, {:id => 1, :subject => 'subject', :full => true})
+      @mock_connection.should_receive(:get).with('uri').and_return('200')
+      @ticket = Roart::Ticket.send(:instantiate, search_array.to_search_array).first
+      @ticket.class.should_receive(:connection).and_return(@mock_connection)
+      Roart::History.should_receive(:uri_for).with(@ticket).and_return('uri')
+    end
+    
+    it 'should return history objects' do
+      @ticket.histories.class.should == Roart::HistoryArray
+    end
+    
+    it 'should have a default of the ticket id' do
+      @ticket.histories.ticket.should == @ticket
+    end
+    
+    it 'should only spawn 1 dup class for each ticket' do
+      @ticket.histories.should === @ticket.histories
+    end
+    
+    it 'should have a last history that is equal to the last value' do
+      @ticket.histories.last.should == @ticket.histories[@ticket.histories.size - 1]
+    end
+    
+    it 'should have count, which is equal to size' do
+      @ticket.histories.count.should == @ticket.histories.size
+    end
+    
+  end
+  
 end

data/spec/test_data/full_history.txt

@@ -0,0 +1,126 @@
+RT/3.6.6 200 Ok
+
+# 5/5 (id/34725/total)
+
+id: 34725
+Ticket: 12345
+TimeTaken: 0
+Type: Create
+Field: 
+OldValue: 
+NewValue: 
+Data: 
+Description: Ticket created by Dallas-stezuohc@LEESSUMMITHONDA.COM
+
+Content: Now you can get big real fast at an affordable price
+         http://www.lameppe.com/
+
+
+Creator: Dallas-stezuohc@LEESSUMMITHONDA.COM
+Created: 2008-06-03 09:24:32
+
+Attachments: 
+             16377: untitled (77b)
+             16379: untitled (248b)
+
+
+--
+
+# 5/5 (id/34727/total)
+
+id: 34727
+Ticket: 12345
+TimeTaken: 0
+Type: EmailRecord
+Field: 
+OldValue: 
+NewValue: 
+Data: <rt-3.6.6-50432-1212485073-937.12345-456-0@somewhere.com>
+Description: Outgoing email recorded by RT_System
+
+Content: 
+         Greetings,
+         
+         This message has been automatically generated in response to the creation of a trouble ticket at Somewhere Technical Support regarding:
+         	"SUPPORT EMAIL: Somewhere- 2 pills a day and you will be good"
+         
+         There is no need to reply to this message right now.  Your ticket has been
+         assigned an ID of [RequestTracker #12345].
+         
+         Please include the ID in the subject line, or "reply" to this message, for all future correspondence about this issue.
+         
+         You can also call us 24 hours a day, 7 days a week.
+         
+         We appreciate your business!
+         
+         Sincerely,
+         
+         Somewhere Technical Support Team
+         
+         Thank you,
+         support@somewhere.com
+         1-800-468-3474
+         
+         -------------------------------------------------------------------------
+         Now you can get big real fast at an affordable price
+         http://www.lameppe.com/
+
+
+Creator: RT_System
+Created: 2008-06-03 09:24:33
+Attachments: 
+
+--
+
+# 5/5 (id/34871/total)
+
+id: 34871
+Ticket: 12345
+TimeTaken: 0
+Type: Take
+Field: Owner
+OldValue: 10
+NewValue: 527
+Data: 
+Description: Taken by someone
+Content: This transaction appears to have no content
+Creator: someone
+Created: 2008-06-03 10:39:16
+Attachments: 
+
+--
+
+# 5/5 (id/34883/total)
+
+id: 34883
+Ticket: 12345
+TimeTaken: 0
+Type: Comment
+Field: 
+OldValue: 
+NewValue: 
+Data: No Subject
+Description: Comments added by someone
+Content: SPAM
+Creator: someone
+Created: 2008-06-03 10:39:49
+Attachments: 
+
+--
+
+# 5/5 (id/34885/total)
+
+id: 34885
+Ticket: 12345
+TimeTaken: 0
+Type: Status
+Field: Status
+OldValue: new
+NewValue: deleted
+Data: 
+Description: Ticket deleted by someone
+Content: This transaction appears to have no content
+Creator: someone
+Created: 2008-06-03 10:39:50
+Attachments: 
+

data/spec/test_data/single_history.txt

@@ -0,0 +1,26 @@
+RT/3.6.6 200 Ok
+
+# 5/5 (id/34725/total)
+
+id: 34725
+Ticket: 12345
+TimeTaken: 0
+Type: Create
+Field: 
+OldValue: 
+NewValue: 
+Data: 
+Description: Ticket created by Dallas-stezuohc@LEESSUMMITHONDA.COM
+
+Content: Now you can get big real fast at an affordable price
+         http://www.lameppe.com/
+
+
+Creator: Dallas-stezuohc@LEESSUMMITHONDA.COM
+Created: 2008-06-03 09:24:32
+
+Attachments: 
+             16377: untitled (77b)
+             16379: untitled (248b)
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pjdavis-roart
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - PJ Davis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-14 00:00:00 -07:00
+date: 2009-08-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,6 +41,8 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - README.rdoc
+- spec/test_data/full_history.txt
+- spec/test_data/single_history.txt
 files: 
 - History.txt
 - README.rdoc
@@ -50,6 +52,7 @@ files:
 - lib/roart/core/array.rb
 - lib/roart/core/string.rb
 - lib/roart/errors.rb
+- lib/roart/history.rb
 - lib/roart/roart.rb
 - lib/roart/ticket.rb
 - lib/roart/ticket_page.rb
@@ -57,11 +60,14 @@ files:
 - spec/roart/connection_spec.rb
 - spec/roart/core/array_spec.rb
 - spec/roart/core/string_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_spec.rb
 - spec/spec_helper.rb
+- spec/test_data/full_history.txt
+- spec/test_data/single_history.txt
 - test/test_roart.rb
 has_rdoc: true
 homepage: http://github.com/pjdavis/roart