pubnub 5.3.5 → 5.5.0

data/lib/pubnub/events/get_channel_members.rb

@@ -12,23 +12,26 @@ module Pubnub
       @telemetry_name = :l_obj
       @channel = options[:channel]
       @limit = [options[:limit], 100].min unless options[:limit].nil?
-      @sort = options[:sort].join(",") if options[:sort] && !options[:sort].empty?
+      @sort = options[:sort].join(',') if options[:sort] && !options[:sort].empty?
       @filter = options[:filter] if options[:filter] && !options[:filter].empty?
       @start = options[:start] if options[:start] && !options[:start].empty?
       @end = options[:end] if options[:start] && !options[:end].empty?
 
+      @include = []
       if options[:include]
         include = options[:include]
-        @include_count = [0, '0', false].include?(include[:count]) ? "0" : "1" unless include[:count].nil?
-        @include_custom = "custom" if !include[:custom].nil? && ![0, '0', false].include?(include[:custom])
-        @include_uuid_metadata = "uuid" if !include[:uuid_metadata].nil? && ![0, '0', false].include?(include[:uuid_metadata])
-        @include_uuid_custom = "uuid.custom" if !include[:uuid_custom].nil? && ![0, '0', false].include?(include[:uuid_custom])
-
-        @include = [@include_custom, @include_uuid_metadata, @include_uuid_custom].reject { |flag| flag.to_s.empty? }
+        @include.push('type') unless include[:type].nil? || [0, '0', false].include?(include[:type])
+        @include.push('status') unless include[:status].nil? || [0, '0', false].include?(include[:status])
+        @include.push('custom') unless include[:custom].nil? || [0, '0', false].include?(include[:custom])
+        @include.push('uuid') unless include[:uuid_metadata].nil? || [0, '0', false].include?(include[:uuid_metadata])
+        @include.push('uuid.type') unless include[:uuid_type].nil? || [0, '0', false].include?(include[:uuid_type])
+        @include.push('uuid.status') unless include[:uuid_status].nil? || [0, '0', false].include?(include[:uuid_status])
+        @include.push('uuid.custom') unless include[:uuid_custom].nil? || [0, '0', false].include?(include[:uuid_custom])
+        @include_count = [0, '0', false].include?(include[:count]) ? '0' : '1' unless include[:count].nil?
       end
 
       # Collections by default return number of available entries.
-      @include_count = "1" if @include_count.nil?
+      @include_count = '1' if @include_count.nil?
 
       super
     end
@@ -47,7 +50,7 @@ module Pubnub
       parameters[:start] = @start unless @start.nil?
       parameters[:end] = @end if @end && !@start
       parameters[:count] = @include_count unless @include_count.nil?
-      parameters[:include] = @include.sort.join(",") if @include && !@include.empty?
+      parameters[:include] = @include.sort.join(',') unless @include.empty?
 
       parameters
     end
@@ -64,20 +67,20 @@ module Pubnub
     end
 
     def valid_envelope(parsed_response, req_res_objects)
