taskmapper 0.8.0

data/TODO

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

data/VERSION

@@ -0,0 +1 @@
+0.8.0

data/bin/tm

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# The 'taskmapper' gem was installed using rubygems
+# This file is the CLI application to use with 'taskmapper'
+
+require File.dirname(__FILE__) + '/../lib/taskmapper/cli/init.rb'
+

data/examples/tm_example.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'taskmapper'
+require 'taskmapper-lighthouse'
+
+# display list of projects
+tm = TaskMapper.new(:lighthouse)
+tm.projects.each {|project|
+  puts "#{project.id} - #{project.name}"
+}
+
+

data/examples/tm_example_2.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'taskmapper'
+require 'taskmapper-pivotal'
+
+# display list of tickets for last project
+tm = TaskMapper.new(:pivotal)
+project = tm.projects.last
+project.tickets.each {|ticket|
+  puts "#{ticket.id} - #{ticket.title}"
+}
+

data/examples/tm_example_3.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'taskmapper'
+require 'taskmapper-pivotal'
+require 'taskmapper-lighthouse'
+
+# copy all tickets and comments from pivotal tracker to new lighthouse project (the hard way)
+pivotal = TaskMapper.new(:pivotal)
+lighthouse = TaskMapper.new(:lighthouse)
+
+from = pivotal.project(97107)
+
+to = lighthouse.project!(:name => "Copy Test on #{Time.now}", 
+                          :description => "A copy test")
+
+from.tickets.each do |from_ticket|
+  to_ticket = to.ticket!({:title => pivotal_ticket.title, 
+                          :description => pivotal_ticket.description})
+  from_ticket.comments.each do |comment|
+    to_ticket.comment!(:body => comment.body)
+  end
+end

data/examples/tm_example_4.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'taskmapper'
+require 'taskmapper-pivotal'
+require 'taskmapper-lighthouse'
+
+# copy all tickets and comments from pivotal tracker to new lighthouse project (the easy way)
+pivotal = TaskMapper.new(:pivotal)
+lighthouse = TaskMapper.new(:lighthouse)
+
+from = pivotal.project(97107)
+to = lighthouse.project!(:name => "Copy Test on #{Time.now}", 
+                          :description => "A copy test")
+                          
+to.copy(from)
+
+puts "Copy finished."
+

data/lib/taskmapper.rb

