pjdavis-roart 0.1.1 → 0.1.2

data/History.txt

@@ -1,3 +1,6 @@
+==0.1.2 / 2009-08-18
+Added Create ticket functionality. Ticket.new will create a ticket in the RT system and return that ticket.
+
 == 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.
 

data/README.rdoc

@@ -45,6 +45,11 @@ If you are using Best Practical's Request Tracker (RT) and you need to interact
     ticket.creator #-> rimmer@reddwarf.com
     ticket.subject #-> Where is the Bomb?
     
+* Get history for a ticket
+    
+    my_ticket.histories #-> Returns an array of history objects
+    
+    
 
 == REQUIREMENTS:
 

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 --heckle'
+PROJ.spec.opts << '--color'
 
 # EOF

data/lib/roart/connection.rb

@@ -33,6 +33,10 @@ module Roart
       @agent.get(uri).body
     end
     
+    def post(uri, payload)
+      @agent.post(uri, payload).body
+    end
+    
     protected
     
     def login

data/lib/roart/core/hash.rb

@@ -0,0 +1,7 @@
+class Hash
+  def to_content_format
+    fields = self.map { |key,value| "#{key.to_s.camelize}: #{value}" unless value.nil? }
+    content = fields.compact.join("\n")
+  end
+  
+end

data/lib/roart/ticket.rb

@@ -3,18 +3,25 @@ module Roart
   module Tickets
     
     DefaultAttributes = %w(queue owner creator subject status priority initial_priority final_priority requestors cc admin_cc created starts started due resolved told last_updated time_estimated time_worked time_left full logs)
-    RequiredAttributes = %w(queue creator subject status created)
+    RequiredAttributes = %w(queue subject)
   
   end
   
   class Ticket
     
     include Roart::MethodFunctions
-  
+    
+    # Creates a new ticket. Attributes queue and subject are required. Expects a hash with the attributes of the ticket.
+    #
+    #   ticket = MyTicket.new(:queue => "Some Queue", :subject => "The System is Down.")
+    #   ticket.id #-> This will be the ID of the ticket in the RT System.
+    #
     def initialize(attributes)
       Roart::check_keys!(attributes, Roart::Tickets::RequiredAttributes)
       if attributes.is_a?(Hash)
         @attributes = Roart::Tickets::DefaultAttributes.to_hash.merge(attributes)
+        @attributes.update(:id => 'ticket/new')
+        @attributes[:id] = create
       else
         raise ArgumentError, "Expects a hash."
       end
@@ -40,6 +47,21 @@ module Roart
       @histories ||= Roart::History.default(:ticket => self)
     end
     
