ProximityBeacon

This gem allows access to Google's Proximity Beacon API. You can register beacons, list your beacons, add attachments, etc.

Installation

Add this line to your application's Gemfile:

gem 'proximity_beacon'

And then execute:

$ bundle

Or install it yourself as:

$ gem install proximity_beacon

Usage

# get beacons list, using CLI oauth flow
client = ProximityBeacon::Client.new
beacons = client.beacons.list

# get attachments
attachments = client.attachements.list(beacons.first.name)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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/RadiusNetworks/proximity_beacon_gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.