pjdavis-roart 0.1.3 → 0.1.4

data/History.txt

@@ -1,3 +1,9 @@
+==0.1.4 / 2009-08-19
+Implemented callbacks, you can now hook into the ticket life-cycle with before and after create and update.
+Saving works like ActiveRecord now, with save returning true if successful and false otherwise, and save! raising an error if unsuccessful.
+Creating tickets is more ActiveRecord like now, with new not saving to the ticketing system automatically, you must call save or save!. There is a create function to do this now. Although this does break backward compatability, I'm not going to bump the minor because a) nobody has forked this yet, and b) i skipped 0.
+You can now specify a default queue when you subclass Roart::Ticket. just add a default_queue 'queue name' to your class and that queue will automatically be searched unless you specify a queue.
+
 ==0.1.3 / 2009-08-18
 Can now update tickets with #save. Returns true if saved, raises an error if not.
 

data/README.rdoc

@@ -49,6 +49,20 @@ If you are using Best Practical's Request Tracker (RT) and you need to interact
     
     my_ticket.histories #-> Returns an array of history objects
     
+* Create a new ticket
+
+    issue = Ticket.new(:queue => 'some_queue', :subject => 'This is not working for me')
+    issue.id #-> 'ticket/new'
+    issue.save
+    issue.id #-> 23423
+    
+* Update a ticket
+
+    ticket = Ticket.find(23452)
+    ticket.subject #-> "Some Subject for a ticket."
+    ticket.subject #-> "Smoke me a kipper, I'll be back for breakfast."
+    ticket.save
+    ticket.subject #->"Smoke me a kipper, I'll be back for breakfast."
     
 
 == REQUIREMENTS:

data/lib/roart.rb

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

data/lib/roart/callbacks.rb

@@ -0,0 +1,25 @@
+module Roart
+  
+  # Callbacks are implemented to do a bit of logic either before or after a part of the object life cycle. These can be overridden in your Ticket class and will be called at the approprate times.
+  #
+  module Callbacks
+    
+    # called just before a ticket that has not been saved to the ticketing system is saved.
+    #
+    def before_create; end
+    
+    # Called immediately a ticket that has not been saved is saved.
+    #
+    def before_update; end
+    
+    # called just before a ticket that has been updated is saved to the ticketing system
+    #
+    def after_create; end
+    
+    # called just after a ticket that has been updated is saved to the ticketing system
+    #
+    def after_update; end
+    
+  end
+  
+end

data/lib/roart/ticket.rb

@@ -10,8 +10,9 @@ module Roart
   class Ticket
     
     include Roart::MethodFunctions
+    include Roart::Callbacks
     
-    attr_reader :full, :history
+    attr_reader :full, :history, :saved
     
     # Creates a new ticket. Attributes queue and subject are required. Expects a hash with the attributes of the ticket.
     #
@@ -23,7 +24,7 @@ module Roart
       if attributes.is_a?(Hash)
         @attributes = Roart::Tickets::DefaultAttributes.to_hash.merge(attributes)
         @attributes.update(:id => 'ticket/new')
-        @attributes[:id] = create
+        @saved = false
       else
         raise ArgumentError, "Expects a hash."
       end
@@ -34,7 +35,7 @@ module Roart
     # Loads all information for a ticket from RT and lets full to true. 
     # This changes the ticket object and adds methods for all the fields on the ticket.
     # Custom fields will be prefixed with 'cf' so a custom field of 'phone'
-    # would be cf_phone
+    # would be cf_phone. custom fields hold their case from how they are defined in RT, so a custom field of PhoneNumber would be cf_PhoneNumber and a custom field of phone_number would be cf_phone_number
     #
     def load_full!
       unless self.full
@@ -50,52 +51,60 @@ module Roart
       @histories ||= Roart::History.default(:ticket => self)
     end
     
+    # if a ticket is new, calling save will create it in the ticketing system and assign the id that it gets to the id attribute. It returns true if the save was successful, and false if something went wrong
+    #
     def save
