pubnub 3.6.10 → 3.7.0

data/lib/pubnub/events/audit.rb

@@ -17,6 +17,19 @@ module Pubnub
       raise ArgumentError.new(:object => self, :message => 'publish_key is required by Audit') unless @publish_key
       raise ArgumentError.new(:object => self, :message => 'Parameter secret_key is required by Audit') if !@secret_key || @secret_key == 0
 
+      # check channel/channels
+      raise ArgumentError.new(:object => self, :message => 'SetState requires :channel, :channels or :group argument') if @channel.blank? && @channel_group.blank?
+      unless @channel.blank?
+        raise ArgumentError.new(:object => self, :message => 'Invalid channel(s) format! Should be type of: String, Symbol, or Array of both') unless valid_channel?
+      end
+
+      unless @channel_group.blank?
+        # check channel_group
+        raise ArgumentError.new(:object => self, :message => 'Invalid channel group format! Should be type of: String, Symbol') unless [String, Symbol, NilClass].include?(@channel_group.class)
+
+        # check channel_group
+        # raise ArgumentError.new(:object => self, :message => ':group argument has to be in format "ns:cg", "ns:" or ":cg"') if @channel_group.count(':') != 1
+      end
     end
 
     private

data/lib/pubnub/events/channel_registration.rb

@@ -0,0 +1,132 @@
+module Pubnub
+  class ChannelRegistration
+    include Pubnub::Event
+    include Pubnub::SingleEvent
+    include Pubnub::Formatter
+    include Pubnub::Validator
+
+    def initialize(options, app)
+      @group  = options[:group]
+      @action = options[:action]
+      @cloak  = options[:cloak]
+      super
+
+      @channel = nil if @channel.size == 1 && @channel.first.empty?
+      format_group if @group
+
+      @event = 'channel_registration'
+    end
+
+    private
+
+    def validate!
+      # Callback
+      raise ArgumentError.new(:object => self, :message => 'Callback parameter is required while using async channel_registration') 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
+
+    def format_group
+      if @group.to_s.count(':') > 0
+        @namespace_id, @group_id = @group.to_s.split(':')
+      else
+        @namespace_id = nil
+        @group_id     = @group.to_s
+      end
+    end
+
+    def parameters(app)
+      parameters = super(app)
+      parameters.merge!({cloak:  @cloak})             if @cloak
+      parameters.merge!({add:    @channel.join(',')}) if @action == :add    && !@channel.blank?
+      parameters.merge!({remove: @channel.join(',')}) if @action == :remove && !@channel.blank?
+      parameters
+    end
+
+    def path(app)
+      head = "/v1/channel-registration/sub-key/#{@subscribe_key}/"
+      body = ''
+      case @action
+        when :list_groups
+          body << [
+            'channel-group'
+          ].join('/')
+        when :list_namespaces
+          body << [
+            'namespace'
+          ].join('/')
+          
+        when :get
+          body << [
+            ('namespace' unless @namespace_id.blank?),
+            @namespace_id,
+            'channel-group',
+            @group_id
+          ].delete_if { |e| e.blank? }.join('/')
+
+        when :add
+          body << [
+              ('namespace' unless @namespace_id.blank?),
+              @namespace_id,
+              'channel-group',
+              @group_id
+          ].delete_if { |e| e.blank? }.join('/')
+
+        when :remove
+          body << [
+              ('namespace' unless @namespace_id.blank?),
+              @namespace_id,
+              ('channel-group' unless @group_id.blank?),
+              @group_id,
+              ('remove' if @channel.blank?)
+          ].delete_if { |e| e.blank? }.join('/')
+
+        when :set_cloak
+          body << [
+              ('namespace' unless @namespace_id.blank?),
+              @namespace_id,
+              'channel-group',
+              @group_id
+          ].delete_if { |e| e.blank? }.join('/')
+
+        else
+          fail ArgumentError.new(:object => self, :message => 'ChannelRegistration requires proper :action key'), 'ChannelRegistration requires proper :action key'
+      end
+
+      head + body
+    end
+
+
+    def format_envelopes(response, app, error)
+
+      parsed_response = Parser.parse_json(response.body) if Parser.valid_json?(response.body)
+
+      envelopes = Array.new
+      envelopes << Envelope.new({
+                                    :parsed_response => parsed_response,
+                                    :payload => (parsed_response['payload'] if parsed_response),
+                                    :service => (parsed_response['service'] if parsed_response),
+                                    :message => (parsed_response['message'] if parsed_response),
+                                    :status  => (parsed_response['status']  if parsed_response),
+                                    :error   => (parsed_response['error']   if parsed_response)
+                                }, app)
+
+      envelopes = add_common_data_to_envelopes(envelopes, response, app, error)
+
+      envelopes
+
+    end
+
+    def encode_state(state)
+      URI.encode_www_form_component(state.to_json).gsub('+', '%20')
+    end
+  end
+end

