ringcentral-sdk 0.9.7 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0def40f14858640a19c34e45ff4ff317dfaf49ad9982973caa3d11c837352b94
-  data.tar.gz: 838af02960f7b0f797d9d4c84df5f386d8c68f635e69d2256fe2e45147e4d48b
+  metadata.gz: 0c82aa5b359e0d18f0096e856d81cebb7c00990208cc210a217d49d470ee19eb
+  data.tar.gz: 5a4f3973076393c86fa95ea47aa7b467c0b01abd3c46fcd819a5c976ab625717
 SHA512:
-  metadata.gz: 649477f3d68de34a1211b6ea467bcf220fa1e8d17931fa96eb9f752dd0314878a4d3ba5843a6039644441d1abcea4f2c8616ab646c7a0e713c639e657a8ca1e2
-  data.tar.gz: 5abfbfb09b56b5f8f0dc913e39a56d36bcc48d4cd3affdaeab64428049b2918ae4de79f1f6e0ebf4f01a53a012ff8c03247dbb29e67b82cb4bac70da19ae3742
+  metadata.gz: 1cd78622b101fbf1ef52b717af4ea587fdf98517613d9de858f432c3954e89c4c8393a16f67a43bfa29fe938d2711970200133ad9fc7362307b214d0a807f094
+  data.tar.gz: 9a98212a1550ee2cd269d8b935fb25115f31f9ece0609498e6a5fa2efd701107da6e3ed58a48fb266e118934e85b8ded88860529f93c13142ea2d87cb315e94b

data/README.md

@@ -41,7 +41,7 @@ https://developer.ringcentral.com/api-docs/latest/index.html
 require 'ringcentral'
 
 rc = RingCentral.new('clientID', 'clientSecret', 'serverURL')
-rc.authorize(username: 'username', extension: 'extension', password: 'password')
+rc.authorize(jwt: 'jwt-token')
 
 # get
 r = rc.get('/restapi/v1.0/account/~/extension/~')
@@ -82,8 +82,7 @@ If you want the SDK to do auto refresh please `rc.auto_refresh = true` before au
 ### Load preexisting token
 
 Let's say you already have a token. Then you can load it like this: `rc.token = your_token_object`.
-
-The benifits of loading a preexisting token is you don't need to go through any authorization flow.
+The benefit of loading a preexisting token is you don't need to go through any authorization flow.
 
 If what you have is a JSON string instead of a Ruby object, you need to convert it first: `JSON.parse(your_token_string)`.
 
@@ -99,7 +98,7 @@ rc.token = { access_token: 'the token string' }
 ```ruby
 r = rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
     to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
-    from: {phoneNumber: ENV['RINGCENTRAL_USERNAME']},
+    from: {phoneNumber: ENV['RINGCENTRAL_SENDER']},
     text: 'Hello world'
 })
 ```
