basecamp 0.0.2 → 0.0.3

data/README.rdoc

@@ -0,0 +1,134 @@
+= A Ruby library for working with the Basecamp web-services API.
+
+For more information about the Basecamp web-services API, visit:
+
+  http://developer.37signals.com/basecamp
+
+You can find the original code in:
+
+  http://developer.37signals.com/basecamp/basecamp.rb
+
+NOTE: not all of Basecamp's web-services are accessible via REST. This
+library provides access to RESTful services via ActiveResource. Services not
+yet upgraded to REST are accessed via the Basecamp class. Continue reading
+for more details.
+
+== Installation
+
+  gem install basecamp
+
+== 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:
+
+  Basecamp.establish_connection!('you.grouphub.com', 'username', 'password')
+
+This is the same whether you're accessing using the ActiveResource interface,
+or the legacy interface.
+
+== Getting API token
+
+If you only have username/password you can get the API token to use in future calls.
+
+  Basecamp.establish_connection!('you.grouphub.com', 'username', 'password')
+  Basecamp.get_token
+
+== Using the REST interface via ActiveResource
+
+The REST interface is accessed via ActiveResource, a popular Ruby library
+that implements object-relational mapping for REST web-services. For more
+information on working with ActiveResource, see:
+
+ * http://api.rubyonrails.org/files/activeresource/README.html
+ * http://api.rubyonrails.org/classes/ActiveResource/Base.html
+
+
+=== Finding a Resource
+
+Find a specific resource using the +find+ method. Attributes of the resource
+are available as instance methods on the resulting object. For example, to
+find a message with the ID of 8675309 and access its title attribute, you
+would do the following:
+
+  m = Basecamp::Message.find(8675309)
+  m.title # => 'Jenny'
+
+To find all messages for a given project, use find(:all), passing the
+project_id as a parameter to find. Example:
+
+  messages = Basecamp::Message.find(:all, params => { :project_id => 1037 })
+  messages.size # => 25
+
+
+=== Creating a Resource
+
+Create a resource by making a new instance of that resource, setting its
+attributes, and saving it. If the resource requires a prefix to identify
+it (as is the case with resources that belong to a sub-resource, such as a
+project), it should be specified when instantiating the object. Examples:
+
+  m = Basecamp::Message.new(:project_id => 1037)
+  m.category_id = 7301
+  m.title = 'Message in a bottle'
+  m.body = 'Another lonely day, with no one here but me'
+  m.save # => true
+
+  c = Basecamp::Comment.new(:post_id => 25874)
+  c.body = 'Did you get those TPS reports?'
+  c.save # => true
+
+You can also create a resource using the +create+ method, which will create
+and save it in one step. Example:
+
+  Basecamp::TodoItem.create(:todo_list_id => 3422, :contents => 'Do it')
+
+
+=== Updating a Resource
+
+To update a resource, first find it by its id, change its attributes, and
+save it. Example:
+
+  m = Basecamp::Message.find(8675309)
+  m.body = 'Changed'
+  m.save # => true
+
+
+=== Deleting a Resource
+
+To delete a resource, use the +delete+ method with the ID of the resource
+you want to delete. Example:
+
+  Basecamp::Message.delete(1037)
+
+
+=== 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::Attachment.create('primary', File.read('primary.doc'))
+  a2 = Basecamp::Attachment.create('another', File.read('another.doc'))
+
+  m = Basecamp::Message.new(:project_id => 1037)
+  ...
+  m.attachments = [a1, a2]
+  m.save # => true
+
+
+= Using the non-REST inteface
+
+The non-REST interface is accessed via instance methods on the Basecamp
+class. Ensure you've established a connection, then create a new Basecamp
+instance and call methods on it. Object attributes are accessible as methods.
+Example:
+
+  session = Basecamp.new
+  person = session.person(93832) # => #<Record(person)..>
+  person.first_name # => "Jason"
+
+== Contributors
+
+* jamesarosen
+* defeated
+* justinbarry

data/lib/basecamp.rb

@@ -3,151 +3,7 @@ require 'yaml'
 require 'date'
 require 'time'
 
