ringcentral-sdk 1.0.0.pre.beta.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2cb478670f796bb5865ad74d62d046ae085fb120bfd4f1587fcf5008d6dda43
-  data.tar.gz: b83a678d5087bf5c957f1fa49ca339f483aa46736a1d86fc079e6f61121b8776
+  metadata.gz: cb3d49139090020a404bb081c1468d4439c2628afc355df576ac27c36bc29f6f
+  data.tar.gz: 44f29f3245d3766e87ee46b725f0f737e085e6d7e42d764fedc156b7095d503d
 SHA512:
-  metadata.gz: 60e646c7aeec753a278004705e692cea1f018df149f8bfe5f600c6ac757c6e500cb50f56ba1d2cdf30845804ebc218df668bfb429fc7bf66668543c20979dacb
-  data.tar.gz: 30b40d21161fd726758e6ce793853d5703cf125a6319aa6fbfb619d8e00b37b54a324fd824a768b1e7cd21abd6bfaf78b3f8025026191dd068c0152fee432636
+  metadata.gz: 6351380d085117dfd916d66693be085e7785de57cff373344e8800a8f204a2632ca3cfd7aa382cfb16b30d9f5c67eb18d62a4662b3437a3f4ab0bd154019c7f6
+  data.tar.gz: 2e4f4b03ceb67b5d8aa4df33335b395c0f2241f63c1dd2bd356afd1048d0dec0ed5bba990738e6d747721edaf69bee87db5da60be25c016875d2e492e0c82a14

data/README.md

@@ -81,7 +81,7 @@ Access token expires. You need to call `rc.refresh()` before it expires.
 If you want the SDK to do auto refresh please `rc.auto_refresh = true` before authorization.
 
 
-### Load preexisting token
+### Load pre-existing token
 
 Let's say you already have a token. Then you can load it like this: `rc.token = your_token_object`.
 The benefit of loading a preexisting token is you don't need to go through any authorization flow.
