pubnub 4.7.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c52a9cfe08cbc90c671a74610beb900b5627c81e9f24da57e0c60530aa05c5b9
-  data.tar.gz: 5dd3300e2b6667e2364ab3e6d56f6583d3ca1eb71caa1839e9e97d3dbe68ec50
+  metadata.gz: e9393969418b064ec9d7b89500f7fbf2556607985ba14c3a61f77a5452830b2d
+  data.tar.gz: bb033ee292892b54dd13d606eee102f719bd1d51012307e3e87aa8f33ed6cde0
 SHA512:
-  metadata.gz: 3385c44fe3b07c3f84ff233e3bc42456e0907ff56e2fd65bd6197b2bcaa6edd75c3d53268959bb1491b88e7eaf3e49308a3afbed86a3bbebc2062364336b95be
-  data.tar.gz: 50506cf261d7d8c8240b8a25683dbe1032ebbb99b4f9dc3ba609228672fb8e3609ee43c3a0cc94052e8d80177e7e3554ee8b57458275d5a9865b37b7ad81ca1a
+  metadata.gz: 0a9eabe43321053374680972c48aea024f80c47b53fb98650698bffb522fd53995246749eb9561b2e136564c1a1367e6eda7a6b2307646690e8f670ff88bd30f
+  data.tar.gz: 2160579b9069914c28f0fdc2992608737cfc5a7235b9eac86e42a2f02fa984f5179c327cb1a3a93c4f22d0de596e662e2ce8dea84e51ade44a29f770196c60a6

data/.github/workflows/run_acceptance_tests.yml

@@ -25,10 +25,10 @@ jobs:
           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
+        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
+        run: bundle exec cucumber sdk-specifications/features/ -p mock -p run_main -p report_main -f pretty
       - name: Combine test results
         if: always()
         run: |

data/.pubnub.yml

@@ -1,6 +1,23 @@
 ---
-version: "4.7.1"
+version: "5.1.0"
 changelog:
+  - date: 2022-07-26
+    version: v5.1.0
+    changes:
+      - type: feature
+        text: "Add support for spaces and users permissions in grant_token."
+      - type: feature
+        text: "Add user_id and deprecate uuid when creating new pubnub instance."
+  - date: 2022-01-13
+    version: v5.0.0
+    changes:
+      - type: improvement
+        text: "BREAKING CHANGES: uuid is required parameter to create PubNub instance."
+  - date: 2021-12-16
+    version: v4.8.0
+    changes:
+      - type: feature
+        text: "Add revoke token feature."
   - date: 2021-11-24
     version: v4.7.1
     changes:
@@ -403,6 +420,10 @@ features:
   access:
     - ACCESS-GRANT
     - ACCESS-SECRET-KEY-ALL-ACCESS
+    - ACCESS-GRANT-TOKEN
+    - ACCESS-PARSE-TOKEN
+    - ACCESS-SET-TOKEN
+    - ACCESS-REVOKE-TOKEN
   channel-groups:
     - CHANNEL-GROUPS-ADD-CHANNELS
     - CHANNEL-GROUPS-REMOVE-CHANNELS
@@ -433,7 +454,6 @@ features:
     - PUSH-TYPE-APNS
     - PUSH-TYPE-APNS2
     - PUSH-TYPE-FCM
-    - PUSH-TYPE-MPNS
   storage:
     - STORAGE-REVERSE
     - STORAGE-INCLUDE-TIMETOKEN
@@ -612,7 +632,7 @@ sdks:
                     - x86-64
           - distribution-type: package
             distribution-repository: RubyGems
-            package-name: pubnub-4.7.1.gem
+            package-name: pubnub-5.1.0.gem
             location: https://rubygems.org/gems/pubnub
             requires:
               - name: addressable
@@ -717,8 +737,8 @@ sdks:
                     - x86-64
           - distribution-type: library
             distribution-repository: GitHub release