@@ -124,7 +123,7 @@ payload: { to: [{ phoneNumber: ENV['RINGCENTRAL_RECEIVER'] }] },
 r = rc.post('/restapi/v1.0/account/~/extension/~/sms',
     payload: {
         to: [{ phoneNumber: ENV['RINGCENTRAL_RECEIVER'] }],
-        from: { phoneNumber: ENV['RINGCENTRAL_USERNAME'] },
+        from: { phoneNumber: ENV['RINGCENTRAL_SENDER'] },
         text: 'hello world'
     },
     files: [
@@ -154,7 +153,7 @@ createSubscription(lambda { |message|
 ```
 
 
-For more sample code, please refer to the [test cases](/spec).
+For more sample codes, please refer to the [test cases](/spec).
 
 
 ## How to test
@@ -163,17 +162,9 @@ For more sample code, please refer to the [test cases](/spec).
 bundle install --path vendor/bundle
 ```
 
-Create `.env` file with the following content:
+Rename `.env.sample` to `.env`.
 
-```
-RINGCENTRAL_SERVER_URL=https://platform.devtest.ringcentral.com
-RINGCENTRAL_CLIENT_ID=
-RINGCENTRAL_CLIENT_SECRET=
-RINGCENTRAL_USERNAME=
-RINGCENTRAL_EXTENSION=
-RINGCENTRAL_PASSWORD=
-RINGCENTRAL_RECEIVER=
-```
+Edit `.env` file to specify credentials.
 
 `RINGCENTRAL_RECEIVER` is a phone number to receive SMS, Fax..etc.
 
@@ -183,8 +174,3 @@ Run `bundle exec rspec`
 ## License
 
 MIT
-
-
-## Todo
-
-- Batch requests

data/lib/ringcentral.rb

@@ -16,13 +16,14 @@ class RingCentral
   end
 
   attr_reader :client_id, :client_secret, :server, :token
-  attr_accessor :auto_refresh
+  attr_accessor :auto_refresh, :debug_mode
 
-  def initialize(client_id, client_secret, server)
+  def initialize(client_id, client_secret, server, debug_mode = false)
     @client_id = client_id
     @client_secret = client_secret
     @server = server
     @auto_refresh = false
+    @debug_mode = debug_mode
     @token = nil
     @timer = nil
     @faraday = Faraday.new(url: server, request: { params_encoder: Faraday::FlatParamsEncoder }) do |faraday|
@@ -91,31 +92,36 @@ class RingCentral
     self.post('/restapi/oauth/revoke', payload: payload)
   end
 
-  def authorize_uri(redirect_uri, state = '', challenge = nil, challenge_method = 'S256')
+  def authorize_uri(redirect_uri, hash = {})
+    hash[:response_type] = 'code'
+    hash[:redirect_uri] = redirect_uri
+    hash[:client_id] = @client_id
     uri = Addressable::URI.parse(@server) + '/restapi/oauth/authorize'
-    uri.query_values = {
-      response_type: 'code',
-      state: state,
-      redirect_uri: redirect_uri,
-      client_id: @client_id
-    }
-    if challenge != nil
-      uri.query_values["code_challenge"] = challenge
-      uri.query_values["code_challenge_method"] = challenge_method
-    end
+    uri.query_values = hash
     uri.to_s
   end
 
   def get(endpoint, params = {})
-    @faraday.get do |req|
+    r = @faraday.get do |req|
       req.url endpoint
       req.params = params
       req.headers = headers
     end
+    if @debug_mode
+      puts r.status, r.body
+    end
+    if r.status >= 400
+      raise "HTTP status #{r.status}: 
+
+headers: #{r.headers}
+
+body: #{r.body}"
+    end
+    return r
   end
 
   def post(endpoint, payload: nil, params: {}, files: nil)
-    @faraday.post do |req|
+    r = @faraday.post do |req|
       req.url endpoint
       req.params = params
       if files != nil && files.size > 0 # send fax or MMS
@@ -133,32 +139,76 @@ class RingCentral
         req.body = payload
       end
     end
+    if @debug_mode
+      puts r.status, r.body
+    end
+    if r.status >= 400
+      raise "HTTP status #{r.status}: 
+
+headers: #{r.headers}
+
+body: #{r.body}"
+    end
+    return r
   end
 
   def put(endpoint, payload: nil, params: {}, files: nil)
-    @faraday.put do |req|
+    r = @faraday.put do |req|
       req.url endpoint
       req.params = params
       req.headers = headers.merge({ 'Content-Type': 'application/json' })
       req.body = payload.to_json
     end
+    if @debug_mode
+      puts r.status, r.body
+    end
+    if r.status >= 400
+      raise "HTTP status #{r.status}: 
+
+headers: #{r.headers}
+
+body: #{r.body}"
+    end
+    return r
   end
 
   def patch(endpoint, payload: nil, params: {}, files: nil)
-    @faraday.patch do |req|
+    r = @faraday.patch do |req|
       req.url endpoint
       req.params = params
       req.headers = headers.merge({ 'Content-Type': 'application/json' })
       req.body = payload.to_json
     end
+    if @debug_mode
+      puts r.status, r.body
+    end
+    if r.status >= 400
+      raise "HTTP status #{r.status}: 
+
+headers: #{r.headers}
+
+body: #{r.body}"
+    end
+    return r
   end
 
   def delete(endpoint, params = {})
-    @faraday.delete do |req|
+    r = @faraday.delete do |req|
       req.url endpoint
       req.params = params
       req.headers = headers
     end
+    if @debug_mode
+      puts r.status, r.body
+    end
+    if r.status >= 400
+      raise "HTTP status #{r.status}: 
+
+headers: #{r.headers}
+
+body: #{r.body}"
+    end
+    return r
   end
 
   private
@@ -175,8 +225,7 @@ class RingCentral
       user_agent_header = "ringcentral/ringcentral-ruby Ruby #{RUBY_VERSION} #{RUBY_PLATFORM}"
       {
         'Authorization': autorization_header,
-        'RC-User-Agent': user_agent_header,
-        'User-Agent': user_agent_header,
+        'X-User-Agent': user_agent_header,
       }
     end
 end

data/lib/subscription.rb

@@ -2,7 +2,6 @@ require 'pubnub'
 require 'concurrent'
 require 'openssl'
 require 'base64'
-require 'securerandom'
 
 class PubNub
   attr_accessor :events
@@ -39,7 +38,7 @@ class PubNub
       @timer = nil
     end
     if value != nil
-      @timer = Concurrent::TimerTask.new(execution_interval: value['expiresIn'] - 120, timeout_interval: 60) do
+      @timer = Concurrent::TimerTask.new(execution_interval: value['expiresIn'] - 120) do
         self.refresh
       end
       @timer.execute
@@ -49,7 +48,7 @@ class PubNub
   def subscribe
     r = @rc.post('/restapi/v1.0/subscription', payload: request_body)
     self.subscription = r.body
-    @pubnub = Pubnub.new(subscribe_key: @subscription['deliveryMode']['subscriberKey'], uuid: SecureRandom.uuid)
+    @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

data/ringcentral-sdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = 'ringcentral-sdk'
-  gem.version       = '0.9.7'
+  gem.version       = '0.9.9'
   gem.authors       = ['Tyler Liu']
   gem.email         = ['tyler.liu@ringcentral.com']
   gem.description   = 'Ruby SDK for you to access RingCentral platform API.'
@@ -13,9 +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.0')
-  gem.add_dependency('concurrent-ruby', '~> 1.1', '>= 1.1.10')
-  gem.add_dependency('pubnub', '~> 5.0', '>= 5.0.0')
-  gem.add_dependency('faraday', '~> 2.3', '>= 2.3.0')
+  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('faraday-multipart', '~> 1.0', '>= 1.0.4')
 end

data/spec/fax_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe 'Fax' do
     it 'should send a fax' do
       Dotenv.load
       rc = RingCentral.new(ENV['RINGCENTRAL_CLIENT_ID'], ENV['RINGCENTRAL_CLIENT_SECRET'], ENV['RINGCENTRAL_SERVER_URL'])
-      rc.authorize(username: ENV['RINGCENTRAL_USERNAME'], extension: ENV['RINGCENTRAL_EXTENSION'], password: ENV['RINGCENTRAL_PASSWORD'])
+      rc.authorize(jwt: ENV['RINGCENTRAL_JWT_TOKEN'])
       r = rc.post('/restapi/v1.0/account/~/extension/~/fax',
         payload: { to: [{ phoneNumber: ENV['RINGCENTRAL_RECEIVER'] }] },
         files: [
@@ -17,6 +17,8 @@ RSpec.describe 'Fax' do
       expect(r).not_to be_nil
       message = r.body
       expect('Fax').to eq(message['type'])
+
+      rc.revoke()
     end
   end
 end

data/spec/mms_spec.rb

@@ -6,12 +6,12 @@ RSpec.describe 'MMS' do
     it 'should send an MMS' do
       Dotenv.load
       rc = RingCentral.new(ENV['RINGCENTRAL_CLIENT_ID'], ENV['RINGCENTRAL_CLIENT_SECRET'], ENV['RINGCENTRAL_SERVER_URL'])
-      rc.authorize(username: ENV['RINGCENTRAL_USERNAME'], extension: ENV['RINGCENTRAL_EXTENSION'], password: ENV['RINGCENTRAL_PASSWORD'])
+      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_USERNAME'] },
+          from: { phoneNumber: ENV['RINGCENTRAL_SENDER'] },
           text: 'hello world'
         },
         files: [
@@ -21,6 +21,8 @@ RSpec.describe 'MMS' do
       expect(r).not_to be_nil
       message = r.body
       expect('SMS').to eq(message['type'])
+
+      rc.revoke()
     end
   end
 end

data/spec/query_params_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe 'query params' do
     it 'contain single query param' do
       Dotenv.load
       rc = RingCentral.new(ENV['RINGCENTRAL_CLIENT_ID'], ENV['RINGCENTRAL_CLIENT_SECRET'], ENV['RINGCENTRAL_SERVER_URL'])
-      rc.authorize(username: ENV['RINGCENTRAL_USERNAME'], extension: ENV['RINGCENTRAL_EXTENSION'], password: ENV['RINGCENTRAL_PASSWORD'])
+      rc.authorize(jwt: ENV['RINGCENTRAL_JWT_TOKEN'])
       r = rc.get('/restapi/v1.0/account/~/extension/~/address-book/contact', { phoneNumber: '666' })
       expect(r).not_to be_nil
       message = r.body
@@ -16,6 +16,7 @@ RSpec.describe 'query params' do
       expect(r).not_to be_nil
       message = r.body
       expect(message['uri']).to include('phoneNumber=666&phoneNumber=888')
+
       rc.revoke()
     end
   end

data/spec/ringcentral_spec.rb

@@ -17,16 +17,16 @@ RSpec.describe 'RingCentral' do
 
     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', 'mystate'))
+      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'}))
     end
 
-    it 'test_password_flow' do
+    it 'test_jwt_flow' do
       Dotenv.load
       rc = RingCentral.new(ENV['RINGCENTRAL_CLIENT_ID'], ENV['RINGCENTRAL_CLIENT_SECRET'], ENV['RINGCENTRAL_SERVER_URL'])
       expect(rc.token).to be_nil
 
       # create token
-      rc.authorize(username: ENV['RINGCENTRAL_USERNAME'], extension: ENV['RINGCENTRAL_EXTENSION'], password: ENV['RINGCENTRAL_PASSWORD'])
+      rc.authorize(jwt: ENV['RINGCENTRAL_JWT_TOKEN'])
       expect(rc.token).not_to be_nil
 
       # refresh token
@@ -41,7 +41,7 @@ RSpec.describe 'RingCentral' do
     it 'test_http_methods' do
       Dotenv.load
       rc = RingCentral.new(ENV['RINGCENTRAL_CLIENT_ID'], ENV['RINGCENTRAL_CLIENT_SECRET'], ENV['RINGCENTRAL_SERVER_URL'])
-      rc.authorize(username: ENV['RINGCENTRAL_USERNAME'], extension: ENV['RINGCENTRAL_EXTENSION'], password: ENV['RINGCENTRAL_PASSWORD'])
+      rc.authorize(jwt: ENV['RINGCENTRAL_JWT_TOKEN'])
 
       # get
       r = rc.get('/restapi/v1.0/account/~/extension/~')
@@ -51,7 +51,7 @@ RSpec.describe 'RingCentral' do
       # post
       r = rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
         to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
-        from: {phoneNumber: ENV['RINGCENTRAL_USERNAME']},
+        from: {phoneNumber: ENV['RINGCENTRAL_SENDER']},
         text: 'Hello world'
       })
       expect(r).not_to be_nil
@@ -78,6 +78,8 @@ RSpec.describe 'RingCentral' do
       expect(r).not_to be_nil
       message = r.body
       expect('Deleted').to eq(message['availability'])
+
+      rc.revoke()
     end
   end
 end

data/spec/subscription_spec.rb

@@ -5,7 +5,7 @@ require 'rspec'
 
 Dotenv.load
 $rc = RingCentral.new(ENV['RINGCENTRAL_CLIENT_ID'], ENV['RINGCENTRAL_CLIENT_SECRET'], ENV['RINGCENTRAL_SERVER_URL'])
-$rc.authorize(username: ENV['RINGCENTRAL_USERNAME'], extension: ENV['RINGCENTRAL_EXTENSION'], password: ENV['RINGCENTRAL_PASSWORD'])
+
 
 def createSubscription(callback)
   events = [
@@ -21,6 +21,7 @@ end
 RSpec.describe 'Subscription' do
   describe 'subscription' do
     it 'receives message notification' do
+      $rc.authorize(jwt: ENV['RINGCENTRAL_JWT_TOKEN'])
       count = 0
       createSubscription(lambda { |message|
         count += 1
@@ -28,15 +29,17 @@ RSpec.describe 'Subscription' do
 
       $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
         to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
-        from: {phoneNumber: ENV['RINGCENTRAL_USERNAME']},
+        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
@@ -46,15 +49,17 @@ RSpec.describe 'Subscription' do
 
       $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
         to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
-        from: {phoneNumber: ENV['RINGCENTRAL_USERNAME']},
+        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
@@ -64,12 +69,13 @@ RSpec.describe 'Subscription' do
 
       $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
         to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
-        from: {phoneNumber: ENV['RINGCENTRAL_USERNAME']},
+        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.7
+  version: 0.9.9
 platform: ruby
 authors:
 - Tyler Liu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-02 00:00:00.000000000 Z
+date: 2023-05-05 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.0
+        version: 2.8.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,67 +29,67 @@ dependencies:
         version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.8.4
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: pubnub
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.2.2
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.7.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.7.4
 - !ruby/object:Gem::Dependency
   name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: RingCentral Ruby SDK.