pubnub 4.2.6 → 4.6.0

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

@@ -34,8 +34,10 @@ module Pubnub
 
       def decipher_payload(message)
         return message[:payload] if message[:channel].end_with?('-pnpres') || (@app.env[:cipher_key].nil? && @cipher_key.nil? && @cipher_key_selector.nil? && @env[:cipher_key_selector].nil?)
-        cipher_key = compute_cipher_key(message.reject { |k, _v| k == :payload })
-        crypto = Pubnub::Crypto.new(cipher_key)
+        data = message.reject { |k, _v| k == :payload }
+        cipher_key = compute_cipher_key(data)
+        random_iv = compute_random_iv(data)
+        crypto = Pubnub::Crypto.new(cipher_key, random_iv)
         JSON.parse(crypto.decrypt(message[:payload]), quirks_mode: true)
       rescue StandardError
         message[:payload]
@@ -148,6 +150,11 @@ module Pubnub
       end
 
       def format_envelopes(response, request)
+        if response.is_a?(StandardError)
+          # unexpected error response
+          raise response
+        end
+
         parsed_response, error = Pubnub::Formatter.parse_json(response.body)
 
         error = response if parsed_response && response.code.to_i != 200
@@ -168,32 +175,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/add_channels_to_push.rb

@@ -0,0 +1,52 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for AddChannelsToPush event
+    module AddChannelsToPush
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+        validate_push_token!
+        validate_push_gateway!
+        validate_channel!
+        validate_topic! if @push_gateway.eql? 'apns2'
+      end
+
+      private
+
+      def validate_push_token!
+        return unless @push_token.nil? || @push_token.empty?
+        raise(
+          ArgumentError.new,
+          ':push_token is required for AddChannelsToPush event.'
+        )
+      end
+
+      def validate_push_gateway!
+        return unless @push_gateway.nil? || @push_gateway.empty?
+        raise(
+          ArgumentError.new,
+          ':push_gateway is required for AddChannelsToPush event.'
+        )
+      end
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+        raise(
+          ArgumentError.new,
+          ':channel is required for AddChannelsToPush event.'
+        )
+      end
+
+      def validate_topic!
+        return unless @topic.nil? || @topic.empty?
+        raise(
+          ArgumentError.new,
+          ':topic is required for AddChannelsToPush event.'
+        )
+      end
+    end
+  end
+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 @uuids.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

data/lib/pubnub/validators/list_push_provisions.rb

@@ -0,0 +1,43 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for ListPushProvisions event
+    module ListPushProvisions
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+        validate_push_token!
+        validate_push_gateway!
+        validate_topic! if @push_gateway.eql? 'apns2'
+      end
+
+      private
+
+      def validate_push_token!
+        return unless @push_token.nil? || @push_token.empty?
+        raise(
+          ArgumentError.new,
+          ':push_token is required for ListPushProvisions event.'
+        )
+      end
+
+      def validate_push_gateway!
+        return unless @push_gateway.nil? || @push_gateway.empty?
+        raise(
+          ArgumentError.new,
+          ':push_gateway is required for ListPushProvisions event.'
+        )
+      end
+
+      def validate_topic!
+        return unless @topic.nil? || @topic.empty?
+        raise(
+          ArgumentError.new,
+          ':topic is required for ListPushProvisions event.'
+        )
+      end
+    end
+  end
+end