+    protected
+      
+      def create
+        uri = "#{self.class.connection.server}/REST/1.0/ticket/new"
+        payload = @attributes.to_content_format
+        resp = self.class.connection.post(uri, :content => payload)
+        resp = resp.split("\n")
+        raise "Ticket Create Failed" unless resp.first.include?("200")
+        if tid = resp[2].match(/^# Ticket (\d+) created./)
+          return tid[1].to_i
+        else
+          raise "Ticket Create Failed"
+        end      
+      end
+    
     class << self #class methods
       
       # Gives or Sets the connection object for the RT Server.
@@ -55,11 +77,9 @@ module Roart
         else
           @connection
         end
-        @connection
       end
       
-      # Searches for a ticket or group of tickets with an active
-      # record like interface.
+      # Searches for a ticket or group of tickets with an active record like interface.
       #
       # Find has 3 different ways to search for tickets
       #
@@ -104,7 +124,7 @@ module Roart
       
       protected
       
-      def instantiate(attrs)
+      def instantiate(attrs) #:nodoc:
         object = nil
         if attrs.is_a?(Array)
           array = Array.new
@@ -123,21 +143,21 @@ module Roart
         object
       end
       
-      def find_initial(options={})
+      def find_initial(options={}) #:nodoc:
         options.update(:limit => 1)
         find_all(options).first
       end
       
-      def find_all(options)
+      def find_all(options) #:nodoc:
         uri = construct_search_uri(options)
         tickets = get_tickets_from_search_uri(uri)
       end
       
-      def find_by_ids(args, options)
+      def find_by_ids(args, options) #:nodoc:
         get_ticket_by_id(args.first)
       end
       
-      def page_array(uri)
+      def page_array(uri) #:nodoc:
         page = self.connection.get(uri)
         raise TicketSystemError, "Can't get ticket." unless page
         page = page.split("\n")   
@@ -150,14 +170,14 @@ module Roart
         end
       end
       
-      def get_tickets_from_search_uri(uri)
+      def get_tickets_from_search_uri(uri) #:nodoc:
         page = page_array(uri)
         page.extend(Roart::TicketPage)
         page = page.to_search_array
         self.instantiate(page)
       end
       
-      def get_ticket_from_uri(uri)
+      def get_ticket_from_uri(uri) #:nodoc:
         page = page_array(uri)
         page.extend(Roart::TicketPage)
         page = page.to_hash
@@ -165,13 +185,13 @@ module Roart
         self.instantiate(page)
       end
       
-      def get_ticket_by_id(id)
+      def get_ticket_by_id(id) #:nodoc:
         uri = "#{self.connection.server}/REST/1.0/ticket/"
         uri << id.to_s
         get_ticket_from_uri(uri)
       end
       
-      def construct_search_uri(options)
+      def construct_search_uri(options) #:nodoc:
         uri = "#{self.connection.server}/REST/1.0/search/ticket?"
         uri << 'orderby=-Created&' if options.delete(:order)
         unless options.empty?
@@ -191,7 +211,7 @@ module Roart
         uri
       end
       
-      def add_queue!(uri, queue)
+      def add_queue!(uri, queue) #:nodoc:
         return false unless queue
         if queue.is_a?(Array)
           queues = Array.new
@@ -204,7 +224,7 @@ module Roart
         end
       end
       
-      def add_custom_fields!(uri, options)
+      def add_custom_fields!(uri, options) #:nodoc:
         return false unless options
         options.each do |field, value|
           if value.is_a?(Array)
@@ -219,7 +239,7 @@ module Roart
         end
       end
       
-      def add_status!(uri, options)
+      def add_status!(uri, options) #:nodoc:
         return false unless options
         parts = Array.new
         if options.is_a?(Array)
@@ -234,7 +254,7 @@ module Roart
         uri << parts
       end
       
-      def add_searches!(uri, options)
+      def add_searches!(uri, options) #:nodoc:
         search_fields = %w( subject content content_type file_name)
         options.each do |key, value|
           if search_fields.include?(key.to_s)
@@ -252,7 +272,7 @@ module Roart
         end
       end
       
-      def add_dates!(uri, options)
+      def add_dates!(uri, options) #:nodoc:
         date_field = %w( created started resolved told last_updated starts due updated )
         options.each do |key, value|
           if date_field.include?(key.to_s)

data/lib/roart.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 module Roart
 
   # :stopdoc:
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
   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.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["PJ Davis"]
-  s.date = %q{2009-08-17}
+  s.date = %q{2009-08-18}
   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/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.files = ["History.txt", "README.rdoc", "Rakefile", "lib/roart.rb", "lib/roart/connection.rb", "lib/roart/core/array.rb", "lib/roart/core/hash.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/hash_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/core/hash_spec.rb

@@ -0,0 +1,11 @@
+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
+  
+end

data/spec/roart/history_spec.rb

@@ -30,6 +30,7 @@ describe "History" do
     
     before do
       @page = File.open(File.join(File.dirname(__FILE__), %w[ .. test_data full_history.txt])).readlines.join
+      @ticket = mock('ticket')
       Roart::History.should_receive(:get_page).and_return(@page)
       @histories = Roart::History.default(:ticket => @ticket)
     end

data/spec/roart/ticket_spec.rb

@@ -296,12 +296,42 @@ describe "Ticket" do
     
   end
   
+  describe 'manipulating tickets' do
+    
+    def to_content_format(data)
+      fields = data.map { |key,value| "#{key.to_s.camelize}: #{value}" unless value.nil? }
+      fields.compact.join("\n")
+    end
+    
+    before do 
+      post_data = @payload = {:subject => 'A New Ticket', :queue => 'My Queue'}
+      post_data.update(:id => 'ticket/new')
+      post_data = to_content_format(post_data)
+      mock_connection = mock('connection')
+      mock_connection.should_receive(:post).with('uri/REST/1.0/ticket/new', {:content => post_data}).and_return("RT/3.6.6 200 Ok\n\n# Ticket 267783 created.")
+      mock_connection.should_receive(:server).and_return('uri')
+      Roart::Ticket.should_receive(:connection).twice.and_return(mock_connection)
+    end
+    
+    it 'should be able to create a ticket' do
+      ticket = Roart::Ticket.new(@payload)
+    end
+    
+    it 'should return a newly created ticket' do
+      ticket = Roart::Ticket.new(@payload)
+      ticket.class.should == Roart::Ticket
+      ticket.id.should == 267783
+    end
+    
+  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 = mock('connection')
       @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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pjdavis-roart
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - PJ Davis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-17 00:00:00 -07:00
+date: 2009-08-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,7 @@ files:
 - lib/roart.rb
 - lib/roart/connection.rb
 - lib/roart/core/array.rb
+- lib/roart/core/hash.rb
 - lib/roart/core/string.rb
 - lib/roart/errors.rb
 - lib/roart/history.rb
@@ -59,6 +60,7 @@ files:
 - roart.gemspec
 - spec/roart/connection_spec.rb
 - spec/roart/core/array_spec.rb
+- spec/roart/core/hash_spec.rb
 - spec/roart/core/string_spec.rb
 - spec/roart/history_spec.rb
 - spec/roart/roart_spec.rb