-            package-name: pubnub-4.7.1.gem
-            location: https://github.com/pubnub/ruby/releases/download/v4.7.1/pubnub-4.7.1.gem
+            package-name: pubnub-5.1.0.gem
+            location: https://github.com/pubnub/ruby/releases/download/v5.1.0/pubnub-5.1.0.gem
             requires:
               - name: addressable
                 min-version: 2.0.0

data/.travis.yml

@@ -26,7 +26,7 @@ jobs:
       rvm: '2.7.1'
       script: bundle exec rspec
     - name: 'Ruby JRuby'
-      rvm: 'jruby-head'
+      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:

data/CHANGELOG.md

@@ -1,12 +1,31 @@
-## v4.7.1
-November 24 2021
+## v5.1.0
+July 26 2022
 
 #### Added
-- Add new method `all_history_messages` which return messages from requested interval or `since` / `before` date in single object.
+- Add support for spaces and users permissions in grant_token.
+- Add user_id and deprecate uuid when creating new pubnub instance.
 
-#### Fixed
-- Fix exception raised when optional start / end not passed to `paged_history`.
+## v5.0.0
+January 13 2022
 
+#### Modified
+- BREAKING CHANGES: uuid is required parameter to create PubNub instance.
+
+## v4.8.0
+December 16 2021
+
+#### Added
+- Add revoke token feature.
+
+## v4.7.1
+November 24 2021
+
+#### Added
+- Add new method `all_history_messages` which return messages from requested interval or `since` / `before` date in single object.
+
+#### Fixed
+- Fix exception raised when optional start / end not passed to `paged_history`.
+
 ## v4.7.0
 November 09 2021
 

data/Gemfile.lock

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

data/VERSION

@@ -1 +1 @@
-4.7.1
+5.1.0

data/features/step_definitions/{grant_token_steps.rb → access_steps.rb}

@@ -12,6 +12,20 @@ Given('I have a keyset with access manager enabled') do
   logger = Logger.new(STDOUT)
   logger.level = Logger::DEBUG
   @pn_configuration['logger'] = logger
+  @pn_configuration['uuid'] = Pubnub::UUID.generate
+
+  @pubnub = Pubnub.new(@pn_configuration)
+end
+
+Given('I have a keyset with access manager enabled - without secret key') do
+  expect(ENV['PAM_SUB_KEY']).not_to be_nil
+  expect(ENV['PAM_PUB_KEY']).not_to be_nil
+  @pn_configuration['subscribe_key'] = ENV['PAM_SUB_KEY']
+  @pn_configuration['publish_key'] = ENV['PAM_PUB_KEY']
+  logger = Logger.new(STDOUT)
+  logger.level = Logger::DEBUG
+  @pn_configuration['logger'] = logger
+  @pn_configuration['uuid'] = Pubnub::UUID.generate
 
   @pubnub = Pubnub.new(@pn_configuration)
 end
@@ -48,17 +62,56 @@ Given('the {string} {resourceType} pattern access permissions') do |pattern, res
   }
 end
 
+Given('a valid token with permissions to publish with channel {string}') do |string|
+  @grant_token_state[:token] = token_with_all
+end
+
+Given('a token') do
+  @grant_token_state[:token] = token_with_all
+end
+
+Given('an expired token with permissions to publish with channel {string}') do |string|
+  @grant_token_state[:token] = token_with_all
+end
+
 And('grant pattern permission {permissionType}') do |permission_type|
   current_pattern = @grant_token_state[:current_pattern]
   @grant_token_state[:current_grant][current_pattern][:permission_type].push(permission_type)
 end
 
-
 When('I grant a token specifying those permissions') do
   res = call_grant_token(@pubnub, @grant_token_state)
   @grant_token_state[:parsed_token] = @pubnub.parse_token(res.result[:data]["token"])
 end
 
