pubnub 5.3.5 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c7cc7a030addfbffc036f0aad24012009e7299a2dd7b64dcf6555db3967516
-  data.tar.gz: 527ccc89a82801ab418c32907fc4df3333f3605794b3124445aafa647864275a
+  metadata.gz: fc4c6cc7d070726bb7046638c4cb142a9f902b21b0da50ae924d450f39e6e8a7
+  data.tar.gz: 27cb6f7c2e3ec634654b4d6e78984ea51b2ee8338f5cc58b0b08cf136bf1b15f
 SHA512:
-  metadata.gz: fca94c169ea327386f48164e7806bac20233da3b8f51d5ff3fcad61acb34dde0c5bec7f074ea0bf9ed72cc33d38b4170e0ad48607d4954ab71981f70365e440a
-  data.tar.gz: f87ff02c1bca1d1b9cb82be21f159a0af5540237acebef2b36bf034e96f8f083568e262d81964cca5012c5b84f3c4d50aedabc18e997f0f42ebb5672fb5f1990
+  metadata.gz: 401aa81c9dcafdd86d3d9626c18c321d3758f5a8278be2dca699e8210a2c20412cef22f7001f33fbde630c75c61fb88735deba59657df4e5f0c7e05a0582c672
+  data.tar.gz: 6d6715e518fe654f37d795b4d4ab283b22aab1e29c93d71f1c2df85964a8b52530cdc4f011ec128c053f472668a6f1dd7a4fee09aa0c6b726c3d1583b0b672c7

data/.github/workflows/commands-handler.yml

@@ -12,7 +12,7 @@ jobs:
     name: Process command
     if: github.event.issue.pull_request && endsWith(github.repository, '-private') != true
     runs-on:
-      group: Default
+      group: organization/Default
     steps:
       - name: Check referred user
         id: user-check

data/.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     name: Check release required
     if: ${{ github.event.pull_request.merged && endsWith(github.repository, '-private') != true }}
     runs-on:
-      group: Default
+      group: organization/Default
     outputs:
       release: ${{ steps.check.outputs.ready }}
     steps:
@@ -31,7 +31,7 @@ jobs:
     needs: check-release
     if: ${{ needs.check-release.outputs.release == 'true' }}
     runs-on:
-      group: Default
+      group: organization/Default
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

data/.github/workflows/run-tests.yml

@@ -20,13 +20,13 @@ jobs:
   tests:
     name: Integration and Unit tests
     runs-on:
-      group: Default
+      group: organization/Default
     env:
       NO_COVERAGE: true
     strategy:
       fail-fast: true
       matrix:
-        ruby: [3.0.6, 3.1.4, 3.2.3]
+        ruby: [ 3.0.6, 3.1.4, 3.2.3 ]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -52,7 +52,7 @@ jobs:
   acceptance-tests:
     name: Acceptance tests
     runs-on:
-      group: Default
+      group: organization/Default
     steps:
       - name: Checkout project
         uses: actions/checkout@v4
@@ -67,11 +67,15 @@ jobs:
         uses: ./.github/.release/actions/actions/mock-server
         with:
           token: ${{ secrets.GH_TOKEN }}
-      - name: Setup Ruby 3.0
+      - name: Setup Ruby 3.2.2
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0
+          ruby-version: 3.2.2
           bundler-cache: true
+      - name: Verify Ruby Version
+        run: ruby -v
+      - name: Check Ruby Version for Bundler
+        run: bundle exec ruby -v
       - name: Run acceptance tests (optional)
         run: bundle exec cucumber sdk-specifications/features/ -p mock -p run_beta -p report_beta -f pretty
         continue-on-error: true
@@ -84,7 +88,7 @@ jobs:
           jrm ./main.xml "./main/**/*.xml" &&
           jrm ./beta.xml "./beta/**/*.xml"
       - name: Expose acceptance tests reports
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: always()
         with:
           name: acceptance-test-reports
@@ -97,9 +101,9 @@ jobs:
         uses: ./.github/.release/actions/actions/utils/fast-jobs-failure
   all-tests:
     name: Tests
-    needs: [tests, acceptance-tests]
+    needs: [ tests, acceptance-tests ]
     runs-on:
-      group: Default
+      group: organization/Default
     steps:
       - name: Tests summary
         run: echo -e "\033[38;2;95;215;0m\033[1mAll tests successfully passed"

data/.github/workflows/run-validations.yml

@@ -6,7 +6,7 @@ jobs:
   pubnub-yml:
     name: "Validate .pubnub.yml"
     runs-on:
-      group: Default
+      group: organization/Default
     steps:
       - name: Checkout project
         uses: actions/checkout@v4
@@ -28,7 +28,7 @@ jobs:
     name: Validations
     needs: [pubnub-yml]
     runs-on:
-      group: Default
+      group: organization/Default
     steps:
       - name: Validations summary
         run: echo -e "\033[38;2;95;215;0m\033[1mAll validations passed"

data/.pubnub.yml

@@ -1,6 +1,28 @@
 ---
