Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 822 Bytes

README.rdoc

File metadata and controls

36 lines (21 loc) · 822 Bytes

Beanstalk API Wrapper

Official Ruby gem for accessing Beanstalk RESTful API. Basically a set of pre-written ActiveResource classes with a few adjustments.

api.beanstalkapp.com

Installation

gem install beanstalkapp

Requirements

ActiveResource 2.3.5

Usage

First enable API access in your Beanstalk account by going to Account > Setup. Only the account owner can do that.

Then in your code setup the API like that:

Beanstalk::API::Base.setup(
  :domain   => 'your_beanstalk_subdomain',
  :login    => 'login',
  :password => '12345'
)

Then you can start using the API:

Beanstalk::API::Account.find

For information about all API methods please go to the official documentation site:

api.beanstalkapp.com

Copyright © 2011 Ilya Sabanin, Wildbit. Released under the MIT license