-begin
-  require 'xmlsimple'
-rescue LoadError
-  begin
-    require 'rubygems'
-    require 'xmlsimple'
-  rescue LoadError
-    abort <<-ERROR
-The 'xml-simple' library could not be loaded. If you have RubyGems installed
-you can install xml-simple by doing "gem install xml-simple".
-ERROR
-  end
-end
-
-begin
-  require 'activeresource'
-rescue LoadError
-  begin
-    require 'rubygems'
-    require 'activeresource'
-  rescue LoadError
-    abort <<-ERROR
-The 'activeresource' library could not be loaded. If you have RubyGems 
-installed you can install ActiveResource by doing "gem install activeresource".
-ERROR
-  end
-end
-
-# = A Ruby library for working with the Basecamp web-services API.
-#
-# For more information about the Basecamp web-services API, visit:
-#
-#   http://developer.37signals.com/basecamp
-#
-# NOTE: not all of Basecamp's web-services are accessible via REST. This
-# library provides access to RESTful services via ActiveResource. Services not
-# yet upgraded to REST are accessed via the Basecamp class. Continue reading
-# for more details.
-#
-#
-# == 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:
-#
-#   Basecamp.establish_connection!('you.grouphub.com', 'username', 'password')
-#
-# This is the same whether you're accessing using the ActiveResource interface,
-# or the legacy interface.
-#
-#
-# == Using the REST interface via ActiveResource
-#
-# The REST interface is accessed via ActiveResource, a popular Ruby library
-# that implements object-relational mapping for REST web-services. For more
-# information on working with ActiveResource, see:
-#
-#  * http://api.rubyonrails.org/files/activeresource/README.html
-#  * http://api.rubyonrails.org/classes/ActiveResource/Base.html
-#
-#
-# === Finding a Resource
-#
-# Find a specific resource using the +find+ method. Attributes of the resource
-# are available as instance methods on the resulting object. For example, to
-# find a message with the ID of 8675309 and access its title attribute, you
-# would do the following:
-#
-#   m = Basecamp::Message.find(8675309)
-#   m.title # => 'Jenny'
-#
-# To find all messages for a given project, use find(:all), passing the
-# project_id as a parameter to find. Example:
-#
-#   messages = Basecamp::Message.find(:all, params => { :project_id => 1037 })
-#   messages.size # => 25
-#
-#
-# === Creating a Resource
-#
-# Create a resource by making a new instance of that resource, setting its
-# attributes, and saving it. If the resource requires a prefix to identify
-# it (as is the case with resources that belong to a sub-resource, such as a
-# project), it should be specified when instantiating the object. Examples:
-#
-#   m = Basecamp::Message.new(:project_id => 1037)
-#   m.category_id = 7301
-#   m.title = 'Message in a bottle'
-#   m.body = 'Another lonely day, with no one here but me'
-#   m.save # => true
-#
-#   c = Basecamp::Comment.new(:post_id => 25874)
-#   c.body = 'Did you get those TPS reports?'
-#   c.save # => true
-#
-# You can also create a resource using the +create+ method, which will create
-# and save it in one step. Example:
-#
-#   Basecamp::TodoItem.create(:todo_list_id => 3422, :contents => 'Do it')
-#
-#
-# === Updating a Resource
-#
-# To update a resource, first find it by its id, change its attributes, and
-# save it. Example:
-#
-#   m = Basecamp::Message.find(8675309)
-#   m.body = 'Changed'
-#   m.save # => true
-#
-#
-# === Deleting a Resource
-#
-# To delete a resource, use the +delete+ method with the ID of the resource
-# you want to delete. Example:
-#
-#   Basecamp::Message.delete(1037)
-#
-#
-# === 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::Attachment.create('primary', File.read('primary.doc'))
-#   a2 = Basecamp::Attachment.create('another', File.read('another.doc'))
-#
-#   m = Basecamp::Message.new(:project_id => 1037)
-#   ...
-#   m.attachments = [a1, a2]
-#   m.save # => true
-#
-#
-# = Using the non-REST inteface
-#
-# The non-REST interface is accessed via instance methods on the Basecamp
-# class. Ensure you've established a connection, then create a new Basecamp
-# instance and call methods on it. Object attributes are accessible as methods.
-# Example:
-#
-#   session = Basecamp.new
-#   person = session.person(93832) # => #<Record(person)..>
-#   person.first_name # => "Jason"
-#
-class Basecamp
+module Basecamp
   class Connection #:nodoc:
     def initialize(master)
       @master = master
@@ -202,6 +58,9 @@ class Basecamp
   end
 
   class Project < Resource
+    def time_entries(options = {})
+      @time_entries ||= TimeEntry.find(:all, :params => options.merge(:project_id => id))
+    end
   end
 
   class Company < Resource

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: basecamp
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Anibal Cucco
@@ -16,12 +16,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-15 00:00:00 -04:00
+date: 2011-05-10 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: 
@@ -33,11 +33,11 @@ dependencies:
         - 0
         - 8
         version: 0.0.8
-  type: :runtime
+  name: oauth2
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
+  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -47,12 +47,40 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  name: xml-simple
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: mg
   prerelease: false
+  type: :runtime
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activerecord
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rake
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,12 +91,12 @@ dependencies:
         - 0
         - 8
         version: 0.0.8
-  type: :development
-  version_requirements: *id003
+  name: mg
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -79,12 +107,12 @@ dependencies:
         - 3
         - 0
         version: 1.3.0
-  type: :development
-  version_requirements: *id004
+  name: rspec
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -95,8 +123,8 @@ dependencies:
         - 2
         - 2
         version: 1.2.2
-  type: :development
-  version_requirements: *id005
+  name: webmock
+  version_requirements: *id007
 description: Basecamp API wrapper.
 email: nobody@gmail.com
 executables: []
@@ -107,7 +135,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/basecamp.rb
-- readme
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/anibalcucco/basecamp-wrapper
 licenses: []
@@ -138,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Basecamp API wrapper.

data/readme

@@ -1,13 +0,0 @@
-= Using the Basecamp API with Ruby
-
-This is the basecamp wrapper provided by 37Signals to access their API with a little change to obtain the API token.
-
-This is useful when you only have username/password and you want to obtain the token automatically to use that in future calls.
-
-= Usage
-
->> Basecamp.establish_connection!('<subdomain>.basecamphq.com', <username>, <password>, true)
->> Basecamp.get_token
-=> "the token"
-
--- Anibal Cucco