pubnub 4.0.19 → 4.0.20

data/lib/pubnub/event/formatter.rb

@@ -0,0 +1,45 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Event class lib/pubnub/event.rb
+  class Event
+    # Module that holds formatters for events
+    module EFormatter
+      def format_envelopes(response, request)
+        if response.is_a? HTTPClient::ReceiveTimeoutError
+          return error_envelope(nil, response, request: request, response: response)
+        elsif response.is_a? OpenSSL::SSL::SSLError
+          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 format_channels
+        @channel =  Formatter.format_channel(@channel || @channels)
+        @channel += Formatter.format_presence_channel(@presence)
+        @channel += Formatter.format_presence_channel(@channel || @channels) if @with_presence
+        @wildcard_channel = @channel.select { |e| e.index('.*') } || []
+      end
+
+      def format_group
+        @group = (@channel_group || @channel_groups) if (@channel_group || @channel_groups) && @group.blank?
+        @group = Formatter.format_group(@group)
+
+        if @group.first.to_s.count(':') > 0
+          @namespace_id, @group_id = @group.first.to_s.split(':')
+        else
+          @namespace_id = nil
+          @group_id = @group.first.to_s
+        end
+      end
+    end
+  end
+end

data/lib/pubnub/event/signature.rb

@@ -0,0 +1,41 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Event class lib/pubnub/event.rb
+  class Event
+    # Module that holds signature computing code
+    module Signature
+      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")
+
+        message = message.gsub(/[!~*'()]/) { |char| '%' + char.ord.to_s(16).upcase }
+
+        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
+    end
+  end
+end

data/lib/pubnub/event.rb

@@ -1,3 +1,6 @@
+require 'pubnub/event/signature'
+require 'pubnub/event/formatter'
+
 # Toplevel Pubnub module.
 module Pubnub
   # Event module holds most basic and required infrastructure for every pubnub
@@ -11,6 +14,9 @@ module Pubnub
     alias_method :channels, :channel
     alias_method :channel_groups, :channel_group
 
+    include Signature
+    include EFormatter
+
     def initialize(options, app)
       @app = app
       @given_options = options
@@ -74,50 +80,12 @@ 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")
-
-      message = message.gsub(/[!~*'()]/) { |char| '%' + char.ord.to_s(16).upcase }
-
-      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
       Pubnub.logger.error('Pubnub::Event') { "Error while calling callback #{error.inspect}" }
     end
 
-    def format_channels
-      @channel =  Formatter.format_channel(@channel || @channels)
-      @channel += Formatter.format_presence_channel(@presence)
-      @channel += Formatter.format_presence_channel(@channel || @channels) if @with_presence
-      @wildcard_channel = @channel.select { |e| e.index('.*') } || []
-    end
-
     def fire_callbacks(envelope)
       Pubnub.logger.debug('Pubnub::Event') { "Firing callbacks for #{self.class}" }
       secure_call @callback, envelope if @callback
@@ -134,7 +102,7 @@ module Pubnub
         uuid: @app.env[:uuid]
       }
 
-      required.merge!({timestamp: @timestamp}) if @app.env[:secret_key] && ![:grant, :revoke, :audit].include?(@event)
+      required.merge!(timestamp: @timestamp) if @app.env[:secret_key] && ![:grant, :revoke, :audit].include?(@event)
 
       empty_if_blank.delete_if { |_k, v| v.blank? }
 
@@ -146,24 +114,6 @@ module Pubnub
       @envelopes = format_envelopes response, request
     end
 
-    def format_envelopes(response, request)
-      if response.is_a? HTTPClient::ReceiveTimeoutError
-        return error_envelope(nil, response, request: request, response: response)
-      elsif response.is_a? OpenSSL::SSL::SSLError
-        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
                      ssl cipher_key secret_key auth_key
@@ -172,7 +122,7 @@ module Pubnub
                      group action read write manage ttl presence start
                      end count reverse presence_callback store skip_validate
                      state channel_group channel_groups compressed meta customs include_token
-                     replicate with_presence)
+                     replicate with_presence cipher_key_selector)
 
       options = options.each_with_object({}) { |option, obj| obj[option.first.to_sym] = option.last }
 
@@ -185,18 +135,6 @@ module Pubnub
       @idle_timeout = options[:s_idle_timeout]
     end
 
-    def format_group
-      @group = (@channel_group || @channel_groups) if (@channel_group || @channel_groups) && @group.blank?
-      @group = Formatter.format_group(@group)
-
-      if @group.first.to_s.count(':') > 0
-        @namespace_id, @group_id = @group.first.to_s.split(':')
-      else
-        @namespace_id = nil
-        @group_id = @group.first.to_s
-      end
-    end
-
     def set_timestamp
       @timestamp = current_time
     end
@@ -210,6 +148,12 @@ module Pubnub
       URI.encode_www_form_component(parameter).gsub('+', '%20')
     end
 
+    def compute_cipher_key(data)
+      ck = @compute_cipher_key || @cipher_key || @app.env[:cipher_key_selector] || @app.env[:cipher_key].to_s
+      return ck unless ck.respond_to?(:call)
+      ck.call(data)
+    end
+
     def error_message(parsed_response)
       parsed_response['message']
     rescue
@@ -227,36 +171,36 @@ module Pubnub
 
     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
-        when OpenSSL::SSL::SSLError
-          error_category = Pubnub::Constants::SSL_ERROR
-          code = nil
-        else
-          error_category = Pubnub::Constants::STATUS_ERROR
-          code = req_res_objects[:response].code
+      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
+      when OpenSSL::SSL::SSLError
+        error_category = Pubnub::Constants::SSL_ERROR
+        code = nil
+      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: 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
-          }
+        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/history.rb

