pubnub 4.5.0 → 4.6.0

data/spec/examples/set_channel_metadata_examples_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe Pubnub::HereNow do
+  around :each do |example|
+    @fired = false
+
+    @callback = -> (_envelope) do
+      @fired = true
+    end
+
+    @pubnub = Pubnub.new(
+      publish_key: "pub-a-mock-key",
+      subscribe_key: 'sub-a-mock-key',
+      uuid: "ruby-test-uuid-client-one",
+      auth_key: "ruby-test-auth-client-one",
+      random_iv: false
+    )
+
+    example.run_with_retry retry: 10
+  end
+
+  it "__channel__channel___metadata__name_some_name___include__custom___http_sync__true___cipher_key__nil___random_iv__false___callback__lambda_" do
+    VCR.use_cassette("examples/channel_metadata/001", record: :once) do
+      envelope = @pubnub.set_channel_metadata(
+        channel: 'channel',
+        metadata: { name: 'some_name' },
+        include: { custom: true },
+        http_sync: true,
+        callback: @callback
+      )
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+      expect(@fired).to eq true
+      expect(@pubnub.env[:random_iv]).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:set_channel_metadata)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:client_request].path.split('/').last).to eq("channel")
+      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
+
+  it "__channel__channel___metadata__name_some_name___include__nil___http_sync__true___cipher_key__enigma___random_iv__false___callback__nil_" do
+    VCR.use_cassette("examples/channel_metadata/002", record: :once) do
+      pubnub = Pubnub.new(
+        publish_key: "pub-a-mock-key",
+        subscribe_key: 'sub-a-mock-key',
+        uuid: "ruby-test-uuid-client-one",
+        auth_key: "ruby-test-auth-client-one",
+        random_iv: false,
+        cipher_key: "enigma"
+      )
+
+      envelope = pubnub.set_channel_metadata(channel: 'channel', metadata: { name: 'some_name' }, http_sync: true)
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+      expect(pubnub.env[:random_iv]).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:set_channel_metadata)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:client_request].path.split('/').last).to eq("channel")
+      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
+
+  it "__channel__channel___metadata__name_some_name___include__nil___http_sync__true___cipher_key__enigma___random_iv__true___callback__nil_" do
+    VCR.use_cassette("examples/channel_metadata/003", record: :once) do
+      pubnub = Pubnub.new(
+        publish_key: "pub-a-mock-key",
+        subscribe_key: 'sub-a-mock-key',
+        uuid: "ruby-test-uuid-client-one",
+        auth_key: "ruby-test-auth-client-one",
+        cipher_key: "enigma"
+      )
+
+      envelope = pubnub.set_channel_metadata(channel: 'channel', metadata: { name: 'some_name' }, http_sync: true)
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+      expect(pubnub.env[:random_iv]).to eq true
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:set_channel_metadata)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:client_request].path.split('/').last).to eq("channel")
+      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

data/spec/examples/set_memberships_examples_spec.rb

