ticketmaster 0.1.0 → 0.3.1

data/lib/ticketmaster/provider.rb

@@ -11,6 +11,11 @@
 # We are also planning on standardizing non-standard/provider-specific object models
 module TicketMaster::Provider
   module Base
+    PROJECT_API = nil # The Class for the project api interaction
+    TICKET_API = nil # The Class for the ticket api interaction
+    
+    include TicketMaster::Provider::Helper
+    
     # All providers must define this method.
     # It doesn't *have* to do anything, it just has to be there. But since it's here, you don't
     # have to worry about it as long as you "include TicketMaster::Provider::Base"
@@ -28,8 +33,15 @@ module TicketMaster::Provider
     #
     # Should try to implement a find :first (or find with singular result) if given parameters
     def project(*options)
-      return TicketMaster::Project.find(*options) if options.length > 0
-      TicketMaster::Project
+      easy_finder(@provider::Project, :first, options)
+    end
+    
+    # All providers should try to define this method.
+    #
+    # It returns all projects in an array
+    # Should try to implement a find :all if given parameters
+    def projects(*options)
+      easy_finder(@provider::Project, :all, options)
     end
     
     # Providers should try to define this method
@@ -43,16 +55,7 @@ module TicketMaster::Provider
     #
     # Should try to implement a find :first (or find with singular result) if given parameters
     def ticket(*options)
-      return TicketMaster::Ticket.find(*options) if options.length > 0
-      TicketMaster::Ticket
-    end
-    
-    # All providers should try to define this method.
-    #
-    # It returns all projects in an array
-    # Should try to implement a find :all if given parameters
-    def projects(*options)
-      []
+      easy_finder(@provider::Ticket, :first, options)
     end
       
     # All providers should try to define this method
@@ -60,7 +63,7 @@ module TicketMaster::Provider
     # It returns all tickets in an array.
     # Should try to implement a find :all if given parameters
     def tickets(*options)
-      []
+      easy_finder(@provider::Ticket, :all, options)
     end
   end
 end

data/lib/ticketmaster/ticket.rb

@@ -8,111 +8,139 @@ module TicketMaster::Provider
     # methods act based on a blank slate (which means the info to find a specific ticket has
     # to be passed in the parameters in the ticket)
     #
-    # Methods that a provider must define:
-    #
-    # * self.find
-    # * close
-    # * save
-    # * destroy
-    #
     # Methods that the provider should define if feasible:
     #
     # * reload!
     # * initialize
+    # * close
+    # * save
+    # * destroy
     #
     # Methods that would probably be okay if the provider left it alone:
     #
     # * self.create
     # * update
     # * update!
+    # * self.find
     #
     # A provider should define as many attributes as feasibly possible. The list below are 
     # some guidelines as to what attributes are necessary, if your provider's api does not
-    # implement them, point it to an attribute that is close to it. (for example, a summary
-    # can point to title. and assignee might point to assigned_to. Remember to alias it in your class!)
+    # implement them, point it to an attribute that is close to it. (for example, a title
+    # can point to summary. and assignee might point to assigned_to. Remember to alias it in your class!)
     # 
     # * id
     # * status
     # * priority
-    # * summary
+    # * title
     # * resolution
     # * created_at
     # * updated_at
     # * description
     # * assignee
+    # * requestor
+    # * project_id
     class Ticket < Hashie::Mash
-      @ignore_inspect = %w| system system_data |
-      @system = nil # The symbol for the provider.
-      @system_data = nil # The system info for the provider
+      include TicketMaster::Provider::Common
+      include TicketMaster::Provider::Helper
+      extend TicketMaster::Provider::Helper
       attr_accessor :system, :system_data
-      # Find a ticket
-      #
-      # The implementation should be able to accept these cases if feasible:
+      API = nil # Replace with your ticket API's Class
+
+      # Find ticket
+      # You can also retrieve an array of all tickets by not specifying any query.
       #
-      # * find(:all) - Returns an array of all tickets
-      # * find(##) - Returns a project 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)
-        raise TicketMaster::Exception.new("This method must be reimplemented in the provider")
+      # * find(<project_id>) or find(<project_id>, :all) - Returns an array of all tickets
+      # * find(<project_id>, ##) - Returns a ticket based on that id or some other primary (unique) attribute
+      # * find(<project_id>, [#, #, #]) - Returns many tickets with these ids
+      # * find(<project_id>, :first, :title => 'ticket name') - Returns the first ticket based on the ticket's attribute(s)
+      # * find(<project_id>, :last, :title => 'Some ticket') - Returns the last ticket based on the ticket's attribute(s)
+      # * find(<project_id>, :all, :title => 'Test ticket') - Returns all tickets based on the given attribute(s)
+      def self.find(project_id, *options)
+        first, attributes = options
+        if first.nil? or (first == :all and attributes.nil?)
+          self.find_by_attributes(project_id)
+        elsif first.is_a? Fixnum
+          self.find_by_id(project_id, first)
+        elsif first.is_a? Array
+          first.collect { |id| self.find_by_id(project_id, id) }
+        elsif first == :first
+          tickets = attributes.nil? ? self.find_by_attributes(project_id) : self.find_by_attributes(project_id, attributes)
+          tickets.first
+        elsif first == :last
+          tickets = attributes.nil? ? self.find_by_attributes(project_id) : self.find_by_attributes(project_id, attributes)
+          tickets.last
+        elsif first == :all
+          self.find_by_attributes(project_id, attributes)
+        end
       end
       
