ringcentral_sdk 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df5aca1bce66925c5e3e14d134fba3f5b53625e9
-  data.tar.gz: 811bac728f717e58b0ab0f7c5c1b420468103c3f
+  metadata.gz: 98d2a8eb022ff4511a3d145f3b5aa893f30ba796
+  data.tar.gz: 163dd6efc182dda1ab77523d21955fa5ac8b7348
 SHA512:
-  metadata.gz: 99e6878c0e06d67cd959eabad0ae6291714f7d11e9ab00f8d22de5fcd72f873ccbca7001f0b4fd097c1899c2c6f04be1f2b7edcac6129e9d8d049fa751ec7763
-  data.tar.gz: 2878c4c401b37fbe11c2ca7b7a3066bedcc5f62542f8de8dfb1071070608d0deea9b131f580ec8b2dd19f43d644ffa8c788e98031afba5832fa43a0f86b012a6
+  metadata.gz: d5d99ea86065b3c9c52af955f6171541205ab90cf047c0a7502f3ff280e4920178a96ef1b772c5c0c276bcb63f08c3c63eb9699a1f39d8db43b595cb758ba2bd
+  data.tar.gz: 684f7792e42327cc036917a9f41e09d711ccad403e2b7417892b9b3a6b3c2d826f005ad45e90ba0148f8186c959897064538165c97bd8d9f889f91878bc632f3

data/CHANGELOG.md

@@ -1,12 +1,34 @@
 CHANGELOG
 ---------
-- **2016-01-23**: 0.9.0
-  - Major refactor
-  - Add `RingCentral::REST::Config` and dotenv support
+- **2016-02-07**: 1.1.0
+  - Add Subscription to Retrieve New Messages functionality
+    - `./lib`
+      - Add `RingCentralSdk::REST::Event`
+      - Add `RingCentralSdk::REST::MessagesRetriever`
+      - Add `RingCentralSdk::REST::Request::Simple`
+      - Update `RingCentralSdk::REST::Client` - update `send_request`
+      - Update `RingCentralSdk::REST::Request::Base` - add `headers`
+    - `./scripts`
+      - Add `scripts/fax_download.rb` demo script
+      - Add `scripts/fax_download_new.rb` demo script
+      - Add `scripts/sms_to_chat.rb` demo script to send inbound SMS to chat
+- **2016-01-26**: 1.0.0
+  - Major refactor focusing on naming changes to improve consistency
+    - All code moved into `RingCentralSdk::REST` namespace
+    - Update: rename `RingCentralSdk::Platform` to `RingCentralSdk::REST::Client`
+    - Update: rename `RingCentralSdk::Platform::client` to `RingCentralSdk::REST::Client::http`
+    - Update: rename `RingCentralSdk::Helpers` namespace to `RingCentralSdk::Request`
+  - Add `RingCentralSdk::REST::Config` to support `dotenv` config files
+    - Add `RingCentralSdk::REST::Config` reads dotenv files
+    - Add `scripts/account-extensions.rb` script
+    - Update sample scripts to use new Config object
+  - Add `RingCentral::REST::Messages`, `RingCentral::REST::Messages::MessagesSMS` and `RingCentral::REST::Messages::MessagesFax`
+  - Update `RingCentralSdk::REST::Request::Fax` helper for nicer interface, formerly `RingCentralSdk::Helpers::Fax`
 - **2016-01-22**: 0.5.2
-  - Add `RingCentralSdk::Cache::Extensions`
-  - Add `RingCentralSdk::Helpers::ExtensionPresence`
-  - Add Call Queue Member Status mydocs documentation
+  - Add Call Queue Management support
+    - Add `RingCentralSdk::Cache::Extensions`
+    - Add `RingCentralSdk::Helpers::ExtensionPresence`
+    - Add Call Queue Member Status mydocs documentation
 - **2015-12-08**: 0.5.1
   - Add call recording transcription demo script via VoiceBase
   - Fix PubNub unsubscribe bug
@@ -15,19 +37,23 @@ CHANGELOG
   - 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
