pubnub 4.3.0 → 4.4.0

data/lib/pubnub/events/{get_user.rb → get_channel_metadata.rb}

@@ -2,38 +2,45 @@
 # frozen_string_literal: true
 
 module Pubnub
-  # Holds GetUser functionality
-  class GetUser < SingleEvent
+  # Holds GetChannelMetadata functionality
+  class GetChannelMetadata < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::GetUser
+    include Pubnub::Validator::GetChannelMetadata
 
     def initialize(options, app)
-      @event = :get_user
+      @event = current_operation
       @telemetry_name = :l_obj
-      @user_id = options[:user_id]
-      @include = options[:include]
+      @channel = options[:channel]
+
+      if options[:include]
+        @include = "custom" unless [0, '0', false].include?(options[:include][:custom])
+      end
+
+      # Single entity creation should return it's 'custom' field by default.
+      @include = "custom" if @include.nil?
       super
     end
 
     private
 
     def current_operation
-      Pubnub::Constants::OPERATION_GET_USER
+      Pubnub::Constants::OPERATION_GET_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,
-        'users',
-        @user_id
+        'channels',
+        Formatter.channels_for_url(@channel)
       ].join('/')
     end
 
@@ -45,7 +52,7 @@ module Pubnub
 
         result: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_GET_USER,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: parsed_response
@@ -53,7 +60,7 @@ module Pubnub
 
         status: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_GET_USER,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: nil,

data/lib/pubnub/events/get_memberships.rb

@@ -0,0 +1,100 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds GetMemberships functionality
+  class GetMemberships < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GetMemberships
+
+    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
+
+      # Collections by default return number of available entries.
+      @include_count = "1" if @include_count.nil?
+
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GET_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/{get_space.rb → get_uuid_metadata.rb}

@@ -2,38 +2,45 @@
 # frozen_string_literal: true
 
 module Pubnub
-  # Holds GetSpace functionality
-  class GetSpace < SingleEvent
+  # Holds GetUuidMetadata functionality
+  class GetUuidMetadata < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::GetSpace
+    include Pubnub::Validator::GetUuidMetadata
 
     def initialize(options, app)
-      @event = :get_space
+      @event = current_operation
       @telemetry_name = :l_obj
-      @space_id = options[:space_id]
-      @include = options[:include]
+      @uuid = options[:uuid]
+
+      if options[:include]
+        @include = "custom" unless [0, '0', false].include?(options[:include][:custom])
+      end
+
+      # Single entity creation should return it's 'custom' field by default.
+      @include = "custom" if @include.nil?
       super
     end
 
     private
 
     def current_operation
-      Pubnub::Constants::OPERATION_GET_SPACE
+      Pubnub::Constants::OPERATION_GET_UUID_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',
-        @space_id
+        'uuids',
+        Formatter.encode(@uuid)
       ].join('/')
     end
 
@@ -45,7 +52,7 @@ module Pubnub
 
         result: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_GET_SPACE,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: parsed_response
@@ -53,7 +60,7 @@ module Pubnub
 
         status: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_GET_SPACE,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: nil,

data/lib/pubnub/events/grant.rb

@@ -6,8 +6,9 @@ module Pubnub
     include Pubnub::Validator::Grant
 
     def initialize(options, app)
-      @event = :grant
+      @event = current_operation
       super
+      @uuids = options[:uuids] unless options[:uuids].nil?
       @ttl ||= Pubnub::Constants::DEFAULT_TTL
     end
 
@@ -21,18 +22,19 @@ module Pubnub
       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 @group.blank?
-
-      if @delete.blank?
-        delete = nil
-      else
-        delete = [0, '0', false].include?(@delete) ? 0 : 1
-      end
+      delete = [0, '0', false].include?(@delete) ? 0 : 1 unless @delete.nil?
+      get = [0, '0', false].include?(@get) ? 0 : 1 unless @get.nil?
+      update = [0, '0', false].include?(@update) ? 0 : 1 unless @update.nil?
+      join = [0, '0', false].include?(@join) ? 0 : 1 unless @join.nil?
 
       { timestamp: @timestamp,
         w: write,
         r: read,
         m: manage,
         d: delete,
+        g: get,
+        u: update,
+        j: join,
         ttl: @ttl }.delete_if { |_k, v| v.nil? }.merge(super(signature))
     end
 

data/lib/pubnub/events/remove_channel_members.rb

@@ -0,0 +1,117 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds RemoveChannelMembers functionality
+  class RemoveChannelMembers < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::RemoveChannelMembers
+
+    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::RemoveChannelMembers') { "Fired event #{self.class}" }
+
+      members = @uuids.map do |member|
+        { uuid: { id: member[:uuid] } }
+      end
+
+      body = Formatter.format_message({ delete: 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_REMOVE_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/{delete_space.rb → remove_channel_metadata.rb}

@@ -2,20 +2,20 @@
 # frozen_string_literal: true
 
 module Pubnub
-  # Holds DeleteSpace functionality
-  class DeleteSpace < SingleEvent
+  # Holds RemoveChannelMetadata functionality
+  class RemoveChannelMetadata < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::DeleteSpace
+    include Pubnub::Validator::RemoveChannelMetadata
 
     def initialize(options, app)
-      @event = :delete_space
+      @event = :remove_channel_metadata
       @telemetry_name = :l_obj
-      @space_id = options[:space_id]
+      @channel = options[:channel]
       super
     end
 
     def fire
-      Pubnub.logger.debug('Pubnub::DeleteSpace') { "Fired event #{self.class}" }
+      Pubnub.logger.debug('Pubnub::RemoveChannelMetadata') { "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_SPACE
+      Pubnub::Constants::OPERATION_REMOVE_CHANNEL_METADATA
     end
 
     def path
       '/' + [
-        'v1',
+        'v2',
         'objects',
         @subscribe_key,
-        'spaces',
-        @space_id
+        'channels',
+        Formatter.channels_for_url(@channel)
       ].join('/')
     end
 
@@ -49,7 +49,7 @@ module Pubnub
 
         result: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_DELETE_SPACE,
+          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_SPACE,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: nil,