Lita RingCentral Adapter

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

lita-ringcentral is an adapter for Lita that allows you to use the robot with RingCentral via SMS.

Installation

Add lita-ringcentral to your Lita instance's Gemfile:

gem "lita-ringcentral"

Configuration

Lita.configure do |config|
  config.robot.adapter = :ringcentral

  # RingCentral app info
  config.adapters.ringcentral.app_key = 'my_app_key'
  config.adapters.ringcentral.app_secret = 'my_app_secret'
  config.adapters.ringcentral.server = 'my_server'

  # RingCentral user info
  config.adapters.ringcentral.username = 'my_username'
  config.adapters.ringcentral.extension = 'my_extension'
  config.adapters.ringcentral.password = 'my_password'

  # RingCentral bot SMS number available to authorized user
  config.adapters.ringcentral.sms_number = 'my_sms_number' 
end

Notes

This adapter supports 1:1 communications between a Lita chatbot and a user of SMS. It supports standard communications and does not have special functionality for command routes.

Usage

The bot will listen to and respond from the SMS number provided for config.adapters.ringcentral.sms_number.

API documentation

The API documentation, useful for plugin authors, can be found for the latest gem release on RubyDoc.info.

To Do

  1. User address book lookup.

Change Log

See CHANGELOG.md

Project Repo

Lita

Contributing

  1. Fork it ( http://github.com/ringcentral-ruby/lita-ringcentral/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

Lita RingCentral Adapter is available under the MIT license. See LICENSE.md for details.

Lita RingCentral Adapter © 2016 by John Wang