taskmapper 0.8.0

data/lib/taskmapper/cli/commands/generate/provider/ticket.rb

@@ -0,0 +1,12 @@
+module TaskMapper::Provider
+  module Yoursystem
+    # Ticket class for taskmapper-yoursystem
+    #
+    
+    class Ticket < TaskMapper::Provider::Base::Ticket
+      #API = Yoursystem::Ticket # The class to access the api's tickets
+      # declare needed overloaded methods here
+      
+    end
+  end
+end

data/lib/taskmapper/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\ttm #{cmd} --help"
+  end  
+end

data/lib/taskmapper/cli/commands/help/config

@@ -0,0 +1,27 @@
+This command is used to configure taskmapper settings for use in your terminal.
+
+By default, taskmapper searches for the config information in a file named 'taskmapper.yml' in the current directory. Next it searches for 'config/taskmapper.yml' and if that fails, it uses the home directory's ~/.taskmapper.yml (note the . in front on this one). There is also the TASKMAPPER environment variable that you can set to point to another configuration file anywhere if necessary.
+
+This command helps facilitate the creation of a taskmapper.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:
+  tm -c ~/.taskmapper.yml -p dummy -A username:cheese,password:cakes -P 555 config --add
+  tm -p dummy config --set-default-provider
+
+The format for taskmapper.yml is:
+  default: <default provider>
+  <provider name>:
+    authentication:
+      <authentication information>
+    project: <project>
+  [...]
+
+For example, a taskmapper.yml with the Dummy provider would look something like this:
+  default: dummy
+  dummy:
+    authentication:
+      username: name
+      password: doesnt-matter
+    project: 555

data/lib/taskmapper/cli/commands/help/console

@@ -0,0 +1,13 @@
+This command is used to open an irb session with the taskmapper.
+
+The configuration for this command should mostly be dependent on the taskmapper.yml files.
+See taskmapper help config for more information on how to set it up.
+
+Example:
+  tm console
+  tm -p dummy console
+  tm -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/taskmapper/cli/commands/help/generate

