pusher 1.3.3 → 2.0.0

data/spec/client_spec.rb

@@ -1,7 +1,12 @@
-require 'spec_helper'
+require 'base64'
 
+require 'rbnacl'
 require 'em-http'
 
+require 'spec_helper'
+
+encryption_master_key = RbNaCl::Random.random_bytes(32)
+
 describe Pusher do
   # The behaviour should be the same when using the Client object, or the
   # 'global' client delegated through the Pusher class
@@ -12,11 +17,11 @@ describe Pusher do
 
     describe 'default configuration' do
       it 'should be preconfigured for api host' do
-        expect(@client.host).to eq('api.pusherapp.com')
+        expect(@client.host).to eq('api-mt1.pusher.com')
       end
 
-      it 'should be preconfigured for port 80' do
-        expect(@client.port).to eq(80)
+      it 'should be preconfigured for port 443' do
+        expect(@client.port).to eq(443)
       end
 
       it 'should use standard logger if no other logger if defined' do
@@ -74,6 +79,16 @@ describe Pusher do
         expect(@client.host).to eq('api-eu.pusher.com')
       end
 
+      it 'should handle nil gracefully' do
+        @client.cluster = nil
+        expect(@client.host).to eq('api-mt1.pusher.com')
+      end
+
+      it 'should handle empty string' do
+        @client.cluster = ""
+        expect(@client.host).to eq('api-mt1.pusher.com')
+      end
+
       it 'should be overridden by host if it comes after' do
         @client.cluster = 'eu'
         @client.host = 'api.staging.pusher.com'
@@ -101,26 +116,26 @@ describe Pusher do
     end
 
     describe 'configuring TLS' do
-      it 'should set port and scheme if "use_tls" enabled' do
+      it 'should set port and scheme if "use_tls" disabled' do
         client = Pusher::Client.new({
-          :use_tls => true,
+          :use_tls => false,
         })
-        expect(client.scheme).to eq('https')
-        expect(client.port).to eq(443)
+        expect(client.scheme).to eq('http')
+        expect(client.port).to eq(80)
       end
 
-      it 'should set port and scheme if "encrypted" enabled' do
+      it 'should set port and scheme if "encrypted" disabled' do
         client = Pusher::Client.new({
-          :encrypted => true,
+          :encrypted => false,
         })
-        expect(client.scheme).to eq('https')
-        expect(client.port).to eq(443)
+        expect(client.scheme).to eq('http')
+        expect(client.port).to eq(80)
       end
 
-      it 'should use non-TLS port and scheme if "encrypted" or "use_tls" are not set' do
+      it 'should use TLS port and scheme if "encrypted" or "use_tls" are not set' do
         client = Pusher::Client.new
-        expect(client.scheme).to eq('http')
-        expect(client.port).to eq(80)
+        expect(client.scheme).to eq('https')
+        expect(client.port).to eq(443)
       end
 
       it 'should override port if "use_tls" option set but a different port is specified' do
@@ -132,6 +147,15 @@ describe Pusher do
         expect(client.port).to eq(8443)
       end
 
+      it 'should override port if "use_tls" option set but a different port is specified' do
+        client = Pusher::Client.new({
+          :use_tls => false,
+          :port => 8000
+        })
+        expect(client.scheme).to eq('http')
+        expect(client.port).to eq(8000)
+      end
+
     end
 
     describe 'configuring a http proxy' do
@@ -171,11 +195,22 @@ describe Pusher do
       end
     end
 
+    describe 'can set encryption_master_key_base64' do
+      it "sets encryption_master_key" do
+        @client.encryption_master_key_base64 =
+          Base64.strict_encode64(encryption_master_key)
+
+        expect(@client.encryption_master_key).to eq(encryption_master_key)
+      end
+    end
+
     describe 'when configured' do
       before :each do
         @client.app_id = '20'
         @client.key    = '12345678900000001'
         @client.secret = '12345678900000001'
+        @client.encryption_master_key_base64 =
+          Base64.strict_encode64(encryption_master_key)
       end
 
       describe '#[]' do
@@ -260,6 +295,19 @@ describe Pusher do
           })
         end
 
+        it 'should include a shared_secret if the private-encrypted channel' do
+          allow(MultiJson).to receive(:encode).with(@custom_data).and_return 'a json string'
+          @client.instance_variable_set(:@encryption_master_key, '3W1pfB/Etr+ZIlfMWwZP3gz8jEeCt4s2pe6Vpr+2c3M=')
+
+          response = @client.authenticate('private-encrypted-test_channel', '1.1', @custom_data)
+
+          expect(response).to eq({
+            :auth => "12345678900000001:#{hmac(@client.secret, "1.1:private-encrypted-test_channel:a json string")}",
+            :shared_secret => "o0L3QnIovCeRC8KTD8KBRlmi31dGzHVS2M93uryqDdw=",
+            :channel_data => 'a json string'
+          })
+        end
+
       end
 
       describe '#trigger' do
@@ -321,6 +369,46 @@ describe Pusher do
             }
           end
         end