+When('I publish a message using that auth token with channel {string}') do |channel|
+  @pubnub.set_token(@grant_token_state[:token])
+  res = @pubnub.publish(
+    message: "This is message",
+    channel: channel,
+    http_sync: true
+  )
+  @global_state[:last_call_res] = res
+end
+
+When('I attempt to publish a message using that auth token with channel {string}') do |channel|
+  @pubnub.set_token(@grant_token_state[:token])
+  res = @pubnub.publish(
+    message: "This is message",
+    channel: channel,
+    http_sync: true
+  )
+  @global_state[:last_call_res] = res
+end
+
+When('I revoke a token') do
+  res = @pubnub.revoke_token(
+    token: @grant_token_state[:token],
+    http_sync: true
+  )
+  @global_state[:last_call_res] = res
+end
+
 Then('the token contains the authorized UUID {string}') do |expected_uuid|
   expect(@grant_token_state[:parsed_token]["uuid"]).to eq expected_uuid
 end
@@ -115,35 +168,37 @@ Given('deny resource permission {permissionType}') do |permission_type|
 end
 
 When('I attempt to grant a token specifying those permissions') do
-  @grant_token_state[:error_response] = call_grant_token(@pubnub, @grant_token_state)
+  @global_state[:last_call_res] = call_grant_token(@pubnub, @grant_token_state)
 end
 
 Then('an error is returned') do
-  expect(@grant_token_state[:error_response]).not_to eq nil
+  envelope = @global_state[:last_call_res]
+  expect(envelope).not_to eq nil
+  expect(envelope.is_a?(Pubnub::ErrorEnvelope)).to eq true
 end
 
 Then('the error status code is {int}') do |code|
-  expect(@grant_token_state[:error_response].status[:code]).to eq code
+  expect(@global_state[:last_call_res].status[:code]).to eq code
 end
 
 Then('the error message is {string}') do |error_message|
-  expect(parse_error_body(@grant_token_state[:error_response])["error"]["message"]).to eq error_message
+  expect(parse_error_body(@global_state[:last_call_res])["error"]["message"]).to eq error_message
 end
 
 Then('the error source is {string}') do |error_source|
-  expect(parse_error_body(@grant_token_state[:error_response])["error"]["source"]).to eq error_source
+  expect(parse_error_body(@global_state[:last_call_res])["error"]["source"]).to eq error_source
 end
 
 Then('the error detail message is {string}') do |details_message|
-  expect(parse_error_body(@grant_token_state[:error_response])["error"]["details"][0]["message"]).to eq details_message
+  expect(parse_error_body(@global_state[:last_call_res])["error"]["details"][0]["message"]).to eq details_message
 end
 
 Then('the error detail location is {string}') do |details_location|
-  expect(parse_error_body(@grant_token_state[:error_response])["error"]["details"][0]["location"]).to eq details_location
+  expect(parse_error_body(@global_state[:last_call_res])["error"]["details"][0]["location"]).to eq details_location
 end
 
 Then('the error detail location type is {string}') do |location_type|
-  expect(parse_error_body(@grant_token_state[:error_response])["error"]["details"][0]["locationType"]).to eq location_type
+  expect(parse_error_body(@global_state[:last_call_res])["error"]["details"][0]["locationType"]).to eq location_type
 end
 
 Given('I have a known token containing an authorized UUID') do
@@ -165,3 +220,39 @@ end
 Given('I have a known token containing UUID pattern Permissions') do
   @grant_token_state[:token] = token_with_all
 end
+
+Given('the token string {string}') do |token|
+  @grant_token_state[:token] = token
+end
+
+Then('the result is successful') do
+  envelope = @global_state[:last_call_res]
+  expect(envelope.is_a?(Pubnub::ErrorEnvelope)).to eq false
+  expect(envelope.status[:code]).to eq 200
+end
+
+Then('an auth error is returned') do
+  envelope = @global_state[:last_call_res]
+  expect(envelope).not_to eq nil
+  expect(envelope.is_a?(Pubnub::ErrorEnvelope)).to eq true
+end
+
+Then('the auth error message is {string}') do |error_message|
+  expect(parse_error_body(@global_state[:last_call_res])["message"]).to eq error_message
+end
+
+Then('the error service is {string}') do |service|
+  expect(parse_error_body(@global_state[:last_call_res])["service"]).to eq service
+end
+
+Then('I get confirmation that token has been revoked') do
+  envelope = @global_state[:last_call_res]
+  expect(envelope.is_a?(Pubnub::ErrorEnvelope)).to eq false
+  expect(envelope.status[:code]).to eq 200
+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/support/hooks.rb

