pubnub 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94a5346f9874553c5abf72a14cd22f76fe14d268c81ac97e8c88c8489fba2bf4
-  data.tar.gz: 9c6517348ed1e98f0434105afadacbb3b1d381437edb996366d977ec9749ba53
+  metadata.gz: e9393969418b064ec9d7b89500f7fbf2556607985ba14c3a61f77a5452830b2d
+  data.tar.gz: bb033ee292892b54dd13d606eee102f719bd1d51012307e3e87aa8f33ed6cde0
 SHA512:
-  metadata.gz: d16f505c9f0bddfb93e794abefe02f7e4c23e23158e755c97a942b27fae298d8c244d1e6cc1bae6d9ef439f5cc631354a50d401f419da2a0d3ce523474ccc737
-  data.tar.gz: cdab28581565cadc69597cc737b4fe616296e43f5c686a58543312d37fec6f8b4dd377d3fc26406a404e6791a4ba731bfe25cc8a5f899b1c5e054759286fcd4d
+  metadata.gz: 0a9eabe43321053374680972c48aea024f80c47b53fb98650698bffb522fd53995246749eb9561b2e136564c1a1367e6eda7a6b2307646690e8f670ff88bd30f
+  data.tar.gz: 2160579b9069914c28f0fdc2992608737cfc5a7235b9eac86e42a2f02fa984f5179c327cb1a3a93c4f22d0de596e662e2ce8dea84e51ade44a29f770196c60a6

data/.pubnub.yml

@@ -1,6 +1,13 @@
 ---
-version: "5.0.0"
+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:
@@ -447,7 +454,6 @@ features:
     - PUSH-TYPE-APNS
     - PUSH-TYPE-APNS2
     - PUSH-TYPE-FCM
-    - PUSH-TYPE-MPNS
   storage:
     - STORAGE-REVERSE
     - STORAGE-INCLUDE-TIMETOKEN
@@ -626,7 +632,7 @@ sdks:
                     - x86-64
           - distribution-type: package
             distribution-repository: RubyGems
-            package-name: pubnub-5.0.0.gem
+            package-name: pubnub-5.1.0.gem
             location: https://rubygems.org/gems/pubnub
             requires:
               - name: addressable
@@ -731,8 +737,8 @@ sdks:
                     - x86-64
           - distribution-type: library
             distribution-repository: GitHub release
-            package-name: pubnub-5.0.0.gem
-            location: https://github.com/pubnub/ruby/releases/download/v5.0.0/pubnub-5.0.0.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,3 +1,10 @@
+## 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
 

data/Gemfile.lock

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

data/VERSION

@@ -1 +1 @@
-5.0.0
+5.1.0

data/lib/pubnub/client/getters_setters.rb

@@ -7,6 +7,8 @@ module Pubnub
     # Module that holds some getters and setters
     module GettersSetters
 
+      extend Gem::Deprecate
+
       def sdk_version
         "PubNub-Ruby/#{Pubnub::VERSION}"
       end
@@ -15,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:
@@ -26,16 +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?
-        Validator::Client.validate_uuid uuid
+        change_user_id(uuid)
+      end
+      deprecate :change_uuid, :change_user_id, 2023, 1
 
-        @env[:uuid] = uuid
+      # 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:
       # ========
@@ -97,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

@@ -111,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.
@@ -155,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 },
@@ -289,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)
@@ -379,6 +382,7 @@ 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
 

data/lib/pubnub/event.rb

@@ -148,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
       }
 
@@ -175,7 +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
-                     token
+                     authorized_user_id token
                    ]
 
       options = options.each_with_object({}) { |option, obj| obj[option.first.to_sym] = option.last }
@@ -223,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/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,7 +11,7 @@ module Pubnub
           validate_origin parameters[:origin], true
           validate_subscribe_key parameters[:subscribe_key], true
           validate_publish_key parameters[:publish_key]
-          validate_uuid parameters[:uuid]
+          validate_user_id parameters[:user_id]
         end
       end
     end

data/lib/pubnub/validators/common_validator.rb

@@ -53,18 +53,17 @@ module Pubnub
         end
       end
 
-      # Validates given uuid
-      def validate_uuid(uuid)
-        if !uuid || uuid.blank?
+      def validate_user_id(user_id)
+        if !user_id || user_id.blank?
           raise(
             InitializationError.new,
-            'Missing required :uuid parameter.'
+            'Missing required :user_id parameter.'
           )
-        elsif !([String, Symbol].include?(uuid.class) ||
-          uuid.blank?)
+        elsif !([String, Symbol].include?(user_id.class) ||
+          user_id.blank?)
           raise(
             InitializationError.new,
-            'UUID parameter is not valid. \
+            'user_id parameter is not valid. \
                    Should be type of String or Symbol.'
           )
         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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubnub
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - PubNub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable