Class: BasecampAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/basecamp/basecamp.rb

Overview

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"

Defined Under Namespace

Classes: Account, Attachment, Category, Comment, Company, Connection, Message, People, Project, Record, Resource, TimeEntry, TodoItem, TodoList

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeBasecampAPI

Returns a new instance of BasecampAPI.


475
476
477
# File 'lib/basecamp/basecamp.rb', line 475

def initialize
  @use_xml = false
end

Class Attribute Details

.passwordObject (readonly)

Returns the value of attribute password


455
456
457
# File 'lib/basecamp/basecamp.rb', line 455

def password
  @password
end

.siteObject (readonly)

Returns the value of attribute site


455
456
457
# File 'lib/basecamp/basecamp.rb', line 455

def site
  @site
end

.use_sslObject (readonly)

Returns the value of attribute use_ssl


455
456
457
# File 'lib/basecamp/basecamp.rb', line 455

def use_ssl
  @use_ssl
end

.userObject (readonly)

Returns the value of attribute user


455
456
457
# File 'lib/basecamp/basecamp.rb', line 455

def user
  @user
end

Instance Attribute Details

#use_xmlObject

Returns the value of attribute use_xml


452
453
454
# File 'lib/basecamp/basecamp.rb', line 452

def use_xml
  @use_xml
end

Class Method Details

.connectionObject


470
471
472
# File 'lib/basecamp/basecamp.rb', line 470

def connection
  @connection || raise('No connection established')
end

.establish_connection!(site, user, password, use_ssl = false) ⇒ Object


457
458
459
460
461
462
463
464
465
466
467
468
# File 'lib/basecamp/basecamp.rb', line 457

def establish_connection!(site, user, password, use_ssl = false)
  @site     = site
  @user     = user
  @password = password
  @use_ssl  = use_ssl

  Resource.user = user
  Resource.password = password
  Resource.site = (use_ssl ? "https" : "http") + "://" + site

  @connection = Connection.new(self)
end

Instance Method Details

#complete_milestone(id) ⇒ Object

Complete the milestone with the given id


533
534
535
# File 'lib/basecamp/basecamp.rb', line 533

def complete_milestone(id)
  record "/milestones/complete/#{id}"
end

#create_milestone(project_id, data) ⇒ Object

Create a new milestone for the given project. data must be hash of the values to set, including title, deadline, responsible_party, and notify.


509
510
511
# File 'lib/basecamp/basecamp.rb', line 509

def create_milestone(project_id, data)
  create_milestones(project_id, [data]).first
end

#create_milestones(project_id, milestones) ⇒ Object

As #create_milestone, but can create multiple milestones in a single request. The milestones parameter must be an array of milestone values as described in #create_milestone.


516
517
518
# File 'lib/basecamp/basecamp.rb', line 516

def create_milestones(project_id, milestones)
  records "milestone", "/projects/#{project_id}/milestones/create", :milestone => milestones
end

#delete_milestone(id) ⇒ Object

Destroys the milestone with the given id.


528
529
530
# File 'lib/basecamp/basecamp.rb', line 528

def delete_milestone(id)
  record "/milestones/delete/#{id}"
end

#milestones(project_id, find = 'all') ⇒ Object

Returns a list of all milestones for the given project, optionally filtered by whether they are completed, late, or upcoming.


502
503
504
# File 'lib/basecamp/basecamp.rb', line 502

def milestones(project_id, find = 'all')
  records "milestone", "/projects/#{project_id}/milestones/list", :find => find
end

#people(company_id, project_id = nil) ⇒ Object

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.


485
486
487
488
489
# File 'lib/basecamp/basecamp.rb', line 485

def people(company_id, project_id=nil)
  url = project_id ? "/projects/#{project_id}" : ""
  url << "/contacts/people/#{company_id}"
  records "person", url
end

#person(id) ⇒ Object

Return information about the person with the given id


492
493
494
# File 'lib/basecamp/basecamp.rb', line 492

def person(id)
  record "/contacts/person/#{id}"
end

#uncomplete_milestone(id) ⇒ Object

Uncomplete the milestone with the given id


538
539
540
# File 'lib/basecamp/basecamp.rb', line 538

def uncomplete_milestone(id)
  record "/milestones/uncomplete/#{id}"
end

#update_milestone(id, data, move = false, move_off_weekends = false) ⇒ Object

Updates an existing milestone.


521
522
523
524
525
# File 'lib/basecamp/basecamp.rb', line 521

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