-version: "5.3.5"
+version: "5.5.0"
 changelog:
+  - date: 2025-01-28
+    version: v5.5.0
+    changes:
+      - type: feature
+        text: "Add the ability to specify `type` and `status` fields for `channel metadata`, `uuid metadata`, `member`, and `membership`."
+      - type: feature
+        text: "Add missing `include` options for App Context APIs: `custom`, `status`, `type`, `uuid_status`, `uuid_type`, `channel_status`, and `channel_type`."
+  - date: 2025-01-07
+    version: v5.4.0
+    changes:
+      - type: feature
+        text: "Add batch history support."
+      - type: feature
+        text: "Add fetch messages with message reactions."
+      - type: feature
+        text: "Add fetch messages (batch history) endpoint support to fetch history for multiple channels."
+      - type: feature
+        text: "Add fetch messages with reactions support."
+      - type: feature
+        text: "Add `include_custom_message_type` support for fetch messages endpoint."
+      - type: feature
+        text: "Add `custom_message_type` support for `publish` / `signal` and `subscribe` endpoints."
   - date: 2024-10-09
     version: v5.3.5
     changes:
@@ -581,7 +603,7 @@ sdks:
                     - x86-64
           - distribution-type: package
             distribution-repository: RubyGems
-            package-name: pubnub-5.3.5.gem
+            package-name: pubnub-5.5.0.gem
             location: https://rubygems.org/gems/pubnub
             requires:
               - name: addressable
@@ -686,8 +708,8 @@ sdks:
                     - x86-64
           - distribution-type: library
             distribution-repository: GitHub release
-            package-name: pubnub-5.3.5.gem
-            location: https://github.com/pubnub/ruby/releases/download/v5.3.5/pubnub-5.3.5.gem
+            package-name: pubnub-5.5.0.gem
+            location: https://github.com/pubnub/ruby/releases/download/v5.5.0/pubnub-5.5.0.gem
             requires:
               - name: addressable
                 min-version: 2.0.0

data/CHANGELOG.md

