ringcentral_sdk 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b70ade50a441762f3e16344e6c7012505bf90091
-  data.tar.gz: 79b9a35b3726573276a1bc3fcbde970592e72399
+  metadata.gz: 239dea9ba4e4c8e62d7766757e538136ecda1576
+  data.tar.gz: b4f83504a9a0e48110174b4233da10b0619b7868
 SHA512:
-  metadata.gz: 979970f4904d46bbb97e79bfa6cc2059ed4a82415078b8277c21d0361bfb1998f1a3ae52085db35ef23e4a94c7cb7a7b25ca52c57d9d0a37dfa361ae73100431
-  data.tar.gz: 70804c31f8c0ede3dc3369d3aac266669d6a8b9d8751fa6d31381d984b7e0846e43ee44f3258515732266c30df7da4a971e7c9324ad4233f683fa6d7335fdae1
+  metadata.gz: 9fa0276afb85635e2865c00a63c7a14ca2dd2213cb0b894223cfd0ad6863509a234b158e85c9bb8c5c318512a3eb75fa566f952c96c7cd5911f65b65b4234ce9
+  data.tar.gz: 3114700d02cc0e3c31c86864c60240a55ff884d69e707235888a7cae7f6390fc01a831e4573b4ab9e5411ba001692fa43940737cfc105610cb5607ac6d531a93

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 CHANGELOG
 ---------
+- **2015-10-07**: 0.3.0
+  - Add subscription support via PubNub
+  - Add `ruby-head`, `jruby`, `jruby-head`, and `rbx-2` to Travis CI
+  - Remove Ruby 1.8.7 support due to `hitimes` requirement in `pubnub` and `eventmachine`
 - **2015-09-14**: 0.2.0
   - Refactor platform class to remove `authorized` method in favor of `set_token`
   - Add `User-Agent` header support

data/LICENSE.txt

