turingstudio-basecamp-rb 0.0.1 → 0.0.2

data/Rakefile

@@ -0,0 +1,21 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/basecamp/version'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('basecamp-rb', Basecamp::VERSION) do |p|
+  p.developer('The Turing Studio, Inc.', 'support@turingstudio.com')
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [
+    ['xml-simple','>= 1.0.11'],
+    ['activesupport','>= 2.2.2'],
+    ['activeresource','>= 2.2.2']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/basecamp/attachment.rb

@@ -1,28 +1,20 @@
+# === Attaching Files to a Resource
+#
+# If the resource accepts file attachments, the +attachments+ parameter should
+# be an array of Basecamp::Attachment objects. Example:
+#
+#   a1 = Basecamp::Atachment.create('primary', File.read('primary.doc'))
+#   a2 = Basecamp::Atachment.create('another', File.read('another.doc'))
+#
+#   m = Basecamp::Message.new(:project_id => 1037)
+#   ...
+#   m.attachments = [a1, a2]
+#   m.save # => true
+#
 module Basecamp
-  class Attachment
-
-     # === Attaching Files to a Resource
-     #
-     # If the resource accepts file attachments, the +attachments+ parameter should
-     # be an array of Basecamp::Attachment objects. Example:
-     #
-     #   a1 = Basecamp::Atachment.create('primary', File.read('primary.doc'))
-     #   a2 = Basecamp::Atachment.create('another', File.read('another.doc'))
-     #
-     #   m = Basecamp::Message.new(:project_id => 1037)
-     #   ...
-     #   m.attachments = [a1, a2]
-     #   m.save # => true
-     #
-       
+  class Attachment       
      attr_accessor :id, :filename, :content, :content_type
-
-     def self.create(filename, content)
-       returning new(filename, content) do |attachment|
-         attachment.save
-       end
-     end
-
+     
      def initialize(filename, content, content_type = 'application/octet-stream')
        @filename, @content, @content_type = filename, content, content_type
      end
@@ -49,5 +41,13 @@ module Basecamp
          raise "Could not save attachment: #{response.message} (#{response.code})"
        end
      end
+     
+     class << self
+       def create(filename, content)
+         returning new(filename, content) do |attachment|
+           attachment.save
+         end
+       end
+     end
   end
 end

data/lib/basecamp/attachment_category.rb

@@ -0,0 +1,10 @@
+module Basecamp
+  class AttachmentCategory < Record
+    class << self
+      # Returns the list of file categories for the given project
+      def list(project_id)
+        records "/projects/#{project_id}/attachment_categories"
+      end
+    end
+  end
+end

data/lib/basecamp/base.rb

@@ -26,128 +26,24 @@ module Basecamp
       @use_xml = false
     end
 
-    # ==========================================================================
-    # GENERAL
-    # ==========================================================================
-
-    # Return the list of all accessible projects
-    def projects
-      records "project", "/project/list"
-    end
-
-    # Returns the list of message categories for the given project
-    def message_categories(project_id)
-      records "post-category", "/projects/#{project_id}/post_categories"
-    end
-
-    # Returns the list of file categories for the given project
-    def file_categories(project_id)
-      records "attachment-category", "/projects/#{project_id}/attachment_categories"
-    end
-
-    # ==========================================================================
-    # CONTACT MANAGEMENT
-    # ==========================================================================
-
-    # Return information for the company with the given id
-    def company(id)
-      record "/contacts/company/#{id}"
-    end
-
-    # Return an array of the people in the given company. If the project-id is
-    # given, only people who have access to the given project will be returned.
-    def people(company_id, project_id=nil)
-      url = project_id ? "/projects/#{project_id}" : ""
-      url << "/contacts/people/#{company_id}"
-      records "person", url
-    end
-
-    # Return information about the person with the given id
-    def person(id)
-      record "/contacts/person/#{id}"
-    end
-
-    # ==========================================================================
-    # MILESTONES
-    # ==========================================================================
-
-    # Complete the milestone with the given id
-    def complete_milestone(id)
-      record "/milestones/complete/#{id}"
-    end
-
-    # Create a new milestone for the given project. +data+ must be hash of the
-    # values to set, including +title+, +deadline+, +responsible_party+, and
-    # +notify+.
-    def create_milestone(project_id, data)
-      create_milestones(project_id, [data]).first
-    end
-
-    # As #create_milestone, but can create multiple milestones in a single
-    # request. The +milestones+ parameter must be an array of milestone values as
-    # descrbed in #create_milestone.
-    def create_milestones(project_id, milestones)
-      records "milestone", "/projects/#{project_id}/milestones/create", :milestone => milestones
-    end
-
-    # Destroys the milestone with the given id.
-    def delete_milestone(id)
-      record "/milestones/delete/#{id}"
-    end
-
-    # Returns a list of all milestones for the given project, optionally filtered
-    # by whether they are completed, late, or upcoming.
-    def milestones(project_id, find="all")
-      records "milestone", "/projects/#{project_id}/milestones/list", :find => find
-    end
-
-    # Uncomplete the milestone with the given id
-    def uncomplete_milestone(id)
-      record "/milestones/uncomplete/#{id}"
-    end
-
-    # Updates an existing milestone.
-    def update_milestone(id, data, move=false, move_off_weekends=false)
-      record "/milestones/update/#{id}", :milestone => data,
-      :move_upcoming_milestones => move,
-        :move_upcoming_milestones_off_weekends => move_off_weekends
-    end
-
-    private
-
     # Make a raw web-service request to Basecamp. This will return a Hash of
     # Arrays of the response, and may seem a little odd to the uninitiated.
     def request(path, parameters = {})
       response = Base.connection.post(path, convert_body(parameters), "Content-Type" => content_type)
-
+      
       if response.code.to_i / 100 == 2
         result = XmlSimple.xml_in(response.body, 'keeproot' => true, 'contentkey' => '__content__', 'forcecontent' => true)
-        typecast_value(result)
+        typecast_value(result)        
       else
         raise "#{response.message} (#{response.code})"
       end
     end
 
-    # A convenience method for wrapping the result of a query in a Record
-    # object. This assumes that the result is a singleton, not a collection.
-    def record(path, parameters={})
-      result = request(path, parameters)
-      (result && !result.empty?) ? Record.new(result.keys.first, result.values.first) : nil
-    end
-
-    # A convenience method for wrapping the result of a query in Record
-    # objects. This assumes that the result is a collection--any singleton
-    # result will be wrapped in an array.
-    def records(node, path, parameters={})
-      result = request(path, parameters).values.first or return []
-      result = result[node] or return []
-      result = [result] unless Array === result
-      result.map { |row| Record.new(node, row) }
-    end
-
+    private
+    
     def convert_body(body)
       body = use_xml ? body.to_legacy_xml : body.to_yaml
-    end
+    end                  
 
     def content_type
       use_xml ? "application/xml" : "application/x-yaml"

data/lib/basecamp/company.rb

@@ -0,0 +1,10 @@
+module Basecamp
+  class Company < Record
+    class << self
+      def find(id)
+        # Return information for the company with the given id      
+        record "/contacts/company/#{id}"
+      end
+    end
+  end
+end

data/lib/basecamp/message.rb

@@ -3,30 +3,32 @@ module Basecamp
     parent_resources :project
     self.element_name = 'post'
 
-    # Returns the most recent 25 messages in the given project (and category,
-    # if specified). If you need to retrieve older messages, use the archive
-    # method instead. Example:
-    #
-    #   Basecamp::Message.list(1037)
-    #   Basecamp::Message.list(1037, :category_id => 7301)
-    #
-    def self.list(project_id, options = {})
-      find(:all, :params => options.merge(:project_id => project_id))
-    end
-
-    # Returns a summary of all messages in the given project (and category, if
-    # specified). The summary is simply the title and category of the message,
-    # as well as the number of attachments (if any). Example:
-    #
-    #   Basecamp::Message.archive(1037)
-    #   Basecamp::Message.archive(1037, :category_id => 7301)
-    #
-    def self.archive(project_id, options = {})
-      find(:all, :params => options.merge(:project_id => project_id), :from => :archive)
-    end
-
     def comments(options = {})
       @comments ||= Comment.find(:all, :params => options.merge(:post_id => id))
     end
+    
+    class << self
+      # Returns the most recent 25 messages in the given project (and category,
+      # if specified). If you need to retrieve older messages, use the archive
+      # method instead. Example:
+      #
+      #   Basecamp::Message.list(1037)
+      #   Basecamp::Message.list(1037, :category_id => 7301)
+      #
+      def list(project_id, options = {})
+        find(:all, :params => options.merge(:project_id => project_id))
+      end
+
+      # Returns a summary of all messages in the given project (and category, if
+      # specified). The summary is simply the title and category of the message,
+      # as well as the number of attachments (if any). Example:
+      #
+      #   Basecamp::Message.archive(1037)
+      #   Basecamp::Message.archive(1037, :category_id => 7301)
+      #
+      def archive(project_id, options = {})
+        find(:all, :params => options.merge(:project_id => project_id), :from => :archive)
+      end
+    end
   end
 end

data/lib/basecamp/milestone.rb

@@ -0,0 +1,50 @@
+module Basecamp
+  class Milestone < Record
+    # Updates an existing milestone.
+    def update_attributes(params = {})
+      data = params.dup
+      move = data.delete :move
+      move_off_weekends = data.delete :move_off_weekends
+      record "/milestones/update/#{id}",
+        :milestone                             => data,
+        :move_upcoming_milestones              => move,
+        :move_upcoming_milestones_off_weekends => move_off_weekends 
+    end
+   
+    # Destroys the milestone
+    def destroy
+      record "/milestones/delete/#{id}"
+    end
+
+    # Complete the milestone 
+    def complete!
+      record "/milestones/complete/#{id}"
+    end 
+    
+    # Uncomplete the milestone
+    def uncomplete!
+      record "/milestones/uncomplete/#{id}"
+    end
+
+    class << self
+      def list(project_id, find = "all")
+        records "/projects/#{project_id}/milestones/list", :find => find
+      end
+   
+      # Create a new milestone for the given project. +data+ must be hash of the
+      # values to set, including +title+, +deadline+, +responsible_party+, and
+      # +notify+.
+      def create(project_id, data = {})
+        create_milestones(project_id, [data]).first
+      end
+    
+
+      # As #create_milestone, but can create multiple milestones in a single
+      # request. The +milestones+ parameter must be an array of milestone values as
+      # descrbed in #create_milestone.
+      def create_milestones(project_id, milestones)
+        records "/projects/#{project_id}/milestones/create", :milestone => milestones
+      end
+    end
+  end
+end

data/lib/basecamp/person.rb

@@ -0,0 +1,18 @@
+module Basecamp
+  class Person < Record
+    class << self
+      # Return an array of the people in the given company. If the project-id is
+      # given, only people who have access to the given project will be returned.
+      def list(company_id, project_id = nil)
+        url = project_id ? "/projects/#{project_id}" : ""
+        url << "/contacts/people/#{company_id}"
+        records url
+      end
+
+      # Return information about the person with the given id
+      def find(id)
+        record "/contacts/person/#{id}"
+      end
+    end
+  end
+end

data/lib/basecamp/post_category.rb

@@ -0,0 +1,10 @@
+module Basecamp
+  class PostCategory < Record
+    class << self
+      # Returns the list of message categories for the given project
+      def list(project_id)        
+        records "/projects/#{project_id}/post_categories"
+      end
+    end
+  end
+end

data/lib/basecamp/project.rb

@@ -0,0 +1,22 @@
+module Basecamp
+  class Project < Record
+    class << self
+      # Return the list of all accessible projects
+      def list
+        records "/project/list" 
+      end
+    end
+    
+    # def messages(options = {})
+    #   Message.list(id, options)
+    # end
+    # 
+    # def message_archive(options = {})
+    #   @message_archive ||= Message.archive(id, options)
+    # end
+    # 
+    # def milestones(find="all")
+    #   Milestone.list(id, find)
+    # end
+  end
+end

data/lib/basecamp/record.rb

@@ -1,20 +1,22 @@
 module Basecamp
   class Record #:nodoc:
     attr_reader :type
-
-    def initialize(type, hash)
-      @type, @hash = type, hash
+    
+    def initialize(hash)
+      # type = self.class.to_s
+      @hash = hash
     end
 
     def [](name)
-      name = dashify(name)
+      name = name.to_s.dasherize
 
       case @hash[name]
       when Hash then
+        puts @hash[name].inspect
         @hash[name] = if (@hash[name].keys.length == 1 && @hash[name].values.first.is_a?(Array))
-          @hash[name].values.first.map { |v| Record.new(@hash[name].keys.first, v) }
+          @hash[name].values.first.map { |v| self.class.new_with_type(@hash[name].keys.first, v) }
         else
-          Record.new(name, @hash[name])
+          self.class.new_with_type(name, @hash[name])
         end
       else
         @hash[name]
@@ -30,7 +32,7 @@ module Basecamp
     end
 
     def respond_to?(sym)
-      super || @hash.has_key?(dashify(sym))
+      super || @hash.has_key?(sym.to_s.dasherize)
     end
 
     def method_missing(sym, *args)
@@ -42,17 +44,44 @@ module Basecamp
     end
 
     def to_s
-      "\#<Record(#{@type}) #{@hash.inspect[1..-2]}>"
+      "\#<Record(#{self.class}) #{@hash.inspect[1..-2]}>"
     end
 
     def inspect
       to_s
     end
 
-    private
-
-    def dashify(name)
-      name.to_s.tr("_", "-")
+    # A convenience method for wrapping the result of a query in a Record
+    # object. This assumes that the result is a singleton, not a collection.
+    def record(path, parameters = {})
+      self.class.record(path, parameters)
     end
-  end
+   
+    class << self
+      def new_with_type(type, hash)
+        "Basecamp::#{type.classify}".constantize.new(hash)
+      end
+      
+      def record(path, parameters = {})
+        result = Basecamp::Base.new.request(path, parameters)
+        (result && !result.empty?) ? new(result.values.first) : nil
+      end
+
+      # A convenience method for wrapping the result of a query in Record
+      # objects. This assumes that the result is a collection--any singleton
+      # result will be wrapped in an array.
+      def records(path, parameters = {})
+        result = Basecamp::Base.new.request(path, parameters)
+        node_singular = name.demodulize.underscore.dasherize
+        node_plural = node_singular.pluralize
+
+        # FIX: rename FileCategory class to AttachmentCategory
+        # node_plural = 'attachment-categories' if node_plural == 'file-categories'
+      
+        result = result[node_plural][node_singular] or return [] 
+        result = [result] unless Array === result
+        result.map { |row| new(row) }
+      end
+    end 
+  end  
 end

data/lib/basecamp/resource.rb

@@ -1,29 +1,29 @@
 module Basecamp
   class Resource < ActiveResource::Base #:nodoc:
+    def prefix_options
+      id ? {} : super
+    end
+
     class << self
       def parent_resources(*parents)
         @parent_resources = parents
       end
-
+      
       def element_name
         name.split(/::/).last.underscore
       end
-
+    
       def prefix_source
         @parent_resources.map { |resource| "/#{resource.to_s.pluralize}/:#{resource}_id/" }.join
       end
-
+      
       def prefix(options={})
         if options.any?
           options.map { |name, value| "/#{name.to_s.chomp('_id').pluralize}/#{value}/" }.join
         else
-          super
+          '/'
         end
-      end
-    end
-
-    def prefix_options
-      id ? {} : super
+      end  
     end
   end
 end

data/lib/basecamp/time_entry.rb

@@ -1,17 +1,19 @@
 module Basecamp
   class TimeEntry < Resource
     parent_resources :project, :todo_item
-
-    def self.all(project_id, page=0)
-      find(:all, :params => { :project_id => project_id, :page => page })
+    
+    def todo_item(options={})
+      @todo_item ||= todo_item_id && TodoItem.find(todo_item_id, options)
     end
+    
+    class << self
+      def all(project_id, page=0)
+        find(:all, :params => { :project_id => project_id, :page => page })
+      end
 
-    def self.report(options={})
-      find(:all, :from => :report, :params => options)
+      def report(options={})
+        find(:all, :from => :report, :params => options)
+      end
     end
-
-    def todo_item(options={})
-      @todo_item ||= todo_item_id && TodoItem.find(todo_item_id, options)
-    end    
   end
 end

data/lib/basecamp/todoitem.rb

@@ -1,23 +1,23 @@
 module Basecamp
   class TodoItem < Resource
     parent_resources :todo_list
-
+    
     def todo_list(options={})
-      @todo_list ||= TodoList.find(todo_list_id, options)
+      @todo_list ||= TodoList.find(self.todo_list_id, options)
     end
-
+    
     def time_entries(options={})
       @time_entries ||= TimeEntry.find(:all, :params => options.merge(:todo_item_id => id))
     end
-
+    
     def comments(options = {})
       @comments ||= Comment.find(:all, :params => options.merge(:todo_item_id => id))
     end
-
+    
     def complete!
       put(:complete)
     end
-
+    
     def uncomplete!
       put(:uncomplete)
     end

data/lib/basecamp/todolist.rb

@@ -1,22 +1,24 @@
 module Basecamp
   class TodoList < Resource
     parent_resources :project
-
-    # Returns all lists for a project. If complete is true, only completed lists
-    # are returned. If complete is false, only uncompleted lists are returned.
-    def self.all(project_id, complete=nil)
-      filter = case complete
-        when nil   then "all"
-        when true  then "finished"
-        when false then "pending"
-        else raise ArgumentError, "invalid value for `complete'"
-      end
-
-      find(:all, :params => { :project_id => project_id, :filter => filter })
-    end
-
+    
     def todo_items(options={})
       @todo_items ||= TodoItem.find(:all, :params => options.merge(:todo_list_id => id))
     end
+    
+    class << self
+      # Returns all lists for a project. If complete is true, only completed lists
+      # are returned. If complete is false, only uncompleted lists are returned.
+      def all(project_id, complete=nil)
+        filter = case complete
+          when nil   then "all"
+          when true  then "finished"
+          when false then "pending"
+          else raise ArgumentError, "invalid value for `complete'"
+        end
+
+        find(:all, :params => { :project_id => project_id, :filter => filter })
+      end
+    end
   end
 end

data/lib/basecamp/version.rb

@@ -1,3 +1,3 @@
 module Basecamp #:nodoc:
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/basecamp.rb

@@ -8,11 +8,17 @@ require 'activeresource'
 
 require 'basecamp/base'
 require 'basecamp/resource'
+require 'basecamp/record'
 require 'basecamp/attachment'
 require 'basecamp/comment'
+require 'basecamp/company'
 require 'basecamp/connection'
+require 'basecamp/file_category'
 require 'basecamp/message'
-require 'basecamp/record'
+require 'basecamp/milestone'
+require 'basecamp/project'
+require 'basecamp/person'
+require 'basecamp/post_category'
 require 'basecamp/time_entry'
 require 'basecamp/todoitem'
 require 'basecamp/todolist'

data/spec/lib/basecamp/attachment_category_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe Basecamp::AttachmentCategory do
+  before(:each) do
+    establish_connection
+  end
+  
+  it "should return the list of file categories for the given project" do
+    list = Basecamp::AttachmentCategory.list(TEST_PROJECT_ID)
+    list.should be_kind_of(Array)
+  end
+end