vigetlabs-unfuzzle 0.1.1 → 0.1.2

data/README.rdoc

@@ -2,7 +2,7 @@
 
 == Description
 
-The Unfuzzle gem provides an interface to the Unfuddle JSON API
+The Unfuzzle gem provides an interface to the Unfuddle XML API
 
 == Installation
 
@@ -81,8 +81,28 @@ And can also be associated to a milestone for the project:
     ticket.description  # => "Wash my car"
     ticket.status       # => "closed"
 
+Unfuddle has additional associations for a ticket, including component, severity,
+and priority:
+
+    ticket.component      # => #<Unfuzzle::Component:0x12c5b54 ...>
+    ticket.component_name # => "User Accounts"
+    ticket.severity       # => #<Unfuzzle::Severity:0x12a357c ...>
+    ticket.severity_name  # => "Development"
+    ticket.priority       # => #<Unfuzzle::Priority:0x12811fc @id=3>
+    ticket.priority_name  # => "Normal"
+
 See the Ticket documentation for more information.
 
+== Updating
+
+Currently, only ticket updating is supported and only for a subset of the data:
+
+    ticket.title = 'This is a new title' # => "This is a new title"
+    ticket.update                        # => #<Unfuzzle::Response:0x1275280 ...>
+
+This will update the title of the ticket.  Other fields that can be updated include
+description and status. 
+
 == License
 
 Copyright (c) 2009 Patrick Reagan of Viget Labs (mailto:patrick.reagan@viget.com)

data/Rakefile

@@ -12,13 +12,13 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc         = true
   s.extra_rdoc_files = %w(README.rdoc)
   s.rdoc_options     = %w(--main README.rdoc)
-  s.summary          = "This gem provides an interface to the Unfuddle JSON API"
+  s.summary          = "This gem provides an interface to the Unfuddle XML API"
   s.author           = 'Patrick Reagan'
   s.email            = 'patrick.reagan@viget.com'
   s.homepage         = 'http://www.viget.com/extend'
   s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
   
-  s.add_dependency('json', '>= 1.1.6')
+  s.add_dependency('graft', '>= 0.1.1')
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/lib/unfuzzle.rb

@@ -4,13 +4,16 @@ require 'uri'
 require 'net/http'
 require 'json'
 require 'builder'
+require 'graft'
 
 require 'unfuzzle/request'
 require 'unfuzzle/response'
-require 'unfuzzle/model'
 require 'unfuzzle/project'
 require 'unfuzzle/milestone'
 require 'unfuzzle/ticket'
+require 'unfuzzle/severity'
+require 'unfuzzle/priority'
+require 'unfuzzle/component'
 
 # = Unfuzzle: A simple wrapper around the Unfuddle JSON API
 #
@@ -28,7 +31,15 @@ require 'unfuzzle/ticket'
 # 
 # From there, you can start accessing a list of projects:
 #
-#    Project.all
+#   >> Unfuzzle.projects
+#   => [#<Unfuzzle::Project:0x5f5c44 @id=1, @name="BlipCo", ...>, ... ]
+#
+# Or a specific project by its 'short name':
+#
+#   >> Unfuzzle.project('sample')
+#   => #<Unfuzzle::Project:0x123f888 @id=2, @name="Sample Project", ... >
+#
+# For more usage documentation, see README.doc.
 #
 module Unfuzzle
   

data/lib/unfuzzle/component.rb

@@ -0,0 +1,31 @@
+module Unfuzzle
+  
+  # = Component
+  #
+  # Represents a Component in an Unfuddle project.  These are user-configurable
+  # and are custom for each project you have.  Examples include 'Administration',
+  # 'User Registration', etc..  A component has the following attributes:
+  #
+  # [id] The unique id for this component
+  # [name] The name of this component (e.g User Registration)
+  # [created_at] The date/time that this component was created
+  # [updated_at] The date/time that this component was last updated
+  #
+  class Component
+    
+    include Graft::Model
+    
+    attribute :id, :type => :integer
+    attribute :name
+    attribute :project_id, :from => 'project-id', :type => :integer
+    attribute :created_at, :from => 'created-at', :type => :time
+    attribute :updated_at, :from => 'updated-at', :type => :time
+    
+    # Find a component by ID for a given project
+    def self.find_by_project_id_and_component_id(project_id, component_id)
+      response = Request.get("/projects/#{project_id}/components/#{component_id}")
+      new response.body
+    end
+    
+  end
+end