@@ -0,0 +1,122 @@
+require "spec_helper"
+
+describe Pubnub::HereNow do
+  around :each do |example|
+    @fired = false
+
+    @callback = -> (_envelope) do
+      @fired = true
+    end
+
+    @pubnub = Pubnub.new(
+      publish_key: "pub-a-mock-key",
+      subscribe_key: 'sub-a-mock-key',
+      uuid: "ruby-test-uuid-client-one",
+      auth_key: "ruby-test-auth-client-one",
+      random_iv: false
+    )
+
+    example.run_with_retry retry: 10
+  end
+
+  it "__uuid__nil___channels__channel___include__count___http_sync__true___cipher_key__nil___random_iv__false___callback__lambda_" do
+    VCR.use_cassette("examples/memberships/001", record: :once) do
+      @pubnub.set_channel_metadata(channel: 'channel', metadata: { name: 'some_name' }, http_sync: true)
+      @pubnub.set_uuid_metadata(uuid: nil, metadata: { name: 'magnum' }, http_sync: true)
+      envelope = @pubnub.set_memberships(
+        uuid: nil,
+        channels: [{ channel: 'channel' }],
+        include: { count: true },
+        http_sync: true,
+        callback: @callback
+      )
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+      expect(@fired).to eq true
+      expect(@pubnub.env[:random_iv]).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:set_memberships)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:client_request].path.split('/')[-2]).to eq("ruby-test-uuid-client-one")
+      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
+
+  it "__uuid__bob___channels__channel___include__count___http_sync__true___cipher_key__nil___random_iv__false___callback__nil_" do
+    VCR.use_cassette("examples/memberships/002", record: :once) do
+      @pubnub.set_channel_metadata(channel: 'channel', metadata: { name: 'some_name' }, http_sync: true)
+      @pubnub.set_uuid_metadata(uuid: 'bob', metadata: { name: 'magnum' }, http_sync: true)
+      envelope = @pubnub.set_memberships(
+        uuid: 'bob',
+        channels: [{ channel: 'channel' }],
+        include: { count: true },
+        http_sync: true
+      )
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+      expect(@pubnub.env[:random_iv]).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:set_memberships)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:client_request].path.split('/')[-2]).to eq("bob")
+      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
+
+  it "__uuid__bob___channels__channel___include__nil___http_sync__true___cipher_key__enigma___random_iv__false___callback__nil_" do
+    VCR.use_cassette("examples/memberships/003", record: :once) do
+      @pubnub.set_channel_metadata(channel: 'channel', metadata: { name: 'some_name' }, http_sync: true)
+      @pubnub.set_uuid_metadata(uuid: 'bob', metadata: { name: 'magnum' }, http_sync: true)
+      pubnub = Pubnub.new(
+        publish_key: "pub-a-mock-key",
+        subscribe_key: 'sub-a-mock-key',
+        uuid: "ruby-test-uuid-client-one",
+        auth_key: "ruby-test-auth-client-one",
+        random_iv: false,
+        cipher_key: "enigma"
+      )
+
+      envelope = pubnub.set_memberships(uuid: 'bob', channels: [{ channel: 'channel' }], http_sync: true)
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+      expect(pubnub.env[:random_iv]).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:set_memberships)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:client_request].path.split('/')[-2]).to eq("bob")
+      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
+
+  it "__uuid__bob___channels__channel___include__nil___http_sync__true___cipher_key__enigma___random_iv__true___callback__nil_" do
+    VCR.use_cassette("examples/memberships/004", record: :once) do
+      @pubnub.set_channel_metadata(channel: 'channel', metadata: { name: 'some_name' }, http_sync: true)
+      @pubnub.set_uuid_metadata(uuid: 'bob', metadata: { name: 'magnum' }, http_sync: true)
+      pubnub = Pubnub.new(
+        publish_key: "pub-a-mock-key",
+        subscribe_key: 'sub-a-mock-key',
+        uuid: "ruby-test-uuid-client-one",
+        auth_key: "ruby-test-auth-client-one",
+        cipher_key: "enigma"
+      )
+
+      envelope = pubnub.set_memberships(uuid: 'bob', channels: [{ channel: 'channel' }], http_sync: true)
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+      expect(pubnub.env[:random_iv]).to eq true
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:set_memberships)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:client_request].path.split('/')[-2]).to eq("bob")
+      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

data/spec/examples/set_uuid_metadata_examples_spec.rb

@@ -0,0 +1,114 @@
+require "spec_helper"
+
+describe Pubnub::HereNow do
+  around :each do |example|
+    @fired = false
+
+    @callback = -> (_envelope) do
+      @fired = true
+    end
+
+    @pubnub = Pubnub.new(
+      publish_key: "pub-a-mock-key",
+      subscribe_key: 'sub-a-mock-key',
+      uuid: "ruby-test-uuid-client-one",
+      auth_key: "ruby-test-auth-client-one",
+      random_iv: false
+    )
+
+    example.run_with_retry retry: 10
+  end
+
+  it "__uuid__nil___metadata__name_magnum___include__custom___http_sync__true___cipher_key__nil___random_iv__false___callback__lambda_" do
+    VCR.use_cassette("examples/uuid_metadata/001", record: :once) do
+      envelope = @pubnub.set_uuid_metadata(
+        uuid: nil,
+        metadata: { name: 'magnum' },
+        include: { custom: true },
+        http_sync: true,
+        callback: @callback
+      )
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+      expect(@fired).to eq true
+      expect(@pubnub.env[:random_iv]).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:set_uuid_metadata)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:client_request].path.split('/').last).to eq("ruby-test-uuid-client-one")
+      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
+
+  it "__uuid__bob___metadata__name_magnum___include__custom___http_sync__true___cipher_key__nil___random_iv__false___callback__nil_" do
+    VCR.use_cassette("examples/uuid_metadata/002", record: :once) do
+      envelope = @pubnub.set_uuid_metadata(
+        uuid: 'bob',
+        metadata: { name: 'magnum' },
+        include: { custom: true },
+        http_sync: true
+      )
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+      expect(@pubnub.env[:random_iv]).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:set_uuid_metadata)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:client_request].path.split('/').last).to eq("bob")
+      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
+
+  it "__uuid__bob___metadata__name_magnum___include__nil___http_sync__true___cipher_key__enigma___random_iv__false___callback__nil_" do
+    VCR.use_cassette("examples/uuid_metadata/003", record: :once) do
+      pubnub = Pubnub.new(
+        publish_key: "pub-a-mock-key",
+        subscribe_key: 'sub-a-mock-key',
+        uuid: "ruby-test-uuid-client-one",
+        auth_key: "ruby-test-auth-client-one",
+        random_iv: false,
+        cipher_key: "enigma"
+      )
+
+      envelope = pubnub.set_uuid_metadata(uuid: 'bob', metadata: { name: 'magnum' }, http_sync: true)
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+      expect(pubnub.env[:random_iv]).to eq false
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:set_uuid_metadata)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:client_request].path.split('/').last).to eq("bob")
+      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
+
+  it "__uuid__bob___metadata__name_magnum___include__nil___http_sync__true___cipher_key__enigma___random_iv__true___callback__nil_" do
+    VCR.use_cassette("examples/uuid_metadata/004", record: :once) do
+      pubnub = Pubnub.new(
+        publish_key: "pub-a-mock-key",
+        subscribe_key: 'sub-a-mock-key',
+        uuid: "ruby-test-uuid-client-one",
+        auth_key: "ruby-test-auth-client-one",
+        cipher_key: "enigma"
+      )
+
+      envelope = pubnub.set_uuid_metadata(uuid: 'bob', metadata: { name: 'magnum' }, http_sync: true)
+
+      expect(envelope.is_a?(Pubnub::Envelope)).to eq true
+      expect(envelope.error?).to eq false
+      expect(pubnub.env[:random_iv]).to eq true
+
+      expect(envelope.status[:code]).to eq(200)
+      expect(envelope.status[:operation]).to eq(:set_uuid_metadata)
+      expect(envelope.status[:category]).to eq(:ack)
+      expect(envelope.status[:client_request].path.split('/').last).to eq("bob")
+      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

