pubnub 3.6.10 → 3.7.0

data/lib/pubnub/events/state.rb

@@ -16,12 +16,18 @@ module Pubnub
       super
 
       # check channel/channels
-      raise ArgumentError.new(:object => self, :message => 'State requires :channel argument') unless @channel
-      raise ArgumentError.new(:object => self, :message => 'Invalid channel format! Should be type of: String or Symbol') unless @channel.is_a?(String) or @channel.is_a?(Symbol)
+      # raise ArgumentError.new(:object => self, :message => 'State requires :channel argument') unless @channel
+      # raise ArgumentError.new(:object => self, :message => 'Invalid channel format! Should be type of: String or Symbol') unless @channel.is_a?(String) or @channel.is_a?(Symbol)
     end
 
     private
 
+    def parameters(app)
+      parameters = super(app)
+      parameters.merge!({ 'channel-group' => format_channel_group(@channel_group).join(',') }) unless @channel_group.blank?
+      parameters
+    end
+
     def path(app)
       '/' + [
           'v2',
@@ -29,7 +35,7 @@ module Pubnub
           'sub_key',
           @subscribe_key,
           'channel',
-          @channel,
+          channels_for_url(@channel),
           'uuid',
           @uuid_looking_for
       ].join('/')
@@ -43,12 +49,12 @@ module Pubnub
       envelopes << Envelope.new(
         {
             :parsed_response => parsed_response,
-            :channel => (parsed_response['channel']  if parsed_response),
-            :payload => (parsed_response['payload']  if parsed_response),
-            :service => (parsed_response['service']  if parsed_response),
-            :message => (parsed_response['message']  if parsed_response),
-            :uuid    => (parsed_response['uuid']     if parsed_response),
-            :status  => (parsed_response['status']   if parsed_response)
+            :channel  => (parsed_response['channel']  if parsed_response),
+            :payload  => (parsed_response['payload']  if parsed_response),
+            :service  => (parsed_response['service']  if parsed_response),
+            :message  => (parsed_response['message']  if parsed_response),
+            :uuid     => (parsed_response['uuid']     if parsed_response),
+            :status   => (parsed_response['status']   if parsed_response)
         },
         app
       )

data/lib/pubnub/events/subscribe.rb

@@ -23,11 +23,20 @@ module Pubnub
     def validate!
       super
       # Check channels
-      raise ArgumentError.new(:object => self, :message => 'Subscribe requires :channel or :channels argument') unless @channel
+      raise ArgumentError.new(:object => self, :message => 'Subscribe requires :channel, :channels or :group argument') if @channel.blank? && @channel_group.blank?
 
       # Check callback
       raise ArgumentError.new(:object => self, :message => 'Callback parameter is required while using async subscribe') if !@http_sync && @callback.blank?
 
+      # Channel group
+      if @channel_group.class == Array
+        @channel_group.each do |cg|
+          # raise ArgumentError.new(:object => self, :message => ':group argument has to be in format "ns:cg", "ns:" or ":cg"') if cg.count(':') != 1
+        end
+      elsif !@channel_group.blank?
+        number_of_groups = @channel_group.to_s.split(',').size # In case it will be given as csv
+        # raise ArgumentError.new(:object => self, :message => ':group argument has to be in format "ns:cg", "ns:" or ":cg"') if @channel_group.to_s.count(':') != number_of_groups
+      end
     end
 
     private
@@ -35,7 +44,12 @@ module Pubnub
     def add_state(state, app)
       app.env[:state]          = {} unless app.env[:state]
       app.env[:state][@origin] = {} unless app.env[:state][@origin]
-      app.env[:state][@origin][@channel] = state
+      @channel.each do |channel|
+        app.env[:state][@origin][channel] = state
+      end
+      @channel_group.each do |channel_group|
+        app.env[:state][@origin][channel_group] = state
+      end
     end
   end
-end
+end

data/lib/pubnub/formatter.rb

@@ -3,18 +3,36 @@ module Pubnub
     # Formats channels as array of channels as strings
     def format_channels(channels, should_encode = true)
       channel_array = case channels.class.to_s
