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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbfb68b0fa5c60f0ab8dd33013d773a81568e424e616be7ba8aa1b3aaa8ffc00
-  data.tar.gz: c74ff9b328b54394693d696f186c9ef590ef3b3d5a66d0c110fcb31a85514906
+  metadata.gz: 8bb9f1c796f3fc2ac90aa28d1a33090d5e26fdc8445edb312fd9b1937add7add
+  data.tar.gz: 394c158641dfe6d4f6301eec2527107eeb3909b6aff782b1af5224f700aca7ef
 SHA512:
-  metadata.gz: a2bb2ff1d5fb1de2217470ab049435b49fadc236c49e3da87573554d95001b517c041cc33c56a2346a92878b675b6ed855f786e8f0c1e4bd15f5493084117456
-  data.tar.gz: 7c815de3a1679926ae14966403445217c16224702468f1807026484a4f24a8516ca12915f5f5d5d74e1be819b9cf8e60319708da174bcd120aec5e995e14b6f7
+  metadata.gz: 6cc88ac631aca239ecb0a644d2f399e86cd055d11a50021adb0aab66d6a3bc30be7e03c448541fa5309cfed9b336ec1ef183348b3383c29f006357093bb9c24d
+  data.tar.gz: 10a25f56bc1afbd4b3c04df79ccfecf9f7a1cd019023d6417b38b43f80fa829f651fea02a1fdf677f64c3ca8fa11457bd31d23d1f30d2bad190bfbd2958228d8

data/README.md

@@ -149,6 +149,22 @@ subscription = WS.new(rc, events, lambda { |message|
 subscription.subscribe()
 ```
 
+#### How to keep a subscription running 24 * 7?
+
+There are two main cases that a subscription will be terminated:
+
+- Absolute time out. The maximum time for a subscription to run is 24 hours. After that, the websocket connection will be closed by the server.
+- Network issue. It could be your local network issue or the server's network issue. In either case, your websocket connection will be closed
+
+In order to keep a subscription running 24 * 7, you need to re-subscribe when the connection is closed.
+
+```ruby
+subscription.on_ws_closed = lambda { |event|
+  # make sure that there is no network issue and re-subscribe
+  subscription.subscribe()
+}
+```
+
 ### (deprecated) PubNub Subscriptions
 
 ```ruby

data/lib/ringcentral.rb

@@ -62,6 +62,7 @@ class RingCentral
         assertion: jwt
       }
     else
+      warn('Password auth is deprecated. Use JWT auth or OAuth instead.')
       payload = {
         grant_type: 'password',
         username: username,

data/lib/subscription.rb

@@ -7,10 +7,15 @@ require 'securerandom'
 require 'eventmachine'
 
 class WS
-  def initialize(ringcentral, events, callback)
+  def initialize(ringcentral, events, callback, debugMode = false)
     @rc = ringcentral
     @events = events
     @callback = callback
+    @debugMode = debugMode
+  end
+
+  def on_ws_closed=(callback)
+    @on_ws_closed = callback
   end
 
   def subscribe
@@ -18,18 +23,42 @@ class WS
     @t = Thread.new do
       EM.run {
         @ws = Faye::WebSocket::Client.new(r['uri'] + '?access_token=' + r['ws_access_token'])
+        if @debugMode
+          class << @ws
+            def send(message)
+              puts "Sending...\n" + message
+              super(message)
+            end
+          end
+        end
         @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())
+
+          # send a heartbeat every 10 minutes
+          @task = Concurrent::TimerTask.new(execution_interval: 600) do
+            @ws.send([
+              { type: 'Heartbeat', messageId: SecureRandom.uuid },
+            ].to_json())
+          end
+          @task.execute
         end
         @ws.on :message do |event|
+          if @debugMode
+            puts "Receiving...\n" + event.data
+          end
           header, body = JSON.parse(event.data)
           if header['type'] == 'ServerNotification'
             @callback.call(body)
           end
         end
+        @ws.on :close do |event|
+          if @on_ws_closed
+            @on_ws_closed.call(event)
+          end
+        end
       }
     end
   end

data/ringcentral-sdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = 'ringcentral-sdk'
-  gem.version       = '1.0.0-beta.2'
+  gem.version       = '1.0.0-beta.4'
   gem.authors       = ['Tyler Liu']
   gem.email         = ['tyler.liu@ringcentral.com']
   gem.description   = 'Ruby SDK for you to access RingCentral platform API.'

data/spec/mms_spec.rb

@@ -8,19 +8,20 @@ RSpec.describe 'MMS' do
       rc = RingCentral.new(ENV['RINGCENTRAL_CLIENT_ID'], ENV['RINGCENTRAL_CLIENT_SECRET'], ENV['RINGCENTRAL_SERVER_URL'])
       rc.authorize(jwt: ENV['RINGCENTRAL_JWT_TOKEN'])
 
-      r = rc.post('/restapi/v1.0/account/~/extension/~/sms',
-        payload: {
-          to: [{ phoneNumber: ENV['RINGCENTRAL_RECEIVER'] }],
-          from: { phoneNumber: ENV['RINGCENTRAL_SENDER'] },
-          text: 'hello world'
-        },
-        files: [
-          ['spec/test.png', 'image/png']
-        ]
-      )
-      expect(r).not_to be_nil
-      message = r.body
-      expect('SMS').to eq(message['type'])
+      # comment out because sandbox doesn't support mms any more.
+      # r = rc.post('/restapi/v1.0/account/~/extension/~/sms',
+      #   payload: {
+      #     to: [{ phoneNumber: ENV['RINGCENTRAL_RECEIVER'] }],
+      #     from: { phoneNumber: ENV['RINGCENTRAL_SENDER'] },
+      #     text: 'hello world'
+      #   },
+      #   files: [
+      #     ['spec/test.png', 'image/png']
+      #   ]
+      # )
+      # expect(r).not_to be_nil
+      # message = r.body
+      # expect('SMS').to eq(message['type'])
 
       rc.revoke()
     end

data/spec/pubnub_subscription_spec.rb

@@ -9,7 +9,7 @@ $rc = RingCentral.new(ENV['RINGCENTRAL_CLIENT_ID'], ENV['RINGCENTRAL_CLIENT_SECR
 RSpec.describe 'PubNub Subscription' do
   def createSubscription(callback)
     events = [
-      '/restapi/v1.0/account/~/extension/~/message-store',
+      '/restapi/v1.0/account/~/extension/~/message-store?type=Pager',
     ]
     subscription = PubNub.new($rc, events, lambda { |message|
       callback.call(message)
@@ -26,9 +26,9 @@ RSpec.describe 'PubNub Subscription' do
         count += 1
       })
 
-      $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
-        to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
-        from: {phoneNumber: ENV['RINGCENTRAL_SENDER']},
+      $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)
@@ -46,9 +46,9 @@ RSpec.describe 'PubNub Subscription' do
 
       subscription.refresh()
 
-      $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
-        to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
-        from: {phoneNumber: ENV['RINGCENTRAL_SENDER']},
+      $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)
@@ -66,9 +66,9 @@ RSpec.describe 'PubNub Subscription' do
 
       subscription.revoke()
 
-      $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
-        to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
-        from: {phoneNumber: ENV['RINGCENTRAL_SENDER']},
+      $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)

