pubnub 4.3.0 → 4.4.0

data/lib/pubnub/events/remove_memberships.rb

@@ -0,0 +1,117 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds RemoveMemberships functionality
+  class RemoveMemberships < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::RemoveMemberships
+
+    def initialize(options, app)
+      @event = current_operation
+      @telemetry_name = :l_obj
+      @uuid = options[:uuid]
+      @limit = [options[:limit], 100].min unless options[:limit].nil?
+      @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?
+
+      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? }
+      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?
+
+      super
+    end
+
+    def fire
+      Pubnub.logger.debug('Pubnub::RemoveMemberships') { "Fired event #{self.class}" }
+
+      memberships = @channels.map do |membership|
+        { channel: { id: membership[:channel] } }
+      end
+
+      body = Formatter.format_message({ delete: memberships }, @cipher_key, false)
+      response = send_request(body)
+
+      envelopes = fire_callbacks(handle(response, uri))
+      finalize_event(envelopes)
+      envelopes
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_REMOVE_MEMBERSHIPS
+    end
+
+    def parameters(signature = false)
+      parameters = super(signature)
+      parameters[:limit] = @limit unless @limit.nil?
+      parameters[:sort] = @sort unless @sort.nil?
+      parameters[:filter] = @filter unless @filter.nil?
+      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
+    end
+
+    def path
+      '/' + [
+        'v2',
+        'objects',
+        @subscribe_key,
+        'uuids',
+        Formatter.encode(@uuid),
+        'channels'
+      ].join('/')
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+
+        result: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: nil,
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          config: get_config
+        }
+      )
+    end
+  end
+end

data/lib/pubnub/events/{delete_user.rb → remove_uuid_metadata.rb}

@@ -2,20 +2,20 @@
 # frozen_string_literal: true
 
 module Pubnub
-  # Holds DeleteUser functionality
-  class DeleteUser < SingleEvent
+  # Holds RemoveUuidMetadata functionality
+  class RemoveUuidMetadata < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::DeleteUser
+    include Pubnub::Validator::RemoveUuidMetadata
 
     def initialize(options, app)
-      @event = :delete_user
+      @event = current_operation
       @telemetry_name = :l_obj
-      @user_id = options[:user_id]
+      @uuid = options[:uuid]
       super
     end
 
     def fire
-      Pubnub.logger.debug('Pubnub::DeleteUser') { "Fired event #{self.class}" }
+      Pubnub.logger.debug('Pubnub::RemoveUuidMetadata') { "Fired event #{self.class}" }
 
       body = Formatter.format_message(@data, @cipher_key, false)
       response = send_request(body)
@@ -28,16 +28,16 @@ module Pubnub
     private
 
     def current_operation
-      Pubnub::Constants::OPERATION_DELETE_USER
+      Pubnub::Constants::OPERATION_REMOVE_UUID_METADATA
     end
 
     def path
       '/' + [
-        'v1',
+        'v2',
         'objects',
         @subscribe_key,
-        'users',
-        @user_id
+        'uuids',
+        Formatter.encode(@uuid)
       ].join('/')
     end
 
@@ -49,7 +49,7 @@ module Pubnub
 
         result: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_DELETE_USER,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: parsed_response
@@ -57,7 +57,7 @@ module Pubnub
 
         status: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_DELETE_USER,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: nil,

data/lib/pubnub/events/set_channel_members.rb

@@ -0,0 +1,120 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds SetChannelMembers functionality
+  class SetChannelMembers < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::SetChannelMembers
+
+    def initialize(options, app)
+      @event = current_operation
+      @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?
+      @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?
+
+      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? }
+      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?
+
+      super
+    end
+
+    def fire
+      Pubnub.logger.debug('Pubnub::SetChannelMembers') { "Fired event #{self.class}" }
+
+      members = @uuids.map do |member|
+        member_object = { uuid: { id: member[:uuid] } }
+        member_object[:custom] = member[:custom] if member[:custom] && !member[:custom].empty?
+
+        member_object
+      end
+
+      body = Formatter.format_message({ set: members }, @cipher_key, false)
+      response = send_request(body)
+
+      envelopes = fire_callbacks(handle(response, uri))
+      finalize_event(envelopes)
+      envelopes
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_SET_CHANNEL_MEMBERS
+    end
+
+    def parameters(signature = false)
+      parameters = super(signature)
+      parameters[:limit] = @limit unless @limit.nil?
+      parameters[:sort] = @sort unless @sort.nil?
+      parameters[:filter] = @filter unless @filter.nil?
+      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
+    end
+
+    def path
+      '/' + [
+        'v2',
+        'objects',
+        @subscribe_key,
+        'channels',
+        Formatter.channels_for_url(@channel),
+        'uuids'
+      ].join('/')
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+
+        result: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: nil,
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          config: get_config
+        }
+      )
+    end
+  end
+end

