pubnub 4.3.0 → 4.4.0

data/lib/pubnub/events/{update_space.rb → set_uuid_metadata.rb}

@@ -2,24 +2,33 @@
 # frozen_string_literal: true
 
 module Pubnub
-  # Holds UpdateSpace functionality
-  class UpdateSpace < SingleEvent
+  # Holds SetUuidMetadata functionality
+  class SetUuidMetadata < SingleEvent
     include Concurrent::Async
-    include Pubnub::Validator::UpdateSpace
+    include Pubnub::Validator::SetUuidMetadata
 
     def initialize(options, app)
-      @event = :update_space
+      @event = current_operation
       @telemetry_name = :l_obj
-      @space_id = options[:space_id]
-      @data = options[:data]
-      @include = options[:include]
+      @uuid = options[:uuid]
+
+      # Clean up user-provided metadata object from nils.
+      @metadata = options[:metadata].delete_if { |_k, v| v.blank? } unless options[:metadata].nil?
+
+      if options[:include]
+        @include = [0, '0', false].include?(options[:include][:custom]) ? "0" : "1" unless options[:include][:custom].nil?
+      end
+
+      # Single entity creation should return it's 'custom' field by default.
+      @include = "custom" if @include.nil?
+
       super
     end
 
     def fire
-      Pubnub.logger.debug('Pubnub::UpdateSpace') { "Fired event #{self.class}" }
+      Pubnub.logger.debug('Pubnub::SetUuidMetadata') { "Fired event #{self.class}" }
 
-      body = Formatter.format_message(@data, @cipher_key, false)
+      body = Formatter.format_message(@metadata, @cipher_key, false)
       response = send_request(body)
 
       envelopes = fire_callbacks(handle(response, uri))
@@ -30,22 +39,22 @@ module Pubnub
     private
 
     def current_operation
-      Pubnub::Constants::OPERATION_UPDATE_SPACE
+      Pubnub::Constants::OPERATION_SET_UUID_METADATA
     end
 
-    def parameters(*_args)
-      parameters = super
-      parameters[:include] = @include if @include
+    def parameters(signature = false)
+      parameters = super(signature)
+      parameters[:include] = @include
       parameters
     end
 
     def path
       '/' + [
-        'v1',
+        'v2',
         'objects',
         @subscribe_key,
-        'spaces',
-        @space_id
+        'uuids',
+        Formatter.encode(@uuid)
       ].join('/')
     end
 
@@ -57,7 +66,7 @@ module Pubnub
 
         result: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_UPDATE_SPACE,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: parsed_response