data/spec/examples/subscribe_examples_1_spec.rb

@@ -14,7 +14,7 @@ describe Pubnub::Subscribe do
   end
 
   let(:pubnub_cipher_params) do
-    pubnub_params.merge({cipher_key: "super-secret-cipher-key"})
+    pubnub_params.merge({cipher_key: "super-secret-cipher-key", random_iv: false})
   end
 
   let(:pubnub) { Pubnub.new(**pubnub_params) }
@@ -17458,7 +17458,7 @@ describe Pubnub::Subscribe do
         expect(@status_envelopes[0].status[:subscribed_channel_groups]).to eq([])
         expect(@status_envelopes[0].status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", :auth_key => "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
         true
-      end 
+      end
     end
   end
 

data/spec/examples/subscribe_examples_2_spec.rb

@@ -14,7 +14,7 @@ describe Pubnub::Subscribe do
   end
 
   let(:pubnub_cipher_params) do
-    pubnub_params.merge({cipher_key: "super-secret-cipher-key"})
+    pubnub_params.merge({cipher_key: "super-secret-cipher-key", random_iv: false})
   end
 
   let(:pubnub) { Pubnub.new(**pubnub_params) }
@@ -853,7 +853,7 @@ describe Pubnub::Subscribe do
         expect(envelopes[0].result[:data]).to eq({:message => "ruby is awesome", :subscribed_channel => "demo", :actual_channel => "demo", :publish_time_object => {:timetoken => "14654009949699093", :region_code => 12}, :message_meta_data => nil, :presence_event => nil, :presence => nil})
       end
     end
-    
+
     it "__channel___demo____presence__nil___channel_group__nil___http_sync__true___callback___block_cipherkeysuper-secret-cipher-key" do
 
       VCR.use_cassette("examples/subscribe/265", record: :none) do
@@ -933,7 +933,7 @@ describe Pubnub::Subscribe do
           expect(@status_envelopes[0].status[:subscribed_channel_groups]).to eq([])
           expect(@status_envelopes[0].status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", :auth_key => "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
           true
-        end 
+        end
       end
     end
 
@@ -16177,7 +16177,7 @@ describe Pubnub::Subscribe do
           expect(@status_envelopes[0].status[:subscribed_channel_groups]).to eq([])
           expect(@status_envelopes[0].status[:config]).to eq({:tls => false, :uuid => "ruby-test-uuid-client-one", :auth_key => "ruby-test-auth-client-one", :origin => "ps.pndsn.com"})
           true
-        end 
+        end
       end
     end
 

data/spec/lib/events/subscribe_spec.rb

@@ -69,6 +69,7 @@ describe Pubnub::Subscribe do
           publish_key: "demo",
           uuid: "ruby-test-uuid",
           cipher_key: "demo",
+          random_iv: false
         )
 
         @pubnub.add_listener(callback: @callbacks)
@@ -244,6 +245,7 @@ describe Pubnub::Subscribe do
           publish_key: "demo",
           uuid: "ruby-test-uuid",
           cipher_key: "demo",
+          random_iv: false
         )
 
         VCR.use_cassette("lib/events/subscribe-cipher-async", record: :once) do

