ticketmaster-lighthouse 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # ticketmaster-lighthouse
 
-This is a provider for [ticketmaster](http://ticketrb.com). It provides interoperability with (Lighthouse)[http://www.lighthouseapp.com/] through the ticketmaster gem.
+This is a provider for [ticketmaster](http://ticketrb.com). It provides interoperability with [Lighthouse](http://www.lighthouseapp.com/) through the ticketmaster gem.
 
 # Usage and Examples
 
@@ -11,11 +11,17 @@ First we have to instantiate a new ticketmaster instance:
 
 The :account is the name of the account which should be the same as the subdomain used to access the account's projects. For you convenience, you can also pass in :subdomain in place of :account. If you pass in both, it'll use the :account value. If you do not pass in the token or both the username and password, it will only access public information for the account.
 
-Tokens allow access to a specific project or account without having to give out your login credentials. It can be nullified if necessary. I highly suggest you use tokens. For more information, please see Lighthouse's FAQ (How do I get an API token?)[http://help.lighthouseapp.com/faqs/api/how-do-i-get-an-api-token]
+Tokens allow access to a specific project or account without having to give out your login credentials. It can be nullified if necessary. I highly suggest you use tokens. For more information, please see Lighthouse's FAQ [How do I get an API token?](http://help.lighthouseapp.com/faqs/api/how-do-i-get-an-api-token)
 
 == Finding Projects
 
-    project = lighthouse.project
+    project = lighthouse.project['project_name']
+    project = lighthouse.project.find(:id => 505)
+
+== Finding Tickets
+
+    tickets = project.tickets
+    
 
 ## Requirements
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/provider/lighthouse.rb

@@ -0,0 +1,87 @@
+module TicketMaster::Provider
+  # This is the Lighthouse Provider for ticketmaster
+  module Lighthouse
+    include TicketMaster::Provider::Base
+    
+    # This is for cases when you want to instantiate using TicketMaster::Provider::Lighthouse.new(auth)
+    def self.new(auth = {})
+      TicketMaster.new(:lighthouse, auth)
+    end
+    
+    # The authorize and initializer for this provider
+    def authorize(auth = {})
+      @authentication ||= TicketMaster::Authenticator.new(auth)
+      auth = @authentication
+      LighthouseAPI.account = auth.account || auth.subdomain
+      if auth.token
+        LighthouseAPI.token = auth.token
+      elsif auth.username && auth.password
+        LighthouseAPI.authenticate(auth.username, auth.password)
+      end
+    end
+    
+    # The projects
+    #
+    # We have to merge in the auth information because, due to the class-based authentication
+    # mechanism, if we don't reset the authorize information for every request, it would 
+    # 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)
+    end
+    
+    # The project
+    def project(*options)
+      authorize
+      return set_master_data(Project.find(:first, *options)) if options.length > 0
+      Project
+    end
+    
+    # The tickets
+    #
+    # Due to the nature of lighthouse, we must have the project_id to pull tickets. You can
+    # pass in the id through this format:
+    # 
+    #    .tickets(22)
+    #    .tickets(:project_id => 22)
+    # 
+    # To conform to ticketmaster's standard of returning all tickets on a call to this method
+    # without any parameters, if no parameters are passed, it will return all tickets for whatever
+    # 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)
+    end
+    
+    # the ticket
+    def ticket(*options)
+      authorize
+      return set_master_data(Ticket.find(*options)) if options.length > 0
+      Ticket
+    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

@@ -1,48 +1,93 @@
-module TicketMasterMod
+module TicketMaster::Provider
   module Lighthouse
-    class Project
-      def self.find(query, options = {})
-        self.authenticate(options[:authentication]) if options[:authentication]
-        projects = LighthouseAPI::Project.find :all # Kernel::Lighthouse::Project.find query
-        formatted_projects = []
-
-        unless projects.empty?
-          projects.each do |project|
-            attributes = {:system => "lighthouse", :authentication => options[:authentication],
-              :system_data => {:project => project}}
-            attributes.merge!(project.attributes)
-            formatted_projects << TicketMasterMod::Project.new(attributes)
+    # Project class for ticketmaster-lighthouse
+    # 
+    # 
+    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
-
-        formatted_projects
       end
       
-      def self.authenticate(auth)
-        LighthouseAPI.account = auth.account || auth.subdomain
-        if auth.token
-          LighthouseAPI.token = auth.token
-        elsif auth.username && auth.password
-          LighthouseAPI.authenticate(auth.username, auth.password)
+      # 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
-
-      def self.tickets(project_instance)
-        self.authenticate(project_instance.authentication)
-        tickets = project_instance.system_data[:project].tickets
-        formatted_tickets = []
-
-        unless tickets.empty?
-          tickets.each do |ticket|
-            attributes = {:system => 'lighthouse', :project => project_instance,
-              :system_data => {:project => project_instance.system_data[:project], :ticket => ticket}}
-            attributes.merge!(ticket.attributes)
-            formatted_tickets << TicketMasterMod::Ticket.new(attributes)
+      
+      # 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
-
-        formatted_tickets
       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
+
     end
   end
 end

data/lib/provider/ticket.rb

@@ -1,31 +1,106 @@
-module TicketMasterMod
+module TicketMaster::Provider
   module Lighthouse
-    class Ticket
+    # Ticket class for ticketmaster-lighthouse
+    class Ticket < TicketMaster::Provider::Base::Ticket
       # This is an exhaustive list, but should contain the most common ones, add as necessary
       @@allowed_attributes = ["number", "permalink", "milestone_id", "created_at", "title", "closed", "updated_at", "raw_data", "priority", "tag", "url", "attachments_count", "creator_id", "milestone_due_on", "original_body_html", "user_id", "user_name", "original_body", "latest_body", "assigned_user_id", "creator_name", "state"]
-      def self.create(ticket)
-        ticket_attr = ticket.to_hash.delete_if { |k, v| !@@allowed_attributes.include?(k) }
-        project = ticket.project.system_data[:project]
-        new_ticket = LighthouseAPI::Ticket.new(:project_id => ticket.project.id)
+      @@allowed_states = ['new', 'open', 'resolved', 'hold', 'invalid']
+      attr_accessor :prefix_options
+      
+      # 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
+      
+      
+      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
+      end
+      
+      # The find helper
+      def self.search(options, limit = 1000)
+        tickets = LighthouseAPI::Ticket.find(:all, :params => qize(options))
+        options.delete(:project_id) || options.delete('project_id')
+        tickets.find_all do |t|
+          options.keys.reduce(true) do |memo, key|
+            p.send(key) == options[key] and (limit-=1) > 0
+          end
+        end
+      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
+      end
+      
+      # The creator
+      def self.create(*options)
+        ticket_attr = options.delete_if { |k, v| !@@allowed_attributes.include?(k) }
+        new_ticket = LighthouseAPI::Ticket.new(ticket_attr)
+        ticket_attr.delete(:project_id) || ticket_attr.delete('project_id')
         ticket_attr.each do |k, v|
           new_ticket.send(k + '=', v)
         end
         new_ticket.save
       end
-
-      def self.save(ticket)
-        ticket_attr = ticket.to_hash.delete_if { |k, v| !@@allowed_attributes.include?(k) || ticket.system_data[:ticket].send(k) == v }
-        project = ticket.project.system_data[:project]
-        lh_ticket = ticket.system_data[:ticket]
+      
+      # The saver
+      def save
+        ticket_attr = self.to_hash.delete_if { |k, v| !@@allowed_attributes.include?(k) || ticket.system_data[:client].send(k) == v }
+        lh_ticket = ticket.system_data[:client]
         ticket_attr.each do |k, v|
           lh_ticket.send(k + '=', v)
         end
         lh_ticket.save
       end
-
-      def self.close(ticket, resolution)
-        project = ticket.project.system_data[:project]
-        ticket = LighthouseAPI::Ticket.find(ticket.id, :params => {:project_id => ticket.project.id})
+      
+      # The closer
+      def close(resolution = 'resolved')
+        resolution = 'resolved' unless @@allowed_states.include?(resolution)
+        ticket = LighthouseAPI::Ticket.find(self.id, :params => {:project_id => self.prefix_options[:project_id]})
         ticket.state = resolution
         ticket.save
       end

data/lib/ticketmaster-lighthouse.rb

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

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require '../ticketmaster/lib/ticketmaster'
 require 'ticketmaster-lighthouse'
 require 'spec'
 require 'spec/autorun'

data/spec/ticketmaster-lighthouse_spec.rb

@@ -1,7 +1,62 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "TicketmasterLighthouse" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe "Ticketmaster" do
+  before(:each) do
+    @ticketmaster = TicketMaster.new(:lighthouse, :token => '00c00123b00f00dc0de', :account => 'ticketmaster')
+    @project_class = TicketMaster::Provider::Lighthouse::Project
+    @ticket_class = TicketMaster::Provider::Lighthouse::Ticket
+    @lh_project = LighthouseAPI::Project.new
+    @lh_project.attributes = {"permalink"=>"lh-test", "name"=>"lh-test", "created_at"=>Time.now, "description_html"=>"<div><p>This is a test project created in order to test the\nticketmaster-lighthouse gem.</p></div>", "closed_states_list"=>"resolved,hold,invalid", "public"=>true, "default_ticket_text"=>nil, "license"=>nil, "default_milestone_id"=>nil, "closed_states"=>"resolved/6A0 # You can customize colors\nhold/EB0     # with 3 or 6 character hex codes\ninvalid/A30  # 'A30' expands to 'AA3300'", "updated_at"=>Time.now, "archived"=>false, "send_changesets_to_events"=>true, "open_states_list"=>"new,open", "open_tickets_count"=>2, "id"=>54448, "default_assigned_user_id"=>nil, "description"=>"This is a test project created in order to test the ticketmaster-lighthouse gem.", "open_states"=>"new/f17  # You can add comments here\nopen/aaa # if you want to.", "hidden"=>false}
+    @lh_project.prefix_options = {}
+    
+  end
+  
+  # Essentially just a sanity check on the include since .new always returns the object's instance
+  it "should be able to instantiate a new instance" do
+    @ticketmaster.should be_an_instance_of TicketMaster
+    @ticketmaster.should be_a_kind_of TicketMaster::Provider::Lighthouse
+  end
+  
+  it "should be able to load projects" do
+    LighthouseAPI::Project.should_receive(:find).with(:all).at_least(:once).and_return([@lh_project])
+    @ticketmaster.projects.should be_an_instance_of Array
+    @ticketmaster.projects.first.should be_an_instance_of @project_class
+    @ticketmaster.projects.first.description.should == @lh_project.attributes['description']
+    @ticketmaster.projects(:id => 54448).should be_an_instance_of Array
+    @ticketmaster.projects(:id => 54448).first.should be_an_instance_of @project_class
+    @ticketmaster.projects(:id => 54448).first.id.should == 54448
+    
+    @ticketmaster.project.should == @project_class
+    @ticketmaster.project(:name => "lh-test").should be_an_instance_of @project_class
+    @ticketmaster.project(:name => "lh-test").name.should == "lh-test"
+    @ticketmaster.project.find(:first, :description => @lh_project.attributes['description']).should be_an_instance_of @project_class
+    @ticketmaster.project.find(:first, :description => @lh_project.attributes['description']).description.should == @lh_project.attributes['description']
+  end
+  
+  it "should be able to do project stuff" do
+    info = {:name => 'Test create'}
+    LighthouseAPI::Project.should_receive(:new).at_least(:once).and_return(@lh_project)
+    @lh_project.should_receive(:save).at_least(:once).and_return(true)
+    @ticketmaster.project.create(info).should be_an_instance_of @project_class
+    @ticketmaster.project.new(info).should be_an_instance_of @project_class
+    @ticketmaster.project.create(info).id.should == 54448
+  end
+  
+  it "should be able to load tickets" do
+    LighthouseAPI::Project.should_receive(:find).with(:all).at_least(:once).and_return([@lh_project])
+    LighthouseAPI::Ticket.should_receive(:find).with(:all, :params => {:project_id => 54448}).at_least(:once).and_return([LighthouseAPI::Ticket.new])
+    LighthouseAPI::Ticket.should_receive(:find).with(999, :params => {:project_id => 54448}).at_least(:once).and_return(LighthouseAPI::Ticket.new(:id => 999))
+    LighthouseAPI::Ticket.should_receive(:find).with(:all, :params => {:project_id => 54448, :id => 888}).at_least(:once).and_return([LighthouseAPI::Ticket.new(:id => 888)])
+    project = @ticketmaster.projects.first
+    project.tickets.should be_an_instance_of Array
+    project.tickets.first.should be_an_instance_of @ticket_class
+    project.tickets(999).should be_an_instance_of Array
+    project.tickets(999).first.should  be_an_instance_of @ticket_class
+    project.tickets(999).first.id.should == 999
+    
+    project.ticket.should ==  TicketMaster::Provider::Lighthouse::Ticket
+    project.ticket(999).should be_an_instance_of @ticket_class
+    project.ticket(999).id.should == 999
+    project.ticket.find(:first, :project_id => 54448, :id => 888).should be_an_instance_of @ticket_class
   end
 end

data/ticketmaster-lighthouse.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ticketmaster-lighthouse}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hong"]
-  s.date = %q{2010-06-14}
+  s.date = %q{2010-06-22}
   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,7 +26,7 @@ Gem::Specification.new do |s|
      "lib/lighthouse/LICENSE",
      "lib/lighthouse/README.markdown",
      "lib/lighthouse/lighthouse-api.rb",
-     "lib/provider/authenticator.rb",
+     "lib/provider/lighthouse.rb",
      "lib/provider/project.rb",
      "lib/provider/ticket.rb",
      "lib/ticketmaster-lighthouse.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ticketmaster-lighthouse
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Hong
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-14 00:00:00 -07:00
+date: 2010-06-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,7 +101,7 @@ files:
 - lib/lighthouse/LICENSE
 - lib/lighthouse/README.markdown
 - lib/lighthouse/lighthouse-api.rb
-- lib/provider/authenticator.rb
+- lib/provider/lighthouse.rb
 - lib/provider/project.rb
 - lib/provider/ticket.rb
 - lib/ticketmaster-lighthouse.rb

data/lib/provider/authenticator.rb

@@ -1,4 +0,0 @@
-module TicketMasterMod
-  class Authenticator < Hashie::Mash
-  end
-end