ringcentral_sdk 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6ac4e79b4c9626cf8b931e0cf4776ac22d08909
-  data.tar.gz: 95084e7e2cd40c0567b13d53ae32d56baaeb9ef8
+  metadata.gz: 96b95c556e178ef01ddbc722d0c3218957847cb0
+  data.tar.gz: 265aa9e0b869a20fd04a137e96639eb33ef63366
 SHA512:
-  metadata.gz: 21c8a0f4d2c62ce147805ff28a0eaaaa7e4417a0e1864a04ccf86e7dacc1b6e30bd61188c2b5909c70cdedac713180d28bcb9bdd5f7cb2caaab29cfd493f7c83
-  data.tar.gz: e841e5c7960967dff3c008b1fb4f31e7568f8126444bd87467e9ab36afe020eca135947f9b3a14dd174e565e8066d129390b5b55ea136b1bdde4517e9fffa763
+  metadata.gz: f4beda03bae9a21852650aea069973125272e0f9872450868588be2656ea3fc63129e0eb881191682c58db92715ac901cb858e2b96e014dd34d66738731491a4
+  data.tar.gz: 2841f8cd41b0db6df6fa5fd42a8faf7e83dafe3d35bf797c449fe456e5696b5fc0a02389f6f7eacbd87f9067187dccbf8fc593f82535a8df8012f025dd293ebf

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 John Wang
+Copyright (c) 2015-2016 John Wang
  
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -7,6 +7,7 @@ RingCentral SDK for Ruby
 [![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]
+[![Downloads][downloads-svg]][downloads-link]
 [![Docs][docs-readthedocs-svg]][docs-readthedocs-link]
 [![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
 [![License][license-svg]][license-link]
@@ -15,7 +16,6 @@ RingCentral SDK for Ruby
 
 1. [Overview](#overview)
   1. [Included](#included)
-  2. [To Do](#to-do)
 2. [Documentation](#documentation)
 3. [Installation](#installation)
 4. [Usage](#usage)
@@ -27,7 +27,6 @@ RingCentral SDK for Ruby
     1. [Generic HTTP Requests](#generic-http-requests)
     2. [SMS Example](#sms-example)
     3. [Fax Example](#fax-example)
-  1. [Subscriptions](#subscriptions)
 5. [Supported Ruby Versions](#supported-ruby-versions)
 6. [Releases](#releases)
   1. [Versioning](#versioning)
@@ -38,11 +37,7 @@ RingCentral SDK for Ruby
 
 ## Overview
 
-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.
-
-This SDK is an early stage library and subject to breaking changes.
+A gem for using the [RingCentral REST API](https://developers.ringcentral.com). [Click here to read the full documentation](http://ringcentral-sdk-ruby.readthedocs.org/)
 
 ### Included
 
@@ -53,16 +48,14 @@ This SDK is an early stage library and subject to breaking changes.
 * Unit test suite via `Test::Unit` and `mocha`
 * Docs via [Read the Docs](http://ringcentral-sdk-ruby.readthedocs.org/) and [RubyDoc](http://www.rubydoc.info/gems/ringcentral_sdk/)
 
-### To Do
+## Documentation
 
-There are no major to do items at this time.
+Documentation is available on:
 
-## Documentation
+1. [Read the Docs](http://ringcentral-sdk-ruby.readthedocs.org/)
+2. [RubyDoc](http://www.rubydoc.info/gems/ringcentral_sdk/). 
 
-More documentation is available on [Read the Docs](http://ringcentral-sdk-ruby.readthedocs.org/)
-and [RubyDoc](http://www.rubydoc.info/gems/ringcentral_sdk/). The documentation philosophy is to
-use RubyDoc / YARD for brief documentation and code specific docs while using Read the Docs for
-user guide / tutorial / FAQ style documentation.
+Read the Docs is the primary documentation solution used, however, RubyDoc is useful for examining code.
 
 In addition the documentation for this Ruby SDK, refer to the official RingCentral guides for
 more information on individual API calls:
@@ -75,15 +68,10 @@ more information on individual API calls:
 
 ### Via Bundler
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'ringcentral_sdk'
-```
-
-And then execute:
+Add 'ringcentral_sdk' to Gemfile and then run `bundle`:
 
 ```sh
+$ echo "gem 'ringcentral_sdk'" >> Gemfile
 $ bundle
 ```
 
@@ -97,6 +85,8 @@ $ gem install ringcentral_sdk
 
 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
@@ -153,13 +143,13 @@ auth_url = rcsdk.authorize_url()
 Customizing authorize URL:
 
 ```ruby
-rcsdk = RingCentralSdk.new(
+rcapi = RingCentralSdk.new(
   'myAppKey',
   'myAppSecret',
   RingCentralSdk::RC_SERVER_SANDBOX
 )
 # Retrieve OAuth authorize url using override redirect URL
-auth_url = rcsdk.authorize_url({
+auth_url = rcapi.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'
@@ -173,7 +163,7 @@ On your redirect page, you can exchange your authorization code for an access to
 
 ```ruby
 code  = params['code'] # retrieve GET 'code' parameter in Sinatra
-rcsdk.authorize_code(code)
+rcapi.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).
@@ -192,13 +182,13 @@ 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.new(
+rcapi2 = RingCentralSdk.new(
   'myAppKey',
   'myAppSecret',
   RingCentralSdk::RC_SERVER_SANDBOX
 )
 # set_token() accepts a hash or OAuth2::AccessToken object
-rcsdk2.set_token(token_hash)
+rcapi2.set_token(token_hash)
 ```
 
 Important! You have to manually maintain synchronization of SDK's between requests if you share authentication. When two simultaneous requests will perform refresh, only one will succeed. One of the solutions would be to have semaphor and pause other pending requests while one of them is performing refresh.
@@ -211,37 +201,20 @@ API requests can be made via the included `Faraday` client or `RingCentralSdk::H
 
 #### Generic HTTP Requests
 
-To make generic API requests, use included `Faraday` client which can be accessed via `rcsdk.client`. The client automatically adds the correct access token to the HTTP request and handles OAuth token refresh using the `OAuth` gem.
+To make generic API requests, use included `Faraday` client which can be accessed via `rcapi.client`. The client automatically adds the correct access token to the HTTP request and handles OAuth token refresh using the `OAuth` gem.
 
 ```ruby
-client = rcsdk.client
+client = rcapi.client
 ```
 
-Faraday request middleware has been loaded for the following:
-
-* `:oauth2_refresh`
-* `:json`
-* `:url_encoded`
-
-Faraday response middleware is loaded for the following:
-
-* `:json`
-
 #### SMS Example
 
-SMS and other requests can be easily sent directly without helpers.
-
 ```ruby
-# SMS Example
-response = rcsdk.client.post do |req|
-  req.url 'account/~/extension/~/sms'
-  req.headers['Content-Type'] = 'application/json'
-  req.body = {
-    :from =>   { :phoneNumber => '16505551212' },
-    :to   => [ { :phoneNumber => '14155551212'} ],
-    :text => 'RingCentral SMS demo using Ruby!'
-  }
-end
+rcapi.messages.create(
+  :from => '+16505551212',
+  :to => '+14155551212',
+  :text => 'Hi there!'
+)
 ```
 
 #### Fax Example
@@ -270,48 +243,27 @@ fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
 )
 
 # sending request via request helper methods
-response = rcsdk.request(fax)
+response = rcapi.request(fax)
 
 # sending request via standard Faraday client
-response = rcsdk.client.post do |req|
+response = rcapi.client.post do |req|
   req.url fax.url
   req.headers['Content-Type'] = fax.content_type
   req.body = fax.body
 end
 ```
 
-### Subscriptions
-
-To make subscriptions with RingCentral, use the SDK object to create subscription Observer object and then add observers to it.
-
-```ruby
-# Create an observer object
-class MyObserver
-  def update(message)
-    puts "Subscription Message Received"
-    puts JSON.dump(message)
-  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())
-
-# End the subscription
-sub.destroy()
-```
-
 ## Supported Ruby Versions
 
 This library supports and is [tested against](https://travis-ci.org/grokify/ringcentral-sdk-ruby) the following Ruby implementations:
 
-* Ruby 2.2.3, 2.2.0
-* Ruby 2.1.7, 2.1.0
-* Ruby 2.0.0
-* Ruby 1.9.3
-* [JRuby](http://jruby.org/)
-* [Rubinius](http://rubini.us/)
+1. Ruby 2.3.0
+2. Ruby 2.2.0
+3. Ruby 2.1.0
+4. Ruby 2.0.0
+5. Ruby 1.9.3
+6. [JRuby](http://jruby.org/)
+7. [Rubinius](http://rubinius.com/)
 
 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.
 
@@ -357,10 +309,12 @@ 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-2016 by John Wang
 
  [gem-version-svg]: https://badge.fury.io/rb/ringcentral_sdk.svg
  [gem-version-link]: http://badge.fury.io/rb/ringcentral_sdk
+ [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/ringcentral_sdk
+ [downloads-link]: https://rubygems.org/gems/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

data/lib/ringcentral_sdk.rb

@@ -1,10 +1,11 @@
 module RingCentralSdk
 
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 
   RC_SERVER_PRODUCTION = 'https://platform.ringcentral.com'
   RC_SERVER_SANDBOX    = 'https://platform.devtest.ringcentral.com'
 
+  autoload :Cache, 'ringcentral_sdk/cache'
   autoload :Helpers, 'ringcentral_sdk/helpers'
   autoload :Platform, 'ringcentral_sdk/platform'
   autoload :Simple, 'ringcentral_sdk/simple'

data/lib/ringcentral_sdk/cache.rb

@@ -0,0 +1,3 @@
+module RingCentralSdk::Cache
+  autoload :Extensions, 'ringcentral_sdk/cache/extensions'
+end

data/lib/ringcentral_sdk/cache/extensions.rb

@@ -0,0 +1,123 @@
+require 'time'
+require 'uri'
+
+module RingCentralSdk::Cache
+  class Extensions
+
+    attr_accessor :rc_api
+    attr_accessor :account_id
+    attr_reader :extensions_hash
+    attr_reader :extensions_num2id
+    attr_reader :last_retrieved
+
+    def initialize(rc_api)
+      @rc_api = rc_api
+      @account_id = '~'
+      @extensions_hash = {}
+      @extensions_num2id = {}
+      @last_retrieved = -1
+    end
+
+    def retrieve(params={}, retrieve_all=true)
+      @last_retrieved = Time.now.to_i
+      uri = URI.parse "account/#{@account_id}/extension"
+      if params.length > 0 
+        uri.query = URI.encode_www_form params
+      end
+      res = @rc_api.client.get do |req|
+        req.url uri.to_s
+        if retrieve_all
+          req.params['page'] = 1
+          req.params['perPage'] = 1000
+        end
+      end
+      res.body['records'].each do |extension|
+        if extension.has_key?('id') && extension['id']>0
+          @extensions_hash[extension['id'].to_s] = extension
+        end
+      end
+      if retrieve_all
+        while res.body.has_key?('navigation') && res.body['navigation'].has_key?('nextPage')
+          res = rcsdk.client.get do |req|
+            req.url res.body['navigation']['nextPage']['uri']
+          end
+          res.body['records'].each do |record|
+            if extension.has_key?('id') && extension['id'].length>0
+              @extensions_hash[extension['id'].to_s] = extension
+            end
+          end
+        end
+      end
+      inflate_num2id()
+      return @extensions_hash
+    end
+
+    def retrieve_all()
+      retrieve({}, true)
+    end
+
+    def inflate_num2id()
+      num2id = {}
+      @extensions_hash.each do |k,v|
+        if v.has_key?('id') && v['id']>0 &&
+          v.has_key?('extensionNumber') && v['extensionNumber'].length>0
+          num2id[v['extensionNumber']] = v['id'].to_s
+        end
+      end
+      @extensions_num2id = num2id
+      return num2id
+    end
+
+    def get_extension_by_id(extension_id)
+      if !extension_id.is_a?(String)
+        extension_id = extension_id.to_s
+      end
+      if @extensions_hash.has_key?(extension_id)
+          return @extensions_hash[extension_id]
+      end
+      return nil
+    end
+
+    def get_extension_by_number(extension_number)
+      if !extension_number.is_a?(String)
+        extension_number = extension_number.to_s
+      end
+      if @extensions_num2id.has_key?(extension_number)
+        extension_id = @extensions_num2id[extension_number]
+        if @extensions_hash.has_key?(extension_id)
+          return @extensions_hash[extension_id]
+        end
+      end
+      return nil
+    end
+
+    def get_department_members(department_id)
+      if !department_id.is_a?(String)
+        department_id = department_id.to_s
+      end
+      if department_id !~ /^[0-9]+$/
+        raise 'department_id parameter must be a positive integer'
+      end
+
+      members = []
+
+      res = @rc_api.client.get do |req|
+        req.url "account/#{account_id}/department/#{department_id}/members"
+      end
+
+      if res.body.has_key?('records')
+        res.body['records'].each do |extension|
+          if extension.has_key?('id')
+            member = get_extension_by_id extension['id']
+            if !member.nil?
+              members.push member
+            end
+          end
+        end
+      end
+
+      return members
+    end
+
+  end
+end

data/lib/ringcentral_sdk/helpers.rb

@@ -1,5 +1,7 @@
 module RingCentralSdk::Helpers
   autoload :CreateFaxRequest, 'ringcentral_sdk/helpers/fax'
+  autoload :ExtensionPresence, 'ringcentral_sdk/helpers/extension_presence'
   autoload :Inflator, 'ringcentral_sdk/helpers/inflator'
+  autoload :Messages, 'ringcentral_sdk/helpers/messages'
   autoload :Request, 'ringcentral_sdk/helpers/request'
 end

data/lib/ringcentral_sdk/helpers/extension_presence.rb

@@ -0,0 +1,129 @@
+module RingCentralSdk::Helpers
+  class ExtensionPresence
+
+    attr_accessor :rc_api
+    attr_accessor :account_id
+    attr_accessor :exension_id
+    attr_accessor :presence_info
+
+    def initialize(rc_api, extension_id=nil)
+      @rc_api = rc_api
+      @account_id = '~'
+      @extension_id = extension_id.to_s
+      @presence_info = {}
+    end
+
+    def retrieve()
+      if @extension_id !~ /^[0-9]+$/
+        raise "extension_id is not an integer"
+      end
+
+      res = @rc_api.client.get do |req|
+        req.url "account/#{@account_id}/extension/#{@extension_id}/presence"
+      end
+
+      @presence_info = res.body
+
+      return @presence_info
+    end
+
+    def department_calls_enable(enable)
+      retrieve()
+
+      if !@presence_info.has_key?('dndStatus')
+        raise 'invalid presence info'
+      end
+
+      current_status = @presence_info['dndStatus']
+      new_status = enable ?
+        status_enable_dnd_department_calls(current_status) :
+        status_disable_dnd_department_calls(current_status)
+
+      if current_status != new_status
+        update({:dndStatus => new_status})
+      end
+    end
+
+    def department_calls_enabled?(reload=false)
+      if reload
+        retrieve()
+      elsif !@presence_info.has_key?('dndStatus')
+        retrieve()
+      end
+
+      current_status = @presence_info['dndStatus']
+
+      status_enabled = {
+        'DoNotAcceptAnyCalls' => false,
+        'DoNotAcceptDepartmentCalls' => false,
+        'TakeAllCalls' => true,
+        'TakeDepartmentCallsOnly' => true
+      }
+
+      return status_enabled.has_key?(current_status) ?
+        status_enabled[current_status] : nil
+    end
+
+    def disable_department_calls()
+      retrieve()
+
+      if !@presence_info.has_key?('dndStatus')
+        raise 'invalid presence info'
+      end
+
+      current_status = @presence_info['dndStatus']
+      new_status = status_disable_dnd_department_calls(current_status)
+
+      if current_status != new_status
+        update({:dndStatus => new_status})
+      end
+    end
+
+    def update(body=nil)
+      if body.nil?
+        raise 'HTTP request body is required to update presence'
+      end
+
+      res = @rc_api.client.put do |req|
+        req.url "account/#{@account_id}/extension/#{@extension_id}/presence"
+        req.headers['Content-Type'] = 'application/json'
+        req.body = body
+      end
+      
+      @presence_info = res.body
+
+      return @presence_info
+    end
+
+    def status_enable_dnd_department_calls(current_status)
+      new_status = current_status
+
+      new_statuses = {
+        'DoNotAcceptAnyCalls' => 'TakeDepartmentCallsOnly',
+        'DoNotAcceptDepartmentCalls' => 'TakeAllCalls'
+      }
+
+      if new_statuses.has_key?(current_status.to_s)
+        new_status = new_statuses[current_status.to_s]
+      end
+
+      return new_status
+    end
+
+    def status_disable_dnd_department_calls(current_status)
+      new_status = current_status
+
+      new_statuses = {
+        'TakeAllCalls' => 'DoNotAcceptDepartmentCalls',
+        'TakeDepartmentCallsOnly' => 'DoNotAcceptAnyCalls'
+      }
+
+      if new_statuses.has_key?(current_status.to_s)
+        new_status = new_statuses[current_status.to_s]
+      end
+
+      return new_status
+    end
+
+  end
+end

data/lib/ringcentral_sdk/helpers/messages.rb

@@ -0,0 +1,19 @@
+module RingCentralSdk::Helpers
+  class Messages
+    def initialize(rcapi)
+      @rcapi = rcapi
+    end
+    def create(opts)
+      response = @rcapi.client.post do |req|
+        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
+        }
+      end
+      return response
+    end
+  end
+end

data/lib/ringcentral_sdk/platform.rb

@@ -26,6 +26,8 @@ module RingCentralSdk
     attr_reader   :user_agent
     attr_reader   :redirect_uri
 
+    attr_reader   :messages
+
     def initialize(app_key, app_secret, server_url=RingCentralSdk::RC_SERVER_SANDBOX, opts={})
       @app_key      = app_key.to_s
       @app_secret   = app_secret.to_s
@@ -42,6 +44,7 @@ module RingCentralSdk
           authorize_password(opts[:username], extension, opts[:password])
         end
       end
+      @messages = RingCentralSdk::Helpers::Messages.new(self)
     end
 
     def get_api_version_url()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-08 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -154,9 +154,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/ringcentral_sdk/cache/extensions.rb
+- lib/ringcentral_sdk/cache.rb
+- lib/ringcentral_sdk/helpers/extension_presence.rb
 - lib/ringcentral_sdk/helpers/fax.rb
 - lib/ringcentral_sdk/helpers/inflator/contact_info.rb
 - lib/ringcentral_sdk/helpers/inflator.rb
+- lib/ringcentral_sdk/helpers/messages.rb
 - lib/ringcentral_sdk/helpers/request.rb
 - lib/ringcentral_sdk/helpers.rb
 - lib/ringcentral_sdk/platform.rb