-      uri = "#{self.class.connection.server}/REST/1.0/ticket/#{self.id}/edit"
-      payload = @attributes.clone
-      payload.delete(:id)
-      payload = payload.to_content_format
-      resp = self.class.connection.post(uri, :content => payload)
-      resp = resp.split("\n")
-      raise "Ticket Update Failed" unless resp.first.include?("200")
-      if resp[2].match(/^# Ticket (\d+) updated./)
-        return true
+      if self.id == "ticket/new"
+        self.create
       else
-        raise "Ticket Create Failed"
+        self.before_update
+        uri = "#{self.class.connection.server}/REST/1.0/ticket/#{self.id}/edit"
+        payload = @attributes.clone
+        payload.delete(:id)
+        payload = payload.to_content_format
+        resp = self.class.connection.post(uri, :content => payload)
+        resp = resp.split("\n")
+        raise "Ticket Update Failed" unless resp.first.include?("200")
+        if resp[2].match(/^# Ticket (\d+) updated./)
+          self.after_update
+          true
+        else
+          false
+        end
       end
     end
     
+    # works just like save, but if the save fails, it raises an exception instead of silently returning false
+    #
+    def save!
+      raise "Ticket Create Failed" unless self.save
+      true
+    end
+    
     protected
       
-      def create
+      def create #:nodoc:
+        self.before_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
+          @attributes[:id] = tid[1].to_i
+          self.after_create
+          true
         else
-          raise "Ticket Create Failed"
+          false
         end      
       end
-    
-    class << self #class methods
       
-      # Gives or Sets the connection object for the RT Server.
-      # Accepts 3 parameters :server, :user, and :pass. Call this 
-      # at the top of your subclass to create the connection, 
-      #     class Ticket < Roart::Ticket
-      #       connection :server => 'server', :user => 'user', :pass => 'pass'
-      #     end
-      #
-      def connection(options=nil)
-        if options && @connection.nil?
-          @connection = Roart::Connection.new(options)
-        else
-          @connection
-        end
+      def create! #:nodoc:
+        raise "Ticket Create Failed" unless self.create
+        true
       end
+    
+    class << self #class methods
       
       # Searches for a ticket or group of tickets with an active record like interface.
       #
@@ -140,6 +149,41 @@ module Roart
         end
       end
       
+
+      # Gives or Sets the connection object for the RT Server.
+      # Accepts 3 parameters :server, :user, and :pass. Call this 
+      # at the top of your subclass to create the connection, 
+      #     class Ticket < Roart::Ticket
+      #       connection :server => 'server', :user => 'user', :pass => 'pass'
+      #     end
+      #
+      def connection(options=nil)
+        if options
+          @connection = Roart::Connection.new(options)
+        else
+          defined?(@connection) ? @connection : nil
+        end
+      end
+      
+      # Adds a default queue to search each time. This is overridden by 
+      # specifically including a :queue option in your find method. This can
+      # be an array of queue names or a string with a single queue name.
+      #
+      def default_queue(options=nil)
+        if options
+          @default_queue = options
+        else
+          defined?(@default_queue) ? @default_queue : nil
+        end
+      end
+      
+      # creates a new ticket object and immediately saves it to the database.
+      def create(options)
+        ticket = self.new(options)
+        ticket.save
+        ticket
+      end
+      
       protected
       
       def instantiate(attrs) #:nodoc:
@@ -211,14 +255,18 @@ module Roart
         get_ticket_from_uri(uri)
       end
       
-      def construct_search_uri(options) #:nodoc:
+      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?
+        unless options.empty? && default_queue.nil?
           uri << 'query= '
           query = Array.new
-        
-          add_queue!(query, options[:queues] || options[:queue])
+          
+          if options[:queues] || options[:queue]
+            add_queue!(query, options[:queues] || options[:queue])
+          else
+            add_queue!(query, default_queue)
+          end
           add_dates!(query, options)
           add_searches!(query, options)
           add_status!(query, options[:status])

data/roart.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{roart}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["PJ Davis"]
+  s.date = %q{2009-08-19}
+  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/callbacks.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/callbacks_spec.rb", "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"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/pjdavis/roart}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{roart}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Interface for working with Request Tracker (RT) tickets inspired by ActiveRecord}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mechanize>, [">= 0.9.0"])
+      s.add_development_dependency(%q<bones>, [">= 2.5.1"])
+    else
+      s.add_dependency(%q<mechanize>, [">= 0.9.0"])
+      s.add_dependency(%q<bones>, [">= 2.5.1"])
+    end
+  else
+    s.add_dependency(%q<mechanize>, [">= 0.9.0"])
+    s.add_dependency(%q<bones>, [">= 2.5.1"])
+  end
+end

data/spec/roart/callbacks_spec.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), %w[ .. spec_helper])
+
+describe 'ticket callbacks' do
+
+  describe 'create callbacks' do
+    
+    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 call before_create callback' do
+      
+      ticket = Roart::Ticket.new(@payload)
+      ticket.should_receive(:before_create)
+      ticket.should_receive(:after_create)
+      ticket.save
+    end
+    
+  end
+  
+  describe 'update callbacks' do
+    
+    before do
+      @post_data = @payload = {:subject => 'A New Ticket', :queue => 'My Queue'}
+      @post_data[:subject] = 'An Old Ticket'
+      @post_data = to_content_format(@post_data)
+      @mock_connection = mock('connection')
+      @mock_connection.should_receive(:server).and_return('uri')
+      Roart::Ticket.should_receive(:connection).twice.and_return(@mock_connection)
+    end
+    
+    it 'should call before_update callbacks' do
+      @mock_connection.should_receive(:post).with('uri/REST/1.0/ticket/1/edit', {:content => @post_data}).and_return("RT/3.6.6 200 Ok\n\n# Ticket 267783 updated.")
+      ticket = Roart::Ticket.send(:instantiate, @payload.update(:id => 1))
+      ticket.instance_variable_set("@saved", false)
+      ticket.should_receive(:before_update)
+      ticket.should_receive(:after_update)
+      ticket.save
+    end
+    
+  end
+
+end

