Giter VIP home page Giter VIP logo

basecamper's Introduction

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

basecamper's People

Contributors

carlosramireziii avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.