-      members = parsed_response['data'].map { |channel_member|
-        member = Hash.new
-        channel_member.each{ |k,v| member[k.to_sym] = v }
+      members = parsed_response['data'].map do |channel_member|
+        member = {}
+        channel_member.each { |k, v| member[k.to_sym] = v }
 
         unless member[:uuid].nil?
-          uuid_metadata = Hash.new
-          member[:uuid].each{ |k,v| uuid_metadata[k.to_sym] = v }
+          uuid_metadata = {}
+          member[:uuid].each { |k, v| uuid_metadata[k.to_sym] = v }
           uuid_metadata[:updated] = Date._parse(uuid_metadata[:updated]) unless uuid_metadata[:updated].nil?
           member[:uuid] = uuid_metadata
         end
         member[:updated] = Date._parse(member[:updated]) unless member[:updated].nil?
 
         member
-      }
+      end
 
       Pubnub::Envelope.new(
         event: @event,

data/lib/pubnub/events/get_channel_metadata.rb

@@ -12,12 +12,16 @@ module Pubnub
       @telemetry_name = :l_obj
       @channel = options[:channel]
 
+      @include = []
       if options[:include]
-        @include = "custom" unless [0, '0', false].include?(options[:include][:custom])
+        include = options[:include]
+        @include.push('type') unless include[:type].nil? || [0, '0', false].include?(include[:type])
+        @include.push('status') unless include[:status].nil? || [0, '0', false].include?(include[:status])
+        @include.push('custom') unless include[:custom].nil? || [0, '0', false].include?(include[:custom])
       end
 
       # Single entity creation should return it's 'custom' field by default.
-      @include = "custom" if @include.nil?
+      @include = ['custom'] if @include.empty?
       super
     end
 
@@ -29,7 +33,7 @@ module Pubnub
 
     def parameters(signature = false)
       parameters = super(signature)
-      parameters[:include] = @include
+      parameters[:include] = @include.sort.join(',') unless @include.empty?
 
       parameters
     end
@@ -46,8 +50,8 @@ module Pubnub
 
     def valid_envelope(parsed_response, req_res_objects)
       data = parsed_response['data']
-      metadata = Hash.new
-      data.each{ |k,v| metadata[k.to_sym] = v }
+      metadata = {}
+      data.each { |k, v| metadata[k.to_sym] = v }
       metadata[:updated] = Date._parse(metadata[:updated]) unless metadata[:updated].nil?
 
       Pubnub::Envelope.new(

data/lib/pubnub/events/get_memberships.rb

@@ -12,23 +12,26 @@ module Pubnub
       @telemetry_name = :l_obj
       @uuid = options[:uuid].nil? ? app.user_id : options[:uuid]
       @limit = [options[:limit], 100].min unless options[:limit].nil?
-      @sort = options[:sort].join(",") if options[:sort] && !options[:sort].empty?
+      @sort = options[:sort].join(',') if options[:sort] && !options[:sort].empty?
       @filter = options[:filter] if options[:filter] && !options[:filter].empty?
       @start = options[:start] if options[:start] && !options[:start].empty?
       @end = options[:end] if options[:start] && !options[:end].empty?
 
+      @include = []
       if options[:include]
         include = options[:include]
-        @include_count = [0, '0', false].include?(include[:count]) ? "0" : "1" unless include[:count].nil?
-        @include_custom = "custom" if !include[:custom].nil? && ![0, '0', false].include?(include[:custom])
-        @include_channel_metadata = "channel" if !include[:channel_metadata].nil? && ![0, '0', false].include?(include[:channel_metadata])
-        @include_channel_custom = "channel.custom" if !include[:channel_custom].nil? && ![0, '0', false].include?(include[:channel_custom])
-
-        @include = [@include_custom, @include_channel_metadata, @include_channel_custom].reject { |flag| flag.to_s.empty? }
+        @include.push('type') unless include[:type].nil? || [0, '0', false].include?(include[:type])
+        @include.push('status') unless include[:status].nil? || [0, '0', false].include?(include[:status])
+        @include.push('custom') unless include[:custom].nil? || [0, '0', false].include?(include[:custom])
+        @include.push('channel') unless include[:channel_metadata].nil? || [0, '0', false].include?(include[:channel_metadata])
+        @include.push('channel.type') unless include[:channel_type].nil? || [0, '0', false].include?(include[:channel_type])
+        @include.push('channel.status') unless include[:channel_status].nil? || [0, '0', false].include?(include[:channel_status])
+        @include.push('channel.custom') unless include[:channel_custom].nil? || [0, '0', false].include?(include[:channel_custom])
+        @include_count = [0, '0', false].include?(include[:count]) ? '0' : '1' unless include[:count].nil?
       end
 
       # Collections by default return number of available entries.
-      @include_count = "1" if @include_count.nil?
+      @include_count = '1' if @include_count.nil?
 
       super
     end
@@ -47,7 +50,7 @@ module Pubnub
       parameters[:start] = @start unless @start.nil?
       parameters[:end] = @end if @end && !@start
       parameters[:count] = @include_count unless @include_count.nil?
-      parameters[:include] = @include.sort.join(",") if @include && !@include.empty?
+      parameters[:include] = @include.sort.join(',') unless @include.empty?
 
       parameters
     end
@@ -64,20 +67,20 @@ module Pubnub
     end
 
     def valid_envelope(parsed_response, req_res_objects)
-      memberships = parsed_response['data'].map { |uuid_membership|
-        membership = Hash.new
-        uuid_membership.each{ |k,v| membership[k.to_sym] = v }
+      memberships = parsed_response['data'].map do |uuid_membership|
+        membership = {}
+        uuid_membership.each { |k, v| membership[k.to_sym] = v }
 
         unless membership[:channel].nil?
-          channel_metadata = Hash.new
-          membership[:channel].each{ |k,v| channel_metadata[k.to_sym] = v }
+          channel_metadata = {}
+          membership[:channel].each { |k, v| channel_metadata[k.to_sym] = v }
           channel_metadata[:updated] = Date._parse(channel_metadata[:updated]) unless channel_metadata[:updated].nil?
           membership[:channel] = channel_metadata
         end
         membership[:updated] = Date._parse(membership[:updated]) unless membership[:updated].nil?
 
         membership
-      }
+      end
 
       Pubnub::Envelope.new(
         event: @event,

data/lib/pubnub/events/get_uuid_metadata.rb

@@ -12,12 +12,16 @@ module Pubnub
       @telemetry_name = :l_obj
       @uuid = options[:uuid].nil? ? app.user_id : options[:uuid]
 
+      @include = []
       if options[:include]
-        @include = "custom" unless [0, '0', false].include?(options[:include][:custom])
+        include = options[:include]
+        @include.push('type') unless include[:type].nil? || [0, '0', false].include?(include[:type])
+        @include.push('status') unless include[:status].nil? || [0, '0', false].include?(include[:status])
+        @include.push('custom') unless include[:custom].nil? || [0, '0', false].include?(include[:custom])
       end
 
       # Single entity creation should return it's 'custom' field by default.
-      @include = "custom" if @include.nil?
+      @include = ['custom'] if @include.empty?
       super
     end
 
@@ -29,7 +33,7 @@ module Pubnub
 
     def parameters(signature = false)
       parameters = super(signature)
-      parameters[:include] = @include
+      parameters[:include] = @include.sort.join(',') unless @include.empty?
 
       parameters
     end
@@ -46,8 +50,8 @@ module Pubnub
 
     def valid_envelope(parsed_response, req_res_objects)
       data = parsed_response['data']
-      metadata = Hash.new
-      data.each{ |k,v| metadata[k.to_sym] = v }
+      metadata = {}
+      data.each { |k, v| metadata[k.to_sym] = v }
       metadata[:updated] = Date._parse(metadata[:updated]) unless metadata[:updated].nil?
 
       Pubnub::Envelope.new(

data/lib/pubnub/events/publish.rb

@@ -52,6 +52,7 @@ module Pubnub
       params = super
 
       empty_if_blank = {
+        custom_message_type: @custom_message_type,
         store: @store,
         meta: @meta,
         ttl: @ttl

data/lib/pubnub/events/set_channel_members.rb

@@ -12,25 +12,28 @@ module Pubnub
       @telemetry_name = :l_obj
       @channel = options[:channel]
       @limit = [options[:limit], 100].min unless options[:limit].nil?
-      @sort = options[:sort].join(",") if options[:sort] && !options[:sort].empty?
+      @sort = options[:sort].join(',') if options[:sort] && !options[:sort].empty?
       @filter = options[:filter] if options[:filter] && !options[:filter].empty?
       @start = options[:start] if options[:start] && !options[:start].empty?
       @end = options[:end] if options[:start] && !options[:end].empty?
 
+      @include = []
       if options[:include]
         include = options[:include]
-        @include_count = [0, '0', false].include?(include[:count]) ? "0" : "1" unless include[:count].nil?
-        @include_custom = "custom" if !include[:custom].nil? && ![0, '0', false].include?(include[:custom])
-        @include_uuid_metadata = "uuid" if !include[:uuid_metadata].nil? && ![0, '0', false].include?(include[:uuid_metadata])
-        @include_uuid_custom = "uuid.custom" if !include[:uuid_custom].nil? && ![0, '0', false].include?(include[:uuid_custom])
-
-        @include = [@include_custom, @include_uuid_metadata, @include_uuid_custom].reject { |flag| flag.to_s.empty? }
+        @include.push('type') unless include[:type].nil? || [0, '0', false].include?(include[:type])
+        @include.push('status') unless include[:status].nil? || [0, '0', false].include?(include[:status])
+        @include.push('custom') unless include[:custom].nil? || [0, '0', false].include?(include[:custom])
+        @include.push('uuid') unless include[:uuid_metadata].nil? || [0, '0', false].include?(include[:uuid_metadata])
+        @include.push('uuid.type') unless include[:uuid_type].nil? || [0, '0', false].include?(include[:uuid_type])
+        @include.push('uuid.status') unless include[:uuid_status].nil? || [0, '0', false].include?(include[:uuid_status])
+        @include.push('uuid.custom') unless include[:uuid_custom].nil? || [0, '0', false].include?(include[:uuid_custom])
+        @include_count = [0, '0', false].include?(include[:count]) ? '0' : '1' unless include[:count].nil?
       end
 
       @uuids = options[:uuids] if options[:uuids] && !options[:uuids].empty?
 
       # Collections by default return number of available entries.
-      @include_count = "1" if @include_count.nil?
+      @include_count = '1' if @include_count.nil?
 
       super
     end
@@ -41,6 +44,8 @@ module Pubnub
       members = @uuids.map do |member|
         member_object = { uuid: { id: member[:uuid] } }
         member_object[:custom] = member[:custom] if member[:custom] && !member[:custom].empty?
+        member_object[:type] = member[:type] if member[:type] && !member[:type].empty?
+        member_object[:status] = member[:status] if member[:status] && !member[:status].empty?
 
         member_object
       end
@@ -67,7 +72,7 @@ module Pubnub
       parameters[:start] = @start unless @start.nil?
       parameters[:end] = @end if @end && !@start
       parameters[:count] = @include_count unless @include_count.nil?
-      parameters[:include] = @include.sort.join(",") if @include && !@include.empty?
+      parameters[:include] = @include.sort.join(',') unless @include.empty?
 
       parameters
     end
@@ -84,12 +89,12 @@ module Pubnub
     end
 
     def valid_envelope(parsed_response, req_res_objects)
-      members = parsed_response['data'].map { |channel_member|
-        member = Hash.new
+      members = parsed_response['data'].map do |channel_member|
+        member = {}
         channel_member.each { |k, v| member[k.to_sym] = v }
 
         unless member[:uuid].nil?
-          uuid_metadata = Hash.new
+          uuid_metadata = {}
           member[:uuid].each { |k, v| uuid_metadata[k.to_sym] = v }
           uuid_metadata[:updated] = Date._parse(uuid_metadata[:updated]) unless uuid_metadata[:updated].nil?
           member[:uuid] = uuid_metadata
@@ -97,7 +102,7 @@ module Pubnub
         member[:updated] = Date._parse(member[:updated]) unless member[:updated].nil?
 
         member
-      }
+      end
 
       Pubnub::Envelope.new(
         event: @event,

data/lib/pubnub/events/set_channel_metadata.rb

@@ -15,12 +15,16 @@ module Pubnub
       # Clean up user-provided metadata object from nils.
       @metadata = options[:metadata].delete_if { |_k, v| v.blank? } unless options[:metadata].nil?
 
+      @include = []
       if options[:include]
-        @include = [0, '0', false].include?(options[:include][:custom]) ? "0" : "1" unless options[:include][:custom].nil?
+        include = options[:include]
+        @include.push('type') unless include[:type].nil? || [0, '0', false].include?(include[:type])
+        @include.push('status') unless include[:status].nil? || [0, '0', false].include?(include[:status])
+        @include.push('custom') unless include[:custom].nil? || [0, '0', false].include?(include[:custom])
       end
 
       # Single entity creation should return it's 'custom' field by default.
-      @include = "custom" if @include.nil?
+      @include = ['custom'] if @include.empty?
       super
     end
 
@@ -43,7 +47,7 @@ module Pubnub
 
     def parameters(signature = false)
       parameters = super(signature)
-      parameters[:include] = @include
+      parameters[:include] = @include.sort.join(',') unless @include.empty?
       parameters
     end
 
@@ -59,7 +63,7 @@ module Pubnub
 
     def valid_envelope(parsed_response, req_res_objects)
       data = parsed_response['data']
-      metadata = Hash.new
+      metadata = {}
       data.each { |k, v| metadata[k.to_sym] = v }
       metadata[:updated] = Date._parse(metadata[:updated]) unless metadata[:updated].nil?
 

data/lib/pubnub/events/set_memberships.rb

@@ -12,25 +12,28 @@ module Pubnub
       @telemetry_name = :l_obj
       @uuid = options[:uuid].nil? ? app.user_id : options[:uuid]
       @limit = [options[:limit], 100].min unless options[:limit].nil?
-      @sort = options[:sort].join(",") if options[:sort] && !options[:sort].empty?
+      @sort = options[:sort].join(',') if options[:sort] && !options[:sort].empty?
       @filter = options[:filter] if options[:filter] && !options[:filter].empty?
       @start = options[:start] if options[:start] && !options[:start].empty?
       @end = options[:end] if options[:start] && !options[:end].empty?
 
+      @include = []
       if options[:include]
         include = options[:include]
-        @include_count = [0, '0', false].include?(include[:count]) ? "0" : "1" unless include[:count].nil?
-        @include_custom = "custom" if !include[:custom].nil? && ![0, '0', false].include?(include[:custom])
-        @include_channel_metadata = "channel" if !include[:channel_metadata].nil? && ![0, '0', false].include?(include[:channel_metadata])
-        @include_channel_custom = "channel.custom" if !include[:channel_custom].nil? && ![0, '0', false].include?(include[:channel_custom])
-
-        @include = [@include_custom, @include_channel_metadata, @include_channel_custom].reject { |flag| flag.to_s.empty? }
+        @include.push('type') unless include[:type].nil? || [0, '0', false].include?(include[:type])
+        @include.push('status') unless include[:status].nil? || [0, '0', false].include?(include[:status])
+        @include.push('custom') unless include[:custom].nil? || [0, '0', false].include?(include[:custom])
+        @include.push('channel') unless include[:channel_metadata].nil? || [0, '0', false].include?(include[:channel_metadata])
+        @include.push('channel.type') unless include[:channel_type].nil? || [0, '0', false].include?(include[:channel_type])
+        @include.push('channel.status') unless include[:channel_status].nil? || [0, '0', false].include?(include[:channel_status])
+        @include.push('channel.custom') unless include[:channel_custom].nil? || [0, '0', false].include?(include[:channel_custom])
+        @include_count = [0, '0', false].include?(include[:count]) ? '0' : '1' unless include[:count].nil?
       end
 
       @channels = options[:channels] if options[:channels] && !options[:channels].empty?
 
       # Collections by default return number of available entries.
-      @include_count = "1" if @include_count.nil?
+      @include_count = '1' if @include_count.nil?
 
       super
     end
@@ -41,6 +44,8 @@ module Pubnub
       memberships = @channels.map do |membership|
         membership_object = { channel: { id: membership[:channel] } }
         membership_object[:custom] = membership[:custom] if membership[:custom] && !membership[:custom].empty?
+        membership_object[:type] = membership[:type] if membership[:type] && !membership[:type].empty?
+        membership_object[:status] = membership[:status] if membership[:status] && !membership[:status].empty?
 
         membership_object
       end
@@ -67,7 +72,7 @@ module Pubnub
       parameters[:start] = @start unless @start.nil?
       parameters[:end] = @end if @end && !@start
       parameters[:count] = @include_count unless @include_count.nil?
-      parameters[:include] = @include.sort.join(",") if @include && !@include.empty?
+      parameters[:include] = @include.sort.join(',') unless @include.empty?
 
       parameters
     end
@@ -84,12 +89,12 @@ module Pubnub
     end
 
     def valid_envelope(parsed_response, req_res_objects)
-      memberships = parsed_response['data'].map { |uuid_membership|
-        membership = Hash.new
+      memberships = parsed_response['data'].map do |uuid_membership|
+        membership = {}
         uuid_membership.each { |k, v| membership[k.to_sym] = v }
 
         unless membership[:channel].nil?
-          channel_metadata = Hash.new
+          channel_metadata = {}
           membership[:channel].each { |k, v| channel_metadata[k.to_sym] = v }
           channel_metadata[:updated] = Date._parse(channel_metadata[:updated]) unless channel_metadata[:updated].nil?
           membership[:channel] = channel_metadata
@@ -97,7 +102,7 @@ module Pubnub
         membership[:updated] = Date._parse(membership[:updated]) unless membership[:updated].nil?
 
         membership
-      }
+      end
 
       Pubnub::Envelope.new(
         event: @event,

data/lib/pubnub/events/set_uuid_metadata.rb

@@ -15,12 +15,16 @@ module Pubnub
       # Clean up user-provided metadata object from nils.
       @metadata = options[:metadata].delete_if { |_k, v| v.blank? } unless options[:metadata].nil?
 
+      @include = []
       if options[:include]
-        @include = [0, '0', false].include?(options[:include][:custom]) ? "0" : "1" unless options[:include][:custom].nil?
+        include = options[:include]
+        @include.push('type') unless include[:type].nil? || [0, '0', false].include?(include[:type])
+        @include.push('status') unless include[:status].nil? || [0, '0', false].include?(include[:status])
+        @include.push('custom') unless include[:custom].nil? || [0, '0', false].include?(include[:custom])
       end
 
       # Single entity creation should return it's 'custom' field by default.
-      @include = "custom" if @include.nil?
+      @include = ['custom'] if @include.empty?
 
       super
     end
@@ -44,7 +48,7 @@ module Pubnub
 
     def parameters(signature = false)
       parameters = super(signature)
-      parameters[:include] = @include
+      parameters[:include] = @include.sort.join(',') unless @include.empty?
       parameters
     end
 
@@ -60,7 +64,7 @@ module Pubnub
 
     def valid_envelope(parsed_response, req_res_objects)
       data = parsed_response['data']
-      metadata = Hash.new
+      metadata = {}
       data.each { |k, v| metadata[k.to_sym] = v }
       metadata[:updated] = Date._parse(metadata[:updated]) unless metadata[:updated].nil?
 

data/lib/pubnub/events/signal.rb

@@ -26,6 +26,10 @@ module Pubnub
     def parameters(*_args)
       params = super
 
+      empty_if_blank = { custom_message_type: @custom_message_type }
+      empty_if_blank.delete_if { |_k, v| v.blank? }
+
+      params = params.merge(empty_if_blank)
       params = params.merge(seqn: @sequence_number,
                             ortt: { t: @origination_time_token })
       params

data/lib/pubnub/subscribe_event/formatter.rb

@@ -60,6 +60,7 @@ module Pubnub
       end
 
       def plain_envelope(req_res_objects, timetoken)
+        operation = get_operation
         Pubnub::Envelope.new(
           event: @event,
           event_options: @given_options,
@@ -82,7 +83,7 @@ module Pubnub
           },
           result: {
             code: req_res_objects[:response].code,
-            operation: get_operation,
+            operation: operation,
             client_request: req_res_objects[:request],
             server_response: req_res_objects[:response],
 
@@ -92,6 +93,20 @@ module Pubnub
       end
 
       def encrypted_envelope(req_res_objects, message, timetoken)
+        operation = get_operation(message)
+        data = {
+          message: decipher_payload(message),
+          subscribed_channel: message[:subscription_match] || message[:channel],
+          actual_channel: message[:channel],
+          publish_time_object: message[:publish_timetoken],
+          message_meta_data: message[:user_meta_data],
+          presence_event: get_presence_event(message),
+          presence: get_presence_data(message)
+        }
+        if !data[:actual_channel].end_with?('-pnpres') && (message[:type].nil? || [1, 4].include?(message[:type]))
+          data[:custom_message_type] = message[:custom_message_type]
+        end
+
         Pubnub::Envelope.new(
           event: @event,
           event_options: @given_options,
@@ -114,19 +129,11 @@ module Pubnub
           },
           result: {
             code: req_res_objects[:response].code,
-            operation: get_operation(message),
+            operation: operation,
             client_request: req_res_objects[:request],
             server_response: req_res_objects[:response],
 
-            data: {
-              message: decipher_payload(message),
-              subscribed_channel: message[:subscription_match] || message[:channel],
-              actual_channel: message[:channel],
-              publish_time_object: message[:publish_timetoken],
-              message_meta_data: message[:user_meta_data],
-              presence_event: get_presence_event(message),
-              presence: get_presence_data(message)
-            }
+            data: data
           }
         )
       end
@@ -142,10 +149,10 @@ module Pubnub
           Pubnub::Schemas::Envelope::StatusSchema.new.call status
         end
 
-        if (results_validation + statuses_validation).map(&:failure?).index(true)
-          Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { 'Invalid formatted envelope.' }
-          raise Exception, 'Invalid formatted envelope.'
-        end
+        return unless (results_validation + statuses_validation).map(&:failure?).index(true)
+
+        Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { 'Invalid formatted envelope.' }
+        raise Exception, 'Invalid formatted envelope.'
       end
 
       def format_envelopes(response, request)
@@ -216,6 +223,7 @@ module Pubnub
 
       def get_presence_data(message)
         return nil unless get_operation(message) == Pubnub::Constants::OPERATION_PRESENCE
+
         {
           uuid: message[:payload]['uuid'],
           timestamp: message[:payload]['timestamp'],
@@ -226,6 +234,7 @@ module Pubnub
 
       def get_presence_event(message)
         return nil unless get_operation(message) == Pubnub::Constants::OPERATION_PRESENCE
+
         message[:payload]['action']
       rescue StandardError
         nil
@@ -233,7 +242,7 @@ module Pubnub
 
       def expand_messages_keys(messages)
         messages.map do |m|
-          {
+          envelope = {
             shard: m['a'],
             channel: m['c'],
             subscription_match: m['b'],
@@ -250,11 +259,15 @@ module Pubnub
             origination_time_token: expand_timetoken(m['o']),
             publish_timetoken: expand_timetoken(m['p'])
           }
+          envelope[:custom_message_type] = m['cmt'] if !m['c'].end_with?('-pnpres') && (envelope[:type].nil? || [1, 4].include?(envelope[:type]))
+
+          envelope
         end
       end
 
       def expand_timetoken(timetoken)
         return nil unless timetoken
+
         {
           timetoken: timetoken['t'],
           region_code: timetoken['r']

data/lib/pubnub/validators/fetch_messages.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules.
+  module Validator
+    # Validator for FetchMessages event.
+    module FetchMessages
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+        validate_channel_or_channels!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for fetch messages event'),
+          ':subscribe_key is required for fetch messages event'
+        )
+      end
+
+      def validate_channel_or_channels!
+        error_message = nil
+        if @include_message_actions
+          error_message = ":channels can't be used with :include_custom_message_type set to 'true'" unless @channels.nil?
+          error_message = ":channel is required with :include_custom_message_type set to 'true'" if @channel.nil?
+        elsif @channels.nil? || @channels.empty?
+          error_message = ':channels is required for fetch message event'
+        end
+
+        raise(ArgumentError.new(object: self, message: error_message), error_message) unless error_message.nil?
+      end
+    end
+  end
+end