Skip to content
37 Signals Basecamp API Wrapper
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
features/support
lib
spec
.gitignore
.rvmrc
Gemfile
README.md
Rakefile
basecamper.gemspec

README.md

Basecamper

travis

Basecamper is a Ruby wrapper to the 37 Signals Basecamp API

Installation

Simply add the gem to your Gemfile

    gem 'basecamper'

Configuration

Add authentication configurations:

    Basecamper.configure do |config|
      config.token   = '123abc'
      config.domain  = 'dummy.basecamphq.com'
    end

Basecamper also enables one to authenticate with one's username and password:

    Basecamper.configure do |config|
      config.user      = '123abc'
      config.password  = 'secret'
    end

Authentication using OAuth is also supported:

    Basecamper.configure do |config|
      config.use_oauth  = true
      config.token      = 'abc123'
    end

Use SSL?

    Basecamper.configure {|c| c.use_ssl = true }

Usage

View account info:

    Basecamper.account

Return current user:

    Basecamper::Person.me

Basic operations:

    Basecamper::Project.all
    returns:  [#<Basecamper::Project:0x266e458 @attributes={"company"=>..}>]

    Basecamper::Project.first
    returns:  #<Basecamper::Project:0x266e458 @attributes={"company"=>..}>

Advanced queries:

    Basecamper::TodoList.all(:params => { :project_id => 1234 })
    Basecamper::TodoList.find(:all, :params => { :project_id => 1234, :responsible_party => 9124 })

Child assocations:

    project = Basecamper::Project.find(123)
    project.messages

Parent associations:

    message = Basecamper::Message.find(123)
    message.project

Credits

Something went wrong with that request. Please try again.