ringcentral_sdk 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2154bcc7c5ab9744b0e8022fce9182ef79b367f4
-  data.tar.gz: e905f7a5bf71557b364010abbab3d9ec3c9988b7
+  metadata.gz: ab1568adfa0b75e2499ca45a6ecfb8aab7fb8a9b
+  data.tar.gz: 12f9564a379c2360a97446a236768e111f7043d8
 SHA512:
-  metadata.gz: ebf2f8089617611f8bd71ed3e1abf0d36a17f608c0e1e49b47299b641d1a60db1d6e2d869a87c74694c8e09257247c507196f31c1c653b41e21644bdf99f28f1
-  data.tar.gz: f62ada05b0b567e60688090e3be51f41e1ce819b05c16f1bdacfa3f830c5ae7282dd55d6bad06128f34b20d019a2cf3fbb934f4dab0e9dd4201dadebd4ae3fdd
+  metadata.gz: 4a3589d87ec26898d95400919ca9a32bee0ef82458566ea8e4fcacb5933d61ed65405afba5672c19f84b5c6c16210792917de809be51b527656550b51134c587
+  data.tar.gz: 0dd57841c119378949b680aff89c28a70bf370eabbba26b4444ab16e3ea63a3e8ed2d35985540d4f6d038ef0fe1351e9402ecac437802897a0c30e1b7d5e9e47

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 CHANGELOG
 ---------
+- **2016-04-23**: 1.2.0
+  - Additions
+    - Add `RingCentral::REST::Client` custom instance headers support
+    - Add `RingCentral::REST::Client` `attr_reader` for `app_config`
+    - Add docs for Answering Rules
+  - Updates
+    - Update Pubnub dependency to 3.8.0 from 3.7.3
+  - Removals
+    - Deprecate Ruby 1.9.3 due to `mime-types-data` (3.2016.0221) requiring Ruby >= 2.0
 - **2016-02-13**: 1.1.1
   - Additions
     - Add `client.send_request` hash support in addition to `Request::Base` object

data/Gemfile

@@ -13,7 +13,7 @@ gem 'mime_builder'
 gem 'mocha'
 gem 'multi_json'
 gem 'oauth2'
-gem 'pubnub', '~> 3.7.3'
+gem 'pubnub', '~> 3.8.0'
 gem 'rake'
 gem 'simplecov'
 gem 'test-unit'

data/Gemfile.lock

