ringcentral-sdk 0.9.9 → 1.0.0.pre.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c82aa5b359e0d18f0096e856d81cebb7c00990208cc210a217d49d470ee19eb
-  data.tar.gz: 5a4f3973076393c86fa95ea47aa7b467c0b01abd3c46fcd819a5c976ab625717
+  metadata.gz: bbfb68b0fa5c60f0ab8dd33013d773a81568e424e616be7ba8aa1b3aaa8ffc00
+  data.tar.gz: c74ff9b328b54394693d696f186c9ef590ef3b3d5a66d0c110fcb31a85514906
 SHA512:
-  metadata.gz: 1cd78622b101fbf1ef52b717af4ea587fdf98517613d9de858f432c3954e89c4c8393a16f67a43bfa29fe938d2711970200133ad9fc7362307b214d0a807f094
-  data.tar.gz: 9a98212a1550ee2cd269d8b935fb25115f31f9ece0609498e6a5fa2efd701107da6e3ed58a48fb266e118934e85b8ded88860529f93c13142ea2d87cb315e94b
+  metadata.gz: a2bb2ff1d5fb1de2217470ab049435b49fadc236c49e3da87573554d95001b517c041cc33c56a2346a92878b675b6ed855f786e8f0c1e4bd15f5493084117456
+  data.tar.gz: 7c815de3a1679926ae14966403445217c16224702468f1807026484a4f24a8516ca12915f5f5d5d74e1be819b9cf8e60319708da174bcd120aec5e995e14b6f7

data/README.md

@@ -20,6 +20,8 @@ If you are having difficulty using this SDK, or working with the RingCentral API
 gem install ringcentral-sdk
 ```
 
+If for some reason `eventmachine` failed to install, please check [this](https://stackoverflow.com/a/31516586/862862).
+
 
 ### Name collision with `ringcentral` gem
 
@@ -133,23 +135,30 @@ r = rc.post('/restapi/v1.0/account/~/extension/~/sms',
 ```
 
 
-### PubNub subscription
+## Subscriptions
+
+### WebSocket Subscriptions
 
 ```ruby
-def createSubscription(callback)
-    events = [
-        '/restapi/v1.0/account/~/extension/~/message-store',
-    ]
-    subscription = PubNub.new(rc, events, lambda { |message|
-        callback.call(message)
-    })
-    subscription.subscribe()
-    return subscription
-end
-
-createSubscription(lambda { |message|
-    puts message
+events = [
+  '/restapi/v1.0/account/~/extension/~/message-store',
+]
+subscription = WS.new(rc, events, lambda { |message|
+  puts message
+})
+subscription.subscribe()
+```
+
+### (deprecated) PubNub Subscriptions
+
+```ruby
+events = [
+  '/restapi/v1.0/account/~/extension/~/message-store',
+]
+subscription = PubNub.new(rc, events, lambda { |message|
+  puts message
 })
+subscription.subscribe()
 ```
 
 

data/lib/subscription.rb

@@ -2,11 +2,48 @@ require 'pubnub'
 require 'concurrent'
 require 'openssl'
 require 'base64'
+require 'faye/websocket'
+require 'securerandom'
+require 'eventmachine'
+
+class WS
+  def initialize(ringcentral, events, callback)
+    @rc = ringcentral
+    @events = events
+    @callback = callback
+  end
+
+  def subscribe
+    r = @rc.post('/restapi/oauth/wstoken').body
+    @t = Thread.new do
+      EM.run {
+        @ws = Faye::WebSocket::Client.new(r['uri'] + '?access_token=' + r['ws_access_token'])
+        @ws.on :open do
+          @ws.send([
+            { type: 'ClientRequest', method: 'POST', path: '/restapi/v1.0/subscription', messageId: SecureRandom.uuid },
+            { deliveryMode: { transportType: 'WebSocket' }, eventFilters: @events }
+          ].to_json())
+        end
+        @ws.on :message do |event|
+          header, body = JSON.parse(event.data)
+          if header['type'] == 'ServerNotification'
+            @callback.call(body)
+          end
+        end
+      }
+    end
+  end
+
+  def revoke
+    @t.kill
+  end
+end
 
 class PubNub
   attr_accessor :events
 
   def initialize(ringcentral, events, message_callback, status_callback = nil, presence_callback = nil)