-  - Modify `RingCentralSdk::RC_SERVER_PRODUCTION` url from `RingCentralSdk::Sdk::RC_SERVER_Production`
-  - Remove `lib/ringcentral_sdk/sdk.rb` file and `RingCentralSdk::Sdk` class
-  - Remove `lib/ringcentral_sdk/version.rb` file
-  - Remove `VERSION.txt` file
+  - Update naming and cleanup interface
+    - Add `RingCentralSdk.new()` sugar method
+    - Update `RingCentralSdk::RC_SERVER_PRODUCTION` url from `RingCentralSdk::Sdk::RC_SERVER_Production`
+    - Delete `lib/ringcentral_sdk/sdk.rb` file and `RingCentralSdk::Sdk` class
+    - Delete `lib/ringcentral_sdk/version.rb` file
+    - Delete `VERSION.txt` file
 - **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`
+  - Add OAuth `authorization_code` support
+    - './lib'
+      - Add 3-Legged OAuth support via platform `authorize_url` and `authorize_code` methods
+      - Update SDK initialization by converting optional params to options hash
+      - Update `RingCentralSdk::Platform::Platform` to `RingCentralSdk::Platform`
+    - './scripts'
+      - 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
 - **2015-10-07**: 0.3.0
   - Add subscription support via PubNub
   - Add `ruby-head`, `jruby`, `jruby-head`, and `rbx-2` to Travis CI

data/Gemfile

@@ -5,6 +5,7 @@ gem 'dotenv'
 gem 'faraday', '~> 0.9.0'
 gem 'faraday_middleware'
 gem 'faraday_middleware-oauth2_refresh'
+gem 'jsondoc'
 gem 'logger'
 gem 'mime'
 gem 'mime-types'

data/Gemfile.lock

@@ -24,6 +24,7 @@ GEM
     http-cookie (1.0.2)
       domain_name (~> 0.5)
     json (1.8.3)
+    jsondoc (0.1.0)
     jwt (1.5.2)
     logger (1.2.8)
     metaclass (0.0.4)
@@ -82,6 +83,7 @@ DEPENDENCIES
   faraday (~> 0.9.0)
   faraday_middleware
   faraday_middleware-oauth2_refresh
+  jsondoc
   logger
   mime
   mime-types
@@ -94,3 +96,6 @@ DEPENDENCIES
   simplecov
   test-unit
   timers
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -22,10 +22,12 @@ RingCentral SDK for Ruby
   1. [Authorization](#authorization)
     1. [Password Grant](#password-grant)
     1. [Authorization Code Grant](#authorization-code-grant)
+    1. [Token Reuse](#token-reuse)
   1. [API Requests](#api-requests)
     1. [Generic HTTP Requests](#generic-http-requests)
     2. [SMS Example](#sms-example)
     3. [Fax Example](#fax-example)
+  1. [Advanced Use Cases](#advanced-use-cases)
 5. [Supported Ruby Versions](#supported-ruby-versions)
 6. [Releases](#releases)
   1. [Versioning](#versioning)
@@ -40,19 +42,16 @@ A library for using the [RingCentral REST API](https://developers.ringcentral.co
 
 ## Documentation
 
-Documentation is available on:
+Full documentation and resources are available at:
 
-1. [Read the Docs](http://ringcentral-sdk-ruby.readthedocs.org/)
-2. [RubyDoc](http://www.rubydoc.info/gems/ringcentral_sdk/). 
+1. [Ruby SDK Developer Guide](http://ringcentral-sdk-ruby.readthedocs.org/) - Read the Docs
+2. [Ruby SDK Reference Guide](http://www.rubydoc.info/gems/ringcentral_sdk/) - RubyDoc.info
 
-Read the Docs is the primary documentation solution used, however, RubyDoc is useful for examining code.
+For API information, see the official RingCentral resources:
 
-In addition the documentation for this Ruby SDK, refer to the official RingCentral guides for
-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. [Dev Tutorial](http://ringcentral.github.io/tutorial/)
+1. [API Developer and Reference Guide](https://developers.ringcentral.com/api-docs/latest/index.html)
+1. [API Explorer](https://developer.ringcentral.com/api-explorer/)
+1. [CTI Tutorial](http://ringcentral.github.io/tutorial/)
 
 ## Installation
 
@@ -73,12 +72,6 @@ $ gem install ringcentral_sdk
 
 ## Usage
 
-This provides a very basic guide to using the SDK. Please use the following resources for more information:
-
-1. [SDK Developer Guide](http://ringcentral-sdk-ruby.readthedocs.org/)
-2. [SDK Reference](http://www.rubydoc.info/gems/ringcentral_sdk/). 
-1. [API Developer and Reference Guide](https://developers.ringcentral.com/api-docs/latest/index.html)
-
 ### Instantiation and Authorization
 
 How you instantiate the SDK can depend on whether you use OAuth 2.0 password grant or the authorization code grant which are both described here.
@@ -118,7 +111,7 @@ client = RingCentralSdk::REST::Client.new(
   'myAppKey',
   'myAppSecret',
   RingCentralSdk::RC_SERVER_SANDBOX,
-  {:redirect_uri => 'http://example.com/oauth'}
+  {redirect_uri: 'http://example.com/oauth'}
 )
 
 # Retrieve OAuth authorize url using default redirect URL
@@ -175,9 +168,9 @@ http = client.http
 
 ```ruby
 client.messages.sms.create(
-  :from => '+16505551212',
-  :to => '+14155551212',
-  :text => 'Hi there!'
+  from: '+16505551212',
+  to: '+14155551212',
+  text: 'Hi there!'
 )
 ```
 
@@ -187,9 +180,9 @@ Fax files:
 
 ```ruby
 client.messages.fax.create(
-  :to => '+14155551212',
-  :coverPageText => 'Hi there!',
-  :files => ['/path/to/myfile.pdf']
+  to: '+14155551212',
+  coverPageText: 'Hi there!',
+  files: ['/path/to/myfile.pdf']
 )
 ```
 
@@ -197,9 +190,9 @@ Fax text:
 
 ```ruby
 client.messages.fax.create(
-  :to => '+14155551212',
-  :coverPageText => 'Hi there!',
-  :text => 'Hi there!'
+  to: '+14155551212',
+  coverPageText: 'Hi there!',
+  text: 'Hi there!'
 )
 ```
 
@@ -227,6 +220,11 @@ sub.subscribe(['/restapi/v1.0/account/~/extension/~/presence'])
 sub.destroy()
 ```
 
