ticketmaster-lighthouse 0.1.1 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.3.0

data/lib/provider/comment.rb

@@ -0,0 +1,69 @@
+module TicketMaster::Provider
+  module Lighthouse
+    # The comment class for ticketmaster-lighthouse
+    #
+    # Due to the way lighthouse handles tickets, comments aren't really comments, but
+    # versions of the ticket.
+    #
+    # * author => user_name (read-only)
+    # * body => description
+    # * id => position in the versions array (set by the initializer)
+    # * created_at
+    # * updated_at
+    # * ticket_id => number (read-only)
+    # * project_id => (set by the initializer)
+    class Comment < TicketMaster::Provider::Base::Comment
+      API = LighthouseAPI::Ticket
+      
+      # A custom find_by_id
+      # The "comment" id is it's index in the versions array. An id of 0 therefore exists and
+      # should be the first ticket (original)
+      def self.find_by_id(project_id, ticket_id, id)
+        self.new LighthouseAPI::Ticket.find(ticket_id, :params => {:project_id => project_id}), id
+      end
+      
+      # A custom find_by_attributes
+      #
+      def self.find_by_attributes(project_id, ticket_id, attributes = {})
+        result = self.search(project_id, ticket_id, attributes)
+        result[0].collect do |comment|
+          self.new(result[1], index_of(result[1].versions, comment))
+        end
+      end
+      
+      # The Array#index method doesn't work for the versions...
+      # because it seems they're all equal.
+      def self.index_of(versions, needle)
+        result = nil
+        versions.each_with_index do |version, index|
+          result = index if version.attributes == needle.attributes
+        end
+        result
+      end
+      
+      def initialize(ticket, id)
+        @system_data ||= {}
+        @system_data[:ticket] = @system_data[:client] = ticket
+        @system_data[:version] = ticket.versions[id]
+        self.project_id = ticket.prefix_options[:project_id]
+        self.id = id
+        super(@system_data[:version].attributes)
+      end
+      
+      # A custom searcher
+      #
+      # It returns a custom result because we need the original ticket to make a comment.
+      def self.search(project_id, ticket_id, options = {}, limit = 1000)
+        ticket = LighthouseAPI::Ticket.find(ticket_id, :params => {:project_id => project_id})
+        comments = ticket.versions
+        [search_by_attribute(comments, options, limit), ticket]
+      end
+      
+      # The author's name
+      def author
+        user_name
+      end
+      
+    end
+  end
+end

data/lib/provider/lighthouse.rb

@@ -2,6 +2,8 @@ module TicketMaster::Provider
   # This is the Lighthouse Provider for ticketmaster
   module Lighthouse
     include TicketMaster::Provider::Base
+    PROJECT_API = LighthouseAPI::Project
+    TICKET_API = LighthouseAPI::Ticket
     
     # This is for cases when you want to instantiate using TicketMaster::Provider::Lighthouse.new(auth)
     def self.new(auth = {})
@@ -27,19 +29,13 @@ module TicketMaster::Provider
     # end up using whatever the previous instantiated object's account info is.
     def projects(*options)
       authorize
-      projects = if options.length > 0
-        Project.find(*options)
-        else
-        Project.find(:all)
-        end
-      set_master_data(projects)
+      super(*options)
     end
     
     # The project
     def project(*options)
       authorize
-      return set_master_data(Project.find(:first, *options)) if options.length > 0
-      Project
+      super(*options)
     end
     
     # The tickets
@@ -55,33 +51,14 @@ module TicketMaster::Provider
     # the first project is.
     def tickets(*options)
       authorize
-      arg = options.shift
-      tickets = if arg.nil?
-        Ticket.find
-        elsif arg.is_a?(Fixnum)
-        Ticket.find(:all, :params => {:project_id => arg})
-        elsif arg.is_a?(Hash)
-        Ticket.find(:all, :params => arg) if arg.is_a?(Hash)
-        else
-        []
-        end
-      set_master_data(tickets)
+      super(*options)
     end
     
     # the ticket
     def ticket(*options)
       authorize
-      return set_master_data(Ticket.find(*options)) if options.length > 0
-      Ticket
+      super(*options)
     end
     
-    def set_master_data(data)
-      if data.is_a?(Array)
-        data.collect! { |p| p.system_data.merge!(:master => self); p }
-      else
-        data.system_data.merge!(:master => self)
-      end
-      data
-    end
   end
 end

data/lib/provider/project.rb

@@ -4,102 +4,11 @@ module TicketMaster::Provider
     # 
     # 
     class Project < TicketMaster::Provider::Base::Project
-      # The finder method
-      # 
-      # It accepts all the find functionalities defined by ticketmaster
-      #
-      # + find() and find(:all) - Returns all projects on the account
-      # + find(<project_id>) - Returns the project based on the id
-      # + find(:first, :name => <project_name>) - Returns the first project based on the attribute
-      # + find(:name => <project name>) - Returns all projects based on the attribute
       attr_accessor :prefix_options
