ringcentral-sdk 0.9.4 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0e9ec214fa6cb168e753cf367afc4fab5ece8a4d
-  data.tar.gz: 7618f9fca3c507b3ecf791ffb888d52bad222561
+SHA256:
+  metadata.gz: 1540372aa98b7028d885a28cc968a3348cf39c19611e2d86dbbcd67e115152bd
+  data.tar.gz: d6e4c9cbacec4d74422b2c692ac0f99e4213191e7ec47e43d5205776b1c60808
 SHA512:
-  metadata.gz: 0c120833dbf80291b4e32e14e545b40a29b3d37a53d6bc387617f0d52df9ef42b6df32dd1e4af299740207597797c62eac11474e4e5c7a03fe341ee8b706ca91
-  data.tar.gz: c6e5688b6510026d740fb31a006c2f0613b4a0fe99a3a5847a1544812bf7ddfd1153df0fd9c0d692e42fe1d1c86c79df5dbebbd299acab2f4b9e46475e73a973
+  metadata.gz: accae1e8fa5df89849746124c4f5f51587b7c9d67c4bf8498d5c726bbc541719a2b2117aa278535271cba3ddc0602b76827140a6a2bc25fec3a4fae1613eecef
+  data.tar.gz: ba5d969dabb7b891f2b22597097388e2c7a08dff9262dcd209be7bdbaa9da49c35ce18b48502fb982889c4a7a138128e79c9e2c6ecdcebbcccb41c9cc5ca8676

data/README.md

@@ -1,8 +1,6 @@
 # RingCentral SDK for Ruby
 