data/spec/roart/ticket_spec.rb

@@ -143,7 +143,7 @@ describe "Ticket" do
         it 'should take multiple queues' do
           Roart::Ticket.send(:construct_search_uri, {:queue => ['myQueue', 'another']}).should == @query + "( Queue = 'myQueue' OR Queue = 'another' )"
         end
-        
+
       end
       
       describe 'dates' do
@@ -282,6 +282,28 @@ describe "Ticket" do
     
   end
   
+  describe "the default queue" do
+    
+    before do
+      @connection = mock('connection', :server => "server")
+      @search_string = "/REST/1.0/search/ticket?"
+      @query = @connection.server + @search_string + 'query= '
+      class MyTicket < Roart::Ticket; end
+      MyTicket.instance_variable_set("@default_queue", 'myQueue')
+      MyTicket.should_receive(:connection).and_return(@connection)
+    end
+      
+        
+    it 'should have a default queue' do
+      MyTicket.send(:construct_search_uri, :status => :new).should == @query + "Queue = 'myQueue' AND Status = 'new'"
+    end
+    
+    it 'should search without options and return the default queue' do
+      MyTicket.send(:construct_search_uri).should == @query + "Queue = 'myQueue'"
+    end
+  
+  end
+  
   describe 'ticket methods' do
     
     
@@ -305,11 +327,6 @@ describe "Ticket" do
   
   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
-    
     describe 'creating tickets' do
     
       before do 
@@ -322,13 +339,19 @@ describe "Ticket" do
         Roart::Ticket.should_receive(:connection).twice.and_return(mock_connection)
       end
     
-      it 'should be able to create a ticket' do
+      it 'should be able to save a new ticket' do
         ticket = Roart::Ticket.new(@payload)
+        ticket.save
+      end
+      
+      it  'should be able to create a ticket' do
+        ticket = Roart::Ticket.create(@payload)
       end
     
       it 'should return a newly created ticket' do
         ticket = Roart::Ticket.new(@payload)
         ticket.class.should == Roart::Ticket
+        ticket.save
         ticket.id.should == 267783
       end
     

data/spec/spec_helper.rb

@@ -8,6 +8,11 @@ def dbtime(time)
   time.strftime("%Y-%m-%d %H:%M:%S")
 end
 
+def to_content_format(data)
+  fields = data.map { |key,value| "#{key.to_s.camelize}: #{value}" unless value.nil? }
+  fields.compact.join("\n")
+end
+
 Spec::Runner.configure do |config|
   # == Mock Framework
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pjdavis-roart
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - PJ Davis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-18 00:00:00 -07:00
+date: 2009-08-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,6 +48,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/roart.rb
+- lib/roart/callbacks.rb
 - lib/roart/connection.rb
 - lib/roart/core/array.rb
 - lib/roart/core/hash.rb
@@ -57,6 +58,8 @@ files:
 - lib/roart/roart.rb
 - lib/roart/ticket.rb
 - lib/roart/ticket_page.rb
+- roart.gemspec
+- spec/roart/callbacks_spec.rb
 - spec/roart/connection_spec.rb
 - spec/roart/core/array_spec.rb
 - spec/roart/core/hash_spec.rb