-      # Create a ticket.
-      # Basically, a .new and .save in the same call. The default method assumes it is passed a
-      # single hash with attribute information
-      def self.create(*options)
-        ticket = self.new(options.first)
-        ticket.save
+      # The first of whatever ticket
+      def self.first(project_id, *options)
+        self.find(project_id, :first, *options)
       end
       
-      # Instantiate a new ticket (but don't save yet!)
-      # The default method assumes a single hash with all the parameters is passed to Ticket.new
-      def initialize(*options)
-        super(options.first)
-        # do some other stuff
+      # The last of whatever ticket
+      def self.last(project_id, *options)
+        self.find(project_id, :last, *options)
       end
-
-      # Close this ticket
-      #
-      # On success it should return true, otherwise false
-      def close(*options)
-        raise TicketMaster::Exception.new("This method must be reimplemented in the provider")
+      
+      # Accepts an integer id and returns the single ticket instance
+      # Must be defined by the provider
+      def self.find_by_id(project_id, ticket_id)
+        if self::API.is_a? Class
+          self.new self::API.find(ticket_id, :params => {:project_id => project_id})
+        else
+          raise TicketMaster::Exception.new("This method must be reimplemented in the provider")
+        end
       end
       
-      # Save this ticket
-      # Expected return value of true (successful) or false (failure)
-      def save(*options)
-        raise TicketMaster::Exception.new("This method must be reimplemented in the provider")
+      # Accepts an attributes hash and returns all tickets matching those attributes in an array
+      # Should return all tickets if the attributes hash is empty
+      # Must be defined by the provider
+      def self.find_by_attributes(project_id, attributes = {})
+        if self::API.is_a? Class
+          self.search(project_id, attributes).collect { |thing| self.new thing }
+        else
+          raise TicketMaster::Exception.new("This method must be reimplemented in the provider")
+        end
       end
       
-      # Reload this ticket
-      def reload!(*options)
-        raise TicketMaster::Exception.new("This method must be reimplemented in the provider")
+      # This is a helper method to find
+      def self.search(project_id, options = {}, limit = 1000)
+        if self::API.is_a? Class
+          tickets = self::API.find(:all, :params => {:project_id => project_id})
+          search_by_attribute(tickets, options, limit)
+        else
+          raise TicketMaster::Exception.new("This method must be reimplemented in the provider")
+        end
+      end
+
+      # Asks the provider's api for the comment associated with the project,
+      # returns an array of Comment objects.
+      def comments(*options)
+        options.insert 0, project_id
+        options.insert 1, id
+        easy_finder(self.class.parent::Comment, :all, options, 2)
       end
       
-      # Delete this ticket
-      #
-      # If your provider doesn't have a delete or trash option for tickets:
-      #    raise TicketMaster::Exception.new("Tickets can not be destroyed on SomeProviderAPI")
-      def destroy(*options)
-        raise TicketMaster::Exception.new("This method must be reimplemented in the provider")
+      def comment(*options)
+        if options.length > 0
+          options.insert(0, project_id)
+          options.insert(1, id)
+        end
+        easy_finder(self.class.parent::Comment, :first, options, 2)
       end
       
-      # Update a ticket and save
+      # Close this ticket
       #
-      # The default assumes the options passed to it is a single hash with the attributes to update
-      def update!(*options)
-        update(options.first)
-        save
+      # On success it should return true, otherwise false
+      def close(*options)
+        raise TicketMaster::Exception.new("This method must be reimplemented in the provider")
       end
       
-      # Update a ticket's attributes, but no save
-      # Used when you need to do mass attribute assignment
-      def update(*options)
-        options.first.each do |k, v|
-          self.send(k + '=', v)
-        end
-        self
+      # Reload this ticket
+      def reload!(*options)
+        raise TicketMaster::Exception.new("This method must be reimplemented in the provider")
       end
 
     end

data/spec/ticketmaster-cli_spec.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config| end
+# Tests for the cli
+# I'm not quite sure what the most effective way to test this is...
+describe "Ticketmaster CLI" do
+  before(:all) do
+    @ticket = File.dirname(__FILE__) + '/../bin/ticket'
+    @cli_dir = File.dirname(__FILE__) + '/../lib/ticketmaster/cli'
+  end
+  
+  it "should output help if no command given" do
+    help = `#{@ticket}`
+    $?.should == 0
+    help.should include('Usage: ticket [options] COMMAND [command_options]')
+  end
+  
+  it "should be able to show help pages" do
+    `#{@ticket} help`.should include(File.read(@cli_dir + '/commands/help/help'))
+    `#{@ticket} help config`.should include(File.read(@cli_dir + '/commands/help/config'))
+    `#{@ticket} help console`.should include(File.read(@cli_dir + '/commands/help/console'))
+  end
+  
+  it "should be able to add and edit config info" do
+    pending
+  end
+  
+  it "should be able to open up a console" do
+    pending
+  end
+  
+end