-      def self.find(*options)
-        first = options.shift
-        if first.nil? or first == :all
-          LighthouseAPI::Project.find(:all).collect do |p|
-            self.new p
-          end
-        elsif first.is_a?(Fixnum)
-          self.new LighthouseAPI::Project.find(first)
-        elsif first == :first
-          self.new self.search(options.shift || {}, 1).first
-        elsif first.is_a?(Hash)
-          self.search(first).collect { |p| self.new p }
-        end
-      end
-      
-      # This is a helper method to find
-      def self.search(options = {}, limit = 1000)
-        projects = LighthouseAPI::Project.find(:all)
-        projects.find_all do |p|
-          options.keys.reduce(true) do |memo, key|
-            p.send(key) == options[key] and (limit-=1) >= 0
-          end
-        end
-      end
-      
-      # Create a project
-      def self.create(*options)
-        project = LighthouseAPI::Project.new(options.shift)
-        project.save
-        self.new project
-      end
-      
-      # The initializer
-      #
-      # A side effect of Hashie causes prefix_options to become an instance of TicketMaster::Provider::Lighthouse::Project
-      def initialize(*options)
-        @system = :lighthouse
-        @system_data = {}
-        first = options.shift
-        if first.is_a?(LighthouseAPI::Project)
-          @system_data[:client] = first
-          @prefix_options = first.prefix_options
-          super(first.attributes)
-        else
-          super(first)
-        end
-      end
-      
-      # All tickets for this project
-      def tickets(*options)
-        if options.length == 0
-          Ticket.find(:project_id => self.id)
-        else
-          first = options.first
-          if first.is_a?(Fixnum)
-            [Ticket.find(first, {:project_id => self.id})]
-          else
-            Ticket.find({:project_id => self.id}.merge(:q => options.first))
-          end
-        end
-      end
-      
-      # The ticket finder
-      # returns only one ticket
-      def ticket(*options)
-        first = options.shift
-        if first.nil?
-          return Ticket
-        elsif first.is_a?(Fixnum)
-          return Ticket.find(first, :project_id => self.id)
-        else
-          Ticket.find(:first, {:project_id => self.id}.merge(:q => first))
-        end
-      end
-      
-      # Save this project
-      def save
-        lighthouse = @system_data[:client]
-        lighthouse.attributes.each do |k, v|
-          lighthouse.send(k + '=', self.send(k)) if self.send(k) != v
-        end
-        lighthouse.save
-      end
-      
+      API = LighthouseAPI::Project
       # Delete this project
       def destroy
-        result = self.system_data[:client].destroy
+        result = super
         result.is_a?(Net::HTTPOK)
       end
 

data/lib/provider/ticket.rb

@@ -1,102 +1,114 @@
 module TicketMaster::Provider
   module Lighthouse
     # Ticket class for ticketmaster-lighthouse
+    #
+    # Due to the way Lighthouse stores tickets, we actually end up creating a new ticket version
+    # every time we edit tickets. Their api FAQ states these attributes as the only editable ones(?):
+    #
+    # * title
+    # * body - follows the same formatting rules.
+    # * state - Can be any one of these: new, open, resolved, hold, invalid. Optional, set to open by default for new tickets.
+    # * assigned-user-id - optional
+    # * milestone-id - optional
+    # * tag - space or comma delimited list of tags
+    #
+    # We had to remap things a bit since lighthouse doesn't name things as ticketmaster specifies.
+    #
+    # * id => number (read-only)
+    # * status => state
+    # * resolution => ticket.latest_body
+    # * description => ticket.original_body (setting a new description creates a new body)
+    # * assignee => assigned_user_name (read-only)
+    # * requestor => creator_name (read-only)
+    # * project_id => prefix_options[:project_id]
+    # * priority
+    # * title 
+    # * created_at
+    # * updated_at
+    
     class Ticket < TicketMaster::Provider::Base::Ticket
       @@allowed_states = ['new', 'open', 'resolved', 'hold', 'invalid']
       attr_accessor :prefix_options
+      API = LighthouseAPI::Ticket
+      COMMENT = Lighthouse::Comment
       
-      # The finder
-      #
-      # It tries to implement all the ticketmaster calls, but since the project id is required as the
-      # parent key, it doesnt really make sense to call find(:all) or find(##)
-      # 
-      # * find(:all) - Returns an array of all tickets
-      # * find(##, ##) - Returns a ticket based on that id or some other primary (unique) attribute
-      # * find(:first, :summary => 'Ticket title') - Returns a ticket based on the ticket's attributes
-      # * find(:summary => 'Test Ticket') - Returns all tickets based on the given attributes
-      def self.find(*options)
-        first = options.shift
-        if first.nil? or first == :all
-          tickets = []
-          LighthouseAPI::Project.find(:all).each do |p|
-            tickets |= p.tickets
-          end
-          tickets.collect { |t| self.new t }
-        elsif first.is_a?(Fixnum)
-          second = options.shift
-          if second.is_a?(Fixnum)
-            self.new LighthouseAPI::Ticket.find(first, :params => { :project_id => second })
-          elsif second.is_a?(Hash)
-            self.new LighthouseAPI::Ticket.find(first, :params => qize(second))
-          end
-        elsif first == :first
-          self.new self.search(options.shift, 1).first
-        elsif first.is_a?(Hash)
-          self.search(first).collect do |t| self.new t end
-        end
-      end
-      
+      # This is to get the ticket id
+      # We can't set ids, so there's no 'id=' method.
       def id
         @system_data[:client].number
       end
       