@@ -0,0 +1,53 @@
+%w{
+  rubygems
+  hashie
+  active_resource
+}.each {|lib| require lib }
+
+class TaskMapper 
+end
+
+%w{
+  common
+  helper
+  project
+  ticket
+  comment
+  authenticator
+  provider
+  exception
+  dummy/dummy.rb
+  tester/tester.rb
+}.each {|lib| require File.dirname(__FILE__) + '/taskmapper/' + lib }
+
+
+# This is the TaskMapper class
+#
+class TaskMapper
+  attr_reader :provider, :symbol
+  attr_accessor :default_project
+  
+  # This initializes the TaskMapper instance and prepares the provider
+  # If called without any arguments, it conveniently tries searching for the information in
+  # ~/.taskmapper.yml
+  # See the documentation for more information on the format of that file.
+  #
+  # 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? or authentication.nil?
+      require 'yaml'
+      data = YAML.load_file File.expand_path(ENV['TASKMAPPER_CONFIG'] || '~/.taskmapper.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 TaskMapper::Provider.const_get(system.to_s.capitalize)
+    authorize authentication
+    @symbol = system.to_sym
+    @provider = TaskMapper::Provider.const_get(system.to_s.capitalize)
+  end
+  
+  # Providers should over-write this method
+  def authorize(authentication = {})
+    raise TaskMapper::Exception.new("This method must be reimplemented in the provider")
+  end
+end

data/lib/taskmapper/authenticator.rb

@@ -0,0 +1,2 @@
+class TaskMapper::Authenticator < Hashie::Mash
+end

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

@@ -0,0 +1,100 @@
+# 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 taskmapper options.') do
+        options[:subcommand] = 'add'
+      end
+      
+      opts.on('-e', '--edit', 'Edit an existing entry to the configuration file based on taskmapper 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_file = File.expand_path(options[:config])
+  config = if File.exists?(config_file)
+    YAML.load_file(config_file)
+    else
+    {}
+    end
+  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_file = File.expand_path(options[:config])
+  config = if File.exist?(config_file)
+    YAML.load_file(config_file)
+  else
+    {}
+  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 --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/taskmapper/cli/commands/console.rb

@@ -0,0 +1,35 @@
+# 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__) + '/../../../taskmapper.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['TASKMAPPER_CONFIG']=config
+  end
+  providers = !options[:provider].nil? ? [options[:provider]] : YAML.load_file(config).keys
+  providers.delete 'default'
+  require 'rubygems'
+  require 'taskmapper'
+  providers.inject(requires) do |mem, p|
+    begin
+      require "taskmapper-#{p}"
+      requires << "-r taskmapper-#{p} "
+    rescue Exception => exception
+      #puts exception
+      begin
+        require "#{p}"
+        requires << "-r #{p} "
+      rescue Exception => exception
+        warn "Could not require the '#{p}' provider. Is it installed?"
+      end
+    end
+  end
+  cmd << "#{irb_name} #{requires} --simple-prompt #{ARGV.join(' ')}"
+  exec cmd
+end

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

@@ -0,0 +1,112 @@
+# The generate command
+def generate(options)
+  if ARGV.length == 0
+    ARGV << '--help'
+  else
+    provider_name = ARGV.shift
+    if provider_name.start_with? '_'
+      options[:provider] = provider_name[1..-1]
+      options[:provider_dir] = options[:provider]
+    else
+      options[:provider] = provider_name
+      options[:provider_dir] = 'taskmapper-' + options[:provider]
+    end
+  end
+  options[:mkdir] = true
+  begin
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: tm generate PROVIDER_NAME [--lib-directory DIR] [--jeweler [jeweler_options]]'
+      opts.separator ''
+      opts.separator 'Options:'
+      
+      opts.on('-J', '--jeweler [JEWELER_OPTIONS]', 'Sets the working ticket') do |option|
+        options[:jeweler] = ARGV
+        options[:mkdir] = false
+      end
+      
+      opts.on('-L', '--lib-directory DIR', 'Put the skeleton files inside this directory', ' * This assumes the directory already exists') do |dir|
+        options[:lib] = dir
+        options[:mkdir] = false
+      end
+      
+      opts.separator ''
+      opts.separator 'Other options:'
+      
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+      opts.separator ''
+      opts.separator 'NOTE: taskmapper- will be prepended to your provider name'
+      opts.separator 'unless you set the first character as _ (it will be removed)'
+    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
+  rescue OptionParser::InvalidOption => exception
+    options[:jeweler] = exception.recover(ARGV)
+    options[:mkdir] = false
+  end
+  options[:lib] ||= options[:provider_dir] + '/lib/'
+  create_directories(options)
+  copy_skeleton(options)
+end
+
+# Copy over the skeleton files
+def copy_skeleton(options)
+  skeleton_path = File.dirname(__FILE__) + '/generate/'
+  provider = File.read(skeleton_path + 'provider.rb').gsub('yoursystem', options[:provider].downcase)
+  create_file(options, options[:provider_dir] + '.rb', provider)
+  skeleton_path << 'provider/'
+  provider = File.read(skeleton_path + 'provider.rb').gsub('Yoursystem', options[:provider].capitalize).gsub('yoursystem', options[:provider].downcase)
+  create_file(options, 'provider/' + options[:provider].downcase + '.rb', provider)
+  %w(project.rb ticket.rb comment.rb).each do |p|
+    provider = File.read(skeleton_path + p).gsub('Yoursystem', options[:provider].capitalize).gsub('yoursystem', options[:provider].downcase)
+    create_file(options, 'provider/' + p, provider)
+  end
+end
+
+# Create the directories so copy_skeleton can do its job
+def create_directories(options)
+  if options[:jeweler]
+    jeweler_options = options[:jeweler].inject('') do |mem, j|
+      j="'#{j}'" if j.include?(' ')
+      mem + j + ' '
+    end
+    puts "Running jeweler #{jeweler_options} #{options[:provider_dir]}"
+    puts `jeweler #{jeweler_options} #{options[:provider_dir]}`
+  elsif options[:mkdir]
+    begin 
+      Dir.mkdir(options[:provider_dir])
+      puts "\tcreate\t#{options[:provider_dir]}"
+    rescue Exception => e
+      puts "\t#{e.message}"
+    end
+    begin
+      Dir.mkdir(options[:lib])
+      puts "\tcreate\t#{options[:lib]}"
+    rescue Exception => e
+      puts "\t#{e.message}"
+    end
+  end
+  begin
+    Dir.mkdir(options[:lib] + '/provider')
+    puts "\tcreate\t#{options[:lib] + 'provider'}"
+  rescue Exception => e
+    puts "\t#{e.message}"
+  end
+end
+
+# Create files
+def create_file(options, filename, data)
+  file_path = options[:lib] + '/' + filename
+  if File.exist?(file_path) and File.size(file_path) > 0
+    puts "\texists with content...skipping\t#{filename}"
+    return false;
+  end
+  puts "\tcreate\t#{filename}"
+  f = File.open(file_path, 'a+')
+  f.write data
+  f.close
+end

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

@@ -0,0 +1,5 @@
+#require YOUR_PROVIDER_API
+
+%w{ yoursystem ticket project comment }.each do |f|
+  require File.dirname(__FILE__) + '/provider/' + f + '.rb';
+end

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

@@ -0,0 +1,14 @@
+module TaskMapper::Provider
+  module Yoursystem
+    # The comment class for taskmapper-yoursystem
+    #
+    # Do any mapping between TaskMapper and your system's comment model here
+    # versions of the ticket.
+    #
+    class Comment < TaskMapper::Provider::Base::Comment
+      #API = Yoursystem::Comment # The class to access the api's comments
+      # declare needed overloaded methods here
+      
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module TaskMapper::Provider
+  module Yoursystem
+    # Project class for taskmapper-yoursystem
+    #
+    #
+    class Project < TaskMapper::Provider::Base::Project
+      #API = Yoursystem::Project # The class to access the api's projects
+      # declare needed overloaded methods here
+      
+      
+      # copy from this.copy(that) copies that into this
+      def copy(project)
+        project.tickets.each do |ticket|
+          copy_ticket = self.ticket!(:title => ticket.title, :description => ticket.description)
+          ticket.comments.each do |comment|
+            copy_ticket.comment!(:body => comment.body)
+            sleep 1
+          end
+        end
+      end
+
+    end
+  end
+end
+
+

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

@@ -0,0 +1,25 @@
+module TaskMapper::Provider
+  # This is the Yoursystem Provider for taskmapper 
+  module Yoursystem
+    include TaskMapper::Provider::Base
+    #TICKET_API = Yoursystem::Ticket # The class to access the api's tickets
+    #PROJECT_API = Yoursystem::Project # The class to access the api's projects
+    
+    # This is for cases when you want to instantiate using TaskMapper::Provider::Yoursystem.new(auth)
+    def self.new(auth = {})
+      TaskMapper.new(:yoursystem, auth)
+    end
+    
+    # Providers must define an authorize method. This is used to initialize and set authentication
+    # parameters to access the API
+    def authorize(auth = {})
+      @authentication ||= TaskMapper::Authenticator.new(auth)
+      # Set authentication parameters for whatever you're using to access the API
+    end
+    
+    # declare needed overloaded methods here
+    
+  end
+end
+
+