data/lib/pubnub/events/{create_space.rb → set_channel_metadata.rb}

@@ -2,23 +2,32 @@
 # frozen_string_literal: true
 
 module Pubnub
-  # Holds CreateSpace functionality
-  class CreateSpace < SingleEvent
+  # Holds SetChannelMetadata functionality
+  class SetChannelMetadata < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::CreateSpace
+    include Pubnub::Validator::SetChannelMetadata
 
     def initialize(options, app)
-      @event = :create_space
+      @event = current_operation
       @telemetry_name = :l_obj
-      @data = options[:data]
-      @include = options[:include]
+      @channel = options[:channel]
+
+      # Clean up user-provided metadata object from nils.
+      @metadata = options[:metadata].delete_if { |_k, v| v.blank? } unless options[:metadata].nil?
+
+      if options[:include]
+        @include = [0, '0', false].include?(options[:include][:custom]) ? "0" : "1" unless options[:include][:custom].nil?
+      end
+
+      # Single entity creation should return it's 'custom' field by default.
+      @include = "custom" if @include.nil?
       super
     end
 
     def fire
-      Pubnub.logger.debug('Pubnub::CreateSpace') { "Fired event #{self.class}" }
+      Pubnub.logger.debug('Pubnub::SetChannelMetadata') { "Fired event #{self.class}" }
 
-      body = Formatter.format_message(@data, @cipher_key, false)
+      body = Formatter.format_message(@metadata, @cipher_key, false)
       response = send_request(body)
 
       envelopes = fire_callbacks(handle(response, uri))
@@ -29,21 +38,22 @@ module Pubnub
     private
 
     def current_operation
-      Pubnub::Constants::OPERATION_CREATE_SPACE
+      Pubnub::Constants::OPERATION_SET_CHANNEL_METADATA
     end
 
-    def parameters(*_args)
-      parameters = super
-      parameters[:include] = @include if @include
+    def parameters(signature = false)
+      parameters = super(signature)
+      parameters[:include] = @include
       parameters
     end
 
     def path
       '/' + [
-        'v1',
+        'v2',
         'objects',
         @subscribe_key,
-        'spaces'
+        'channels',
+        Formatter.channels_for_url(@channel)
       ].join('/')
     end
 
@@ -55,7 +65,7 @@ module Pubnub
 
         result: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_CREATE_SPACE,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: parsed_response
@@ -63,7 +73,7 @@ module Pubnub
 
         status: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_CREATE_SPACE,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: nil,

data/lib/pubnub/events/set_memberships.rb

@@ -0,0 +1,120 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds SetMemberships functionality
+  class SetMemberships < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::SetMemberships
+
+    def initialize(options, app)
+      @event = current_operation
+      @telemetry_name = :l_obj
+      @uuid = options[:uuid]
+      @limit = [options[:limit], 100].min unless options[:limit].nil?
+      @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?
+
+      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? }
+      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?
+
+      super
+    end
+
+    def fire
+      Pubnub.logger.debug('Pubnub::SetMemberships') { "Fired event #{self.class}" }
+
+      memberships = @channels.map do |membership|
+        membership_object = { channel: { id: membership[:channel] } }
+        membership_object[:custom] = membership[:custom] if membership[:custom] && !membership[:custom].empty?
+
+        membership_object
+      end
+
+      body = Formatter.format_message({ set: memberships }, @cipher_key, false)
+      response = send_request(body)
+
+      envelopes = fire_callbacks(handle(response, uri))
+      finalize_event(envelopes)
+      envelopes
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_SET_MEMBERSHIPS
+    end
+
+    def parameters(signature = false)
+      parameters = super(signature)
+      parameters[:limit] = @limit unless @limit.nil?
+      parameters[:sort] = @sort unless @sort.nil?
+      parameters[:filter] = @filter unless @filter.nil?
+      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
+    end
+
+    def path
+      '/' + [
+        'v2',
+        'objects',
+        @subscribe_key,
+        'uuids',
+        Formatter.encode(@uuid),
+        'channels'
+      ].join('/')
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+
+        result: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: nil,
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          config: get_config
+        }
+      )
+    end
+  end
+end