pubnub 5.1.2 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02ec93862ae59cbf3c741a3cf1b8a52424d091bd004f12c6430a733ff025b759
-  data.tar.gz: 320a4002c58c092b7b62d618841e54b3b718c8efe627f2fa7c551e123aca74ab
+  metadata.gz: 54a4586bf266ad9fd5d51168e215ac8dcf0f31a765ac15129314e184d4ae6a97
+  data.tar.gz: e814f4fee3cecaf6ba20c2ad0f349af4b5eabf7507261fcadd986339624a8bdc
 SHA512:
-  metadata.gz: a08577ad50fcd03b44fadd091d621aab6667ae76bc27574582afbd8b445a554e6ea1056e30646af88c1ccfd7cd1561d4de88639333f5f40ef63e35bcde205116
-  data.tar.gz: c0aec4363fef5e2056d5c3e4d530d5d1453cafd6a1fe9c08723c6c6cdcafed7f431519e1dbe8791ce23d1bff56486a9390d707f8c9908920f5fce14770b53004
+  metadata.gz: 71223b6e8268f6a126e780f55ce1b57488e73d86b0185fe283b9665cde7aa470b3a9168fddd99b7090f3f5a1ff04ac5b49fd1ef12cb0b14c06b76f24828375a9
+  data.tar.gz: 5133e307589a55f0b352a016b3301cfff3c946fb0e750c391ceca648e2551bb7f970b321be8365a26d3f2bbff5771de2dc6ec1665a2ce84dfb65b13fd20ed4da

data/.github/workflows/release.yml

@@ -56,3 +56,8 @@ jobs:
           token: ${{ secrets.GH_TOKEN }}
           jira-api-key: ${{ secrets.JIRA_API_KEY }}
           last-service: true
+      - name: Upload test reports
+        uses: ./.github/.release/actions/actions/test-reports/upload
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+          acceptance-tests-workflow: Tests

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

@@ -0,0 +1,84 @@
+name: Tests
+
+on:
+  push:
+  workflow_dispatch:
+
+
+jobs:
+  tests:
+    name: Integration and Unit tests
+    runs-on: ubuntu-latest
+    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
+        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
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.1
+          bundler-cache: true
+      - name: Build and run tests for Ruby 2.7.1
+        run: bundle exec rspec
+      - name: Setup JRuby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: jruby
+          bundler-cache: true
+  acceptance:
+    name: Acceptance tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+      - name: Checkout mock-server action
+        uses: actions/checkout@v3
+        with:
+          repository: pubnub/client-engineering-deployment-tools
+          ref: v1
+          token: ${{ secrets.GH_TOKEN }}
+          path: .github/.release/actions
+      - name: Run mock server action
+        uses: ./.github/.release/actions/actions/mock-server
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Setup Ruby 3.0
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+      - 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
+      - name: Run acceptance tests (required)
+        run: bundle exec cucumber sdk-specifications/features/ -p mock -p run_main -p report_main -f pretty
+      - name: Combine test results
+        if: always()
+        run: |
+          sudo npm install -g junit-report-merger &&
+          jrm ./main.xml "./main/**/*.xml" &&
+          jrm ./beta.xml "./beta/**/*.xml"
+      - name: Expose acceptance tests reports
+        uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: acceptance-test-reports
+          path: |
+            main.xml
+            beta.xml
+          retention-days: 7

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

@@ -0,0 +1,22 @@
+name: Validations
+
+on: [push]
+
+jobs:
+  validators:
+    name: "Validate .pubnub.yml"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+      - name: Checkout validator action
+        uses: actions/checkout@v3
+        with:
+          repository: pubnub/client-engineering-deployment-tools
+          ref: v1
+          token: ${{ secrets.GH_TOKEN }}
+          path: .github/.release/actions
+      - name: "Run '.pubnub.yml' file validation"
+        uses: ./.github/.release/actions/actions/validators/pubnub-yml
+        with:
+          token: ${{ secrets.GH_TOKEN }}

data/.pubnub.yml

@@ -1,6 +1,13 @@
 ---