@@ -3,6 +3,7 @@ require 'json'
 
 Before do |scenario|
   @grant_token_state = {}
+  @global_state = {}
   @grant_token_state[:current_grant] = {}
   @pn_configuration = {}
 

data/lib/pubnub/client/events.rb

@@ -4,7 +4,7 @@ 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 delete_messages
+      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_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

data/lib/pubnub/client/getters_setters.rb

@@ -1,9 +1,14 @@
+require 'pubnub/validators/common_validator'
+
 # Toplevel Pubnub module.
 module Pubnub
   # Pubnub client Class
   class Client
     # Module that holds some getters and setters
     module GettersSetters
+
+      extend Gem::Deprecate
+
       def sdk_version
         "PubNub-Ruby/#{Pubnub::VERSION}"
       end
@@ -12,7 +17,7 @@ module Pubnub
       # ===========
       # <dl>
       #   <dt>uuid</dt>
-      #   <dd>New uuid to be set.</dd>
+      #   <dd>New uuid to be set. Note that this will override user_id value</dd>
       # </dl>
       #
       # Returns:
@@ -23,14 +28,38 @@ module Pubnub
       # ==============
       # Can't change uuid while subscribed. You have to leave every subscribed channel.
       def change_uuid(uuid)
-        Pubnub.logger.debug('Pubnub::Client') { 'Changing uuid' }
-        raise('Cannot change UUID while subscribed.') if subscribed?
-        @env[:uuid] = uuid
+        change_user_id(uuid)
+      end
+      deprecate :change_uuid, :change_user_id, 2023, 1
+
+      # Parameters:
+      # ===========
+      # <dl>
+      #   <dt>user_id</dt>
+      #   <dd>New user_id to be set. Note that this will override uuid value</dd>
+      # </dl>
+      #
+      # Returns:
+      # ========
+      # New user_id.
+      #
+      # Functionality:
+      # ==============
+      # Can't change user_id while subscribed. You have to leave every subscribed channel.
+      def change_user_id(user_id)
+        Pubnub.logger.debug('Pubnub::Client') { 'Changing user_id' }
+        raise('Cannot change user_id while subscribed.') if subscribed?
+        Validator::Client.validate_user_id user_id
+
+        @env[:user_id] = user_id
       end
 
       alias session_uuid= change_uuid
       alias uuid= change_uuid
       alias set_uuid= change_uuid
+      alias session_user_id= change_user_id
+      alias user_id= change_user_id
+      alias set_user_id= change_user_id
 
       # Returns:
       # ========
@@ -92,7 +121,15 @@ module Pubnub
       # ========
       # Current uuid.
       def uuid
-        @env[:uuid]
+        user_id
+      end
+      deprecate :uuid, :user_id, 2023, 1
+
+      # Returns:
+      # ========
+      # Current user_id.
+      def user_id
+        @env[:user_id]
       end
 
       # Returns:

data/lib/pubnub/client.rb

@@ -37,6 +37,7 @@ require 'pubnub/validators/audit'
 require 'pubnub/validators/channel_registration'
 require 'pubnub/validators/grant'
 require 'pubnub/validators/grant_token'
+require 'pubnub/validators/revoke_token'
 require 'pubnub/validators/heartbeat'
 require 'pubnub/validators/here_now'
 require 'pubnub/validators/history'
@@ -110,7 +111,10 @@ module Pubnub
     #   <dd><b>optional.</b> Required to encrypt messages.</dd>
     #
     #   <dt>uuid</dt>
