pubnub 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29d9b1bf2b58050bd99d049ea2416ff1cfe3cd92ee813e335a54b3ca2e9ee7ac
-  data.tar.gz: 274b127f964ad0059b3edbf152397e761c4437206b08f98a8b61b95081e96a16
+  metadata.gz: fc4c6cc7d070726bb7046638c4cb142a9f902b21b0da50ae924d450f39e6e8a7
+  data.tar.gz: 27cb6f7c2e3ec634654b4d6e78984ea51b2ee8338f5cc58b0b08cf136bf1b15f
 SHA512:
-  metadata.gz: 043f1102de6fa623327a91ba08a4d69a794b5e192970ee8607651f17c20cd0526d6e3dec0aa6cf299c3c6742c3af576e3e89e2664ca0461e8c60cb8d0e79f0cb
-  data.tar.gz: d8ad79fedee8ff7dc4bdeac2a044dafa91f8d5c6e67d35827e0e8657b1082cb4996c271feb4e4663497c8b408ade109674034956c522c7ac6663d8837f58ab29
+  metadata.gz: 401aa81c9dcafdd86d3d9626c18c321d3758f5a8278be2dca699e8210a2c20412cef22f7001f33fbde630c75c61fb88735deba59657df4e5f0c7e05a0582c672
+  data.tar.gz: 6d6715e518fe654f37d795b4d4ab283b22aab1e29c93d71f1c2df85964a8b52530cdc4f011ec128c053f472668a6f1dd7a4fee09aa0c6b726c3d1583b0b672c7

data/.pubnub.yml

@@ -1,6 +1,13 @@
 ---
-version: "5.4.0"
+version: "5.5.0"
 changelog:
+  - date: 2025-01-28
+    version: v5.5.0
+    changes:
+      - type: feature
+        text: "Add the ability to specify `type` and `status` fields for `channel metadata`, `uuid metadata`, `member`, and `membership`."
+      - type: feature
+        text: "Add missing `include` options for App Context APIs: `custom`, `status`, `type`, `uuid_status`, `uuid_type`, `channel_status`, and `channel_type`."
   - date: 2025-01-07
     version: v5.4.0
     changes:
@@ -596,7 +603,7 @@ sdks:
                     - x86-64
           - distribution-type: package
             distribution-repository: RubyGems
-            package-name: pubnub-5.4.0.gem
+            package-name: pubnub-5.5.0.gem
             location: https://rubygems.org/gems/pubnub
             requires:
               - name: addressable
@@ -701,8 +708,8 @@ sdks:
                     - x86-64
           - distribution-type: library
             distribution-repository: GitHub release
-            package-name: pubnub-5.4.0.gem
-            location: https://github.com/pubnub/ruby/releases/download/v5.4.0/pubnub-5.4.0.gem
+            package-name: pubnub-5.5.0.gem
+            location: https://github.com/pubnub/ruby/releases/download/v5.5.0/pubnub-5.5.0.gem
             requires:
               - name: addressable
                 min-version: 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v5.5.0
+January 28 2025
+
+#### Added
+- Add the ability to specify `type` and `status` fields for `channel metadata`, `uuid metadata`, `member`, and `membership`.
+- Add missing `include` options for App Context APIs: `custom`, `status`, `type`, `uuid_status`, `uuid_type`, `channel_status`, and `channel_type`.
+
 ## v5.4.0
 January 07 2025
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pubnub (5.4.0)
+    pubnub (5.5.0)
       addressable (>= 2.0.0)
       concurrent-ruby (~> 1.3.4)
       concurrent-ruby-edge (~> 0.7.1)

data/VERSION

@@ -1 +1 @@
-5.4.0
+5.5.0

data/lib/pubnub/event.rb

@@ -178,7 +178,7 @@ module Pubnub
                      include_custom_message_type include_message_actions include_message_type
                      replicate with_presence cipher_key_selector include_meta include_uuid join
                      update get add remove push_token push_gateway environment topic
-                     authorized_uuid authorized_user_id token type value]
+                     authorized_uuid authorized_user_id token type status value]
 
       options = options.each_with_object({}) { |option, obj| obj[option.first.to_sym] = option.last }
 

data/lib/pubnub/events/get_all_channels_metadata.rb

@@ -11,18 +11,22 @@ module Pubnub
       @event = current_operation
       @telemetry_name = :l_obj
       @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_count = [0, '0', false].include?(options[:include][:count]) ? "0" : "1" unless options[:include][:count].nil?
-        @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])
+        @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
@@ -41,7 +45,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 unless @include.to_s.empty?
+      parameters[:include] = @include.sort.join(',') unless @include.empty?
 
       parameters
     end
@@ -56,12 +60,12 @@ module Pubnub
     end
 
     def valid_envelope(parsed_response, req_res_objects)
-      channels_metadata = parsed_response['data'].map { |uuid_metadata|
-        metadata = Hash.new
-        uuid_metadata.each{ |k,v| metadata[k.to_sym] = v }
+      channels_metadata = parsed_response['data'].map do |uuid_metadata|
+        metadata = {}
+        uuid_metadata.each { |k, v| metadata[k.to_sym] = v }
         metadata[:updated] = Date._parse(metadata[:updated]) unless metadata[:updated].nil?
         metadata
-      }
+      end
 
       Pubnub::Envelope.new(
         event: @event,

data/lib/pubnub/events/get_all_uuid_metadata.rb

@@ -11,18 +11,22 @@ module Pubnub
       @event = current_operation
       @telemetry_name = :l_obj
       @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_count = [0, '0', false].include?(options[:include][:count]) ? "0" : "1" unless options[:include][:count].nil?
-        @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])
+        @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
@@ -41,7 +45,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 unless @include.to_s.empty?
+      parameters[:include] = @include.sort.join(',') unless @include.empty?
 
       parameters
     end