+    warn('PubNub is deprecated. Use WS (WebSocket) instead.')
     @rc = ringcentral
     @events = events
     @callback = Pubnub::SubscribeCallback.new(

data/ringcentral-sdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = 'ringcentral-sdk'
-  gem.version       = '0.9.9'
+  gem.version       = '1.0.0-beta.2'
   gem.authors       = ['Tyler Liu']
   gem.email         = ['tyler.liu@ringcentral.com']
   gem.description   = 'Ruby SDK for you to access RingCentral platform API.'
@@ -18,4 +18,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency('pubnub', '~> 5.2', '>= 5.2.2')
   gem.add_dependency('faraday', '~> 2.7', '>= 2.7.4')
   gem.add_dependency('faraday-multipart', '~> 1.0', '>= 1.0.4')
+  gem.add_dependency('faye-websocket', '~> 0.11', '>= 0.11.2')
 end

data/spec/{subscription_spec.rb → pubnub_subscription_spec.rb}

@@ -6,20 +6,19 @@ require 'rspec'
 Dotenv.load
 $rc = RingCentral.new(ENV['RINGCENTRAL_CLIENT_ID'], ENV['RINGCENTRAL_CLIENT_SECRET'], ENV['RINGCENTRAL_SERVER_URL'])
 
+RSpec.describe 'PubNub Subscription' do
+  def createSubscription(callback)
+    events = [
+      '/restapi/v1.0/account/~/extension/~/message-store',
+    ]
+    subscription = PubNub.new($rc, events, lambda { |message|
+      callback.call(message)
+    })
+    subscription.subscribe()
+    return subscription
+  end
 
-def createSubscription(callback)
-  events = [
-    '/restapi/v1.0/account/~/extension/~/message-store',
-  ]
-  subscription = PubNub.new($rc, events, lambda { |message|
-    callback.call(message)
-  })
-  subscription.subscribe()
-  return subscription
-end
-
-RSpec.describe 'Subscription' do
-  describe 'subscription' do
+  describe 'PubNub Subscription' do
     it 'receives message notification' do
       $rc.authorize(jwt: ENV['RINGCENTRAL_JWT_TOKEN'])
       count = 0

data/spec/websocket_subscription_spec.rb

@@ -0,0 +1,71 @@
+require 'ringcentral'
+require 'subscription'
+require 'dotenv'
+require 'rspec'
+
+Dotenv.load
+$rc = RingCentral.new(ENV['RINGCENTRAL_CLIENT_ID'], ENV['RINGCENTRAL_CLIENT_SECRET'], ENV['RINGCENTRAL_SERVER_URL'])
+
+RSpec.describe 'WebSocket Subscription' do
+  def createSubscription(callback)
+    events = [
+      '/restapi/v1.0/account/~/extension/~/message-store?type=Pager',
+    ]
+    subscription = WS.new($rc, events, lambda { |message|
+      callback.call(message)
+    })
+    subscription.subscribe()
+    return subscription
+  end
+
+  describe 'WebSocket Subscription' do
+    it 'receives message notification' do
+      $rc.authorize(jwt: ENV['RINGCENTRAL_JWT_TOKEN'])
+      count = 0
+      sub = createSubscription(lambda { |message|
+        count += 1
+      })
+
+      $rc.post('/restapi/v1.0/account/~/extension/~/company-pager', payload: {
+        to: [{extensionId: $rc.token['owner_id']}],
+        from: {extensionId: $rc.token['owner_id']},
+        text: 'Hello world'
+      })
+      sleep(20)
+      expect(count).to be > 0
+
+      # sleep for some time and see if the websocket is still alive
+      sleep(60)
+      $rc.post('/restapi/v1.0/account/~/extension/~/company-pager', payload: {
+        to: [{extensionId: $rc.token['owner_id']}],
+        from: {extensionId: $rc.token['owner_id']},
+        text: 'Hello world'
+      })
+      sleep(20)
+      expect(count).to be > 1
+
+      sub.revoke()
+      $rc.revoke()
+    end
+
+    it 'revoke' do
+      $rc.authorize(jwt: ENV['RINGCENTRAL_JWT_TOKEN'])
+      count = 0
+      subscription = createSubscription(lambda { |message|
+        count += 1
+      })
+
+      subscription.revoke()
+
+      $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
+        to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
+        from: {phoneNumber: ENV['RINGCENTRAL_SENDER']},
+        text: 'Hello world'
+      })
+      sleep(20)
+
+      expect(count).to eq(0)
+      $rc.revoke()
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-sdk
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 1.0.0.pre.beta.2
 platform: ruby
 authors:
 - Tyler Liu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -110,6 +110,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.2
 description: Ruby SDK for you to access RingCentral platform API.
 email:
 - tyler.liu@ringcentral.com
@@ -123,9 +143,10 @@ files:
 - ringcentral-sdk.gemspec
 - spec/fax_spec.rb
 - spec/mms_spec.rb
+- spec/pubnub_subscription_spec.rb
 - spec/query_params_spec.rb
 - spec/ringcentral_spec.rb
-- spec/subscription_spec.rb
+- spec/websocket_subscription_spec.rb
 homepage: https://github.com/ringcentral/ringcentral-ruby
 licenses:
 - MIT
@@ -141,9 +162,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key:
@@ -152,6 +173,7 @@ summary: RingCentral Ruby SDK.
 test_files:
 - spec/fax_spec.rb
 - spec/mms_spec.rb
+- spec/pubnub_subscription_spec.rb
 - spec/query_params_spec.rb
 - spec/ringcentral_spec.rb
-- spec/subscription_spec.rb
+- spec/websocket_subscription_spec.rb