-        when 'String'
-          channels.split(',')
-        when 'Array'
-          channels.map { |channel| channel.to_s }
-        else
-          [channels.to_s]
-      end
+                        when 'String'
+                          channels.split(',')
+                        when 'Array'
+                          channels.map { |channel| channel.to_s }
+                        when 'NilClass'
+                          []
+                        else
+                          [channels.to_s]
+                      end
 
       channel_array = channel_array.map { |channel| encode_channel(channel) } if should_encode
       channel_array
     end
 
+    def format_channel_group(channel_group, should_encode = true)
+      channel_group_array = case channel_group.class.to_s
+                              when 'String'
+                                channel_group.split(',')
+                              when 'Array'
+                                channel_group.map { |channel| channel.to_s }
+                              when 'NilClass'
+                                []
+                              else
+                                [channel_group.to_s]
+                            end
+
+      channel_group_array = channel_group_array.map { |channel| encode_channel(channel) } if should_encode
+      channel_group_array
+    end
+
     def encode_channel(channel)
       URI.encode_www_form_component(channel).gsub('+', '%20')
     end
@@ -42,5 +60,11 @@ module Pubnub
       params
     end
 
+    def channels_for_url(channels)
+      channel = channels.join(',')
+      channel = ',' if channel.empty?
+      channel
+    end
+
   end
 end

data/lib/pubnub/pam.rb

@@ -16,9 +16,10 @@ module Pubnub
 
     def parameters(app, signature = false)
       params = super(app)
-      params.merge!({ :timestamp => @timestamp })
-      params.merge!({ :channel   => @channel.join(',') }) unless @channel.first.blank?
-      params.merge!({ :signature => signature(app) }) unless signature
+      params.merge!({ :timestamp     => @timestamp })
+      params.merge!({ 'channel-group' => @channel_group.join(',') }) unless @channel_group.blank?
+      params.merge!({ :channel       => @channel.join(',') })       unless @channel.first.blank?
+      params.merge!({ :signature     => signature(app) })           unless signature
       params
     end
 

data/lib/pubnub/version.rb

@@ -1,3 +1,3 @@
 module Pubnub
-  VERSION = '3.6.10'
+  VERSION = '3.7.0'
 end