@@ -1,18 +1,31 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    coveralls (0.8.10)
+    celluloid (0.17.3)
+      celluloid-essentials
+      celluloid-extras
+      celluloid-fsm
+      celluloid-pool
+      celluloid-supervision
+      timers (>= 4.1.1)
+    celluloid-essentials (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-extras (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-fsm (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-pool (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-supervision (0.20.5)
+      timers (>= 4.1.1)
+    coveralls (0.8.13)
       json (~> 1.8)
-      rest-client (>= 1.6.8, < 2)
       simplecov (~> 0.11.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
       tins (~> 1.6.0)
     docile (1.1.5)
-    domain_name (0.5.25)
-      unf (>= 0.0.5, < 1.0.0)
     dotenv (2.1.0)
-    eventmachine (1.0.9.1)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.10.0)
@@ -21,15 +34,16 @@ GEM
       faraday (~> 0.9, >= 0.9)
       faraday_middleware (~> 0, >= 0)
     hitimes (1.2.3)
-    http-cookie (1.0.2)
-      domain_name (~> 0.5)
+    httpclient (2.7.1)
     json (1.8.3)
-    jsondoc (0.1.0)
-    jwt (1.5.2)
+    jsondoc (0.1.2)
+    jwt (1.5.1)
     logger (1.2.8)
     metaclass (0.0.4)
     mime (0.4.3)
-    mime-types (2.99)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
     mime_builder (0.0.2)
       mime
       mime-types (>= 1.25)
@@ -38,41 +52,32 @@ GEM
     multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    net-http-persistent (2.9.4)
-    netrc (0.11.0)
-    oauth2 (1.0.0)
+    oauth2 (1.1.0)
       faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
+      jwt (~> 1.0, < 1.5.2)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
+      rack (>= 1.2, < 3)
     power_assert (0.2.7)
-    pubnub (3.7.10)
-      eventmachine (~> 1.0)
+    pubnub (3.8.0)
+      celluloid (~> 0.16)
+      httpclient (~> 2.6)
       json (~> 1.8)
-      net-http-persistent (~> 2.9)
     rack (1.6.4)
-    rake (10.5.0)
-    rest-client (1.8.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    simplecov (0.11.1)
+    rake (11.1.1)
+    simplecov (0.11.2)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     term-ansicolor (1.3.2)
       tins (~> 1.0)
-    test-unit (3.1.7)
+    test-unit (3.1.8)
       power_assert
     thor (0.19.1)
     timers (4.1.1)
       hitimes
     tins (1.6.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.1)
 
 PLATFORMS
   ruby
@@ -91,7 +96,7 @@ DEPENDENCIES
   mocha
   multi_json
   oauth2
-  pubnub (~> 3.7.3)
+  pubnub (~> 3.8.0)
   rake
   simplecov
   test-unit

data/README.md

@@ -38,6 +38,11 @@ RingCentral SDK for Ruby
 
 ## Overview
 
+##### :warning: YOU MUST HAVE A RINGCENTRAL ACCOUNT TO USE THE API :warning:
+##### Get an account at: https://developers.ringcentral.com/login.html
+
+www.ringcentral.com - RingCentral Complete Cloud Communications System.
+
 A library for using the [RingCentral REST API](https://developers.ringcentral.com). [Click here to read the full documentation](http://ringcentral-sdk-ruby.readthedocs.org/).
 
 ## Documentation

data/lib/ringcentral_sdk.rb

@@ -1,5 +1,5 @@
 module RingCentralSdk
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 
   RC_SERVER_PRODUCTION = 'https://platform.ringcentral.com'
   RC_SERVER_SANDBOX    = 'https://platform.devtest.ringcentral.com'

data/lib/ringcentral_sdk/rest.rb

@@ -13,5 +13,6 @@ module RingCentralSdk::REST
   autoload :MessagesSMS, 'ringcentral_sdk/rest/messages'
   autoload :MessagesRetriever, 'ringcentral_sdk/rest/messages_retriever'
   autoload :Request, 'ringcentral_sdk/rest/request'
+  autoload :SimpleClient, 'ringcentral_sdk/rest/simple_client'
   autoload :Subscription, 'ringcentral_sdk/rest/subscription'
 end

data/lib/ringcentral_sdk/rest/client.rb

@@ -6,7 +6,6 @@ require 'oauth2'
 
 module RingCentralSdk::REST
   class Client
-
     ACCESS_TOKEN_TTL  = 600             # 10 minutes
     REFRESH_TOKEN_TTL = 36000           # 10 hours
     REFRESH_TOKEN_TTL_REMEMBER = 604800 # 1 week
@@ -17,6 +16,7 @@ module RingCentralSdk::REST
     REVOKE_ENDPOINT   = '/restapi/oauth/revoke'
     API_VERSION       = 'v1.0'
     URL_PREFIX        = '/restapi'
+    DEFAULT_LANGUAGE  = 'en-us'
 
     attr_reader :app_config
     attr_reader :http
@@ -25,21 +25,25 @@ module RingCentralSdk::REST
     attr_reader :user_agent
     attr_reader :messages
 
+    attr_reader :instance_headers
+
     def initialize(app_key='', app_secret='', server_url=RingCentralSdk::RC_SERVER_SANDBOX, opts={})
       init_attributes()
-      app_config = RingCentralSdk::REST::ConfigApp.new(app_key, app_secret, server_url, opts)
-      app_config(app_config)
+      self.app_config = RingCentralSdk::REST::ConfigApp.new(
+        app_key, app_secret, server_url, opts)
 
       if opts.key?(:username) && opts.key?(:password)
         extension = opts.key?(:extension) ? opts[:extension] : ''
         authorize_password(opts[:username], extension, opts[:password])
       end
 
-      @messages = RingCentralSdk::REST::Messages.new(self)
+      @instance_headers = opts[:headers] || {}
+
+      @messages = RingCentralSdk::REST::Messages.new self
     end
 
-    def app_config(app_config)
-      @app_config = app_config
+    def app_config=(new_app_config)
+      @app_config = new_app_config
       @oauth2client = new_oauth2_client()
     end
 
@@ -93,53 +97,60 @@ module RingCentralSdk::REST
       return built_urls
     end
 
-    def authorize_url(opts={})
+    def authorize_url(opts = {})
       @oauth2client.auth_code.authorize_url(_add_redirect_uri(opts))
     end
 
-    def authorize_code(code, opts={})
+    def authorize_code(code, opts = {})
       token = @oauth2client.auth_code.get_token(code, _add_redirect_uri(opts))
       set_token(token)
       return token
     end
 
-    def _add_redirect_uri(opts={})
+    def _add_redirect_uri(opts = {})
       if !opts.key?(:redirect_uri) && @app_config.redirect_url.to_s.length > 0
         opts[:redirect_uri] = @app_config.redirect_url.to_s
       end
       return opts
     end
 
-    def authorize_password(username, extension='', password='', remember=false)
+    def authorize_password(username, extension = '', password = '', remember = false)
       token = @oauth2client.password.get_token(username, password, {
         extension: extension,
-        headers: { 'Authorization' => 'Basic ' + get_api_key() } })
+        headers: {'Authorization' => 'Basic ' + get_api_key()}})
       set_token(token)
       return token
     end
 
-    def authorize_user(user, remember=false)
+    def authorize_user(user, remember = false)
       authorize_password(user.username, user.extension, user.password)
     end
 
     def set_token(token)
-      if token.is_a?(Hash)
+      if token.is_a? Hash
         token = OAuth2::AccessToken::from_hash(@oauth2client, token)
       end
 
-      unless token.is_a?(OAuth2::AccessToken)
+      unless token.is_a? OAuth2::AccessToken
         raise "Token is not a OAuth2::AccessToken"
       end
 
       @token = token
 
-      @http = Faraday.new(:url => api_version_url()) do |conn|
+      @http = Faraday.new(url: 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 => /\bjson$/
+        if @instance_headers.is_a? Hash 
+          @instance_headers.each do |k,v|
+            conn.headers[k] = v
+          end
+        end
+        conn.headers['RC-User-Agent'] = @user_agent
+        conn.headers['SDK-User-Agent'] = @user_agent
+        conn.response :json, content_type: /\bjson$/
+        conn.response :logger
         conn.adapter Faraday.default_adapter
       end
     end
@@ -154,7 +165,7 @@ module RingCentralSdk::REST
     def set_oauth2_client(client=nil)
       if client.nil?
         @oauth2client = new_oauth2_client()
-      elsif client.is_a?(OAuth2::Client)
+      elsif client.is_a? OAuth2::Client
         @oauth2client = client
       else
         fail "client is not an OAuth2::Client"
@@ -163,7 +174,7 @@ module RingCentralSdk::REST
 
     def get_api_key()
       api_key = (@app_config.key.is_a?(String) && @app_config.secret.is_a?(String)) \
-        ? Base64.encode64("#{@app_config.key}:#{@app_config.secret}").gsub(/[\s\t\r\n]/,'') : ''
+        ? Base64.encode64("#{@app_config.key}:#{@app_config.secret}").gsub(/\s/,'') : ''
       return api_key
     end
 
@@ -174,8 +185,10 @@ module RingCentralSdk::REST
         fail 'Request is not a RingCentralSdk::REST::Request::Base'
       end
 
+      method = request_sdk.method.to_s.downcase
+      method = 'get' if method.empty?
+
       res = nil
-      method = request_sdk.method.downcase
 
       case method
       when 'delete'
@@ -187,7 +200,7 @@ module RingCentralSdk::REST
       when 'put'
         res = @http.put { |req| req = inflate_request(req, request_sdk) }
       else
-        fail "#{method} not supported"
+        fail "method [#{method}] not supported"
       end
       return res
     end

data/lib/ringcentral_sdk/rest/config.rb

@@ -74,6 +74,15 @@ module RingCentralSdk::REST
       @server_url = ENV['RC_APP_SERVER_URL']
       @redirect_url = ENV['RC_APP_REDIRECT_URL']
     end
+
+    def to_hash
+      {
+        key: @key,
+        secret: @secret,
+        server_url: @server_url,
+        redirect_url: @redirect_url
+      }
+    end
   end
 end
 

data/lib/ringcentral_sdk/rest/subscription.rb

@@ -23,7 +23,7 @@ module RingCentralSdk::REST
     end
 
     def nil_subscription()
-      subscription       =  {
+      subscription        =  {
         'eventFilters'    => [],
         'expirationTime'  => '', # 2014-03-12T19:54:35.613Z
         'expiresIn'       => 0,
@@ -90,9 +90,8 @@ module RingCentralSdk::REST
         reset()
         changed
         notify_observers(e)
-        raise 'Subscribe HTTP Request Error'
+        raise 'Subscribe HTTP Request Error: ' + e.to_s
       end
-
     end
 
     def renew(events = nil)
@@ -134,9 +133,8 @@ module RingCentralSdk::REST
       end
 
       begin
-        url = 'subscription/' + @_subscription['id'].to_s
         response = @_client.http.delete do |req|
-          req.url = 'subscription' + @_subscription['id']
+          req.url 'subscription/' + @_subscription['id'].to_s
         end
         reset()
         changed

data/mkdocs.yml

@@ -22,6 +22,9 @@ pages:
 - ['usage/voice/Click-To-Call.md', 'Voice', 'Click-To-Call']
 - ['usage/messages/Call-Recordings.md', 'Voice', 'Call Recordings']
 
+## Answering Rules:
+- ['usage/answering-rules/Answering-Rules-Call-Forwarding.md', 'Answering Rules', 'Call Forwarding']
+
 ## Call Queues:
 - ['usage/callqueues/Member-Status.md', 'Call Queues', 'Member Status']
 

data/pubnub.log

@@ -0,0 +1,5 @@
+# Logfile created on 2016-03-21 00:44:14 -0700 by logger.rb/1.2.8
+I, [2016-03-21T00:44:14.724379 #4232]  INFO -- Pubnub::Client: Created new Pubnub::Client instance. Version: 3.8.0
+I, [2016-03-21T00:44:47.460102 #4234]  INFO -- Pubnub::Client: Created new Pubnub::Client instance. Version: 3.8.0
+I, [2016-03-21T00:45:55.441057 #4236]  INFO -- Pubnub::Client: Created new Pubnub::Client instance. Version: 3.8.0
+I, [2016-03-21T00:46:05.912837 #4238]  INFO -- Pubnub::Client: Created new Pubnub::Client instance. Version: 3.8.0

data/ringcentral_sdk.gemspec

@@ -7,7 +7,7 @@ version = $1
 Gem::Specification.new do |s|
   s.name        = 'ringcentral_sdk'
   s.version     = version
-  s.date        = '2016-02-13'
+  s.date        = '2016-04-23'
   s.summary     = 'RingCentral SDK - Ruby SDK for the RingCentral Connect Platform API'
   s.description = 'A Ruby SDK for the RingCentral Connect Platform API'
   s.authors     = ['John Wang']
@@ -28,6 +28,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'mime_builder', '~> 0'
   s.add_dependency 'multi_json', '~> 1.3'
   s.add_dependency 'oauth2', '~> 1.0', '>= 1.0.0'
-  s.add_dependency 'pubnub', '~> 3.7', '>= 3.7.3'
+  s.add_dependency 'pubnub', '~> 3.8', '>= 3.8.0'
   s.add_dependency 'timers', '~> 4.1'
 end

data/test/test_client.rb

@@ -16,6 +16,19 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
     assert_equal "bXlfYXBwX2tleTpteV9hcHBfc2VjcmV0", @rcsdk.send(:get_api_key)
   end
 
+  def test_config
+    redirect_url = 'http://localhost:4567/oauth'
+    client = RingCentralSdk.new(
+      'my_app_key',
+      'my_app_secret',
+      RingCentralSdk::RC_SERVER_SANDBOX,
+      {
+        redirect_url: redirect_url
+      }
+    )
+    assert_equal redirect_url, client.app_config.redirect_url
+  end
+
   def test_set_client
     rcsdk = new_client()
     assert_equal true, rcsdk.oauth2client.is_a?(OAuth2::Client)
@@ -183,7 +196,7 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
 
     client.oauth2client.password.stubs(:get_token).returns(stub_token)
 
-    token = client.authorize('my_test_username', 'my_test_extension', 'my_test_password')
+    client.authorize('my_test_username', 'my_test_extension', 'my_test_password')
 
     #@rcsdk.client.stubs(:post).returns(Faraday::Response.new)
     Faraday::Connection.any_instance.stubs(:post).returns(Faraday::Response.new)
@@ -263,7 +276,7 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
 
     client.oauth2client.password.stubs(:get_token).returns(stub_token)
 
-    token = client.authorize('my_test_username', 'my_test_extension', 'my_test_password')
+    client.authorize('my_test_username', 'my_test_extension', 'my_test_password')
 
     res = client.messages.sms.create(
       from: '+16505551212',

data/test/test_setup.rb

@@ -13,7 +13,7 @@ class RingCentralSdkTest < Test::Unit::TestCase
     assert_equal 'RingCentralSdk::REST::Client', @rcsdk.class.name
 
     assert_raise do
-      @rcsdk.request(nil)
+      @rcsdk.send_request(nil)
     end
 
     rcsdk = RingCentralSdk.new(

data/test/test_subscription.rb

@@ -195,7 +195,7 @@ class RingCentralSdkSubscriptionTest < Test::Unit::TestCase
 
   def test_pubnub
     sub = @rcsdk.create_subscription()
-    pub = sub.new_pubnub()
+    pub = sub.new_pubnub('test', false, '')
 
     assert_equal 'Pubnub::Client', pub.class.name
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2016-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -192,20 +192,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.3
+        version: 3.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.3
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: timers
   requirement: !ruby/object:Gem::Requirement
@@ -252,6 +252,7 @@ files:
 - lib/ringcentral_sdk/rest/simple_client.rb
 - lib/ringcentral_sdk/rest/subscription.rb
 - mkdocs.yml
+- pubnub.log
 - ringcentral_sdk.gemspec
 - test/test_base.rb
 - test/test_client.rb