Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 1.54 KB

README.md

File metadata and controls

77 lines (52 loc) · 1.54 KB
Raw

Brivo

API wrapper for the Brivo API

Installation

Add this line to your application's Gemfile:

gem 'brivo'

And then execute:

$ bundle

Or install it yourself as:

$ gem install brivo

Usage

client = Brivo::Application.new(
  client_id: YOUR_CLIENT_ID,
  secret: YOUR_SECRET,
  api_key: YOUR_API_KEY,
  username: YOUR_USERNAME,
  password: YOUR_PASSWORD
)

# Create a user
client.user.create(
  first_name: 'First name',
  last_name: 'last name',
  external_id: 1
)

# Get all users
client.users

# Find a user
client.user(id)

# Create a group
client.group.create(
  name: 'Group name'
)

# Get all groups
client.groups

# Find a group
group = client.group(id)

# Assign a user to a group
group.assign_user(user_id)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/techspaceco/brivo

License

The gem is available as open source under the terms of the MIT License.