confuddle 0.0.1

data/lib/unfuzzle/lib/unfuzzle/comment.rb

@@ -0,0 +1,37 @@
+module Unfuzzle
+
+  #
+  class Comment
+
+    include Graft
+
+    attribute :id 
+    attribute :created_at
+    attribute :body
+    attribute :author_id, :from => "author-id", :type => :integer
+    
+    # Hash representation of this ticket's data (for updating)
+    def to_hash
+      {
+        'id'           => id,
+        'body'         => body,
+        'author-id'    => author_id
+      }
+    end
+    
+    # Return a list of all tickets for an individual project
+    def self.all_by_project_and_ticket(project_id, ticket_id)
+      response = Request.get("/projects/{id}/tickets/{id}/comments")
+      collection_from(response.body, 'comments/comment')
+    end
+    
+    # Create a comment
+    def create(project_id, ticket_id)
+      resource_path = "/projects/#{project_id}/tickets/#{ticket_id}/comments"
+      Request.post(resource_path, self.to_xml('comment'))
+    end
+    
+  end
+end
+  
+  

data/lib/unfuzzle/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
+    
+    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/lib/unfuzzle/milestone.rb

@@ -0,0 +1,54 @@
+module Unfuzzle
+
+  # = Milestone
+  #
+  # A representation of an Unfuddle Milestone.  Has the following attributes:
+  #
+  # [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 Graft
+
+    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")
+      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.body
+    end
+
+    # Has this milestone been archived?
+    def archived?
+      archived == true
+    end
+
+    # Does this milestone occur in the past?
+    def past?
+      due_on < Date.today
+    end
+
+    # The collection of Tickets associated to this milestone
+    def tickets
+      Ticket.find_all_by_project_id_and_milestone_id(project_id, id)
+    end
+
+  end
+end

data/lib/unfuzzle/lib/unfuzzle/person.rb

@@ -0,0 +1,20 @@
+module Unfuzzle
+  class Person
+    include Graft
+    attribute :id, :type => :integer
+    attribute :first_name, :from => 'first-name'
+    attribute :last_name, :from => 'last-name'
+    attribute :username, :from => 'username'
+
+    def self.all
+      response = Request.get("/people")
+      collection_from(response.body, 'people/person')
+    end
+
+    def self.all_for_project(project_id)
+      response = Request.get("/projects/#{project_id}/people")
+      collection_from(response.body, 'people/person')
+    end
+
+  end
+end

data/lib/unfuzzle/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/lib/unfuzzle/project.rb

@@ -0,0 +1,62 @@
+module Unfuzzle
+  
+  # = Project
+  #
+  # Represents an Unfuddle project.  Has the following attributes:
+  #
+  # [id] The unique identifier for this project
+  # [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 Graft
+    
+    attribute :id, :type => :integer
+    attribute :slug, :from => 'short-name'
+    attribute :archived, :type => :boolean
+    attribute :name, :from => 'title'
+    attribute :description
+    attribute :created_at, :from => 'created-at', :type => :time
+    attribute :updated_at, :from => 'updated-at', :type => :time
+    attribute :disk_usage, :from => 'disk-usage'
+
+    # Return a list of all projects to which the current user has access
+    def self.all
+      response = Request.get('/projects')
+      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.body)
+    end
+
+    # Find a single project by its ID
+    def self.find_by_id(id)
+      response = Request.get("/projects/#{id}")
+      new(response.body)
+    end
+
+    # Has this project been archived?
+    def archived?
+      archived == true
+    end
+    
+    # The collection of Milestones associated to this project
+    def milestones
+      Milestone.find_all_by_project_id(id)
+    end
+
+    # The collection of Tickets associated to this project
+    def tickets
+      Ticket.find_all_by_project_id(id)
+    end
+
+  end
+end

data/lib/unfuzzle/lib/unfuzzle/request.rb

@@ -0,0 +1,75 @@
+module Unfuzzle
+  
+  # = Request
+  #
+  # A basic wrapper for GET requests to the Unfuddle API
+  #
+  class Request 
+
+    # Retrieve a response from the given resource path
+    def self.get(resource_path, query = nil)
+      request = new(resource_path, nil, query)
+      request.get
+    end
+
+    # Send a POST request with data and retrieve a Response
+    def self.post(resource_path, payload)
+      request = new(resource_path, payload)
+      request.post
+    end
+    
+    # Send a PUT request with data and retrieve a Response
+    def self.put(resource_path, payload)
+      request = new(resource_path, payload)
+      request.put
+    end
+    
+    # Create a new request for the given resource path
+    def initialize(resource_path, payload = nil, query = nil)
+      @resource_path = resource_path
+      @payload       = payload
+      @query = query
+    end
+    
+    def endpoint_uri  # :nodoc:
+      url = "https://#{Unfuzzle.subdomain}.unfuddle.com/api/v1#{@resource_path}.xml"
+      url += @query if @query
+      URI.parse(url)
+    end
+
+    def client # :nodoc:
+      http = Net::HTTP.new(endpoint_uri.host, endpoint_uri.port)
+      if Unfuzzle.use_ssl
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      http
+    end
+
+    # Retrieve a response from the current resource path    
+    def get
+      request = Net::HTTP::Get.new(endpoint_uri.request_uri)
+      request.basic_auth Unfuzzle.username, Unfuzzle.password
+      Response.new(client.request(request))
+    end
+
+    # Send a POST request to the configured endpoint
+    def post
+      request = Net::HTTP::Post.new(endpoint_uri.request_uri)
+      request.basic_auth Unfuzzle.username, Unfuzzle.password
+      request.content_type = 'application/xml'
+
+      Response.new(client.request(request, @payload))
+    end
+
+    # Send a PUT request to the configured endpoint
+    def put
+      request = Net::HTTP::Put.new(endpoint_uri.request_uri)
+      request.basic_auth Unfuzzle.username, Unfuzzle.password
+      request.content_type = 'application/xml'
+      
+      Response.new(client.request(request, @payload))
+    end
+    
+  end
+end

