ticketmaster 0.0.0 → 0.0.1

data/README.md

@@ -22,49 +22,91 @@ 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.
+**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 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":
+### Grabbing a project
+
+Now that we've got out ticketmaster instance, let's go ahead and grab "testproject":
+
     project = unfuddle.project["testproject"]
+        #=> TicketMaster::Project<#name="testproject"..>
+
+*Project#[]* is an alias to *Project#find*:
 
-Which is a shortcut for:
     project = unfuddle.project.find "testproject"
+        #=> TicketMaster::Project<#name="testproject"..>
+
+Which translates into:
 
-Which is a shortcut for:
     project = unfuddle.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:
 
-Meaning you could also find a project by description or any other property, like this:
-    project = unfuddle.project.find :description => "Testproject's description"
+    project = unfuddle.project.find :owner => "Sirupsen"
+        #=> TicketMaster::Project<#owner="sirupsen"..>
+
+To retrieve all projects, simply pass no argument to find:
+
+    project = unfuddle.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:
 
-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:
+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.
+
+### Finding tickets
+
+Alright, let's play with the projects tickets! Here we grab the ticket with the id of 22:
+
     ticket = project.tickets(:id => 22)
+        #=> TicketMaster::Ticket<#id=22..>
+
+Like with projects, we can also find tickets by other attributes, like title, priority and so on, with tickets we do not use a find method though. Also as with projects, if no argument is passed, all tickets are retrieved:
+
+    tickets = project.tickets
+        #=> [TicketMaster::Ticket<#..>,TicketMaster::Ticket<#..>,..]
+
+### Changing ticket attributes
+
+Let's say that we're working on this ticket right now, so let's go ahead and change the status to reflect that:
 
-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:
+Other valid ticket statuses include:
+
     :closed, :accepted, :resolved
 
-For the fun of it, we'll change the description as well, and then save the ticket.
+For the sake of example, 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:
+### Closing a ticket
+
+The issue was solved, let's make that official by closing the ticket with the appropriate resolution:
+
     ticket.close(:resolution => "fixed", :description => "Fixed issue by doing x")
 
+Note that you could close the ticket by changing all the attributes manually, like so:
+
+    ticket.status = :closed
+    ticket.resolution = "fixed"
+    ticket.resolution_description = "Fixed issue by doing x"
+    ticket.save
+
+However, as closing a ticket with a resolution is such a common task, the other method is included because it may be more convenient.
+
 ## Support
 
 Currently ticketmaster supports the following systems:
@@ -75,44 +117,43 @@ 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:
+Creating a provider consists of two 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:
+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:
 
 **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.
+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.
 
-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).
+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).
 
-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.
+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.
 
 ### 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:
+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:
+For instance if you set for a Github provider, it would be named:
 
     ticketmaster-github
 
-This makes it easy for people to install a provider, simply by issuing:
-
-    gem search ticketmaster
+This makes it easy for people to find providers, simply by issuing:
 
-They should be presented a nice list of all available providers.
+    gem search -r ticketmaster
 
-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!
+They should be presented with a nice list of all available providers.
 
 ## Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/lib/ticketmaster/project.rb

@@ -52,8 +52,8 @@ module TicketMasterMod
 
       objects.each do |object|
         matches = 0
-        query.each do |query, expected_value|
-          matches += 1 if object.send(query) == expected_value
+        query.each_pair do |method, expected_value|
+          matches += 1 if object.send(method) == expected_value
         end
 
         matching_objects << object if matches == query.length

data/test/test_unfuddler.rb

@@ -49,7 +49,7 @@ class TestTicketmaster < Test::Unit::TestCase
 
         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

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ticketmaster
 version: !ruby/object:Gem::Version 
-  hash: 31
   prerelease: false
   segments: 
   - 0
   - 0
-  - 0
-  version: 0.0.0
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Sirupsen
@@ -16,18 +15,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-07 00:00:00 +02:00
+date: 2010-06-12 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"
@@ -37,11 +34,9 @@ dependencies:
   name: shoulda
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -81,27 +76,23 @@ rdoc_options:
 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
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ticketmaster provides a universal API to trouble ticket and project management systems.