-version: "5.1.2"
+version: "5.2.0"
 changelog:
+  - date: 2022-12-12
+    version: v5.2.0
+    changes:
+      - type: feature
+        text: "Add api which allow to work with message actions endpoints."
+      - type: improvement
+        text: "Migrate test suite run from Travis to GitHub Actions."
   - date: 2022-11-23
     version: v5.1.2
     changes:
@@ -642,7 +649,7 @@ sdks:
                     - x86-64
           - distribution-type: package
             distribution-repository: RubyGems
-            package-name: pubnub-5.1.2.gem
+            package-name: pubnub-5.2.0.gem
             location: https://rubygems.org/gems/pubnub
             requires:
               - name: addressable
@@ -747,8 +754,8 @@ sdks:
                     - x86-64
           - distribution-type: library
             distribution-repository: GitHub release
-            package-name: pubnub-5.1.2.gem
-            location: https://github.com/pubnub/ruby/releases/download/v5.1.2/pubnub-5.1.2.gem
+            package-name: pubnub-5.2.0.gem
+            location: https://github.com/pubnub/ruby/releases/download/v5.2.0/pubnub-5.2.0.gem
             requires:
               - name: addressable
                 min-version: 2.0.0

data/.tool-versions

@@ -1 +1 @@
-ruby 3.0.0
+ruby jruby-9.3.8.0

data/CHANGELOG.md

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

data/Gemfile.lock

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

data/VERSION

@@ -1 +1 @@
-5.1.2
+5.2.0

data/lib/pubnub/client/events.rb

@@ -6,6 +6,7 @@ module Pubnub
     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

data/lib/pubnub/client.rb

@@ -31,6 +31,9 @@ require 'pubnub/client/paged_history'
 require 'pubnub/client/helpers'
 require 'pubnub/client/getters_setters'
 
+require 'pubnub/validators/get_message_actions'
+require 'pubnub/validators/add_message_action'
+require 'pubnub/validators/remove_message_action'
 require 'pubnub/validators/common_validator'
 require 'pubnub/validators/client'
 require 'pubnub/validators/audit'

data/lib/pubnub/constants.rb

@@ -61,6 +61,9 @@ module Pubnub
     OPERATION_REVOKE_TOKEN = :revoke_token
     OPERATION_REVOKE = :revoke
     OPERATION_DELETE = :delete
+    OPERATION_ADD_MESSAGE_ACTION = :add_message_action
+    OPERATION_REMOVE_MESSAGE_ACTION = :remove_message_action
+    OPERATION_GET_MESSAGE_ACTIONS = :get_message_actions
     OPERATION_LIST_ALL_CHANNEL_GROUPS = :list_all_channel_groups
     OPERATION_LIST_ALL_CHANNELS_IN_CHANNEL_GROUP = :list_all_channels_in_channel_group
     OPERATION_MESSAGE_COUNTS = :message_counts
