ringcentral-sdk 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 985e9f0cf6416e2288c2330b596fde160e32a381
-  data.tar.gz: 631d59c2a2c13baa8178fadfc466c6044209b9c4
+  metadata.gz: 354ed40d66f2e406de2889128652ae486f7a58a6
+  data.tar.gz: 612d22c0d3c057d446b505b4d5a5f1ebc2d8ceae
 SHA512:
-  metadata.gz: 2b44f5dddcbc5c65b8c1484844665ce01c2944f42f71d708992bfacbd54f0a977c98b8f87a566a456afc2bc17056328e7663e279aca1559e44059556bfecb906
-  data.tar.gz: 1206c7a15bb653e5cb412e1b814031c4b7726f53f39875a56e2cb8688096a1abe68ae6d7aef7c552c2a0f5d2842eeea35d1e03d7002dab44c976ad556205875f
+  metadata.gz: fd5fb7784d5a65dc0d3a1f3c5f9d59ca2bf7c2949f6ec376e3a23343277a8be607956042fe9de803fe58ce2dca8d359a5d8b8b52f0eb6a68d28f83a0095245da
+  data.tar.gz: 46f4c8903ef34646614850b2c0bdb32bb50e0dd376f30cc28034768e681a139bead61c0d59d9e7cb5ec055ee5f466d4864ea4d6e49ad9c906721e775e2cd001e

data/README.md

@@ -1,5 +1,9 @@
 # ringcentral-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)
+
+
 Ruby SDK for RingCentral.
 
 
@@ -58,7 +62,5 @@ MIT
 
 ## Todo
 
-- Travis CI
-- Code coverage
 - Batch requests
-- Fax & SMS
+- Samples for Fax & MMS

data/lib/ringcentral.rb

@@ -1,9 +1,9 @@
 require 'base64'
 require 'addressable/uri'
 require 'subscription'
-require 'rest-client'
 require 'json'
 require 'concurrent'
+require 'faraday'
 
 class RingCentral
   def self.SANDBOX_SERVER
@@ -24,6 +24,11 @@ class RingCentral
     @auto_refresh = true
     @token = nil
     @timer = nil
+    @faraday = Faraday.new(url: server) do |faraday|
+      faraday.request :multipart
+      faraday.request :url_encoded
+      faraday.adapter Faraday.default_adapter
+    end
   end
 
   def token=(value)
@@ -87,20 +92,48 @@ class RingCentral
     uri.to_s
   end
 
-  def get(endpoint, params = nil)
-    request(:get, endpoint, params: params)
+  def get(endpoint, params = {})
+    @faraday.get do |req|
+      req.url endpoint
+      req.params = params
+      req.headers = headers
+    end
   end
 
-  def post(endpoint, payload: nil, params: nil, files: nil)
-    request(:post, endpoint, payload: payload, params: params, files: files)
+  def post(endpoint, payload: nil, params: {}, files: nil)
+    @faraday.post do |req|
+      req.url endpoint
+      req.params = params
+      if files != nil && files.size > 0
+        req.headers = headers
+        req.body = (payload || {}).merge({
+          attachment: Faraday::UploadIO.new(files[0][:path], files[0][:content_type])
+        })
+      elsif payload != nil && @token != nil
+        req.headers = headers.merge({ 'Content-Type': 'application/json' })
+        req.body = payload.to_json
+      else
+        req.headers = headers
+        req.body = payload
+      end
+    end
   end
 
-  def put(endpoint, payload: nil, params: nil, files: nil)
-    request(:put, endpoint, payload: payload, params: params, files: files)
+  def put(endpoint, payload: nil, params: {}, files: nil)
+    @faraday.put do |req|
+      req.url endpoint
+      req.params = params
+      req.headers = headers.merge({ 'Content-Type': 'application/json' })
+      req.body = payload.to_json
+    end
   end
 
-  def delete(endpoint, params = nil)
-    request(:delete, endpoint, params: params)
+  def delete(endpoint, params = {})
+    @faraday.delete do |req|
+      req.url endpoint
+      req.params = params
+      req.headers = headers
+    end
   end
 
   def subscription(events, callback)
@@ -117,17 +150,12 @@ class RingCentral
       @token != nil ? "Bearer #{@token['access_token']}" : "Basic #{basic_key}"
     end
 
-    def request(method, endpoint, params: nil, payload: nil, files: nil)
-      url = (Addressable::URI.parse(@server) + endpoint).to_s
+    def headers
       user_agent_header = "ringcentral/ringcentral-ruby Ruby #{RUBY_VERSION} #{RUBY_PLATFORM}"
