ringcentral-sdk 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22713ecf76dc139e0a97fc0947a1e81c8782d3ae
-  data.tar.gz: 9d3a34d9a689633fcfa6116eda4ce9545657da73
+  metadata.gz: f05987bc7911b539c714d03db8541a64f9952875
+  data.tar.gz: af9b7d5e38f3d7c639f5d872b01e5a8367183c37
 SHA512:
-  metadata.gz: 4518d6cc3bf373040f63960cedab921b6e13a776e6ef41b9121c3d0c2b2a04f046f821730ef07445cabfc488306bfb3c7b9252086ab32a5c27e87b291d9dc60e
-  data.tar.gz: bf884572171894c8df910610e0f45ea762155970d342e74a5cbdb164f94ed8756e42f108443e512b47bc7a92309b8b9a01acf3de9063c0d821bfd75d072e152f
+  metadata.gz: c64088595d4936f4714dac813a8eba9fb5614a44d2f9e19a7533e6ff4b5f0f88998fcac2aa2f21420b62d76eb2efb218f4138008743d87e442b1ba466ed390f0
+  data.tar.gz: ef5e6248621cc31bdc8607d1d3cfcdcddd7bfa49bcc09c0b91f2e144275e4c508aed061cd71813e7d68883b78dee5ee2c0d468a5cdb6ece18e5d4231add7a31c

data/README.md

@@ -13,7 +13,20 @@ https://developer.ringcentral.com/api-docs/latest/index.html
 
 ## Usage
 
-WIP.
+```ruby
+require 'ringcentral'
+
+rc = RingCentral.new(ENV['appKey'], ENV['appSecret'], ENV['server'])
+rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+
+# get
+r = rc.get('/restapi/v1.0/account/~/extension/~')
+assert_not_equal nil, r
+assert_equal '101', JSON.parse(r.body)['extensionNumber']
+```
+
+
+For more sample code, please refer to the [test cases](/test).
 
 
 ## How to test

data/lib/ringcentral.rb

@@ -3,6 +3,7 @@ require 'addressable/uri'
 require 'subscription'
 require 'rest-client'
 require 'json'
+require 'concurrent'
 
 class RingCentral
   def self.SANDBOX_SERVER
@@ -13,7 +14,7 @@ class RingCentral
     'https://platform.ringcentral.com'
   end
 
-  attr_reader :app_key, :app_secret, :server
+  attr_reader :app_key, :app_secret, :server, :token
   attr_accessor :auto_refresh
 
   def initialize(app_key, app_secret, server)
@@ -22,10 +23,7 @@ class RingCentral
     @server = server
     @auto_refresh = true
     @token = nil
-  end
-
-  def token
-    @token
+    @timer = nil
   end
 
   def token=(value)
@@ -35,9 +33,7 @@ class RingCentral
       @timer = nil
     end
     if @auto_refresh && value != nil
-      @timer = Concurrent::TimerTask.new(execution_interval: value.expires_in - 120, timeout_interval: 60) do
-        refresh
-      end
+      @timer = Concurrent::TimerTask.new(execution_interval: value['expires_in'] - 120, timeout_interval: 60) { self.refresh }
       @timer.execute
     end
   end
@@ -57,9 +53,9 @@ class RingCentral
         password: password,
       }
     end
-    @token = nil
-    r = post('/restapi/oauth/token', payload: payload)
-    @token = JSON.parse(r.body)
+    self.token = nil
+    r = self.post('/restapi/oauth/token', payload: payload)
+    self.token = JSON.parse(r.body)
   end
 
   def refresh
@@ -68,18 +64,16 @@ class RingCentral
       grant_type: 'refresh_token',
       refresh_token: @token['refresh_token']
     }
-    @token = nil
-    r = post('/restapi/oauth/token', payload: payload)
-    @token = JSON.parse(r.body)
+    self.token = nil
+    r = self.post('/restapi/oauth/token', payload: payload)
+    self.token = JSON.parse(r.body)
   end
 
   def revoke
     return if @token == nil
-    payload = {
-      token: @token['access_token']
-    }
-    @token = nil
-    post('/restapi/oauth/revoke', payload: payload)
+    payload = { token: @token['access_token'] }
+    self.token = nil
+    self.post('/restapi/oauth/revoke', payload: payload)
   end
 
   def authorize_uri(redirect_uri, state = '')
@@ -109,32 +103,31 @@ class RingCentral
     request(:delete, endpoint, params: params)
   end
 
-  def subscription(event_filters, callback)
-    Subscription.new(event_filters, callback)
+  def subscription(events, callback)
+    Subscription.new(self, events, callback)
   end
 
   private
 
-  def basic_key
-    Base64.encode64("#{@app_key}:#{@app_secret}").gsub(/\s/, '')
-  end
+    def basic_key
+      Base64.encode64("#{@app_key}:#{@app_secret}").gsub(/\s/, '')
+    end
 