data/spec/lib/multiple_ciphers_spec.rb

@@ -6,7 +6,7 @@ describe "Using multiple cipher keys" do
   end
 
   it "works with publish" do
-    @pubnub = Pubnub.new(subscribe_key: :demo, publish_key: :demo, cipher_key: "this_doesnt_fit_anywhere")
+    @pubnub = Pubnub.new(subscribe_key: :demo, publish_key: :demo, cipher_key: "this_doesnt_fit_anywhere", random_iv: false)
 
     VCR.use_cassette("lib/multiple_ciphers", record: :once) do
       # Fetch current timestamp
@@ -16,12 +16,14 @@ describe "Using multiple cipher keys" do
         channel: :multiple_cipher_test,
         message: "Some test message",
         cipher_key: "super_secret",
+        random_iv: false,
         http_sync: true,
       )
 
       e0 = @pubnub.subscribe(
         channel: :multiple_cipher_test,
         cipher_key: "super_secret",
+        random_iv: false,
         http_sync: true,
       ).first
 
@@ -29,12 +31,14 @@ describe "Using multiple cipher keys" do
         channel: :multiple_cipher_test,
         message: "Another test message",
         cipher_key: "another_secret",
+        random_iv: false,
         http_sync: true,
       )
 
       e1 = @pubnub.subscribe(
         channel: :multiple_cipher_test,
         cipher_key: "another_secret",
+        random_iv: false,
         http_sync: true,
       ).first
 
@@ -44,19 +48,21 @@ describe "Using multiple cipher keys" do
   end
 
   it "works with history" do
-    @pubnub = Pubnub.new(subscribe_key: :demo, publish_key: :demo, cipher_key: "this_doesnt_fit_anywhere")
+    @pubnub = Pubnub.new(subscribe_key: :demo, publish_key: :demo, cipher_key: "this_doesnt_fit_anywhere", random_iv: false)
 
     VCR.use_cassette("lib/multiple_ciphers_history", record: :once) do
       @pubnub.publish(
         channel: :multiple_cipher_test,
         message: "Some test message",
         cipher_key: "super_secret",
+        random_iv: false,
         http_sync: true,
       )
 
       e0 = @pubnub.history(
         channel: :multiple_cipher_test,
         cipher_key: "super_secret",
+        random_iv: false,
         count: 1,
         http_sync: true,
       )
@@ -65,12 +71,14 @@ describe "Using multiple cipher keys" do
         channel: :multiple_cipher_test,
         message: "Another test message",
         cipher_key: "another_secret",
+        random_iv: false,
         http_sync: true,
       )
 
       e1 = @pubnub.history(
         channel: :multiple_cipher_test,
         cipher_key: "another_secret",
+        random_iv: false,
         count: 1,
         http_sync: true,
       )
@@ -81,19 +89,21 @@ describe "Using multiple cipher keys" do
   end
 
   it "works with async history" do
-    @pubnub = Pubnub.new(subscribe_key: :demo, publish_key: :demo, cipher_key: "this_doesnt_fit_anywhere")
+    @pubnub = Pubnub.new(subscribe_key: :demo, publish_key: :demo, cipher_key: "this_doesnt_fit_anywhere", random_iv: false)
 
     VCR.use_cassette("lib/multiple_ciphers_history", record: :once) do
       @pubnub.publish(
         channel: :multiple_cipher_test,
         message: "Some test message",
         cipher_key: "super_secret",
+        random_iv: false,
         http_sync: true,
       )
 
       e0 = @pubnub.history(
         channel: :multiple_cipher_test,
         cipher_key: "super_secret",
+        random_iv: false,
         count: 1,
       ).value
 
@@ -101,12 +111,14 @@ describe "Using multiple cipher keys" do
         channel: :multiple_cipher_test,
         message: "Another test message",
         cipher_key: "another_secret",
+        random_iv: false,
         http_sync: true,
       )
 
       e1 = @pubnub.history(
         channel: :multiple_cipher_test,
         cipher_key: "another_secret",
+        random_iv: false,
         count: 1,
       ).value
 
@@ -129,7 +141,7 @@ describe "Using multiple cipher keys" do
       ciphers[data[:issuing_client_id]]
     end
 
-    @pubnub = Pubnub.new(subscribe_key: :demo, publish_key: :demo, cipher_key_selector: lambda_cipher_key)
+    @pubnub = Pubnub.new(subscribe_key: :demo, publish_key: :demo, cipher_key_selector: lambda_cipher_key, random_iv: false)
     @pubnub.add_listener(callback: cb)
 
     VCR.use_cassette("lib/callable_cipher_key", record: :once) do