-      headers = {
+      {
         'Authorization': autorization_header,
-        'RC-User-Agent': user_agent_header
+        'RC-User-Agent': user_agent_header,
+        'User-Agent': user_agent_header,
       }
-      if payload != nil && @token != nil
-        headers['Content-Type'] = 'application/json'
-        payload = payload.to_json
-      end
-      RestClient::Request.execute(method: method.to_sym, url: url, params: params, payload: payload, headers: headers, files: files)
     end
 end

data/lib/subscription.rb

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

data/ringcentral-sdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = 'ringcentral-sdk'
-  gem.version       = '0.3.0'
+  gem.version       = '0.4.0'
   gem.authors       = ['Tyler Liu']
   gem.email         = ['tyler.liu@ringcentral.com']
   gem.description   = 'Ruby SDK for you to access RingCentral platform API.'
@@ -13,8 +13,8 @@ Gem::Specification.new do |gem|
   gem.files        += Dir['lib/**/*.rb']
   gem.test_files    = Dir['spec/**/*.rb']
 
-  gem.add_dependency('rest-client', '~> 2.0', '>= 2.0.2')
   gem.add_dependency('addressable', '~> 2.5', '>= 2.5.2')
   gem.add_dependency('concurrent-ruby', '~> 1.0', '>= 1.0.2')
   gem.add_dependency('pubnub', '~> 4.0', '>= 4.0.27')
+  gem.add_dependency('faraday', '~> 0.13', '>= 0.13.1')
 end

data/spec/fax_spec.rb

@@ -0,0 +1,20 @@
+require 'dotenv'
+require 'ringcentral'
+
+RSpec.describe 'Fax' do
+  describe 'send fax' do
+    it 'should send a fax' do
+      Dotenv.load
+      rc = RingCentral.new(ENV['appKey'], ENV['appSecret'], ENV['server'])
+      rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+
+      r = rc.post('/restapi/v1.0/account/~/extension/~/fax',
+        payload: { to: ENV['receiver'] },
+        files:[{ path: './spec/test.png', content_type: 'image/png' }]
+      )
+      expect(r).not_to be_nil
+      message = JSON.parse(r.body)
+      expect('Fax').to eq(message['type'])
+    end
+  end
+end

data/spec/spec_helper.rb

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

data/spec/subscription_spec.rb

@@ -2,23 +2,48 @@ require 'ringcentral'
 require 'dotenv'
 require 'rspec'
 
+Dotenv.load
+$rc = RingCentral.new(ENV['appKey'], ENV['appSecret'], ENV['server'])
+$rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+
+def createSubscription(callback)
+  events = [
+    '/restapi/v1.0/account/~/extension/~/message-store',
+  ]
+  subscription = $rc.subscription(events, lambda { |message|
+    callback.call(message)
+  })
+  subscription.subscribe()
+  return subscription
+end
+
 RSpec.describe 'Subscription' do
   describe 'subscription' do
     it 'receives message notification' do
-      Dotenv.load
-      rc = RingCentral.new(ENV['appKey'], ENV['appSecret'], ENV['server'])
-      rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+      count = 0
+      createSubscription(lambda { |message|
+        count += 1
+      })
+
+      $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
+        to: [{phoneNumber: ENV['receiver']}],
+        from: {phoneNumber: ENV['username']},
+        text: 'Hello world'
+      })
+      sleep(20)
+
+      expect(count).to be > 0
+    end
 
-      events = [
-        '/restapi/v1.0/account/~/extension/~/message-store',
-      ]
+    it 'refresh' do
       count = 0
-      subscription = rc.subscription(events, lambda { |message|
+      subscription = createSubscription(lambda { |message|
         count += 1
       })
-      subscription.subscribe()
 
-      rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
+      subscription.refresh()
+
+      $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
         to: [{phoneNumber: ENV['receiver']}],
         from: {phoneNumber: ENV['username']},
         text: 'Hello world'
@@ -27,5 +52,23 @@ RSpec.describe 'Subscription' do
 
       expect(count).to be > 0
     end
+
+    it 'revoke' do
+      count = 0
+      subscription = createSubscription(lambda { |message|
+        count += 1
+      })
+
+      subscription.revoke()
+
+      $rc.post('/restapi/v1.0/account/~/extension/~/sms', payload: {
+        to: [{phoneNumber: ENV['receiver']}],
+        from: {phoneNumber: ENV['username']},
+        text: 'Hello world'
+      })
+      sleep(20)
+
+      expect(count).to eq(0)
+    end
   end
 end

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tyler Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2017-12-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +70,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.27
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.1
 description: Ruby SDK for you to access RingCentral platform API.
 email:
 - tyler.liu@ringcentral.com
@@ -101,7 +101,9 @@ files:
 - lib/ringcentral.rb
 - lib/subscription.rb
 - ringcentral-sdk.gemspec
+- spec/fax_spec.rb
 - spec/ringcentral_spec.rb
+- spec/spec_helper.rb
 - spec/subscription_spec.rb
 homepage: https://github.com/ringcentral/ringcentral-ruby
 licenses:
@@ -128,5 +130,7 @@ signing_key:
 specification_version: 4
 summary: RingCentral Ruby SDK.
 test_files:
+- spec/fax_spec.rb
 - spec/ringcentral_spec.rb
+- spec/spec_helper.rb
 - spec/subscription_spec.rb