@@ -65,7 +74,7 @@ module Pubnub
 
         status: {
           code: req_res_objects[:response].code,
-          operation: Pubnub::Constants::OPERATION_UPDATE_SPACE,
+          operation: current_operation,
           client_request: req_res_objects[:request],
           server_response: req_res_objects[:response],
           data: nil,

data/lib/pubnub/pam.rb

@@ -14,17 +14,7 @@ module Pubnub
     end
 
     def signature
-      message = [
-        @subscribe_key,
-        @publish_key,
-        path,
-        variables_for_signature.gsub(/[!~'()*]/) { |char| '%' + char.ord.to_s(16).upcase }, # Replace ! ~ * ' ( )
-      ].join("\n")
-
-      Base64.urlsafe_encode64(
-        OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'),
-                             @secret_key.to_s, message)
-      ).strip
+      super_admin_signature("GET", nil)
     end
 
     def parameters(set_signature = false)
@@ -32,6 +22,7 @@ module Pubnub
       params['channel-group'] = @group.join(',') unless @group.blank?
       params[:timestamp] = @timestamp
       params[:channel] = @channel.join(',') unless @channel.first.blank?
+      params['target-uuid'] = @uuids.join(',') if !@uuids.nil? && !@uuids.first.blank?
       params[:signature] = signature unless set_signature
       params
     end

data/lib/pubnub/subscribe_callback.rb

@@ -10,9 +10,7 @@ module Pubnub
         status: options[:status],
         presence: options[:presence],
         signal: options[:signal],
-        user: options[:user],
-        space: options[:space],
-        membership: options[:membership]
+        object: options[:object]
       }
       validate!
     end

data/lib/pubnub/subscribe_event/formatter.rb

@@ -173,32 +173,36 @@ module Pubnub
           Pubnub::Constants::OPERATION_SIGNAL
         elsif message[:type] == 2
           case message[:payload]['type']
-          when 'user'
+          when 'uuid'
             case message[:payload]['event']
-            when 'create'
-              Pubnub::Constants::OPERATION_CREATE_USER
-            when 'update'
-              Pubnub::Constants::OPERATION_UPDATE_USER
+            when 'set'
+              Pubnub::Constants::OPERATION_SET_UUID_METADATA
             when 'delete'
-              Pubnub::Constants::OPERATION_DELETE_USER
+              Pubnub::Constants::OPERATION_REMOVE_UUID_METADATA
             else
-              Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid event #{message[:payload]['event']}." }
-              raise Exception, "Invalid event #{message[:payload]['event']}."
+              Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid event #{message[:payload]['event']} for uuid." }
+              raise Exception, "Invalid event #{message[:payload]['event']} for uuid."
             end
-          when 'space'
+          when 'channel'
             case message[:payload]['event']
-            when 'create'
-              Pubnub::Constants::OPERATION_CREATE_SPACE
-            when 'update'
-              Pubnub::Constants::OPERATION_UPDATE_SPACE
+            when 'set'
+              Pubnub::Constants::OPERATION_SET_CHANNEL_METADATA
             when 'delete'
-              Pubnub::Constants::OPERATION_DELETE_SPACE
+              Pubnub::Constants::OPERATION_REMOVE_CHANNEL_METADATA
             else
-              Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid event #{message[:payload]['event']}." }
-              raise Exception, "Invalid event #{message[:payload]['event']}."
+              Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid event #{message[:payload]['event']} for channel." }
+              raise Exception, "Invalid event #{message[:payload]['event']} for channel."
             end
           when 'membership'
-            Pubnub::Constants::OPERATION_MANAGE_MEMBERSHIPS
+            case message[:payload]['event']
+            when 'set'
+              Pubnub::Constants::OPERATION_SET_MEMBERSHIPS
+            when 'delete'
+              Pubnub::Constants::OPERATION_REMOVE_MEMBERSHIPS
+            else
+              Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid event #{message[:payload]['event']} for membership." }
+              raise Exception, "Invalid event #{message[:payload]['event']} for membership."
+            end
           else
             Pubnub.logger.error('Pubnub::SubscribeEvent::Formatter') { "Invalid operation type #{message[:payload]['type']}." }
             raise Exception, "Invalid operation type #{message[:payload]['type']}."

data/lib/pubnub/subscriber.rb

@@ -75,12 +75,11 @@ module Pubnub
               secure_call callbacks.callbacks[:signal], envelope
             when Pubnub::Constants::OPERATION_PRESENCE
               secure_call callbacks.callbacks[:presence], envelope
-            when Pubnub::Constants::OPERATION_CREATE_USER, Pubnub::Constants::OPERATION_UPDATE_USER, Pubnub::Constants::OPERATION_DELETE_USER
-              secure_call callbacks.callbacks[:user], envelope
-            when Pubnub::Constants::OPERATION_CREATE_SPACE, Pubnub::Constants::OPERATION_UPDATE_SPACE, Pubnub::Constants::OPERATION_DELETE_SPACE
-              secure_call callbacks.callbacks[:space], envelope
-            when Pubnub::Constants::OPERATION_MANAGE_MEMBERS, Pubnub::Constants::OPERATION_MANAGE_MEMBERSHIPS
-              secure_call callbacks.callbacks[:membership], envelope
+            when Pubnub::Constants::OPERATION_SET_UUID_METADATA, Pubnub::Constants::OPERATION_REMOVE_UUID_METADATA,
+                 Pubnub::Constants::OPERATION_SET_CHANNEL_METADATA, Pubnub::Constants::OPERATION_REMOVE_CHANNEL_METADATA,
+                 Pubnub::Constants::OPERATION_SET_CHANNEL_MEMBERS, Pubnub::Constants::OPERATION_REMOVE_CHANNEL_MEMBERS,
+                 Pubnub::Constants::OPERATION_SET_MEMBERSHIPS, Pubnub::Constants::OPERATION_REMOVE_MEMBERSHIPS
+              secure_call callbacks.callbacks[:object], envelope
             else
               secure_call callbacks.callbacks[:status], envelope
             end

data/lib/pubnub/validators/get_all_channels_metadata.rb

@@ -0,0 +1,29 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for GetAllChannelsMetadata event
+    module GetAllChannelsMetadata
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for get all channels metadata event.'),
+          ':subscribe_key is required for get all channels metadata event.'
+        )
+      end
+    end
+  end
+end