-  def autorization_header
-    return "Bearer #{@token['access_token']}" if @token != nil
-    return "Basic #{basic_key}"
-  end
+    def autorization_header
+      @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
-    user_agent_header = "ringcentral/ringcentral-ruby Ruby #{RUBY_VERSION} #{RUBY_PLATFORM}"
-    headers = {
-      'Authorization': autorization_header,
-      'RC-User-Agent': user_agent_header
-    }
-    if payload != nil && @token != nil
-      headers['Content-Type'] = 'application/json'
-      payload = payload.to_json
+    def request(method, endpoint, params: nil, payload: nil, files: nil)
+      url = (Addressable::URI.parse(@server) + endpoint).to_s
+      user_agent_header = "ringcentral/ringcentral-ruby Ruby #{RUBY_VERSION} #{RUBY_PLATFORM}"
+      headers = {
+        'Authorization': autorization_header,
+        'RC-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
-    RestClient::Request.execute(method: method.to_sym, url: url, params: params, payload: payload, headers: headers, files: files)
-  end
 end

data/lib/subscription.rb

@@ -1,2 +1,67 @@
+require 'pubnub'
+require 'concurrent'
+
 class Subscription
+  attr_accessor :events
+
+  def initialize(ringcentral, events, message_callback, status_callback = nil, presence_callback = nil)
+    @rc = ringcentral
+    @events = events
+    @callback = Pubnub::SubscribeCallback.new(
+      message: ->(envelope) {
+        # todo: decrypt the message
+        message_callback(envelope)
+      },
+      presence: ->(envelope) { presence_callback != nil && presence_callback(presence) },
+      status: ->(envelope) { status_callback != nil && status_callback(envelope) }
+    )
+    @subscription = nil
+    @timer = nil
+  end
+
+  def subscription=(value)
+    @subscription = value
+    if @timer != nil
+      @timer.shutdown
+      @timer = nil
+    end
+    if value != nil
+      @timer = Concurrent::TimerTask.new(execution_interval: value['expiresIn'] - 120, timeout_interval: 60) do
+        self.refresh
+      end
+      @timer.execute
+    end
+  end
+
+  def subscribe
+    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.subscribe(channel: @subscription['deliveryMode']['address'])
+  end
+
+  def refresh
+    return if @subscription == nil
+    r = @rc.put("/restapi/v1.0/subscription/#{@subscription['id']}", payload: request_body)
+    self.subscription = JSON.parse(r.body)
+  end
+
+  def revoke
+    return if @subscription == nil
+    @pubnub.unsubscribe(channel: @subscription['deliveryMode']['address'])
+    @pubnub.remove_listener(@callback)
+    @pubnub = nil
+    rc.delete("/restapi/v1.0/subscription/#{@subscription['id']}")
+    self.subscription = nil
+  end
+
+  private
+
+    def request_body
+      {
+        'deliveryMode': { 'transportType': 'PubNub', 'encryption': true },
+        'eventFilters': @events
+      }
+    end
 end

data/ringcentral-sdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = 'ringcentral-sdk'
-  gem.version       = '0.2.0'
+  gem.version       = '0.2.1'
   gem.authors       = ['Tyler Liu']
   gem.email         = ['tyler.liu@ringcentral.com']
   gem.description   = 'Ruby SDK for you to access RingCentral platform API.'
@@ -16,4 +16,5 @@ Gem::Specification.new do |gem|
   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')
 end

data/test/test_subscription.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+require 'ringcentral'
+require 'dotenv'
+
+class SubscriptionTest < Test::Unit::TestCase
+  def test_create_subscription
+    # Dotenv.load
+    # rc = RingCentral.new(ENV['appKey'], ENV['appSecret'], ENV['server'])
+    # rc.authorize(username: ENV['username'], extension: ENV['extension'], password: ENV['password'])
+    # events = [
+    #   '/restapi/v1.0/account/~/extension/~/message-store',
+    # ]
+    # subscription = rc.subscription(events, ->(message) {
+    #   puts message
+    # })
+    # subscription.subscribe()
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tyler Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -70,6 +70,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: pubnub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.27
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.27
 description: Ruby SDK for you to access RingCentral platform API.
 email:
 - tyler.liu@ringcentral.com
@@ -83,6 +103,7 @@ files:
 - lib/subscription.rb
 - ringcentral-sdk.gemspec
 - test/test_ringcentral.rb
+- test/test_subscription.rb
 homepage: https://github.com/tylerlong/ringcentral-ruby
 licenses:
 - MIT
@@ -109,3 +130,4 @@ specification_version: 4
 summary: RingCentral Ruby SDK.
 test_files:
 - test/test_ringcentral.rb
+- test/test_subscription.rb