Kisi::Client

Ruby Client for the KISI (Access Control System) API

Installation

Add this line to your application's Gemfile:

gem 'kisi-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install kisi-client

Usage

# Initialize KISI Client
kisi = Kisi::Client.new "KISI_TOKEN"

# Get the list (array) of doors
doors = kisi.get_doors

# The name/description of the first door in the list
doors.first['name']

# Open the first door
kisi.open_door(doors.first)

Where is my KISI Token?

You should have one in your inbox for each organisation you have access to. It is an alpha numeric key at the end of the URL your recieved from KISI, for example:

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake false 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/yevgenko/kisi-client.

License

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