ringcentral_sdk 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 239dea9ba4e4c8e62d7766757e538136ecda1576
-  data.tar.gz: b4f83504a9a0e48110174b4233da10b0619b7868
+  metadata.gz: df84f0ee4eab215d88476494ab7ff4681c59fe34
+  data.tar.gz: 0bcb1c96920506ee4d63d4a162c9cab33a25078d
 SHA512:
-  metadata.gz: 9fa0276afb85635e2865c00a63c7a14ca2dd2213cb0b894223cfd0ad6863509a234b158e85c9bb8c5c318512a3eb75fa566f952c96c7cd5911f65b65b4234ce9
-  data.tar.gz: 3114700d02cc0e3c31c86864c60240a55ff884d69e707235888a7cae7f6390fc01a831e4573b4ab9e5411ba001692fa43940737cfc105610cb5607ac6d531a93
+  metadata.gz: 89675600de9040918b4fead9d4134d00d2107ff4501e81108189126452201a6c2b7d1130e9a92921dfe744f39fd84b190c25cc6a34ceec65758649f63d2d1733
+  data.tar.gz: d64154488b9a64cdf2385112b1a2b548a6092f15c57b1550eecdbae005b19f080343108f917d07ff281603d44468cc7d4a3dad211b85b3966286e78e433036fa

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 CHANGELOG
 ---------
+- **2015-10-15**: 0.4.0
+  - Add 3-Legged OAuth support via platform `authorize_url` and `authorize_code` methods
+  - Add `oauth2-sinatra` demo app in `scripts` directory
+  - Add `call_recording_download.rb` demo script
+  - Add `rc-credentials.json` separate demo credentials file
+  - Update `fax_send.rb` demo script with name change
+  - Modify SDK initialization by converting optional params to options hash
+  - Refactor `RingCentralSdk::Platform::Platform` to `RingCentralSdk::Platform`
 - **2015-10-07**: 0.3.0
   - Add subscription support via PubNub
   - Add `ruby-head`, `jruby`, `jruby-head`, and `rbx-2` to Travis CI

data/README.md