data/lib/unfuzzle/milestone.rb

@@ -6,28 +6,33 @@ module Unfuzzle
   #
   # [id] Unique identifier for this milestone
   # [name] Name of the milestone
-  #
+  # [archived] The archived status of this milestone (see Milestone#archived?)
+  # [due_on] The due date for this milestone
+  # [created_at] The date/time that this milestone was created
+  # [updated_at] The date/time that this milestone was last updated
+  # 
   class Milestone
 
-    include Unfuzzle::Model
+    include Graft::Model
 
-    attribute :id
-    attribute :project_id
-    attribute :archived
-    attribute :name, :from => :title
-    attribute :created_timestamp, :from => :created_at
-    attribute :updated_timestamp, :from => :updated_at
-    attribute :due_datestamp, :from => :due_on
+    attribute :id, :type => :integer
+    attribute :project_id, :from => 'project-id', :type => :integer
+    attribute :archived, :type => :boolean
+    attribute :name, :from => 'title'
+    attribute :created_at, :from => 'created-at', :type => :time
+    attribute :updated_at, :from => 'updated-at', :type => :time
+    attribute :due_on, :from => 'due-on', :type => :date
 
     # Return a list of all milestones for a given project
     def self.find_all_by_project_id(project_id)
       response = Request.get("/projects/#{project_id}/milestones")
-      response.data.map {|data| new(data) }
+      collection_from(response.body, 'milestones/milestone')
     end
 
+    # Find a milestone by ID for a given project
     def self.find_by_project_id_and_milestone_id(project_id, milestone_id)
       response = Request.get("/projects/#{project_id}/milestones/#{milestone_id}")
-      new response.data
+      new response.body
     end
 
     # Has this milestone been archived?
@@ -35,21 +40,7 @@ module Unfuzzle
       archived == true
     end
 
-    # The DateTime that this milestone was created
-    def created_at
-      DateTime.parse(created_timestamp)
-    end
-
-    # The DateTime that this milestone was last updated
-    def updated_at
-      DateTime.parse(updated_timestamp)
-    end
-
-    # The Date that this milestone is due
-    def due_on
-      Date.parse(due_datestamp) unless due_datestamp.nil?
-    end
-
+    # Does this milestone occur in the past?
     def past?
       due_on < Date.today
     end

data/lib/unfuzzle/priority.rb

@@ -0,0 +1,30 @@
+module Unfuzzle
+  
+  # = Priority
+  #
+  # Represents a priority for a ticket.
+  #
+  class Priority
+    
+    def initialize(id)
+      @id = id
+    end
+    
+    # The name of the priority based on the supplied ID
+    def name
+      mapping[@id]
+    end
+    
+    private
+    def mapping
+      {
+        5 => 'Highest',
+        4 => 'High',
+        3 => 'Normal',
+        2 => 'Low',
+        1 => 'Lowest'
+      }
+    end
+    
+  end
+end

data/lib/unfuzzle/project.rb

@@ -8,35 +8,38 @@ module Unfuzzle
   # [slug] The "short name" for this project
   # [name] The name of this project
   # [description] The description for the project
+  # [archived] The archived status of this project (see Project#archived?)
+  # [created_at] The date/time that this project was created
+  # [updated_at] The date/time that this project was last updated
   #
   class Project
     
-    include Unfuzzle::Model
+    include Graft::Model
     
-    attribute :id
-    attribute :slug, :from => :short_name
-    attribute :archived
-    attribute :name, :from => :title
+    attribute :id, :type => :integer
+    attribute :slug, :from => 'short-name'
+    attribute :archived, :type => :boolean
+    attribute :name, :from => 'title'
     attribute :description
