Glip SDK for Ruby

Gem Version Build Status Dependency Status Codacy Badge Code Climate Scrutinizer Code Quality Downloads Docs License

Glip SDK for Glip collaboration (https://glip.com).

More documentation will be added soon. For now see the example and SDK code.

Usage

rc_sdk = RingCentralSdk::REST::Client.new [...]
glip = GlipSdk::REST::Client.new rc_sdk

# For HTTP calls, params are the same as REST API, e.g. camelCase
res = glip.posts.post groupId: '12345', text: 'Hi there!'

# All params can be provided:
groups = glip.groups.get                      # => Faraday::Response
groups = glip.groups.get groupId: 12345       # => Faraday::Response

# Get all groups will continue call `prevPageToken` as provided
groups = glip.groups.all_groups               # => Array group hash
groups = glip.groups.all_groups type: 'Group' # => ..where type == 'Group'
groups = glip.groups.all_groups type: 'Team'  # => ..where type == 'Team'

# Subscribe for updates
class MyObserver
  def update(message)
    puts 'received message'
  end
end

glip.groups.observe MyObserver.new
glip.posts.observe MyObserver.new

Example Scripts

Example scripts can be found in the scripts directory.

Change Log

See CHANGELOG.md

Project Repo

Contributing

  1. Fork it ( http://github.com/ringcentral-ruby/glip-sdk-ruby/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 new Pull Request

License

Glip SDK is available under the MIT license. See LICENSE.md for details.

Glip SDK © 2016-2017 by John Wang