-      def self.qize(params)
-        return params unless params[:q] and params[:q].is_a?(Hash)
-        q = ''
-        params[:q].keys.each do |key|
-          value = params[:q][key]
-          value = "\"#{value}\"" if value.to_s.include?(' ')
-          q += "#{key}:#{value} "
-        end
-        params[:q] = q
-        params
+      # This is to get the status, mapped to state
+      def status
+        state
+      end
+      
+      # This is to set the status, mapped to state
+      def status=(stat)
+        stat = state unless @@allowed_states.include?(stat)
+        state = stat
+      end
+      
+      # Get the resolution, mapped to latest_body
+      def resolution
+        latest_body
+      end
+      
+      # Set the resolution...also sets state to resolved
+      def resolution=(res)
+        state = 'resolved'
+        body = res
+      end
+      
+      # Get the description, mapped to original_body
+      def description
+        original_body
+      end
+      
+      # Set the description, mapped to body, which actually does a comment
+      def description=(desc)
+        body = desc
+      end
+      
+      # Get the assigned person's name
+      def assignee
+        assigned_user_name
       end
       
-      # The find helper
-      def self.search(options, limit = 1000)
-        tickets = LighthouseAPI::Ticket.find(:all, :params => ({:project_id => (options.delete(:project_id) || options.delete('project_id')).to_i}.merge(qize(:q => options))))
-        tickets.find_all do |t|
-          options.keys.reduce(true) do |memo, key|
-            t.send(key) == options[key] and (limit-=1) > 0
-          end
-        end
+      # Get the requestor's name
+      def requestor
+        creator_name
       end
       
-      # The initializer
-      def initialize(*options)
-        @system = :lighthouse
-        @system_data = {}
-        first = options.shift
-        if first.is_a?(LighthouseAPI::Ticket)
-          @system_data[:client] = first
-          @prefix_options = first.prefix_options
-          super(first.attributes)
-        else
-          super(first)
-        end
+      # Get the project id
+      def project_id
+        prefix_options[:project_id]
       end
       
-      # The creator
-      def self.create(*options)
-        new_ticket = LighthouseAPI::Ticket.new(:project_id => (options.first.delete(:project_id) || options.first.delete('project_id')).to_i)
-        ticket_attr.each do |k, v|
-          new_ticket.send(k + '=', v)
-        end
-        new_ticket.save
-        self.new new_ticket
+      # Set the body
+      def body=(bod)
+        @system_data[:client].body = nil
+        super(bod)
       end
       
-      # The saver
-      def save(*options)
-        lh_ticket = @system_data[:client]
-        self.keys.each do |key|
-          lh_ticket.send(key + '=', self.send(key)) if self.send(key) != lh_ticket.send(key)
-        end
-        lh_ticket.save
+      # Tags, a little helper for the ticket tagging
+      def tags
+        return @tags if @tags
+        tagz = self.tag.split(/([\w\d]+)|"([\w \d]+)"/)
+        tagz.delete(' ')
+        tagz.delete('')
+        @tags = tagz
       end
       
-      def destroy(*options)
-        @system_data[:client].destroy
+      # Gotta unset the body attribute...otherwise every save ends up using that body
+      def save
+        tag = @tags.reduce([]) do |mem, t|
+          t = "\"#{t}\"" if t.include?(' ')
+          mem << t
+        end.join(' ') if @tags
+        super
+        body = nil
+        @system_data[:client].body = nil
       end
       
       # The closer

data/lib/ticketmaster-lighthouse.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/lighthouse/lighthouse-api'
 
-%w{ lighthouse ticket project }.each do |f|
+%w{ lighthouse ticket project comment }.each do |f|
   require File.dirname(__FILE__) + '/provider/' + f + '.rb';
 end
 

data/ticketmaster-lighthouse.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ticketmaster-lighthouse}
-  s.version = "0.1.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hong"]
-  s.date = %q{2010-06-25}
+  s.date = %q{2010-07-02}
   s.description = %q{Allows ticketmaster to interact with Lighthouse's issue tracking system.}
   s.email = %q{hong.quach@abigfisch.com}
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "lib/lighthouse/LICENSE",
      "lib/lighthouse/README.markdown",
      "lib/lighthouse/lighthouse-api.rb",
+     "lib/provider/comment.rb",
      "lib/provider/lighthouse.rb",
      "lib/provider/project.rb",
      "lib/provider/ticket.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ticketmaster-lighthouse
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Hong
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-25 00:00:00 -07:00
+date: 2010-07-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -117,6 +117,7 @@ files:
 - lib/lighthouse/LICENSE
 - lib/lighthouse/README.markdown
 - lib/lighthouse/lighthouse-api.rb
+- lib/provider/comment.rb
 - lib/provider/lighthouse.rb
 - lib/provider/project.rb
 - lib/provider/ticket.rb