@@ -86,7 +89,8 @@ module Pubnub
 
     OPERATIONS = [
       OPERATION_SUBSCRIBE, OPERATION_HEARTBEAT, OPERATION_PRESENCE, OPERATION_TIME, OPERATION_HISTORY,
-      OPERATION_HERE_NOW, OPERATION_GLOBAL_HERE_NOW, OPERATION_GET_STATE, OPERATION_LIST_ALL_CHANNEL_GROUPS,
+      OPERATION_HERE_NOW, OPERATION_GLOBAL_HERE_NOW, OPERATION_GET_STATE, OPERATION_ADD_MESSAGE_ACTION,
+      OPERATION_REMOVE_MESSAGE_ACTION, OPERATION_GET_MESSAGE_ACTIONS, OPERATION_LIST_ALL_CHANNEL_GROUPS,
       OPERATION_LIST_ALL_CHANNELS_IN_CHANNEL_GROUP, OPERATION_CHANNEL_GROUP_ADD, OPERATION_CHANNEL_GROUP_REMOVE,
       OPERATION_AUDIT, OPERATION_GRANT, OPERATION_GRANT_TOKEN, OPERATION_REVOKE, OPERATION_WHERE_NOW,
       OPERATION_MESSAGE_COUNTS, OPERATION_ADD_CHANNELS_TO_PUSH, OPERATION_LIST_PUSH_PROVISIONS,

data/lib/pubnub/event.rb

@@ -53,11 +53,11 @@ module Pubnub
 
       telemetry_time_start = ::Time.now.to_f
       response = case operation_http_method
-                 when "get"
+                 when 'get'
                    sender.get(uri.to_s, header: header)
-                 when "post"
+                 when 'post'
                    sender.post(uri.to_s, body: compressed_body, header: header)
-                 when "patch"
+                 when 'patch'
                    sender.patch(uri.to_s, body: compressed_body, header: header)
                  else
                    sender.delete(uri.to_s, header: header)
@@ -112,18 +112,21 @@ module Pubnub
 
     def operation_http_method
       case @event
-      when Pubnub::Constants::OPERATION_DELETE, Pubnub::Constants::OPERATION_REMOVE_CHANNEL_METADATA,
-           Pubnub::Constants::OPERATION_REMOVE_UUID_METADATA, Pubnub::Constants::OPERATION_REVOKE_TOKEN
-        "delete"
+      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
+        '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
-        "patch"
+        'patch'
+      when Pubnub::Constants::OPERATION_ADD_MESSAGE_ACTION
+        'post'
       else
         if @compressed_body.nil? || @compressed_body.empty?
-          "get"
+          'get'
         else
-          "post"
+          'post'
         end
       end
     end
@@ -168,14 +171,14 @@ 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
-                     publish_key subscribe_key timetoken
+                     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
                      end count limit reverse presence_callback store skip_validate
                      state channel_group channel_groups compressed meta customs include_token
                      replicate with_presence cipher_key_selector include_meta join update get
                      add remove push_token push_gateway environment topic authorized_uuid
-                     authorized_user_id token
+                     authorized_user_id token type value
                    ]
 
       options = options.each_with_object({}) { |option, obj| obj[option.first.to_sym] = option.last }
@@ -229,7 +232,8 @@ module Pubnub
       }
     end
 
-    def error_envelope(_parsed_response, error, req_res_objects)
+    def error_envelope(parsed_response, error, req_res_objects)
+      error_information = nil
       case error
       when JSON::ParserError
         error_category = Pubnub::Constants::STATUS_NON_JSON_RESPONSE
@@ -243,6 +247,12 @@ module Pubnub
       else
         error_category = Pubnub::Constants::STATUS_ERROR
         code = req_res_objects[:response].code
+        # Trying to receive useful information about error.
+        unless parsed_response.nil?
+          error_msg, error_details = error_details_from_response parsed_response
+          error_information = { message: error_msg, details: error_details } unless error_msg.nil?
+        end
+
       end
 
       Pubnub::ErrorEnvelope.new(
@@ -254,7 +264,7 @@ module Pubnub
           operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
-          data: nil,
+          data: error_information,
           category: error_category,
           error: true,
           auto_retried: false,
@@ -263,5 +273,19 @@ module Pubnub
         }
       )
     end
+
+    def error_details_from_response(parsed_response)
+      return [nil, nil] if parsed_response.nil?
+
+      error_msg = parsed_response.include?('message') ? parsed_response['message'] : nil
+      error_details = nil
+
+      if parsed_response.include?('error') && parsed_response['error'].is_a?(Hash)
+        error_msg = parsed_response['error']['message'] if parsed_response['error'].include? 'message'
+        error_details = parsed_response['error']['details'] if parsed_response['error'].include? 'details'
+      end
+
+      [error_msg, error_details]
+    end
   end
 end

data/lib/pubnub/events/add_message_action.rb

@@ -0,0 +1,86 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Holds add message action functionality
+  class AddMessageAction < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::AddMessageAction
+
+    def initialize(options, app)
+      @event = current_operation
+      @telemetry_name = :l_msga
+      super
+    end
+
+    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)
+
+      response = send_request(body, { "Content-Type": 'application/json' })
+
+      envelopes = fire_callbacks(handle(response, uri))
+      finalize_event(envelopes)
+      envelopes
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_ADD_MESSAGE_ACTION
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'message-actions',
+        @subscribe_key,
+        'channel',
+        Formatter.channels_for_url(@channel),
+        'message',
+        @message_timetoken,
+      ].join('/')
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      data = parsed_response['data']
+
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+
+        result: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: {
+            type: data['type'],
+            value: data['value'],
+            uuid: data['uuid'],
+            action_timetoken: data['actionTimetoken'].to_i,
+            message_timetoken: data['messageTimetoken'].to_i
+          }
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          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_message_actions.rb

@@ -0,0 +1,78 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Holds get message actions functionality
+  class GetMessageActions < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::GetMessageActions
+
+    def initialize(options, app)
+      @event = current_operation
+      @telemetry_name = :l_msga
+      super
+    end
+
+    private
+
+    def parameters
+      parameters = super
+      parameters['start'] = @start unless @start.nil?
+      parameters['end'] = @end unless @end.nil?
+      parameters['limit'] = @limit unless @limit.nil?
+      parameters
+    end
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GET_MESSAGE_ACTIONS
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'message-actions',
+        @subscribe_key,
+        'channel',
+        Formatter.channels_for_url(@channel)
+      ].join('/')
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      actions = parsed_response['data'].map do |v|
+        v['message_timetoken'] = v['messageTimetoken'].to_i
+        v['action_timetoken'] = v['actionTimetoken'].to_i
+        v.delete_if { |key| %w[messageTimetoken actionTimetoken].include? key }
+      end
+
+      Pubnub::Envelope.new(
+        event: @event,
+        event_options: @given_options,
+        timetoken: nil,
+
+        result: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: actions
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          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/remove_message_actions.rb

@@ -0,0 +1,68 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Holds get message actions functionality
+  class RemoveMessageAction < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::RemoveMessageAction
+
+    def initialize(options, app)
+      @event = current_operation
+      @telemetry_name = :l_msga
+      super
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_REMOVE_MESSAGE_ACTION
+    end
+
+    def path
+      '/' + [
+        'v1',
+        'message-actions',
+        @subscribe_key,
+        'channel',
+        Formatter.channels_for_url(@channel),
+        'message',
+        @message_timetoken,
+        'action',
+        @action_timetoken
+      ].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: current_operation,
+          client_request: req_res_objects[:request],
+          server_response: req_res_objects[:response],
+          data: parsed_response['data']
+        },
+
+        status: {
+          code: req_res_objects[:response].code,
+          operation: current_operation,
+          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/schemas/envelope_schema.rb

@@ -69,7 +69,7 @@ module Pubnub
           required(:client_request).filled
           required(:server_response).filled
 
-          optional(:data).maybe(:hash?)
+          optional(:data)
         end
 
         rule(:operation, :data) do

data/lib/pubnub/validators/add_message_action.rb

@@ -0,0 +1,51 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for AddMessageAction event
+    module AddMessageAction
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_channel!
+        validate_type!
+        validate_value!
+        validate_timetoken!
+      end
+
+      private
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+
+        raise ArgumentError, { message: ':channel is required for AddMessageAction event.' }
+      end
+
+      def validate_type!
+        if @type.is_a? String
+          raise ArgumentError, {message:':type is required for AddMessageAction event.'} if @type.empty?
+        else
+          raise ArgumentError, {message:':type should be String.'}
+        end
+        raise ArgumentError, {message:':type should be not longer than 15 characters.'} unless @type.length <= 15
+      end
+
+      def validate_value!
+        if @value.is_a? String
+          raise ArgumentError, {message:':value is required for AddMessageAction event.'} if @type.empty?
+        else
+          raise ArgumentError, {message:':value should be String.'}
+        end
+        raise ArgumentError, {message:':value should be String.'} unless @value.is_a? String
+      end
+
+      def validate_timetoken!
+        raise ArgumentError, {message:':message_timetoken is required for AddMessageAction event.'} if @message_timetoken.nil?
+        raise ArgumentError, {message:':message_timetoken should be Numeric.'} unless @message_timetoken.is_a? Numeric
+        raise ArgumentError, {message:':message_timetoken should be PubNub timetoken larger than 0.'} unless @message_timetoken.positive?
+      end
+    end
+  end
+end

data/lib/pubnub/validators/get_message_actions.rb

@@ -0,0 +1,24 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for     module GetMessageActions event
+    module GetMessageActions
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_channel!
+      end
+
+      private
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+
+        raise ArgumentError, { message: ':channel is required for GetMessageAction event.' }
+      end
+    end
+  end
+end

data/lib/pubnub/validators/remove_message_action.rb

@@ -0,0 +1,35 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for RemoveMessageAction event
+    module RemoveMessageAction
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_channel!
+        validate_timetokens!
+      end
+
+      private
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+
+        raise ArgumentError, { message: ':channel is required for RemoveMessageAction event.' }
+      end
+
+      def validate_timetokens!
+        raise ArgumentError, {message:':message_timetoken is required for RemoveMessageAction event.'} if @message_timetoken.nil?
+        raise ArgumentError, {message:':message_timetoken should be Numeric.'} unless @message_timetoken.is_a? Numeric
+        raise ArgumentError, {message:':message_timetoken should be PubNub timetoken larger than 0.'} unless @message_timetoken.positive?
+
+        raise ArgumentError, {message:':action_timetoken is required for RemoveMessageAction event.'} if @action_timetoken.nil?
+        raise ArgumentError, {message:':action_timetoken should be Numeric.'} unless @action_timetoken.is_a? Numeric
+        raise ArgumentError, {message:':action_timetoken should be PubNub timetoken larger than 0.'} unless @action_timetoken.positive?
+      end
+    end
+  end
+end

data/lib/pubnub/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 5.2.0
 platform: ruby
 authors:
 - PubNub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-23 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -133,14 +133,12 @@ files:
 - ".github/workflows/commands-handler.yml"
 - ".github/workflows/release.yml"
 - ".github/workflows/release/versions.json"
-- ".github/workflows/run_acceptance_tests.yml"
-- ".github/workflows/validate-pubnub-yml.yml"
-- ".github/workflows/validate-yml.js"
+- ".github/workflows/run-tests.yml"
+- ".github/workflows/run-validations.yml"
 - ".gitignore"
 - ".pubnub.yml"
 - ".rubocop.yml"
 - ".tool-versions"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -181,6 +179,7 @@ files:
 - lib/pubnub/event/formatter.rb
 - lib/pubnub/event/signature.rb
 - lib/pubnub/events/add_channels_to_push.rb
+- lib/pubnub/events/add_message_action.rb
 - lib/pubnub/events/audit.rb
 - lib/pubnub/events/channel_registration.rb
 - lib/pubnub/events/delete_messages.rb
@@ -189,6 +188,7 @@ files:
 - lib/pubnub/events/get_channel_members.rb
 - lib/pubnub/events/get_channel_metadata.rb
 - lib/pubnub/events/get_memberships.rb
+- lib/pubnub/events/get_message_actions.rb
 - lib/pubnub/events/get_uuid_metadata.rb
 - lib/pubnub/events/grant.rb
 - lib/pubnub/events/grant_token.rb
@@ -205,6 +205,7 @@ files:
 - lib/pubnub/events/remove_channels_from_push.rb
 - lib/pubnub/events/remove_device_from_push.rb
 - lib/pubnub/events/remove_memberships.rb
+- lib/pubnub/events/remove_message_actions.rb
 - lib/pubnub/events/remove_uuid_metadata.rb
 - lib/pubnub/events/revoke.rb
 - lib/pubnub/events/revoke_token.rb
@@ -236,6 +237,7 @@ files:
 - lib/pubnub/telemetry.rb
 - lib/pubnub/uuid.rb
 - lib/pubnub/validators/add_channels_to_push.rb
+- lib/pubnub/validators/add_message_action.rb
 - lib/pubnub/validators/audit.rb
 - lib/pubnub/validators/channel_registration.rb
 - lib/pubnub/validators/client.rb
@@ -246,6 +248,7 @@ files:
 - lib/pubnub/validators/get_channel_members.rb
 - lib/pubnub/validators/get_channel_metadata.rb
 - lib/pubnub/validators/get_memberships.rb
+- lib/pubnub/validators/get_message_actions.rb
 - lib/pubnub/validators/get_uuid_metadata.rb
 - lib/pubnub/validators/grant.rb
 - lib/pubnub/validators/grant_token.rb
@@ -262,6 +265,7 @@ files:
 - lib/pubnub/validators/remove_channels_from_push.rb
 - lib/pubnub/validators/remove_device_from_push.rb
 - lib/pubnub/validators/remove_memberships.rb
+- lib/pubnub/validators/remove_message_action.rb
 - lib/pubnub/validators/remove_uuid_metadata.rb
 - lib/pubnub/validators/revoke.rb
 - lib/pubnub/validators/revoke_token.rb

data/.github/workflows/run_acceptance_tests.yml

@@ -1,46 +0,0 @@
-name: run_acceptance_tests
-
-on: [push]
-
-jobs:
-  build:
-    name: Perform Acceptance BDD tests
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout project
-        uses: actions/checkout@v3
-      - name: Checkout mock-server action
-        uses: actions/checkout@v3
-        with:
-          repository: pubnub/client-engineering-deployment-tools
-          ref: v1
-          token: ${{ secrets.GH_TOKEN }}
-          path: client-engineering-deployment-tools
-      - name: Run mock server action
-        uses: ./client-engineering-deployment-tools/actions/mock-server
-        with:
-          token: ${{ secrets.GH_TOKEN }}
-      - name: Install dependencies
-        run: |
-          sudo gem install bundler &&
-          bundle install
-      - 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
-      - name: Run acceptance tests (required)
-        run: bundle exec cucumber sdk-specifications/features/ -p mock -p run_main -p report_main -f pretty
-      - name: Combine test results
-        if: always()
-        run: |
-          sudo npm install -g junit-report-merger &&
-          jrm ./main.xml "./main/**/*.xml" &&
-          jrm ./beta.xml "./beta/**/*.xml"
-      - name: Expose main report
-        uses: actions/upload-artifact@v3
-        if: always()
-        with:
-          name: acceptance-test-reports
-          path: |
-            main.xml
-            beta.xml
-          retention-days: 7

data/.github/workflows/validate-pubnub-yml.yml

@@ -1,24 +0,0 @@
-name: validate-pubnub-yml
-
-# Controls when the action will run. Workflow runs when manually triggered using the UI
-# or API.
-on: [push]
-
-jobs:
-  build:
-    name: Validate PubNub yml
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: '12.x'
-      - name: Install dependencies
-        run: |
-          npm install ajv@6.12.6
-          npm install yaml@1.10.0
-          npm install node-fetch@2.6.1
-          npm install chalk@2.4.2
-      - name: Validate
-        run: GITHUB_TOKEN=${{ secrets.GH_TOKEN }} node ./.github/workflows/validate-yml.js

data/.github/workflows/validate-yml.js

@@ -1,95 +0,0 @@
-const YAML = require('yaml')
-const Ajv = require('ajv');
-const fetch = require('node-fetch');
-const fs = require('fs');
-const chalk = require('chalk');
-
-const ghToken = process.env.GITHUB_TOKEN;
-const ghHeaders = {'User-Agent': 'sdk-bot', 'Authorization': 'token ' + ghToken,'Accept': 'application/vnd.github.v3.raw'};
-
-const sdkReposJSONBranch = "develop";
-let sdkReposJSONPath = "http://api.github.com/repos/pubnub/documentation-resources/contents/website-common/tools/build/sdk-repos.json?ref=" + sdkReposJSONBranch;
-startExecution(sdkReposJSONPath);
-
-async function startExecution(sdkReposJSONPath){
-    console.log('JSON:', sdkReposJSONPath);
-    var sdkRepos = await requestGetFromGithub(sdkReposJSONPath);
-    var sdkReposAndFeatureMappingArray = parseReposAndFeatureMapping(sdkRepos);
-    var schemaText = await requestGetFromGithub(sdkReposAndFeatureMappingArray[2]);
-
-    schema = JSON.parse(schemaText);
-    var yaml = fs.readFileSync(".pubnub.yml", 'utf8');
-
-    if(yaml != null){
-        yml = YAML.parse(yaml);
-        var ajv = new Ajv({schemaId: 'id', "verbose":true, "allErrors": true});
-        const validate = ajv.compile(schema);
-        const valid = validate(yml);
-        if (validate.errors!= null) {
-            console.log(chalk.cyan("==================================="));
-            console.log(chalk.red(yml["version"] + " validation errors..."));
-            console.log(chalk.cyan("==================================="));
-            console.log(validate.errors);
-            console.log(chalk.cyan("==================================="));
-            var result = {code:1, repo: yml["version"], msg: "validation errors"};
-            printResult(result);
-            process.exit(1);
-        }
-        else {
-            var result = {code: 0, repo: yml["version"], msg: "validation pass"};
-            printResult(result);
-        }
-    } else {
-        var result = {code:1, repo: "yml null", msg: "validation errors"};
-        printResult(result);
-        process.exit(1);
-    }
-}
-
-function printResult(result){
-    var str = result.repo + ", " + result.msg;
-    if(result.code === 0){
-        console.log(chalk.green(str) + ", Code: " + result.code);
-    } else {
-        console.log(chalk.red(str) + ", Code: " + result.code);
-    }
-}
-
-async function requestGetFromGithub(url){
-    try {
-        const response = await fetch(url, {
-            headers: ghHeaders,
-            method: 'get',
-        });
-        if(response.status == 200){
-            const json = await response.text();
-            return json;
-        } else {
-            console.error(chalk.red("res.status: " + response.status + "\n URL: " + url));
-            return null;
-        }
-
-    } catch (error) {
-        console.error(chalk.red("requestGetFromGithub: " + error + "\n URL: " + url));
-        return null;
-    }
-}
-
-function parseReposAndFeatureMapping(body){
-    if(body != null){
-        var sdkRepos = JSON.parse(body);
-        var locations = sdkRepos["locations"];
-        if(locations!=null){
-            var sdkURLs = locations["sdks"];
-            var featureMappingURL = locations["featureMapping"];
-            var pubnubYAMLSchemaURL = locations["pubnubYAMLSchema"];
-            return [sdkURLs, featureMappingURL, pubnubYAMLSchemaURL];
-        } else {
-            console.log(chalk.red("response locations null"));
-            return null;
-        }
-    } else {
-        console.log(chalk.red("response body null"));
-        return null;
-    }
-}

data/.travis.yml

@@ -1,34 +0,0 @@
-language: ruby
-dist: xenial
-os: linux
-
-before_install:
-  # See https://github.com/travis-ci/travis-ci/issues/5861
-  - gem update --system
-  - gem install bundler
-  - gem update bundler
-
-bundler_args: --without development
-
-
-stages:
-  - name: "test"
-
-jobs:
-  include:
-    - name: 'Ruby 2.5.8'
-      rvm: '2.5.8'
-      script: bundle exec rspec
-    - name: 'Ruby 2.6.6'
-      rvm: '2.6.6'
-      script: bundle exec rspec
-    - name: 'Ruby 2.7.1'
-      rvm: '2.7.1'
-      script: bundle exec rspec
-    - name: 'Ruby JRuby'
-      rvm: 'jruby-9.3.4.0'
-      env: JRUBY_TEST=true NO_COVERAGE=true JRUBY_OPTS="--server -J-Xms2048m -J-Xmx2048m -J-XX:-UseGCOverheadLimit -J-XX:+CMSClassUnloadingEnabled"
-      jdk: oraclejdk11
-      script:
-        - jruby -S rspec ./spec/examples/
-        - jruby -S rspec ./spec/lib/