-    #   <dd><b>optional.</b> Sets given uuid as client uuid, does not generates random uuid on init as usually.</dd>
+    #   <dd><b>optional.</b> <b>Deprecated.</b> Sets given uuid as client uuid, does not generates random uuid on init as usually</dd>
+    #
+    #   <dt>user_id</dt>
+    #   <dd><b>required.</b> Sets given user_id as client user_id.</dd>
     #
     #   <dt>origin</dt>
     #   <dd><b>optional.</b> Specifies the fully qualified domain name of the PubNub origin.
@@ -154,7 +158,7 @@ module Pubnub
     #   publish_key: :demo,
     #   secret_key: :secret,
     #   cipher_key: :other_secret,
-    #   uuid: :mad_max,
+    #   user_id: :mad_max,
     #   origin: 'custom.pubnub.com',
     #   callback: ->(envelope) { puts envelope.message },
     #   connect_callback: ->(message) { puts message },
@@ -288,7 +292,7 @@ module Pubnub
 
     def sequence_number_for_publish!
       @env[:sequence_number_for_publish] += 1
-      @env[:sequence_number_for_publish] % 2**32
+      @env[:sequence_number_for_publish] % 2 ** 32
     end
 
     def apply_state(event)
@@ -378,19 +382,15 @@ module Pubnub
       Pubnub.logger = options[:logger] || Logger.new('pubnub.log')
       Concurrent.global_logger = Pubnub.logger
       @subscriber = Subscriber.new(self)
+      options[:user_id] = options[:uuid] if options[:user_id].nil?
       @env = options
     end
 
     def prepare_env
       assign_defaults
-      generate_uuid if @env[:uuid].blank?
       setup_pools
     end
 
-    def generate_uuid
-      @env[:uuid] = UUID.generate
-    end
-
     def assign_defaults
       @env[:origin] = @env[:origins_pool].first if @env[:origins_pool]
       default_values.each do |k, v|

data/lib/pubnub/constants.rb

@@ -58,6 +58,7 @@ module Pubnub
     OPERATION_AUDIT = :audit
     OPERATION_GRANT = :grant
     OPERATION_GRANT_TOKEN = :grant_token
+    OPERATION_REVOKE_TOKEN = :revoke_token
     OPERATION_REVOKE = :revoke
     OPERATION_DELETE = :delete
     OPERATION_LIST_ALL_CHANNEL_GROUPS = :list_all_channel_groups

data/lib/pubnub/event.rb

@@ -112,7 +112,8 @@ 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
+      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_SET_UUID_METADATA, Pubnub::Constants::OPERATION_SET_CHANNEL_METADATA,
            Pubnub::Constants::OPERATION_SET_CHANNEL_MEMBERS, Pubnub::Constants::OPERATION_SET_MEMBERSHIPS,
@@ -147,7 +148,7 @@ module Pubnub
       token = @app.env[:token]
       empty_if_blank = {
         auth: token ? token : @auth_key,
-        uuid: @app.env[:uuid],
+        uuid: @app.user_id,
         @telemetry_name => @current_telemetry
       }
 
@@ -174,6 +175,7 @@ module Pubnub
                      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
                    ]
 
       options = options.each_with_object({}) { |option, obj| obj[option.first.to_sym] = option.last }
@@ -221,7 +223,7 @@ module Pubnub
     def get_config
       {
         tls: @app.env[:ssl],
-        uuid: @app.env[:uuid],
+        uuid: @app.user_id,
         auth_key: @app.env[:auth_key],
         origin: @app.current_origin
       }

data/lib/pubnub/events/get_memberships.rb

@@ -10,7 +10,7 @@ module Pubnub
     def initialize(options, app)
       @event = current_operation
       @telemetry_name = :l_obj
