ringcentral-sdk 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d48fd9aeb0ce08172f73e2922121f31713cbd626
-  data.tar.gz: 5ae74b326aed1c61ba8a98745174a3a7d19eb2dc
+SHA256:
+  metadata.gz: 06ddfd78c12b59f0671d7e1972591f42b0c8ec3f840e99ae99ae4c91aa729640
+  data.tar.gz: 8f9db936652f2e3f26617d82d2384e7f70f34545c4cfb46ce0b92279d5f3d6f4
 SHA512:
-  metadata.gz: d2cfe606abaa3f47c4b1b745f15eb1ce7bc2f00258ccf31aca1ab16210aba4de87488df119646eee6b6183bf19bf18ade336fd626e5125606eed2c716b4e260d
-  data.tar.gz: e669a6ba874cf06b7190300fdeb6b23102d820801370644470619c8d1d73e1b6591370465e56eb3d54e958d4d887682952aee99bedc697ce25925cb9770cdef5
+  metadata.gz: 1949bd7acb065a8bff3414deca51cbb466f3f68bd75a956079aed13ebba9721b395a1282e84c6f7b4de7157eb00cb1eee3d53ca2c37167e435e3e598b0370e6a
+  data.tar.gz: 8a45c38e893069f78000d3a3dba132257cd7f6626fddb803fd0fd640ff784d8962ecc05035e92cf1cca0e124622fa13f7c5422af10a0774bc6bb3d13c8a05cde

data/README.md

@@ -13,6 +13,15 @@ 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.
+
+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`
+
+
 ## Documentation
 
 https://developer.ringcentral.com/api-docs/latest/index.html
@@ -23,19 +32,19 @@ https://developer.ringcentral.com/api-docs/latest/index.html
 ```ruby
 require 'ringcentral'
 
-rc = RingCentral.new(ENV['clientId'], ENV['clientSecret'], ENV['server'])
-rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+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'])
 
 # get
 r = rc.get('/restapi/v1.0/account/~/extension/~')
 expect(r).not_to be_nil
-expect('101').to eq(JSON.parse(r.body)['extensionNumber'])
+expect('101').to eq(r.body['extensionNumber'])
 ```
 
 
 ### Token Refresh
 
-Access token expires. You need to call `rc.refresh()` before it expores.
+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.
 
 
@@ -43,8 +52,8 @@ If you want the SDK to do auto refresh please `rc.auto_refresh = true` before au
 
 ```ruby
 r = rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