@@ -149,26 +149,27 @@ subscription = WS.new(rc, events, lambda { |message|
 subscription.subscribe()
 ```
 
-### (deprecated) PubNub Subscriptions
+#### How to keep a subscription running 24 * 7?
 
-```ruby
-events = [
-  '/restapi/v1.0/account/~/extension/~/message-store',
-]
-subscription = PubNub.new(rc, events, lambda { |message|
-  puts message
-})
-subscription.subscribe()
-```
+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.
 
-For more sample codes, please refer to the [test cases](/spec).
+```ruby
+subscription.on_ws_closed = lambda { |event|
+  # make sure that there is no network issue and re-subscribe
+  subscription.subscribe()
+}
+```
 
 
 ## How to test
 
 ```
-bundle install --path vendor/bundle
+bundle install
 ```
 
 Rename `.env.sample` to `.env`.

data/lib/ringcentral.rb

@@ -4,13 +4,8 @@ require 'json'
 require 'concurrent'
 require 'faraday'
 require 'faraday/multipart'
-require 'tmpdir'
 
 class RingCentral
-  def self.SANDBOX_SERVER
-    'https://platform.devtest.ringcentral.com'
-  end
-
   def self.PRODUCTION_SERVER
     'https://platform.ringcentral.com'
   end
@@ -18,7 +13,7 @@ class RingCentral
   attr_reader :client_id, :client_secret, :server, :token
   attr_accessor :auto_refresh, :debug_mode
 
-  def initialize(client_id, client_secret, server, debug_mode = false)
+  def initialize(client_id, client_secret, server = self.PRODUCTION_SERVER, debug_mode = false)
     @client_id = client_id
     @client_secret = client_secret
     @server = server

data/lib/subscription.rb

@@ -1,16 +1,18 @@
-require 'pubnub'
 require 'concurrent'
-require 'openssl'
-require 'base64'
 require 'faye/websocket'
 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 +20,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
@@ -38,79 +64,3 @@ class WS
     @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(
-      message: lambda { |envelope|
-        message = envelope.result[:data][:message]
-        cipher = OpenSSL::Cipher::AES.new(128, :ECB)
-        cipher.decrypt
-        cipher.key = Base64.decode64(@subscription['deliveryMode']['encryptionKey'])
-        ciphertext = Base64.decode64(message)
-        plaintext = cipher.update(ciphertext) + cipher.final
-        message_callback.call(JSON.parse(plaintext))
-      },
-      presence: lambda { |envelope|
-        presence_callback != nil && presence_callback.call(envelope)
-      },
-      status: lambda { |envelope|
-        status_callback != nil && status_callback.call(envelope)
-      }
-    )
-    @subscription = nil
-    @timer = nil
-    @pubnub = nil
-  end
-
-  def subscription=(value)
-    @subscription = value
-    if @timer != nil
-      @timer.shutdown
-      @timer = nil
-    end
-    if value != nil
-      @timer = Concurrent::TimerTask.new(execution_interval: value['expiresIn'] - 120) do
-        self.refresh
-      end
-      @timer.execute
-    end
-  end
-
-  def subscribe
-    r = @rc.post('/restapi/v1.0/subscription', payload: request_body)
-    self.subscription = r.body
-    @pubnub = Pubnub.new(subscribe_key: @subscription['deliveryMode']['subscriberKey'], user_id: @rc.token['owner_id'])
-    @pubnub.add_listener(name: 'default', callback: @callback)
-    @pubnub.subscribe(channels: @subscription['deliveryMode']['address'])
-  end
-
-  def refresh
-    return if @subscription == nil
-    r = @rc.put("/restapi/v1.0/subscription/#{@subscription['id']}", payload: request_body)
-    self.subscription = r.body
-  end
-
-  def revoke
-    return if @subscription == nil
-    @pubnub.unsubscribe(channel: @subscription['deliveryMode']['address'])
-    @pubnub.remove_listener(name: 'default')
-    @pubnub = nil
-    @rc.delete("/restapi/v1.0/subscription/#{@subscription['id']}")
-    self.subscription = nil
-  end
-
-  private
-
-    def request_body
-      {
-        'deliveryMode': { 'transportType': 'PubNub', 'encryption': true },
-        'eventFilters': @events
-      }
-    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.3'
+  gem.version       = '1.0.0'
   gem.authors       = ['Tyler Liu']
   gem.email         = ['tyler.liu@ringcentral.com']
   gem.description   = 'Ruby SDK for you to access RingCentral platform API.'
@@ -13,10 +13,9 @@ Gem::Specification.new do |gem|
   gem.files        += Dir['lib/**/*.rb']
   gem.test_files    = Dir['spec/**/*.rb']
 
-  gem.add_dependency('addressable', '~> 2.8', '>= 2.8.4')
-  gem.add_dependency('concurrent-ruby', '~> 1.2', '>= 1.2.2')
-  gem.add_dependency('pubnub', '~> 5.2', '>= 5.2.2')
-  gem.add_dependency('faraday', '~> 2.7', '>= 2.7.4')
+  gem.add_dependency('addressable', '~> 2.8', '>= 2.8.6')
+  gem.add_dependency('concurrent-ruby', '~> 1.2', '>= 1.2.3')
+  gem.add_dependency('faraday', '~> 2.9', '>= 2.9.0')
   gem.add_dependency('faraday-multipart', '~> 1.0', '>= 1.0.4')
-  gem.add_dependency('faye-websocket', '~> 0.11', '>= 0.11.2')
+  gem.add_dependency('faye-websocket', '~> 0.11', '>= 0.11.3')
 end

data/spec/fax_spec.rb

@@ -1,5 +1,7 @@
 require 'dotenv'
 require 'ringcentral'
+require "simplecov"
+SimpleCov.start
 
 RSpec.describe 'Fax' do
   describe 'send fax' do

data/spec/mms_spec.rb

@@ -1,5 +1,7 @@
 require 'dotenv'
 require 'ringcentral'
+require "simplecov"
+SimpleCov.start
 
 RSpec.describe 'MMS' do
   describe 'send MMS' do

data/spec/query_params_spec.rb

@@ -1,5 +1,7 @@
 require 'dotenv'
 require 'ringcentral'
+require "simplecov"
+SimpleCov.start
 
 RSpec.describe 'query params' do
   describe 'single' do

data/spec/ringcentral_spec.rb

@@ -1,23 +1,24 @@
 require 'ringcentral'
+require "simplecov"
+SimpleCov.start
 
 RSpec.describe 'RingCentral' do
   describe 'ringcentral' do
     it 'test_class_variables' do
-      expect('https://platform.devtest.ringcentral.com').to eq(RingCentral.SANDBOX_SERVER)
       expect('https://platform.ringcentral.com').to eq(RingCentral.PRODUCTION_SERVER)
     end
 
     it 'test_initializer' do
-      rc = RingCentral.new('client_id', 'client_secret', RingCentral.SANDBOX_SERVER)
+      rc = RingCentral.new('client_id', 'client_secret', RingCentral.PRODUCTION_SERVER)
       expect('client_id').to eq(rc.client_id)
       expect('client_secret').to eq(rc.client_secret)
-      expect('https://platform.devtest.ringcentral.com').to eq(rc.server)
+      expect('https://platform.ringcentral.com').to eq(rc.server)
       expect(false).to eq(rc.auto_refresh)
     end
 
     it 'test_authorize_uri' do
-      rc = RingCentral.new('client_id', 'client_secret', RingCentral.SANDBOX_SERVER)
-      expect(RingCentral.SANDBOX_SERVER + '/restapi/oauth/authorize?client_id=client_id&redirect_uri=https%3A%2F%2Fexample.com&response_type=code&state=mystate').to eq(rc.authorize_uri('https://example.com', {state: 'mystate'}))
+      rc = RingCentral.new('client_id', 'client_secret', RingCentral.PRODUCTION_SERVER)
+      expect(RingCentral.PRODUCTION_SERVER + '/restapi/oauth/authorize?client_id=client_id&redirect_uri=https%3A%2F%2Fexample.com&response_type=code&state=mystate').to eq(rc.authorize_uri('https://example.com', {state: 'mystate'}))
     end
 
     it 'test_jwt_flow' do
@@ -46,17 +47,17 @@ RSpec.describe 'RingCentral' do
       # get
       r = rc.get('/restapi/v1.0/account/~/extension/~')
       expect(r).not_to be_nil
-      expect('101').to eq(r.body['extensionNumber'])
+      expect(r.body['extensionNumber']).not_to be_nil
 
       # 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,13 +73,12 @@ RSpec.describe 'RingCentral' do
       # todo: test patch
 
       # delete
-      # 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'])
+      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

@@ -2,6 +2,8 @@ require 'ringcentral'
 require 'subscription'
 require 'dotenv'
 require 'rspec'
+require "simplecov"
+SimpleCov.start
 
 Dotenv.load
 $rc = RingCentral.new(ENV['RINGCENTRAL_CLIENT_ID'], ENV['RINGCENTRAL_CLIENT_SECRET'], ENV['RINGCENTRAL_SERVER_URL'])
@@ -15,6 +17,9 @@ RSpec.describe 'WebSocket Subscription' do
       callback.call(message)
     })
     subscription.subscribe()
+    # subscription.on_ws_closed = lambda { |event|
+    #   puts 'WebSocket closed'
+    # }
     return subscription
   end
 
@@ -31,17 +36,17 @@ RSpec.describe 'WebSocket Subscription' do
         from: {extensionId: $rc.token['owner_id']},
         text: 'Hello world'
       })
-      sleep(20)
+      sleep(10)
       expect(count).to be > 0
 
       # sleep for some time and see if the websocket is still alive
-      sleep(60)
+      sleep(20)
       $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)
+      sleep(10)
       expect(count).to be > 1
 
       sub.revoke()
@@ -57,12 +62,12 @@ 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)
+      sleep(10)
 
       expect(count).to eq(0)
       $rc.revoke()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Tyler Liu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-21 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -19,7 +19,7 @@ dependencies:
         version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.4
+        version: 2.8.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.4
+        version: 2.8.6
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: 1.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,47 +49,27 @@ dependencies:
         version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.2
-- !ruby/object:Gem::Dependency
-  name: pubnub
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.4
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.4
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +99,7 @@ dependencies:
         version: '0.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.11.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -129,7 +109,7 @@ dependencies:
         version: '0.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.11.3
 description: Ruby SDK for you to access RingCentral platform API.
 email:
 - tyler.liu@ringcentral.com
@@ -143,7 +123,6 @@ 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/websocket_subscription_spec.rb
@@ -162,9 +141,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.10
 signing_key:
@@ -173,7 +152,6 @@ 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/websocket_subscription_spec.rb

data/spec/pubnub_subscription_spec.rb

@@ -1,80 +0,0 @@
-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 '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
-
-  describe 'PubNub Subscription' do
-    it 'receives message notification' do
-      $rc.authorize(jwt: ENV['RINGCENTRAL_JWT_TOKEN'])
-      count = 0
-      createSubscription(lambda { |message|
-        count += 1
-      })
-
-      $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 be > 0
-      $rc.revoke()
-    end
-
-    it 'refresh' do
-      $rc.authorize(jwt: ENV['RINGCENTRAL_JWT_TOKEN'])
-      count = 0
-      subscription = createSubscription(lambda { |message|
-        count += 1
-      })
-
-      subscription.refresh()
-
-      $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 be > 0
-      $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