+### Advanced Use Cases
+
+1. [Subscribing to All Extensions](http://ringcentral-sdk-ruby.readthedocs.org/en/latest/usage/notifications/Subscriptions-All-Extensions/)
+1. [Managing Call Queue Member Status](http://ringcentral-sdk-ruby.readthedocs.org/en/latest/usage/callqueues/Member-Status/)
+
 ## Supported Ruby Versions
 
 This library supports and is [tested against](https://travis-ci.org/grokify/ringcentral-sdk-ruby) the following Ruby implementations:
@@ -247,9 +245,8 @@ Releases with release notes are availabe on [GitHub releases](https://github.com
 
 ### 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.
+* Versions 1.0.0 and above follow [semantic versioning](http://semver.org/). Breaking changes will be indicated by a change in major version.
+* Versions below 1.0.0 are in active development. During initial development (Version 0.x.x), minor version changes will indicate either substantial feature inclusion or breaking changes.
 
 ### Change Log
 
@@ -273,11 +270,13 @@ RingCentral Official SDKs
 
 * https://github.com/ringcentral
 
-## Contributions
-
-Any reports of problems, comments or suggestions are most welcome.
+## Contributing
 
-Please report these on [Github](https://github.com/grokify/ringcentral-sdk-ruby)
+1. Fork it ( http://github.com/grokify/ringcentral-sdk-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
 ## License
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'rake'
 require 'rake/testtask'
 
 desc 'Default: run unit tests.'
-task :default => :test
+task default: :test
 
 desc 'Test the library.'
 Rake::TestTask.new do |t|

data/lib/ringcentral_sdk/rest/client.rb

@@ -112,8 +112,8 @@ module RingCentralSdk::REST
 
     def authorize_password(username, extension='', password='', remember=false)
       token = @oauth2client.password.get_token(username, password, {
-        :extension => extension,
-        :headers   => { 'Authorization' => 'Basic ' + get_api_key() } })
+        extension: extension,
+        headers: { 'Authorization' => 'Basic ' + get_api_key() } })
       set_token(token)
       return token
     end
@@ -134,21 +134,21 @@ module RingCentralSdk::REST
       @token = token
 
       @http = Faraday.new(:url => api_version_url()) do |conn|
-        conn.request  :oauth2_refresh, @token
-        conn.request  :json
-        conn.request  :url_encoded
+        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$/
-        conn.adapter  Faraday.default_adapter
+        conn.adapter Faraday.default_adapter
       end
     end
 
     def new_oauth2_client()
       return OAuth2::Client.new(@app_config.key, @app_config.secret,
-        :site          => @app_config.server_url,
-        :authorize_url => AUTHZ_ENDPOINT,
-        :token_url     => TOKEN_ENDPOINT)
+        site: @app_config.server_url,
+        authorize_url: AUTHZ_ENDPOINT,
+        token_url: TOKEN_ENDPOINT)
     end
 
     def set_oauth2_client(client=nil)
@@ -167,19 +167,44 @@ module RingCentralSdk::REST
       return api_key
     end
 
-    def send_request(request=nil)
-      unless request.is_a?(RingCentralSdk::REST::Request::Base)
+    def send_request(request_sdk = nil)
+      unless request_sdk.is_a?(RingCentralSdk::REST::Request::Base)
         fail 'Request is not a RingCentralSdk::REST::Request::Base'
       end
 
-      if request.method.downcase == 'post'
-        resp       =  @http.post do |req|
-          req.url request.url
-          req.headers['Content-Type'] = request.content_type if request.content_type
-          req.body = request.body if request.body
-        end
-        return resp
+      res = nil
+
+      method = request_sdk.method.downcase
+      case method
+      when 'delete'
+        res = @http.delete { |req| req = inflate_request(req, request_sdk) }
+      when 'get'
+        res = @http.get { |req| req = inflate_request(req, request_sdk) }
+      when 'post'
+        res = @http.post { |req| req = inflate_request(req, request_sdk) }
+      when 'put'
+        res = @http.put { |req| req = inflate_request(req, request_sdk) }
+      else
+        fail "#{method} not support"
+      end
+      return res
+    end
+
+    def inflate_request(req_faraday, req_sdk)
+      req_faraday.url req_sdk.url
+      req_faraday.body = req_sdk.body if req_sdk.body
+      if req_sdk.params.is_a? Hash 
+        req_sdk.params.each { |k,v| req_faraday.params[k] = v }
+      end
+      if req_sdk.headers.is_a? Hash 
+        req_sdk.headers.each { |k,v| req_faraday.headers[k] = v }
+      end
+
+      ct = req_sdk.content_type
+      if !ct.nil? && ct.to_s.length > 0
+        req_faraday.headers['Content-Type'] = ct.to_s
       end
+      return req_faraday
     end
 
     def get_user_agent()

data/lib/ringcentral_sdk/rest/event.rb

@@ -0,0 +1,61 @@
+require 'jsondoc'
+require 'multi_json'
+
+module RingCentralSdk::REST
+  class Event
+    attr_accessor :doc
+    def initialize(data = nil)
+      if data.is_a? JsonDoc::Document
+        @doc = data
+      elsif data.is_a? Hash
+        data = _symbolize_keys data
+        @doc = JsonDoc::Document.new(data, false, false, false)
+      elsif data.nil?
+        @doc = JsonDoc::Document.new({}, false, false, false)
+      else
+        raise 'initialize needs JsonDoc::Document or Hash argument'
+      end
+    end
+
+    def _hash_has_string_keys(hash={})
+      hash.each do |k,v|
+        return true if k.is_a? String
+      end
+      return false
+    end
+
+    def _symbolize_keys(hash={})
+      if _hash_has_string_keys hash
+        return MultiJson.decode(MultiJson.encode(hash), :symbolize_keys=>true)
+      end
+      return hash
+    end
+
+    def new_fax_count
+      new_type_count('fax')
+    end
+
+    def new_sms_count
+      new_type_count('sms')
+    end
+
+    def new_type_count(type)
+      count = 0
+      have_type = false
+      changes = @doc.getAttr('body.changes')
+      if changes.is_a?(Array) && changes.length > 0
+        changes.each do |change|
+          if change.key?(:type) && change[:type].to_s.downcase == type
+            have_type = true
+            if change.key?(:newCount)
+              count += change[:newCount]
+            end
+          end
+        end
+      end
+      return have_type ? count : -1
+    end
+
+    private :_hash_has_string_keys, :_symbolize_keys
+  end
+end

data/lib/ringcentral_sdk/rest/extension.rb

@@ -1,12 +1,12 @@
 module RingCentralSdk::REST
   class Extension
-  	attr_reader :extension_id
-  	attr_reader :presence
-  	attr_accessor :client
-  	def initialize(extension_id, opts={})
-  	  @extension_id = extension_id
-  	  @client = opts.has_key?(:client) ? opts[:client] : nil
+    attr_reader :extension_id
+    attr_reader :presence
+    attr_accessor :client
+    def initialize(extension_id, opts={})
+      @extension_id = extension_id
+      @client = opts.has_key?(:client) ? opts[:client] : nil
       @presence = RingCentralSdk::REST::ExtensionPresence.new(extension_id, opts)
-  	end
+    end
   end
 end

data/lib/ringcentral_sdk/rest/extension_presence.rb

@@ -29,7 +29,7 @@ module RingCentralSdk::REST
     def department_calls_enable(enable)
       retrieve()
 
-      if !@presence_data.key?('dndStatus')
+      unless @presence.is_a?(Hash) && @presence_data.key?('dndStatus')
         raise 'invalid presence info'
       end
 
@@ -81,11 +81,11 @@ module RingCentralSdk::REST
 
     def new_status_dnd_department_calls(current_status, enable)
       new_statuses = {
-        :enable => {
+        enable: {
           'DoNotAcceptAnyCalls' => 'TakeDepartmentCallsOnly',
           'DoNotAcceptDepartmentCalls' => 'TakeAllCalls'
         },
-        :disable => {
+        disable: {
           'TakeAllCalls' => 'DoNotAcceptDepartmentCalls',
           'TakeDepartmentCallsOnly' => 'DoNotAcceptAnyCalls'
         }

data/lib/ringcentral_sdk/rest/messages.rb

@@ -22,9 +22,9 @@ module RingCentralSdk::REST
         req.url 'account/~/extension/~/sms'
         req.headers['Content-Type'] = 'application/json'
         req.body = {
-          :from =>   { :phoneNumber => opts[:from].to_s },
-          :to   => [ { :phoneNumber => opts[:to].to_s } ],
-          :text => opts[:text].to_s
+          from: { phoneNumber: opts[:from].to_s },
+          to: [ { phoneNumber: opts[:to].to_s } ],
+          text: opts[:text].to_s
         }
       end
       return response
@@ -43,4 +43,4 @@ module RingCentralSdk::REST
       return @client.send_request(fax)
     end
   end
-end
+end

data/lib/ringcentral_sdk/rest/messages_retriever.rb

@@ -0,0 +1,45 @@
+require 'date'
+require 'jsondoc'
+
+module RingCentralSdk::REST
+  class MessagesRetriever
+    attr_accessor :range
+    def initialize(client)
+      @client = client
+      @range = 1.0 # minutes
+    end
+
+    def retrieve_for_event(event, params={})
+      unless event.is_a? RingCentralSdk::REST::Event
+        fail 'retrieve_for_event requires RingCentralSdk::REST::Event argument'
+      end
+      url = event.doc.getAttr :event
+      last_updated_s = event.doc.getAttr('body.lastUpdated')
+      last_updated_dt = DateTime.iso8601(last_updated_s)
+
+      params.merge!(
+        dateFrom: (last_updated_dt - (@range/1440.0)).to_s,
+        dateTo: (last_updated_dt + (@range/1440.0)).to_s)
+      
+      if event.new_sms_count > 0
+        params[:messageType] = 'SMS'
+      end
+
+      res = @client.http.get do |req|
+        req.url url
+        req.params = params
+      end
+
+      messages = []
+
+      res.body['records'].each do |rec|
+        rec_last_modified_time = rec['lastModifiedTime']
+        rec_last_modified_time_dt = DateTime.iso8601(rec_last_modified_time)
+        if rec_last_modified_time_dt == last_updated_dt
+          messages.push rec
+        end
+      end
+      return messages
+   end
+  end
+end

data/lib/ringcentral_sdk/rest/request/base.rb

@@ -1,16 +1,27 @@
 module RingCentralSdk::REST::Request
   class Base
-    def method()
-      return 'get'
+    def method
+      return 'get' # HTTP methods
     end
-    def url()
+
+    def url
       return ''
     end
-    def content_type()
-      return ''
+
+    def params
+      return {}
+    end
+
+    def headers
+      return {}
     end
-    def body()
+
+    def content_type
       return ''
     end
+
+    def body
+      return '' # '' || Hash
+    end
   end
-end
+end

data/lib/ringcentral_sdk/rest/request/fax.rb

@@ -25,16 +25,8 @@ module RingCentralSdk::REST::Request
     end
 
     def add_path(opts={})
-      if opts.key?(:accountId) && opts[:accountId].to_s.length>0
-        @account_id = opts[:accountId]
-      else
-        @account_id = '~'
-      end
-      if opts.key?(:extensionId) && opts[:extensionId].to_s.length>0
-        @extension_id = opts[:extensionId]
-      else
-        @extension_id = '~'
-      end
+      @account_id = opts[:accountId] ||= '~'
+      @extension_id = opts[:extensionId] ||= '~'
     end
 
     def add_part_meta(opts={})
@@ -57,12 +49,12 @@ module RingCentralSdk::REST::Request
       meta[:to] = inf.inflate_to_array opts[:to]
 
       processed = {
-        :accountId => 1,
-        :extensionId => 1,
-        :to    => 1,
-        :text  => 1,
-        :files => 1,
-        :parts => 1
+        accountId: 1,
+        extensionId: 1,
+        to: 1,
+        text: 1,
+        files: 1,
+        parts: 1
       }
 
       opts.each do |k,v|
@@ -118,4 +110,4 @@ module RingCentralSdk::REST::Request
       @msg.body.to_s
     end
   end
-end
+end

data/lib/ringcentral_sdk/rest/request/inflator.rb

@@ -1,3 +1,3 @@
 module RingCentralSdk::REST::Request::Inflator
   autoload :ContactInfo, 'ringcentral_sdk/rest/request/inflator/contact_info'
-end
+end

data/lib/ringcentral_sdk/rest/request/simple.rb

@@ -0,0 +1,40 @@
+module RingCentralSdk::REST::Request
+  class Simple < RingCentralSdk::REST::Request::Base
+    def initialize(opts = {})
+      @method = opts[:method]
+      @url = opts[:url]
+      @params = opts[:params]
+      @headers = opts[:headers]
+      @body = body.nil? ? '' : body
+      if body.is_a? Hash 
+        @headers = {} unless @headers.is_a? Hash 
+        @headers['Content-Type'] = 'application/json'
+      end
+
+      def content_type
+        ct = @headers.is_a?(Hash) \
+          ? @headers['Content-Type'] || '' : 'application/json'
+      end
+
+      def method
+        @method
+      end
+
+      def url
+        @url
+      end
+
+      def params
+        @params
+      end
+
+      def headers
+        @headers
+      end
+
+      def body
+        @body
+      end
+    end
+  end
+end

data/lib/ringcentral_sdk/rest/request.rb

@@ -2,4 +2,5 @@ module RingCentralSdk::REST::Request
   autoload :Base, 'ringcentral_sdk/rest/request/base'
   autoload :Fax, 'ringcentral_sdk/rest/request/fax'
   autoload :Inflator, 'ringcentral_sdk/rest/request/inflator'
-end
+  autoload :Simple, 'ringcentral_sdk/rest/request/simple'
+end

data/lib/ringcentral_sdk/rest/simple_client.rb

@@ -1,4 +1,20 @@
 module RingCentralSdk::REST
+
+  # A simplified, but still generic, REST interface.
+  #
+  # NOTE: This is an experimental module.
+  #
+  # client = RingCentralSdk::REST::Client.new ...
+  # simple = RingCentralSdk::REST::SimpleClient client
+  #
+  # simple.post(
+  #   path: 'sms',
+  #   body: {
+  #     from: {phoneNumber: '+16505551212'},
+  #     to: [{phoneNumber: '+14155551212'}],
+  #     text: 'Hi There!'
+  #   }
+  # )
   class SimpleClient
     attr_accessor :client
 
@@ -13,7 +29,7 @@ module RingCentralSdk::REST
         raise "Request is not a RingCentralSdk::Helpers::Request or Hash"
       end
 
-      verb = request.has_key?(:verb) ? request[:verb].to_s.downcase : 'get'
+      verb = request.key?(:verb) ? request[:verb].to_s.downcase : 'get'
 
       if verb == 'get'
         return get(request)
@@ -42,26 +58,25 @@ module RingCentralSdk::REST
 
     def post(opts={})
       return @client.http.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
+        req = inflate_request req, opts
       end
     end
 
     def put(opts={})
       return @client.http.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
+        req = inflate_request req, opts
+      end
+    end
+
+    def inflate_request(req, opts={})
+      req.url build_url(opts[:path])
+      if opts.key? :body
+        req.body = opts[:body]
+        if opts[:body].is_a?(Hash)
+          req.headers['Content-Type'] = 'application/json'
         end
       end
+      req
     end
 
     def build_url(path)
@@ -69,7 +84,7 @@ module RingCentralSdk::REST
       if !path.is_a?(Array)
         path = [path]
       end
-      if path.length>0
+      if path.length > 0
         path0 = path[0].to_s
         if path0 !~ /\//
           if path0.index('account') != 0
@@ -83,6 +98,5 @@ module RingCentralSdk::REST
       url = path.join('/')
       return url
     end
-
   end
 end

data/lib/ringcentral_sdk/rest/subscription.rb

@@ -46,7 +46,7 @@ module RingCentralSdk::REST
       return @_pubnub
     end
 
-    def register(events=nil)
+    def register(events = nil)
       return alive?() ? renew(events) : subscribe(events)
     end
 
@@ -54,7 +54,7 @@ module RingCentralSdk::REST
       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)
@@ -67,7 +67,7 @@ module RingCentralSdk::REST
     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
 
@@ -75,9 +75,9 @@ module RingCentralSdk::REST
         response = @_client.http.post do |req|
           req.url 'subscription'
           req.body = {
-            :eventFilters    => @_client.create_urls(@event_filters),
-            :deliveryMode    => {
-              :transportType => 'PubNub'
+            eventFilters: @_client.create_urls(@event_filters),
+            deliveryMode: {
+              transportType: 'PubNub'
             }
           }
         end
@@ -95,7 +95,7 @@ module RingCentralSdk::REST
 
     end
 
-    def renew(events=nil)
+    def renew(events = nil)
       set_events(events) if events.is_a?(Array)
 
       unless alive?()
@@ -112,7 +112,7 @@ module RingCentralSdk::REST
         response = @_client.http.put do |req|
           req.url 'subscription/' + @_subscription['id'].to_s
           req.body = {
-            :eventFilters => @_client.create_urls(@event_filters),
+            eventFilters: @_client.create_urls(@event_filters)
           }
         end
 
@@ -191,16 +191,17 @@ module RingCentralSdk::REST
       callback = lambda { |envelope|
       	_notify(envelope.msg)
       	changed
-      	notify_observers('GOT_PUBNUB_MESSAGE_NOTIFY')
+        #notify_observers {}
+      	#notify_observers('GOT_PUBNUB_MESSAGE_NOTIFY')
       }
 
       @_pubnub.subscribe(
-        :channel    => @_subscription['deliveryMode']['address'],
-        :callback   => callback,
-        :error      => lambda { |envelope| puts('ERROR: ' + envelope.msg.to_s) },
-        :connect    => lambda { |envelope| puts('CONNECTED') },
-        :reconnect  => lambda { |envelope| puts('RECONNECTED') },
-        :disconnect => lambda { |envelope| puts('DISCONNECTED') }
+        channel:    @_subscription['deliveryMode']['address'],
+        callback:   callback,
+        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
 
@@ -225,7 +226,7 @@ module RingCentralSdk::REST
         ciphertext = Base64.decode64(message)
         plaintext = cipher.update(ciphertext) + cipher.final
 
-        message = MultiJson.decode(plaintext)
+        message = MultiJson.decode(plaintext, :symbolize_keys=>false)
       end
 
       return message
@@ -257,7 +258,7 @@ module RingCentralSdk::REST
     end
 
     def _clear_timeout()
-      if @_timeout.is_a?(Timers::Group)
+      if @_timeout.is_a? Timers::Group
         @_timeout.cancel()
       end
     end
@@ -266,17 +267,16 @@ module RingCentralSdk::REST
       my_logger = Logger.new(STDOUT) if my_logger.nil?
 
       return Pubnub.new(
-        :subscribe_key    => subscribe_key.to_s,
-        :publish_key      => publish_key.to_s,
-        :error_callback   => lambda { |msg|
+        subscribe_key: subscribe_key.to_s,
+        publish_key: publish_key.to_s,
+        error_callback: lambda { |msg|
           puts "Error callback says: #{msg.inspect}"
         },
-        :connect_callback => lambda { |msg|
+        connect_callback: lambda { |msg|
           puts "CONNECTED: #{msg.inspect}"
         },
-        :logger => my_logger
+        logger: my_logger
       )
     end
-
   end
-end
+end

data/lib/ringcentral_sdk/rest.rb

@@ -5,11 +5,13 @@ module RingCentralSdk::REST
   autoload :ConfigApp, 'ringcentral_sdk/rest/config'
   autoload :ConfigUser, 'ringcentral_sdk/rest/config'
   autoload :ConfigEnvRc, 'ringcentral_sdk/rest/config'
+  autoload :Event, 'ringcentral_sdk/rest/event'
   autoload :Extension, 'ringcentral_sdk/rest/extension'
   autoload :ExtensionPresence, 'ringcentral_sdk/rest/extension_presence'
   autoload :Messages, 'ringcentral_sdk/rest/messages'
   autoload :MessagesFax, 'ringcentral_sdk/rest/messages'
   autoload :MessagesSMS, 'ringcentral_sdk/rest/messages'
+  autoload :MessagesRetriever, 'ringcentral_sdk/rest/messages_retriever'
   autoload :Request, 'ringcentral_sdk/rest/request'
   autoload :Subscription, 'ringcentral_sdk/rest/subscription'
-end
+end

data/lib/ringcentral_sdk.rb

@@ -1,6 +1,5 @@
 module RingCentralSdk
-
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
   RC_SERVER_PRODUCTION = 'https://platform.ringcentral.com'
   RC_SERVER_SANDBOX    = 'https://platform.devtest.ringcentral.com'
@@ -8,9 +7,8 @@ module RingCentralSdk
   autoload :REST, 'ringcentral_sdk/rest'
 
   class << self
-    def new(app_key, app_secret, server_url=RC_SERVER_SANDBOX, opts={})
+    def new(app_key, app_secret, server_url = RC_SERVER_SANDBOX, opts = {})
       RingCentralSdk::REST::Client.new(app_key, app_secret, server_url, opts)
     end
   end
-
-end
+end

data/mkdocs.yml

@@ -27,4 +27,5 @@ pages:
 
 ## Notifications:
 - ['usage/notifications/Subscriptions.md', 'Notifications', 'Subscriptions']
-- ['usage/notifications/Subscriptions-All-Extensions.md', 'Notifications', 'Subscribe to All Extensions']
+- ['usage/notifications/Subscribe_to_All_Extensions.md', 'Notifications', 'Subscribe to All Extensions']
+- ['usage/notifications/Subscribe_for_New_SMS.md', 'Notifications', 'Subscribe for New SMS']

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-01-21'
+  s.date        = '2016-02-07'
   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']
@@ -22,10 +22,12 @@ Gem::Specification.new do |s|
   s.add_dependency 'faraday', '~> 0.9', '>= 0.9'
   s.add_dependency 'faraday_middleware', '~> 0', '>= 0'
   s.add_dependency 'faraday_middleware-oauth2_refresh', '~> 0'
+  s.add_dependency 'jsondoc', '~> 0.1', '>= 0.1.0'
   s.add_dependency 'mime', '~> 0.4', '>= 0.4.3'
   s.add_dependency 'mime-types', '~> 1.25' # >= 1.9 '~> 2.5', '>= 2.5'
+  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 'timers', '~> 0'
+  s.add_dependency 'timers', '~> 4.1'
 end

data/test/test_client.rb

@@ -209,6 +209,49 @@ class RingCentralSdkPlatformTest < Test::Unit::TestCase
       :text          => 'RingCentral fax demo using Ruby SDK!'
     )
     assert_equal 'Faraday::Response', res.class.name
+
+    ######
+    # Simple Request - GET
+    ######
+    request = RingCentralSdk::REST::Request::Simple.new(
+      method: 'get',
+      url: 'account/~/extension/~/message-store',
+      params: {
+        direction: 'Inbound',
+        messageType: 'SMS'
+      }
+    )
+    assert_equal 'get', request.method
+
+    res = client.send_request request
+    assert_equal 'Faraday::Response', res.class.name
+
+    ######
+    # Simple Request - PUT
+    ######
+    request = RingCentralSdk::REST::Request::Simple.new(
+      method: 'put',
+      url: 'account/~/extension/~/message-store/11111111',
+      body: {
+        readStatus: 'Read'
+      }
+    )
+    assert_equal 'put', request.method
+
+    res = client.send_request request
+    assert_equal 'Faraday::Response', res.class.name
+
+    ######
+    # Simple Request - DELETE
+    ######
+    request = RingCentralSdk::REST::Request::Simple.new(
+      method: 'delete',
+      url: 'account/~/extension/~/message-store/11111111',
+    )
+    assert_equal 'delete', request.method
+
+    res = client.send_request request
+    assert_equal 'Faraday::Response', res.class.name
   end
 
   def test_sms

data/test/test_event.rb

@@ -0,0 +1,51 @@
+require './test/test_base.rb'
+require 'multi_json'
+
+class RingCentralSdkRESTEventTest < Test::Unit::TestCase
+  def test_new_sms_count
+    data = data_test_json_sms()
+
+    event = RingCentralSdk::REST::Event.new data
+
+    assert_equal '11112222-3333-4444-5555-666677778888', event.doc.getAttr('uuid')
+    assert_equal 1, event.new_sms_count
+    assert_equal -1, event.new_fax_count
+  end
+
+  def test_new_fax_count
+    data = data_test_json_fax()
+
+    event = RingCentralSdk::REST::Event.new data
+
+    assert_equal '11112222-3333-4444-5555-666677778888', event.doc.getAttr('uuid')
+    assert_equal -1, event.new_sms_count
+    assert_equal 1, event.new_fax_count
+  end
+
+  def test_new_empty
+    event = RingCentralSdk::REST::Event.new
+    assert_equal 'RingCentralSdk::REST::Event', event.class.name
+  end
+
+  def test_new_failure
+    assert_raise do
+      event = RingCentralSdk::REST::Event.new ''
+    end
+  end
+
+  def data_test_hash(opts={})
+    json = data_test_json()
+    hash = MultiJson.decode(json, symbolize_keys: false)
+    return hash
+  end
+
+  def data_test_json_sms
+    json = '{"uuid":"11112222-3333-4444-5555-666677778888","event":"/restapi/v1.0/account/~/extension/22222222/message-store","timestamp":"2016-01-31T00:15:30.196Z","body":{"extensionId":22222222,"lastUpdated":"2016-01-31T00:15:15.923+0000","changes":[{"type":"SMS","newCount":1,"updatedCount":1}]}}'
+    MultiJson.decode(json, symbolize_keys: true)
+  end
+
+  def data_test_json_fax
+    json = '{"uuid":"11112222-3333-4444-5555-666677778888","event":"/restapi/v1.0/account/~/extension/22222222/message-store","timestamp":"2016-02-07T14:28:29.010Z","body":{"extensionId":22222222,"lastUpdated":"2016-02-07T14:28:21.961+0000","changes":[{"type":"Fax","newCount":1,"updatedCount":0}]}}'
+    MultiJson.decode(json, symbolize_keys: false)
+  end
+end

data/test/test_extension_presence.rb

@@ -78,6 +78,14 @@ class RingCentralSdkRESTExtensionPresenceTest < Test::Unit::TestCase
     end
 
     presence.update({:dndStatus=>'TakeAllCalls'})
+
+    ######
+    # Test with good data
+    ######
+
+    assert_raise do
+      presence.department_calls_enable true
+    end
   end
 
   def data_extension_presence

data/test/test_helper_fax.rb

@@ -88,5 +88,12 @@ class RingCentralSdkHelperFaxTest < Test::Unit::TestCase
       :parts => [{:text=>'RingCentral fax demo using Ruby SDK!'}]
     )
     assert_equal 'account/111111111/extension/222222222/fax', fax6.url()
+
+    fax7 = RingCentralSdk::REST::Request::Fax.new(
+      :coverPageText => "RingCentral fax demo using Ruby SDK!",
+      :parts => [{:text=>'RingCentral fax demo using Ruby SDK!'}]
+    )
+    assert_equal '~', fax7.account_id
+    assert_equal '~', fax7.extension_id
   end
 end

data/test/test_helper_request.rb

@@ -2,12 +2,13 @@ require './test/test_base.rb'
 
 class RingCentralSdkHelperRequestTest < Test::Unit::TestCase
   def testSetup
-
     req = RingCentralSdk::REST::Request::Base.new
 
-    assert_equal 'get', req.method()
-    assert_equal '', req.url()
-    assert_equal '', req.content_type()
-    assert_equal '', req.body()
+    assert_equal 'get', req.method
+    assert_equal '', req.url
+    assert_equal 'Hash', req.params.class.name
+    assert_equal 'Hash', req.headers.class.name
+    assert_equal '', req.content_type
+    assert_equal '', req.body
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -84,6 +84,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jsondoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: mime
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +138,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: mime_builder
+  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: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -178,14 +212,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
 description: A Ruby SDK for the RingCentral Connect Platform API
 email: johncwang@gmail.com
 executables: []
@@ -204,22 +238,25 @@ files:
 - lib/ringcentral_sdk/rest/cache/extensions.rb
 - lib/ringcentral_sdk/rest/client.rb
 - lib/ringcentral_sdk/rest/config.rb
+- lib/ringcentral_sdk/rest/event.rb
 - lib/ringcentral_sdk/rest/extension.rb
 - lib/ringcentral_sdk/rest/extension_presence.rb
 - lib/ringcentral_sdk/rest/messages.rb
+- lib/ringcentral_sdk/rest/messages_retriever.rb
 - lib/ringcentral_sdk/rest/request.rb
 - lib/ringcentral_sdk/rest/request/base.rb
 - lib/ringcentral_sdk/rest/request/fax.rb
 - lib/ringcentral_sdk/rest/request/inflator.rb
 - lib/ringcentral_sdk/rest/request/inflator/contact_info.rb
+- lib/ringcentral_sdk/rest/request/simple.rb
 - lib/ringcentral_sdk/rest/simple_client.rb
 - lib/ringcentral_sdk/rest/subscription.rb
 - mkdocs.yml
-- ringcentral_sdk-0.5.2.gem
 - ringcentral_sdk.gemspec
 - test/test_base.rb
 - test/test_client.rb
 - test/test_config.rb
+- test/test_event.rb
 - test/test_extension_presence.rb
 - test/test_helper_fax.rb
 - test/test_helper_inflator_contact_info.rb