@@ -1,3 +1,5 @@
+The MIT License (MIT)
+
 Copyright (c) 2015 John Wang
  
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -3,6 +3,7 @@ RingCentral SDK
 
 [![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)
+[![Dependency Status](https://gemnasium.com/bogdanRada/ruby-gem-downloads-badge.svg)](https://gemnasium.com/bogdanRada/ruby-gem-downloads-badge)
 [![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)
 [![Coverage Status](https://coveralls.io/repos/grokify/ringcentral-sdk-ruby/badge.svg?branch=master)](https://coveralls.io/r/grokify/ringcentral-sdk-ruby?branch=master)
@@ -23,6 +24,7 @@ RingCentral SDK
   1. [API Requests](#api-requests)
     1. [SMS Example](#sms-example)
     2. [Fax Example](#fax-example)
+  1. [Subscriptions](#subscriptions)
 5. [Change Log](#change-log)
 6. [Links](#links)
 7. [Contributions](#contributions)
@@ -113,13 +115,12 @@ platform = rcsdk.platform
 ### Authorization
 
 ```ruby
-# Initialize using user phone number without extension number
-
-platform.authorize("myUsername", nil, "myPassword")
-
 # Initialize using main phone number and extension number
-
 platform.authorize("myUsername", "myExtension", "myPassword")
+
+# Initialize using user phone number without extension number
+# Extension defaults to company admin extension
+platform.authorize("myUsername", nil, "myPassword")
 ```
 
 #### Authentication Lifecycle
@@ -127,21 +128,22 @@ platform.authorize("myUsername", "myExtension", "myPassword")
 The platform class performs token refresh procedure automatically if needed. To save the access and refresh tokens between instances of the SDK, you can save and reuse the token as follows:
 
 ```ruby
-# Retrieve and save access token when program is to be stopped:
-
-token_hash = sdk.platform.token.to_hash
+# Retrieve and save access token when program is to be stopped
+# `token` is an `OAuth2::AccessToken` object
+token_hash = rcsdk.platform.token.to_hash
 ```
 
 After you have saved the token hash, e.g. as JSON, you can reload it in another instance of the SDK as follows:
 
 ```ruby
-# Reuse token_hash in new SDK instance
-rcsdk = RingCentralSdk::Sdk.new(
+# Reuse token_hash in another SDK instance
+rcsdk2 = RingCentralSdk::Sdk.new(
   "myAppKey",
   "myAppSecret",
   RingCentralSdk::Sdk::RC_SERVER_SANDBOX
 )
-sdk2.platform.set_token(token_hash)
+# set_token() accepts a hash or OAuth2::AccessToken object
+rcsdk2.platform.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.
@@ -163,7 +165,6 @@ SMS and other requests can be easily sent directly without helpers.
 
 ```ruby
 # SMS Example
-
 response = client.post do |req|
   req.url 'account/~/extension/~/sms'
   req.headers['Content-Type'] = 'application/json'
@@ -190,7 +191,6 @@ helper object in its entirety.
 
 ```ruby
 # Fax example using request helper
-
 fax = RingCentralSdk::Helpers::CreateFaxRequest.new(
   nil, # auto-inflates to [{:account_id => '~', :extension_id => '~'}]
   {
@@ -213,11 +213,32 @@ response = client.post do |req|
 end
 ```
 
+### Subscriptions
+
+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'])
+
+class MyObserver
+  def update(message)
+    puts "Subscription Message Received"
+    puts JSON.dump(message)
+  end
+end
+
+sub.add_observer(MyObserver.new())
+
+sub.destroy() # end the subscription
+```
+
 ## Versioning
 
-This project is currently in development and the API can change. During development (Version 0.x.x), versioning a minor version change indicates backward incompatibility.
+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/).
+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
 

data/VERSION.txt

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/ringcentral_sdk.rb

@@ -3,5 +3,7 @@ require 'ringcentral_sdk/version.rb'
 module RingCentralSdk
   autoload :Helpers, 'ringcentral_sdk/helpers'
   autoload :Platform, 'ringcentral_sdk/platform'
+  autoload :PubnubFactory, 'ringcentral_sdk/pubnub_factory'
   autoload :Sdk, 'ringcentral_sdk/sdk'
+  autoload :Subscription, 'ringcentral_sdk/subscription'
 end

data/lib/ringcentral_sdk/platform.rb

@@ -1,3 +1,3 @@
 module RingCentralSdk::Platform
-	autoload :Platform, 'ringcentral_sdk/platform/platform'
+  autoload :Platform, 'ringcentral_sdk/platform/platform'
 end

data/lib/ringcentral_sdk/platform/platform.rb

@@ -21,7 +21,7 @@ module RingCentralSdk::Platform
 
     attr_reader   :client
     attr_reader   :token
-    attr_reader   :ua
+    attr_reader   :user_agent
 
     def initialize(app_key='', app_secret='', server_url=RingCentralSdk::Sdk::RC_SERVER_SANDBOX)
       @app_key    = app_key
@@ -36,8 +36,29 @@ module RingCentralSdk::Platform
       return @server_url + URL_PREFIX + '/' + API_VERSION 
     end
 
+    def create_url(url, add_server=false, add_method=nil, add_token=false)
+      built_url = ''
+      has_http = !url.index('http://').nil? && !url.index('https://').nil?
+
+      if add_server && ! has_http
+        built_url += @server_url
+      end
+
+      if url.index(URL_PREFIX).nil? && ! has_http
+        built_url += URL_PREFIX + '/' + API_VERSION
+      end
+
+      built_url += url
+
+      return built_url
+    end
+
+    def login(username, extension, password)
+      return authorize(username, extension, password)
+    end
+
     def authorize(username='', extension='', password='', remember=false)
-      oauth2client = get_oauth2_client()
+      oauth2client = new_oauth2_client()
 
       token = oauth2client.password.get_token(username, password, {
         :extension => extension,
@@ -48,12 +69,11 @@ module RingCentralSdk::Platform
 
     def set_token(token)
       if token.is_a?(Hash)
-        oauth2client = get_oauth2_client()
-        token = OAuth2::AccessToken::from_hash(oauth2client, token)
+        token = OAuth2::AccessToken::from_hash(new_oauth2_client(), token)
       end
 
       unless token.is_a?(OAuth2::AccessToken)
-        raise "Token is a OAuth2::AccessToken"
+        raise "Token is not a OAuth2::AccessToken"
       end
 
       @token  = token
@@ -69,7 +89,7 @@ module RingCentralSdk::Platform
       end
     end
 
-    def get_oauth2_client()
+    def new_oauth2_client()
       return OAuth2::Client.new(@app_key, @app_secret,
         :site      => @server_url,
         :token_url => TOKEN_ENDPOINT)

data/lib/ringcentral_sdk/pubnub_factory.rb

@@ -0,0 +1,33 @@
+require 'logger'
+require 'pubnub'
+
+module RingCentralSdk
+  class PubnubFactory
+
+    def initialize(use_mock=false)
+      @_use_mock = use_mock
+    end
+
+    def pubnub(subscribe_key='', ssl_on=false, publish_key='', my_logger=nil)
+      if @_use_mock
+        raise 'PubNub Mock is not implemented'
+      end
+
+      my_logger = Logger.new(STDOUT) if my_logger.nil?
+
+      pubnub = Pubnub.new(
+        :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|
+          puts "CONNECTED: #{msg.inspect}"
+        },
+        :logger => my_logger
+      )
+
+      return pubnub
+    end
+  end
+end

data/lib/ringcentral_sdk/sdk.rb

@@ -4,19 +4,25 @@ module RingCentralSdk
     RC_SERVER_PRODUCTION = 'https://platform.ringcentral.com'
     RC_SERVER_SANDBOX    = 'https://platform.devtest.ringcentral.com'
 
-    #attr_reader :parser
     attr_reader :platform
 
     def initialize(app_key=nil,app_secret=nil,server_url=nil,username=nil,extension=nil,password=nil)
-      #@parser   = RingCentralSdk::Platform::Parser.new
+      use_pubnub_mock = false
+
       @platform = RingCentralSdk::Platform::Platform.new(app_key, app_secret, server_url)
       if not username.nil? and not password.nil?
         @platform.authorize(username, extension, password)
       end
+
+      @_pubnub_factory = RingCentralSdk::PubnubFactory.new(use_pubnub_mock)
     end
 
     def request(helper=nil)
       return @platform.request(helper)
     end
+
+    def create_subscription()
+      return RingCentralSdk::Subscription.new(@platform, @_pubnub_factory)
+    end
   end
-end
+end

data/lib/ringcentral_sdk/subscription.rb

@@ -0,0 +1,281 @@
+require 'base64'
+require 'multi_json'
+require 'observer'
+require 'timers' # Also see http://ruby-doc.org/stdlib-2.2.3/libdoc/timeout/rdoc/Timeout.html
+
+module RingCentralSdk
+  class Subscription
+    include Observable
+
+    RENEW_HANDICAP = 60
+
+    def initialize(platform, pubnub_factory)
+      @_platform = platform
+      @_pubnub_factory = pubnub_factory
+      @_event_filters = []
+      @_timeout = nil
+      @_subscription = nil_subscription()
+      @_pubnub = nil
+    end
+
+    def nil_subscription()
+      subscription       =  {
+        'eventFilters'    => [],
+        'expirationTime'  => '', # 2014-03-12T19:54:35.613Z
+        'expiresIn'       => 0,
+        'deliveryMode'    => {
+          'transportType' => 'PubNub',
+          'encryption'    => false,
+          'address'       => '',
+          'subscriberKey' => '',
+          'secretKey'     => ''
+        },
+        'id'              => '',
+        'creationTime'    => '', # 2014-03-12T19:54:35.613Z
+        'status'          => '', # Active
+        'uri'             => ''
+      }
+      return subscription
+    end
+
+    def pubnub()
+      return @_pubnub
+    end
+
+    def register(events=nil)
+      return alive() ? renew(events) : subscribe(events)
+    end
+
+    def add_events(events)
+      unless events.is_a?(Array)
+        raise 'Events is not an array.'
+      end
+      @_event_filters.push(events) if events.length>0
+    end
+
+    def set_events(events)
+      unless events.is_a?(Array)
+        raise 'Events is not an array.'
+      end
+      @_event_filters.push(*events) if events.length>0
+    end
+
+    def subscribe(events=nil)
+      set_events(events) if events.is_a?(Array)
+
+      if !@_event_filters.is_a?(Array) || @_event_filters.length ==0
+        raise 'Events are undefined'
+      end
+
+      begin
+        response = @_platform.client.post do |req|
+          req.url 'subscription'
+          req.body = {
+            :eventFilters    => _get_full_events_filter(),
+            :deliveryMode    => {
+              :transportType => 'PubNub'
+            }
+          }
+        end
+        set_subscription(response.body)
+        _subscribe_at_pubnub()
+        changed
+        notify_observers(response)
+        return response
+      rescue StandardError => e
+        reset()
+        changed
+        notify_observers(e)
+        raise 'Subscribe HTTP Request Error'
+      end
+
+      return nil
+    end
+
+    def renew(events=nil)
+      set_events(events) if events.is_a?(Array)
+
+      unless alive()
+        raise 'Subscription is not alive'
+      end
+
+      if !@_event_filters.is_a?(Array) || @_event_filters.length ==0
+        raise 'Events are undefined'
+      end
+ 
+      _clear_timeout()
+
+      begin
+        response = @_platform.client.put do |req|
+          req.url 'subscription' + @_subscription['id']
+          req.body = {
+            :eventFilters => _get_full_events_filter()
+          }
+        end
+
+        set_subscription(response.body)
+        changed
+        notify_observers(response)
+        return response
+      rescue StandardError => e
+        reset()
+        changed
+        notify_observers(e)
+        raise 'Renew HTTP Request Error'
+      end
+    end
+
+    def remove()
+      unless alive()
+        raise 'Subscription is not alive'
+      end
+
+      begin
+        response = @_platform.client.delete do |req|
+          req.url = 'subscription' + @_subscription['id']
+        end
+        reset()
+        changed
+        notify_observers(response.body)
+        return response
+      rescue StandardError => e
+        reset()
+        changed
+        notify_observers(e)
+      end
+    end
+
+    def alive()
+      s = @_subscription
+      return (s.has_key?('deliveryMode') && s['deliveryMode']) && \
+        (s['deliveryMode'].has_key?('subscriberKey') && s['deliveryMode']['subscriberKey']) && \
+        (s['deliveryMode'].has_key?('address') && s['deliveryMode']['address'])
+    end
+
+    def subscription()
+      return @_subscription
+    end
+
+    def set_subscription(data)
+      _clear_timeout()
+      @_subscription = data
+      _set_timeout()
+    end
+
+    def reset()
+      _clear_timeout()
+      _unsubscribe_at_pubnub()
+      _subscription = nil
+    end
+
+    def destroy()
+      reset()
+      off()
+    end
+
+    def _subscribe_at_pubnub()
+      unless alive()
+        raise 'Subscription is not alive'
+      end
+
+      s_key = @_subscription['deliveryMode']['subscriberKey']
+      @_pubnub = @_pubnub_factory.pubnub(s_key, false, '')
+
+      callback = lambda { |envelope|
+      	_notify(envelope.msg)
+      	changed
+      	notify_observers('GOT_PUBNUB_MESSAGE_NOTIFY')
+      }
+
+      error = lambda { |envelope|
+        puts('ERROR : ' + envelope.msg.to_s) # FIXME Handle this
+      }
+
+      connect = lambda { |envelope|
+        puts('CONNECTED')
+      }
+
+      reconnect = lambda { |envelope|
+        puts('RECONNECTED')
+      }
+
+      disconnect = lambda { |envelope|
+        puts('DISCONNECTED')
+      }
+
+      @_pubnub.subscribe(
+        :channel    => @_subscription['deliveryMode']['address'],
+        :callback   => callback,
+        :error      => error,
+        :connect    => connect,
+        :reconnect  => reconnect,
+        :disconnect => disconnect
+      )
+    end
+
+    def _notify(message)
+      message = _decrypt(message)
+      changed
+      notify_observers(message)
+    end
+
+    def _decrypt(message)
+      unless alive()
+        raise 'Subscription is not alive'
+      end
+
+      delivery_mode = @_subscription['deliveryMode']
+
+      is_encrypted  = delivery_mode.has_key?('encryption') && \
+        delivery_mode['encryption']                        && \
+        delivery_mode.has_key?('encryptionKey')            && \
+        delivery_mode['encryptionKey']
+
+      if is_encrypted
+        key = Base64.decode64(delivery_mode['encryptionKey'])
+        ciphertext = Base64.decode64(message)
+
+        decipher = OpenSSL::Cipher::AES.new(128, :ECB)
+        decipher.decrypt
+        decipher.key = key
+
+        plaintext = decipher.update(ciphertext) + decipher.final
+
+        message = MultiJson.decode(plaintext)
+      end
+
+      return message
+    end
+
+    def _unsubscribe_at_pubnub()
+      if @_pubnub && alive()
+        @_pubnub.unsubscribe(@_subscription['deliveryMode']['address'])
+      end
+    end
+
+    def _get_full_events_filter()
+      full_events_filter = []
+      @_event_filters.each do |filter|
+        if filter.to_s
+          full_events_filter.push(@_platform.create_url(filter.to_s))
+        end
+      end
+      return full_events_filter
+    end
+
+    def _set_timeout()
+      time_to_expiration = @_subscription['expiresIn'] - RENEW_HANDICAP
+      @_timeout = Timers::Group.new
+      @_timeout.after(time_to_expiration) do
+        renew()
+      end
+    end
+
+    def _clear_timeout()
+      if @_timeout.is_a?(Timers::Group)
+        @_timeout.cancel()
+      end
+    end
+
+  end
+end

data/lib/ringcentral_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-14 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -120,6 +120,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pubnub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.7.3
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +148,21 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: An unofficial Ruby SDK for the RingCentral Connect Platform API
+- !ruby/object:Gem::Dependency
+  name: timers
+  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'
+description: A Ruby SDK for the RingCentral Connect Platform API
 email: johncwang@gmail.com
 executables: []
 extensions: []
@@ -153,11 +181,14 @@ files:
 - lib/ringcentral_sdk/helpers/request.rb
 - lib/ringcentral_sdk/platform.rb
 - lib/ringcentral_sdk/platform/platform.rb
+- lib/ringcentral_sdk/pubnub_factory.rb
 - lib/ringcentral_sdk/sdk.rb
+- lib/ringcentral_sdk/subscription.rb
 - lib/ringcentral_sdk/version.rb
 - test/test_setup.rb
 homepage: https://github.com/grokify/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -178,6 +209,5 @@ rubyforge_project:
 rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
-summary: RingCentral SDK - Unofficial Ruby SDK for the RingCentral Connect Platform
-  API
+summary: RingCentral SDK - Ruby SDK for the RingCentral Connect Platform API
 test_files: []