data/lib/pubnub/validators/get_all_uuid_metadata.rb

@@ -0,0 +1,29 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for GetAllUuidMetadata event
+    module GetAllUuidMetadata
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for get all uuid metadata event.'),
+          ':subscribe_key is required for get all uuid metadata event.'
+        )
+      end
+    end
+  end
+end

data/lib/pubnub/validators/get_channel_members.rb

@@ -0,0 +1,39 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for GetChannelMembers event
+    module GetChannelMembers
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+        validate_channel!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for get channel members event.'),
+          ':subscribe_key is required for get channel members event.'
+        )
+      end
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':channel is required for get channel members event.'),
+          ':channel is required for get channel members event.'
+        )
+      end
+    end
+  end
+end

data/lib/pubnub/validators/get_channel_metadata.rb

@@ -0,0 +1,39 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for GetChannelMetadata event
+    module GetChannelMetadata
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+        validate_channel!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for get channel metadata event.'),
+          ':subscribe_key is required for get channel metadata event.'
+        )
+      end
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':channel is required for get channel metadata event.'),
+          ':channel is required for get channel metadata event.'
+        )
+      end
+    end
+  end
+end

data/lib/pubnub/validators/get_memberships.rb

@@ -0,0 +1,39 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for GetMemberships event
+    module GetMemberships
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+        validate_uuid!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for get memberships event.'),
+          ':subscribe_key is required for get memberships event.'
+        )
+      end
+
+      def validate_uuid!
+        return unless @uuid.nil? || @uuid.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':uuid is required for get memberships event.'),
+          ':uuid is required for get memberships event.'
+        )
+      end
+    end
+  end
+end

data/lib/pubnub/validators/get_uuid_metadata.rb

@@ -0,0 +1,39 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for GetUuidMetadata event
+    module GetUuidMetadata
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+        validate_uuid!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for get uuid metadata event.'),
+          ':subscribe_key is required for get uuid metadata event.'
+        )
+      end
+
+      def validate_uuid!
+        return unless @uuid.nil? || @uuid.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':uuid is required for get uuid metadata event.'),
+          ':uuid is required for get uuid metadata event.'
+        )
+      end
+    end
+  end
+end

data/lib/pubnub/validators/grant.rb

@@ -8,18 +8,53 @@ module Pubnub
 
       def validate!
         return if @skip_validate
+
+        validate_keys!
         validate_ttl!
+        validate_uuids!
       end
 
       private
 
+      def validate_keys!
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for grant event.'),
+          ':subscribe_key is required for grant event.'
+        ) if @subscribe_key.nil? || @subscribe_key.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':publish_key is required for grant event.'),
+          ':publish_key is required for grant event.'
+        ) if @publish_key.nil? || @publish_key.empty?
+      end
+
       def validate_ttl!
         return unless !@ttl.nil? && !@ttl.is_a?(Integer)
+
         raise(
-          ArgumentError.new,
-          ':ttl has to be kind of Integer'
+          ArgumentError.new(object: self, message: ':ttl has to be kind of Integer for grant event.'),
+          ':ttl has to be kind of Integer for grant event.'
         )
       end
+
+      def validate_uuids!
+        return if @uuid.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':uuid should not be empty for grant event.'),
+          ':uuid should not be empty for grant event.'
+        ) if @uuid.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':auth_key required for grant event on uuids.'),
+          ':uuid should not be empty for grant event on uuids.'
+        ) if @auth_key.nil? || @auth_key.blank?
+
+        raise(
+          ArgumentError.new(object: self, message: ':uuid can\'t be used along with channel/channel_groups for grant event.'),
+          ':uuid can\'t be used along with channel/channel_groups for grant event.'
+        ) if !@channels.nil? || !@channel_groups.nil?
+      end
     end
   end
 end