-    attribute :created_timestamp, :from => :created_at
-    attribute :updated_timestamp, :from => :updated_at
+    attribute :created_at, :from => 'created-at', :type => :time
+    attribute :updated_at, :from => 'updated-at', :type => :time
 
     # Return a list of all projects to which the current user has access
     def self.all
       response = Request.get('/projects')
-      response.data.map {|data| new(data) }
+      collection_from(response.body, 'projects/project')
     end
     
     # Find a single project by its slug (short name)
     def self.find_by_slug(slug)
       response = Request.get("/projects/by_short_name/#{slug}")
-      new(response.data)
+      new(response.body)
     end
 
     # Find a single project by its ID
     def self.find_by_id(id)
       response = Request.get("/projects/#{id}")
-      new(response.data)
+      new(response.body)
     end
 
     # Has this project been archived?
@@ -44,16 +47,6 @@ module Unfuzzle
       archived == true
     end
     
-    # The DateTime that this project was created
-    def created_at
-      DateTime.parse(created_timestamp)
-    end
-    
-    # The DateTime that this project was last updated
-    def updated_at
-      DateTime.parse(updated_timestamp)
-    end
-
     # The collection of Milestones associated to this project
     def milestones
       Milestone.find_all_by_project_id(id)

data/lib/unfuzzle/request.rb

@@ -12,24 +12,20 @@ module Unfuzzle
       request.get
     end
     
+    # Send a PUT request with data and retrieve a Response
     def self.put(resource_path, payload)
-      request = new(resource_path, payload, :format => :xml)
+      request = new(resource_path, payload)
       request.put
     end
     
     # Create a new request for the given resource path
-    def initialize(resource_path, payload = nil, options = {})
+    def initialize(resource_path, payload = nil)
       @resource_path = resource_path
       @payload       = payload
-      @options       = options
-    end
-    
-    def request_format
-      (@options[:format] || 'json').to_s
     end
     
     def endpoint_uri  # :nodoc:
-      URI.parse("http://#{Unfuzzle.subdomain}.unfuddle.com/api/v1#{@resource_path}.#{request_format}")
+      URI.parse("http://#{Unfuzzle.subdomain}.unfuddle.com/api/v1#{@resource_path}.xml")
     end
 
     def client # :nodoc:
@@ -44,6 +40,7 @@ module Unfuzzle
       Response.new(client.request(request))
     end
 
+    # Send a PUT request to the configured endpoint
     def put
       request = Net::HTTP::Put.new(endpoint_uri.path)
       request.basic_auth Unfuzzle.username, Unfuzzle.password

data/lib/unfuzzle/response.rb

@@ -21,12 +21,5 @@ module Unfuzzle
       @http_response.body
     end
     
-    # Parsed JSON response body
-    def data
-      if !error?
-        @parsed_data ||= JSON.parse(body)
-      end
-    end
-    
   end
 end

data/lib/unfuzzle/severity.rb

@@ -0,0 +1,31 @@
+module Unfuzzle
+  
+  # = Severity
+  #
+  # Represents a Severity in an Unfuddle project.  These are user-configurable
+  # and are custom for each project you have.  Examples include 'Story',
+  # 'Defect', etc..  A severity has the following attributes:
+  #
+  # [id] The unique identifier for this severity
+  # [name] The name of this severity
+  # [created_at] The date/time that this severity was created
+  # [updated_at] The date/time that this severity was last updated
+  #
+  class Severity
+    
+    include Graft::Model
+    
+    attribute :id, :type => :integer
+    attribute :name
+    attribute :project_id, :from => 'project-id', :type => :integer
+    attribute :created_at, :from => 'created-at', :type => :time
+    attribute :updated_at, :from => 'updated-at', :type => :time
+    
+    # Find the severity by ID for a given project
+    def self.find_by_project_id_and_severity_id(project_id, severity_id)
+      response = Request.get("/projects/#{project_id}/severities/#{severity_id}")
+      new response.body
+    end
+    
+  end
+end

