https://github.com/lenage/gensee
Ruby wrapper for Gensee API
https://github.com/lenage/gensee
Last synced: about 1 month ago
JSON representation
Ruby wrapper for Gensee API
- Host: GitHub
- URL: https://github.com/lenage/gensee
- Owner: lenage
- License: mit
- Created: 2015-01-08T13:11:48.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-01-08T13:22:31.000Z (over 11 years ago)
- Last Synced: 2023-03-12T23:31:04.650Z (over 3 years ago)
- Language: Ruby
- Homepage:
- Size: 133 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Gensee
Gensee is Ruby wrapper for [Gensee API](http://www.gensee.com/document-technical.php),
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'gensee'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install gensee
## Usage
```ruby
# Provide authentication credentials
Gensee.configure do |c|
c.endpoint = 'http://yoursubdomain.gensee.com'
c.login = 'loginname'
c.password = 'yourpassword'
end
# Create classroom
classroom = Gensee.client.create_classroom('AWESOME CLASSROOM', Time.now, rand(100_000..200_000), rand(100_000..2000_000))
puts classroom[:student_join_url] # http://youdomain.gensee.com/training/site/s/{classroom_number}
puts classroom[:teacher_join_url] # http://youdomain.gensee.com/training/site/s/{classroom_number}
puts classroom[:number] # 34154643
puts classroom[:id] # mquQf2
```
or
```ruby
# Provide authentication credentials
client = Gensee::Client.new(endpoint: 'http://yoursubdomain.gensee.com', login: 'gensee@username', password: 'yourpassword')
# create classroom
classroom = client.create_classroom('AWESOME CLASSROOM', Time.now, rand(100_000..200_000), rand(100_000..2000_000))
puts classroom[:student_join_url] # http://youdomain.gensee.com/training/site/s/{classroom_number}
puts classroom[:teacher_join_url] # http://youdomain.gensee.com/training/site/s/{classroom_number}
puts classroom[:number] # 34154643
puts classroom[:id] # mquQf2
```
## Testing
$export GENSEE_ENDPOINT='http://yoursubdomain.gensee.com' GENSEE_LOGIN=loginname GENSEE_PASSWORD=somelooogpassword
$ rake
## Contributing
1. Fork it ( https://github.com/[my-github-username]/gensee/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request