pubnub 4.1.6 → 4.2.0

data/lib/pubnub/events/delete_user.rb

@@ -0,0 +1,78 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds DeleteUser functionality
+  class DeleteUser < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::DeleteUser
+
+    def initialize(options, app)
+      @event = :delete_user
+      @telemetry_name = :l_obj
+      @user_id = options[:user_id]
+      super
+    end
+
+    def fire
+      Pubnub.logger.debug('Pubnub::DeleteUser') { "Fired event #{self.class}" }
+
+      body = Formatter.format_message(@data, @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_DELETE_USER
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'objects',
+        @subscribe_key,
+        'users',
+        @user_id
+      ].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: Pubnub::Constants::OPERATION_DELETE_USER,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_DELETE_USER,
+          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_members.rb

@@ -0,0 +1,93 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds GetMembers functionality
+  class GetMembers < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GetMembers
+    @max_limit = 100
+
+    def initialize(options, app)
+      @event = :get_members
+      @telemetry_name = :l_obj
+      @start = options[:start]
+      @end = if options[:end].nil?
+               @max_limit
+             else
+               @end = options[:end]
+             end
+      @limit = options[:limit]
+      @count = if options[:count].nil?
+                 false
+               else
+                 options[:count]
+               end
+      @include = options[:include]
+      @space_id = options[:space_id]
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GET_MEMBERS
+    end
+
+    def parameters(*_args)
+      parameters = super
+      parameters[:start] = @start if @start
+      parameters[:end] = @end if @end && !@start
+      parameters[:count] = @count if @count
+      parameters[:limit] = @limit if @limit && @limit != @max_limit
+      parameters[:include] = @include if @include
+
+      parameters
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'objects',
+        @subscribe_key,
+        'spaces',
+        @space_id,
+        'users'
+      ].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: Pubnub::Constants::OPERATION_GET_MEMBERS,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_GET_MEMBERS,
+          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

@@ -0,0 +1,74 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds GetSpace functionality
+  class GetSpace < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GetSpace
+
+    def initialize(options, app)
+      @event = :get_space
+      @telemetry_name = :l_obj
+      @space_id = options[:space_id]
+      @include = options[:include]
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GET_SPACE
+    end
+
+    def parameters(*_args)
+      parameters = super
+      parameters[:include] = @include if @include
+      parameters
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'objects',
+        @subscribe_key,
+        'spaces',
+        @space_id
+      ].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: Pubnub::Constants::OPERATION_GET_SPACE,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_GET_SPACE,
+          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_memberships.rb

@@ -0,0 +1,93 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds GetSpaceMemberships functionality
+  class GetSpaceMemberships < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GetSpaceMemberships
+    @max_limit = 100
+
+    def initialize(options, app)
+      @event = :get_space_memberships
+      @telemetry_name = :l_obj
+      @start = options[:start]
+      @end = if options[:end].nil?
+               @max_limit
+             else
+               @end = options[:end]
+             end
+      @limit = options[:limit]
+      @count = if options[:count].nil?
+                 false
+               else
+                 options[:count]
+               end
+      @include = options[:include]
+      @user_id = options[:user_id]
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GET_SPACE_MEMBERSHIPS
+    end
+
+    def parameters(*_args)
+      parameters = super
+      parameters[:start] = @start if @start
+      parameters[:end] = @end if @end && !@start
+      parameters[:count] = @count if @count
+      parameters[:limit] = @limit if @limit && @limit != @max_limit
+      parameters[:include] = @include if @include
+
+      parameters
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'objects',
+        @subscribe_key,
+        'users',
+        @user_id,
+        'spaces'
+      ].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: Pubnub::Constants::OPERATION_GET_SPACE_MEMBERSHIPS,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_GET_SPACE_MEMBERSHIPS,
+          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_spaces.rb

@@ -0,0 +1,90 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds GetSpaces functionality
+  class GetSpaces < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GetSpaces
+    @max_limit = 100
+
+    def initialize(options, app)
+      @event = :get_spaces
+      @telemetry_name = :l_obj
+      @start = options[:start]
+      @end = if options[:end].nil?
+               @max_limit
+             else
+               @end = options[:end]
+             end
+      @limit = options[:limit]
+      @count = if options[:count].nil?
+                 false
+               else
+                 options[:count]
+               end
+      @include = options[:include]
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GET_SPACES
+    end
+
+    def parameters(*_args)
+      parameters = super
+      parameters[:start] = @start if @start
+      parameters[:end] = @end if @end && !@start
+      parameters[:count] = @count if @count
+      parameters[:limit] = @limit if @limit && @limit != @max_limit
+      parameters[:include] = @include if @include
+
+      parameters
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'objects',
+        @subscribe_key,
+        'spaces'
+      ].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: Pubnub::Constants::OPERATION_GET_SPACES,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_GET_SPACES,
+          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_user.rb

@@ -0,0 +1,74 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds GetUser functionality
+  class GetUser < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GetUser
+
+    def initialize(options, app)
+      @event = :get_user
+      @telemetry_name = :l_obj
+      @user_id = options[:user_id]
+      @include = options[:include]
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GET_USER
+    end
+
+    def parameters(*_args)
+      parameters = super
+      parameters[:include] = @include if @include
+      parameters
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'objects',
+        @subscribe_key,
+        'users',
+        @user_id
+      ].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: Pubnub::Constants::OPERATION_GET_USER,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: Pubnub::Constants::OPERATION_GET_USER,
+          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