ticketmaster 0.1.0 → 0.3.1

data/TODO

@@ -0,0 +1 @@
+1) A Cache system for the finders

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.3.1

data/bin/ticket

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-puts "ticket commands will go thru here..."
-puts "EXAMPLE:"
-puts "ticket list"
-puts "ticket close 127 \"This is done\""
-puts "ticket open \"what a problem we have here\""
+# The 'ticketmaster' gem was installed using rubygems
+# This file is the CLI application to use with 'ticketmaster'
+
+require File.dirname(__FILE__) + '/../lib/ticketmaster/cli/init.rb'
+

data/lib/ticketmaster.rb

@@ -7,8 +7,11 @@ class TicketMaster
 end
 
 %w{
+  common
+  helper
   project
   ticket
+  comment
   authenticator
   provider
   exception
@@ -18,7 +21,8 @@ end
 # This is the TicketMaster class
 #
 class TicketMaster
-  attr_reader :provider
+  attr_reader :provider, :symbol
+  attr_accessor :default_project
   
   # This initializes the TicketMaster instance and prepares the provider
   # If called without any arguments, it conveniently tries searching for the information in
@@ -27,14 +31,16 @@ class TicketMaster
   #
   # What it DOES NOT do is auto-require the provider...so make sure you have the providers required.
   def initialize(system = nil, authentication = nil)
-    if system.nil?
+    if system.nil? or authentication.nil?
       require 'yaml'
-      data = YAML.load_file File.expand_path('~/.ticketmaster.yml')
-      system = data['default'] || data.first.first
-      authentication = data[system] if authentication.nil?
+      data = YAML.load_file File.expand_path(ENV['TICKETMASTER_CONFIG'] || '~/.ticketmaster.yml')
+      system = system.nil? ? data['default'] || data.first.first : system.to_s
+      authentication = data[system]['authentication'] if authentication.nil? and data[system]['authentication']
     end
     self.extend TicketMaster::Provider.const_get(system.to_s.capitalize)
     authorize authentication
+    @symbol = system.to_sym
+    @provider = TicketMaster::Provider.const_get(system.to_s.capitalize)
   end
   
   # Providers should over-write this method

data/lib/ticketmaster/cli/commands/config.rb

@@ -0,0 +1,90 @@
+# The command method call implementation
+# This sets the option parser and passes the parsed options to the subcommands
+def config(options)
+  ARGV << '--help' if ARGV.length == 0
+  begin
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: ticket -p PROVIDER [options] config [config_options]'
+      opts.separator ''
+      opts.separator 'Options:'
+      
+      opts.on('-a', '--add', 'Add a new entry to the configuration file based on ticketmaster options.') do
+        options[:subcommand] = 'add'
+      end
+      
+      opts.on('-e', '--edit', 'Edit an existing entry to the configuration file based on ticketmaster options') do
+        options[:subcommand] = 'edit'
+      end
+      
+      opts.on('-p', '--set-default-provider', 'Set the current provider as the default.', 'Requires provider to be specified, otherwise unsets the default') do
+        options[:subcommand] = 'set_default_provider'
+      end
+      
+      opts.separator ''
+      opts.separator 'Other options:'
+      
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+    end.parse(ARGV)
+  rescue OptionParser::MissingArgument => exception
+    puts "ticket #{options[:original_argv].join(' ')}\n\n"
+    puts "Error: An option was called that requires an argument, but was not given one"
+    puts exception.message
+  end
+  send(options[:subcommand], options)
+end
+
+# Called on --add. It adds a new entry to the config file and will refuse if it already exists
+def add(options)
+  require_provider unless options[:provider]
+  provider = options[:provider]
+  config = YAML.load_file(config_file = File.expand_path(options[:config]))
+  if config[provider]
+    puts "#{provider} has already been specfied in #{options[:config]}. Refusing to add. Use --edit instead."
+    exit 1
+  end
+  config[provider] = {}
+  config[provider]['authentication'] = options[:authentication] || {}
+  config[provider]['project'] = options[:project] if options[:project]
+  File.open(config_file, 'w') do |out|
+    YAML.dump(config, out)
+  end
+  puts "Wrote #{provider} to #{config_file}"
+  exit
+end
+
+# Called on --edit. It updates and edits an entry. If the entry is non-existent, it will add it.
+def edit(options)
+  require_provider unless options[:provider]
+  provider = options[:provider]
+  config = YAML.load_file(config_file = File.expand_path(options[:config]))
+  config[provider] ||= {}
+  config[provider]['authentication'] = options[:authentication] || {}
+  config[provider]['project'] = options[:project] if options[:project]
+  File.open(config_file, 'w') do |out|
+    YAML.dump(config, out)
+  end
+  puts "Wrote #{provider} to #{config_file}"
+  exit
+end
+
+# Called on --set-default-provider. It sets the current provider as the default
+def set_default_provider(options)
+  provider = options[:provider]
+  config = YAML.load_file(config_file = File.expand_path(options[:config]))
+  puts "Warning! #{provider} is not defined in #{config_file}" unless provider.nil? or config[provider]
+  config['default'] = provider
+  File.open(config_file, 'w') do |out|
+    YAML.dump(config, out)
+  end
+  puts "Default provider has been set to '#{provider}'"
+  exit
+end
+
+# Called when a provider is not given.
+def require_provider
+  puts "Provider must be specified!"
+  exit 1
+end

data/lib/ticketmaster/cli/commands/console.rb

@@ -0,0 +1,31 @@
+# the console command
+def console(options)
+  send(:open_irb, options, ARGV)
+end
+
+# the actual method to do the irb opening
+def open_irb(options, argv)
+  tm_lib   = File.dirname(__FILE__) + '/../../../ticketmaster.rb'
+  irb_name = RUBY_PLATFORM =~ /mswin32/ ? 'irb.bat' : 'irb'  
+  requires = "-r rubygems -r #{tm_lib} "
+  cmd = ''
+  if File.exist?(config = File.expand_path(options[:config]))
+    ENV['TICKETMASTER_CONFIG']=config
+  end
+  providers = !options[:provider].nil? ? [options[:provider]] : YAML.load_file(config).keys
+  providers.delete 'default'
+  require 'rubygems'
+  require 'ticketmaster'
+  providers.reduce(requires) do |mem, p|
+    begin
+      require "ticketmaster-#{p}"
+      requires << "-r ticketmaster-#{p} "
+    rescue LoadError => exception
+      puts exception
+      require "#{p}"
+      requires << "-r #{p} "
+    end
+  end
+  cmd << "#{irb_name} #{requires} --simple-prompt #{ARGV.join(' ')}"
+  exec cmd
+end

data/lib/ticketmaster/cli/commands/help.rb

@@ -0,0 +1,9 @@
+# The help command.
+def help(options)
+  cmd = ARGV.shift || 'help'
+  page = File.dirname(__FILE__) + '/help/' + cmd
+  if File.exist?(page)
+    puts File.read(page)
+    puts "\nFor parameter listing and details, try executing the command with --help.\n\tticketmaster #{cmd} --help"
+  end  
+end

data/lib/ticketmaster/cli/commands/help/config

@@ -0,0 +1,27 @@
+This command is used to configure ticketmaster settings for use in your terminal.
+
+By default, ticketmaster searches for the config information in a file named 'ticketmaster.yml' in the current directory. Next it searches for 'config/ticketmaster.yml' and if that fails, it uses the home directory's ~/.ticketmaster.yml (note the . in front on this one). There is also the TICKETMASTER_CONFIG environment variable that you can set to point to another configuration file anywhere if necessary.
+
+This command helps facilitate the creation of a ticketmaster.yml.
+
+Warning: Due to the way the authentication is parsed, if any keys or values contain a comma (,) or colin (:), it can not be parsed through the -A command. Usually this isn't a problem, and if it is, it can be resolved though putting the values in a config file.
+
+Example:
+  ticket -c ~/.ticketmaster.yml -p dummy -A username:cheese,password:cakes -P 555 config --add
+  ticket -p dummy config --set-default-provider
+
+The format for ticketmaster.yml is:
+  default: <default provider>
+  <provider name>:
+    authentication:
+      <authentication information>
+    project: <project>
+  [...]
+
+For example, a ticketmaster.yml with the Dummy provider would look something like this:
+  default: dummy
+  dummy:
+    authentication:
+      username: name
+      password: doesnt-matter
+    project: 555

data/lib/ticketmaster/cli/commands/help/console

@@ -0,0 +1,13 @@
+This command is used to open an irb session with the ticketmaster.
+
+The configuration for this command should mostly be dependent on the ticketmaster.yml files.
+See ticketmaster help config for more information on how to set it up.
+
+Example:
+  ticket console
+  ticket -p dummy console
+  ticket -p dummy console -d --tracer
+
+By default, it attempts to load all providers listed in the config unless a provider is explicitly given.
+
+All options passed to console is passed to the irb session. See irb --help for those options and their details

data/lib/ticketmaster/cli/commands/help/help

@@ -0,0 +1,7 @@
+usage: ticket help COMMAND
+
+This is the help command. You can use this command to get more information on other commands.
+
+Example:
+  ticket help config
+  ticket help console

data/lib/ticketmaster/cli/commands/help/project

@@ -0,0 +1,13 @@
+This command is used to work with projects.
+
+It can be used to do any of the CRUD actions with projects that are provided by the provider.
+
+It will attempt to load data through the config files if they are available. See 'ticket help config' for more information.
+
+Examples:
+  ticket -p lighthouse -A account:ticketmaster,token:abc project --create name "new project"
+  ticket project --read 946
+  ticket --project 946 project --read
+  ticket -p dummy -A "user:common coder,pass:w3rd out" project --destroy 712
+  ticket -p dummy -P 712 project --destroy
+  ticket -p dummy project --update name "new project name" description "this is the project description"

data/lib/ticketmaster/cli/commands/help/ticket

@@ -0,0 +1,14 @@
+This command is used to work with tickets.
+
+It can be used to do any of the CRUD actions with projects that are provided by the provider.
+
+It will attempt to load data through the config files if they are available. See 'ticket help config' for more information.
+
+If any of the keys or values contain a space, you will have to enclose that key or value in quotes. For example, if you set name to ProjectName it does not need to be quoted, but if you set name to Project Name it will have to be quoted to "Project Name" or 'Project Name'
+
+Examples:
+  ticket -p lighthouse -A account:ticketmaster,token:abc ticket --create name "new ticket" description "this is a new ticket"
+  ticket --project 946 ticket --read --ticket 2
+  ticket -p dummy -A "user:common coder,pass: w3rd out" ticket --destroy --ticket 12
+  ticket -p dummy -P 712 ticket --destroy --ticket 4
+  ticket -p dummy project --ticket 6 --update attribute value name "free dummies"

data/lib/ticketmaster/cli/commands/project.rb

@@ -0,0 +1,136 @@
+require 'rubygems'
+# The command method call for project
+# This sets the option parser and passes the parsed options to the subcommands
+def project(options)
+  ARGV << '--help' if ARGV.length == 0
+  begin
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: ticket -p PROVIDER [options] project [project_options]'
+      opts.separator ''
+      opts.separator 'Options:'
+      
+      opts.on('-C', '--create ATTRIBUTES', 'Create a new project') do |attribute|
+        options[:project_attributes] = {attribute => ARGV.shift}.merge(attributes_hash(ARGV))
+        options[:subcommand] = 'create'
+      end
+      
+      opts.on('-R', '--read [PROJECT]', 'Read out project and its attributes') do |id|
+        options[:project] = id if id
+        options[:subcommand] = 'read'
+      end
+      
+      opts.on('-U', '--update ATTRIBUTES', 'Update project information') do |attribute|
+        options[:project_attributes] = {attribute => ARGV.shift}.merge(attributes_hash(ARGV))
+        options[:subcommand] = 'update'
+      end
+      
+      opts.on('-D', '--destroy [PROJECT]', 'Destroy the project. Not reversible!') do |id|
+        options[:project] = id if id
+        options[:subcommand] = 'destroy'
+      end
+      
+      opts.on('-I', '--info [PROJECT_ID]', 'Get project info. Same as --read. ') do |id|
+        options[:project] = id if id
+        options[:subcommand] = 'read'
+      end
+      
+      opts.on('-S', '--search [ATTRIBUTES]', 'Search for a project based on attributes') do |attribute|
+        options[:project_attributes] = attribute ? {attribute => ARGV.shift}.merge(attributes_hash(ARGV)) : {}
+        options[:subcommand] = 'search'
+      end
+      
+      opts.on('-L', '--list-all', 'List all projects. Same as --search without any parameters') do
+        options[:project_attributes] = {}
+        options[:subcommand] = 'search'
+      end
+      
+      opts.separator ''
+      opts.separator 'Other options:'
+      
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+    end.order!
+  rescue OptionParser::MissingArgument => exception
+    puts "ticket #{options[:original_argv].join(' ')}\n\n"
+    puts "Error: An option was called that requires an argument, but was not given one"
+    puts exception.message
+  end
+  parse_config!(options)
+  begin
+    require 'ticketmaster'
+    require "ticketmaster-#{options[:provider]}"
+  rescue
+    require options[:provider]
+  end
+  send(options[:subcommand], options)
+end
+
+
+# The create subcommand
+def create(options)
+  tm = TicketMaster.new(options[:provider], options[:authentication])
+  project = tm.project.create(options[:project_attributes])
+  read_project project
+  exit
+end
+
+# The read subcommand
+def read(options)
+  tm = TicketMaster.new(options[:provider], options[:authentication])
+  project = tm.project.find(options[:project].to_i)
+  read_project project
+  exit
+end
+
+# The update subcommand
+def update(options)
+  tm = TicketMaster.new(options[:provider], options[:authentication])
+  project = tm.project.find(options[:project].to_i)
+  if project.update!(options[:project_attributes])
+    puts "Successfully updated Project #{project.name} (#{project.id})"
+  else
+    puts "Sorry, it seems there was an error when trying to update the attributes"
+  end
+  read_project project
+  exit
+end
+
+# The destroy subcommand.
+def destroy(options)
+  tm = TicketMaster.new(options[:provider], options[:authentication])
+  project = tm.project.find(options[:project].to_i)
+  puts "Are you sure you want to delete Project #{project.name} (#{project.id})? (yes/no) [no]"
+  ARGV.clear
+  confirm = readline.chomp.downcase
+  if confirm != 'y' and confirm != 'yes'
+    puts "Did not receive a 'yes' confirmation. Exiting..."
+    exit
+  elsif project.destroy
+    puts "Successfully deleted Project #{project.name} (#{project.id})"
+  else
+    puts "Sorry, it seems there was an error when trying to delete the project"
+  end
+  exit
+end
+
+# The search and list subcommands
+def search(options)
+  tm = TicketMaster.new(options[:provider], options[:authentication])
+  projects = tm.projects(options[:project_attributes])
+  puts "Found #{projects.length} projects"
+  projects.each_with_index do |project, index|
+    puts "#{index+1}) Project #{project.name} (#{project.id})"
+    read_project project
+    puts
+  end
+  exit
+end
+
+# A utility method used to output project attributes
+def read_project(project)
+  project.system_data[:client].attributes.sort.each do |key, value|
+    puts "#{key} : #{value}"
+  end
+end

data/lib/ticketmaster/cli/commands/ticket.rb

@@ -0,0 +1,136 @@
+require 'rubygems'
+# The command method call for project
+# This sets the option parser and passes the parsed options to the subcommands
+def ticket(options)
+  ARGV << '--help' if ARGV.length == 0
+  begin
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: ticket -p PROVIDER -P PROJECT [options] ticket [ticket_options]'
+      opts.separator ''
+      opts.separator 'Options:'
+      
+      opts.on('-T', '--ticket TICKET', 'Sets the working ticket') do |id|
+        options[:ticket] = id
+      end
+      opts.on('-C', '--create ATTRIBUTES', 'Create a new ticket') do |attribute|
+        options[:ticket_attributes] = {attribute => ARGV.shift}.merge(attributes_hash(ARGV))
+        options[:subcommand] = 'create'
+      end
+      
+      opts.on('-R', '--read', 'Read out ticket and its attributes. Requires --ticket to be set') do
+        options[:subcommand] = 'read'
+      end
+      
+      opts.on('-U', '--update ATTRIBUTES', 'Update ticket information. Requires --ticket to be set') do |attribute|
+        options[:ticket_attributes] = {attribute => ARGV.shift}.merge(attributes_hash(ARGV))
+        options[:subcommand] = 'update'
+      end
+      
+      opts.on('-D', '--destroy', 'Destroy/Delete the ticket. Not reversible! Requires --ticket to be set') do
+        options[:subcommand] = 'destroy'
+      end
+      
+      opts.on('-I', '--info', 'Get ticket info. Same as --read. ') do
+        options[:subcommand] = 'read'
+      end
+      
+      opts.on('-S', '--search [ATTRIBUTES]', 'Search for a ticket based on attributes') do |attribute|
+        options[:ticket_attributes] = attribute ? {attribute => ARGV.shift}.merge(attributes_hash(ARGV)) : {}
+        options[:subcommand] = 'search'
+      end
+      
+      opts.on('-L', '--list-all', 'List all tickets. Same as --search without any parameters') do
+        options[:ticket_attributes] = {}
+        options[:subcommand] = 'search'
+      end
+      
+      opts.separator ''
+      opts.separator 'Other options:'
+      
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+    end.order!
+  rescue OptionParser::MissingArgument => exception
+    puts "ticket #{options[:original_argv].join(' ')}\n\n"
+    puts "Error: An option was called that requires an argument, but was not given one"
+    puts exception.message
+  end
+  parse_config!(options)
+  begin
+    require 'ticketmaster'
+    require "ticketmaster-#{options[:provider]}"
+  rescue
+    require options[:provider]
+  end
+  send(options[:subcommand], options)
+end
+
+
+# The create subcommand
+def create(options)
+  tm = TicketMaster.new(options[:provider], options[:authentication])
+  ticket = tm.ticket.create(options[:ticket_attributes].merge({:project_id => options[:project].to_i}))
+  read_ticket ticket
+  exit
+end
+
+# The read subcommand
+def read(options)
+  tm = TicketMaster.new(options[:provider], options[:authentication])
+  ticket = tm.ticket.find(options[:ticket].to_i, options[:project].to_i)
+  read_ticket ticket
+  exit
+end
+
+# The update subcommand
+def update(options)
+  tm = TicketMaster.new(options[:provider], options[:authentication])
+  ticket = tm.ticket.find(options[:ticket].to_i, options[:project].to_i)
+  if ticket.update!(options[:ticket_attributes])
+    puts "Successfully updated Ticket #{ticket.title} (#{ticket.id})"
+  else
+    puts "Sorry, it seems there was an error when trying to update the attributes"
+  end
+  read_ticket ticket
+  exit
+end
+
+# The destroy subcommand.
+def destroy(options)
+  tm = TicketMaster.new(options[:provider], options[:authentication])
+  ticket = tm.ticket.find(options[:ticket].to_i, options[:project].to_i)
+  puts "Are you sure you want to delete Ticket #{ticket.title} (#{ticket.id})? (yes/no) [no]"
+  ARGV.clear
+  confirm = readline.chomp.downcase
+  if confirm != 'y' and confirm != 'yes'
+    puts "Did not receive a 'yes' confirmation. Exiting..."
+    exit
+  elsif ticket.destroy
+    puts "Successfully deleted Ticket #{ticket.title} (#{ticket.id})"
+  else
+    puts "Sorry, it seems there was an error when trying to delete the project"
+  end
+  exit
+end
+
+# The search and list subcommands
+def search(options)
+  tm = TicketMaster.new(options[:provider], options[:authentication])
+  tickets = tm.ticket.find(options[:ticket_attributes])
+  puts "Found #{tickets.length} tickets"
+  tickets.each_with_index do |ticket, index|
+    puts "#{index+1}) Ticket #{ticket.title} (#{ticket.id})"
+    read_ticket ticket
+    puts
+  end
+  exit
+end
+
+# A utility method used to output project attributes
+def read_ticket(ticket)
+  ticket.system_data[:client].attributes.sort.each do |key, value|
+    puts "#{key} : #{value}"
+  end
+end