-    to: [{phoneNumber: ENV['receiver']}],
-    from: {phoneNumber: ENV['username']},
+    to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
+    from: {phoneNumber: ENV['RINGCENTRAL_USERNAME']},
     text: 'Hello world'
 })
 ```
@@ -54,7 +63,7 @@ r = rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
 
 ```ruby
 rc.post('/restapi/v1.0/account/~/extension/~/fax',
-payload: { to: [{ phoneNumber: ENV['receiver'] }] },
+payload: { to: [{ phoneNumber: ENV['RINGCENTRAL_RECEIVER'] }] },
     files: [
         ['spec/test.txt', 'text/plain'],
         ['spec/test.png', 'image/png']
@@ -68,8 +77,8 @@ payload: { to: [{ phoneNumber: ENV['receiver'] }] },
 ```ruby
 r = rc.post('/restapi/v1.0/account/~/extension/~/sms',
     payload: {
-        to: [{ phoneNumber: ENV['receiver'] }],
-        from: { phoneNumber: ENV['username'] },
+        to: [{ phoneNumber: ENV['RINGCENTRAL_RECEIVER'] }],
+        from: { phoneNumber: ENV['RINGCENTRAL_USERNAME'] },
         text: 'hello world'
     },
     files: [
@@ -107,16 +116,17 @@ For more sample code, please refer to the [test cases](/spec).
 Create `.env` file with the following content:
 
 ```
-production=false
-server=https://platform.devtest.ringcentral.com
-clientId=clientId
-clientSecret=clientSecret
-username=username
-extension=extension
-password=password
-receiver=number-to-receiver-sms
+RINGCENTRAL_SERVER_URL=https://platform.devtest.ringcentral.com
+RINGCENTRAL_CLIENT_ID=
+RINGCENTRAL_CLIENT_SECRET=
+RINGCENTRAL_USERNAME=
+RINGCENTRAL_EXTENSION=
+RINGCENTRAL_PASSWORD=
+RINGCENTRAL_RECEIVER=
 ```
 
+`RINGCENTRAL_RECEIVER` is a phone number to receive SMS, Fax..etc.
+
 Run `rspec`
 
 

data/lib/ringcentral.rb

@@ -3,6 +3,7 @@ require 'addressable/uri'
 require 'json'
 require 'concurrent'
 require 'faraday'
+require 'faraday_middleware'
 require 'tmpdir'
 
 class RingCentral
@@ -14,12 +15,12 @@ class RingCentral
     'https://platform.ringcentral.com'
   end
 
-  attr_reader :app_key, :app_secret, :server, :token
+  attr_reader :client_id, :client_secret, :server, :token
   attr_accessor :auto_refresh
 
-  def initialize(app_key, app_secret, server)
-    @app_key = app_key
-    @app_secret = app_secret
+  def initialize(client_id, client_secret, server)
+    @client_id = client_id
+    @client_secret = client_secret
     @server = server
     @auto_refresh = false
     @token = nil
@@ -27,6 +28,7 @@ class RingCentral
     @faraday = Faraday.new(url: server) do |faraday|
       faraday.request :multipart
       faraday.request :url_encoded
+      faraday.response :json, :content_type => /\bjson$/
       faraday.adapter Faraday.default_adapter
     end
   end
@@ -60,7 +62,7 @@ class RingCentral
     end
     self.token = nil
     r = self.post('/restapi/oauth/token', payload: payload)
-    self.token = JSON.parse(r.body)
+    self.token = r.body
   end
 
   def refresh
@@ -71,7 +73,7 @@ class RingCentral
     }
     self.token = nil
     r = self.post('/restapi/oauth/token', payload: payload)
-    self.token = JSON.parse(r.body)
+    self.token = r.body
   end
 
   def revoke
@@ -87,7 +89,7 @@ class RingCentral
       response_type: 'code',
       state: state,
       redirect_uri: redirect_uri,
-      client_id: @app_key
+      client_id: @client_id
     }
     uri.to_s
   end
@@ -150,7 +152,7 @@ class RingCentral
   private
 
     def basic_key
-      Base64.encode64("#{@app_key}:#{@app_secret}").gsub(/\s/, '')
+      Base64.encode64("#{@client_id}:#{@client_secret}").gsub(/\s/, '')
     end
 
     def autorization_header

data/lib/subscription.rb

@@ -47,7 +47,7 @@ class PubNub
 
   def subscribe
     r = @rc.post('/restapi/v1.0/subscription', payload: request_body)
-    self.subscription = JSON.parse(r.body)
+    self.subscription = r.body
     @pubnub = Pubnub.new(subscribe_key: @subscription['deliveryMode']['subscriberKey'])
     @pubnub.add_listener(name: 'default', callback: @callback)
     @pubnub.subscribe(channels: @subscription['deliveryMode']['address'])
@@ -56,7 +56,7 @@ class PubNub
   def refresh
     return if @subscription == nil
     r = @rc.put("/restapi/v1.0/subscription/#{@subscription['id']}", payload: request_body)
-    self.subscription = JSON.parse(r.body)
+    self.subscription = r.body
   end
 
   def revoke

data/ringcentral-sdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = 'ringcentral-sdk'
-  gem.version       = '0.8.2'
+  gem.version       = '0.9.0'
   gem.authors       = ['Tyler Liu']
   gem.email         = ['tyler.liu@ringcentral.com']
   gem.description   = 'Ruby SDK for you to access RingCentral platform API.'
@@ -17,4 +17,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency('concurrent-ruby', '~> 1.0', '>= 1.0.2')
   gem.add_dependency('pubnub', '~> 4.0', '>= 4.0.27')
   gem.add_dependency('faraday', '~> 0.10', '>= 0.10.0')
+  gem.add_dependency('faraday_middleware', '~> 0.12', '>= 0.12.2')
 end

data/spec/fax_spec.rb

@@ -5,17 +5,17 @@ RSpec.describe 'Fax' do
   describe 'send fax' do
     it 'should send a fax' do
       Dotenv.load
-      rc = RingCentral.new(ENV['clientId'], ENV['clientSecret'], ENV['server'])
-      rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+      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.post('/restapi/v1.0/account/~/extension/~/fax',
-        payload: { to: [{ phoneNumber: ENV['receiver'] }] },
+        payload: { to: [{ phoneNumber: ENV['RINGCENTRAL_RECEIVER'] }] },
         files: [
           ['spec/test.txt', 'text/plain'],
           ['spec/test.png', 'image/png']
         ]
       )
       expect(r).not_to be_nil
-      message = JSON.parse(r.body)
+      message = r.body
       expect('Fax').to eq(message['type'])
     end
   end

data/spec/mms_spec.rb

@@ -5,13 +5,13 @@ RSpec.describe 'MMS' do
   describe 'send MMS' do
     it 'should send an MMS' do
       Dotenv.load
-      rc = RingCentral.new(ENV['clientId'], ENV['clientSecret'], ENV['server'])
-      rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+      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.post('/restapi/v1.0/account/~/extension/~/sms',
         payload: {
-          to: [{ phoneNumber: ENV['receiver'] }],
-          from: { phoneNumber: ENV['username'] },
+          to: [{ phoneNumber: ENV['RINGCENTRAL_RECEIVER'] }],
+          from: { phoneNumber: ENV['RINGCENTRAL_USERNAME'] },
           text: 'hello world'
         },
         files: [
@@ -19,7 +19,7 @@ RSpec.describe 'MMS' do
         ]
       )
       expect(r).not_to be_nil
-      message = JSON.parse(r.body)
+      message = r.body
       expect('SMS').to eq(message['type'])
     end
   end

data/spec/ringcentral_spec.rb

@@ -8,25 +8,25 @@ RSpec.describe 'RingCentral' do
     end
 
     it 'test_initializer' do
-      rc = RingCentral.new('app_key', 'app_secret', RingCentral.SANDBOX_SERVER)
-      expect('app_key').to eq(rc.app_key)
-      expect('app_secret').to eq(rc.app_secret)
+      rc = RingCentral.new('client_id', 'client_secret', RingCentral.SANDBOX_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(false).to eq(rc.auto_refresh)
     end
 
     it 'test_authorize_uri' do
-      rc = RingCentral.new('app_key', 'app_secret', RingCentral.SANDBOX_SERVER)
-      expect(RingCentral.SANDBOX_SERVER + '/restapi/oauth/authorize?client_id=app_key&redirect_uri=https%3A%2F%2Fexample.com&response_type=code&state=mystate').to eq(rc.authorize_uri('https://example.com', 'mystate'))
+      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'))
     end
 
     it 'test_password_flow' do
       Dotenv.load
-      rc = RingCentral.new(ENV['clientId'], ENV['clientSecret'], ENV['server'])
+      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['username'], extension: ENV['extension'], password: ENV['password'])
+      rc.authorize(username: ENV['RINGCENTRAL_USERNAME'], extension: ENV['RINGCENTRAL_EXTENSION'], password: ENV['RINGCENTRAL_PASSWORD'])
       expect(rc.token).not_to be_nil
 
       # refresh token
@@ -40,33 +40,33 @@ RSpec.describe 'RingCentral' do
 
     it 'test_http_methods' do
       Dotenv.load
-      rc = RingCentral.new(ENV['clientId'], ENV['clientSecret'], ENV['server'])
-      rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+      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'])
 
       # get
       r = rc.get('/restapi/v1.0/account/~/extension/~')
       expect(r).not_to be_nil
-      expect('101').to eq(JSON.parse(r.body)['extensionNumber'])
+      expect('101').to eq(r.body['extensionNumber'])
 
       # post
       r = rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
-        to: [{phoneNumber: ENV['receiver']}],
-        from: {phoneNumber: ENV['username']},
+        to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
+        from: {phoneNumber: ENV['RINGCENTRAL_USERNAME']},
         text: 'Hello world'
       })
       expect(r).not_to be_nil
-      message = JSON.parse(r.body)
+      message = r.body
       expect('SMS').to eq(message['type'])
       messageUrl = "/restapi/v1.0/account/~/extension/~/message-store/#{message['id']}"
 
       # put
       r = rc.put(messageUrl, payload: { readStatus: 'Unread' })
       expect(r).not_to be_nil
-      message = JSON.parse(r.body)
+      message = r.body
       expect('Unread').to eq(message['readStatus'])
       r = rc.put(messageUrl, payload: { readStatus: 'Read' })
       expect(r).not_to be_nil
-      message = JSON.parse(r.body)
+      message = r.body
       expect('Read').to eq(message['readStatus'])
 
       # todo: test patch
@@ -76,7 +76,7 @@ RSpec.describe 'RingCentral' do
       expect(r).not_to be_nil
       r = rc.get(messageUrl)
       expect(r).not_to be_nil
-      message = JSON.parse(r.body)
+      message = r.body
       expect('Deleted').to eq(message['availability'])
     end
   end

data/spec/subscription_spec.rb

@@ -4,8 +4,8 @@ require 'dotenv'
 require 'rspec'
 
 Dotenv.load
-$rc = RingCentral.new(ENV['clientId'], ENV['clientSecret'], ENV['server'])
-$rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+$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 = [
@@ -27,8 +27,8 @@ RSpec.describe 'Subscription' do
       })
 
       $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
-        to: [{phoneNumber: ENV['receiver']}],
-        from: {phoneNumber: ENV['username']},
+        to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
+        from: {phoneNumber: ENV['RINGCENTRAL_USERNAME']},
         text: 'Hello world'
       })
       sleep(20)
@@ -45,8 +45,8 @@ RSpec.describe 'Subscription' do
       subscription.refresh()
 
       $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
-        to: [{phoneNumber: ENV['receiver']}],
-        from: {phoneNumber: ENV['username']},
+        to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
+        from: {phoneNumber: ENV['RINGCENTRAL_USERNAME']},
         text: 'Hello world'
       })
       sleep(20)
@@ -63,8 +63,8 @@ RSpec.describe 'Subscription' do
       subscription.revoke()
 
       $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
-        to: [{phoneNumber: ENV['receiver']}],
-        from: {phoneNumber: ENV['username']},
+        to: [{phoneNumber: ENV['RINGCENTRAL_RECEIVER']}],
+        from: {phoneNumber: ENV['RINGCENTRAL_USERNAME']},
         text: 'Hello world'
       })
       sleep(20)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-sdk
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Tyler Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -90,6 +90,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
 description: Ruby SDK for you to access RingCentral platform API.
 email:
 - tyler.liu@ringcentral.com
@@ -126,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: RingCentral Ruby SDK.