data/spec/lib/integration/channel_groups_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe 'channel groups specific events' do
+
+  before :each do
+    EM.stop if EM.reactor_running?
+    while EM.reactor_running? do end
+    sleep(0.1)
+  end
+
+  let(:callback) { lambda { |envelope| @envelopes = [envelope] } }
+
+  context '#subscribe' do
+
+    before :each do
+      @pubnub_client = Pubnub.new(subscribe_key: 'demo', publish_key: 'demo')
+    end
+
+    it 'allows us to subscribe to cg and channel' do
+      VCR.use_cassette('cg/subscribe-cg-and-channel', :record => :once) do
+        @pubnub_client.subscribe(channel: :bot, group: 'foo:foo', callback: callback)
+        eventually do
+          expect(@envelopes.first.message).to eq '*****.......... 3520 - 2014-11-05 03:49:35'
+        end
+      end
+    end
+
+    it 'allows us to subscribe to cg only' do
+      VCR.use_cassette('cg/subscribe-cg-only', :record => :once) do
+        @pubnub_client.subscribe(group: 'foo:foo', callback: callback)
+        eventually do
+          expect(@envelopes.first.message).to eq '*****.......... 4495 - 2014-11-05 04:08:46'
+        end
+      end
+    end
+  end
+
+  context '#leave' do
+    before :each do
+      @pubnub_client = Pubnub.new(subscribe_key: 'demo', publish_key: 'demo')
+    end
+
+    it 'leaves cg' do
+      VCR.use_cassette('cg/leave-cg', :record => :once) do
+        @pubnub_client.subscribe(channel: :bot, group: 'foo:foo', callback: callback)
+        sleep(1)
+        @pubnub_client.leave(channel: :bot, group: 'foo:foo', callback: callback)
+        sleep(1)
+        expect(@pubnub_client.env[:subscriptions].empty?).to eq true
+      end
+    end
+
+    it 'leaves cg and channel' do
+      VCR.use_cassette('cg/leave-cg-c', :record => :once) do
+        @pubnub_client.subscribe(group: 'foo:foo', callback: callback)
+        sleep(1)
+        @pubnub_client.leave(group: 'foo:foo', callback: callback)
+        sleep(1)
+        expect(@pubnub_client.env[:subscriptions].empty?).to eq true
+      end
+    end
+  end
+
+  context '#here_now' do
+    before :each do
+      @pubnub_client = Pubnub.new(subscribe_key: 'demo', publish_key: 'demo')
+    end
+
+    it 'can check cg' do
+      VCR.use_cassette('cg/here_now-cg', :record => :once) do
+        envelopes = @pubnub_client.here_now(group: 'foo:', http_sync: true)
+        expect(envelopes.first.message).to eq 'OK'
+
+      end
+    end
+  end
+
+  context 'PAM' do
+
+    before :each do
+      @pubnub_client = Pubnub.new(:subscribe_key => 'sub-c-53c3d30a-4135-11e3-9970-02ee2ddab7fe', :publish_key => 'pub-c-15d6fd3c-05de-4abc-8eba-6595a441959d', :secret_key => 'sec-c-ZWYwMGJiZTYtMTQwMC00NDQ5LWI0NmEtMzZiM2M5NThlOTJh')
+      Pubnub::Grant.any_instance.stub(:current_time).and_return 1234567890
+      Pubnub::Grant.any_instance.stub(:signature).and_return 'sig'
+      Pubnub::Audit.any_instance.stub(:current_time).and_return 1234567890
+      Pubnub::Audit.any_instance.stub(:signature).and_return 'sig'
+    end
+
+    context '#grant' do
+      it 'grants all permissions on cg' do
+        VCR.use_cassette('cg/grant-cg', :record => :once) do
+          envelopes = @pubnub_client.grant(group: 'foo:foo', http_sync: true)
+          expect(envelopes.first.message).to eq 'Success'
+        end
+        end
+
+      it 'grants all permissions on ns' do
+        VCR.use_cassette('cg/grant-ns', :record => :once) do
+          envelopes = @pubnub_client.grant(group: 'foo:', http_sync: true)
+          expect(envelopes.first.message).to eq 'Success'
+        end
+      end
+    end
+
+    context '#audit' do
+      it 'audits permissions on cg' do
+        VCR.use_cassette('cg/audit-cg', :record => :once) do
+          envelopes = @pubnub_client.audit(group: 'foo:foo', http_sync: true)
+          expect(envelopes.first.message).to eq 'Success'
+        end
+      end
+
+      it 'audits permissions on ns' do
+        VCR.use_cassette('cg/audit-ns', :record => :once) do
+          envelopes = @pubnub_client.audit(group: 'foo:', http_sync: true)
+          expect(envelopes.first.message).to eq 'Success'
+        end
+      end
+    end
+  end
+end

data/spec/lib/integration/channel_registration_spec.rb

