ringcentral_sdk 1.3.4 → 2.0.0

data/lib/ringcentral_sdk/rest/simple_client.rb

@@ -1,102 +1,87 @@
-module RingCentralSdk::REST
+module RingCentralSdk
+  module 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
 
-  # 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
-
-    def initialize(client)
-      @client = client
-    end
-
-    def send(request)
-      if request.is_a?(RingCentralSdk::Helpers::Request)
-        return @client.request(request)
-      elsif ! request.is_a?(Hash)
-        raise "Request is not a RingCentralSdk::Helpers::Request or Hash"
+      def initialize(client)
+        @client = client
       end
 
-      verb = request.key?(:verb) ? request[:verb].to_s.downcase : 'get'
+      def send(request)
+        return @client.request(request) if request.is_a? RingCentralSdk::Helpers::Request
+        raise(ArgumentError, 'Request is not a ...Helpers::Request or Hash') unless request.is_a? Hash
 
-      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
+        verb = request.key?(:verb) ? request[:verb].to_s.downcase : 'get'
 
-    def delete(opts={})
-      return @client.http.delete do |req|
-        req.url build_url(opts[:path])
+        return get(request) if verb == 'get'
+        return post(request) if verb == 'post'
+        return put(request) if verb == 'put'
+        return delete(request) if verb == 'delete'
+        raise  ArgumentError, "Method not supported #{verb}"
       end
-    end
 
-    def get(opts={})
-      return @client.http.get do |req|
-        req.url build_url(opts[:path])
+      def delete(opts = {})
+        @client.http.delete do |req|
+          req.url build_url(opts[:path])
+        end
       end
-    end
 
-    def post(opts={})
-      return @client.http.post do |req|
-        req = inflate_request req, opts
+      def get(opts = {})
+        @client.http.get do |req|
+          req.url build_url(opts[:path])
+        end
       end
-    end
 
-    def put(opts={})
-      return @client.http.put do |req|
-        req = inflate_request req, opts
+      def post(opts = {})
+        @client.http.post do |req|
+          req = inflate_request req, opts
+        end
       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'
+      def put(opts = {})
+        @client.http.put do |req|
+          req = inflate_request req, opts
         end
       end
-      req
-    end
 
-    def build_url(path)
-      url = ''
-      if !path.is_a?(Array)
-        path = [path]
+      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
-      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
+
+      def build_url(path)
+        path = [path] unless path.is_a? Array
+
+        unless path.empty?
+          path0 = path[0].to_s
+          if path0.index('/').nil? && path0.index('account') != 0
+            path.unshift('extension/~') if path0.index('extension') != 0
             path.unshift('account/~')
           end
         end
+        path.join('/')
       end
-      url = path.join('/')
-      return url
     end
   end
 end

data/lib/ringcentral_sdk/rest/subscription.rb

@@ -5,284 +5,279 @@ require 'observer'
 require 'openssl'
 require 'pubnub'
 
-module RingCentralSdk::REST
-  class Subscription
-    include Observable
-
-    RENEW_HANDICAP = 60
-
-    attr_reader :event_filters
-
-    def initialize(client)
-      @_client = client
-      @event_filters = []
-      @_timeout = nil
-      @_subscription = nil_subscription()
-      @_pubnub = nil
-      @_logger_prefix = " -- #{self.class.name}: "
-    end
+module RingCentralSdk
+  module REST
+    # Subscription class is an observerable class that represents
+    # one RingCentral subscription using the PubNub transport via
+    # the Subscription API
+    class Subscription
+      include Observable
+
+      RENEW_HANDICAP = 60
+
+      attr_reader :event_filters
+
+      def initialize(client)
+        @_client = client
+        @event_filters = []
+        @_timeout = nil
+        @_subscription = nil_subscription
+        @_pubnub = nil
+        @_logger_prefix = " -- #{self.class.name}: "
+      end
 
-    def nil_subscription()
-      return {
-        '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'             => ''
-      }
-    end
+      def nil_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'             => ''
+        }
+      end
 
-    def pubnub()
-      return @_pubnub
-    end
+      def pubnub
+        @_pubnub
+      end
 
-    def register(events = nil)
-      return alive? ? renew(events) : subscribe(events)
-    end
+      def register(events = nil)
+        alive? ? renew(events) : subscribe(events)
+      end
 
-    def add_events(events)
-      unless events.is_a? Array
-        raise 'Events is not an array.'
+      def add_events(events)
+        raise 'Events is not an array.' unless events.is_a? Array
+        @event_filters.push(events) unless events.empty?
       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.'
+      def set_events(events)
+        raise 'Events is not an array.' unless events.is_a? Array
+        @event_filters = events
       end
-      @event_filters = events
-    end
 
-    def subscribe(events=nil)
-      set_events(events) if events.is_a? Array
+      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
+        raise 'Events are undefined' unless @event_filters.is_a?(Array) && !@event_filters.empty?
 
