ringcentral_sdk 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f9dcd84f1f05d75c88713e2670ef117ff10fbbc
-  data.tar.gz: 592200667132fc64debd755707acb7b89e820926
+  metadata.gz: e6ac4e79b4c9626cf8b931e0cf4776ac22d08909
+  data.tar.gz: 95084e7e2cd40c0567b13d53ae32d56baaeb9ef8
 SHA512:
-  metadata.gz: fdb5b49fd8ee320bf2309e976a106f4d721251e5b355b523c358394e6341ea50e6f8e5b869b40988efff9bba687a1b3a66860c132eaa782f7c5c2631a021a2f3
-  data.tar.gz: 0d84fb441b6be1b14fd92c6a164856ec3b80a6762c822bf8dad71adc7c8e5207f463124b40997d78f9ddf0704eaee17dfdc25d2ac1ac2645489e1b917031d5df
+  metadata.gz: 21c8a0f4d2c62ce147805ff28a0eaaaa7e4417a0e1864a04ccf86e7dacc1b6e30bd61188c2b5909c70cdedac713180d28bcb9bdd5f7cb2caaab29cfd493f7c83
+  data.tar.gz: e841e5c7960967dff3c008b1fb4f31e7568f8126444bd87467e9ab36afe020eca135947f9b3a14dd174e565e8066d129390b5b55ea136b1bdde4517e9fffa763

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 CHANGELOG
 ---------
+- **2015-12-08**: 0.5.1
+  - Add call recording transcription demo script via VoiceBase
+  - Fix PubNub unsubscribe bug
+  - Fix fax helper to support UTF-8 metadata with file attachment
+  - Update tests to support access token without refresh token
+  - Update sample scripts credentials file format to be more scalable
 - **2015-10-18**: 0.5.0
   - Add stubbed tests via `mocha`
   - Add `RingCentralSdk.new()` sugar method
@@ -48,4 +54,4 @@ CHANGELOG
 - **2015-03-08**: 0.0.2
   - Convert methods from camelCase to under_scores
 - **2015-03-07**: 0.0.1
-  - Initial release
+  - Initial release

data/README.md

@@ -1,15 +1,15 @@
 RingCentral SDK for Ruby
 ========================
 