-      @uuid = options[:uuid].nil? ? app.env[:uuid] : options[:uuid]
+      @uuid = options[:uuid].nil? ? app.user_id : options[:uuid]
       @limit = [options[:limit], 100].min unless options[:limit].nil?
       @sort = options[:sort].join(",") if options[:sort] && !options[:sort].empty?
       @filter = options[:filter] if options[:filter] && !options[:filter].empty?

data/lib/pubnub/events/get_uuid_metadata.rb

@@ -10,7 +10,7 @@ module Pubnub
     def initialize(options, app)
       @event = current_operation
       @telemetry_name = :l_obj
-      @uuid = options[:uuid].nil? ? app.env[:uuid] : options[:uuid]
+      @uuid = options[:uuid].nil? ? app.user_id : options[:uuid]
 
       if options[:include]
         @include = "custom" unless [0, '0', false].include?(options[:include][:custom])

data/lib/pubnub/events/grant_token.rb

@@ -10,19 +10,28 @@ module Pubnub
       @uuids = options[:uuids] || {}
       options[:channels] = options[:channels] || {}
       options[:channel_groups] = options[:channel_groups] || {}
+      @spaces_permissions = options[:spaces_permissions] || {}
+      @users_permissions = options[:users_permissions] || {}
       super
     end
 
     def fire
       Pubnub.logger.debug('Pubnub::GrantToken') { "Fired event #{self.class}" }
+      if @authorized_user_id != nil
+        uuid = @authorized_user_id
+      elsif @authorized_uuid != nil
+        uuid = @authorized_uuid
+      else
+        uuid = nil
+      end
 
       raw_body = {
         ttl: @ttl,
         permissions: {
           meta: @meta,
-          uuid: @authorized_uuid,
-          resources: prepare_permissions(:resource, @channels, @channel_groups, @uuids),
-          patterns: prepare_permissions(:pattern, @channels, @channel_groups, @uuids)
+          uuid: uuid,
+          resources: prepare_permissions(:resource, @channels, @channel_groups, @uuids, @spaces_permissions, @users_permissions),
+          patterns: prepare_permissions(:pattern, @channels, @channel_groups, @uuids, @spaces_permissions, @users_permissions)
         }.select { |_, v| v }
       }
       body = Formatter.format_message(raw_body, "", false, false)
@@ -47,11 +56,11 @@ module Pubnub
       Pubnub::Constants::OPERATION_GRANT_TOKEN
     end
 
-    def prepare_permissions(type, channels, groups, uuids)
+    def prepare_permissions(type, channels, groups, uuids, spaces_permissions, users_permissions)
       {
-        channels: prepare_single_permissions(type, channels),
+        channels: prepare_single_permissions(type, channels).merge!(prepare_single_permissions(type, spaces_permissions)),
         groups: prepare_single_permissions(type, groups),
-        uuids: prepare_single_permissions(type, uuids)
+        uuids: prepare_single_permissions(type, uuids).merge!(prepare_single_permissions(type, users_permissions))
       }
     end
 

data/lib/pubnub/events/remove_memberships.rb

@@ -10,7 +10,7 @@ module Pubnub
     def initialize(options, app)
       @event = current_operation
       @telemetry_name = :l_obj
-      @uuid = options[:uuid].nil? ? app.env[:uuid] : options[:uuid]
+      @uuid = options[:uuid].nil? ? app.user_id : options[:uuid]
       @limit = [options[:limit], 100].min unless options[:limit].nil?
       @sort = options[:sort].join(",") if options[:sort] && !options[:sort].empty?
       @filter = options[:filter] if options[:filter] && !options[:filter].empty?

data/lib/pubnub/events/remove_uuid_metadata.rb

@@ -10,7 +10,7 @@ module Pubnub
     def initialize(options, app)
       @event = current_operation
       @telemetry_name = :l_obj
-      @uuid = options[:uuid].nil? ? app.env[:uuid] : options[:uuid]
+      @uuid = options[:uuid].nil? ? app.user_id : options[:uuid]
       super
     end
 

data/lib/pubnub/events/revoke_token.rb

