pubnub 4.7.0 → 4.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60893402c5e2e35de1e5f78237b7a031920bf5c1eb3533c33bfc0b20441d2616
-  data.tar.gz: e3d018155805ab0a09453d8560aaf1ddcc35fe9d040229c0a3e9ec1c235bafdd
+  metadata.gz: c52a9cfe08cbc90c671a74610beb900b5627c81e9f24da57e0c60530aa05c5b9
+  data.tar.gz: 5dd3300e2b6667e2364ab3e6d56f6583d3ca1eb71caa1839e9e97d3dbe68ec50
 SHA512:
-  metadata.gz: '09fd547306bf18cc940d87ca6fe568c9e7fca6b5a6a309dc7e0fb159af537d604b0ff846857df420716d9092963d116bb08be6fb573de55c9913599eafae8873'
-  data.tar.gz: bd33c010676d951a71cadcc76184357441c911e4ab763a95e34f783033a942c88ecffb3e3afecb0fc74184964eff11d43e07cb6e908161045e8a730b9438b25a
+  metadata.gz: 3385c44fe3b07c3f84ff233e3bc42456e0907ff56e2fd65bd6197b2bcaa6edd75c3d53268959bb1491b88e7eaf3e49308a3afbed86a3bbebc2062364336b95be
+  data.tar.gz: 50506cf261d7d8c8240b8a25683dbe1032ebbb99b4f9dc3ba609228672fb8e3609ee43c3a0cc94052e8d80177e7e3554ee8b57458275d5a9865b37b7ad81ca1a

data/.pubnub.yml

@@ -1,6 +1,13 @@
 ---
-version: "4.7.0"
+version: "4.7.1"
 changelog:
+  - date: 2021-11-24
+    version: v4.7.1
+    changes:
+      - type: feature
+        text: "Add new method `all_history_messages` which return messages from requested interval or `since` / `before` date in single object."
+      - type: bug
+        text: "Fix exception raised when optional start / end not passed to `paged_history`."
   - date: 2021-11-09
     version: v4.7.0
     changes:
@@ -605,7 +612,7 @@ sdks:
                     - x86-64
           - distribution-type: package
             distribution-repository: RubyGems
-            package-name: pubnub-4.7.0.gem
+            package-name: pubnub-4.7.1.gem
             location: https://rubygems.org/gems/pubnub
             requires:
               - name: addressable
@@ -710,8 +717,8 @@ sdks:
                     - x86-64
           - distribution-type: library
             distribution-repository: GitHub release
-            package-name: pubnub-v4.7.0.gem
-            location: https://github.com/pubnub/ruby/releases/download/v4.7.0/pubnub-4.7.0.gem
+            package-name: pubnub-4.7.1.gem
+            location: https://github.com/pubnub/ruby/releases/download/v4.7.1/pubnub-4.7.1.gem
             requires:
               - name: addressable
                 min-version: 2.0.0

data/CHANGELOG.md

@@ -1,19 +1,28 @@
-## v4.7.0
-November 09 2021
+## v4.7.1
+November 24 2021
 
 #### Added
-- Grant_token allows generation of signed token with permissions for channels, channel groups and uuids.
+- Add new method `all_history_messages` which return messages from requested interval or `since` / `before` date in single object.
 
-##### v4.6.2
-
-- Add new `sdks` section to `.pubnub.yml` with information about available artifacts and distribution variants. 
-
-##### v4.6.1
-
-- Exclude `spec` and `fixtures` from built gem file. 
-- Fix Ruby SDK repository location under `sdks` section in `.pubnub.yml`. 
-- Add new section to `.pubnub.yml` file with information about SDK and destribution types. 
+#### Fixed
+- Fix exception raised when optional start / end not passed to `paged_history`.
 
+## v4.7.0
+November 09 2021
+
+#### Added
+- Grant_token allows generation of signed token with permissions for channels, channel groups and uuids.
+
+##### v4.6.2
+
+- Add new `sdks` section to `.pubnub.yml` with information about available artifacts and distribution variants. 
+
+##### v4.6.1
+
+- Exclude `spec` and `fixtures` from built gem file. 
+- Fix Ruby SDK repository location under `sdks` section in `.pubnub.yml`. 
+- Add new section to `.pubnub.yml` file with information about SDK and destribution types. 
+
 ##### v4.6.0
 
 - BREAKING CHANGE: Add randomized initialization vector usage by default for data encryption / decryption in publish / subscribe / history API calls. 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pubnub (4.7.0)
+    pubnub (4.7.1)
       addressable (>= 2.0.0)
       concurrent-ruby (~> 1.1.5)
       concurrent-ruby-edge (~> 0.5.0)

data/VERSION

@@ -1 +1 @@
-4.7.0
+4.7.1

data/lib/pubnub/client/paged_history.rb

@@ -1,19 +1,46 @@
+# frozen_string_literal: true
+
 # Toplevel Pubnub module.
 module Pubnub
   # Pubnub client Class
   class Client
     # Module that holds paged_history event logic
     module PagedHistory
+      # Fetch messages as long as one of criteria won't be met.
+      # Messages returned as single envelope.
+      def all_history_messages(options = {}, &block)
+        channel = options.fetch(:channel)
+        # Time frame between which messages should be fetched.
+        start_tt = options.fetch(:start, nil)
+        end_tt = options.fetch(:end, nil)
+        page_size = options.fetch(:page_size, 100)          # How many messages per-request should be fetched.
+        reverse = options.fetch(:reverse, false)            # Order in which messages should be retrieved if :end not set.
+        include_token = options.fetch(:include_token, true) # Whether timetoken should be included with message or not.
+        maximum = options.fetch(:max, 500)                  # Maximum number of messages which should be fetched.
+        callback = options.fetch(:callback, block)
+
+        reverse = false unless end_tt.nil? # Disable revers if closed time interval specified.
+        maximum = nil unless end_tt.nil? # Disable maximum messages count if closed time interval specified.
+
+        if options[:http_sync]
+          sync_all_history_messages(channel, include_token, page_size, reverse, maximum, callback, start: start_tt, end: end_tt)
+        else
+          async_all_history_messages(options)
+        end
+      end
+
       def paged_history(options = {}, &block)
         channel = options.fetch(:channel)
