pubnub 3.7.5 → 3.7.7

data/fixtures/vcr_cassettes/wc-sub-ssl-true-4.yml

@@ -0,0 +1,168 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://pubsub.pubnub.com/subscribe/ds/foo,foo.*/0/0?channel-group=group&pnsdk=PubNub-Ruby/3.7.5&uuid=rubytests
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - 30
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 23 Jul 2015 15:10:20 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '30'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '[[],"14376642203952013","",""]'
+    http_version: 
+  recorded_at: Thu, 23 Jul 2015 15:10:20 GMT
+- request:
+    method: get
+    uri: https://pubsub.pubnub.com/subscribe/ds/foo,foo.*/0/14376642203952013?channel-group=group&pnsdk=PubNub-Ruby/3.7.5&uuid=rubytests
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - 30
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 23 Jul 2015 15:10:24 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '56'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '[[{"text":"hey"}],"14376642242988715","foo.*","foo.foo"]'
+    http_version: 
+  recorded_at: Thu, 23 Jul 2015 15:10:24 GMT
+- request:
+    method: get
+    uri: https://pubsub.pubnub.com/subscribe/ds/foo,foo.*/0/14376642242988715?channel-group=group&pnsdk=PubNub-Ruby/3.7.5&uuid=rubytests
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - 30
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 23 Jul 2015 15:10:27 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '157'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '[[{"action": "leave", "timestamp": 1437664227, "uuid": "c7769435-68b3-48b0-9065-08cafce285df",
+        "occupancy": 0}],"14376642278720422","foo.*","foo.foo-pnpres"]'
+    http_version: 
+  recorded_at: Thu, 23 Jul 2015 15:10:28 GMT
+- request:
+    method: get
+    uri: https://pubsub.pubnub.com/subscribe/ds/foo,foo.*/0/14376642278720422?channel-group=group&pnsdk=PubNub-Ruby/3.7.5&uuid=rubytests
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - 30
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 23 Jul 2015 15:10:30 GMT
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Content-Length:
+      - '50'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Allow-Methods:
+      - GET
+    body:
+      encoding: UTF-8
+      string: '[[{"text":"hey"}],"14376642302336303","foo","foo"]'
+    http_version: 
+  recorded_at: Thu, 23 Jul 2015 15:10:30 GMT
+recorded_with: VCR 2.9.2

data/lib/pubnub/envelope.rb

