Sha256: 6333c109113abdad7e89b4449938c2ca06e94bd869e15c6a77331990e1b439e2

Contents?: true

Size: 1.84 KB

Versions: 3

Compression:

Stored size: 1.84 KB

Contents

# 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

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
gensee-0.1.2 README.md
gensee-0.1.1 README.md
gensee-0.1.0 README.md