basecamp 0.0.6 → 0.0.7

data/README.rdoc

@@ -33,9 +33,19 @@ Include the system gems and require the library in your script
 == Establishing a Connection
 
 The first thing you need to do is establish a connection to Basecamp. This
-requires your Basecamp site address and your login credentials. Example:
+requires your Basecamp site address and your login credentials or API token.
 
-  Basecamp.establish_connection!('you.grouphub.com', 'username', 'password')
+=== Using username and password
+
+  Basecamp.establish_connection!('yoururl.basecamphq.com', 'username', 'password')
+
+=== Using API token (My Info -> Show your tokens)
+
+  Basecamp.establish_connection!('yoururl.basecamphq.com', 'APITOKEN', 'X')
+
+=== With a Basecamp account that use SSL (https://yoururl.basecamphq.com)
+
+  Basecamp.establish_connection!('yoururl.basecamphq.com', 'APITOKEN', 'X', true)
 
 This is the same whether you're accessing using the ActiveResource interface,
 or the legacy interface.
@@ -127,14 +137,19 @@ you want to delete. Example:
 If the resource accepts file attachments, the +attachments+ parameter should
 be an array of Basecamp::Attachment objects. Example:
 
-  a1 = Basecamp::Attachment.create('primary', File.read('primary.doc'))
-  a2 = Basecamp::Attachment.create('another', File.read('another.doc'))
+  f1 = File.open('primary.doc')
+  s1 = StringIO.new('a string')
+
+  a1 = Basecamp::Attachment.create('primary', f1)
+  a2 = Basecamp::Attachment.create('another', s1))
 
   m = Basecamp::Message.new(:project_id => 1037)
   ...
   m.attachments = [a1, a2]
   m.save # => true
 
+  f1.close
+
 === Milestones
 
 Is not implemented as an active resource, it uses the non-REST interface.
@@ -145,6 +160,24 @@ For example, to list all milestones in a project:
   milestones = Basecamp::Milestone.list(1037)
   milestones.first.title # => "The Milestone"
 
+=== More about Todo Items
+
+To access all todo items in a todo list:
+
+  Basecamp::TodoItem.find(:all, :params => { :todo_list_id => 3422 })
+
+You can't access all todo items in a project with a single API call.
+So you have to do something like this:
+
+  def todo_items_on_project(project_id)
+    todo_items = []
+    todo_lists = TodoList.find(:all, :params => { :project_id => project_id })
+    todo_lists.each do |todo_list|
+      todo_items += TodoItem.find(:all, :params => { :todo_list_id => todo_list.id })
+    end
+    todo_items
+  end
+
 = Using the non-REST interface
 
 You can access other resources not included in this wrapper yet using "record" and "records".
@@ -155,9 +188,17 @@ You can access other resources not included in this wrapper yet using "record" a
   people_in_company = Basecamp.records("person", "/contacts/people/85")
   people_in_company.first.first_name # => "Jason"
 
+= Using json as the default format
+
+By default the wrapper will use :xml for the active record connection but you can set :json as the default format:
+
+  Basecamp.establish_connection!('yoururl.basecamphq.com', 'APITOKEN', 'X', true, false)
+
+Note: We recommend using xml. There are some API calls that don't behave well with json.
+
 == Contributors
 
 * jamesarosen
 * defeated
 * justinbarry
-* fmiopensource
+* fmiopensource

data/lib/basecamp/base.rb

@@ -3,15 +3,17 @@ module Basecamp
     attr_accessor :use_xml
     attr_reader :site, :user, :password, :use_ssl
 
-    def establish_connection!(site, user, password, use_ssl = false)
+    def establish_connection!(site, user, password, use_ssl = false, use_xml = true)
       @site     = site
       @user     = user
       @password = password
       @use_ssl  = use_ssl
+      @use_xml  = use_xml
 
-      Resource.user = user
+      Resource.user     = user
       Resource.password = password
-      Resource.site = (use_ssl ? "https" : "http") + "://" + site
+      Resource.site     = (use_ssl ? "https" : "http") + "://" + site
+      Resource.format   = (use_xml ? :xml : :json)
 
       @connection = Connection.new(self)
     end

data/lib/basecamp/connection.rb

@@ -6,10 +6,12 @@ module Basecamp; class Connection
     @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE if master.use_ssl
   end
 
-  def post(path, body, headers = {})
+  def post(path, iostream, headers = {})
     request = Net::HTTP::Post.new(path, headers.merge('Accept' => 'application/xml'))
     request.basic_auth(@master.user, @master.password)
-    @connection.request(request, body)
+    request.body_stream = iostream
+    request.content_length = iostream.size
+    @connection.request(request)
   end
 
   def get(path, headers = {})
@@ -17,4 +19,4 @@ module Basecamp; class Connection
     request.basic_auth(@master.user, @master.password)
     @connection.request(request)
   end
-end; end
+end; end

data/lib/basecamp/resource.rb

@@ -16,6 +16,9 @@ module Basecamp; class Resource < ActiveResource::Base
       end
     end
 
+    def check_prefix_options(options)
+    end
+
     def prefix(options = {})
       if options.any?
         options.map { |name, value| "/#{name.to_s.chomp('_id').pluralize}/#{value}" }.join + '/'
@@ -23,9 +26,21 @@ module Basecamp; class Resource < ActiveResource::Base
         '/'
       end
     end
+
+    def all(options = {})
+      find(:all, options)
+    end
+
+    def first(options = {})
+      find(:first, options)
+    end
+
+    def last(options = {})
+      find(:last, options)
+    end
   end
 
   def prefix_options
     id ? {} : super
   end
-end; end
+end; end

data/lib/basecamp/resources/attachment.rb

@@ -1,5 +1,5 @@
 module Basecamp; class Attachment
-  attr_accessor :id, :filename, :content
+  attr_accessor :id, :filename, :content, :category_id
 
   def self.create(filename, content)
     returning new(filename, content) do |attachment|
@@ -16,7 +16,7 @@ module Basecamp; class Attachment
   end
 
   def to_xml(options = {})
-    { :file => attributes }.to_xml(options)
+    { :file => attributes, :category_id => category_id }.to_xml(options)
   end
 
   def inspect

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: basecamp
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Anibal Cucco
@@ -16,12 +16,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-12 00:00:00 -03:00
+date: 2011-11-23 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: oauth2
   prerelease: false
-  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -31,11 +31,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: oauth2
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
+  name: xml-simple
   prerelease: false
-  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -45,11 +45,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: xml-simple
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  name: activeresource
   prerelease: false
-  type: :runtime
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -61,11 +61,11 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
-  name: activeresource
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  type: :development
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -75,11 +75,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rake
+  type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
+  name: mg
   prerelease: false
-  type: :development
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -91,11 +91,11 @@ dependencies:
         - 0
         - 8
         version: 0.0.8
-  name: mg
+  type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  type: :development
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -107,11 +107,11 @@ dependencies:
         - 3
         - 0
         version: 1.3.0
-  name: rspec
+  type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
+  name: webmock
   prerelease: false
-  type: :development
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -123,7 +123,7 @@ dependencies:
         - 2
         - 2
         version: 1.2.2
-  name: webmock
+  type: :development
   version_requirements: *id007
 description: Basecamp API wrapper.
 email: nobody@gmail.com