ticketmaster 0.3.10 → 0.4.0

data/README.md

@@ -18,52 +18,52 @@ ticketmaster by itself won't do too much. You may want to install a provider, to
 
     gem search ticketmaster
 
-You could then install for instance ticketmaster-unfuddle:
+You could then install for instance ticketmaster-pivotal:
 
-    gem install ticketmaster-unfuddle
+    gem install ticketmaster-pivotal
 
 ## Usage
 
 **Note:** The API may change, and the following may not be the final. Please keep yourself updated before you upgrade.
 
-First, we instance a new class with the right set of options. In this example, we are authenticating with Unfuddle. As Unfuddle is a closed system, it is *required* that you authenticate to a subdomain:
+First, we instance a new class with the right set of options. In this example, we are authenticating with Pivotal Tracker.
 
-    unfuddle = TicketMaster.new(:unfuddle, {:username => "john", :password => "seekrit", :subdomain => "ticketmaster"})
+    pivotal = TicketMaster.new(:pivotal, {:username => "john", :password => "seekrit"})
 
 ### Grabbing a project
 
 Now that we've got out ticketmaster instance, let's go ahead and grab "testproject":
 
-    project = unfuddle.project["testproject"]
+    project = pivotal.project["testproject"]
         #=> TicketMaster::Project<#name="testproject"..>
 
 *Project#[]* is an alias to *Project#find*:
 
-    project = unfuddle.project.find "testproject"
+    project = pivotal.project.find "testproject"
         #=> TicketMaster::Project<#name="testproject"..>
 
 Which translates into:
 
-    project = unfuddle.project.find :name => "testproject"
+    project = pivotal.project.find :name => "testproject"
         #=> TicketMaster::Project<#name="testproject"..>
 
 That means you can actually look up a project by something else than the title, like the owner:
 
-    project = unfuddle.project.find :owner => "Sirupsen"
+    project = pivotal.project.find :owner => "Sirupsen"
         #=> TicketMaster::Project<#owner="sirupsen"..>
 
 To retrieve all projects, simply pass no argument to find:
 
-    project = unfuddle.project.find
+    project = pivotal.project.find
         #=> [TicketMaster::Project<#..>,TicketMaster::Project<#..>,..]
 
 ### Creating a ticket
 
 Now that we grabbed the right project. Let's go ahead and create a ticket at this project:
 
-    project.ticket.create(:priority => 3, :summary => "Test", :description => "Hello World")
+    project.ticket.create(:summary => "Test", :description => "Hello World")
 
-We create our ticket with three properties, the only one which may seem unfamiliar is the priority one, however, this attribute is required by Unfuddle.
+We create our ticket with three properties.
 
 ### Finding tickets
 
@@ -111,7 +111,33 @@ However, as closing a ticket with a resolution is such a common task, the other
 
 Currently ticketmaster supports the following systems:
 
-### Unfuddle (Alpha)
+### Pivotal Tracker
+
+To use Pivotal Tracker with ticketmaster, install it:
+    gem install ticketmaster-pivotal
+
+Then simply require it, and you are good to use Pivotal Tracker with ticketmaster!
+
+    require 'ticketmaster'
+    require 'ticketmaster-pivotal'
+    unfuddle = TicketMaster.new(:pivotal, {:username => "..", :password => ".."})
+
+The source code is located at [ticketmaster-pivotal](http://github.com/hybridgroup/ticketmaster-pivotal)
+
+### Lighthouse
+
+To use Lighthouse with ticketmaster, install it:
+    gem install ticketmaster-lighthouse
+
+Then simply require it, and you are all set to use Lighthouse with ticketmaster!
+
+    require 'ticketmaster'
+    require 'ticketmaster-lighthouse'
+    lighthouse = TicketMaster.new(:lighthouse, {:username => "..", :password => ".."})
+
+The source code is located at [ticketmaster-lighthouse](http://github.com/hybridgroup/ticketmaster-lighthouse)
+
+### Unfuddle (Alpha, needs compatibility update)
 
 To use Unfuddle with ticketmaster, install it:
     gem install ticketmaster-unfuddle
@@ -122,23 +148,26 @@ Then simply require it, and you are good to use Unfuddle with ticketmaster!
     require 'ticketmaster-unfuddle'
     unfuddle = TicketMaster.new(:unfuddle, {:username => "..", :password => "..", :subdomain => ".."})
 
+The source code is located at [ticketmaster-unfuddle](http://github.com/hybridgroup/ticketmaster-unfuddle)
+
 ## Creating a provider
-Creating a provider consists of two steps:
+Creating a provider consists of three steps:
 
-* Create the ticketmaster provider (a.k.a. the remap)
+* Create the ticketmaster provider (a.k.a. the remap) using the skeleton located at http://github.com/hybridgroup/ticketmaster-provider-skeleton
+* Implement whatever is needed to connect to your desired backend
 * Release it to RubyGems
 
 ### Create the ticketmaster provider
 Almost all APIs are different. And so are their Ruby providers. ticketmaster attempts to create an universal API for ticket and project management systems, and thus, we need to map the functionality to the ticketmaster API. This is the providers job. The provider is the glue between ticketmaster, and the ticket management system's API.
-Usually, your provider would rely on another library for the raw HTTP interaction. For instance, [ticketmaster-unfuddle](http://github.com/hybridgroup/ticketmaster-unfuddle) relies on [Unfuddler](http://github.com/hybridgroup/unfuddler) in order to interact with the Unfuddle API. Look at it like this:
+Usually, your provider would rely on another library for the raw HTTP interaction. For instance, [ticketmaster-lighthouse](http://github.com/hybridgroup/ticketmaster-lighthouse) relies on ActiveResource in order to interact with the Lighthouse API. Look at it like this:
 
 **ticketmaster** -> **Provider** -> *(Ruby library)* -> **Site's API**
 
-Provider being the *glue* between the site's API and ticketmaster. The Ruby library is "optional" (though higly recommended as mentioned), therefore it is in parantheses.
+Provider being the *glue* between the site's API and ticketmaster. The Ruby library is "optional" (though highly recommended as mentioned), therefore it is in parantheses.
 
-An example of a provider could be [ticketmaster-unfuddle](http://github.com/hybridgroup/ticketmaster-unfuddle), an example of a Ruby library could be [Unfuddler](http://github.com/hybridgroup/unfuddler).
+An example of a provider could be [ticketmaster-lighthouse](http://github.com/hybridgroup/ticketmaster-lighthouse), an example of a Ruby library could be ActiveResource.
 
-For now, look at [ticketmaster-unfuddle](http://github.com/hybridgroup/ticketmaster-unfuddle) as an example on how to create a provider. More detailed documentation will be available soon.
+For now, look at [ticketmaster-lighthouse](http://github.com/hybridgroup/ticketmaster-lighthouse) as an example on how to create a provider. More detailed documentation will be available soon.
 
 ### Release it
 Simply release it to RubyGems.org, the name of the provider Gem should follow this simple naming rule:
@@ -159,12 +188,12 @@ They should be presented with a nice list of all available providers.
  
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
+* Add tests for it. This is important so we don't break it in a
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+  (if you want to have your own version, that is fine but bump version in a commit by itself so we can ignore when we pull)
+* Send us a pull request. Bonus points for feature branches.
 
 ## Copyright
 
-Copyright (c) 2010 [Hybrid Group](http://hybridgroup.com). See LICENSE for details.
+Copyright (c) 2010 [The Hybrid Group](http://hybridgroup.com). See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.3.10
+0.4.0

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

@@ -0,0 +1,104 @@
+# The generate command
+def generate(options)
+  if ARGV.length == 0
+    ARGV << '--help'
+  else
+    options[:provider] = ARGV.shift
+    if options[:provider].first == '_'
+      options[:provider][0] = ''
+      options[:provider_dir] = options[:provider]
+    else
+      options[:provider_dir] = 'ticketmaster-' + 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] = [option] + 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: ticketmaster- 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
+  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]
+    puts "Running jeweler #{options[:provider_dir]} #{options[:jeweler].join(' ')}"
+    puts `jeweler #{options[:provider_dir]} #{options[:jeweler].join(' ')}`
+  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/ticketmaster/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/ticketmaster/cli/commands/generate/provider/comment.rb

@@ -0,0 +1,13 @@
+module TicketMaster::Provider
+  module Yoursystem
+    # The comment class for ticketmaster-yoursystem
+    #
+    # Do any mapping between Ticketmaster and your system's comment model here
+    # versions of the ticket.
+    #
+    class Comment < TicketMaster::Provider::Base::Comment
+      # declare needed overloaded methods here
+      
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module TicketMaster::Provider
+  module Yoursystem
+    # Project class for ticketmaster-yoursystem
+    #
+    #
+    class Project < TicketMaster::Provider::Base::Project
+      # 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/ticketmaster/cli/commands/generate/provider/provider.rb

@@ -0,0 +1,16 @@
+module TicketMaster::Provider
+  # This is the Yoursystem Provider for ticketmaster
+  module Yoursystem
+    include TicketMaster::Provider::Base
+    
+    # This is for cases when you want to instantiate using TicketMaster::Provider::Yoursystem.new(auth)
+    def self.new(auth = {})
+      TicketMaster.new(:yoursystem, auth)
+    end
+    
+    # declare needed overloaded methods here
+    
+  end
+end
+
+

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

@@ -0,0 +1,11 @@
+module TicketMaster::Provider
+  module Yoursystem
+    # Ticket class for ticketmaster-yoursystem
+    #
+    
+    class Ticket < TicketMaster::Provider::Base::Ticket
+      # declare needed overloaded methods here
+      
+    end
+  end
+end

data/lib/ticketmaster/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 'ticketmaster-' 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/ticketmaster/cli/init.rb

@@ -10,11 +10,14 @@ commands ={ 'help' => 'Get the help text for a particular command',
   'config' => 'Setup and configure a ticketmaster.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\t")}\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."
   }
   

data/ticketmaster.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ticketmaster}
-  s.version = "0.3.10"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["kiafaldorius", "Sirupsen", "deadprogrammer"]
-  s.date = %q{2010-07-15}
+  s.date = %q{2010-07-16}
   s.default_executable = %q{tm}
   s.description = %q{Ticketmaster provides a universal API to ticket tracking and project management systems.}
   s.email = %q{info@hybridgroup.com}
@@ -36,9 +36,16 @@ Gem::Specification.new do |s|
      "lib/ticketmaster/authenticator.rb",
      "lib/ticketmaster/cli/commands/config.rb",
      "lib/ticketmaster/cli/commands/console.rb",
+     "lib/ticketmaster/cli/commands/generate.rb",
+     "lib/ticketmaster/cli/commands/generate/provider.rb",
+     "lib/ticketmaster/cli/commands/generate/provider/comment.rb",
+     "lib/ticketmaster/cli/commands/generate/provider/project.rb",
+     "lib/ticketmaster/cli/commands/generate/provider/provider.rb",
+     "lib/ticketmaster/cli/commands/generate/provider/ticket.rb",
      "lib/ticketmaster/cli/commands/help.rb",
      "lib/ticketmaster/cli/commands/help/config",
      "lib/ticketmaster/cli/commands/help/console",
+     "lib/ticketmaster/cli/commands/help/generate",
      "lib/ticketmaster/cli/commands/help/help",
      "lib/ticketmaster/cli/commands/help/project",
      "lib/ticketmaster/cli/commands/help/ticket",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ticketmaster
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 10
-  version: 0.3.10
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - kiafaldorius
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-15 00:00:00 -07:00
+date: 2010-07-16 00:00:00 -07:00
 default_executable: tm
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -75,9 +75,16 @@ files:
 - lib/ticketmaster/authenticator.rb
 - lib/ticketmaster/cli/commands/config.rb
 - lib/ticketmaster/cli/commands/console.rb
+- lib/ticketmaster/cli/commands/generate.rb
+- lib/ticketmaster/cli/commands/generate/provider.rb
+- lib/ticketmaster/cli/commands/generate/provider/comment.rb
+- lib/ticketmaster/cli/commands/generate/provider/project.rb
+- lib/ticketmaster/cli/commands/generate/provider/provider.rb
+- lib/ticketmaster/cli/commands/generate/provider/ticket.rb
 - lib/ticketmaster/cli/commands/help.rb
 - lib/ticketmaster/cli/commands/help/config
 - lib/ticketmaster/cli/commands/help/console
+- lib/ticketmaster/cli/commands/help/generate
 - lib/ticketmaster/cli/commands/help/help
 - lib/ticketmaster/cli/commands/help/project
 - lib/ticketmaster/cli/commands/help/ticket