pubnub 4.0.9 → 4.0.12

data/fixtures/vcr_cassettes/lib/super_admin/where_now.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://pubsub.pubnub.com/v2/presence/sub-key/sub-c-f9f24520-9c56-11e6-a681-02ee2ddab7fe/uuid/ruby-test?pnsdk=PubNub-Ruby/4.0.10&signature=MLqC9qndFXjMgXfRxgky4YS%2B/r0G5hS%2BcD8LCW3tz7E=&timestamp=1477672693&uuid=ruby-test
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.2.4, ruby 2.3.1 (2016-04-26))
+      Accept:
+      - "*/*"
+      Date:
+      - Fri, 28 Oct 2016 16:38:13 GMT
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 28 Oct 2016 16:38:13 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '84'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - OPTIONS, GET, POST
+      Cache-Control:
+      - no-cache
+      Accept-Ranges:
+      - bytes
+      Age:
+      - '0'
+      Server:
+      - Pubnub Presence
+    body:
+      encoding: UTF-8
+      string: '{"status": 200, "message": "OK", "payload": {"channels": []}, "service":
+        "Presence"}'
+    http_version: 
+  recorded_at: Fri, 28 Oct 2016 16:38:13 GMT
+recorded_with: VCR 3.0.1

data/lib/pubnub/client.rb

@@ -404,6 +404,10 @@ module Pubnub
       @env[:subscribe_filter]
     end
 
+    def sdk_version
+      "PubNub-Ruby/#{Pubnub::VERSION}"
+    end
+
     private
 
     def create_state_pools(event)

data/lib/pubnub/configuration.rb

@@ -15,7 +15,8 @@ module Pubnub
         reconnect_attempts: Pubnub::Constants::DEFAULT_RECONNECT_ATTEMPTS,
         reconnect_interval: Pubnub::Constants::DEFAULT_RECONNECT_INTERVAL,
         region: Pubnub::Constants::DEFAULT_REGION,
-        ssl: Pubnub::Constants::DEFAULT_SSL
+        ssl: Pubnub::Constants::DEFAULT_SSL,
+        request_message_count_threshold: Pubnub::Constants::REQUEST_MESSAGE_COUNT_THRESHOLD
       }
     end
   end

data/lib/pubnub/constants.rb

@@ -18,6 +18,7 @@ module Pubnub
     DEFAULT_TTL                        = 1440
     DEFAULT_REGION                     = '0'
     DEFAULT_SSL                        = false
+    REQUEST_MESSAGE_COUNT_THRESHOLD    = 0
 
     # Envelope values
     # Errors
@@ -26,6 +27,7 @@ module Pubnub
     STATUS_NON_JSON_RESPONSE = :non_json_response
     STATUS_ERROR             = :error
     STATUS_API_KEY_ERROR     = :api_key_error
+    STATUS_REQUEST_MESSAGE_COUNT_EXCEEDED = :request_message_count_exceeded
 
     # Successes
     STATUS_ACK = :ack

data/lib/pubnub/event.rb

@@ -49,10 +49,13 @@ module Pubnub
     end
 
     def uri
+      sa_signature = super_admin_signature unless parameters.include?(:signature)
+
       uri = @ssl ? 'https://' : 'http://'
       uri += @origin
       uri += path
       uri += '?' + Formatter.params_hash_to_url_params(parameters)
+      uri += "&signature=#{sa_signature}" if sa_signature
       Pubnub.logger.debug('Pubnub::Event') { "Requested URI: #{uri}" }
       URI uri
     end
@@ -67,6 +70,35 @@ module Pubnub
 
     private
 
+    def super_admin_signature
+      return unless @app.env[:secret_key]
+
+      message = [
+          @app.env[:subscribe_key],
+          @app.env[:publish_key],
+          path,
+          variables_for_signature
+      ].join("\n")
+
+      URI.encode_www_form_component(Base64.encode64(
+          OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'),
+                               @app.env[:secret_key].to_s, message)
+      ).strip).gsub('+', '%20')
+    end
+
+    def variables_for_signature
+      parameters(true).map do |k, v|
+        if %w(meta ortt).include?(k.to_s)
+          encoded_value = URI.encode_www_form_component(v.to_json).gsub('+', '%20')
+          "#{k}=#{encoded_value}"
+        elsif %w(t state filter-expr).include?(k.to_s)
+          "#{k}=#{v}"
+        else
+          "#{k}=#{URI.encode_www_form_component(v.to_s).gsub('+', '%20')}"
+        end
+      end.sort.join('&')
+    end
+
     def secure_call(cb, arg)
       cb.call arg
     rescue => error
@@ -86,9 +118,9 @@ module Pubnub
       envelope
     end
 