data/lib/pubnub/events/grant.rb

@@ -12,9 +12,7 @@ module Pubnub
       @allow_multiple_channels = true
       @timestamp = current_time
 
-      @write = options[:write]
-      @read  = options[:read]
-      @ttl   = options[:ttl]   || Pubnub::Configuration::DEFAULT_TTL
+      @ttl    = options[:ttl]   || Pubnub::Configuration::DEFAULT_TTL
     end
 
     def validate!
@@ -25,24 +23,37 @@ module Pubnub
 
       raise ArgumentError.new(:object => self, :message => 'write parameter accept only one of: 1, "1", 0, "0", true, false values') unless [nil, 1, '1', 0, '0', true, false].include?(@write)
       raise ArgumentError.new(:object => self, :message => 'read parameter accept only: 1, "1", 0, "0", true, false values') unless [nil, 1, '1', 0, '0', true, false].include?(@read)
+      raise ArgumentError.new(:object => self, :message => 'manage parameter accept only: 1, "1", 0, "0", true, false values') unless [nil, 1, '1', 0, '0', true, false].include?(@manage)
 
       raise ArgumentError.new(:object => self, :message => 'ttl parameter is too big, max value is: 525600') unless @ttl.to_i <= 525600 || @ttl.nil?
       raise ArgumentError.new(:object => self, :message => 'ttl parameter can\'t be negative')               unless @ttl.to_i >= 0      || @ttl.nil?
 
+      # 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
 
     def parameters(app, signature = false)
-      write = [0, '0', false].include?(@write) ? 0 : 1
-      read =  [0, '0', false].include?(@read) ? 0 : 1
+      write  = [0, '0', false].include?(@write)  ? 0 : 1
+      read   = [0, '0', false].include?(@read)   ? 0 : 1
+      manage = [0, '0', false].include?(@manage) ? 0 : 1 unless @channel_group.blank?
 
       {
           :timestamp => @timestamp,
           :w         => write,
           :r         => read,
+          :m         => manage,
           :ttl       => @ttl
-      }.merge(super(app, signature))
+      }.delete_if {|k, v| v.nil? }.merge(super(app, signature))
     end
 
     def path(app)
@@ -54,6 +65,5 @@ module Pubnub
           @subscribe_key
       ].join('/')
     end
-
   end
 end

data/lib/pubnub/events/heartbeat.rb

@@ -18,22 +18,48 @@ module Pubnub
 
     private
 
+    def validate!
+      super
+      # Check channels
+      raise ArgumentError.new(:object => self, :message => 'Heartbeat 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 heartbeat') 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
+
     def path(app)
+      if @channel == [''] || @channel.blank?
+        channel = [',']
+      else
+        channel = @channel
+      end
+
       '/' + [
           'v2',
           'presence',
           'sub-key',
           @subscribe_key,
           'channel',
-          @channel.join(','),
+          channel.join(','),
           'heartbeat'
       ].join('/')
     end
 
     def parameters(app)
       parameters = super(app)
-      parameters.merge!({:state => encode_state(app.env[:state][@origin])}) if app.env[:state] && app.env[:state][@origin]
-      parameters.merge!({:heartbeat => app.env[:heartbeat]})                if app.env[:heartbeat]
+      parameters.merge!({:state => encode_state(app.env[:state][@origin])})                        if app.env[:state] && app.env[:state][@origin]
+      parameters.merge!({:heartbeat => app.env[:heartbeat]})                                       if app.env[:heartbeat]
+      parameters.merge!({'channel-group' => format_channel_group(@channel_group, true).join(',')}) unless @channel_group.blank?
       parameters
     end
 