data/lib/unfuzzle/ticket.rb

@@ -10,56 +10,89 @@ module Unfuzzle
   # [title] The title of the ticket (short)
   # [description] The full description of the ticket
   # [status] The ticket's status (new / accepted / resolved / closed)
+  # [due_on] The due date for this ticket
+  # [created_at] The date/time that this ticket was created
+  # [updated_at] The date/time that this ticket was last updated
   #
   class Ticket
 
-    include Unfuzzle::Model
+    include Graft::Model
 
-    attribute :id
-    attribute :project_id
-    attribute :milestone_id
+    attribute :id, :type => :integer
+    attribute :project_id, :from => 'project-id', :type => :integer
+    attribute :milestone_id, :from => 'milestone-id', :type => :integer
+    attribute :component_id, :from => 'component-id', :type => :integer
+    attribute :priority_id, :from => 'priority', :type => :integer
     attribute :number
-    attribute :title, :from => :summary
+    attribute :title, :from => 'summary'
     attribute :description
-    attribute :due_datestamp, :from => :due_on
-    attribute :created_timestamp, :from => :created_at
-    attribute :updated_timestamp, :from => :updated_at
+    attribute :due_on, :from => 'due-on', :type => :date
+    attribute :created_at, :from => 'created-at', :type => :time
+    attribute :updated_at, :from => 'updated-at', :type => :time
+    attribute :severity_id, :from => 'severity-id', :type => :integer
     attribute :status
 
     # Return a list of all tickets for an individual project
     def self.find_all_by_project_id(project_id)
       response = Request.get("/projects/#{project_id}/tickets")
-      response.data.map {|data| new(data) }
+      collection_from(response.body, 'tickets/ticket')
     end
 
     # Return a list of all tickets for a given milestone as part of a project
     def self.find_all_by_project_id_and_milestone_id(project_id, milestone_id)
       response = Request.get("/projects/#{project_id}/milestones/#{milestone_id}/tickets")
-      response.data.map {|data| new(data) }
+      collection_from(response.body, 'tickets/ticket')
     end
 
-    # The DateTime that this milestone was created
-    def created_at
-      DateTime.parse(created_timestamp)
+    # The Milestone associated with this ticket
+    def milestone
+      Milestone.find_by_project_id_and_milestone_id(project_id, milestone_id)
     end
-
-    # The DateTime that this milestone was last updated
-    def updated_at
-      DateTime.parse(updated_timestamp)
+    
+    # The Severity associated with this ticket
+    def severity
+      Severity.find_by_project_id_and_severity_id(project_id, severity_id) unless severity_id.nil?
     end
-
-    # The Date that this milestone is due
-    def due_on
-      Date.parse(due_datestamp) unless due_datestamp.nil?
+    
+    def severity_name
+      severity.name unless severity.nil?
     end
-   
-    def milestone
-      Milestone.find_by_project_id_and_milestone_id(project_id, milestone_id)
+    
+    # The Priority associated with this ticket
+    def priority
+      Priority.new(priority_id)
+    end
+    
+    def priority_name
+      priority.name
+    end
+    
+    # The Component associated with this ticket
+    def component
+      Component.find_by_project_id_and_component_id(project_id, component_id) unless component_id.nil?
+    end
+    
+    def component_name
+      component.name unless component.nil?
+    end
+    
+    # Hash representation of this ticket's data (for updating)
+    def to_hash
+      {
+        'id'           => id,
+        'project_id'   => project_id,
+        'milestone_id' => milestone_id,
+        'number'       => number,
+        'summary'      => title,
+        'description'  => description,
+        'status'       => status
+      }
     end
     
+    # Update the ticket's data in unfuddle
     def update
       resource_path = "/projects/#{project_id}/tickets/#{id}"
-      Request.put(resource_path, self.to_xml)
+      Request.put(resource_path, self.to_xml('ticket'))
     end
 
   end