data/ticketmaster.gemspec

@@ -0,0 +1,95 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ticketmaster}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sirupsen", "deadprogrammer"]
+  s.date = %q{2010-07-03}
+  s.default_executable = %q{ticket}
+  s.description = %q{Ticketmaster provides a universal API to trouble ticket and project management systems.}
+  s.email = %q{simon@hybridgroup.com}
+  s.executables = ["ticket"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md",
+     "TODO"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "NOTES",
+     "README.md",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "bin/ticket",
+     "lib/ticketmaster.rb",
+     "lib/ticketmaster/authenticator.rb",
+     "lib/ticketmaster/cli/commands/config.rb",
+     "lib/ticketmaster/cli/commands/console.rb",
+     "lib/ticketmaster/cli/commands/help.rb",
+     "lib/ticketmaster/cli/commands/help/config",
+     "lib/ticketmaster/cli/commands/help/console",
+     "lib/ticketmaster/cli/commands/help/help",
+     "lib/ticketmaster/cli/commands/help/project",
+     "lib/ticketmaster/cli/commands/help/ticket",
+     "lib/ticketmaster/cli/commands/project.rb",
+     "lib/ticketmaster/cli/commands/ticket.rb",
+     "lib/ticketmaster/cli/common.rb",
+     "lib/ticketmaster/cli/init.rb",
+     "lib/ticketmaster/comment.rb",
+     "lib/ticketmaster/common.rb",
+     "lib/ticketmaster/dummy/dummy.rb",
+     "lib/ticketmaster/dummy/project.rb",
+     "lib/ticketmaster/dummy/ticket.rb",
+     "lib/ticketmaster/exception.rb",
+     "lib/ticketmaster/helper.rb",
+     "lib/ticketmaster/project.rb",
+     "lib/ticketmaster/provider.rb",
+     "lib/ticketmaster/ticket.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/ticketmaster-cli_spec.rb",
+     "spec/ticketmaster_spec.rb",
+     "test/helper.rb",
+     "test/test_ticketmaster.rb",
+     "ticketmaster-0.3.0.gem",
+     "ticketmaster-0.3.1.gem",
+     "ticketmaster.gemspec"
+  ]
+  s.homepage = %q{http://ticketrb.com}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ticketmaster provides a universal API to trouble ticket and project management systems.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/ticketmaster-cli_spec.rb",
+     "spec/ticketmaster_spec.rb",
+     "test/helper.rb",
+     "test/test_ticketmaster.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ticketmaster
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 17
   prerelease: false
   segments: 
   - 0
+  - 3
   - 1
-  - 0
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Sirupsen
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-22 00:00:00 +02:00
+date: 2010-07-03 00:00:00 -07:00
 default_executable: ticket
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,6 +56,7 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.md
+- TODO
 files: 
 - .document
 - .gitignore
@@ -63,23 +64,42 @@ files:
 - NOTES
 - README.md
 - Rakefile
+- TODO
 - VERSION
 - bin/ticket
-- lib/console.rb
 - lib/ticketmaster.rb
 - lib/ticketmaster/authenticator.rb
+- lib/ticketmaster/cli/commands/config.rb
+- lib/ticketmaster/cli/commands/console.rb
+- lib/ticketmaster/cli/commands/help.rb
+- lib/ticketmaster/cli/commands/help/config
+- lib/ticketmaster/cli/commands/help/console
+- lib/ticketmaster/cli/commands/help/help
+- lib/ticketmaster/cli/commands/help/project
+- lib/ticketmaster/cli/commands/help/ticket
+- lib/ticketmaster/cli/commands/project.rb
+- lib/ticketmaster/cli/commands/ticket.rb
+- lib/ticketmaster/cli/common.rb
+- lib/ticketmaster/cli/init.rb
+- lib/ticketmaster/comment.rb
+- lib/ticketmaster/common.rb
 - lib/ticketmaster/dummy/dummy.rb
 - lib/ticketmaster/dummy/project.rb
 - lib/ticketmaster/dummy/ticket.rb
 - lib/ticketmaster/exception.rb
+- lib/ticketmaster/helper.rb
 - lib/ticketmaster/project.rb
 - lib/ticketmaster/provider.rb
 - lib/ticketmaster/ticket.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/ticketmaster-cli_spec.rb
 - spec/ticketmaster_spec.rb
 - test/helper.rb
 - test/test_ticketmaster.rb
+- ticketmaster-0.3.0.gem
+- ticketmaster-0.3.1.gem
+- ticketmaster.gemspec
 has_rdoc: true
 homepage: http://ticketrb.com
 licenses: []
@@ -116,6 +136,7 @@ specification_version: 3
 summary: Ticketmaster provides a universal API to trouble ticket and project management systems.
 test_files: 
 - spec/spec_helper.rb
+- spec/ticketmaster-cli_spec.rb
 - spec/ticketmaster_spec.rb
-- test/test_ticketmaster.rb
 - test/helper.rb
+- test/test_ticketmaster.rb