+
+        it "should fail to publish to encrypted channels when missing key" do
+          @client.encryption_master_key_base64 = nil
+          expect {
+            @client.trigger('private-encrypted-channel', 'event', {'some' => 'data'})
+          }.to raise_error(Pusher::ConfigurationError)
+          expect(WebMock).not_to have_requested(:post, @api_path)
+        end
+
+        it "should fail to publish to multiple channels if one is encrypted" do
+          expect {
+            @client.trigger(
+              ['private-encrypted-channel', 'some-other-channel'],
+              'event',
+              {'some' => 'data'},
+            )
+          }.to raise_error(Pusher::Error)
+          expect(WebMock).not_to have_requested(:post, @api_path)
+        end
+
+        it "should encrypt publishes to encrypted channels" do
+          @client.trigger(
+            'private-encrypted-channel',
+            'event',
+            {'some' => 'data'},
+          )
+
+          expect(WebMock).to have_requested(:post, @api_path).with { |req|
+            data = MultiJson.decode(MultiJson.decode(req.body)["data"])
+
+            key = RbNaCl::Hash.sha256(
+              'private-encrypted-channel' + encryption_master_key
+            )
+
+            expect(MultiJson.decode(RbNaCl::SecretBox.new(key).decrypt(
+              Base64.strict_decode64(data["nonce"]),
+              Base64.strict_decode64(data["ciphertext"]),
+            ))).to eq({ 'some' => 'data' })
+          }
+        end
       end
 
       describe '#trigger_batch' do
@@ -352,6 +440,55 @@ describe Pusher do
             )
           }
         end
+
+        it "should fail to publish to encrypted channels when missing key" do
+          @client.encryption_master_key_base64 = nil
+          expect {
+            @client.trigger_batch(
+              {
+                channel: 'private-encrypted-channel',
+                name: 'event',
+                data: {'some' => 'data'},
+              },
+              {channel: 'mychannel', name: 'event', data: 'already encoded'},
+            )
+          }.to raise_error(Pusher::ConfigurationError)
+          expect(WebMock).not_to have_requested(:post, @api_path)
+        end
+
+        it "should encrypt publishes to encrypted channels" do
+          @client.trigger_batch(
+            {
+              channel: 'private-encrypted-channel',
+              name: 'event',
+              data: {'some' => 'data'},
+            },
+            {channel: 'mychannel', name: 'event', data: 'already encoded'},
+          )
+
+          expect(WebMock).to have_requested(:post, @api_path).with { |req|
+            batch = MultiJson.decode(req.body)["batch"]
+            expect(batch.length).to eq(2)
+
+            expect(batch[0]["channel"]).to eq("private-encrypted-channel")
+            expect(batch[0]["name"]).to eq("event")
+
+            data = MultiJson.decode(batch[0]["data"])
+
+            key = RbNaCl::Hash.sha256(
+              'private-encrypted-channel' + encryption_master_key
+            )
+
+            expect(MultiJson.decode(RbNaCl::SecretBox.new(key).decrypt(
+              Base64.strict_decode64(data["nonce"]),
+              Base64.strict_decode64(data["ciphertext"]),
+            ))).to eq({ 'some' => 'data' })
+
+            expect(batch[1]["channel"]).to eq("mychannel")
+            expect(batch[1]["name"]).to eq("event")
+            expect(batch[1]["data"]).to eq("already encoded")
+          }
+        end
       end
 
       describe '#trigger_async' do
@@ -400,22 +537,22 @@ describe Pusher do
       [:get, :post].each do |verb|
         describe "##{verb}" do
           before :each do
-            @url_regexp = %r{api.pusherapp.com}
+            @url_regexp = %r{api-mt1.pusher.com}
             stub_request(verb, @url_regexp).
               to_return(:status => 200, :body => "{}")
           end
 
           let(:call_api) { @client.send(verb, '/path') }
 
-          it "should use http by default" do
+          it "should use https by default" do
             call_api
