lita-ringcentral 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38bd014146636fd9c6391b41865c96bb42428a93
+  data.tar.gz: f3c693d69c50f0a2ae77782d901e4ae0d00752b5
+SHA512:
+  metadata.gz: 5f07d67f3764e8b6083b3b066492ef6fa69ece6943d5fbf82469f5af720be96eed21539741b482b79c0c9c373d17d866e3d2a3f1473687cb36b89d88c5204a21
+  data.tar.gz: a196e0fa9929e64e76cf689dcfb4c5ab9527b08b03696dc2c806876dcb3760ec93f212f90439963d80dba348d8e1dc568fbc2e6825c2415b5906c0d81938b553

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+---
+languages:
+  Ruby: true
+  JavaScript: false
+  PHP: false
+  Python: false
+engines:
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- docs/**/*
+- scripts/**/*
+- test/**/*

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+lita_config.rb

data/.simplecov

@@ -0,0 +1,6 @@
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter "/test/"
+end

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.3.1
+  - 2.2.2
+script: bundle exec rspec
+before_install:
+  - gem update --system
+  - gem update bundler
+services:
+  - redis-server
+notifications:
+  email: false

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+CHANGELOG
+---------
+- **2016-08-23**: 0.0.1
+  - Initial commit

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 John Wang
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+LITA RingCentral Adapter
+========================
+
+[![Gem Version][gem-version-svg]][gem-version-link]
+[![Build Status][build-status-svg]][build-status-link]
+[![Coverage Status][coverage-status-svg]][coverage-status-link]
+[![Dependency Status][dependency-status-svg]][dependency-status-link]
+[![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
+[![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
+[![Downloads][downloads-svg]][downloads-link]
+[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
+[![License][license-svg]][license-link]
+
+`lita-ringcentral` is an adapter for [Lita](https://www.lita.io/) that allows you to use the robot with [RingCentral](https://developers.ringcentral.com/) via SMS.
+
+## Installation
+
+Add `lita-ringcentral` to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-ringcentral"
+```
+
+### Example
+
+``` ruby
+Lita.configure do |config|
+  config.robot.adapter = :ringcentral
+
+  config.adapters.ringcentral.app_key = 'my_app_key'
+  config.adapters.ringcentral.app_secret = 'my_app_secret'
+  config.adapters.ringcentral.server = 'my_server'
+  config.adapters.ringcentral.username = 'my_username'
+  config.adapters.ringcentral.extension = 'my_extension'
+  config.adapters.ringcentral.password = 'my_password'
+end
+```
+
+### Change Log
+
+See [CHANGELOG.md](CHANGELOG.md)
+
+## Links
+
+Project Repo
+
+* https://github.com/grokify/lita-ringcentral
+
+Lita
+
+* https://www.lita.io/
+
+## Contributing
+
+1. Fork it ( http://github.com/grokify/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.txt](LICENSE.txt) for details.
+
+LITA RingCentral Adapter © 2016 by John Wang
+
+ [gem-version-svg]: https://badge.fury.io/rb/lita-ringcentral.svg
+ [gem-version-link]: http://badge.fury.io/rb/lita-ringcentral
+ [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/lita-ringcentral
+ [downloads-link]: https://rubygems.org/gems/lita-ringcentral
+ [build-status-svg]: https://api.travis-ci.org/grokify/lita-ringcentral.svg?branch=master
+ [build-status-link]: https://travis-ci.org/grokify/lita-ringcentral
+ [coverage-status-svg]: https://coveralls.io/repos/grokify/lita-ringcentral/badge.svg?branch=master
+ [coverage-status-link]: https://coveralls.io/r/grokify/lita-ringcentral?branch=master
+ [dependency-status-svg]: https://gemnasium.com/grokify/lita-ringcentral.svg
+ [dependency-status-link]: https://gemnasium.com/grokify/lita-ringcentral
+ [codeclimate-status-svg]: https://codeclimate.com/github/grokify/lita-ringcentral/badges/gpa.svg
+ [codeclimate-status-link]: https://codeclimate.com/github/grokify/lita-ringcentral
+ [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/grokify/lita-ringcentral/badges/quality-score.png?b=master
+ [scrutinizer-status-link]: https://scrutinizer-ci.com/g/grokify/lita-ringcentral/?branch=master
+ [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
+ [docs-rubydoc-link]: http://www.rubydoc.info/gems/lita-ringcentral/
+ [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
+ [license-link]: https://github.com/grokify/lita-ringcentral/blob/master/LICENSE.txt

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita-ringcentral.rb

@@ -0,0 +1,7 @@
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'lita/adapters/ringcentral'

data/lib/lita/adapters/ringcentral.rb

@@ -0,0 +1,55 @@
+require 'lita'
+require 'lita/adapters/ringcentral/connector'
+
+module Lita
+  module Adapters
+    class RingCentral < Adapter
+      namespace 'ringcentral'
+
+      # Required attributes
+      config :app_key, type: String, required: true
+      config :app_secret, type: String, required: true
+      config :sms_number, type: String, required: true
+
+      # Optional attributes
+      config :server, type: String, default: 'platform.devtest.ringcentral.com'
+      config :username, type: String
+      config :extension, type: String
+      config :password, type: String
+      config :token, type: String
+
+      attr_reader :connector
+
+      def initialize(robot)
+        super
+        @connector = Connector.new(
+          robot,
+          config.app_key,
+          config.app_secret,
+          config.server,
+          config.username,
+          config.extension,
+          config.password,
+          config.token,
+          config.sms_number)
+      end
+
+      def run
+        @connector.connect
+        sleep
+      rescue Interrupt
+        shut_down
+      end
+
+      def send_messages(target, strings)
+        Lita.logger.info 'Sending Message'
+        @connector.message target.user.id, strings
+      end
+
+      def shut_down
+        robot.trigger :disconnected
+      end
+    end
+    Lita.register_adapter :ringcentral, RingCentral
+  end
+end

data/lib/lita/adapters/ringcentral/callback.rb

@@ -0,0 +1,28 @@
+module Lita
+  module Adapters
+    class RingCentral < Adapter
+      class Callback
+        attr_reader :robot
+
+        def initialize(robot)
+          @robot = robot
+        end
+
+        def create_user(user_data)
+          User.create user_data['phoneNumber']
+        end
+
+        def update(message)
+          Lita.logger.info 'Processing RingCentral Message'
+          user_phone_number = message['body']['from']['phoneNumber']
+          user = Lita::User.find_by_name user_phone_number
+          user = create_user(message['body']['from']) unless user
+          source = Lita::Source.new user: user, room: user_phone_number
+          post = message['body']['subject'].to_s
+          msg = Lita::Message.new @robot, post, source
+          @robot.receive msg
+        end
+      end
+    end
+  end
+end

data/lib/lita/adapters/ringcentral/connector.rb

@@ -0,0 +1,53 @@
+require 'lita/adapters/ringcentral/callback'
+require 'ringcentral_sdk'
+
+module Lita
+  module Adapters
+    class RingCentral < Adapter
+      class Connector
+        attr_reader :robot, :client
+
+        def initialize(robot, app_key, app_secret, server, username, extension, password, token, sms_number, debug: false)
+          @robot = robot
+          @client = RingCentralSdk.new app_key, app_secret, server
+          @username = username
+          @extension = extension
+          @password = password
+          @token = token
+          @sms_number = sms_number
+        end
+
+        def connect
+          client_connect
+        end
+
+        def client_connect
+          Lita.logger.debug('Authenticating with RingCentral.')
+          if @token.nil?
+            @client.authorize_password @username, @extension, @password
+          else
+            @client.set_token @token
+          end
+
+          observer = Lita::Adapters::RingCentral::Callback.new @robot
+          @subscription = @client.create_subscription
+          @subscription.subscribe([
+            '/restapi/v1.0/account/~/extension/~/message-store/instant?type=SMS'
+          ])
+          @subscription.add_observer observer
+        end
+
+        def message(to_number, strings)
+          strings.each do |s|
+            @client.messages.sms.create(
+              from: @sms_number,
+              to: to_number,
+              text: s
+            )
+          end
+        end
+
+      end
+    end
+  end
+end

data/lita-ringcentral.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-ringcentral'
+  spec.date          = '2016-08-23'
+  spec.version       = '0.0.1'
+  spec.authors       = ['John Wang']
+  spec.email         = ["johncwang@gmail.com"]
+  spec.description   = %q{A RingCentral adapter for Lita.}
+  spec.summary       = %q{A RingCentral adapter for the Lita chat robot.}
+  spec.homepage      = 'https://github.com/grokify/lita-ringcentral'
+  spec.license       = 'MIT'
+  spec.metadata      = { 'lita_plugin_type' => 'adapter' }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'lita', '>= 4.4.3'
+  spec.add_runtime_dependency 'ringcentral_sdk', '>= 1.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'simplecov', '>= 0.9.2'
+  spec.add_development_dependency 'coveralls'
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    adapters:
+      ringcentralsms:

data/spec/lita/adapters/ringcentral_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Lita::Adapters::RingCentral, lita: true do
+  subject { described_class.new(robot) }
+
+  let(:robot) { Lita::Robot.new(registry) }
+  let(:adapter) { instance_double('Lita::Adapters::RingCentral') }
+  let(:connection) { instance_double('Lita::Adapters::RingCentral::Connector') }
+
+  let(:ringcentral_app_key) { 'my_app_key' }
+  let(:ringcentral_app_secret) { 'my_app_secret' }
+  let(:ringcentral_server) { 'https://platform.devtest.ringcentral.com' }
+  let(:ringcentral_username) { 'my_username' }
+  let(:ringcentral_extension) { 'my_extension' }
+  let(:ringcentral_password) { 'my_password' }
+  let(:ringcentral_token) { '{
+  "access_token": "my_test_access_token_with_refresh",
+  "token_type": "bearer",
+  "expires_in": 3599,
+  "refresh_token": "my_test_refresh_token",
+  "refresh_token_expires_in": 604799,
+  "scope": "ReadCallLog DirectRingOut EditCallLog ReadAccounts Contacts EditExtensions ReadContacts SMS EditPresence RingOut EditCustomData ReadPresence EditPaymentInfo Interoperability Accounts NumberLookup InternalMessages ReadCallRecording EditAccounts Faxes EditReportingSettings ReadClientInfo EditMessages VoipCalling ReadMessages",
+  "owner_id": "1234567890"
+      }' }
+
+  before do
+    registry.register_adapter(:ringcentral, described_class)
+    registry.config.adapters.ringcentral.app_key = ringcentral_app_key
+    registry.config.adapters.ringcentral.app_secret = ringcentral_app_secret
+    registry.config.adapters.ringcentral.server = ringcentral_server
+    registry.config.adapters.ringcentral.username = ringcentral_username
+    registry.config.adapters.ringcentral.extension = ringcentral_extension
+    registry.config.adapters.ringcentral.password = ringcentral_password
+    registry.config.adapters.ringcentral.token = JSON.parse ringcentral_token
+
+    allow(
+      described_class::Connector
+    ).to receive(:connect).with(robot, subject.config).and_return(connection)
+    allow(adapter).to receive(:run)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'simplecov'
+require 'coveralls'
+Coveralls.wear!
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-ringcentral"
+require "lita/rspec"
+
+require "pry"
+
+Lita.version_3_compatibility_mode = false
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: lita-ringcentral
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.3
+- !ruby/object:Gem::Dependency
+  name: ringcentral_sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A RingCentral adapter for Lita.
+email:
+- johncwang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".simplecov"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lita-ringcentral.rb
+- lib/lita/adapters/ringcentral.rb
+- lib/lita/adapters/ringcentral/callback.rb
+- lib/lita/adapters/ringcentral/connector.rb
+- lita-ringcentral.gemspec
+- locales/en.yml
+- spec/lita/adapters/ringcentral_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/grokify/lita-ringcentral
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: adapter
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A RingCentral adapter for the Lita chat robot.
+test_files:
+- spec/lita/adapters/ringcentral_spec.rb
+- spec/spec_helper.rb