pubnub 4.3.0 → 4.4.0

data/lib/pubnub/validators/remove_channel_members.rb

@@ -0,0 +1,52 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for RemoveChannelMembers event
+    module RemoveChannelMembers
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+        validate_channel!
+        validate_members!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for remove channel members event.'),
+          ':subscribe_key is required for remove channel members event.'
+        )
+      end
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':channel is required for remove channel members event.'),
+          ':channel is required for remove channel members event.'
+        )
+      end
+
+      def validate_members!
+        raise(
+          ArgumentError.new(object: self, message: ':uuids is required for remove channel members event.'),
+          ':uuids is required for remove channel members event.'
+        ) if @uuids.nil? || @uuids.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':uuids parameter for remove channel members must be Array.'),
+          ':uuids parameter for remove channel members must be Array.'
+        ) if @uuids.class != Array
+      end
+    end
+  end
+end

data/lib/pubnub/validators/remove_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 RemoveChannelMetadata event
+    module RemoveChannelMetadata
+      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 remove channel metadata event.'),
+          ':subscribe_key is required for remove channel metadata event.'
+        )
+      end
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':channel is required for remove channel metadata event.'),
+          ':channel is required for remove channel metadata event.'
+        )
+      end
+    end
+  end
+end

data/lib/pubnub/validators/remove_memberships.rb

@@ -0,0 +1,52 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for RemoveMemberships event
+    module RemoveMemberships
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+        validate_uuid!
+        validate_memberships!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for remove memberships event.'),
+          ':subscribe_key is required for remove memberships event.'
+        )
+      end
+
+      def validate_uuid!
+        return unless @uuid.nil? || @uuid.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':uuid is required for remove memberships event.'),
+          ':uuid is required for remove memberships event.'
+        )
+      end
+
+      def validate_memberships!
+        raise(
+          ArgumentError.new(object: self, message: ':channels is required for remove memberships event.'),
+          ':channels is required for remove memberships event.'
+        ) if @channels.nil? || @channels.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':channels parameter for remove memberships must be Array.'),
+          ':channels parameter for remove memberships must be Array.'
+        ) if @channels.class != Array
+      end
+    end
+  end
+end

data/lib/pubnub/validators/remove_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 RemoveUuidMetadata event
+    module RemoveUuidMetadata
+      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 remove uuid metadata event.'),
+          ':subscribe_key is required for remove uuid metadata event.'
+        )
+      end
+
+      def validate_uuid!
+        return unless @uuid.nil? || @uuid.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':uuid is required for remove uuid metadata event.'),
+          ':uuid is required for remove uuid metadata event.'
+        )
+      end
+    end
+  end
+end

data/lib/pubnub/validators/set_channel_members.rb

@@ -0,0 +1,78 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for SetChannelMembers event
+    module SetChannelMembers
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+        validate_channel!
+        validate_members!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for set channel members event.'),
+          ':subscribe_key is required for set channel members event.'
+        )
+      end
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':channel is required for set channel members event.'),
+          ':channel is required for set channel members event.'
+        )
+      end
+
+      def validate_members!
+        raise(
+          ArgumentError.new(object: self, message: ':uuids is required for set channel members event.'),
+          ':uuids is required for set channel members event.'
+        ) if @uuids.nil? || @uuids.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':uuids parameter for set channel members must be Array.'),
+          ':uuids parameter for set channel members must be Array.'
+        ) if @uuids.class != Array
+
+        acceptable_values = %w[String Symbol Float Integer TrueClass FalseClass]
+
+        @uuids.each do |member|
+          raise(
+            ArgumentError.new(object: self, message: ':uuid is required for set channel members event.'),
+            ':uuid is required for set channel members event.'
+          ) if member[:uuid].nil? || member[:uuid].empty?
+
+          next if member[:custom].nil?
+
+          raise(
+            ArgumentError.new(object: self, message: ':custom parameter of channel member must be Hash.'),
+            ':custom parameter of channel member must be Hash.'
+          ) if member[:custom].class != Hash
+
+          # Verify that all values in member custom has expected data type.
+          member[:custom].each do |key, value|
+            unless acceptable_values.include?(value.class.to_s)
+              message = "Value for '#{key}' has unacceptable type (#{value.class.to_s})." \
+                        "Only following data types allowed: #{acceptable_values.join(", ")}"
+
+              raise(ArgumentError.new(object: self, message: message), message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pubnub/validators/set_channel_metadata.rb

@@ -0,0 +1,62 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for SetChannelMetadata event
+    module SetChannelMetadata
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+        validate_channel!
+        validate_metadata!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for set channel metadata event.'),
+          ':subscribe_key is required for set channel metadata event.'
+        )
+      end
+
+      def validate_channel!
+        return unless @channel.nil? || @channel.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':channel is required for set channel metadata event.'),
+          ':channel is required for set channel metadata event.'
+        )
+      end
+
+      def validate_metadata!
+        raise(
+          ArgumentError.new(object: self, message: ':metadata is required for set channel metadata event.'),
+          ':metadata is required for set channel metadata event.'
+        ) if @metadata.nil? || @metadata.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':metadata parameter for set channel metadata must be Hash.'),
+          ':metadata parameter for set channel metadata must be Hash.'
+        ) if @metadata.class != Hash
+
+        known_channel_metadata_fields = %w[name description custom updated eTag]
+
+        @metadata.each_key do |field_name|
+          unless known_channel_metadata_fields.include?(field_name.to_s)
+            message = "Unknown channel metadata key: '#{field_name}'. Only following keys allowed: #{known_channel_metadata_fields.join(", ")}"
+
+            raise(ArgumentError.new(object: self, message: message), message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pubnub/validators/set_memberships.rb

@@ -0,0 +1,78 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for SetMemberships event
+    module SetMemberships
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+        validate_uuid!
+        validate_memberships!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for set memberships event.'),
+          ':subscribe_key is required for set memberships event.'
+        )
+      end
+
+      def validate_uuid!
+        return unless @uuid.nil? || @uuid.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':uuid is required for set memberships event.'),
+          ':uuid is required for set memberships event.'
+        )
+      end
+
+      def validate_memberships!
+        raise(
+          ArgumentError.new(object: self, message: ':channels is required for set memberships event.'),
+          ':channels is required for set memberships event.'
+        ) if @channels.nil? || @channels.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':channels parameter for set memberships must be Array.'),
+          ':channels parameter for set memberships must be Array.'
+        ) if @channels.class != Array
+
+        acceptable_values = %w[String Symbol Float Integer TrueClass FalseClass]
+
+        @channels.each do |membership|
+          raise(
+            ArgumentError.new(object: self, message: ':channel is required for set memberships event.'),
+            ':channel is required for set memberships event.'
+          ) if membership[:channel].nil? || membership[:channel].empty?
+
+          next if membership[:custom].nil?
+
+          raise(
+            ArgumentError.new(object: self, message: ':custom parameter of membership must be Hash.'),
+            ':custom parameter of membership must be Hash.'
+          ) if membership[:custom].class != Hash
+
+          # Verify that all values in membership 'custom' has expected data type.
+          membership[:custom].each do |key, value|
+            unless acceptable_values.include?(value.class.to_s)
+              message = "Value for '#{key}' has unacceptable type (#{value.class.to_s})." \
+                        "Only following data types allowed: #{acceptable_values.join(", ")}"
+
+              raise(ArgumentError.new(object: self, message: message), message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pubnub/validators/set_uuid_metadata.rb

@@ -0,0 +1,62 @@
+# Toplevel Pubnub module.
+# frozen_string_literal: true
+
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for SetUuidMetadata event
+    module SetUuidMetadata
+      include CommonValidator
+
+      def validate!
+        return if @skip_validate
+
+        validate_subscribe_key!
+        validate_uuid!
+        validate_metadata!
+      end
+
+      private
+
+      def validate_subscribe_key!
+        return unless @subscribe_key.nil?
+
+        raise(
+          ArgumentError.new(object: self, message: ':subscribe_key is required for set uuid metadata event.'),
+          ':subscribe_key is required for set uuid metadata event.'
+        )
+      end
+
+      def validate_uuid!
+        return unless @uuid.nil? || @uuid.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':uuid is required for set uuid metadata event.'),
+          ':uuid is required for set uuid metadata event.'
+        )
+      end
+
+      def validate_metadata!
+        raise(
+          ArgumentError.new(object: self, message: ':metadata is required for set uuid metadata event.'),
+          ':metadata is required for set uuid metadata event.'
+        ) if @metadata.nil? || @metadata.empty?
+
+        raise(
+          ArgumentError.new(object: self, message: ':metadata parameter for set uuid metadata must be Hash.'),
+          ':metadata parameter for set uuid metadata must be Hash.'
+        ) if @metadata.class != Hash
+
+        known_uuid_metadata_fields = %w[name email externalId profileUrl custom updated eTag]
+
+        @metadata.each_key do |field_name|
+          unless known_uuid_metadata_fields.include?(field_name.to_s)
+            message = "Unknown uuid metadata key: '#{field_name}'. Only following keys allowed: #{known_uuid_metadata_fields.join(", ")}"
+
+            raise(ArgumentError.new(object: self, message: message), message)
+          end
+        end
+      end
+    end
+  end
+end