pubnub 5.2.1 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7916711ab1dff6d2e5b260b9a110954ad1d27db486b2650a532f77828a70833
-  data.tar.gz: c3c6cca9e2911670b8770ad98a90b95f8b80a2d11e1f6153f86257afee1b08ea
+  metadata.gz: 462fba219738d96faf8a4984d3f53b310ff31fbeef92425ad0899684332defcb
+  data.tar.gz: 0bafd18ad8f8e25cae5adb1ed928c05deaf0169843b52f69d157a6aa025c3bba
 SHA512:
-  metadata.gz: b16aa2090b8b9c185e48f7513549b25fc628782320d6768d52e44d6935cfa6905a4e551a0637dd78f05f9b041cf4684b2ae873e9a0b1c03bbc227039899ac8d4
-  data.tar.gz: 2d77b28da1bc846236de1216ced19168a118baf6fa14942a6c28b1b076fa69aecd6dbb28c70faedc5c4ebf01593145ac0e54ee1ee84ef79d17bae2e9c88f8f28
+  metadata.gz: 13555fb9e8a66671c1ecf1695c0574d5d3f358fb9f49231b4576129b9066e6bdbf525d3b544e7e41df16aa4636702fc09c0f938b10022282a6ae69e022f2b19a
+  data.tar.gz: 3ac98cfaa05a5394eec25e60cf83fffe6d441e7cb8bc964bd4c6ffaea29080ef05191c5a98bbee015a0f84a5ae0bc0001670feb3d6a5a26df776f62557a555b6

data/.github/CODEOWNERS