-      begin
-        response = @_client.http.post do |req|
-          req.url 'subscription'
-          req.headers['Content-Type'] = 'application/json'
-          req.body = {
-            eventFilters: @_client.create_urls(@event_filters),
-            deliveryMode: {
-              transportType: 'PubNub'
+        begin
+          response = @_client.http.post do |req|
+            req.url 'subscription'
+            req.headers['Content-Type'] = 'application/json'
+            req.body = {
+              eventFilters: @_client.create_urls(@event_filters),
+              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: ' + e.to_s
         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: ' + e.to_s
       end
-    end
 
-    def renew(events = nil)
-      set_events(events) if events.is_a? Array
-
-      unless alive?
-        raise 'Subscription is not alive'
+      def renew(events = nil)
+        set_events(events) if events.is_a? Array
+
+        raise 'Subscription is not alive' unless alive?
+        raise 'Events are undefined' if @event_filters.empty?
+        _clear_timeout
+
+        begin
+          response = @_client.http.post do |req|
+            req.url uri_join(@_subscription['uri'], 'renew')
+            req.headers['Content-Type'] = 'application/json'
+          end
+
+          set_subscription response.body
+          changed
+          notify_observers response
+
+          return response
+        rescue StandardError => e
+          @client.logger.warn "RingCentralSdk::REST::Subscription: RENEW_ERROR #{e}"
+          reset
+          changed
+          notify_observers e
+          raise 'Renew HTTP Request Error'
+        end
       end
 
-      if !@event_filters.is_a?(Array) || @event_filters.length ==0
-        raise 'Events are undefined'
+      def remove
+        raise 'Subscription is not alive' unless alive?
+
+        begin
+          response = @_client.http.delete do |req|
+            req.url 'subscription/' + @_subscription['id'].to_s
+          end
+          reset
+          changed
+          notify_observers response.body
+          return response
+        rescue StandardError => e
+          reset
+          changed
+          notify_observers e
+        end
       end
-      _clear_timeout
 
-      begin
-        response = @_client.http.post do |req|
-          req.url uri_join(@_subscription['uri'], 'renew')
-          req.headers['Content-Type'] = 'application/json'
+      def alive?
+        s = @_subscription
+        if
+          (s.key?('deliveryMode') && s['deliveryMode']) \
+          && (s['deliveryMode'].key?('subscriberKey') && s['deliveryMode']['subscriberKey']) \
+          && (
+            s['deliveryMode'].key?('address') \
+            && !s['deliveryMode']['address'].nil? \
+            && !s['deliveryMode']['address'].empty?
+          )
+          return true
         end
-
-        set_subscription response.body
-        changed
-        notify_observers response
-
-        return response
-      rescue StandardError => e
-        puts "RingCentralSdk::REST::Subscription: RENEW_ERROR #{e}"
-        reset()
-        changed
-        notify_observers e
-        raise 'Renew HTTP Request Error'
+        false
       end
-    end
 
-    def remove()
-      unless alive?
-        raise 'Subscription is not alive'
+      def subscription
+        @_subscription
       end
 
-      begin
-        response = @_client.http.delete do |req|
-          req.url 'subscription/' + @_subscription['id'].to_s
-        end
-        reset()
-        changed
-        notify_observers response.body
-        return response
-      rescue StandardError => e
-        reset()
-        changed
-        notify_observers e
+      def set_subscription(data)
+        _clear_timeout
+        @_subscription = data
+        _set_timeout
       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'] && \
-          s['deliveryMode']['address'].length>0) \
-        ? true : false
-    end
-
-    def subscription
-      return @_subscription
-    end
+      def reset
+        _clear_timeout
+        _unsubscribe_at_pubnub
+        @_subscription = nil_subscription
+      end
 
-    def set_subscription(data)
-      _clear_timeout
-      @_subscription = data
-      _set_timeout
-    end
+      def destroy
+        reset
+      end
 
-    def reset
-      _clear_timeout()
-      _unsubscribe_at_pubnub()
-      @_subscription = nil_subscription()
-    end
+      def _subscribe_at_pubnub
+        raise 'Subscription is not alive' unless alive?
+
+        s_key = @_subscription['deliveryMode']['subscriberKey']
+
+        @_pubnub = new_pubnub(s_key, false, '')
+
+        callback = Pubnub::SubscribeCallback.new(
+          message: ->(envelope) {
+            @_client.logger.debug "MESSAGE: #{envelope.result[:data]}"
+            _notify envelope.result[:data][:message]
+            changed
+          },
+          presence: ->(envelope) {
+            @_client.logger.info "PRESENCE: #{envelope.result[:data]}"
+          },
+          status: lambda do |envelope|
+            @_client.logger.info "\n\n\n#{envelope.status}\n\n\n"
+            if envelope.error?
+              @_client.logger.info "ERROR! #{envelope.status[:category]}"
+            elsif envelope.status[:last_timetoken] == 0 # Connected!
+              @_client.logger.info('CONNECTED!')
+            end
+          end
+        )
+
+        @_pubnub.add_listener callback: callback, name: :ringcentral
+
+        @_pubnub.subscribe(
+          channels: @_subscription['deliveryMode']['address']
+        )
+        @_client.logger.debug('SUBSCRIBED')
+      end
 
-    def destroy
-      reset()
-    end
+      def _notify(message)
+        count = count_observers
+        @_client.logger.debug("RingCentralSdk::REST::Subscription NOTIFYING '#{count}' observers")
 
-    def _subscribe_at_pubnub
-      unless alive?
-        raise 'Subscription is not alive'
+        message = _decrypt message
+        changed
+        notify_observers message
       end
 
-      s_key = @_subscription['deliveryMode']['subscriberKey']
-
-      @_pubnub = new_pubnub(s_key, false, '')
+      def _decrypt(message)
+        unless alive?
+          raise 'Subscription is not alive'
+        end
 
-      callback = lambda { |envelope|
-      	_notify(envelope.msg)
-      	changed
-      }
+        if _encrypted?
+          delivery_mode = @_subscription['deliveryMode']
 
-      @_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') }
-      )
-    end
+          cipher = OpenSSL::Cipher::AES.new(128, :ECB)
+          cipher.decrypt
+          cipher.key = Base64.decode64(delivery_mode['encryptionKey'].to_s)
 
-    def _notify(message)
-      count = count_observers
-      count_string = " -- RingCentralSdk::REST::Subscription: Notify #{count.to_s} observers"
-      puts count_string
+          ciphertext = Base64.decode64(message)
+          plaintext = cipher.update(ciphertext) + cipher.final
 
-      message = _decrypt message
-      changed
-      notify_observers message
-    end
+          message = MultiJson.decode(plaintext, symbolize_keys: false)
+        end
 
-    def _decrypt(message)
-      unless alive?
-        raise 'Subscription is not alive'
+        message
       end
 
-      if _encrypted?()
+      def _encrypted?
         delivery_mode = @_subscription['deliveryMode']
-
-        cipher = OpenSSL::Cipher::AES.new(128, :ECB)
-        cipher.decrypt
-        cipher.key = Base64.decode64(delivery_mode['encryptionKey'].to_s)
-
-        ciphertext = Base64.decode64(message)
-        plaintext = cipher.update(ciphertext) + cipher.final
-
-        message = MultiJson.decode(plaintext, symbolize_keys: false)
+        is_encrypted  = delivery_mode.key?('encryption') \
+          && delivery_mode['encryption'] \
+          && delivery_mode.key?('encryptionKey') \
+          && delivery_mode['encryptionKey']
+        is_encrypted
       end
 
-      return message
-    end
-
-    def _encrypted?
-      delivery_mode = @_subscription['deliveryMode']
-      is_encrypted  = delivery_mode.has_key?('encryption') && \
-        delivery_mode['encryption']                        && \
-        delivery_mode.has_key?('encryptionKey')            && \
-        delivery_mode['encryptionKey']
-      return is_encrypted
-    end
-
-    def _unsubscribe_at_pubnub
-      if @_pubnub && alive?()
-        @_pubnub.unsubscribe(channel: @_subscription['deliveryMode']['address']) do |envelope|
-          # puts envelope.message
+      def _unsubscribe_at_pubnub
+        if @_pubnub && alive?
+          @_pubnub.unsubscribe(channel: @_subscription['deliveryMode']['address']) do |envelope|
+            puts envelope.status
+          end
         end
       end
-    end
 
-    def _set_timeout
-      _clear_timeout
+      def _set_timeout
+        _clear_timeout
 
-      time_to_expiration = @_subscription['expiresIn'] - RENEW_HANDICAP
+        time_to_expiration = @_subscription['expiresIn'] - RENEW_HANDICAP
 
-      @_timeout = Thread.new do
-        sleep time_to_expiration
-        renew
+        @_timeout = Thread.new do
+          sleep time_to_expiration
+          renew
+        end
       end
-    end
 
-    def _clear_timeout
-      @_timeout.exit if @_timeout.is_a?(Thread) && @_timeout.status == 'sleep'
-      @_timeout = nil
-    end
+      def _clear_timeout
+        @_timeout.exit if @_timeout.is_a?(Thread) && @_timeout.status == 'sleep'
+        @_timeout = nil
+      end
 
-    def uri_join(*args)
-      url = args.join('/').gsub(/\/+/, '/')
-      return url.gsub(/^(https?:\/)/i, '\1/')
-    end
+      def uri_join(*args)
+        url = args.join('/').gsub(%r{/+}, '/')
+        url.gsub(%r{^(https?:/)}i, '\1/')
+      end
 
-    def new_pubnub(subscribe_key='', ssl_on=false, publish_key='', my_logger=nil)
-      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|
-          puts "Error callback says: #{msg.inspect}"
-        },
-        connect_callback: lambda { |msg|
-          puts "CONNECTED: #{msg.inspect}"
-        },
-        logger: my_logger
-      )
+      def new_pubnub(subscribe_key = '', ssl_on = false, publish_key = '', my_logger = nil)
+        Pubnub.new(
+          subscribe_key: subscribe_key.to_s,
+          publish_key: publish_key.to_s
+        )
+      end
     end
   end
 end