-[![Gem Version](https://badge.fury.io/rb/ringcentral_sdk.svg)](http://badge.fury.io/rb/ringcentral_sdk)
-[![Build Status](https://img.shields.io/travis/grokify/ringcentral-sdk-ruby/master.svg)](https://travis-ci.org/grokify/ringcentral-sdk-ruby)
-[![Coverage Status](https://coveralls.io/repos/grokify/ringcentral-sdk-ruby/badge.svg?branch=master)](https://coveralls.io/r/grokify/ringcentral-sdk-ruby?branch=master)
-[![Dependency Status](https://gemnasium.com/grokify/ringcentral-sdk-ruby.svg)](https://gemnasium.com/grokify/ringcentral-sdk-ruby)
-[![Code Climate](https://codeclimate.com/github/grokify/ringcentral-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/grokify/ringcentral-sdk-ruby)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/grokify/ringcentral-sdk-ruby/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/grokify/ringcentral-sdk-ruby/?branch=master)
-[![Docs](https://img.shields.io/badge/docs-readthedocs-blue.svg)](http://ringcentral-sdk-ruby.readthedocs.org/)
-[![Docs](https://img.shields.io/badge/docs-rubydoc-blue.svg)](http://www.rubydoc.info/gems/ringcentral_sdk/)
-[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/grokify/ringcentral-sdk-ruby/master/LICENSE.txt)
+[![Gem Version][gem-version-svg]][gem-version-link]
+[![Build Status][build-status-svg]][build-status-link]
+[![Coverage Status][coverage-status-svg]][coverage-status-link]
+[![Dependency Status][dependency-status-svg]][dependency-status-link]
+[![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
+[![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
+[![Docs][docs-readthedocs-svg]][docs-readthedocs-link]
+[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
+[![License][license-svg]][license-link]
 
 ## Table of contents
 
@@ -29,8 +29,9 @@ RingCentral SDK for Ruby
     3. [Fax Example](#fax-example)
   1. [Subscriptions](#subscriptions)
 5. [Supported Ruby Versions](#supported-ruby-versions)
-6. [Versioning](#versioning)
-7. [Change Log](#change-log)
+6. [Releases](#releases)
+  1. [Versioning](#versioning)
+  1. [Change Log](#change-log)
 8. [Links](#links)
 9. [Contributions](#contributions)
 10. [License](#license)
@@ -284,10 +285,7 @@ end
 To make subscriptions with RingCentral, use the SDK object to create subscription Observer object and then add observers to it.
 
 ```ruby
-sub = rcsdk.create_subscription()
-
-sub.subscribe(['/restapi/v1.0/account/~/extension/~/presence'])
-
+# Create an observer object
 class MyObserver
   def update(message)
     puts "Subscription Message Received"
@@ -295,9 +293,13 @@ class MyObserver
   end
 end
 
+# Create an observable subscription and add your observer
+sub = rcsdk.create_subscription()
+sub.subscribe(['/restapi/v1.0/account/~/extension/~/presence'])
 sub.add_observer(MyObserver.new())
 
-sub.destroy() # end the subscription
+# End the subscription
+sub.destroy()
 ```
 
 ## Supported Ruby Versions
@@ -313,13 +315,17 @@ This library supports and is [tested against](https://travis-ci.org/grokify/ring
 
 Note: Ruby 1.8.7 works except for subscription support which relies on the `pubnub` gem. If there is a need for 1.8.7 support, consider creating a GitHub issue so we can evalute creating a separate library for subscription handling.
 
-## Versioning
+## Releases
+
+Releases with release notes are availabe on [GitHub releases](https://github.com/grokify/ringcentral-sdk-ruby/releases). Release notes include a high level description of the release as well as lists of non-breaking and breaking changes.
+
+### Versioning
 
 This project is currently in development and the API can change. During initial development (Version 0.x.x), minor version changes will indicate either substantial feature inclusion or breaking changes.
 
 Once the project is version 1.0.0 or above, it will use [semantic versioning](http://semver.org/). At this time, breaking changes will be indicated by a change in major version.
 
-## Change Log
+### Change Log
 
 See [CHANGELOG.md](CHANGELOG.md)
 
@@ -352,3 +358,22 @@ 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
+
+ [gem-version-svg]: https://badge.fury.io/rb/ringcentral_sdk.svg
+ [gem-version-link]: http://badge.fury.io/rb/ringcentral_sdk
+ [build-status-svg]: https://api.travis-ci.org/grokify/ringcentral-sdk-ruby.svg?branch=master
+ [build-status-link]: https://travis-ci.org/grokify/ringcentral-sdk-ruby
+ [coverage-status-svg]: https://coveralls.io/repos/grokify/ringcentral-sdk-ruby/badge.svg?branch=master
+ [coverage-status-link]: https://coveralls.io/r/grokify/ringcentral-sdk-ruby?branch=master
+ [dependency-status-svg]: https://gemnasium.com/grokify/ringcentral-sdk-ruby.svg
+ [dependency-status-link]: https://gemnasium.com/grokify/ringcentral-sdk-ruby
+ [codeclimate-status-svg]: https://codeclimate.com/github/grokify/ringcentral-sdk-ruby/badges/gpa.svg
+ [codeclimate-status-link]: https://codeclimate.com/github/grokify/ringcentral-sdk-ruby
+ [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/grokify/ringcentral-sdk-ruby/badges/quality-score.png?b=master
+ [scrutinizer-status-link]: https://scrutinizer-ci.com/g/grokify/ringcentral-sdk-ruby/?branch=master
+ [docs-readthedocs-svg]: https://img.shields.io/badge/docs-readthedocs-blue.svg
+ [docs-readthedocs-link]: http://ringcentral-sdk-ruby.readthedocs.org/
+ [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
+ [docs-rubydoc-link]: http://www.rubydoc.info/gems/ringcentral_sdk/
+ [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
+ [license-link]: https://github.com/grokify/ringcentral-sdk-ruby/blob/master/LICENSE.txt

data/lib/ringcentral_sdk.rb

@@ -1,16 +1,17 @@
 module RingCentralSdk
 
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 
   RC_SERVER_PRODUCTION = 'https://platform.ringcentral.com'
   RC_SERVER_SANDBOX    = 'https://platform.devtest.ringcentral.com'
 
   autoload :Helpers, 'ringcentral_sdk/helpers'
   autoload :Platform, 'ringcentral_sdk/platform'
+  autoload :Simple, 'ringcentral_sdk/simple'
   autoload :Subscription, 'ringcentral_sdk/subscription'
 
   class << self
-    def new(app_key, app_secret, server_url=nil, opts={})
+    def new(app_key, app_secret, server_url=RC_SERVER_SANDBOX, opts={})
       RingCentralSdk::Platform.new(app_key, app_secret, server_url, opts)
     end
   end

data/lib/ringcentral_sdk/helpers/fax.rb

@@ -28,11 +28,14 @@ module RingCentralSdk::Helpers
     end
 
     def add_metadata(meta=nil)
+      base64_encode = true
       meta = inflate_metadata(meta)
       json = MultiJson.encode(meta)
+      json = Base64.encode64(json) if base64_encode
       json_part = MIME::Text.new(json)
       json_part.headers.delete('Content-Id')
-      json_part.headers.set('Content-Type','application/json')
+      json_part.headers.set('Content-Type', 'application/json')
+      json_part.headers.set('Content-Transfer-Encoding', 'base64') if base64_encode
       @msg.add(json_part)
       return true
     end

data/lib/ringcentral_sdk/platform.rb

@@ -157,7 +157,7 @@ module RingCentralSdk
       return api_key
     end
 
-    def request(helper=nil)
+    def send_request(helper=nil)
       unless helper.is_a?(RingCentralSdk::Helpers::Request)
         raise 'Request is not a RingCentralSdk::Helpers::Request'
       end
@@ -187,6 +187,7 @@ module RingCentralSdk
 
     alias_method :authorize, :authorize_password
     alias_method :login, :authorize_password
+    alias_method :request, :send_request
     private :get_api_version_url
   end
 end

data/lib/ringcentral_sdk/simple.rb

@@ -0,0 +1,88 @@
+module RingCentralSdk
+  class Simple
+    attr_accessor :rcsdk
+
+    def initialize(rcsdk)
+      @rcsdk = rcsdk
+    end
+
+    def send(request)
+      if request.is_a?(RingCentralSdk::Helpers::Request)
+        return @rcsdk.request(request)
+      elsif ! request.is_a?(Hash)
+        raise "Request is not a RingCentralSdk::Helpers::Request or Hash"
+      end
+
+      verb = request.has_key?(:verb) ? request[:verb].to_s.downcase : 'get'
+
+      if verb == 'get'
+        return get(request)
+      elsif verb == 'post'
+        return post(request)
+      elsif verb == 'put'
+        return put(request)
+      elsif verb == 'delete'
+        return delete(request)
+      else
+        raise 'Method not supported'
+      end
+    end
+
+    def delete(opts={})
+      return @rcsdk.client.delete do |req|
+        req.url build_url(opts[:path])
+      end
+    end
+
+    def get(opts={})
+      return @rcsdk.client.get do |req|
+        req.url build_url(opts[:path])
+      end
+    end
+
+    def post(opts={})
+      return @rcsdk.client.post do |req|
+        req.url build_url(opts[:path])
+        if opts.has_key?(:body)
+          req.body = opts[:body]
+          if opts[:body].is_a?(Hash)
+            req.headers['Content-Type'] = 'application/json'
+          end
+        end
+      end
+    end
+
+    def put(opts={})
+      return @rcsdk.client.put do |req|
+        req.url build_url(opts[:path])
+        if opts.has_key?(:body)
+          req.body = opts[:body]
+          if opts[:body].is_a?(Hash)
+            req.headers['Content-Type'] = 'application/json'
+          end
+        end
+      end
+    end
+
+    def build_url(path)
+      url = ''
+      if !path.is_a?(Array)
+        path = [path]
+      end
+      if path.length>0
+        path0 = path[0].to_s
+        if path0 !~ /\//
+          if path0.index('account') != 0
+            if path0.index('extension') != 0
+              path.unshift('extension/~')
+            end
+            path.unshift('account/~')
+          end
+        end
+      end
+      url = path.join('/')
+      return url
+    end
+
+  end
+end

data/lib/ringcentral_sdk/subscription.rb

@@ -242,7 +242,9 @@ module RingCentralSdk
 
     def _unsubscribe_at_pubnub()
       if @_pubnub && alive?()
-        @_pubnub.unsubscribe(@_subscription['deliveryMode']['address'])
+        @_pubnub.unsubscribe(channel: @_subscription['deliveryMode']['address']) do |envelope|
+          # puts envelope.message
+        end
       end
     end
 

data/test/test_helper_fax.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require './test/test_helper.rb'
 
 class RingCentralSdkHelperFaxTest < Test::Unit::TestCase
@@ -23,7 +25,7 @@ class RingCentralSdkHelperFaxTest < Test::Unit::TestCase
         # phone numbers are in E.164 format with or without leading '+'
         "to"           => { :phoneNumber => '+16505551212' },
         :faxResolution => 'High',
-        :coverPageText => 'RingCentral fax demo using Ruby SDK!'
+        :coverPageText => 'RingCentral fax demo using Ruby SDK Résolution!'
       },
       :file_name => './scripts/test_file.pdf'
     )
@@ -34,6 +36,9 @@ class RingCentralSdkHelperFaxTest < Test::Unit::TestCase
       fax2.add_file('non-existent_file_path')
     end
 
+    # Test UTF-8 metadata and file MIME concatenation
+    body = fax2.body
+
     fax3 = RingCentralSdk::Helpers::CreateFaxRequest.new(
       { :account_id => 111111111, :extension_id => 222222222 }, # Can be nil or {} for defaults '~'
       {

data/test/test_platform.rb

@@ -92,7 +92,7 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
     rcsdk = new_rcsdk()
     rcsdk.set_oauth2_client()
 
-    stub_token_hash = data_auth_token
+    stub_token_hash = data_auth_token_with_refresh
     stub_token = OAuth2::AccessToken::from_hash(rcsdk.oauth2client, stub_token_hash)
 
     rcsdk.oauth2client.auth_code.stubs(:get_token).returns(stub_token)
@@ -104,7 +104,7 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
     rcsdk = new_rcsdk({:redirect_uri => 'http://localhost:4567/oauth'})
     rcsdk.set_oauth2_client()
 
-    stub_token_hash = data_auth_token
+    stub_token_hash = data_auth_token_with_refresh
     stub_token = OAuth2::AccessToken::from_hash(rcsdk.oauth2client, stub_token_hash)
 
     rcsdk.oauth2client.auth_code.stubs(:get_token).returns(stub_token)
@@ -138,11 +138,11 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
     assert_equal 'OAuth2::AccessToken', rcsdk.token.class.name
   end
 
-  def test_authorize_password
+  def test_authorize_password_with_refresh
     rcsdk = new_rcsdk()
     rcsdk.set_oauth2_client()
 
-    stub_token_hash = data_auth_token
+    stub_token_hash = data_auth_token_with_refresh
     stub_token = OAuth2::AccessToken::from_hash(rcsdk.oauth2client, stub_token_hash)
 
     rcsdk.oauth2client.password.stubs(:get_token).returns(stub_token)
@@ -150,6 +150,22 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
     token = rcsdk.authorize('my_test_username', 'my_test_extension', 'my_test_password')
     assert_equal 'OAuth2::AccessToken', token.class.name
     assert_equal 'OAuth2::AccessToken', rcsdk.token.class.name
+    assert_equal 'my_test_access_token_with_refresh', rcsdk.token.token
+  end
+
+  def test_authorize_password_without_refresh
+    rcsdk = new_rcsdk()
+    rcsdk.set_oauth2_client()
+
+    stub_token_hash = data_auth_token_without_refresh
+    stub_token = OAuth2::AccessToken::from_hash(rcsdk.oauth2client, stub_token_hash)
+
+    rcsdk.oauth2client.password.stubs(:get_token).returns(stub_token)
+
+    token = rcsdk.authorize('my_test_username', 'my_test_extension', 'my_test_password')
+    assert_equal 'OAuth2::AccessToken', token.class.name
+    assert_equal 'OAuth2::AccessToken', rcsdk.token.class.name
+    assert_equal 'my_test_access_token_without_refresh', rcsdk.token.token
   end
 
   def test_request
@@ -160,7 +176,7 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
     rcsdk = new_rcsdk()
     rcsdk.set_oauth2_client()
 
-    stub_token_hash = data_auth_token
+    stub_token_hash = data_auth_token_with_refresh
     stub_token = OAuth2::AccessToken::from_hash(rcsdk.oauth2client, stub_token_hash)
 
     rcsdk.oauth2client.password.stubs(:get_token).returns(stub_token)
@@ -193,9 +209,9 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
     )
   end
 
-  def data_auth_token
+  def data_auth_token_with_refresh
     json = '{
-  "access_token": "my_test_access_token",
+  "access_token": "my_test_access_token_with_refresh",
   "token_type": "bearer",
   "expires_in": 3599,
   "refresh_token": "my_test_refresh_token",
@@ -206,4 +222,18 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
     data = JSON.parse(json, :symbolize_names=>true)
     return data
   end
+
+  def data_auth_token_without_refresh
+    json = '{
+  "access_token": "my_test_access_token_without_refresh",
+  "token_type": "bearer",
+  "expires_in": 3599,
+  "scope": "ReadCallLog DirectRingOut EditCallLog ReadAccounts Contacts EditExtensions ReadContacts SMS EditPresence RingOut EditCustomData ReadPresence EditPaymentInfo Interoperability Accounts NumberLookup InternalMessages ReadCallRecording EditAccounts Faxes EditReportingSettings ReadClientInfo EditMessages VoipCalling ReadMessages",
+  "owner_id": "1234567890"
+      }'
+    data = JSON.parse(json, :symbolize_names=>true)
+    return data
+  end
+
+  alias_method :data_auth_token, :data_auth_token_with_refresh
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-18 00:00:00.000000000 Z
+date: 2015-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -134,20 +134,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.7.3
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: timers
   requirement: !ruby/object:Gem::Requirement
@@ -174,6 +160,7 @@ files:
 - lib/ringcentral_sdk/helpers/request.rb
 - lib/ringcentral_sdk/helpers.rb
 - lib/ringcentral_sdk/platform.rb
+- lib/ringcentral_sdk/simple.rb
 - lib/ringcentral_sdk/subscription.rb
 - lib/ringcentral_sdk.rb
 - CHANGELOG.md