pubnub 5.3.4 → 5.4.0

data/lib/pubnub/events/fetch_messages.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Pubnub
+  # Holds functionality to fetch:
+  # - batch messages (for multiple channels)
+  # - messages with message actions.
+  class FetchMessages < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::FetchMessages
+
+    def initialize(options, app)
+      @telemetry_name = :l_hist
+      @include_custom_message_type = options.fetch(:include_custom_message_type, false)
+      @include_message_actions = options.fetch(:include_message_actions, false)
+      @include_message_type = options.fetch(:include_message_type, true)
+      @include_uuid = options.fetch(:include_uuid, true)
+      @include_meta = options.fetch(:include_meta, false)
+      @start = options[:start] if options.key?(:start)
+      @end = options[:end] if options.key?(:end)
+
+      channel = options[:channel] if options.key?(:channel) && !options[:channel].empty?
+      @channels = options[:channels] if options.key?(:channels) && !options[:channels].empty?
+      if @include_message_actions
+        @channel = channel
+      elsif @channels.nil? && !channel.nil?
+        @channels = [channel]
+        @channel = nil
+        options.delete :channel
+      end
+
+      maximum = @include_message_actions || @channels&.size == 1 ? 100 : 25
+      @max = [options[:max], maximum].min unless options[:max].nil?
+
+      @event = current_operation
+
+      # Override crypto module if custom cipher key has been used.
+      random_iv = options.key?(:random_iv) ? options[:random_iv] : true
+      options[:crypto_module] = Crypto::CryptoModule.new_legacy(options[:cipher_key], random_iv) if options[:cipher_key]
+
+      super
+    end
+
+    private
+
+    def current_operation
+      @include_message_actions ? Pubnub::Constants::OPERATION_FETCH_MESSAGES_WITH_ACTIONS : Pubnub::Constants::OPERATION_FETCH_MESSAGES
+    end
+
+    def parameters(signature: false)
+      parameters = super(signature)
+      parameters[:include_meta] = 'true' if @include_meta
+      parameters[:include_uuid] = 'true' if @include_uuid
+      parameters[:include_custom_message_type] = 'true' if @include_custom_message_type
+      parameters[:include_message_type] = 'true' if @include_message_type
+      parameters[:start] = @start unless @start.nil?
+      parameters[:end] = @end unless @end.nil?
+      parameters[:max] = @max unless @max.nil?
+
+      parameters
+    end
+
+    def path
+      storage_endpoint = @include_message_actions ? 'history-with-actions' : 'history'
+      "/v3/#{storage_endpoint}/sub-key/#{@subscribe_key}/channel/#{Pubnub::Formatter.channels_for_url((
+                                                                                                        unless @channel.nil?
+                                                                                                          [@channel]
+                                                                                                        end) || @channels)}"
+    end
+
+    def enable_format_channels?
+      false
+    end
+
+    def decrypt_history(crypto, message)
+      encrypted_message = Base64.strict_decode64(message['message'])
+      message['message'] = JSON.parse(crypto.decrypt(encrypted_message), quirks_mode: true)
+      message
+    rescue StandardError => e
+      puts "Pubnub :: DECRYPTION ERROR: #{e}"
+      message['decrypt_error'] = true
+      message
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      channels = parsed_response['channels'] unless parsed_response['error']
+      more = parsed_response['more'].transform_keys(&:to_sym) if parsed_response.key?('more')
+      more&.delete :url
+
+      if crypto_module && channels
+        crypto = crypto_module
+        channels.transform_values! do |channel_messages|
+          channel_messages.map(&method(:decrypt_history).curry[crypto])
+        end
+      end
+
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+        status: {
+          code: req_res_objects[:response].code,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+
+          category: Pubnub::Constants::STATUS_ACK,
+          error: false,
+          auto_retried: false,
+
+          data: nil,
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          config: get_config
+        },
+        result: {
+          code: req_res_objects[:response].code,
+          operation: @event,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+
+          data: { channels: channels }.merge!(more.nil? ? {} : { more: more })
+        }
+      )
+    end
+  end
+end

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/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

data/lib/pubnub/version.rb

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

data/pubnub.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.0.0'
 
   spec.add_dependency 'addressable', '>= 2.0.0'
-  spec.add_dependency 'concurrent-ruby', '~> 1.1.5'
-  spec.add_dependency 'concurrent-ruby-edge', '~> 0.5.0'
+  spec.add_dependency 'concurrent-ruby', '~> 1.3.4'
+  spec.add_dependency 'concurrent-ruby-edge', '~> 0.7.1'
   spec.add_dependency 'dry-validation', '~> 1.0'
   spec.add_dependency 'httpclient', '~> 2.8', '>= 2.8.3'
   spec.add_dependency 'json', '>= 2.2.0', '< 3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 5.3.4
+  version: 5.4.0
 platform: ruby
 authors:
 - PubNub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2025-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby-edge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +184,7 @@ files:
 - lib/pubnub/events/audit.rb
 - lib/pubnub/events/channel_registration.rb
 - lib/pubnub/events/delete_messages.rb
+- lib/pubnub/events/fetch_messages.rb
 - lib/pubnub/events/get_all_channels_metadata.rb
 - lib/pubnub/events/get_all_uuid_metadata.rb
 - lib/pubnub/events/get_channel_members.rb
@@ -251,6 +252,7 @@ files:
 - lib/pubnub/validators/client.rb
 - lib/pubnub/validators/common_validator.rb
 - lib/pubnub/validators/delete.rb
+- lib/pubnub/validators/fetch_messages.rb
 - lib/pubnub/validators/get_all_channels_metadata.rb
 - lib/pubnub/validators/get_all_uuid_metadata.rb
 - lib/pubnub/validators/get_channel_members.rb