-[![Build Status](https://travis-ci.org/ringcentral/ringcentral-ruby.svg?branch=master)](https://travis-ci.org/ringcentral/ringcentral-ruby)
-[![Coverage Status](https://coveralls.io/repos/github/ringcentral/ringcentral-ruby/badge.svg?branch=master)](https://coveralls.io/github/ringcentral/ringcentral-ruby?branch=master)
-[![Community](https://img.shields.io/badge/dynamic/json.svg?label=community&colorB=&suffix=%20users&query=$.approximate_people_count&uri=http%3A%2F%2Fapi.getsatisfaction.com%2Fcompanies%2F102909.json)](https://devcommunity.ringcentral.com/ringcentraldev)
+[![Ruby](https://github.com/ringcentral/ringcentral-ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/ringcentral/ringcentral-ruby/actions/workflows/ruby.yml)
 [![Twitter](https://img.shields.io/twitter/follow/ringcentraldevs.svg?style=social&label=follow)](https://twitter.com/RingCentralDevs)
 
 __[RingCentral Developers](https://developer.ringcentral.com/api-products)__ is a cloud communications platform which can be accessed via more than 70 APIs. The platform's main capabilities include technologies that enable:
@@ -10,6 +8,12 @@ __[Voice](https://developer.ringcentral.com/api-products/voice), [SMS/MMS](https
 
 [API Reference](https://developer.ringcentral.com/api-docs/latest/index.html) and [APIs Explorer](https://developer.ringcentral.com/api-explorer/latest/index.html).
 
+
+## Getting help and support
+
+If you are having difficulty using this SDK, or working with the RingCentral API, please visit our [developer community forums](https://community.ringcentral.com/spaces/144/) for help and to get quick answers to your questions. If you wish to contact the RingCentral Developer Support team directly, please [submit a help ticket](https://developers.ringcentral.com/support/create-case) from our developer website.
+
+
 ## Installation
 
 ```
@@ -19,11 +23,11 @@ gem install ringcentral-sdk
 
 ### Name collision with `ringcentral` gem
 
-The ringcentral gem is using RingCentral's legacy API, everyone is recommended to move to the REST API.
+The `ringcentral` gem is using RingCentral's legacy API which was End-of-Lifed in 2018. Everyone is recommended to move to the REST API.
 
-If you have both the ringcentral and ringcentral-sdk gems installed, you will run into a collision error when attempting to initialize the ringcentral-sdk RingCentral SDK.
+If you have both the `ringcentral` and `ringcentral-sdk` gems installed, you will run into a collision error when attempting to initialize the `ringcentral-sdk` RingCentral SDK.
 
-Solution is `gem uninstall ringcentral`
+The solution is `gem uninstall ringcentral`
 
 
 ## Documentation
@@ -57,12 +61,14 @@ rc.get('/restapi/v1.0/account/~/extension', { hello: 'world' })
 ### for post, put & patch
 
 ```ruby
-rc.post('/restapi/v1.0/account/~/extension/~/sms', body, { hello: 'world' })
+rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: body, params: { hello: 'world' })
 ```
 
 ### multi-value query parameter
 
+```ruby
 rc.get('/restapi/v1.0/account/~/extension', { hello: ['world1', 'world2'] })
+```
 
 Above will be translated to `/restapi/v1.0/account/~/extension?hello=world1&hello=world2`.
 
@@ -79,7 +85,13 @@ Let's say you already have a token. Then you can load it like this: `rc.token =
 
 The benifits of loading a preexisting token is you don't need to go through any authorization flow.
 
-If what you have is a string instead of a Ruby object, you need to convert it first: `JSON.parse(your_token_string)`.
+If what you have is a JSON string instead of a Ruby object, you need to convert it first: `JSON.parse(your_token_string)`.
+
+If you only have a string for the access token instead of for the whole object, you can set it like this:
+
+```ruby
+rc.token = { access_token: 'the token string' }
+```
 
 
 ### Send SMS

data/lib/ringcentral.rb

@@ -45,13 +45,21 @@ class RingCentral
     end
   end
 
-  def authorize(username: nil, extension: nil, password: nil, auth_code: nil, redirect_uri: nil)
+  def authorize(username: nil, extension: nil, password: nil, auth_code: nil, redirect_uri: nil, jwt: nil, verifier: nil)
     if auth_code != nil
       payload = {
         grant_type: 'authorization_code',
         code: auth_code,
         redirect_uri: redirect_uri,
       }
+      if verifier != nil
+        payload["code_verifier"] = verifier
+      end
+    elsif jwt != nil
+      payload = {
+        grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
+        assertion: jwt
+      }
     else
       payload = {
         grant_type: 'password',
@@ -83,7 +91,7 @@ class RingCentral
     self.post('/restapi/oauth/revoke', payload: payload)
   end
 
-  def authorize_uri(redirect_uri, state = '')
+  def authorize_uri(redirect_uri, state = '', challenge = nil, challenge_method = 'S256')
     uri = Addressable::URI.parse(@server) + '/restapi/oauth/authorize'
     uri.query_values = {
       response_type: 'code',
@@ -91,6 +99,10 @@ class RingCentral
       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.to_s
   end
 

data/lib/subscription.rb

@@ -2,6 +2,7 @@ require 'pubnub'
 require 'concurrent'
 require 'openssl'
 require 'base64'
+require 'securerandom'
 
 class PubNub
   attr_accessor :events
@@ -48,7 +49,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'])
+    @pubnub = Pubnub.new(subscribe_key: @subscription['deliveryMode']['subscriberKey'], uuid: SecureRandom.uuid)
     @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.4'
+  gem.version       = '0.9.6'
   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.6', '>= 2.6.0')
-  gem.add_dependency('concurrent-ruby', '~> 1.1', '>= 1.1.5')
-  gem.add_dependency('pubnub', '~> 4.1', '>= 4.1.2')
-  gem.add_dependency('faraday', '~> 0.15', '>= 0.15.4')
-  gem.add_dependency('faraday_middleware', '~> 0.13', '>= 0.13.1')
+  gem.add_dependency('addressable', '~> 2.8', '>= 2.8.0')
+  gem.add_dependency('concurrent-ruby', '~> 1.1', '>= 1.1.9')
+  gem.add_dependency('pubnub', '~> 5.0', '>= 5.0.0')
+  gem.add_dependency('faraday', '~> 2.1', '>= 2.1.0')
+  gem.add_dependency('faraday_middleware', '~> 1.2.0', '>= 1.2.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-sdk
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.6
 platform: ruby
 authors:
 - Tyler Liu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.1.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,67 +49,67 @@ dependencies:
         version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.1.9
 - !ruby/object:Gem::Dependency
   name: pubnub
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 1.2.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 1.2.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 1.2.0
 description: Ruby SDK for you to access RingCentral platform API.
 email:
 - tyler.liu@ringcentral.com
@@ -131,7 +131,7 @@ homepage: https://github.com/ringcentral/ringcentral-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,15 +146,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: RingCentral Ruby SDK.
 test_files:
-- spec/spec_helper.rb
-- spec/ringcentral_spec.rb
-- spec/mms_spec.rb
 - spec/fax_spec.rb
-- spec/subscription_spec.rb
+- spec/mms_spec.rb
 - spec/query_params_spec.rb
+- spec/ringcentral_spec.rb
+- spec/spec_helper.rb
+- spec/subscription_spec.rb