@@ -0,0 +1,317 @@
+require 'spec_helper'
+
+describe '#channel_registration' do
+
+  let(:pubnub_client) { Pubnub.new(subscribe_key: 'demo', publish_key: 'demo') }
+  let(:callback)      { lambda { |envelope| @envelopes = [envelope] } }
+
+  context 'sync' do
+    it 'lists all namespaces' do
+      VCR.use_cassette('cg/list-all-namespaces', :record => :once) do
+        envelopes = pubnub_client.channel_registration(action: :list_namespaces, http_sync: true)
+        expect(envelopes.first.status).to eq 200
+        expect(envelopes.first.payload['namespaces']).to eq %w(foo namespace_test)
+      end
+    end
+
+    it 'lists all non-namespaced channel groups' do
+      VCR.use_cassette('cg/list-all-non-namespaced-cg', :record => :once) do
+        envelopes = pubnub_client.channel_registration(action: :list_groups, http_sync: true)
+        expect(envelopes.first.status).to eq 200
+        expect(envelopes.first.payload['namespace']).to eq ''
+        expect(envelopes.first.payload['groups']).to eq %w(cg dk1)
+      end
+    end
+
+    it 'lists all cg in namespace' do
+      VCR.use_cassette('cg/list-all-cg-in-ns', :record => :once) do
+        envelopes = pubnub_client.channel_registration(action: :get, group: 'foo:', http_sync: true)
+        expect(envelopes.first.status).to eq 200
+        expect(envelopes.first.payload['namespace']).to eq 'foo'
+        expect(envelopes.first.payload['groups']).to eq %w(foo new_group)
+      end
+    end
+
+    it 'lists all channels in namespaced cg' do
+      VCR.use_cassette('cg/list-all-c-in-in-ns-cg', :record => :once) do
+        envelopes = pubnub_client.channel_registration(action: :get, group: 'foo:foo', http_sync: true)
+        expect(envelopes.first.status).to eq 200
+        expect(envelopes.first.payload['group']).to eq 'foo'
+        expect(envelopes.first.payload['channels']).to eq %w(aaa bbb)
+      end
+    end
+
+    it 'lists all channels in non-namespaced cg' do
+      VCR.use_cassette('cg/list-all-c-in-non-ns-cg', :record => :once) do
+        envelopes = pubnub_client.channel_registration(action: :get, group: ':cg', http_sync: true)
+        expect(envelopes.first.status).to eq 200
+        expect(envelopes.first.payload['group']).to eq 'cg'
+        expect(envelopes.first.payload['channels']).to eq %w(ping_3 x z)
+      end
+    end
+
+    context 'adding channel to cg' do
+      it 'adds channel to cg if given channel symbol' do
+        VCR.use_cassette('cg/add-c-as-symbol', :record => :once) do
+          envelopes = pubnub_client.channel_registration(action: :add, group: 'foo:foo', channel: :one, http_sync: true)
+          expect(envelopes.first.status).to eq 200
+          expect(envelopes.first.message).to eq 'OK'
+          expect(envelopes.first.error).to eq false
+        end
+      end
+
+      it 'adds channel to cg if given channel array' do
+        VCR.use_cassette('cg/add-c-as-array', :record => :once) do
+          envelopes = pubnub_client.channel_registration(action: :add, group: 'foo:foo', channel: %w(one two), http_sync: true)
+          expect(envelopes.first.status).to eq 200
+          expect(envelopes.first.message).to eq 'OK'
+          expect(envelopes.first.error).to eq false
+        end
+      end
+
+      it 'adds channel to cg if given channel string' do
+        VCR.use_cassette('cg/add-c-as-string', :record => :once) do
+          envelopes = pubnub_client.channel_registration(action: :add, group: 'foo:foo', channel: 'one', http_sync: true)
+          expect(envelopes.first.status).to eq 200
+          expect(envelopes.first.message).to eq 'OK'
+          expect(envelopes.first.error).to eq false
+        end
+      end
+
+      it 'adds channel to cg if given channel csv' do
+        VCR.use_cassette('cg/add-c-as-csv', :record => :once) do
+          envelopes = pubnub_client.channel_registration(action: :add, group: 'foo:foo', channel: 'one,two', http_sync: true)
+          expect(envelopes.first.status).to eq 200
+          expect(envelopes.first.message).to eq 'OK'
+          expect(envelopes.first.error).to eq false
+        end
+      end
+    end
+
+    context 'removing channel from cg' do
+      it 'removes channel from cg if given channel symbol' do
+        VCR.use_cassette('cg/remove-c-as-symbol', :record => :once) do
+          envelopes = pubnub_client.channel_registration(action: :remove, group: 'foo:foo', channel: :one, http_sync: true)
+          expect(envelopes.first.status).to eq 200
+          expect(envelopes.first.message).to eq 'OK'
+          expect(envelopes.first.error).to eq false
+        end
+      end
+
+      it 'removes channel from cg if given channel array' do
+        VCR.use_cassette('cg/remove-c-as-array', :record => :once) do
+          envelopes = pubnub_client.channel_registration(action: :remove, group: 'foo:foo', channel: %w(one two), http_sync: true)
+          expect(envelopes.first.status).to eq 200
+          expect(envelopes.first.message).to eq 'OK'
+          expect(envelopes.first.error).to eq false
+        end
+      end
+
+      it 'removes channel from cg if given channel string' do
+        VCR.use_cassette('cg/remove-c-as-string', :record => :once) do
+          envelopes = pubnub_client.channel_registration(action: :remove, group: 'foo:foo', channel: 'one', http_sync: true)
+          expect(envelopes.first.status).to eq 200
+          expect(envelopes.first.message).to eq 'OK'
+          expect(envelopes.first.error).to eq false
+        end
+      end
+
+      it 'removes channel from cg if given channel csv' do
+        VCR.use_cassette('cg/remove-c-as-csv', :record => :once) do
+          envelopes = pubnub_client.channel_registration(action: :remove, group: 'foo:foo', channel: 'one,two', http_sync: true)
+          expect(envelopes.first.status).to eq 200
+          expect(envelopes.first.message).to eq 'OK'
+          expect(envelopes.first.error).to eq false
+        end
+      end
+
+      it 'removes cg from ns' do
+        VCR.use_cassette('cg/remove-cg-from-ns-csv', :record => :once) do
+          envelopes = pubnub_client.channel_registration(action: :remove, group: 'foo:foo', http_sync: true)
+          expect(envelopes.first.status).to eq 200
+          expect(envelopes.first.message).to eq 'OK'
+          expect(envelopes.first.error).to eq false
+        end
+      end
+
+      it 'removes ns' do
+        VCR.use_cassette('cg/remove-ns-csv', :record => :once) do
+          envelopes = pubnub_client.channel_registration(action: :remove, group: 'foo:', http_sync: true)
+          expect(envelopes.first.status).to eq 200
+          expect(envelopes.first.message).to eq 'OK'
+          expect(envelopes.first.error).to eq false
+        end
+      end
+    end
+  end
+
+  context 'async' do
+    it 'lists all namespaces' do
+      VCR.use_cassette('cg/list-all-namespaces', :record => :once) do
+        pubnub_client.channel_registration(action: :list_namespaces, http_sync: false, callback: callback)
+        eventually do
+          expect(@envelopes.first.status).to eq 200
+          expect(@envelopes.first.payload['namespaces']).to eq %w(foo namespace_test)
+        end
+      end
+    end
+
+    it 'lists all non-namespaced channel groups' do
+      VCR.use_cassette('cg/list-all-non-namespaced-cg', :record => :once) do
+        pubnub_client.channel_registration(action: :list_groups, http_sync: false, callback: callback)
+        eventually do
+          expect(@envelopes.first.status).to eq 200
+          expect(@envelopes.first.payload['namespace']).to eq ''
+          expect(@envelopes.first.payload['groups']).to eq %w(cg dk1)
+        end
+      end
+    end
+
+    it 'lists all cg in namespace' do
+      VCR.use_cassette('cg/list-all-cg-in-ns', :record => :once) do
+        pubnub_client.channel_registration(action: :get, group: 'foo:', http_sync: false, callback: callback)
+        eventually do
+          expect(@envelopes.first.status).to eq 200
+          expect(@envelopes.first.payload['namespace']).to eq 'foo'
+          expect(@envelopes.first.payload['groups']).to eq %w(foo new_group)
+        end
+      end
+    end
+
+    it 'lists all channels in namespaced cg' do
+      VCR.use_cassette('cg/list-all-c-in-in-ns-cg', :record => :once) do
+        pubnub_client.channel_registration(action: :get, group: 'foo:foo', http_sync: false, callback: callback)
+        eventually do
+          expect(@envelopes.first.status).to eq 200
+          expect(@envelopes.first.payload['group']).to eq 'foo'
+          expect(@envelopes.first.payload['channels']).to eq %w(aaa bbb)
+        end
+      end
+    end
+
+    it 'lists all channels in non-namespaced cg' do
+      VCR.use_cassette('cg/list-all-c-in-non-ns-cg', :record => :once) do
+        pubnub_client.channel_registration(action: :get, group: ':cg', http_sync: false, callback: callback)
+        eventually do
+          expect(@envelopes.first.status).to eq 200
+          expect(@envelopes.first.payload['group']).to eq 'cg'
+          expect(@envelopes.first.payload['channels']).to eq %w(ping_3 x z)
+        end
+      end
+    end
+
+    context 'adding channel to cg' do
+      it 'adds channel to cg if given channel symbol' do
+        VCR.use_cassette('cg/add-c-as-symbol', :record => :once) do
+          pubnub_client.channel_registration(action: :add, group: 'foo:foo', channel: :one, http_sync: false, callback: callback)
+          eventually do
+            expect(@envelopes.first.status).to eq 200
+            expect(@envelopes.first.message).to eq 'OK'
+            expect(@envelopes.first.error).to eq false
+          end
+        end
+      end
+
+      it 'adds channel to cg if given channel array' do
+        VCR.use_cassette('cg/add-c-as-array', :record => :once) do
+          pubnub_client.channel_registration(action: :add, group: 'foo:foo', channel: %w(one two), http_sync: false, callback: callback)
+          eventually do
+            expect(@envelopes.first.status).to eq 200
+            expect(@envelopes.first.message).to eq 'OK'
+            expect(@envelopes.first.error).to eq false
+          end
+        end
+      end
+
+      it 'adds channel to cg if given channel string' do
+        VCR.use_cassette('cg/add-c-as-string', :record => :once) do
+          pubnub_client.channel_registration(action: :add, group: 'foo:foo', channel: 'one', http_sync: false, callback: callback)
+          eventually do
+            expect(@envelopes.first.status).to eq 200
+            expect(@envelopes.first.message).to eq 'OK'
+            expect(@envelopes.first.error).to eq false
+          end
+        end
+      end
+
+      it 'adds channel to cg if given channel csv' do
+        VCR.use_cassette('cg/add-c-as-csv', :record => :once) do
+          pubnub_client.channel_registration(action: :add, group: 'foo:foo', channel: 'one,two', http_sync: false, callback: callback)
+          eventually do
+            expect(@envelopes.first.status).to eq 200
+            expect(@envelopes.first.message).to eq 'OK'
+            expect(@envelopes.first.error).to eq false
+          end
+        end
+      end
+    end
+
+    context 'removing channel from cg' do
+      it 'removes channel from cg if given channel symbol' do
+        VCR.use_cassette('cg/remove-c-as-symbol', :record => :once) do
+          pubnub_client.channel_registration(action: :remove, group: 'foo:foo', channel: :one, http_sync: false, callback: callback)
+          eventually do
+            expect(@envelopes.first.status).to eq 200
+            expect(@envelopes.first.message).to eq 'OK'
+            expect(@envelopes.first.error).to eq false
+          end
+        end
+      end
+
+      it 'removes channel from cg if given channel array' do
+        VCR.use_cassette('cg/remove-c-as-array', :record => :once) do
+          pubnub_client.channel_registration(action: :remove, group: 'foo:foo', channel: %w(one two), http_sync: false, callback: callback)
+          eventually do
+            expect(@envelopes.first.status).to eq 200
+            expect(@envelopes.first.message).to eq 'OK'
+            expect(@envelopes.first.error).to eq false
+          end
+        end
+      end
+
+      it 'removes channel from cg if given channel string' do
+        VCR.use_cassette('cg/remove-c-as-string', :record => :once) do
+          pubnub_client.channel_registration(action: :remove, group: 'foo:foo', channel: 'one', http_sync: false, callback: callback)
+          eventually do
+            expect(@envelopes.first.status).to eq 200
+            expect(@envelopes.first.message).to eq 'OK'
+            expect(@envelopes.first.error).to eq false
+          end
+        end
+      end
+
+      it 'removes channel from cg if given channel csv' do
+        VCR.use_cassette('cg/remove-c-as-csv', :record => :once) do
+          pubnub_client.channel_registration(action: :remove, group: 'foo:foo', channel: 'one,two', http_sync: false, callback: callback)
+          eventually do
+            expect(@envelopes.first.status).to eq 200
+            expect(@envelopes.first.message).to eq 'OK'
+            expect(@envelopes.first.error).to eq false
+          end
+        end
+      end
+
+      it 'removes cg from ns' do
+        VCR.use_cassette('cg/remove-cg-from-ns-csv', :record => :once) do
+          pubnub_client.channel_registration(action: :remove, group: 'foo:foo', http_sync: false, callback: callback)
+          eventually do
+            expect(@envelopes.first.status).to eq 200
+            expect(@envelopes.first.message).to eq 'OK'
+            expect(@envelopes.first.error).to eq false
+          end
+        end
+      end
+
+      it 'removes ns' do
+        VCR.use_cassette('cg/remove-ns-csv', :record => :once) do
+          pubnub_client.channel_registration(action: :remove, group: 'foo:', http_sync: false, callback: callback)
+          eventually do
+            expect(@envelopes.first.status).to eq 200
+            expect(@envelopes.first.message).to eq 'OK'
+            expect(@envelopes.first.error).to eq false
+          end
+        end
+      end
+    end
+  end
+end