@@ -0,0 +1,66 @@
+module Pubnub
+  # Holds revoke token functionality
+  class RevokeToken < SingleEvent
+    include Concurrent::Async
+    include Pubnub::Validator::RevokeToken
+
+    def initialize(options, app)
+      @event = :revoke_token
+      super
+      @token = @token.split(' ')
+            .map{ |part| CGI.escape(part) }
+            .join("%20")
+    end
+
+    private
+
+    def current_operation
+      Pubnub::Constants::OPERATION_GRANT_TOKEN
+    end
+
+    def valid_envelope(parsed_response, req_res_objects)
+      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,
+
+          current_timetoken: nil,
+          last_timetoken: nil,
+          subscribed_channels: nil,
+          subscribed_channel_groups: nil,
+
+          data: nil,
+
+          config: get_config
+
+        },
+        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']
+        }
+      )
+    end
+
+
+    def path
+      '/' + [
+        'v3',
+        'pam',
+        @subscribe_key,
+        'grant',
+        @token
+      ].join('/')
+    end
+  end
+end

data/lib/pubnub/events/set_memberships.rb

@@ -10,7 +10,7 @@ module Pubnub
     def initialize(options, app)
       @event = current_operation
       @telemetry_name = :l_obj
-      @uuid = options[:uuid].nil? ? app.env[:uuid] : options[:uuid]
+      @uuid = options[:uuid].nil? ? app.user_id : options[:uuid]
       @limit = [options[:limit], 100].min unless options[:limit].nil?
       @sort = options[:sort].join(",") if options[:sort] && !options[:sort].empty?
       @filter = options[:filter] if options[:filter] && !options[:filter].empty?

data/lib/pubnub/events/set_state.rb

@@ -34,7 +34,7 @@ module Pubnub
         'channel',
         Formatter.channels_for_url(@channel),
         'uuid',
-        Formatter.encode(@app.uuid),
+        Formatter.encode(@app.user_id),
         'data'
       ].join('/')
     end

data/lib/pubnub/events/set_uuid_metadata.rb

@@ -10,7 +10,7 @@ module Pubnub
     def initialize(options, app)
       @event = current_operation
       @telemetry_name = :l_obj
-      @uuid = options[:uuid].nil? ? app.env[:uuid] : options[:uuid]
+      @uuid = options[:uuid].nil? ? app.user_id : options[:uuid]
 
       # Clean up user-provided metadata object from nils.
       @metadata = options[:metadata].delete_if { |_k, v| v.blank? } unless options[:metadata].nil?

data/lib/pubnub/events/state.rb

@@ -10,7 +10,7 @@ module Pubnub
       @telemetry_name = :l_pres
       @uuid_looking_for = options[:uuid] || options['uuid']
       super
-      @uuid = app.uuid
+      @uuid = app.user_id
     end
 
     private

data/lib/pubnub/events/where_now.rb

@@ -9,7 +9,7 @@ module Pubnub
       super
       @telemetry_name = :l_pres
       @uuid_looking_for = options[:uuid] || options['uuid']
-      @uuid = app.uuid
+      @uuid = app.user_id
       @event = :where_now
     end
 

data/lib/pubnub/subscriber.rb

@@ -290,7 +290,7 @@ module Pubnub
     def get_config
       {
         tls: @app.env[:ssl],
-        uuid: @app.env[:uuid],
+        uuid: @app.user_id,
         auth_key: @app.env[:auth_key],
         origin: @app.current_origin
       }

data/lib/pubnub/validators/client.rb

@@ -11,6 +11,7 @@ module Pubnub
           validate_origin parameters[:origin], true
           validate_subscribe_key parameters[:subscribe_key], true
           validate_publish_key parameters[:publish_key]
+          validate_user_id parameters[:user_id]
         end
       end
     end

data/lib/pubnub/validators/common_validator.rb

@@ -52,6 +52,22 @@ module Pubnub
           )
         end
       end
+
+      def validate_user_id(user_id)
+        if !user_id || user_id.blank?
+          raise(
+            InitializationError.new,
+            'Missing required :user_id parameter.'
+          )
+        elsif !([String, Symbol].include?(user_id.class) ||
+          user_id.blank?)
+          raise(
+            InitializationError.new,
+            'user_id parameter is not valid. \
+                   Should be type of String or Symbol.'
+          )
+        end
+      end
     end
   end
 end

data/lib/pubnub/validators/grant_token.rb

@@ -12,6 +12,7 @@ module Pubnub
         validate_permissions!(@uuids, ":uuids")
         validate_permissions!(@channels, ":channels")
         validate_permissions!(@channel_groups, ":uuids")
+        validate_objects_entities_separation!
       end
 
       private
@@ -45,6 +46,19 @@ module Pubnub
           ":#{name} has to be kind of Hash for grant token event."
         ) unless arg.is_a?(Hash)
       end
+
+      def validate_objects_entities_separation!
+        entities_set = !@spaces_permissions.empty? ||
+          !@users_permissions.empty?
+        objects_set = !@channels.empty? ||
+          !@channel_groups.empty? ||
+          !@uuids.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: "Can't mix entities and objects"),
+          "Can't mix entities and objects"
+        ) if (entities_set && objects_set)
+      end
     end
   end
 end

data/lib/pubnub/validators/revoke_token.rb

@@ -0,0 +1,31 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for Grant event
+    module RevokeToken
+      include CommonValidator
+
+      def validate!
+        validate_keys!
+        validate_token!
+      end
+
+      private
+
+      def validate_keys!
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for revoke token event.'),
+          ':subscribe_key is required for grant token event.'
+        ) if @subscribe_key.nil? || @subscribe_key.empty?
+      end
+
+      def validate_token!
+        raise(
+          ArgumentError.new(object: self, message: ':token is required for revoke token event.'),
+          ':token is required for revoke token event.'
+        ) if @token.nil? || @token.empty?
+      end
+    end
+  end
+end

data/lib/pubnub/version.rb

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

data/lib/pubnub.rb

@@ -15,6 +15,7 @@ require 'concurrent-edge'
 
 require 'pubnub/version'
 require 'pubnub/client'
+require 'pubnub/uuid'
 
 # Adding blank? and present? methods to Object.
 class Object

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 4.7.1
+  version: 5.1.0
 platform: ruby
 authors:
 - PubNub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-25 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -151,7 +151,7 @@ files:
 - VERSION
 - config/cucumber.yml
 - docs.md
-- features/step_definitions/grant_token_steps.rb
+- features/step_definitions/access_steps.rb
 - features/support/env.rb
 - features/support/helper.rb
 - features/support/hooks.rb
@@ -206,6 +206,7 @@ files:
 - lib/pubnub/events/remove_memberships.rb
 - lib/pubnub/events/remove_uuid_metadata.rb
 - lib/pubnub/events/revoke.rb
+- lib/pubnub/events/revoke_token.rb
 - lib/pubnub/events/set_channel_members.rb
 - lib/pubnub/events/set_channel_metadata.rb
 - lib/pubnub/events/set_memberships.rb
@@ -262,6 +263,7 @@ files:
 - lib/pubnub/validators/remove_memberships.rb
 - lib/pubnub/validators/remove_uuid_metadata.rb
 - lib/pubnub/validators/revoke.rb
+- lib/pubnub/validators/revoke_token.rb
 - lib/pubnub/validators/set_channel_members.rb
 - lib/pubnub/validators/set_channel_metadata.rb
 - lib/pubnub/validators/set_memberships.rb
@@ -298,7 +300,7 @@ signing_key:
 specification_version: 4
 summary: PubNub Official Ruby gem.
 test_files:
-- features/step_definitions/grant_token_steps.rb
+- features/step_definitions/access_steps.rb
 - features/support/env.rb
 - features/support/helper.rb
 - features/support/hooks.rb