@@ -21,6 +21,8 @@ RingCentral SDK
 2. [Usage](#usage)
   1. [Instantiation](#instantiation)
   1. [Authorization](#authorization)
+    1. [Password Grant](#password-grant)
+    1. [Authorization Code Grant](#authorization-code-grant)
   1. [API Requests](#api-requests)
     1. [SMS Example](#sms-example)
     2. [Fax Example](#fax-example)
@@ -32,7 +34,7 @@ RingCentral SDK
 
 ## Overview
 
-This is an unofficial Ruby SDK for the RingCentral for Developers Platform REST API (https://developers.ringcentral.com).
+This is a Ruby SDK for the RingCentral for Developers Platform REST API (https://developers.ringcentral.com).
 
 The core SDK objects follow the general design of the [official RingCentral SDKs](https://github.com/ringcentral). Additional functionality is provided for ease of use including request helpers and generalized OAuth2 support.
 
@@ -40,8 +42,9 @@ This SDK is an early stage library and subject to breaking changes.
 
 ### Included
 
-* OAuth2 authorization & token refresh via INTRIDEA `OAuth2::AccessToken`
+* OAuth2 authorization code and password grant flows including token refresh via INTRIDEA `OAuth2::AccessToken`
 * Generic API requests handled via `Faraday` client
+* Subscription support via `Pubnub` with auto-decryption
 * Fax request helper to create `multipart/mixed` messages
 * Docs via [Read the Docs](http://ringcentral-sdk-ruby.readthedocs.org/) and [RubyDoc](http://www.rubydoc.info/gems/ringcentral_sdk/)
 
@@ -49,7 +52,6 @@ This SDK is an early stage library and subject to breaking changes.
 
 The following items are still needed for this SDK. Contributions are most welcome.
 
-* Subscriptions
 * Mock tests
 
 ## Documentation
@@ -64,7 +66,7 @@ more information on individual API calls:
 
 1. [API Developer and Reference Guide](https://developers.ringcentral.com/api-docs/latest/index.html) for information on specific APIs.
 1. [API Explorer](http://ringcentral.github.io/api-explorer/)
-1. [CTI Tutorial](http://ringcentral.github.io/cti-tutorial/)
+1. [Dev Tutorial](http://ringcentral.github.io/tutorial/)
 
 ## Installation
 
@@ -105,8 +107,8 @@ The RingCentral server URLs can be populated manually or via the included consta
 require 'ringcentral_sdk'
 
 rcsdk = RingCentralSdk::Sdk.new(
-  "myAppKey",
-  "myAppSecret",
+  'myAppKey',
+  'myAppSecret',
   RingCentralSdk::Sdk::RC_SERVER_SANDBOX
 )
 platform = rcsdk.platform
@@ -114,15 +116,53 @@ platform = rcsdk.platform
 
 ### Authorization
 
+#### Password Grant
+
+The 2-legged OAuth 2.0 flow using a password grant is designed for server applications where the app and resource owners are the same.
+
 ```ruby
 # Initialize using main phone number and extension number
-platform.authorize("myUsername", "myExtension", "myPassword")
+platform.authorize('myUsername', 'myExtension', 'myPassword')
 
 # Initialize using user phone number without extension number
 # Extension defaults to company admin extension
-platform.authorize("myUsername", nil, "myPassword")
+platform.authorize('myUsername', nil, 'myPassword')
+```
+
+#### Authorization Code Grant
+
+The 3-legged OAuth 2.0 flow using an authorization code grant is designed for web apps and public apps where authorization needs to be granted by a 3rd party resource owner.
+
+```ruby
+# Initialize SDK with OAuth redirect URI
+rcsdk = RingCentralSdk::Sdk.new(
+  'myAppKey',
+  'myAppSecret',
+  RingCentralSdk::Sdk::RC_SERVER_SANDBOX,
+  {:redirect_uri => 'http://example.com/oauth'}
+)
+# Retrieve OAuth authorize url using default redirect URL
+auth_url = rcsdk.platform.authorize_url()
+# Retrieve OAuth authorize url using override redirect URL
+auth_url = rcsdk.platform.authorize_url({
+  :redirect_uri => 'my_registered_oauth_url', # optional override of default URL
+  :display      => '', # optional: page|popup|touch|mobile, default 'page'
+  :prompt       => '', # optional: sso|login|consent, default is 'login sso consent'
+  :state        => '', # optional
+  :brand_id     => ''  # optional: string|number
+})
+# Open browser window to authorization url and retrieve authorize code from redirect uri.
 ```
 
+On your redirect page, you can exchange your authorization code for an access token using the following:
+
+```ruby
+code  = params['code'] # retrieve GET 'code' parameter in Sinatra
+rcsdk.platform.authorize_code(code)
+```
+
+For a complete working example, a demo Sinatra app is available in the scripts directory at [scripts/oauth2-sinatra](scripts/oauth2-sinatra).
+
 #### Authentication Lifecycle
 
 The platform class performs token refresh procedure automatically if needed. To save the access and refresh tokens between instances of the SDK, you can save and reuse the token as follows:
@@ -138,8 +178,8 @@ After you have saved the token hash, e.g. as JSON, you can reload it in another
 ```ruby
 # Reuse token_hash in another SDK instance
 rcsdk2 = RingCentralSdk::Sdk.new(
-  "myAppKey",
-  "myAppSecret",
+  'myAppKey',
+  'myAppSecret',
   RingCentralSdk::Sdk::RC_SERVER_SANDBOX
 )
 # set_token() accepts a hash or OAuth2::AccessToken object
@@ -272,4 +312,4 @@ Please report these on [Github](https://github.com/grokify/ringcentral-sdk-ruby)
 
 RingCentral SDK is available under an MIT-style license. See [LICENSE.txt](LICENSE.txt) for details.
 
-RingCentral SDK © 2015 by John Wang
+RingCentral SDK © 2015 by John Wang

data/VERSION.txt

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/ringcentral_sdk/platform.rb

@@ -1,3 +1,161 @@
-module RingCentralSdk::Platform
-  autoload :Platform, 'ringcentral_sdk/platform/platform'
-end
+require 'base64'
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday_middleware/oauth2_refresh'
+require 'oauth2'
+
+module RingCentralSdk
+  class Platform
+
+    ACCESS_TOKEN_TTL  = 600             # 10 minutes
+    REFRESH_TOKEN_TTL = 36000           # 10 hours
+    REFRESH_TOKEN_TTL_REMEMBER = 604800 # 1 week
+    ACCOUNT_PREFIX    = '/account/'
+    ACCOUNT_ID        = '~'
+    AUTHZ_ENDPOINT    = '/restapi/oauth/authorize'
+    TOKEN_ENDPOINT    = '/restapi/oauth/token'
+    REVOKE_ENDPOINT   = '/restapi/oauth/revoke'
+    API_VERSION       = 'v1.0'
+    URL_PREFIX        = '/restapi'
+
+    attr_accessor :server_url
+
+    attr_reader   :client
+    attr_reader   :oauth2client
+    attr_reader   :token
+    attr_reader   :user_agent
+    attr_reader   :redirect_uri
+
+    def initialize(app_key='', app_secret='', server_url=RingCentralSdk::Sdk::RC_SERVER_SANDBOX, opts={})
+      @app_key      = app_key
+      @app_secret   = app_secret
+      @server_url   = server_url
+      @token        = nil
+      @client       = nil
+      @redirect_uri = opts.has_key?(:redirect_uri) ? opts[:redirect_uri] : ''
+      @user_agent   = get_user_agent()
+      @oauth2client = new_oauth2_client()
+    end
+
+    def get_api_version_url()
+      return @server_url + URL_PREFIX + '/' + API_VERSION 
+    end
+
+    def create_url(url, add_server=false, add_method=nil, add_token=false)
+      built_url = ''
+      has_http = !url.index('http://').nil? && !url.index('https://').nil?
+
+      if add_server && ! has_http
+        built_url += @server_url
+      end
+
+      if url.index(URL_PREFIX).nil? && ! has_http
+        built_url += URL_PREFIX + '/' + API_VERSION + '/'
+      end
+
+      if url.index('/') == 0
+        if built_url =~ /\/$/
+          built_url += url.gsub(/^\//, '')
+        else
+          built_url += url
+        end
+      else # no /
+        if built_url =~ /\/$/
+          built_url += url
+        else
+          built_url += '/' + url
+        end
+      end
+
+      return built_url
+    end
+
+    def authorize_url(opts={})
+      if ! opts.has_key?(:redirect_uri) && @redirect_uri.to_s.length>0
+        opts[:redirect_uri] = @redirect_uri.to_s
+      end
+      @oauth2client.auth_code.authorize_url(opts)
+    end
+
+    def authorize_code(code, opts={})
+      if ! opts.has_key?(:redirect_uri) && @redirect_uri.to_s.length>0
+        opts[:redirect_uri] = @redirect_uri.to_s
+      end
+      token = @oauth2client.auth_code.get_token(code, opts)
+      set_token(token)
+      return token
+    end
+
+    def authorize_password(username='', extension='', password='', remember=false)
+      token = @oauth2client.password.get_token(username, password, {
+        :extension => extension,
+        :headers   => { 'Authorization' => 'Basic ' + get_api_key() } })
+      set_token(token)
+      return token
+    end
+
+    def set_token(token)
+      if token.is_a?(Hash)
+        token = OAuth2::AccessToken::from_hash(@oauth2client, token)
+      end
+
+      unless token.is_a?(OAuth2::AccessToken)
+        raise "Token is not a OAuth2::AccessToken"
+      end
+
+      @token  = token
+
+      @client = Faraday.new(:url => get_api_version_url()) do |conn|
+        conn.request  :oauth2_refresh, @token
+        conn.request  :json
+        conn.request  :url_encoded
+        conn.headers['User-Agent'] = @user_agent
+        conn.headers['Rc-User-Agent'] = @user_agent
+        conn.response :json, :content_type => 'application/json'
+        conn.adapter  Faraday.default_adapter
+      end
+    end
+
+    def new_oauth2_client()
+      return OAuth2::Client.new(@app_key, @app_secret,
+        :site          => @server_url,
+        :authorize_url => AUTHZ_ENDPOINT,
+        :token_url     => TOKEN_ENDPOINT)
+    end
+
+    def get_api_key()
+      api_key = (@app_key.is_a?(String) && @app_secret.is_a?(String)) \
+        ? Base64.encode64("#{@app_key}:#{@app_secret}").gsub(/[\s\t\r\n]/,'') : ''
+      return api_key
+    end
+
+    def request(helper=nil)
+      unless helper.is_a?(RingCentralSdk::Helpers::Request)
+        raise 'Request is not a RingCentralSdk::Helpers::Request'
+      end
+
+      if helper.method.downcase == 'post'
+        resp       =  @client.post do |req|
+          req.url helper.url
+          req.headers['Content-Type'] = helper.content_type if helper.content_type
+          req.body = helper.body if helper.body
+        end
+        return resp
+      end
+      return nil
+    end
+
+    def get_user_agent()
+      ua = "ringcentral-sdk-ruby/#{RingCentralSdk::VERSION} %s/%s %s" % [
+        (RUBY_ENGINE rescue nil or "ruby"),
+        RUBY_VERSION,
+        RUBY_PLATFORM
+      ]
+      return ua.strip
+    end
+
+    alias_method :authorize, :authorize_password
+    alias_method :login, :authorize_password
+    private :get_api_version_url
+  end
+end

data/lib/ringcentral_sdk/sdk.rb

@@ -6,12 +6,13 @@ module RingCentralSdk
 
     attr_reader :platform
 
-    def initialize(app_key=nil,app_secret=nil,server_url=nil,username=nil,extension=nil,password=nil)
+    def initialize(app_key=nil,app_secret=nil,server_url=nil,opts={})
       use_pubnub_mock = false
 
-      @platform = RingCentralSdk::Platform::Platform.new(app_key, app_secret, server_url)
-      if not username.nil? and not password.nil?
-        @platform.authorize(username, extension, password)
+      @platform = RingCentralSdk::Platform.new(app_key, app_secret, server_url, opts)
+      if opts.has_key?(:username) && opts.has_key?(:password)
+        extension = opts.has_key?(:extension) ? opts[:extension] : ''
+        @platform.authorize(opts[:username], extension, opts[:password])
       end
 
       @_pubnub_factory = RingCentralSdk::PubnubFactory.new(use_pubnub_mock)

data/lib/ringcentral_sdk/subscription.rb

@@ -1,7 +1,7 @@
 require 'base64'
 require 'multi_json'
 require 'observer'
-require 'timers' # Also see http://ruby-doc.org/stdlib-2.2.3/libdoc/timeout/rdoc/Timeout.html
+require 'timers'
 
 module RingCentralSdk
   class Subscription
@@ -9,10 +9,12 @@ module RingCentralSdk
 
     RENEW_HANDICAP = 60
 
+    attr_reader :event_filters
+
     def initialize(platform, pubnub_factory)
       @_platform = platform
       @_pubnub_factory = pubnub_factory
-      @_event_filters = []
+      @event_filters = []
       @_timeout = nil
       @_subscription = nil_subscription()
       @_pubnub = nil
@@ -43,27 +45,27 @@ module RingCentralSdk
     end
 
     def register(events=nil)
-      return alive() ? renew(events) : subscribe(events)
+      return alive?() ? renew(events) : subscribe(events)
     end
 
     def add_events(events)
       unless events.is_a?(Array)
         raise 'Events is not an array.'
       end
-      @_event_filters.push(events) if events.length>0
+      @event_filters.push(events) if events.length>0
     end
 
     def set_events(events)
       unless events.is_a?(Array)
         raise 'Events is not an array.'
       end
-      @_event_filters.push(*events) if events.length>0
+      @event_filters = events
     end
 
     def subscribe(events=nil)
       set_events(events) if events.is_a?(Array)
 
-      if !@_event_filters.is_a?(Array) || @_event_filters.length ==0
+      if !@event_filters.is_a?(Array) || @event_filters.length ==0
         raise 'Events are undefined'
       end
 
@@ -95,11 +97,11 @@ module RingCentralSdk
     def renew(events=nil)
       set_events(events) if events.is_a?(Array)
 
-      unless alive()
+      unless alive?()
         raise 'Subscription is not alive'
       end
 
-      if !@_event_filters.is_a?(Array) || @_event_filters.length ==0
+      if !@event_filters.is_a?(Array) || @event_filters.length ==0
         raise 'Events are undefined'
       end
  
@@ -126,7 +128,7 @@ module RingCentralSdk
     end
 
     def remove()
-      unless alive()
+      unless alive?()
         raise 'Subscription is not alive'
       end
 
@@ -145,11 +147,14 @@ module RingCentralSdk
       end
     end
 
-    def alive()
+    def alive?()
       s = @_subscription
       return (s.has_key?('deliveryMode') && s['deliveryMode']) && \
         (s['deliveryMode'].has_key?('subscriberKey') && s['deliveryMode']['subscriberKey']) && \
-        (s['deliveryMode'].has_key?('address') && s['deliveryMode']['address'])
+        (
+          s['deliveryMode'].has_key?('address') && s['deliveryMode']['address'] && \
+          s['deliveryMode']['address'].length>0) \
+        ? true : false
     end
 
     def subscription()
@@ -165,16 +170,15 @@ module RingCentralSdk
     def reset()
       _clear_timeout()
       _unsubscribe_at_pubnub()
-      _subscription = nil
+      @_subscription = nil_subscription()
     end
 
     def destroy()
       reset()
-      off()
     end
 
     def _subscribe_at_pubnub()
-      unless alive()
+      if ! alive?()
         raise 'Subscription is not alive'
       end
 
@@ -187,29 +191,13 @@ module RingCentralSdk
       	notify_observers('GOT_PUBNUB_MESSAGE_NOTIFY')
       }
 
-      error = lambda { |envelope|
-        puts('ERROR : ' + envelope.msg.to_s) # FIXME Handle this
-      }
-
-      connect = lambda { |envelope|
-        puts('CONNECTED')
-      }
-
-      reconnect = lambda { |envelope|
-        puts('RECONNECTED')
-      }
-
-      disconnect = lambda { |envelope|
-        puts('DISCONNECTED')
-      }
-
       @_pubnub.subscribe(
         :channel    => @_subscription['deliveryMode']['address'],
         :callback   => callback,
-        :error      => error,
-        :connect    => connect,
-        :reconnect  => reconnect,
-        :disconnect => disconnect
+        :error      => lambda { |envelope| puts('ERROR: ' + envelope.msg.to_s) },
+        :connect    => lambda { |envelope| puts('CONNECTED') },
+        :reconnect  => lambda { |envelope| puts('RECONNECTED') },
+        :disconnect => lambda { |envelope| puts('DISCONNECTED') }
       )
     end
 
@@ -220,18 +208,12 @@ module RingCentralSdk
     end
 
     def _decrypt(message)
-      unless alive()
+      unless alive?()
         raise 'Subscription is not alive'
       end
 
-      delivery_mode = @_subscription['deliveryMode']
-
-      is_encrypted  = delivery_mode.has_key?('encryption') && \
-        delivery_mode['encryption']                        && \
-        delivery_mode.has_key?('encryptionKey')            && \
-        delivery_mode['encryptionKey']
-
-      if is_encrypted
+      if _encrypted?()
+        delivery_mode = @_subscription['deliveryMode']
         key = Base64.decode64(delivery_mode['encryptionKey'])
         ciphertext = Base64.decode64(message)
 
@@ -247,15 +229,24 @@ module RingCentralSdk
       return message
     end
 
+    def _encrypted?()
+      delivery_mode = @_subscription['deliveryMode']
+      is_encrypted  = delivery_mode.has_key?('encryption') && \
+        delivery_mode['encryption']                        && \
+        delivery_mode.has_key?('encryptionKey')            && \
+        delivery_mode['encryptionKey']
+      return is_encrypted
+    end
+
     def _unsubscribe_at_pubnub()
-      if @_pubnub && alive()
+      if @_pubnub && alive?()
         @_pubnub.unsubscribe(@_subscription['deliveryMode']['address'])
       end
     end
 
     def _get_full_events_filter()
       full_events_filter = []
-      @_event_filters.each do |filter|
+      @event_filters.each do |filter|
         if filter.to_s
           full_events_filter.push(@_platform.create_url(filter.to_s))
         end

data/lib/ringcentral_sdk/version.rb

@@ -1,3 +1,3 @@
 module RingCentralSdk
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/test/test_setup.rb

@@ -10,7 +10,11 @@ class RingCentralSdkTest < Test::Unit::TestCase
     )
 
     assert_equal "RingCentralSdk::Sdk", rcsdk.class.name
-    assert_equal "RingCentralSdk::Platform::Platform", rcsdk.platform.class.name
+    assert_equal "RingCentralSdk::Platform", rcsdk.platform.class.name
+
+    assert_raise do
+      rcsdk.request(nil)
+    end
 
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - John Wang
@@ -180,7 +180,6 @@ files:
 - lib/ringcentral_sdk/helpers/inflator/contact_info.rb
 - lib/ringcentral_sdk/helpers/request.rb
 - lib/ringcentral_sdk/platform.rb
-- lib/ringcentral_sdk/platform/platform.rb
 - lib/ringcentral_sdk/pubnub_factory.rb
 - lib/ringcentral_sdk/sdk.rb
 - lib/ringcentral_sdk/subscription.rb

data/lib/ringcentral_sdk/platform/platform.rb

@@ -1,131 +0,0 @@
-require 'base64'
-require 'faraday'
-require 'faraday_middleware'
-require 'faraday_middleware/oauth2_refresh'
-require 'oauth2'
-
-module RingCentralSdk::Platform
-  class Platform
-
-    ACCESS_TOKEN_TTL  = 600             # 10 minutes
-    REFRESH_TOKEN_TTL = 36000           # 10 hours
-    REFRESH_TOKEN_TTL_REMEMBER = 604800 # 1 week
-    ACCOUNT_PREFIX    = '/account/'
-    ACCOUNT_ID        = '~'
-    TOKEN_ENDPOINT    = '/restapi/oauth/token'
-    REVOKE_ENDPOINT   = '/restapi/oauth/revoke'
-    API_VERSION       = 'v1.0'
-    URL_PREFIX        = '/restapi'
-
-    attr_accessor :server_url
-
-    attr_reader   :client
-    attr_reader   :token
-    attr_reader   :user_agent
-
-    def initialize(app_key='', app_secret='', server_url=RingCentralSdk::Sdk::RC_SERVER_SANDBOX)
-      @app_key    = app_key
-      @app_secret = app_secret
-      @server_url = server_url
-      @token      = nil
-      @client     = nil
-      @user_agent = get_user_agent()
-    end
-
-    def get_api_version_url()
-      return @server_url + URL_PREFIX + '/' + API_VERSION 
-    end
-
-    def create_url(url, add_server=false, add_method=nil, add_token=false)
-      built_url = ''
-      has_http = !url.index('http://').nil? && !url.index('https://').nil?
-
-      if add_server && ! has_http
-        built_url += @server_url
-      end
-
-      if url.index(URL_PREFIX).nil? && ! has_http
-        built_url += URL_PREFIX + '/' + API_VERSION
-      end
-
-      built_url += url
-
-      return built_url
-    end
-
-    def login(username, extension, password)
-      return authorize(username, extension, password)
-    end
-
-    def authorize(username='', extension='', password='', remember=false)
-      oauth2client = new_oauth2_client()
-
-      token = oauth2client.password.get_token(username, password, {
-        :extension => extension,
-        :headers   => { 'Authorization' => 'Basic ' + get_api_key() } })
-
-      set_token(token)
-    end
-
-    def set_token(token)
-      if token.is_a?(Hash)
-        token = OAuth2::AccessToken::from_hash(new_oauth2_client(), token)
-      end
-
-      unless token.is_a?(OAuth2::AccessToken)
-        raise "Token is not a OAuth2::AccessToken"
-      end
-
-      @token  = token
-
-      @client = Faraday.new(:url => get_api_version_url()) do |conn|
-        conn.request  :oauth2_refresh, @token
-        conn.request  :json
-        conn.request  :url_encoded
-        conn.headers['User-Agent'] = @user_agent
-        conn.headers['Rc-User-Agent'] = @user_agent
-        conn.response :json, :content_type => 'application/json'
-        conn.adapter  Faraday.default_adapter
-      end
-    end
-
-    def new_oauth2_client()
-      return OAuth2::Client.new(@app_key, @app_secret,
-        :site      => @server_url,
-        :token_url => TOKEN_ENDPOINT)
-    end
-
-    def get_api_key()
-      api_key = (@app_key.is_a?(String) && @app_secret.is_a?(String)) \
-        ? Base64.encode64("#{@app_key}:#{@app_secret}").gsub(/[\s\t\r\n]/,'') : ''
-      return api_key
-    end
-
-    def request(helper=nil)
-      unless helper.is_a?(RingCentralSdk::Helpers::Request)
-        raise 'Request is not a RingCentralSdk::Helpers::Request'
-      end
-
-      if helper.method.downcase == 'post'
-        resp       =  @client.post do |req|
-          req.url helper.url
-          req.headers['Content-Type'] = helper.content_type if helper.content_type
-          req.body = helper.body if helper.body
-        end
-        return resp
-      end
-      return nil
-    end
-
-    def get_user_agent()
-      ua = "ringcentral-sdk-ruby/#{RingCentralSdk::VERSION} %s/%s %s" % [
-        (RUBY_ENGINE rescue nil or "ruby"),
-        RUBY_VERSION,
-        RUBY_PLATFORM
-      ]
-      return ua.strip
-    end
-
-    private :get_api_version_url
-  end
-end