data/spec/ringcentral_spec.rb

@@ -49,14 +49,14 @@ RSpec.describe 'RingCentral' do
       expect('101').to eq(r.body['extensionNumber'])
 
       # post
-      r = rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
-        to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
-        from: {phoneNumber: ENV['RINGCENTRAL_SENDER']},
+      r = 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'
       })
       expect(r).not_to be_nil
       message = r.body
-      expect('SMS').to eq(message['type'])
+      expect('Pager').to eq(message['type'])
       messageUrl = "/restapi/v1.0/account/~/extension/~/message-store/#{message['id']}"
 
       # put
@@ -72,12 +72,13 @@ RSpec.describe 'RingCentral' do
       # todo: test patch
 
       # delete
-      r = rc.delete(messageUrl)
-      expect(r).not_to be_nil
-      r = rc.get(messageUrl)
-      expect(r).not_to be_nil
-      message = r.body
-      expect('Deleted').to eq(message['availability'])
+      # todo: delete "availability" is broken, because of sandbox env
+      # r = rc.delete(messageUrl)
+      # expect(r).not_to be_nil
+      # r = rc.get(messageUrl)
+      # expect(r).not_to be_nil
+      # message = r.body
+      # expect('Deleted').to eq(message['availability'])
 
       rc.revoke()
     end

data/spec/websocket_subscription_spec.rb

@@ -15,6 +15,9 @@ RSpec.describe 'WebSocket Subscription' do
       callback.call(message)
     })
     subscription.subscribe()
+    # subscription.on_ws_closed = lambda { |event|
+    #   puts 'WebSocket closed'
+    # }
     return subscription
   end
 
@@ -57,9 +60,9 @@ RSpec.describe 'WebSocket Subscription' do
 
       subscription.revoke()
 
-      $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
-        to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
-        from: {phoneNumber: ENV['RINGCENTRAL_SENDER']},
+      $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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.2
+  version: 1.0.0.pre.beta.4
 platform: ruby
 authors:
 - Tyler Liu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable