Skip to content

riggy/zoomba

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

travis status Code Climate Test Coverage Issue Count

Zoomba

Zoomba is implementation of Zoom.us API, loosely inspired by zoomus gem.

It aims to provide object mapping for Zoom.us data and convenient methods to interact with those data and the API.

Supported API endpoints

So far gem supports the following Zoom.us endpoints:

  • /user/create
  • /user/autocreate
  • /user/custcreate
  • /user/ssocreate
  • /user/list
  • /user/pending
  • /user/get
  • /user/getbyemail
  • /user/checkemail
  • /user/checkzpk
  • /user/delete
  • /user/deactivate
  • /user/update
  • /user/updatepassword
  • /user/revoketoken
  • /user/permanentdelete

Installation

Add this line to your application's Gemfile:

gem 'zoomba'

And then execute:

$ bundle

Or install it yourself as:

$ gem install zoomba

Usage

First configure Zoomba with this code:

Zoomba.configure do |c|
  c.api_key = API_KEY
  c.api_secret = API_SECRET
end

Then, for example, to fetch all users:

Zoomba::User.list

It will return a collection of Zoomba::User instances.

More usage tips to follow...

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/riggy/zoomba. 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.

License

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