ticketmaster 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.md
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Hybrid Group
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# ticketmaster
+
+ticketmaster is a Gem which eases communication with various project and ticket management systems by providing a consistent Ruby API.
+
+ticketmaster let's you "remap" a system into the consistent ticketmaster API, easily. For instance the description of an issue/ticket, might be named **description** in one system, and **problem-description** somewhere else. Via ticketmaster, this would always be called **description**. The ticketmaster remaps makes it easy for you to integrate different kinds of ticket systems, into your own system. You don't have to take care of all the different kinds of systems, and their different APIs. ticketmaster handles all this *for* you, so you can focus on making your application awesome.
+
+## Installation
+
+ticketmaster is a Gem, so we can easily install it by using RubyGems:
+
+    gem install ticketmaster
+
+ticketmaster depends on [Hashie](http://github.com/intridea/hashie), which is an amazing library which makes converting objects to hashes, and the other way around, a joy. It should be installed automatically whenever installing ticketmaster.
+
+### Finding and installing a provider
+
+ticketmaster by itself won't do too much. You may want to install a provider, to retrieve a list of available providers issue the following command:
+
+    gem search ticketmaster
+
+You could then install for instance ticketmaster-unfuddle:
+
+    gem install ticketmaster-unfuddle
+
+## TODO
+
+* Find ticket by property
+* Load login information from local file
+
+## Usage
+
+**Note** Subject to change.
+
+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 with a user to a subdomain, and so we do:
+    unfuddle = TicketMaster.new(:unfuddle, {:username => "john", :password => "seekrit", :subdomain => "ticketmaster"})
+
+Now we can use our instance with the right settings, to find a project. Let's go ahead and grab "testproject":
+    project = unfuddle.project["testproject"]
+
+Which is a shortcut for:
+    project = unfuddle.project.find "testproject"
+
+Which is a shortcut for:
+    project = unfuddle.project.find :name => "testproject"
+
+Meaning you could also find a project by description or any other property, like this:
+    project = unfuddle.project.find :description => "Testproject's description"
+
+Let's create a ticket with our project instance, unfuddle requires these three properties in order to create a ticket:
+    project.ticket.create(:priority => 3, :summary => "Test", :description => "Hello World")
+
+Let's play with tickets. First we go ahead and grab ticket 22:
+    ticket = project.tickets(:id => 22)
+
+We're working on this ticket right now, so let's go ahead and change the status
+    ticket.status = :in_progress
+
+Other valid ticket statuses are:
+    :closed, :accepted, :resolved
+
+For the fun of it, we'll change the description as well, and then save the ticket.
+    ticket.description = "Changed description to something else!"
+    ticket.save
+
+The issue was solved, let's make it official by closing the ticket with the appropriate resolution:
+    ticket.close(:resolution => "fixed", :description => "Fixed issue by doing x")
+
+## Support
+
+Currently ticketmaster supports the following systems:
+
+### Unfuddle (Alpha)
+
+To use Unfuddle with ticketmaster, install it:
+    gem install ticketmaster-unfuddle
+
+Then simply require it, and you are good to use Unfuddle with ticketmaster!
+    require 'ticketmaster'
+    require 'ticketmaster-unfuddle'
+    unfuddle = TicketMaster.new(:unfuddle, {:username => "..", :password => "..", :subdomain => ".."})
+
+## Creating a provider
+Creating a provider consists of three steps:
+
+* Create the ticketmaster provider (a.k.a. the remap)
+* Release it to RubyGems
+* Send an email to sirup@sirupsen.dk telling me about the awesome provider you created so we can fit it onto the list!
+
+### Create the ticketmaster provider
+Almost all APIs are different. And so are their Ruby providers. ticketmaster attempts to create an universal API for all ticket and project management systems, and thus we need to map the functionality to the ticketmaster API. This is the providers job. It is the glue between ticketmaster, and the ticket management'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) depends on [Unfuddler](http://github.com/hybridgroup/unfuddler) in order to interact with the Unfuddle API. Look at it like this:
+
+**ticketmaster** -> **Provider** -> *(Ruby library)* -> **Site's API**
+
+Provider being the "glue" between the site's API and ticketmaster. Ruby library is "optional" (though higly recommended as mentioned), thus 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 would be [Unfuddler](http://github.com/hybridgroup/unfuddler).
+
+For now, look at [ticketmaster-unfuddle](http://github.com/hybridgroup/ticketmaster-unfuddle) as an example on how to create a provider. More detailed documentation on this matter will be available soon.
+
+### Release it
+It would be an advantage for everyone, if you would host your provider on Github. Afterwards, simply release it to RubyGems.org, the name of the provider Gem should follow this simple naming rule:
+
+    ticketmaster-<provider's name>
+
+For instance for a Github provider:
+
+    ticketmaster-github
+
+This makes it easy for people to install a provider, simply by issuing:
+
+    gem search ticketmaster
+
+They should be presented a nice list of all available providers.
+
+After releasing, throw me an email at sirup@sirupsen.dk telling me about your awesome provider, and I'll throw it on the list of supported systems!
+
+## Note on Patches/Pull Requests
+ 
+* 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
+  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.
+
+## Copyright
+
+Copyright (c) 2010 [Hybrid Group](http://hybridgroup.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ticketmaster"
+    gem.summary = %Q{Ticketmaster provides a universal API to trouble ticket and project management systems.}
+    gem.description = %Q{Ticketmaster provides a universal API to trouble ticket and project management systems.}
+    gem.email = "simon@hybridgroup.com"
+    gem.homepage = "http://ticketrb.com"
+    gem.authors = ["Sirupsen", "deadprogrammer"]
+    gem.add_dependency "hashie", ">= 0"
+    gem.add_development_dependency "shoulda", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ticketmaster #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/ticket

@@ -0,0 +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\""

data/lib/ticketmaster.rb

@@ -0,0 +1,22 @@
+%w{
+  rubygems
+  hashie
+}.each {|lib| require lib }
+
+%w{
+  project
+  ticket
+  authenticator
+}.each {|lib| require 'ticketmaster/' + lib }
+
+module TicketMasterMod
+  attr_reader :project, :client
+
+  def initialize(client, authentication = {})
+    @project = Project::Finder.new(client, authentication)
+  end
+end
+
+class TicketMaster
+  include TicketMasterMod
+end

data/lib/ticketmaster/authenticator.rb

@@ -0,0 +1,4 @@
+module TicketMasterMod
+  class Authenticator < Hashie::Mash
+  end
+end

data/lib/ticketmaster/project.rb

@@ -0,0 +1,82 @@
+module TicketMasterMod
+  class Project < Hashie::Mash
+    # Find a project, or find more projects. You can also retrieve an array of all
+    # projects by not specifying any query.
+    #
+    #     unfuddle = TicketMaster.new(:unfuddle, {:username => "..", :password => "..", :subdomain => ".."})
+    #     unfuddle.project.find("ticketmaster")
+    #         #=> TicketMasterMod::Project<#name = "ticketmaster", ..>
+    #     unfuddle.project.find
+    #         #=> [TicketMasterMod::Project<..>, TicketMasterMod::Project<..>, ..]
+    #
+    def self.find(query = nil, options = {})
+      # Asks the client for the projects, should return an array of
+      # project objects.
+      projects = TicketMasterMod.const_get(options[:client].to_s.capitalize)::Project.find(query, options)
+      
+      if query
+        query = {:name => query} if query.is_a?(String)
+
+        # For some reason #tickets find ability messes up if we use a class method.
+        # Thus I decided to go for an instance method.
+        return Project.new.search(query, projects)
+      end
+
+      # No query, so we just go ahead and return the array of projects
+      projects
+    end
+
+    # Asks the client for the tickets associated with the project,
+    # returns an array of Ticket objects.
+    #
+    #     project.tickets
+    #         #=> [TicketMasterMod::Ticket<...>, TicketMasterMod::Ticket<...>, ..]
+    def tickets(query = {})
+      tickets = TicketMasterMod.const_get(self.system.capitalize)::Project.tickets(self)
+      return search(query, tickets) unless query.empty?
+
+      tickets
+    end
+
+    # Mainly here because it is more natural to do:
+    #     project.ticket.create(..)
+    #
+    # Than
+    #     project.tickets.create(..)
+    def ticket
+      TicketMasterMod::Ticket::Creator.new(self)
+    end
+
+    def search(query, objects)
+      matching_objects = []
+
+      objects.each do |object|
+        matches = 0
+        query.each do |query, expected_value|
+          matches += 1 if object.send(query) == expected_value
+        end
+
+        matching_objects << object if matches == query.length
+      end
+
+      # Raw object versus array with one entry
+      return matching_objects.first if matching_objects.length == 1
+      matching_objects
+    end
+
+    class Finder
+      def initialize(client, authentication)
+        @client = client
+        @authentication = Authenticator.new(authentication)
+      end
+
+      def find(query = nil, options = {})
+        options[:authentication] = @authentication
+        options[:client] = @client
+        Project::find(query, options)
+      end
+
+      alias_method :[], :find
+    end
+  end
+end

data/lib/ticketmaster/ticket.rb

@@ -0,0 +1,27 @@
+module TicketMasterMod
+  class Ticket < Hashie::Mash
+    def create
+      TicketMasterMod.const_get((self.system || self.project.system).to_s.capitalize)::Ticket.create(self)
+    end
+
+    def close(resolution = {})
+      TicketMasterMod.const_get(self.system.to_s.capitalize)::Ticket.close(self, resolution)
+    end
+
+    def save
+      TicketMasterMod.const_get(self.system.to_s.capitalize)::Ticket.save(self)
+    end
+
+    class Creator
+      def initialize(system)
+        @system = {:project => system}
+      end
+
+      def create(ticket_hash)
+        ticket_hash.merge!(@system)
+        ticket = TicketMasterMod::Ticket.new(ticket_hash)
+        ticket.create
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ticketmaster'
+
+class Test::Unit::TestCase
+end

data/test/test_ticketmaster.rb

@@ -0,0 +1,4 @@
+require 'helper'
+
+class TestTicketmaster < Test::Unit::TestCase
+end

data/test/test_unfuddler.rb

@@ -0,0 +1,75 @@
+require 'helper'
+require 'ticketmaster-unfuddle'
+
+class TestTicketmaster < Test::Unit::TestCase
+  context "Unfuddle" do
+    setup do
+      @unfuddle = TicketMaster.new(:unfuddle, {:username => "", :password => "", :subdomain => "ticketmaster"})
+      @project = @unfuddle.project.find.first
+    end
+
+    should "find testproject" do
+      project = @unfuddle.project.find(:name => "testproject")
+
+      assert_instance_of TicketMasterMod::Project, project
+      assert_equal "testproject", project.name
+
+      #method 2
+      project = @unfuddle.project.find("testproject")
+
+      assert_instance_of TicketMasterMod::Project, project
+      assert_equal "testproject", project.name
+
+      #method 3
+      project = @unfuddle.project["testproject"]
+
+      assert_instance_of TicketMasterMod::Project, project
+      assert_equal "testproject", project.name
+    end
+
+    context "project instance" do
+      should "find a project" do
+        assert_instance_of TicketMasterMod::Project, @project
+      end
+    
+      should "find a bunch of tickets" do
+        @project.tickets
+      end
+
+      should "find new tickets" do
+        tickets = @project.tickets(:status => "new")
+
+        tickets.each do |ticket|
+          assert_equal "new", ticket.status
+        end
+      end
+
+      should "find ticket with id 1" do
+        ticket = @project.tickets(:id => 1)
+
+        assert_equal 1, ticket.id
+      end
+    
+      should "create a ticket" do
+        assert @project.ticket.create(:priority => 3, :summary => "Test", :description => "Hello World from TicketMaster::Unfuddle").empty?
+      end
+    
+      should "change ticket property" do
+        ticket = @project.tickets.last
+        ticket.description = "Edited description"
+        assert ticket.save.empty?
+    
+        ticket = @project.tickets.last
+        assert_equal "Edited description", ticket.description
+      end
+    
+      should "close the last ticket with a resolution" do
+        ticket = @project.tickets.last
+        assert ticket.close(:resolution => "fixed", :description => "Fixed issue").empty?
+    
+        ticket = @project.tickets.last
+        assert_equal "fixed", ticket.resolution
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: ticketmaster
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Sirupsen
+- deadprogrammer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-07 00:00:00 +02:00
+default_executable: ticket
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Ticketmaster provides a universal API to trouble ticket and project management systems.
+email: simon@hybridgroup.com
+executables: 
+- ticket
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/ticket
+- lib/ticketmaster.rb
+- lib/ticketmaster/authenticator.rb
+- lib/ticketmaster/project.rb
+- lib/ticketmaster/ticket.rb
+- test/helper.rb
+- test/test_ticketmaster.rb
+- test/test_unfuddler.rb
+has_rdoc: true
+homepage: http://ticketrb.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ticketmaster provides a universal API to trouble ticket and project management systems.
+test_files: 
+- test/test_unfuddler.rb
+- test/test_ticketmaster.rb
+- test/helper.rb