-            expect(WebMock).to have_requested(verb, %r{http://api.pusherapp.com/apps/20/path})
+            expect(WebMock).to have_requested(verb, %r{https://api-mt1.pusher.com/apps/20/path})
           end
 
           it "should use https if configured" do
-            @client.encrypted = true
+            @client.encrypted = false
             call_api
-            expect(WebMock).to have_requested(verb, %r{https://api.pusherapp.com})
+            expect(WebMock).to have_requested(verb, %r{http://api-mt1.pusher.com})
           end
 
           it "should format the respose hash with symbols at first level" do
@@ -480,7 +617,7 @@ describe Pusher do
         [[:get, :get_async], [:post, :post_async]].each do |verb, method|
           describe "##{method}" do
             before :each do
-              @url_regexp = %r{api.pusherapp.com}
+              @url_regexp = %r{api-mt1.pusher.com}
               stub_request(verb, @url_regexp).
                 to_return(:status => 200, :body => "{}")
             end
@@ -494,15 +631,15 @@ describe Pusher do
               }
             }
 
-            it "should use http by default" do
+            it "should use https by default" do
               call_api
-              expect(WebMock).to have_requested(verb, %r{http://api.pusherapp.com/apps/20/path})
+              expect(WebMock).to have_requested(verb, %r{https://api-mt1.pusher.com/apps/20/path})
             end
 
-            it "should use https if configured" do
-              @client.encrypted = true
+            it "should use http if configured" do
+              @client.encrypted = false
               call_api
-              expect(WebMock).to have_requested(verb, %r{https://api.pusherapp.com})
+              expect(WebMock).to have_requested(verb, %r{http://api-mt1.pusher.com})
             end
 
             # Note that the raw httpclient connection object is returned and
@@ -522,27 +659,27 @@ describe Pusher do
         [[:get, :get_async], [:post, :post_async]].each do |verb, method|
           describe "##{method}" do
             before :each do
-              @url_regexp = %r{api.pusherapp.com}
+              @url_regexp = %r{api-mt1.pusher.com}
               stub_request(verb, @url_regexp).
                 to_return(:status => 200, :body => "{}")
             end
 
             let(:call_api) { @client.send(method, '/path') }
 
-            it "should use http by default" do
+            it "should use https by default" do
               EM.run {
                 call_api.callback {
-                  expect(WebMock).to have_requested(verb, %r{http://api.pusherapp.com/apps/20/path})
+                  expect(WebMock).to have_requested(verb, %r{https://api-mt1.pusher.com/apps/20/path})
                   EM.stop
                 }
               }
             end
 
-            it "should use https if configured" do
+            it "should use http if configured" do
               EM.run {
-                @client.encrypted = true
+                @client.encrypted = false
                 call_api.callback {
-                  expect(WebMock).to have_requested(verb, %r{https://api.pusherapp.com})
+                  expect(WebMock).to have_requested(verb, %r{http://api-mt1.pusher.com})
                   EM.stop
                 }
               }
@@ -579,70 +716,6 @@ describe Pusher do
         end
       end
     end
-
-    describe "native notifications" do
-      before :each do
-        @client.app_id = "20"
-        @client.key = "testytest"
-        @client.secret = "mysupersecretkey"
-      end
-
-      it "should configure a native notification client using the pusher client object" do
-        expect(@client.notification_client).to_not be(nil)
-      end
-
-      it "should use the default host if not provided" do
-        expect(@client.notification_host).to eq("nativepush-cluster1.pusher.com")
-      end
-
-      it "should use a newly provided host" do
-        @client.notification_host = "test.com"
-        expect(@client.notification_host).to eq("test.com")
-      end
-
-      it "should set the native notification client host to the same one" do
-        expect(@client.notification_host).to eq(@client.notification_client.host)
-      end
-
-      it "should raise an error if no interest is provided" do
-        payload = {
-          gcm: {
-            notification: {
-              title: "Hello",
-              icon: "icon",
-            }
-          }
-        }
-
-        expect { @client.notify([], payload) }.to raise_error(Pusher::Error)
-      end
-
-      it "should send a request to the notifications endpoint" do
-        notification_host_regexp = %r{nativepush-cluster1.pusher.com}
-        payload = {
-          interests: ["test"],
-          gcm: {
-            notification: {
-              title: "Hello",
-              icon: "icon",
-            }
-          }
-        }
-
-        stub_request(
-          :post,
-          notification_host_regexp,
-        ).with(
-          body: MultiJson.encode(payload)
-        ).to_return({
-          :status => 200,
-          :body => MultiJson.encode({ :foo => "bar" })
-        })
-
-        res = @client.notify(["test"], payload)
-        expect(res).to eq({foo: "bar"})
-      end
-    end
   end
 
   describe 'configuring cluster' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pusher
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Pusher
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-02 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: pusher-signature
   requirement: !ruby/object:Gem::Requirement
@@ -44,112 +44,126 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: em-http-request
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '7.1'
 description: 'Wrapper for Pusher Channels REST api: : https://pusher.com/channels'
 email:
 - support@pusher.com
@@ -157,24 +171,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".document"
-- ".gemtest"
+- ".github/stale.yml"
+- ".github/workflows/gh-release.yml"
+- ".github/workflows/publish.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - examples/async_message.rb
+- examples/presence_channels/presence_channels.rb
+- examples/presence_channels/public/presence_channels.html
 - lib/pusher.rb
 - lib/pusher/channel.rb
 - lib/pusher/client.rb
-- lib/pusher/native_notification/client.rb
 - lib/pusher/request.rb
 - lib/pusher/resource.rb
 - lib/pusher/version.rb
 - lib/pusher/webhook.rb
+- pull_request_template.md
 - pusher.gemspec
 - spec/channel_spec.rb
 - spec/client_spec.rb
@@ -184,7 +202,7 @@ homepage: http://github.com/pusher/pusher-http-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -192,20 +210,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Pusher Channels API client
-test_files:
-- spec/channel_spec.rb
-- spec/client_spec.rb
-- spec/spec_helper.rb
-- spec/web_hook_spec.rb
+test_files: []