data/lib/pubnub/events/here_now.rb

@@ -16,8 +16,15 @@ module Pubnub
       super
 
       # check channel
-      raise ArgumentError.new(:object => self, :message => 'Invalid channel format! Should be type of: String, Symbol') unless [String, Symbol, NilClass].include?(@channel.class)
+      raise ArgumentError.new(:object => self, :message => 'Invalid channel format! Should be type of: String, Symbol')       unless [String, Symbol, NilClass].include?(@channel.class)
 
+      unless @channel_group.blank?
+        # check channel_group
+        raise ArgumentError.new(:object => self, :message => 'Invalid channel group format! Should be type of: String, Symbol') unless [String, Symbol, NilClass].include?(@channel_group.class)
+
+        # check channel_group
+        # raise ArgumentError.new(:object => self, :message => ':group argument has to be in format "ns:cg", "ns:" or ":cg"') if @channel_group.count(':') != 1
+      end
     end
 
     private
@@ -38,11 +45,19 @@ module Pubnub
             'v2',
             'presence',
             'sub-key',
-            @subscribe_key
+            @subscribe_key,
+            ('channel' if @channel_group),
+            (',' if @channel_group)
         ].join('/')
       end
     end
 
+    def parameters(app)
+      parameters = super(app)
+      parameters.merge!({'channel-group' => format_channel_group(@channel_group, false).join(',')}) unless @channel_group.blank?
+      parameters
+    end
+
     def format_envelopes(response, app, error)
       parsed_response = Parser.parse_json(response.body) if Parser.valid_json?(response.body)
 
@@ -50,11 +65,10 @@ module Pubnub
       envelopes << Envelope.new(
           {
               :parsed_response => parsed_response,
-              :occupancy       => (parsed_response['occupancy'] if parsed_response),
-              :service         => (parsed_response['service']   if parsed_response),
-              :message         => (parsed_response['message']   if parsed_response),
-              :uuid            => (parsed_response['uuids']     if parsed_response),
-              :status          => (parsed_response['status']    if parsed_response)
+              :payload => (parsed_response['payload'] if parsed_response),
+              :service => (parsed_response['service'] if parsed_response),
+              :message => (parsed_response['message'] if parsed_response),
+              :status  => (parsed_response['status']  if parsed_response)
           },
           app
       )

data/lib/pubnub/events/leave.rb

@@ -19,8 +19,8 @@ module Pubnub
       super
 
       # check channel
-      raise ArgumentError.new(:object => self, :message => 'Leave requires :channel argument') unless @channel
-      raise ArgumentError.new(:object => self, :message => 'Invalid channel format! Should be type of: String, Symbol, or Array of both') unless valid_channel?
+      # raise ArgumentError.new(:object => self, :message => 'Leave requires :channel argument') unless @channel
+      # raise ArgumentError.new(:object => self, :message => 'Invalid channel format! Should be type of: String, Symbol, or Array of both') unless valid_channel?
     end
 
     def fire(app)
@@ -35,12 +35,24 @@ module Pubnub
             $logger.debug('Pubnub'){"#{app.env[:subscriptions][@origin].get_channels.to_s}.include? #{channel}"}
             raise ArgumentError.new(:object => self, :message => 'You cannot leave channel that is not subscribed') unless app.env[:subscriptions][@origin].get_channels.include?(channel)
           end
+
+          @channel_group.each do |channel_group|
+            $logger.debug('Pubnub'){"#{app.env[:subscriptions][@origin].get_channel_groups.to_s}.include? #{channel_group}"}
+            raise ArgumentError.new(:object => self, :message => 'You cannot leave channel group that is not subscribed') unless app.env[:subscriptions][@origin].get_channel_groups.include?(channel_group)
+          end
         end unless @force