@@ -4,6 +4,7 @@ module Pubnub
     INSTANCE_VARIABLES = [
         :channel,
         :channel_group,
+        :wildcard_channel,
         :error,
         :error_message,
         :first,

data/lib/pubnub/event.rb

@@ -10,13 +10,14 @@ module Pubnub
       @message          = options[:message]
       @http_sync        = options[:http_sync]
       @callback         = options[:callback]
-      @error_callback   = options[:error_callback]   || app.env[:error_callback]
-      @connect_callback = options[:connect_callback] || app.env[:connect_callback]
-      @ssl              = options[:ssl]              || app.env[:ssl]
+      @error_callback   = options[:error_callback]    || app.env[:error_callback]
+      @presence_callback= options[:presence_callback] || app.env[:presence_callback]
+      @connect_callback = options[:connect_callback]  || app.env[:connect_callback]
+      @ssl              = options[:ssl]               || app.env[:ssl]
 
       @cipher_key       = app.env[:cipher_key]
       @secret_key       = app.env[:secret_key]
-      @auth_key         = options[:auth_key]         || app.env[:auth_key]
+      @auth_key         = options[:auth_key]          || app.env[:auth_key]
       @publish_key      = app.env[:publish_key]
       @subscribe_key    = app.env[:subscribe_key]
 
@@ -42,6 +43,7 @@ module Pubnub
     end
 
     def send_request(app)
+      Pubnub.logger.debug(:pubnub){'Pubnub::Event#send_request'}
       if app.disabled_persistent_connection?
         @response = Net::HTTP.get_response uri(app)
       else
@@ -51,6 +53,7 @@ module Pubnub
 
     def start_event(app, count = 0)
       begin
+        @response = nil
         if count <= app.env[:max_retries]
           Pubnub.logger.debug(:pubnub){'Event#start_event | sending request'}
           Pubnub.logger.debug(:pubnub){"Event#start_event | tt: #{@timetoken}; ctt #{app.env[:timetoken]}"}
@@ -59,7 +62,7 @@ module Pubnub
 
         error = response_error(@response, app)
 
-        if ![error].flatten.include?(:json) || count > app.env[:max_retries]
+        if ![error].flatten.include?(:json) || count > app.env[:max_retries] || app.env[:max_retries] == 0
           handle_response(@response, app, error)
         else
           start_event(app, count + 1)
@@ -331,6 +334,15 @@ module Pubnub
               end
             end
 
+            @wildcard_channel.each do |wc|
+              if app.env[:subscriptions][@origin].get_wildcard_channels.include?(wc)
+                @wildcard_channel.delete(wc)
+                Pubnub.logger.error(:pubnub){"Already subscribed to wildcard channel #{wc}, you have to leave that channel first"}
+              else
+                app.env[:subscriptions][@origin].add_wildcard_channel(wc, app)
+              end
+            end
+
             if @channel.empty?
               false
             else
@@ -340,17 +352,21 @@ module Pubnub
           end
 
           if app.env[:subscriptions][@origin].nil?
-            app.env[:subscriptions][@origin]                        = self            if app.env[:subscriptions][@origin].nil?
-            app.env[:callbacks_pool]                                = Hash.new        if app.env[:callbacks_pool].nil?
-            app.env[:callbacks_pool][:channel]                      = Hash.new        if app.env[:callbacks_pool][:channel].nil?
-            app.env[:callbacks_pool][:channel_group]                = Hash.new        if app.env[:callbacks_pool][:channel_group].nil?
-            app.env[:callbacks_pool][:channel][@origin]             = Hash.new        if app.env[:callbacks_pool][:channel][@origin].nil?
-            app.env[:callbacks_pool][:channel_group][@origin]       = Hash.new        if app.env[:callbacks_pool][:channel_group][@origin].nil?
-            app.env[:error_callbacks_pool]                          = Hash.new        if app.env[:error_callbacks_pool].nil?
-            app.env[:error_callbacks_pool][:channel]                = Hash.new        if app.env[:error_callbacks_pool][:channel].nil?
-            app.env[:error_callbacks_pool][:channel][@origin]       = @error_callback if app.env[:error_callbacks_pool][:channel][@origin].nil?
-            app.env[:error_callbacks_pool][:channel_group]          = Hash.new        if app.env[:error_callbacks_pool][:channel_group].nil?
-            app.env[:error_callbacks_pool][:channel_group][@origin] = @error_callback if app.env[:error_callbacks_pool][:channel_group][@origin].nil?
+            app.env[:subscriptions][@origin]                           = self            if app.env[:subscriptions][@origin].nil?
+            app.env[:callbacks_pool]                                   = Hash.new        if app.env[:callbacks_pool].nil?
+            app.env[:callbacks_pool][:channel]                         = Hash.new        if app.env[:callbacks_pool][:channel].nil?
+            app.env[:callbacks_pool][:channel_group]                   = Hash.new        if app.env[:callbacks_pool][:channel_group].nil?
+            app.env[:callbacks_pool][:wildcard_channel]                = Hash.new        if app.env[:callbacks_pool][:wildcard_channel].nil?
+            app.env[:callbacks_pool][:channel][@origin]                = Hash.new        if app.env[:callbacks_pool][:channel][@origin].nil?
+            app.env[:callbacks_pool][:channel_group][@origin]          = Hash.new        if app.env[:callbacks_pool][:channel_group][@origin].nil?
+            app.env[:callbacks_pool][:wildcard_channel][@origin]       = Hash.new        if app.env[:callbacks_pool][:wildcard_channel][@origin].nil?
+            app.env[:error_callbacks_pool]                             = Hash.new        if app.env[:error_callbacks_pool].nil?
+            app.env[:error_callbacks_pool][:channel]                   = Hash.new        if app.env[:error_callbacks_pool][:channel].nil?
+            app.env[:error_callbacks_pool][:channel][@origin]          = @error_callback if app.env[:error_callbacks_pool][:channel][@origin].nil?
+            app.env[:error_callbacks_pool][:channel_group]             = Hash.new        if app.env[:error_callbacks_pool][:channel_group].nil?
+            app.env[:error_callbacks_pool][:channel_group][@origin]    = @error_callback if app.env[:error_callbacks_pool][:channel_group][@origin].nil?
+            app.env[:error_callbacks_pool][:wildcard_channel]          = Hash.new        if app.env[:error_callbacks_pool][:wildcard_channel].nil?
+            app.env[:error_callbacks_pool][:wildcard_channel][@origin] = @error_callback if app.env[:error_callbacks_pool][:wildcard_channel][@origin].nil?
 
             @channel.each do |channel|
               app.env[:callbacks_pool][:channel][@origin][channel]            = Hash.new
@@ -362,10 +378,16 @@ module Pubnub
               app.env[:callbacks_pool][:channel_group][@origin][channel_group][:callback] = @callback unless app.env[:callbacks_pool][:channel_group][@origin][:callback]
             end
 
+            @wildcard_channel.each do |wildcard_channel|
+              app.env[:callbacks_pool][:wildcard_channel][@origin][wildcard_channel]             = Hash.new
+
+              app.env[:callbacks_pool][:wildcard_channel][@origin][wildcard_channel][:callback]  = @callback unless app.env[:callbacks_pool][:wildcard_channel][@origin][:callback]
+              app.env[:callbacks_pool][:wildcard_channel][@origin][wildcard_channel][:presence_callback] = @presence_callback unless app.env[:callbacks_pool][:wildcard_channel][@origin][wildcard_channel][:presence_callback]
+            end
+
           else
             @channel.each do |channel|
               app.env[:callbacks_pool][:channel][@origin][channel] = Hash.new
-              app.env[:callbacks_pool][:channel][@origin][channel] = Hash.new
 
               app.env[:callbacks_pool][:channel][@origin][channel][:callback]       = @callback       unless app.env[:callbacks_pool][:channel][@origin][:callback]
               app.env[:callbacks_pool][:channel][@origin][channel][:error_callback] = @error_callback unless app.env[:callbacks_pool][:channel][@origin][:error_callback]
@@ -373,11 +395,18 @@ module Pubnub
 
             @channel_group.each do |channel_group|
               app.env[:callbacks_pool][:channel_group][@origin][channel_group] = Hash.new
-              app.env[:callbacks_pool][:channel_group][@origin][channel_group] = Hash.new
 
               app.env[:callbacks_pool][:channel_group][@origin][channel_group][:callback]       = @callback       unless app.env[:callbacks_pool][:channel_group][@origin][:callback]
               app.env[:callbacks_pool][:channel_group][@origin][channel_group][:error_callback] = @error_callback unless app.env[:callbacks_pool][:channel_group][@origin][:error_callback]
             end
+
+            @wildcard_channel.each do |wildcard_channel|
+              app.env[:callbacks_pool][:wildcard_channel][@origin][wildcard_channel] = Hash.new
+
+              app.env[:callbacks_pool][:wildcard_channel][@origin][wildcard_channel][:callback]          = @callback       unless app.env[:callbacks_pool][:wildcard_channel][@origin][:callback]
+              app.env[:callbacks_pool][:wildcard_channel][@origin][wildcard_channel][:error_callback]    = @error_callback unless app.env[:callbacks_pool][:wildcard_channel][@origin][:error_callback]
+              app.env[:callbacks_pool][:wildcard_channel][@origin][wildcard_channel][:presence_callback] = @presence_callback unless app.env[:callbacks_pool][:wildcard_channel][@origin][wildcard_channel][:presence_callback]
+            end
           end
 
           app.start_subscribe
@@ -394,7 +423,7 @@ module Pubnub
 
     def add_channel_group(cg, app)
       @channel_group << cg
-      Pubnub.logger.debug(:pubnub){'SubscribeEvent#add_channel | Added channel'}
+      Pubnub.logger.debug(:pubnub){'SubscribeEvent#add_channel_group | Added channel'}
     end
 
     def add_channel(channel, app)
@@ -402,11 +431,16 @@ module Pubnub
       Pubnub.logger.debug(:pubnub){'SubscribeEvent#add_channel | Added channel'}
     end
 
+    def add_wildcard_channel(wc, app)
+      @wildcard_channel << wc
+      Pubnub.logger.debug(:pubnub){'SubscribeEvent#add_wildcard_channel | Added channel'}
+    end
+
     def remove_channel(channel, app)
       @channel = @channel - format_channels(channel)
       Pubnub.logger.debug(:pubnub){'SubscribeEvent#remove_channel | Removed channel'}
       begin
-        shutdown_subscribe(app) if @channel.empty? && @channel_group.empty?
+        shutdown_subscribe(app) if @channel.empty? && @channel_group.empty? && @wildcard_channel.empty?
       rescue => e
         Pubnub.logger.error(:pubnub){e.message}
         Pubnub.logger.error(:pubnub){e.backtrace}
@@ -415,9 +449,20 @@ module Pubnub
 
     def remove_channel_group(channel_group, app)
       @channel_group = @channel_group - format_channel_group(channel_group, false)
-      Pubnub.logger.debug(:pubnub){'SubscribeEvent#remove_channel | Removed channel'}
+      Pubnub.logger.debug(:pubnub){'SubscribeEvent#remove_channel_group | Removed channel'}
+      begin
+        shutdown_subscribe(app) if @channel.empty? && @channel_group.empty? && @wildcard_channel.empty?
+      rescue => e
+        Pubnub.logger.error(:pubnub){e.message}
+        Pubnub.logger.error(:pubnub){e.backtrace}
+      end
+    end
+
+    def remove_wildcard_channel(wc, app)
+      @wildcard_channel -= [wc]
+      Pubnub.logger.debug(:pubnub){'SubscribeEvent#remove_wildcard_channel | Removed channel'}
       begin
-        shutdown_subscribe(app) if @channel.empty? && @channel_group.empty?
+        shutdown_subscribe(app) if @channel.empty? && @channel_group.empty? && @wildcard_channel.empty?
       rescue => e
         Pubnub.logger.error(:pubnub){e.message}
         Pubnub.logger.error(:pubnub){e.backtrace}
@@ -432,6 +477,10 @@ module Pubnub
       @channel_group
     end
 
+    def get_wildcard_channels
+      @wildcard_channel
+    end
+
     private
 
     def parameters(app)
@@ -473,10 +522,14 @@ module Pubnub
         begin
           Pubnub.logger.debug(:pubnub){'Event#fire_callbacks async'}
           envelopes.each do |envelope|
-            if envelope.channel_group && app.env[:callbacks_pool][:channel_group][@origin][envelope.channel_group]
+            if group_envelope?(envelope, app) # WITH GROUP
               app.env[:callbacks_pool][:channel_group][@origin][envelope.channel_group][:callback].call(envelope) if !envelope.error && !envelope.timetoken_update
-            else
+            elsif channel_envelope?(envelope, app) # CHANNEL SUBSCRIBE
               app.env[:callbacks_pool][:channel][@origin][encode_channel(envelope.channel)][:callback].call(envelope) if !envelope.error && !envelope.timetoken_update
+            elsif wc_pnpres_envelope(envelope, app) # wildcard pnpres
+              app.env[:callbacks_pool][:wildcard_channel][@origin][encode_channel(envelope.wildcard_channel)][:presence_callback].call(envelope) if !envelope.error && !envelope.timetoken_update
+            elsif wc_envelope?(envelope, app) # wildcard
+              app.env[:callbacks_pool][:wildcard_channel][@origin][encode_channel(envelope.wildcard_channel)][:callback].call(envelope) if !envelope.error && !envelope.timetoken_update
             end
           end
           Pubnub.logger.debug(:pubnub){'We can send next request now'}
@@ -491,6 +544,30 @@ module Pubnub
 
     end
 
+    def group_envelope?(envelope, app)
+      envelope.channel_group && app.env[:callbacks_pool][:channel_group][@origin][envelope.channel_group]
+    rescue
+      false
+    end
+
+    def channel_envelope?(envelope, app)
+      app.env[:callbacks_pool][:channel][@origin][encode_channel(envelope.channel)]
+    rescue
+      false
+    end
+
+    def wc_pnpres_envelope(envelope, app)
+      app.env[:callbacks_pool][:wildcard_channel][@origin][envelope.wildcard_channel][:presence_callback] && (envelope.channel.index('-pnpres') || envelope.wildcard_channel.index('-pnpres'))
+    rescue
+      false
+    end
+
+    def wc_envelope?(envelope, app)
+      app.env[:callbacks_pool][:wildcard_channel][@origin][envelope.wildcard_channel][:callback]
+    rescue
+      false
+    end
+
     def setup_connection(app)
       app.subscribe_event_connections_pool[@origin] = new_connection(app)
     end
@@ -504,7 +581,7 @@ module Pubnub
     end
 
     def path(app)
-      path = "/subscribe/#{@subscribe_key}/#{channels_for_url(@channel)}/0/#{@timetoken}".gsub(/\?/,'%3F')
+      path = "/subscribe/#{@subscribe_key}/#{channels_for_url(@channel + @wildcard_channel)}/0/#{@timetoken}".gsub(/\?/,'%3F')
     end
 
     def timetoken(parsed_response)
@@ -534,6 +611,7 @@ module Pubnub
         envelopes << Envelope.new(
             {
                 :channel           => @channel,
+                :parsed_response   => parsed_response,
                 :timetoken         => timetoken(parsed_response)
             },
             app
@@ -544,6 +622,7 @@ module Pubnub
             {
                 :channel           => @channel.first,
                 :response_message  => parsed_response,
+                :parsed_response   => parsed_response,
                 :timetoken         => timetoken(parsed_response),
                 :timetoken_update  => true
             },
@@ -573,6 +652,7 @@ module Pubnub
                   :message           => message(parsed_response, i, channel, app),
                   :channel           => channel,
                   :response_message  => parsed_response,
+                  :parsed_response   => parsed_response,
                   :timetoken         => timetoken(parsed_response)
               },
               app
@@ -588,6 +668,11 @@ module Pubnub
           channel       = parsed_response[3].split(',')[i]
           channel_group = parsed_response[2].split(',')[i]
 
+          if channel_group.index('.*')
+            wildcard_channel = channel_group
+            channel_group = nil
+          end
+
           Pubnub.logger.debug(:pubnub){"#{parsed_response}"}
 
           envelopes << Envelope.new(
@@ -595,7 +680,9 @@ module Pubnub
                   :message           => message(parsed_response, i, channel, app),
                   :channel           => channel,
                   :channel_group     => channel_group,
+                  :wildcard_channel  => wildcard_channel,
                   :response_message  => parsed_response,
+                  :parsed_response   => parsed_response,
                   :timetoken         => timetoken(parsed_response)
               },
               app