-        page = options.fetch(:page, 1)
-        limit = options.fetch(:limit, 100)
+        page = options.fetch(:page, 1)                      # How many mages should be fetched with specified limit.
+        limit = options.fetch(:limit, 100)                  # How many messages per page should be fetched.
+        include_token = options.fetch(:include_token, false) # Whether timetoken should be included with message or not.
         callback = options.fetch(:callback, block)
-        sync = options[:http_sync]
-        start_tt = options.fetch(:start)
-        end_tt = options.fetch(:end)
-      if sync
-          sync_paged_history(channel, page, limit, callback, start: start_tt, end: end_tt)
+        # Time frame between which messages should be fetched.
+        start_tt = options.fetch(:start, nil)
+        end_tt = options.fetch(:end, nil)
+
+        if options[:http_sync]
+          sync_paged_history(channel, page, limit, include_token, callback, start: start_tt, end: end_tt)
         else
           async_paged_history(options)
         end
@@ -21,40 +48,140 @@ module Pubnub
 
       private
 
-      def sync_paged_history(channel, page, limit, callback, timetokens)
+      def sync_all_history_messages(channel, include_token, page_size, reverse, maximum, callback, timetokens)
+        next_timetoken = timetokens[:start]
+        messages_timetokens = timetokens.dup
+        final_envelope = nil
+        keep_fetching = true
+        messages = []
+
+        while keep_fetching
+          envelope = history(
+            channel: channel,
+            include_token: include_token,
+            count: page_size,
+            reverse: reverse,
+            start: next_timetoken,
+            end: timetokens[:end],
+            http_sync: true
+          )
+
+          # Terminate fetch because last attempt failed.
+          if envelope.status[:category] != :ack
+            final_envelope = envelope
+            break
+          end
+
+          result_data = envelope.result[:data]
+          result_messages = result_data[:messages]
+          break if result_messages.empty?
+
+          if reverse || timetokens[:end]
+            messages_timetokens[:start] = result_data[:start].to_i if messages.empty?
+            messages_timetokens[:end] = result_data[:end].to_i
+            messages.concat(result_messages)
+          else
+            messages_timetokens[:end] = result_data[:end].to_i if messages.empty?
+            messages_timetokens[:start] = result_data[:start].to_i
+            messages.unshift(*result_messages)
+          end
+
+          keep_fetching = result_messages.length == page_size
+          keep_fetching = messages.length < maximum if keep_fetching && maximum && maximum > 0
+
+          if keep_fetching
+            next_timetoken = reverse ? result_data[:end].to_i : result_data[:start].to_i
+            next_timetoken = result_data[:end].to_i unless timetokens[:end].nil?
+          end
+        end
+
+        # Create envelop if no error should be reported.
+        final_envelope = envelope_with_messages(messages, messages_timetokens) if final_envelope.nil?
+
+        callback&.call final_envelope
+        final_envelope
+      end
+
+      # Retrieve results page-by-page (callback called for each page).
+      def sync_paged_history(channel, page, limit, include_token, callback, timetokens)
         envelopes = []
-        page.times do |i|
-          envelopes << history(
+        page.times do |_i|
+          envelope = history(
             channel: channel,
+            include_token: include_token,
             http_sync: true,
             count: limit,
             start: timetokens[:start],
             end: timetokens[:end]
           )
-          envelopes.flatten!
-          timetokens[:end] = envelopes.last.history_start.to_i
-          envelopes = [] unless i == page - 1
+
+          break if envelope.result[:data][:messages].empty?
+
+          envelopes.push envelope
+          timetokens[:start] = envelope.result[:data][:start].to_i
+          # No need to iterate further if there is no more messages.
+          break if envelope.result[:data][:messages].length < limit
         end
 
         call_callback(envelopes, callback)
       end
 
       def async_paged_history(options)
-        Concurrent::Future.new do
+        Concurrent::Future.execute do
           sync_options = options.dup
           sync_options[:http_sync] = true
-          paged_history(sync_options, &block)
+          paged_history(sync_options)
+        end
+      end
+
+      def async_all_history_messages(options)
+        Concurrent::Future.execute do
+          sync_options = options.dup
+          sync_options[:http_sync] = true
+          all_history_messages(sync_options)
         end
       end
 
       def call_callback(envelopes, callback)
-        envelopes.flatten!
         if callback
           envelopes.each do |envelope|
-            secure_call callback, envelope
+            callback.call envelope
           end
         end
         envelopes
+      rescue StandardError => e
+        Pubnub.logger.error('Pubnub::Client') { "Error while calling callback #{e.inspect}" }
+      end
+
+      def envelope_with_messages(messages, timetokens)
+        Pubnub::Envelope.new(
+          event: :history,
+          event_options: nil,
+          timetoken: nil,
+          status: {
+            code: 200,
+            client_request: nil,
+            server_response: nil,
+
+            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: nil
+          },
+          result: {
+            code: 200,
+            operation: Pubnub::Constants::OPERATION_HISTORY,
+            client_request: nil,
+            server_response: nil,
+            data: { messages: messages, end: timetokens[:end], start: timetokens[:start] }
+          }
+        )
       end
     end
   end

data/lib/pubnub/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.7.1
 platform: ruby
 authors:
 - PubNub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2021-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable