ringcentral-sdk 0.9.2 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ecc70101c8a49551105f83e593be979fe25a2ab7
-  data.tar.gz: 22981b9c0d649af8da86ef9de9d6f507fb82ceac
+SHA256:
+  metadata.gz: 0def40f14858640a19c34e45ff4ff317dfaf49ad9982973caa3d11c837352b94
+  data.tar.gz: 838af02960f7b0f797d9d4c84df5f386d8c68f635e69d2256fe2e45147e4d48b
 SHA512:
-  metadata.gz: 052b9067500e5b0d781b3b026ba4670496b27e7fdc3ec8ca532f92869350978104cc7535089d79c6588afac7e844ad03543087ee37b695382046ebcdb77f6610
-  data.tar.gz: de0b01dff34151dba3ce24c4edc79cf6cf6103707d77b1a767808c79f5380dc1f433763a20df574f04689add934cce619ac80e8e7124e8eff72fe01ec7ebe25b
+  metadata.gz: 649477f3d68de34a1211b6ea467bcf220fa1e8d17931fa96eb9f752dd0314878a4d3ba5843a6039644441d1abcea4f2c8616ab646c7a0e713c639e657a8ca1e2
+  data.tar.gz: 5abfbfb09b56b5f8f0dc913e39a56d36bcc48d4cd3affdaeab64428049b2918ae4de79f1f6e0ebf4f01a53a012ff8c03247dbb29e67b82cb4bac70da19ae3742

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
@@ -46,6 +50,29 @@ expect('101').to eq(r.body['extensionNumber'])
 ```
 
 
+## How to specify query parameters
+
+### for get & delete
+
+```ruby
+rc.get('/restapi/v1.0/account/~/extension', { hello: 'world' })
+```
+
+### for post, put & patch
+
+```ruby
+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`.
+
+
 ### Token Refresh
 
 Access token expires. You need to call `rc.refresh()` before it expires.
@@ -58,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

@@ -3,7 +3,7 @@ require 'addressable/uri'
 require 'json'
 require 'concurrent'
 require 'faraday'
-require 'faraday_middleware'
+require 'faraday/multipart'
 require 'tmpdir'
 
 class RingCentral
@@ -25,10 +25,10 @@ class RingCentral
     @auto_refresh = false
     @token = nil
     @timer = nil
-    @faraday = Faraday.new(url: server) do |faraday|
+    @faraday = Faraday.new(url: server, request: { params_encoder: Faraday::FlatParamsEncoder }) do |faraday|
       faraday.request :multipart
       faraday.request :url_encoded
-      faraday.response :json, :content_type => /\bjson$/
+      faraday.response :json, content_type: /\bjson$/
       faraday.adapter Faraday.default_adapter
     end
   end
@@ -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.2'
+  gem.version       = '0.9.7'
   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.10')
+  gem.add_dependency('pubnub', '~> 5.0', '>= 5.0.0')
+  gem.add_dependency('faraday', '~> 2.3', '>= 2.3.0')
+  gem.add_dependency('faraday-multipart', '~> 1.0', '>= 1.0.4')
 end

data/spec/query_params_spec.rb

@@ -0,0 +1,22 @@
+require 'dotenv'
+require 'ringcentral'
+
+RSpec.describe 'query params' do
+  describe 'single' 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'])
+      r = rc.get('/restapi/v1.0/account/~/extension/~/address-book/contact', { phoneNumber: '666' })
+      expect(r).not_to be_nil
+      message = r.body
+      expect(message['uri']).to include('phoneNumber=666')
+
+      r = rc.get('/restapi/v1.0/account/~/extension/~/address-book/contact', { phoneNumber: ['666', '888'] })
+      expect(r).not_to be_nil
+      message = r.body
+      expect(message['uri']).to include('phoneNumber=666&phoneNumber=888')
+      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.2
+  version: 0.9.7
 platform: ruby
 authors:
 - Tyler Liu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2022-07-02 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.10
   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.10
 - !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.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '2.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 1.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 1.0.4
 description: Ruby SDK for you to access RingCentral platform API.
 email:
 - tyler.liu@ringcentral.com
@@ -123,14 +123,14 @@ files:
 - ringcentral-sdk.gemspec
 - spec/fax_spec.rb
 - spec/mms_spec.rb
+- spec/query_params_spec.rb
 - spec/ringcentral_spec.rb
-- spec/spec_helper.rb
 - spec/subscription_spec.rb
 homepage: https://github.com/ringcentral/ringcentral-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -145,14 +145,13 @@ 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/mms_spec.rb
+- spec/query_params_spec.rb
+- spec/ringcentral_spec.rb
 - spec/subscription_spec.rb

data/spec/spec_helper.rb

@@ -1,7 +0,0 @@
-RSpec.configure do |config|
-  require 'simplecov'
-  SimpleCov.start
-
-  require 'coveralls'
-  Coveralls.wear!
-end