@@ -58,9 +58,10 @@ module Pubnub
     def valid_envelope(parsed_response, req_res_objects)
       messages = parsed_response[0]
 
-      if @app.env[:cipher_key] && messages
-        crypto = Crypto.new(@app.env[:cipher_key])
-        messages = messages.map { |message| crypto.decrypt(message) }
+      if (@cipher_key || @app.env[:cipher_key] || @cipher_key_selector || @app.env[:cipher_key_selector]) && messages
+        cipher_key = compute_cipher_key(parsed_response)
+        crypto = Crypto.new(cipher_key)
+        messages = messages.map { |message| JSON.parse(crypto.decrypt(message), quirks_mode: true) }
       end
 
       start = parsed_response[1]

data/lib/pubnub/events/publish.rb

@@ -14,11 +14,11 @@ module Pubnub
       @origination_time_token = @app.generate_ortt
 
       case @store
-        when false
-          @store = 0
-          @ttl = nil
-        when true
-          @store = 1
+      when false
+        @store = 0
+        @ttl = nil
+      when true
+        @store = 1
       end
     end
 
@@ -49,31 +49,31 @@ module Pubnub
       params = super
 
       empty_if_blank = {
-          store: @store,
-          meta: @meta,
-          ttl: @ttl
+        store: @store,
+        meta: @meta,
+        ttl: @ttl
       }
 
-      replication = @replicate == false ? {norep: true} : {}
+      replication = @replicate == false ? { norep: true } : {}
 
       empty_if_blank.delete_if { |_k, v| v.blank? }
 
       params = params.merge(empty_if_blank)
       params = params.merge(replication)
       params = params.merge(seqn: @sequence_number,
-                            ortt: {t: @origination_time_token})
+                            ortt: { t: @origination_time_token })
       params
     end
 
     def path
       rpath = [
-          'publish',
-          @publish_key,
-          @subscribe_key,
-          '0',
-          @channel,
-          '0',
-          Formatter.format_message(@message, @cipher_key)
+        'publish',
+        @publish_key,
+        @subscribe_key,
+        '0',
+        @channel,
+        '0',
+        Formatter.format_message(@message, @cipher_key)
       ]
 
       rpath.pop if @compressed
@@ -99,26 +99,26 @@ module Pubnub
 
     def valid_envelope(parsed_response, req_res_objects)
       Pubnub::Envelope.new(
-          event: @event,
-          event_options: @given_options,
-          timetoken: timetoken(parsed_response),
-          status: {
-              code: req_res_objects[:response].code,
-              operation: Pubnub::Constants::OPERATION_PUBLISH,
-              client_request: req_res_objects[:request],
-              server_response: req_res_objects[:response],
-              data: nil,
-              category: Pubnub::Constants::STATUS_ACK,
-              error: false,
-              auto_retried: false,
-
-              current_timetoken: nil,
-              last_timetoken: nil,
-              subscribed_channels: nil,
-              subscribed_channel_groups: nil,
-
-              config: get_config
-          }
+        event: @event,
+        event_options: @given_options,
+        timetoken: timetoken(parsed_response),
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_PUBLISH,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: nil,
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          config: get_config
+        }
       )
     end
   end

data/lib/pubnub/formatter.rb

@@ -78,7 +78,7 @@ module Pubnub
       # Formats hash to params string
       def params_hash_to_url_params(hash)
         params = ''
-        hash.sort_by { |k,_v| k.to_s}.to_h.each do |key, value|
+        hash.sort_by { |k, _v| k.to_s }.to_h.each do |key, value|
           if %w(meta ortt).include?(key.to_s)
             encoded_value = URI.encode_www_form_component(value.to_json).gsub('+', '%20')
             params << "#{key}=#{encoded_value}&"

data/lib/pubnub/pam.rb

@@ -85,15 +85,15 @@ module Pubnub
 
     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
