pusher 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7cf7936626783961750faf09d38ea22db710f5f
-  data.tar.gz: bf85e0ba476d7abdeef2eb4ab96f7fc4ca7ce8d0
+  metadata.gz: c321a0933bab4b4ccfbefa2c9e83eadab92d622c
+  data.tar.gz: ecb892017e868a125e8a11bdb130c8f9069d9dcb
 SHA512:
-  metadata.gz: d4fcd557bde9a7f50583bd50bd72675a836ab83eed677b5bf89526e9e0d5bda9fbbb10f12127b8ecf5d509d9ead34ac556dd55d838088445b27782e0cdaa1dc5
-  data.tar.gz: b3a3ef764d730434b45d5046b4974a1e7ca2a1e41e00fea8a2570f30b4331314e02b80756652b76ce27ff672e6deeed25ceb9d169866a4668964370edc6995b6
+  metadata.gz: 9db9cd31686cab8565d2fc2a0b4c57270728b69dc592c2dbb5baaa7c7df509b1c40836e3f9d550703e2e330b5c5198defc7935e5033ab7039bba91015ea3c5b7
+  data.tar.gz: cea7de20ba9b57db2ff5e58fbc8bed35dfd8cf02ca88fb31b3929ba34b7a6036fef6b94fba0e244e0cc3b0549c288b5d3bf8d3d348e9acee0587542c31ab2e87

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.17.0 / 2016-02-22
+==================
+
+  * Introduce the `cluster` option.
 
 0.16.0 / 2016-01-21
 ==================

data/README.md

@@ -19,9 +19,46 @@ gem install pusher
 
 After registering at <http://pusher.com> configure your app with the security credentials.
 
-### Global
+### Instantiating a Pusher client
+
+Creating a new Pusher `client` can be done as follows.
+
+``` ruby
+pusher_client = Pusher::Client.new(
+  app_id: 'your-pusher-app-id',
+  key: 'your-pusher-key',
+  secret: 'your-pusher-secret'
+)
+```
+
+If you want to set a custom `host` value for your client then you can do so when instantiating a Pusher client like so:
+
+``` ruby
+pusher_client = Pusher::Client.new(
+  app_id: 'your-pusher-app-id',
+  key: 'your-pusher-key',
+  secret: 'your-pusher-secret',
+  host: 'your-pusher-host'
+)
+```
+
+If you created your app in a different cluster to the default cluster, you must pass the `cluster` option as follows:
+
+``` ruby
+pusher_client = Pusher::Client.new(
+  app_id: 'your-pusher-app-id',
+  key: 'your-pusher-key',
+  secret: 'your-pusher-secret',
+  cluster: 'your-app-cluster'
+)
+```
+
+This will set the `host` to `api-<cluster>.pusher.com`. If you pass both `host` and `cluster` options, the `host` will take precendence and `cluster` will be ignored.
+
+### Global (Deprecated)
 
-The most standard way of configuring Pusher is to do it globally on the Pusher class.
+Configuring Pusher can also be done globally on the Pusher class.
+*NOTE! This is a deprecated feature and will be removed in future versions of this library!*
 
 ``` ruby
 Pusher.app_id = 'your-pusher-app-id'
@@ -49,33 +86,6 @@ As of version 0.12, SSL certificates are verified when using the synchronous htt
 Pusher.default_client.sync_http_client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
 ```
 
-### Instantiating a Pusher client
-
-Sometimes you may have multiple sets of API keys, or want different configuration in different parts of your application. In these scenarios, a pusher `client` may be configured:
-
-``` ruby
-pusher_client = Pusher::Client.new({
-  app_id: 'your-pusher-app-id',
-  key: 'your-pusher-key',
-  secret: 'your-pusher-secret'
-})
-```
-
-This `client` will have all the functionality listed on the main Pusher class (which proxies to a client internally).
-
-If you want to set the `host` value for your client then you can do so when instantiating a Pusher client like so:
-
-``` ruby
-pusher_client = Pusher::Client.new({
-  app_id: 'your-pusher-app-id',
-  key: 'your-pusher-key',
-  secret: 'your-pusher-secret',
-  host: 'your-pusher-host'
-})
-```
-
-This is useful if, for example, you've created an app on the EU cluster and wish to set the host to be `api-eu.pusher.com`.
-
 ## Interacting with the Pusher service
 
 The Pusher gem contains a number of helpers for interacting with the service. As a general rule, the library adheres to a set of conventions that we have aimed to make universal.
@@ -86,7 +96,7 @@ Handle errors by rescuing `Pusher::Error` (all errors are descendants of this er
 
 ``` ruby
 begin
-  Pusher.trigger('a_channel', 'an_event', {:some => 'data'})
+  Pusher.trigger('a_channel', 'an_event', :some => 'data')
 rescue Pusher::Error => e
   # (Pusher::AuthenticationError, Pusher::HTTPError, or Pusher::Error)
 end
@@ -105,8 +115,8 @@ Pusher.logger = Rails.logger
 An event can be published to one or more channels (limited to 10) in one API call:
 
 ``` ruby
-Pusher.trigger('channel', 'event', {foo: 'bar'})
-Pusher.trigger(['channel_1', 'channel_2'], 'event_name', {foo: 'bar'})
+Pusher.trigger('channel', 'event', foo: 'bar')
+Pusher.trigger(['channel_1', 'channel_2'], 'event_name', foo: 'bar')
 ```
 
 An optional fourth argument may be used to send additional parameters to the API, for example to [exclude a single connection from receiving the event](http://pusher.com/docs/publisher_api_guide/publisher_excluding_recipients).
@@ -120,7 +130,7 @@ Pusher.trigger('channel', 'event', {foo: 'bar'}, {socket_id: '123.456'})
 Most examples and documentation will refer to the following syntax for triggering an event:
 
 ``` ruby
-Pusher['a_channel'].trigger('an_event', {:some => 'data'})
+Pusher['a_channel'].trigger('an_event', :some => 'data')
 ```
 
 This will continue to work, but has been replaced by `Pusher.trigger` which supports one or multiple channels.
@@ -193,10 +203,10 @@ Pusher.authenticate('private-my_channel', params[:socket_id])
 These work in a very similar way, but require a unique identifier for the user being authenticated, and optionally some attributes that are provided to clients via presence events:
 
 ``` ruby
-Pusher.authenticate('presence-my_channel', params[:socket_id], {
+Pusher.authenticate('presence-my_channel', params[:socket_id],
   user_id: 'user_id',
   user_info: {} # optional
-})
+)
 ```
 
 ## Receiving WebHooks

data/lib/pusher.rb

@@ -27,7 +27,7 @@ module Pusher
     def_delegators :default_client, :scheme=, :host=, :port=, :app_id=, :key=, :secret=, :http_proxy=
 
     def_delegators :default_client, :authentication_token, :url
-    def_delegators :default_client, :encrypted=, :url=
+    def_delegators :default_client, :encrypted=, :url=, :cluster=
     def_delegators :default_client, :timeout=, :connect_timeout=, :send_timeout=, :receive_timeout=, :keep_alive_timeout=
 
     def_delegators :default_client, :get, :get_async, :post, :post_async

data/lib/pusher/client.rb

@@ -10,14 +10,24 @@ module Pusher
     ## CONFIGURATION ##
 
     def initialize(options = {})
-      options = {
+      default_options = {
         :scheme => 'http',
-        :host => 'api.pusherapp.com',
         :port => 80,
-      }.merge(options)
-      @scheme, @host, @port, @app_id, @key, @secret = options.values_at(
+      }
+      merged_options = default_options.merge(options)
+
+      if options.has_key?(:host)
+        merged_options[:host] = options[:host]
+      elsif options.has_key?(:cluster)
+        merged_options[:host] = "api-#{options[:cluster]}.pusher.com"
+      else
+        merged_options[:host] = "api.pusherapp.com"
+      end
+
+      @scheme, @host, @port, @app_id, @key, @secret = merged_options.values_at(
         :scheme, :host, :port, :app_id, :key, :secret
       )
+
       @http_proxy = nil
       self.http_proxy = options[:http_proxy] if options[:http_proxy]
 
@@ -88,6 +98,10 @@ module Pusher
       @scheme == 'https'
     end
 
+    def cluster=(cluster)
+      @host = "api-#{cluster}.pusher.com"
+    end
+
     # Convenience method to set all timeouts to the same value (in seconds).
     # For more control, use the individual writers.
     def timeout=(value)

data/pusher.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "pusher"
-  s.version     = "0.16.0"
+  s.version     = "0.17.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Pusher"]
   s.email       = ["support@pusher.com"]

data/spec/client_spec.rb

@@ -60,6 +60,38 @@ describe Pusher do
       end
     end
 
+    describe 'configuring the cluster' do
+      it 'should set a new default host' do
+        @client.cluster = 'eu'
+        expect(@client.host).to eq('api-eu.pusher.com')
+      end
+
+      it 'should be overridden by host if it comes after' do
+        @client.cluster = 'eu'
+        @client.host = 'api.staging.pusher.com'
+        expect(@client.host).to eq('api.staging.pusher.com')
+      end
+
+      it 'should be overridden by url if it comes after' do
+        @client.cluster = 'eu'
+        @client.url = "http://somekey:somesecret@api.staging.pusherapp.com:8080/apps/87"
+
+        expect(@client.host).to eq('api.staging.pusherapp.com')
+      end
+
+      it 'should get override the url configuration if it comes after' do
+        @client.url = "http://somekey:somesecret@api.staging.pusherapp.com:8080/apps/87"
+        @client.cluster = 'eu'
+        expect(@client.host).to eq('api-eu.pusher.com')
+      end
+
+      it 'should overrie by the host configuration if it comes after' do
+        @client.host = 'api.staging.pusher.com'
+        @client.cluster = 'eu'
+        expect(@client.host).to eq('api-eu.pusher.com')
+      end
+    end
+
     describe 'configuring a http proxy' do
       it "should be possible to configure everything by setting the http_proxy" do
         @client.http_proxy = 'http://someuser:somepassword@proxy.host.com:8080'
@@ -431,4 +463,26 @@ describe Pusher do
       end
     end
   end
+
+  describe 'configuring cluster' do
+    it 'should allow clients to specify the cluster only with the default host' do
+      client = Pusher::Client.new({
+        :scheme => 'http',
+        :cluster => 'eu',
+        :port => 80
+      })
+      expect(client.host).to eq('api-eu.pusher.com')
+    end
+
+    it 'should always have host override any supplied cluster value' do
+      client = Pusher::Client.new({
+        :scheme => 'http',
+        :host => 'api.staging.pusherapp.com',
+        :cluster => 'eu',
+        :port => 80
+      })
+      expect(client.host).to eq('api.staging.pusherapp.com')
+    end
+  end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pusher
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Pusher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -184,12 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Pusher API client
-test_files:
-- spec/channel_spec.rb
-- spec/client_spec.rb
-- spec/spec_helper.rb
-- spec/web_hook_spec.rb
+test_files: []