Ruby wrapper around BookingSync API v1
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
features/support
gemfiles
lib
spec
.document
.gitignore
.rspec
.travis.yml
.yardopts
Appraisals
Changelog.md
Gemfile
Gemfile.lock
Guardfile
LICENSE.txt
README.md
Rakefile
bookingsync.gemspec
cucumber.yml

README.md

BookingSync Build Status

What is it?

This gem provides a set of classes to access information on BookingSync via the published API:

Booking, Client, Rental and Inquiry.

All these classes are inherited from ActiveResouce::Base. You can refer to the ActiveResouce documentation for more information.

Installing

gem install bookingsync

or within a Rails 3 application

gem "bookingsync"

Dependencies

This gem depends on ActiveResource 3.x

Configure your key

require 'bookingsync'

BookingSync::Base.user = 'api-auth-token'

If you are using this in a Rails application, putting this code in a config/initializers/bookingsync.rb file is recommended. See config_initializers_bookingsync.rb in the examples/ directory.

Documentation

Further documentation can be found on rdoc.info.

Usage

@rental = BookingSync::Rental.create(:name => 'Wonderful Rental')

@rentals = BookingSync::Rental.all

@bookings = BookingSync::Booking.find_all_across_pages(:params => {:rental_id => 12345})

@bookings = BookingSync::Rental.find(12345).bookings

License

This code is free to be used under the terms of the MIT license.

Authors