@@ -56,12 +60,12 @@ module Pubnub
     end
 
     def valid_envelope(parsed_response, req_res_objects)
-      uuids_metadata = parsed_response['data'].map { |uuid_metadata|
-        metadata = Hash.new
-        uuid_metadata.each{ |k,v| metadata[k.to_sym] = v }
+      uuids_metadata = parsed_response['data'].map do |uuid_metadata|
+        metadata = {}
+        uuid_metadata.each { |k, v| metadata[k.to_sym] = v }
         metadata[:updated] = Date._parse(metadata[:updated]) unless metadata[:updated].nil?
         metadata
-      }
+      end
 
       Pubnub::Envelope.new(
         event: @event,

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/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/validators/set_channel_metadata.rb

@@ -37,24 +37,28 @@ module Pubnub
       end
 
       def validate_metadata!
-        raise(
-          ArgumentError.new(object: self, message: ':metadata is required for set channel metadata event.'),
-          ':metadata is required for set channel metadata event.'
-        ) if @metadata.nil? || @metadata.empty?
+        if @metadata.nil? || @metadata.empty?
+          raise(
+            ArgumentError.new(object: self, message: ':metadata is required for set channel metadata event.'),
+            ':metadata is required for set channel metadata event.'
+          )
+        end
 
-        raise(
-          ArgumentError.new(object: self, message: ':metadata parameter for set channel metadata must be Hash.'),
-          ':metadata parameter for set channel metadata must be Hash.'
-        ) if @metadata.class != Hash
+        if @metadata.class != Hash
+          raise(
+            ArgumentError.new(object: self, message: ':metadata parameter for set channel metadata must be Hash.'),
+            ':metadata parameter for set channel metadata must be Hash.'
+          )
+        end
 
-        known_channel_metadata_fields = %w[name description custom updated eTag]
+        known_channel_metadata_fields = %w[name description type status custom]
 
         @metadata.each_key do |field_name|
-          unless known_channel_metadata_fields.include?(field_name.to_s)
-            message = "Unknown channel metadata key: '#{field_name}'. Only following keys allowed: #{known_channel_metadata_fields.join(", ")}"
+          next if known_channel_metadata_fields.include?(field_name.to_s)
+
+          message = "Unknown channel metadata key: '#{field_name}'. Only following keys allowed: #{known_channel_metadata_fields.join(', ')}"
 
-            raise(ArgumentError.new(object: self, message: message), message)
-          end
+          raise(ArgumentError.new(object: self, message: message), message)
         end
       end
     end

data/lib/pubnub/validators/set_uuid_metadata.rb

@@ -37,24 +37,28 @@ module Pubnub
       end
 
       def validate_metadata!
-        raise(
-          ArgumentError.new(object: self, message: ':metadata is required for set uuid metadata event.'),
-          ':metadata is required for set uuid metadata event.'
-        ) if @metadata.nil? || @metadata.empty?
+        if @metadata.nil? || @metadata.empty?
+          raise(
+            ArgumentError.new(object: self, message: ':metadata is required for set uuid metadata event.'),
+            ':metadata is required for set uuid metadata event.'
+          )
+        end
 
-        raise(
-          ArgumentError.new(object: self, message: ':metadata parameter for set uuid metadata must be Hash.'),
-          ':metadata parameter for set uuid metadata must be Hash.'
-        ) if @metadata.class != Hash
+        if @metadata.class != Hash
+          raise(
+            ArgumentError.new(object: self, message: ':metadata parameter for set uuid metadata must be Hash.'),
+            ':metadata parameter for set uuid metadata must be Hash.'
+          )
+        end
 
-        known_uuid_metadata_fields = %w[name email externalId profileUrl custom updated eTag]
+        known_uuid_metadata_fields = %w[name email externalId profileUrl type status custom]
 
         @metadata.each_key do |field_name|
-          unless known_uuid_metadata_fields.include?(field_name.to_s)
-            message = "Unknown uuid metadata key: '#{field_name}'. Only following keys allowed: #{known_uuid_metadata_fields.join(", ")}"
+          next if known_uuid_metadata_fields.include?(field_name.to_s)
+
+          message = "Unknown uuid metadata key: '#{field_name}'. Only following keys allowed: #{known_uuid_metadata_fields.join(', ')}"
 
-            raise(ArgumentError.new(object: self, message: message), message)
-          end
+          raise(ArgumentError.new(object: self, message: message), message)
         end
       end
     end

data/lib/pubnub/version.rb

@@ -1,4 +1,4 @@
 # Toplevel Pubnub module.
 module Pubnub
-  VERSION = '5.4.0'.freeze
+  VERSION = '5.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 platform: ruby
 authors:
 - PubNub
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-07 00:00:00.000000000 Z
+date: 2025-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -295,7 +295,7 @@ homepage: https://github.com/pubnub/ruby
 licenses:
 - LicenseRef-LICENSE.txt
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -310,8 +310,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: PubNub Official Ruby gem.
 test_files: