pubnub 4.2.5 → 4.5.0

data/lib/pubnub/validators/remove_device_from_push.rb

@@ -0,0 +1,43 @@
+# Toplevel Pubnub module.
+module Pubnub
+  # Validator module that holds all validators modules
+  module Validator
+    # Validator for RemoveDeviceFromPush event
+    module RemoveDeviceFromPush
+      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 RemoveDeviceFromPush event.'
+        )
+      end
+
+      def validate_push_gateway!
+        return unless @push_gateway.nil? || @push_gateway.empty?
+        raise(
+          ArgumentError.new,
+          ':push_gateway is required for RemoveDeviceFromPush event.'
+        )
+      end
+
+      def validate_topic!
+        return unless @topic.nil? || @topic.empty?
+        raise(
+          ArgumentError.new,
+          ':topic is required for RemoveDeviceFromPush 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

data/lib/pubnub/version.rb

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

data/pubnub.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.4'
 
+  spec.add_dependency 'addressable', '>= 2.0.0'
   spec.add_dependency 'concurrent-ruby', '~> 1.1.5'
   spec.add_dependency 'concurrent-ruby-edge', '~> 0.5.0'
   spec.add_dependency 'dry-validation', '~> 1.0'
   spec.add_dependency 'httpclient', '~> 2.8', '>= 2.8.3'
   spec.add_dependency 'json', '>= 2.2.0', '< 3'
   spec.add_dependency 'timers', '>= 4.3.0'
-  spec.add_development_dependency 'bundler', '~> 1.7'
 end

data/spec/examples/add_channels_to_push_spec.rb

@@ -0,0 +1,178 @@
+require "spec_helper"
+
+describe Pubnub::AddChannelsToPush do
+  around :each do |example|
+    @fired = false
+
+    @callback = -> (_envelope) do
+      @fired = true
+    end
+
+    @pubnub = Pubnub.new(
+      subscribe_key: 'sub-a-mock-key',
+      uuid: "ruby-test-uuid-client-one",
+      auth_key: "ruby-test-auth-client-one"
+    )
+
+    @device_token = '815ee724ccb0a6a84dc303be8ccbaa00d1c84dde6bcae6721b08f92100951113'
+
+    example.run_with_retry retry: 1
+  end
+
+  it "001_channel___demo1_demo2___push_gateway___apns___push_token__valid___http_sync__true___callback__nil_" do
+    VCR.use_cassette("examples/add_channels_to_push/001", record: :once) do
+      envelope = @pubnub.add_channels_to_push(push_token: @device_token, push_gateway: 'apns', channel: 'demo1,demo2', http_sync: true)
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:add_channels_to_push)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", auth_key: "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:add_channels_to_push)
+    end
+  end
+
+  it "001_channel___demo1_demo2___push_gateway___apns___push_token__valid___http_sync__true___callback___block_" do
+    VCR.use_cassette("examples/add_channels_to_push/001", record: :once) do
+      envelope = @pubnub.add_channels_to_push(push_token: @device_token, push_gateway: 'apns', channel: 'demo1,demo2', http_sync: true, &@callback)
+
+      expect(@fired).to eq true
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:add_channels_to_push)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", auth_key: "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:add_channels_to_push)
+    end
+  end
+
+  it "001_channel___demo1_demo2___push_gateway___apns___push_token__valid___http_sync__true___callback___lambda_" do
+    VCR.use_cassette("examples/add_channels_to_push/001", record: :once) do
+      envelope = @pubnub.add_channels_to_push(push_token: @device_token, push_gateway: 'apns', channel: 'demo1,demo2', http_sync: true, callback: @callback)
+
+      expect(@fired).to eq true
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:add_channels_to_push)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", auth_key: "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:add_channels_to_push)
+    end
+  end
+
+  it "001_channel___demo1_demo2___push_gateway___apns___push_token__valid___http_sync__false___callback__nil_" do
+    VCR.use_cassette("examples/add_channels_to_push/001", record: :once) do
+      envelope = @pubnub.add_channels_to_push(push_token: @device_token, push_gateway: 'apns', channel: 'demo1,demo2', http_sync: false)
+      envelope = envelope.value
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:add_channels_to_push)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", auth_key: "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:add_channels_to_push)
+    end
+  end
+
+  it "001_channel___demo1_demo2___push_gateway___apns___push_token__valid___http_sync__false___callback___block_" do
+    VCR.use_cassette("examples/add_channels_to_push/001", record: :once) do
+      envelope = @pubnub.add_channels_to_push(push_token: @device_token, push_gateway: 'apns', channel: 'demo1,demo2', http_sync: false, &@callback)
+      envelope = envelope.value
+
+      expect(@fired).to eq true
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:add_channels_to_push)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", auth_key: "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:add_channels_to_push)
+    end
+  end
+
+  it "001_channel___demo1_demo2___push_gateway___apns___push_token__valid___http_sync__false___callback___lambda_" do
+    VCR.use_cassette("examples/add_channels_to_push/001", record: :once) do
+      envelope = @pubnub.add_channels_to_push(push_token: @device_token, push_gateway: 'apns', channel: 'demo1,demo2', http_sync: false, callback: @callback)
+      envelope = envelope.value
+
+      expect(@fired).to eq true
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:add_channels_to_push)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", auth_key: "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:add_channels_to_push)
+    end
+  end
+
+  it "002_channel___demo1_demo2___push_gateway___apns2___push_token__valid___topic__ruby_test___environment__default___http_sync__true___callback__nil_" do
+    VCR.use_cassette("examples/add_channels_to_push/002", record: :once) do
+      envelope = @pubnub.add_channels_to_push(push_token: @device_token, push_gateway: 'apns2', channel: 'demo1,demo2', topic: 'ruby_test', http_sync: true)
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:add_channels_to_push)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", auth_key: "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:add_channels_to_push)
+    end
+  end
+
+  it "003_channel___demo1_demo2___push_gateway___apns2___push_token__valid___topic__ruby_test___environment__production___http_sync__true___callback__nil_" do
+    VCR.use_cassette("examples/add_channels_to_push/003", record: :once) do
+      envelope = @pubnub.add_channels_to_push(push_token: @device_token, push_gateway: 'apns2', channel: 'demo1,demo2', topic: 'ruby_test', environment: 'production', http_sync: true)
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:add_channels_to_push)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", auth_key: "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+
+      expect(envelope.result[:code]).to eq(200)
+      expect(envelope.result[:operation]).to eq(:add_channels_to_push)
+    end
+  end
+
+  it "004_channel___demo1_demo2___push_gateway___apns2___push_token__invalid___topic__ruby_test___environment__production___http_sync__true___callback__nil_" do
+    VCR.use_cassette("examples/add_channels_to_push/004", record: :once) do
+      envelope = @pubnub.add_channels_to_push(push_token: "invalid_token", push_gateway: 'apns2', channel: 'demo1,demo2', topic: 'ruby_test', environment: 'production', http_sync: true)
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq true
+
+      expect(envelope.status[:code]).to eq(400)
+      expect(envelope.status[:operation]).to eq(:add_channels_to_push)
+      expect(envelope.status[:category]).to eq(:error)
+      expect(envelope.status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", auth_key: "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
+    end
+  end
+end