data/lib/unfuzzle/lib/unfuzzle/response.rb

@@ -0,0 +1,25 @@
+module Unfuzzle
+  
+  # = Response
+  #
+  # A simple wrapper around an HTTP response from the Unfuddle API
+  #
+  class Response
+    
+    # Create a new response from an HTTP response object
+    def initialize(http_response)
+      @http_response = http_response
+    end
+    
+    # Was there an error produced as part of the request?
+    def error?
+      !@http_response.is_a?(Net::HTTPSuccess)
+    end
+    
+    # Raw body of the HTTP response
+    def body
+      @http_response.body
+    end
+    
+  end
+end

data/lib/unfuzzle/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
+    
+    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/lib/unfuzzle/ticket.rb

@@ -0,0 +1,156 @@
+module Unfuzzle
+
+  # = Ticket
+  #
+  # Represents a single Unfuddle Ticket - is associated to a project
+  # and optionally a project's milestone.  Has the following attributes:
+  #
+  # [id] The unique identifier for this ticket
+  # [number] The ticket's number - this is displayed in the web interface
+  # [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 Graft
+
+    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, :type => :integer
+    attribute :number, :type => :integer
+    attribute :title, :from => 'summary'
+    attribute :description
+    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 :assignee_id, :from => 'assignee-id', :type => :integer
+    attribute :reporter_id, :from => 'reporter-id', :type => :integer
+    attribute :status
+    attribute :hours, :from => 'hours-estimate-current'
+    
+    
+    def initialize(*args)
+      self.priority = 3
+      self.status = "new"
+      super(*args)
+    end
+
+    # 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")
+      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")
+      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_first_by_project_id_and_number(project_id, number)
+      response = Request.get("/projects/#{project_id}/tickets/by_number/#{number}")
+      new(response.body)
+    end
+    
+    # Return a list of all tickets for a given milestone as part of a project
+    def self.find_first_by_project_id_and_number_with_comments(project_id, number)
+      response = Request.get("/projects/#{project_id}/tickets/by_number/#{number}", "?comments=true")
+      [new(response.body), Comment.collection_from(response.body, 'comments/comment')]
+    end
+
+    
+    def self.find_all_by_project_and_report(project_id, report_id)
+      response = Request.get("/projects/#{project_id}/ticket_reports/#{report_id}/generate")
+      collection_from(response.body, 'tickets/ticket')
+    end
+
+
+    def self.all_by_dinamic_report(with_project_ids = nil, only_my_tickets = false)
+      query = "?title=Dynamic&conditions_string=status-neq-closed"
+      query += ",assignee-eq-current" if only_my_tickets
+      query += "&fields_string=id,number,title,hours,assignee,status,reporter"
+
+      res = []
+
+      if with_project_ids.blank?
+        response = Request.get("/ticket_reports/dynamic", query)
+        res = collection_from(response.body, 'tickets/ticket')
+      else
+        with_project_ids.each do |id|
+          response = Request.get("/projects/#{id}/ticket_reports/dynamic", query)
+          res << collection_from(response.body, 'tickets/ticket')
+        end
+      end
+
+      res.flatten
+    end
+
+   
+    # The Milestone associated with this ticket
+    def milestone
+      Milestone.find_by_project_id_and_milestone_id(project_id, milestone_id)
+    end
+    
+    # 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
+    
+    def severity_name
+      severity.name unless severity.nil?
+    end
+    
+    def priority_name
+      # priority.name
+      Priority.new(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,
+        'priority'     => priority,
+        'severity-id'  => severity_id,
+        'number'       => number,
+        'summary'      => title,
+        'description'  => description,
+        'status'       => status,
+        'assignee-id'  => assignee_id,
+        'reporter-id'  => reporter_id#,
+        #'hours'        => hours
+      }
+    end
+    
+    # Update the ticket's data in unfuddle
+    def update
+      resource_path = "/projects/#{project_id}/tickets/#{id}"
+      Request.put(resource_path, self.to_xml('ticket'))
+    end
+    
+    # Create a ticket in unfuddle
+    def create
+      resource_path = "/projects/#{project_id}/tickets"
+      Request.post(resource_path, self.to_xml('ticket'))
+    end
+
+  end
+end