@@ -1,3 +1,3 @@
-*         @parfeon @CraigLn @kleewho @seba-aln
-.github/* @parfeon @CraigLn @kleewho @seba-aln
+*         @parfeon @MikeDobrzan @kleewho @seba-aln
+.github/* @parfeon @MikeDobrzan @kleewho @seba-aln
 README.md @techwritermat @kazydek

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

@@ -3,16 +3,31 @@ name: Commands processor
 on:
   issue_comment:
     types: [created]
+defaults:
+  run:
+    shell: bash
 
 jobs:
   process:
     name: Process command
-    if: ${{ github.event.issue.pull_request && endsWith(github.repository, '-private') != true && startsWith(github.event.comment.body, format('@{0} ', ${{ secrets.CLEN_BOT }})) }}
+    if: github.event.issue.pull_request && endsWith(github.repository, '-private') != true
     runs-on: ubuntu-latest
     steps:
+      - name: Check referred user
+        id: user-check
+        env: 
+          CLEN_BOT: ${{ secrets.CLEN_BOT }}
+        run: echo "expected-user=${{ startsWith(github.event.comment.body, format('@{0} ', env.CLEN_BOT)) }}" >> $GITHUB_OUTPUT
+      - name: Regular comment
+        if: steps.user-check.outputs.expected-user != 'true'
+        run: echo -e "\033[38;2;19;181;255mThis is regular commit which should be ignored.\033[0m"
       - name: Checkout repository
+        if: steps.user-check.outputs.expected-user == 'true'
         uses: actions/checkout@v3
+        with:
+           token: ${{ secrets.GH_TOKEN }}
       - name: Checkout release actions
+        if: steps.user-check.outputs.expected-user == 'true'
         uses: actions/checkout@v3
         with:
           repository: pubnub/client-engineering-deployment-tools
@@ -20,8 +35,9 @@ jobs:
           token: ${{ secrets.GH_TOKEN }}
           path: .github/.release/actions
       - name: Process changelog entries
+        if: steps.user-check.outputs.expected-user == 'true'
         uses: ./.github/.release/actions/actions/commands
         with:
           token: ${{ secrets.GH_TOKEN }}
           listener: ${{ secrets.CLEN_BOT }}
-          jira-api-key: ${{ secrets.JIRA_API_KEY }}
+          jira-api-key: ${{ secrets.JIRA_API_KEY }}

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

@@ -15,33 +15,33 @@ jobs:
   tests:
     name: Integration and Unit tests
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        ruby: [2.5.8, 2.6.6, 2.7.1]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
         with:
           token: ${{ secrets.GH_TOKEN }}
-      - name: Setup Ruby 2.5.8
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.5.8
-          bundler-cache: true
-      - name: Build and run tests for Ruby 2.5.8
-        run: bundle exec rspec
-      - name: Setup Ruby 2.6.6
-        uses: ruby/setup-ruby@v1
+      - name: Checkout actions
+        uses: actions/checkout@v3
         with:
-          ruby-version: 2.6.6
-          bundler-cache: true
-      - name: Build and run tests for Ruby 2.6.6
-        run: bundle exec rspec
-      - name: Setup Ruby 2.7.1
+          repository: pubnub/client-engineering-deployment-tools
+          ref: v1
+          token: ${{ secrets.GH_TOKEN }}
+          path: .github/.release/actions
+      - name: Setup Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7.1
+          ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - name: Build and run tests for Ruby 2.7.1
+      - name: Build and run tests for Ruby ${{ matrix.ruby }}
         run: bundle exec rspec
-  acceptance:
+      - name: Cancel workflow runs for commit on error
+        if: failure()
+        uses: ./.github/.release/actions/actions/utils/fast-jobs-failure
+  acceptance-tests:
     name: Acceptance tests
     runs-on: ubuntu-latest
     steps:
@@ -83,3 +83,13 @@ jobs:
             main.xml
             beta.xml
           retention-days: 7
+      - name: Cancel workflow runs for commit on error
+        if: failure()
+        uses: ./.github/.release/actions/actions/utils/fast-jobs-failure
+  all-tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    needs: [tests, acceptance-tests]
+    steps:
+      - name: Tests summary
+        run: echo -e "\033[38;2;95;215;0m\033[1mAll tests successfully passed"

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

@@ -3,7 +3,7 @@ name: Validations
 on: [push]
 
 jobs:
-  validators:
+  pubnub-yml:
     name: "Validate .pubnub.yml"
     runs-on: ubuntu-latest
     steps:
@@ -19,4 +19,14 @@ jobs:
       - name: "Run '.pubnub.yml' file validation"
         uses: ./.github/.release/actions/actions/validators/pubnub-yml
         with:
-          token: ${{ secrets.GH_TOKEN }}
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Cancel workflow runs for commit on error
+        if: failure()
+        uses: ./.github/.release/actions/actions/utils/fast-jobs-failure
+  all-validations:
+     name: Validations
+     runs-on: ubuntu-latest
+     needs: [pubnub-yml]
+     steps:
+       - name: Validations summary
+         run: echo -e "\033[38;2;95;215;0m\033[1mAll validations passed"

data/.pubnub.yml

@@ -1,6 +1,18 @@
 ---
-version: "5.2.1"
+version: "5.3.0"
 changelog:
+  - date: 2023-10-16
+    version: v5.3.0
+    changes:
+      - type: feature
+        text: "Add crypto module that allows to configure SDK to encrypt and decrypt messages."
+      - type: bug
+        text: "Improved security of crypto implementation by adding enhanced AES-CBC cryptor."
+  - date: 2023-03-14
+    version: v5.2.2
+    changes:
+      - type: bug
+        text: "Fix issue which raised an exception when PubNub client has been configured with a secret key."
   - date: 2022-12-13
     version: v5.2.1
     changes:
@@ -451,6 +463,10 @@ features:
     - CHANNEL-GROUPS-REMOVE-CHANNELS
     - CHANNEL-GROUPS-REMOVE-GROUPS
     - CHANNEL-GROUPS-LIST-CHANNELS-IN-GROUP
+  message-actions:
+    - MESSAGE-ACTIONS-GET
+    - MESSAGE-ACTIONS-ADD
+    - MESSAGE-ACTIONS-REMOVE
   notify:
     - REQUEST-MESSAGE-COUNT-EXCEEDED
   presence:
@@ -654,7 +670,7 @@ sdks:
                     - x86-64
           - distribution-type: package
             distribution-repository: RubyGems
-            package-name: pubnub-5.2.1.gem
+            package-name: pubnub-5.3.0.gem
             location: https://rubygems.org/gems/pubnub
             requires:
               - name: addressable
@@ -759,8 +775,8 @@ sdks:
                     - x86-64
           - distribution-type: library
             distribution-repository: GitHub release
-            package-name: pubnub-5.2.1.gem
-            location: https://github.com/pubnub/ruby/releases/download/v5.2.1/pubnub-5.2.1.gem
+            package-name: pubnub-5.3.0.gem
+            location: https://github.com/pubnub/ruby/releases/download/v5.3.0/pubnub-5.3.0.gem
             requires:
               - name: addressable
                 min-version: 2.0.0

data/.tool-versions

@@ -1 +1 @@
-ruby jruby-9.3.8.0
+ruby 3.2.2

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 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
 

data/Gemfile

@@ -17,7 +17,7 @@ end
 
 group :development, :test do
   gem 'awesome_print'
-  gem 'pry'
+  gem 'pry', '>= 0.14.2'
   gem 'pry-rescue'
   gem 'pry-stack_explorer'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pubnub (5.2.1)
+    pubnub (5.3.0)
       addressable (>= 2.0.0)
       concurrent-ruby (~> 1.1.5)
       concurrent-ruby-edge (~> 0.5.0)
@@ -100,8 +100,8 @@ GEM
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
       dry-schema (~> 1.5)
-    ffi (1.13.1)
-    ffi (1.13.1-java)
+    ffi (1.16.2)
+    ffi (1.16.2-java)
     hashdiff (1.0.1)
     httpclient (2.8.3)
     interception (0.5)
@@ -115,10 +115,10 @@ GEM
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry (0.13.1-java)
+    pry (0.14.2-java)
       coderay (~> 1.1)
       method_source (~> 1.0)
       spoon (~> 0.0)
@@ -187,7 +187,7 @@ DEPENDENCIES
   awesome_print
   codacy-coverage
   cucumber
-  pry
+  pry (>= 0.14.2)
   pry-rescue
   pry-stack_explorer
   pubnub!

data/LICENSE

@@ -0,0 +1,29 @@
+PubNub Software Development Kit License Agreement
+Copyright © 2023 PubNub Inc. All rights reserved.
+
+Subject to the terms and conditions of the license, you are hereby granted
+a non-exclusive, worldwide, royalty-free license to (a) copy and modify
+the software in source code or binary form for use with the software services
+and interfaces provided by PubNub, and (b) redistribute unmodified copies
+of the software to third parties. The software may not be incorporated in
+or used to provide any product or service competitive with the products
+and services of PubNub.
+
+The above copyright notice and this license shall be included
+in or with all copies or substantial portions of the software.
+
+This license does not grant you permission to use the trade names, trademarks,
+service marks, or product names of PubNub, except as required for reasonable
+and customary use in describing the origin of the software and reproducing
+the content of this license.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL PUBNUB OR THE AUTHORS OR COPYRIGHT HOLDERS OF THE SOFTWARE BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+https://www.pubnub.com/
+https://www.pubnub.com/terms

data/README.md

@@ -39,7 +39,7 @@ You will need the publish and subscribe keys to authenticate your app. Get your
 ```ruby
 callback = Pubnub::SubscribeCallback.new(
     message: ->(envelope) {
-        puts "MESSAGE: # {puts envelope.result[:data][:message]['msg']}"
+        puts "MESSAGE: #{puts envelope.result[:data][:message]['msg']}"
     },
     presence: ->(envelope) {
         puts "PRESENCE: #{envelope.result[:data]}"

data/VERSION

@@ -1 +1 @@
-5.2.1
+5.3.0

data/features/step_definitions/access_steps.rb

@@ -254,5 +254,3 @@ end
 Then('the error detail message is not empty') do
   expect(parse_error_body(@global_state[:last_call_res])["error"]["message"].empty?).to eq false
 end
-
-

data/features/step_definitions/crypto_steps.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+#
+require 'pubnub'
+
+Given(/^Crypto module with '([^']*)' cryptor$/) do |cryptor_id|
+  @cryptor_ids = [cryptor_id]
+end
+
+Given(/^Crypto module with default '([^']*)' and additional '([^']*)' cryptors$/) do |cryptor_id1, cryptor_id2|
+  @cryptor_ids = [cryptor_id1, cryptor_id2]
+end
+
+Given(/^Legacy code with '([^']*)' cipher key and '(random|constant|-)' vector$/) do |cipher_key, use_random_iv|
+  use_random_iv = use_random_iv != 'constant'
+  @legacy_cryptor = Cryptor.new cipher_key, use_random_iv
+end
+
+Then(/^with '([^']*)' cipher key$/) do |cipher_key|
+  @cipher_key = cipher_key
+end
+
+Then(/^with '(random|constant|-)' vector$/) do |use_random_iv|
+  @use_random_iv = use_random_iv != 'constant'
+end
+
+When(/^I encrypt '([^']*)' file as '([^']*)'$/) do |file_name, _|
+  @source_file_name = file_name
+  @source_file_content = File.binread "sdk-specifications/features/encryption/assets/#{file_name}"
+  @encrypted_content = crypto_module.encrypt @source_file_content
+  if file_name.include? 'empty'
+    @encrypt_status = 'encryption error' if @encrypted_content.nil? && @encrypt_status.nil?
+    @encrypt_status = 'success' if !@encrypted_content.nil? && @encrypt_status.nil?
+  else
+    expect(@encrypted_content).not_to eq nil
+  end
+end
+
+When(/^I decrypt '([^']*)' file$/) do |file_name|
+  file_content = File.binread "sdk-specifications/features/encryption/assets/#{file_name}"
+
+  begin
+    @decrypted_content = crypto_module.decrypt file_content
+  rescue Pubnub::UnknownCryptorError
+    @decrypt_status = 'unknown cryptor error'
+  end
+  @decrypt_status = 'decryption error' if @decrypted_content.nil? && @decrypt_status.nil?
+  @decrypt_status = 'success' if !@decrypted_content.nil? && @decrypt_status.nil?
+end
+
+When(/^I decrypt '([^']*)' file as '([^']*)'$/) do |file_name, _|
+  file_content = File.binread "sdk-specifications/features/encryption/assets/#{file_name}"
+
+  begin
+    @decrypted_content = crypto_module.decrypt file_content
+  rescue Pubnub::UnknownCryptorError
+    @decrypt_status = 'unknown cryptor error'
+  end
+  @decrypt_status = 'decryption error' if @decrypted_content.nil? && @decrypt_status.nil?
+  @decrypt_status = 'success' if !@decrypted_content.nil? && @decrypt_status.nil?
+end
+
+Then(/^Decrypted file content equal to the '([^']*)' file content$/) do |file_name|
+  file_content = File.binread "sdk-specifications/features/encryption/assets/#{file_name}"
+  expect(@decrypted_content).not_to eq nil
+  expect(@decrypted_content).to eq file_content
+end
+
+Then('Successfully decrypt an encrypted file with legacy code') do
+  expect(@legacy_cryptor).not_to eq nil
+  base64_encoded = Base64.strict_encode64(@encrypted_content)
+  decrypted_content = @legacy_cryptor.decrypt(base64_encoded)
+  expect(decrypted_content).not_to eq nil
+  expect(decrypted_content).to eq @source_file_content
+end
+
+Then(/^I receive '([^']*)'$/) do |outcome|
+  expect(@encrypt_status || @decrypt_status).not_to eq nil
+  expect(@encrypt_status || @decrypt_status).to eq outcome
+end
+
+# Crypto module
+#
+# @return [Pubnub::Crypto::CryptoModule] Crypto module instance.
+def crypto_module
+  cryptors = []
+  @cryptor_ids.each do |cryptor_id|
+    cryptor = if cryptor_id == 'acrh'
+                Pubnub::Crypto::AesCbcCryptor.new @cipher_key
+              elsif cryptor_id == 'legacy'
+                Pubnub::Crypto::LegacyCryptor.new @cipher_key, @use_random_iv
+              end
+    cryptors.push(cryptor) unless cryptor.nil?
+  end
+
+  raise ArgumentError, "No crypto identifiers specified: #{@cryptor_ids}" if cryptors.empty?
+
+  default_cryptor = cryptors.shift
+  Pubnub::Crypto::CryptoModule.new default_cryptor, cryptors unless default_cryptor.nil?
+end

data/features/support/cryptor.rb

@@ -0,0 +1,58 @@
+# Internal Crypto class used for message encryption and decryption
+class Cryptor
+  def initialize(cipher_key, use_random_iv)
+    @alg = 'AES-256-CBC'
+    sha256_key = Digest::SHA256.hexdigest(cipher_key.to_s)
+    @key = sha256_key.slice(0, 32)
+    @using_random_iv = use_random_iv
+    @iv = @using_random_iv == true ? random_iv : '0123456789012345'
+  end
+
+  def encrypt(message)
+    aes = OpenSSL::Cipher.new(@alg)
+    aes.encrypt
+    aes.key = @key
+    aes.iv = @iv
+
+    json_message = message.to_json
+    cipher = @using_random_iv == true ? @iv : ''
+    cipher << aes.update(json_message)
+    cipher << aes.final
+
+    Base64.strict_encode64(cipher)
+  end
+
+  def decrypt(cipher_text)
+    undecoded_text = Base64.decode64(cipher_text)
+    iv = @iv
+
+    if cipher_text.length > 16 && @using_random_iv == true
+      iv = undecoded_text.slice!(0..15)
+    end
+
+    decode_cipher = OpenSSL::Cipher.new(@alg).decrypt
+    decode_cipher.key = @key
+    decode_cipher.iv = iv
+
+    plain_text = decryption(undecoded_text, decode_cipher)
+
+    plain_text
+  end
+
+  private
+
+  def decryption(cipher_text, decode_cipher)
+    plain_text = decode_cipher.update(cipher_text)
+    plain_text << decode_cipher.final
+  rescue StandardError => e
+    puts "Pubnub :: DECRYPTION ERROR: #{e}"
+    '"DECRYPTION ERROR"'
+  end
+
+  private
+
+  def random_iv
+    random_bytes = Random.new.bytes(16).unpack('NnnnnN')
+    format('%08x%04x%04x', *random_bytes)
+  end
+end

data/features/support/hooks.rb

@@ -8,7 +8,6 @@ Before do |scenario|
   @pn_configuration = {}
 
   when_mock_server_used {
-    puts "Using mock"
     expect(ENV['SERVER_HOST']).not_to be_nil
     expect(ENV['SERVER_PORT']).not_to be_nil
     @pn_configuration = {

data/lib/pubnub/client.rb

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 require 'base64'
 
 require 'pubnub/error'
 require 'pubnub/uuid'
 require 'pubnub/formatter'
-require 'pubnub/crypto'
 require 'pubnub/constants'
 require 'pubnub/configuration'
 require 'pubnub/subscribe_callback'
 
+require 'pubnub/modules/crypto/module'
+
 require 'pubnub/schemas/envelope_schema'
 
 require 'pubnub/event'
@@ -183,6 +186,7 @@ module Pubnub
       clean_env
       prepare_env
       validate! @env
+      setup_crypto_module
       @telemetry = Telemetry.new
       Pubnub.logger.debug('Pubnub::Client') do
         "Created new Pubnub::Client instance. Version: #{Pubnub::VERSION}"
@@ -339,6 +343,14 @@ module Pubnub
       @env[:token] = token
     end
 
+    # Data processing crypto module.
+    #
+    # @return [Pubnub::Crypto::CryptoProvider, nil] Crypto module for data encryption and
+    #   decryption.
+    def crypto_module
+      @env[:crypto_module]
+    end
+
     private
 
     def create_state_pools(event)
@@ -386,9 +398,26 @@ module Pubnub
       Concurrent.global_logger = Pubnub.logger
       @subscriber = Subscriber.new(self)
       options[:user_id] = options[:uuid] if options[:user_id].nil?
+
+      if options[:cipher_key] && options[:crypto_module]
+        puts 'It is expected that only cipherKey or cryptoModule will be configured ' \
+               'at once. PubNub client will use the configured cryptoModule.'
+      end
+
       @env = options
     end
 
+    # Complete crypto module configuration
+    # Create crypto module if it is required by user (specified
+    # <i>cipher_key</i> and not <i>crypto_module</i>).
+    def setup_crypto_module
+      random_iv = @env[:random_iv]
+      key = @env[:cipher_key]
+
+      # Create crypto module if it is not specified
+      @env[:crypto_module] = Crypto::CryptoModule.new_legacy(key, random_iv) if key && @env[:crypto_module].nil?
+    end
+
     def prepare_env
       assign_defaults
       setup_pools

data/lib/pubnub/error.rb

@@ -51,4 +51,7 @@ module Pubnub
 
   class ResponseError < Error
   end
+
+  class UnknownCryptorError < Error
+  end
 end

data/lib/pubnub/event.rb

@@ -113,12 +113,12 @@ module Pubnub
     def operation_http_method
       case @event
       when Pubnub::Constants::OPERATION_DELETE, Pubnub::Constants::OPERATION_REMOVE_MESSAGE_ACTION,
-           Pubnub::Constants::OPERATION_REMOVE_CHANNEL_METADATA, Pubnub::Constants::OPERATION_REMOVE_UUID_METADATA,
-           Pubnub::Constants::OPERATION_REVOKE_TOKEN
+        Pubnub::Constants::OPERATION_REMOVE_CHANNEL_METADATA, Pubnub::Constants::OPERATION_REMOVE_UUID_METADATA,
+        Pubnub::Constants::OPERATION_REVOKE_TOKEN
         'delete'
       when Pubnub::Constants::OPERATION_SET_UUID_METADATA, Pubnub::Constants::OPERATION_SET_CHANNEL_METADATA,
-           Pubnub::Constants::OPERATION_SET_CHANNEL_MEMBERS, Pubnub::Constants::OPERATION_SET_MEMBERSHIPS,
-           Pubnub::Constants::OPERATION_REMOVE_CHANNEL_MEMBERS, Pubnub::Constants::OPERATION_REMOVE_MEMBERSHIPS
+        Pubnub::Constants::OPERATION_SET_CHANNEL_MEMBERS, Pubnub::Constants::OPERATION_SET_MEMBERSHIPS,
+        Pubnub::Constants::OPERATION_REMOVE_CHANNEL_MEMBERS, Pubnub::Constants::OPERATION_REMOVE_MEMBERSHIPS
         'patch'
       when Pubnub::Constants::OPERATION_ADD_MESSAGE_ACTION
         'post'
@@ -170,7 +170,7 @@ module Pubnub
 
     def create_variables_from_options(options)
       variables = %w[channel channels message http_sync callback
-                     ssl cipher_key random_iv secret_key auth_key
+                     ssl cipher_key random_iv crypto_module secret_key auth_key
                      publish_key subscribe_key timetoken action_timetoken message_timetoken
                      open_timeout read_timeout idle_timeout heartbeat
                      group action read write delete manage ttl presence start
@@ -217,6 +217,14 @@ module Pubnub
       ck.call(data)
     end
 
+    # Data processing crypto module.
+    #
+    # @return [Pubnub::Crypto::CryptoProvider, nil] Crypto module for data encryption and
+    #   decryption.
+    def crypto_module
+      @crypto_module
+    end
+
     def error_message(parsed_response)
       parsed_response['message']
     rescue StandardError

data/lib/pubnub/events/add_message_action.rb

@@ -13,8 +13,8 @@ module Pubnub
 
     def fire
       Pubnub.logger.debug('Pubnub::Add Message Action') { "Fired event #{self.class}" }
-      type_payload = { type: @type, value: @value}
-      body = Formatter.format_message(type_payload, '', false, false)
+      type_payload = { type: @type, value: @value }
+      body = Formatter.format_message(type_payload, nil, false)
 
       response = send_request(body, { "Content-Type": 'application/json' })
 

data/lib/pubnub/events/get_message_actions.rb

@@ -13,7 +13,7 @@ module Pubnub
 
     private
 
-    def parameters
+    def parameters(*_args)
       parameters = super
       parameters['start'] = @start unless @start.nil?
       parameters['end'] = @end unless @end.nil?

data/lib/pubnub/events/grant_token.rb

@@ -34,7 +34,7 @@ module Pubnub
           patterns: prepare_permissions(:pattern, @channels, @channel_groups, @uuids, @spaces_permissions, @users_permissions)
         }.select { |_, v| v }
       }
-      body = Formatter.format_message(raw_body, "", false, false)
+      body = Formatter.format_message(raw_body, nil, false)
       response = send_request(body, { "Content-Type": "application/json" })
 
       envelopes = fire_callbacks(handle(response, uri))