@@ -1,88 +1,106 @@
-## v5.3.5
-October 09 2024
-
-#### Modified
-- Updated direct and transient dependency versions. Fixed the following issues reported by [@pboling](https://github.com/pboling): [#158](https://github.com/pubnub/ruby/issues/158).
-
-## v5.3.4
-April 29 2024
-
-#### Fixed
-- Fix issue because of which client didn't encode App Context get all event `filter` query value.
-
-## v5.3.3
-January 29 2024
-
-#### Modified
-- Bump required version to the minimum officially supported Ruby version.
-
-## v5.3.2
-November 23 2023
-
-#### Modified
-- Return source event data when a client configured with crypto is unable to decrypt it (can be not encrypted data or encrypted with different options).
-
-## v5.3.1
-November 03 2023
-
-#### Modified
-- Update license information.
-
-## v5.3.0
-October 16 2023
-
-#### Added
-- Add crypto module that allows to configure SDK to encrypt and decrypt messages.
-
-#### Fixed
-- Improved security of crypto implementation by adding enhanced AES-CBC cryptor.
-
-## v5.2.2
-March 14 2023
-
-#### Fixed
-- Fix issue which raised an exception when PubNub client has been configured with a secret key.
-
-## v5.2.1
-December 13 2022
-
-#### Fixed
-- Fix format which is used to return server data from `get_message_actions` method call.
-
-## v5.2.0
-December 12 2022
-
-#### Added
-- Add api which allow to work with message actions endpoints.
-
-#### Modified
-- Migrate test suite run from Travis to GitHub Actions.
-
-## v5.1.2
-November 23 2022
-
-#### Fixed
-- Fix issue because of which channel hasn't been encoded properly with endpoint call.
-
-## v5.1.1
-October 26 2022
-
-#### Fixed
-- Fix issue because of which `callback` and `http_sync` provided during client configuration not used when missing in method call.
-
-## v5.1.0
-July 26 2022
+## v5.5.0
+January 28 2025
 
 #### Added
-- Add support for spaces and users permissions in grant_token.
-- Add user_id and deprecate uuid when creating new pubnub instance.
-
-## v5.0.0
-January 13 2022
-
-#### Modified
-- BREAKING CHANGES: uuid is required parameter to create PubNub instance.
+- Add the ability to specify `type` and `status` fields for `channel metadata`, `uuid metadata`, `member`, and `membership`.
+- Add missing `include` options for App Context APIs: `custom`, `status`, `type`, `uuid_status`, `uuid_type`, `channel_status`, and `channel_type`.
 
+## v5.4.0
+January 07 2025
+
+#### Added
+- Add batch history support.
+- Add fetch messages with message reactions.
+- Add fetch messages (batch history) endpoint support to fetch history for multiple channels.
+- Add fetch messages with reactions support.
+- Add `include_custom_message_type` support for fetch messages endpoint.
+- Add `custom_message_type` support for `publish` / `signal` and `subscribe` endpoints.
+
+## v5.3.5
+October 09 2024
+
+#### Modified
+- Updated direct and transient dependency versions. Fixed the following issues reported by [@pboling](https://github.com/pboling): [#158](https://github.com/pubnub/ruby/issues/158).
+
+## v5.3.4
+April 29 2024
+
+#### Fixed
+- Fix issue because of which client didn't encode App Context get all event `filter` query value.
+
+## v5.3.3
+January 29 2024
+
+#### Modified
+- Bump required version to the minimum officially supported Ruby version.
+
+## v5.3.2
+November 23 2023
+
+#### Modified
+- Return source event data when a client configured with crypto is unable to decrypt it (can be not encrypted data or encrypted with different options).
+
+## v5.3.1
+November 03 2023
+
+#### Modified
+- Update license information.
+
+## v5.3.0
+October 16 2023
+
+#### Added
+- Add crypto module that allows to configure SDK to encrypt and decrypt messages.
+
+#### Fixed
+- Improved security of crypto implementation by adding enhanced AES-CBC cryptor.
+
+## v5.2.2
+March 14 2023
+
+#### Fixed
+- Fix issue which raised an exception when PubNub client has been configured with a secret key.
+
+## v5.2.1
+December 13 2022
+
+#### Fixed
+- Fix format which is used to return server data from `get_message_actions` method call.
+
+## v5.2.0
+December 12 2022
+
+#### Added
+- Add api which allow to work with message actions endpoints.
+
+#### Modified
+- Migrate test suite run from Travis to GitHub Actions.
+
+## v5.1.2
+November 23 2022
+
+#### Fixed
+- Fix issue because of which channel hasn't been encoded properly with endpoint call.
+
+## v5.1.1
+October 26 2022
+
+#### Fixed
+- Fix issue because of which `callback` and `http_sync` provided during client configuration not used when missing in method call.
+
+## v5.1.0
+July 26 2022
+
+#### Added
+- Add support for spaces and users permissions in grant_token.
+- Add user_id and deprecate uuid when creating new pubnub instance.
+
+## v5.0.0
+January 13 2022
+
+#### Modified
+- BREAKING CHANGES: uuid is required parameter to create PubNub instance.
+
 ## v4.8.0
 December 16 2021
 

data/Gemfile

@@ -9,6 +9,7 @@ group :test do
   gem 'rspec-retry'
   gem 'rspec-expectations'
   gem 'rubocop'
+  gem 'standard'
   gem 'simplecov', '>= 0.21.2', require: false
   gem 'vcr'
   gem 'webmock'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pubnub (5.3.5)
+    pubnub (5.5.0)
       addressable (>= 2.0.0)
       concurrent-ruby (~> 1.3.4)
       concurrent-ruby-edge (~> 0.7.1)
@@ -98,6 +98,7 @@ GEM
     interception (0.5)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
     method_source (1.1.0)
     mini_mime (1.1.5)
     multi_test (1.1.0)
@@ -147,6 +148,9 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.32.3)
       parser (>= 3.3.1.0)
+    rubocop-performance (1.23.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -154,6 +158,18 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
+    standard (1.41.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.66.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.5)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.6.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.23.0)
     sys-uname (1.3.0)
       ffi (~> 1.1)
     timers (4.3.5)
@@ -183,6 +199,7 @@ DEPENDENCIES
   rspec-retry
   rubocop
   simplecov (>= 0.21.2)
+  standard
   vcr
   webmock
 

data/VERSION

@@ -1 +1 @@
-5.3.5
+5.5.0

data/lib/pubnub/client/events.rb

@@ -4,14 +4,16 @@ module Pubnub
   class Client
     # Module that holds generator for all events
     module Events
-      EVENTS = %w[publish subscribe presence leave history here_now audit grant grant_token revoke_token delete_messages
-                  revoke time heartbeat where_now set_state state channel_registration message_counts signal
-                  add_message_action get_message_actions remove_message_action
-                  add_channels_to_push list_push_provisions remove_channels_from_push remove_device_from_push
-                  set_uuid_metadata set_channel_metadata remove_uuid_metadata remove_channel_metadata
-                  get_uuid_metadata get_all_uuid_metadata get_channel_metadata get_all_channels_metadata
-                  get_channel_members get_memberships set_channel_members set_memberships
-                  remove_memberships remove_channel_members].freeze
+      EVENTS = %w[publish subscribe presence leave history fetch_messages here_now audit grant
+                  grant_token revoke_token delete_messages revoke time heartbeat where_now
+                  set_state state channel_registration message_counts signal add_message_action
+                  get_message_actions remove_message_action add_channels_to_push
+                  list_push_provisions remove_channels_from_push remove_device_from_push
+                  set_uuid_metadata set_channel_metadata remove_uuid_metadata
+                  remove_channel_metadata get_uuid_metadata get_all_uuid_metadata
+                  get_channel_metadata get_all_channels_metadata get_channel_members
+                  get_memberships set_channel_members set_memberships remove_memberships
+                  remove_channel_members].freeze
 
       EVENTS.each do |event_name|
         define_method event_name do |options = {}, &block|