@@ -0,0 +1,19 @@
+This command is used to generate a new provider.
+
+It generates some basic files to get you started on creating your own provider.
+
+NOTE: This command, in an attempt to keep provider names consistent, will prepend 'taskmapper-' to the given provider name. You can cancel this by prepending a _ before your provider name, which will be removed if found.
+
+If you have not created a gem directory or skeleton and want to use Jeweler (http://github.com/technicalpickles/jeweler) you can execute:
+
+  $ tm generate myprovider --jeweler [JEWELER ARGS]
+
+And it will create your whole directory and skeleton using jeweler.
+
+If you like the old "classic" gem creation process or are using some other gem processor, you can create the directory to store your files, cd into it and run this command to put the skeleton files inside the directory's lib/.
+
+Example:
+  mkdir myprovider myprovider/lib
+  cd myprovider
+  [...]
+  tm generate myprovider

data/lib/taskmapper/cli/commands/help/help

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

data/lib/taskmapper/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 'tm help config' for more information.
+
+Examples:
+  tm -p lighthouse -A account:taskmapper,token:abc project --create name "new project"
+  tm project --read 946
+  tm --project 946 project --read
+  tm -p dummy -A "user:common coder,pass:w3rd out" project --destroy 712
+  tm -p dummy -P 712 project --destroy
+  tm -p dummy project --update name "new project name" description "this is the project description"

data/lib/taskmapper/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 'tm 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:
+  tm -p lighthouse -A account:taskmapper,token:abc ticket --create name "new ticket" description "this is a new ticket"
+  tm --project 946 ticket --read --ticket 2
+  tm -p dummy -A "user:common coder,pass: w3rd out" ticket --destroy --ticket 12
+  tm -p dummy -P 712 ticket --destroy --ticket 4
+  tm -p dummy project --ticket 6 --update attribute value name "free dummies"

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

@@ -0,0 +1,140 @@
+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: tm -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.on('-P', '--project [PROJECT_ID]', 'Set the project id') do |id|
+        options[:project] = id
+      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 "tm #{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 'taskmapper'
+    require "taskmapper-#{options[:provider]}"
+  rescue
+    require options[:provider]
+  end
+  send(options[:subcommand], options)
+end
+
+
+# The create subcommand
+def create(options)
+  tm = TaskMapper.new(options[:provider], options[:authentication])
+  project = tm.project.create(options[:project_attributes])
+  read_project project
+  exit
+end
+
+# The read subcommand
+def read(options)
+  tm = TaskMapper.new(options[:provider], options[:authentication])
+  project = tm.project.find(options[:project])
+  read_project project
+  exit
+end
+
+# The update subcommand
+def update(options)
+  tm = TaskMapper.new(options[:provider], options[:authentication])
+  project = tm.project.find(options[:project])
+  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 = TaskMapper.new(options[:provider], options[:authentication])
+  project = tm.project.find(options[:project])
+  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 = TaskMapper.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/taskmapper/cli/commands/ticket.rb

@@ -0,0 +1,145 @@
+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: tm -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 [TICKET]', 'Read out ticket and its attributes. Requires --ticket to be set') do |id|
+        options[:ticket] = id if id
+        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.on('-P', '--project [PROJECT_ID]', 'Set the project id') do |id|
+        options[:project] = id
+      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 "tm #{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 'taskmapper'
+    require "taskmapper-#{options[:provider]}"
+  rescue
+    require options[:provider]
+  end
+  send(options[:subcommand], options)
+end
+
+
+# The create subcommand
+def create(options)
+  tm = TaskMapper.new(options[:provider], options[:authentication])
+  ticket = tm.ticket.create(options[:ticket_attributes].merge({:project_id => options[:project]}))
+  read_ticket ticket
+  exit
+end
+
+# The read subcommand
+def read(options)
+  tm = TaskMapper.new(options[:provider], options[:authentication])
+  project = tm.project(options[:project])
+  ticket = project.ticket(options[:ticket])
+  read_ticket ticket
+  exit
+end
+
+# The update subcommand
+def update(options)
+  tm = TaskMapper.new(options[:provider], options[:authentication])
+  project = tm.project(options[:project])
+  ticket = project.ticket(options[:ticket])
+  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 = TaskMapper.new(options[:provider], options[:authentication])
+  project = tm.project(options[:project])
+  ticket = project.ticket(options[:ticket])
+  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 = TaskMapper.new(options[:provider], options[:authentication])
+  project = tm.project(options[:project])
+  tickets = project.tickets(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

data/lib/taskmapper/cli/common.rb

@@ -0,0 +1,28 @@
+# Parses the configuration information and puts it into options
+def parse_config!(options)
+  config = YAML.load_file File.expand_path(options[:config])
+  provider = (options[:provider] ||= config['default'] || config.keys.first)
+  if provider and provider.length > 0
+    options[:project] ||= config[provider]['project']
+    options[:authentication] ||= config[provider]['authentication']
+  end
+  options
+end
+
+# A utility method used to separate name:value pairs
+def attributes_hash(kvlist)
+  require 'enumerator' if RUBY_VERSION < "1.8.7"
+  if kvlist.is_a?(String)
+    kvlist.split(',').inject({}) do |mem, kv|
+      key, value = kv.split(':')
+      mem[key] = value
+      mem
+    end
+  elsif kvlist.is_a?(Array)
+    mem = {}
+    kvlist.each_slice(2) do |k, v|
+      mem[k] = v
+    end
+    mem
+  end
+end

data/lib/taskmapper/cli/init.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'yaml'
+require File.dirname(__FILE__) + '/common.rb'
+
+
+commands ={ 'help' => 'Get the help text for a particular command',
+  'console' => 'Open up a taskmapper console session',
+  'config' => 'Setup and configure a taskmapper.yml file',
+  'ticket' => 'Work with tickets (create, edit, delete, etc)',
+  'project' => 'Work with projects (create, edit, delete, etc)',
+  'generate' => 'Generate skeleton library files for a new provider',
+  }
+
+
+
+helptext = lambda {
+  helpmsg = "\nAvailable commands:\n"
+  commands.sort.inject(helpmsg) { |mem, cmd| mem << "\t#{cmd.join("    \t")}\n" }
+  helpmsg << "\nSee 'tm help COMMAND' for more information on a specific command."
+  }
+  
+ARGV << '--help' if ARGV.length == 0
+
+options = {:original_argv => ARGV.dup}
+
+if File.exist?(options[:config] = File.expand_path('taskmapper.yml'))
+elsif File.exist?(options[:config] = File.expand_path('config/taskmapper.yml'))
+elsif ENV['TASKMAPPER_CONFIG'] and File.exist?(options[:config] = File.expand_path(ENV['TASKMAPPER_CONFIG']))
+else
+  options[:config] = File.expand_path('~/.taskmapper.yml')
+end
+
+begin
+  OptionParser.new do |opts|
+    opts.banner = 'Usage: tm [options] COMMAND [command_options]'
+    opts.separator ''
+    opts.separator 'Options:'
+    
+    opts.on('-c', '--config CONFIG', 'Use CONFIG as the configuration file. default: ~/.taskmapper.yml') do |c|
+      options[:config] = c
+    end
+  
+    opts.on('-p', '--provider PROVIDER', 'Specifies the provider') { |p| options[:provider] = p }
+    
+    opts.on('-A', '--authentication AUTH',
+      'Specifies authentication information, comma-separated list of name:value pairs.',
+      'Note: The whole list must be enclosed in quotes if there are any spaces.') do |a|
+      options[:authentication] = attributes_hash(a)
+    end
+    
+    opts.on('-P', '--project PROJECT', 'Specifies the working project') { |p| options[:project] = p }
+    
+    opts.separator ''
+    opts.separator 'Other options:'
+    
+    opts.on_tail('-h', '--help', 'Show this message') do
+      puts opts
+      puts helptext.call
+      exit
+    end
+  end.order!
+rescue OptionParser::MissingArgument => exception
+  puts "tm #{ARGV.join(' ')}\n\n"
+  puts "Error: An option was called that requires an argument, but was not given one"
+  puts exception.message
+end
+
+command = ARGV.shift
+if commands[command]
+  require File.dirname(__FILE__) + '/commands/' + command
+  send(command, options)
+else
+  puts "'#{command}' is not a taskmapper command\n\n", helptext.call
+  exit
+end