-    def parameters
+    def parameters(_set_signature = false)
       required = {
-        pnsdk: "PubNub-Ruby/#{Pubnub::VERSION}"
+        pnsdk: @app.sdk_version
       }
 
       empty_if_blank = {
@@ -96,6 +128,8 @@ module Pubnub
         uuid: @app.env[:uuid]
       }
 
+      required.merge!({timestamp: @timestamp}) if @app.env[:secret_key] && ![:grant, :revoke, :audit].include?(@event)
+
       empty_if_blank.delete_if { |_k, v| v.blank? }
 
       required.merge(empty_if_blank)
@@ -106,9 +140,21 @@ module Pubnub
       @envelopes = format_envelopes response, request
     end
 
-    # def connection
-    #   @app.connection_for(self)
-    # end
+    def format_envelopes(response, request)
+      if response.is_a? HTTPClient::ReceiveTimeoutError
+        return error_envelope(nil, response, request: request, response: response)
+      else
+        parsed_response, error = Formatter.parse_json(response.body)
+      end
+
+      error = response if parsed_response && response.code.to_i != 200
+
+      if error
+        error_envelope(parsed_response, error, request: request, response: response)
+      else
+        valid_envelope(parsed_response, request: request, response: response)
+      end
+    end
 
     def create_variables_from_options(options)
       variables = %w(channel channels message http_sync callback
@@ -172,22 +218,34 @@ module Pubnub
     end
 
     def error_envelope(_parsed_response, error, req_res_objects)
+      case error
+        when JSON::ParserError
+          error_category = Pubnub::Constants::STATUS_NON_JSON_RESPONSE
+          code = req_res_objects[:response].code
+        when HTTPClient::ReceiveTimeoutError
+          error_category = Pubnub::Constants::STATUS_TIMEOUT
+          code = 408
+        else
+          error_category = Pubnub::Constants::STATUS_ERROR
+          code = req_res_objects[:response].code
+      end
+
       Pubnub::ErrorEnvelope.new(
-        event: @event,
-        event_options: @given_options,
-        timetoken: nil,
-        status: {
-          code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_HEARTBEAT,
-          client_request: req_res_objects[:request],
-          server_response: req_res_objects[:response],
-          data: nil,
-          category: (error ? Pubnub::Constants::STATUS_NON_JSON_RESPONSE : Pubnub::Constants::STATUS_ERROR),
-          error: true,
-          auto_retried: false,
-
-          config: get_config
-        }
+          event: @event,
+          event_options: @given_options,
+          timetoken: nil,
+          status: {
+              code: code,
+              operation: current_operation,
+              client_request: req_res_objects[:request],
+              server_response: req_res_objects[:response],
+              data: nil,
+              category: error_category,
+              error: true,
+              auto_retried: false,
+
+              config: get_config
+          }
       )
     end
   end

data/lib/pubnub/events/audit.rb

@@ -12,6 +12,10 @@ module Pubnub
 
     private
 
+    def current_operation
+      Pubnub::Constants::OPERATION_AUDIT
+    end
+
     def parameters(signature = false)
       { timestamp: @timestamp }.merge(super(signature))
     end

data/lib/pubnub/events/channel_registration.rb

@@ -13,7 +13,7 @@ module Pubnub
 
     private
 
-    def parameters
+    def parameters(*_args)
       parameters = super
       if @action == :add && !@channel.blank?
         parameters.merge!(add: @channel.join(','))
@@ -94,18 +94,6 @@ module Pubnub
       ].delete_if(&:blank?).join('/')
     end
 
-    def format_envelopes(response, request)
-      parsed_response, error = Formatter.parse_json(response.body)
-
-      error = response if parsed_response && response.code.to_i != 200
-
-      if error
-        error_envelope(parsed_response, error, request: request, response: response)
-      else
-        valid_envelope(parsed_response, request: request, response: response)
-      end
-    end
-
     def valid_envelope(parsed_response, req_res_objects)
       # {"status"=>200, "message"=>"OK", "service"=>"channel-registry", "error"=>false}
       Pubnub::Envelope.new(
@@ -140,29 +128,8 @@ module Pubnub
       )
     end
 
-    def error_envelope(parsed_response, error, req_res_objects)
-      Pubnub::ErrorEnvelope.new(
-          event: @event,
-          event_options: @given_options,
-          timetoken: nil,
-          status: {
-              code: req_res_objects[:response].code,
-              operation: define_operation,
-              client_request: req_res_objects[:request],
-              server_response: req_res_objects[:response],
-              data: nil,
-              category: (error ? Pubnub::Constants::STATUS_NON_JSON_RESPONSE : Pubnub::Constants::STATUS_ERROR),
-              error: true,
-              auto_retried: false,
-
-              current_timetoken: nil,
-              last_timetoken: nil,
-              subscribed_channels: nil,
-              subscribed_channel_groups: nil,
-
-              config: get_config
-          }
-      )
+    def current_operation
+      define_operation
     end
 
     def define_operation

data/lib/pubnub/events/grant.rb

@@ -13,6 +13,10 @@ module Pubnub
 
     private
 
+    def current_operation
+      Pubnub::Constants::OPERATION_GRANT
+    end
+
     def parameters(signature = false)
       write  = [0, '0', false].include?(@write) ? 0 : 1
       read   = [0, '0', false].include?(@read) ? 0 : 1

data/lib/pubnub/events/heartbeat.rb

@@ -13,6 +13,10 @@ module Pubnub
 
     private
 
+    def current_operation
+      Pubnub::Constants::OPERATION_HEARTBEAT
+    end
+
     def path
       '/' + [
         'v2',
@@ -25,7 +29,7 @@ module Pubnub
       ].join('/')
     end
 
-    def parameters
+    def parameters(*_args)
       parameters = super
       if @app.env[:state] && @app.env[:state][@origin]
         parameters.merge!(state: encode_state(@app.env[:state][@origin]))
@@ -41,18 +45,6 @@ module Pubnub
       URI.encode_www_form_component(state.to_json).gsub('+', '%20')
     end
 
-    def format_envelopes(response, request)
-      parsed_response, error = Formatter.parse_json(response.body)
-
-      error = response if parsed_response && response.code.to_i != 200
-
-      if error
-        error_envelope(parsed_response, error, request: request, response: response)
-      else
-        valid_envelope(parsed_response, request: request, response: response)
-                  end
-    end
-
     def valid_envelope(_parsed_response, req_res_objects)
       # {"status": 200, "message": "OK", "service": "Presence"}
       Pubnub::Envelope.new(
@@ -78,30 +70,5 @@ module Pubnub
         }
       )
     end
-
-    def error_envelope(_parsed_response, error, req_res_objects)
-      Pubnub::ErrorEnvelope.new(
-        event: @event,
-        event_options: @given_options,
-        timetoken: nil,
-        status: {
-          code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_HEARTBEAT,
-          client_request: req_res_objects[:request],
-          server_response: req_res_objects[:response],
-          data: nil,
-          category: (error ? Pubnub::Constants::STATUS_NON_JSON_RESPONSE : Pubnub::Constants::STATUS_ERROR),
-          error: true,
-          auto_retried: false,
-
-          current_timetoken: nil,
-          last_timetoken: nil,
-          subscribed_channels: nil,
-          subscribed_channel_groups: nil,
-
-          config: get_config
-        }
-      )
-    end
   end
 end

data/lib/pubnub/events/here_now.rb

@@ -12,6 +12,10 @@ module Pubnub
 
     private
 
+    def current_operation
+      get_operation
+    end
+
     def path
       if @channel.first.blank?
         global_path
@@ -42,7 +46,7 @@ module Pubnub
       ].delete_if(&:nil?).join('/')
     end
 
-    def parameters
+    def parameters(*_args)
       parameters = super
       parameters.merge!(
         'channel-group' => @group.join(',')
@@ -50,18 +54,6 @@ module Pubnub
       parameters
     end
 
-    def format_envelopes(response, request)
-      parsed_response, error = Formatter.parse_json(response.body)
-
-      error = response if parsed_response && response.code.to_i != 200
-
-      if error
-        error_envelope(parsed_response, error, request: request, response: response)
-      else
-        valid_envelope(parsed_response, request: request, response: response)
-                  end
-    end
-
     def valid_envelope(parsed_response, req_res_objects)
       Pubnub::Envelope.new(
         event:           @event,
@@ -101,31 +93,6 @@ module Pubnub
       )
     end
 
-    def error_envelope(_parsed_response, error, req_res_objects)
-      Pubnub::ErrorEnvelope.new(
-        event: @event,
-        event_options: @given_options,
-        timetoken: nil,
-        status: {
-          code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_HEARTBEAT,
-          client_request: req_res_objects[:request],
-          server_response: req_res_objects[:response],
-          data: nil,
-          category: (error ? Pubnub::Constants::STATUS_NON_JSON_RESPONSE : Pubnub::Constants::STATUS_ERROR),
-          error: true,
-          auto_retried: false,
-
-          current_timetoken: nil,
-          last_timetoken: nil,
-          subscribed_channels: nil,
-          subscribed_channel_groups: nil,
-
-          config: get_config
-        }
-      )
-    end
-
     def get_operation
       if @channel.empty? && @group.empty?
         Pubnub::Constants::OPERATION_GLOBAL_HERE_NOW