+      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
 
       ErrorEnvelope.new(

data/lib/pubnub/single_event.rb

@@ -5,7 +5,7 @@ module Pubnub
     private
 
     def request_dispatcher
-      Pubnub.logger.debug('Pubnub::SingleEvent'){ '#request_dispatcher called' }
+      Pubnub.logger.debug('Pubnub::SingleEvent') { '#request_dispatcher called' }
       @app.request_dispatcher(@origin, :single_event, @http_sync)
     end
 

data/lib/pubnub/subscribe_event/formatter.rb

@@ -33,16 +33,16 @@ module Pubnub
       end
 
       def decipher_payload(message)
-        return message[:payload] if message[:channel].end_with?('-pnpres') || @app.env[:cipher_key].nil?
-
-        crypto = Pubnub::Crypto.new(@app.env[:cipher_key].to_s)
+        return message[:payload] if message[:channel].end_with?('-pnpres') || (@app.env[:cipher_key].nil? && @cipher_key.nil? && @cipher_key_selector.nil? && @env[:cipher_key_selector].nil?)
+        cipher_key = compute_cipher_key(message.reject { |k, _v| k == :payload })
+        crypto = Pubnub::Crypto.new(cipher_key)
         JSON.parse(crypto.decrypt(message[:payload]), quirks_mode: true)
       rescue
         message[:payload]
       end
 
       def build_non_error_envelopes(parsed_response, req_res_objects)
-        Pubnub.logger.debug('Pubnub::SubscribeEvent::Formatter') { 'Formatting non-errror envelopes' }
+        Pubnub.logger.debug('Pubnub::SubscribeEvent::Formatter') { 'Formatting non-error envelopes' }
         timetoken = parsed_response['t']
         messages = expand_messages_keys(parsed_response['m'])
 

data/lib/pubnub/subscriber.rb

@@ -153,34 +153,34 @@ module Pubnub
         )
       when Pubnub::Constants::STATUS_REQUEST_MESSAGE_COUNT_EXCEEDED
         envelope = Pubnub::Envelope.new(
-            event:         event,
-            event_options: given_options,
-            timetoken:     nil,
-            status: {
-                code: nil,
-                client_request: request,
-                server_response: nil,
-                data: nil,
-                category: Pubnub::Constants::STATUS_REQUEST_MESSAGE_COUNT_EXCEEDED,
-                error: false,
-                auto_retried: true,
-
-                current_timetoken:         @app.env[:timetoken].to_i,
-                last_timetoken:            @app.env[:timetoken].to_i,
-                subscribed_channels:       @app.subscribed_channels,
-                subscribed_channel_groups: @app.subscribed_groups,
-
-                config: get_config
-
-            },
-            result: {
-                code: nil,
-                operation: nil,
-                client_request: request,
-                server_response: nil,
-
-                data: nil
-            }
+          event:         event,
+          event_options: given_options,
+          timetoken:     nil,
+          status: {
+            code: nil,
+            client_request: request,
+            server_response: nil,
+            data: nil,
+            category: Pubnub::Constants::STATUS_REQUEST_MESSAGE_COUNT_EXCEEDED,
+            error: false,
+            auto_retried: true,
+
+            current_timetoken:         @app.env[:timetoken].to_i,
+            last_timetoken:            @app.env[:timetoken].to_i,
+            subscribed_channels:       @app.subscribed_channels,
+            subscribed_channel_groups: @app.subscribed_groups,
+
+            config: get_config
+
+          },
+          result: {
+            code: nil,
+            operation: nil,
+            client_request: request,
+            server_response: nil,
+
+            data: nil
+          }
         )
       else
         Pubnub.logger.warn('Unknown announcement type.')

data/lib/pubnub/validators/client.rb

@@ -7,7 +7,7 @@ module Pubnub
       class << self
         include CommonValidator
         def validate!(parameters)
-          validate_origin parameters[:origins_pool], true
+          validate_origin parameters[:origin], true
           validate_subscribe_key parameters[:subscribe_key], true
           validate_publish_key parameters[:publish_key]
         end

data/lib/pubnub/validators/common_validator.rb

@@ -14,8 +14,8 @@ module Pubnub
         fail(
           InitializationError.new,
           'origins_pool parameter is not valid. \
-                 Should be type of Array.'
-        ) unless origin.is_a?(Array) || origin.blank?
+                 Should be type of String.'
+        ) unless origin.is_a?(String) || origin.blank?
       end
 
       # Validates given subscribe key

data/lib/pubnub/version.rb

@@ -1,4 +1,4 @@
 # Toplevel Pubnub module.
 module Pubnub
-  VERSION = '4.0.19'
+  VERSION = '4.0.20'
 end

data/pubnub.gemspec

@@ -13,8 +13,6 @@ Gem::Specification.new do |spec|
   spec.homepage        = 'http://github.com/pubnub/ruby'
   spec.license         = 'MIT'
 
-  spec.post_install_message = %(-----\nUPGRADE NOTICE: Pubnub 3.8.0 and higher versions are using Celluloid instead of EventMachine for asynchronous processing.\n-----)
-
   spec.files           = `git ls-files -z`.split("\x0")
   spec.executables     = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
   spec.test_files      = spec.files.grep(%r{^(test|spec|features)\/})

data/spec/examples/presence_examples_spec.rb

@@ -12,7 +12,8 @@ describe Pubnub::Presence do
       publish_key: 'pub-c-b42cec2f-f468-4784-8833-dd2b074538c4',
       subscribe_key: 'sub-c-b7fb805a-1777-11e6-be83-0619f8945a4f',
       uuid: 'ruby-test-uuid-client-one',
-      auth_key: 'ruby-test-auth-client-one'
+      auth_key: 'ruby-test-auth-client-one',
+      reconnect_interval: 0
     )
 
     Celluloid.boot