+
         @channel.each do |channel|
           app.env[:subscriptions][@origin].remove_channel(channel, app) if app.env[:subscriptions][@origin]
           @left = true
         end unless @skip_remove
+
+        @channel_group.each do |channel_group|
+          app.env[:subscriptions][@origin].remove_channel_group(channel_group, app) if app.env[:subscriptions][@origin]
+          @left = true
+        end unless @skip_remove
       end
+
       envelopes = super
       app.start_subscribe
       envelopes
@@ -48,14 +60,26 @@ module Pubnub
 
     private
 
+    def parameters(app)
+      params = super(app)
+      params.merge!({ 'channel-group' => @channel_group.join(',') }) unless @channel_group.blank?
+      params
+    end
+
     def path(app)
+      if @channel == [''] || @channel.blank?
+        channel = [',']
+      else
+        channel = @channel
+      end
+
       '/' + [
           'v2',
           'presence',
           'sub-key',
           @subscribe_key,
           'channel',
-          @channel.join(','),
+          channel.join(','),
           'leave'
       ].join('/')
     end

data/lib/pubnub/events/presence.rb

@@ -8,7 +8,8 @@ module Pubnub
 
     def initialize(options, app)
       super
-      @channel = @channel.map {|c| c + '-pnpres'}
+      @channel       = @channel.map       {|c| c + '-pnpres'}
+      @channel_group = @channel_group.map {|c| c + '-pnpres'}
       @event = 'presence'
       @allow_multiple_channels = true
 
@@ -23,8 +24,8 @@ module Pubnub
       super
 
       # Check channels
-      raise ArgumentError.new(:object => self, :message => 'Presence requires :channel or :channels argument') unless @channel
-      raise ArgumentError.new(:object => self, :message => 'Invalid channel(s) format! Should be type of: String, Symbol, or Array of both') unless valid_channel?
+      # raise ArgumentError.new(:object => self, :message => 'Presence requires :channel, :channels or :channel_group argument')               unless @channel || @channel_group
+      # raise ArgumentError.new(:object => self, :message => 'Invalid channel(s) format! Should be type of: String, Symbol, or Array of both') unless valid_channel?
 
     end
 

data/lib/pubnub/events/set_state.rb

@@ -15,6 +15,10 @@ module Pubnub
         app.env[:state][@origin][channel.to_s] = @state
       end
 
+      @channel_group.each do |channel|
+        app.env[:state][@origin][channel.to_s] = @state
+      end
+
       @allow_multiple_channels = true
       @event = 'set_state'
     end
@@ -25,15 +29,24 @@ module Pubnub
       raise 'You can set state only as hash' unless (@state.is_a?(Hash) || @state.is_a?(NilClass))
 
       # check channel/channels
-      raise ArgumentError.new(:object => self, :message => 'SetState requires :channel or :channels argument') unless @channel
+      raise ArgumentError.new(:object => self, :message => 'SetState requires :channel, :channels or :group argument') if @channel.blank? && @channel_group.blank?
       raise ArgumentError.new(:object => self, :message => 'Invalid channel(s) format! Should be type of: String, Symbol, or Array of both') unless valid_channel?
+
+      unless @channel_group.blank?
+        # check channel_group
+        raise ArgumentError.new(:object => self, :message => 'Invalid channel group format! Should be type of: String, Symbol') unless [String, Symbol, NilClass].include?(@channel_group.class)
+
+        # check channel_group
+        # raise ArgumentError.new(:object => self, :message => ':group argument has to be in format "ns:cg", "ns:" or ":cg"') if @channel_group.count(':') != 1
+      end
     end
 
     private
 
     def parameters(app)
       parameters = super(app)
-      parameters.merge!({:state => encode_state(@state)})
+      parameters.merge!({ :state => encode_state(@state)})
+      parameters.merge!({ 'channel-group' => format_channel_group(@channel_group).join(',') }) unless @channel_group.blank?
       parameters
     end
 
@@ -44,7 +57,7 @@ module Pubnub
           'sub-key',
           @subscribe_key,
           'channel',
-          @channel,
+          channels_for_url(@channel),
           'uuid',
           app.env[:uuid],
           'data'