Code Monkey home page Code Monkey logo

brivo's Introduction

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.

brivo's People

Contributors

adamrainsby avatar mble avatar shanna avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

brivo's Issues

Add timeout logic

response = Net::HTTP.start(parsed_uri.host, parsed_uri.port, use_ssl: true) do |https|
request = http_methods[method].new(parsed_uri)
request.body = params.to_json
set_access_token if monotonic_time > @access_token_expiry
request['Content-Type'] = 'application/json'
request['Authorization'] = "bearer #{@access_token}"
request['api-key'] = api_key
https.request(request)
end

On the above and similar usage of Net::HTTP, we need to have a fairly aggressive timeout set - the default read_timeout and open_timeout are 60 seconds. Should also set ssl_timeout in case the handshake takes a long time.

Tell some strings to chill out

Like any API wrapper, there is a fair bit of string munging. Where possible, strings should be frozen with magic comments, or String#freeze (and potentially any object that you don't want to be able to be mutated, like a Brivo::Application instance).

Slap with Rubocop

If we release this to the world, we should probably have it adhere to popular conventions. We can turn the stuff off we don't like (to keep seattle.rb style).

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.