Merge branch 'master' into pusher-channels

Author: jameshfisher

.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 2.1
   - 2.2
   - 2.3.0
+  - 2.4.1
   - jruby
   - rbx-2
 

README.md

@@ -78,7 +78,8 @@ If you need to make requests via a HTTP proxy then it can be configured
 Pusher.http_proxy = 'http://(user):(password)@(host):(port)'
 ```
 
-By default API requests are made over HTTP. HTTPS can be used by setting
+By default API requests are made over HTTP. HTTPS can be used by setting `encrypted` to `true`.
+Issuing this command is going to reset `port` value if it was previously specified.
 
 ``` ruby
 Pusher.encrypted = true
@@ -136,7 +137,7 @@ events per call on multi-tenant clusters):
 
 ``` ruby
 channels_client.trigger_batch([
-  {channel: 'channel_1', name: 'event_name', data: { foo: 'bar' }}
+  {channel: 'channel_1', name: 'event_name', data: { foo: 'bar' }},
   {channel: 'channel_1', name: 'event_name', data: { hello: 'world' }}
 ])
 ```
@@ -153,7 +154,7 @@ This will continue to work, but has been replaced by `channels_client.trigger` w
 
 ### Getting information about the channels in your Pusher Channels app
 
-This gem provides methods for accessing information from the [Pusher HTTP API](https://pusher.com/docs/rest_api). The documentation also shows an example of the responses from each of the API endpionts.
+This gem provides methods for accessing information from the [Pusher HTTP API](https://pusher.com/docs/rest_api). The documentation also shows an example of the responses from each of the API endpoints.
 
 The following methods are provided by the gem.
 
@@ -301,4 +302,3 @@ data = {
 ```
 
 **NOTE:** This is currently a BETA feature and there might be minor bugs and issues. Changes to the API will be kept to a minimum, but changes are expected. If you come across any bugs or issues, please do get in touch via [support](support@pusher.com) or create an issue here.
-

lib/pusher.rb

@@ -32,7 +32,7 @@ class << self
     def_delegators :default_client, :scheme=, :host=, :port=, :app_id=, :key=, :secret=, :http_proxy=
     def_delegators :default_client, :notification_host=, :notification_scheme=
 
-    def_delegators :default_client, :authentication_token, :url
+    def_delegators :default_client, :authentication_token, :url, :cluster
     def_delegators :default_client, :encrypted=, :url=, :cluster=
     def_delegators :default_client, :timeout=, :connect_timeout=, :send_timeout=, :receive_timeout=, :keep_alive_timeout=
 

lib/pusher/channel.rb

@@ -86,6 +86,9 @@ def trigger(event_name, data, socket_id = nil)
 
     # Request info for a channel
     #
+    # @example Response
+    #   [{:occupied=>true, :subscription_count => 12}]
+    #
     # @param info [Array] Array of attributes required (as lowercase strings)
     # @return [Hash] Hash of requested attributes for this channel
     # @raise [Pusher::Error] on invalid Pusher response - see the error message for more details
@@ -99,7 +102,7 @@ def info(attributes = [])
     # Only works on presence channels (see: http://pusher.com/docs/client_api_guide/client_presence_channels and https://pusher.com/docs/rest_api)
     #
     # @example Response
-    #   [{"id"=>"4"}]
+    #   [{:id=>"4"}]
     #
     # @param params [Hash] Hash of parameters for the API - see REST API docs
     # @return [Hash] Array of user hashes for this channel
@@ -146,7 +149,7 @@ def authentication_string(socket_id, custom_string = nil)
     #   render :json => Pusher['private-my_channel'].authenticate(params[:socket_id])
     #
     # @example Presence channels
-    #   render :json => Pusher['private-my_channel'].authenticate(params[:socket_id], {
+    #   render :json => Pusher['presence-my_channel'].authenticate(params[:socket_id], {
     #     :user_id => current_user.id, # => required
     #     :user_info => { # => optional - for example
     #       :name => current_user.name,

lib/pusher/client.rb

@@ -12,6 +12,11 @@ class Client
     # Loads the configuration from an url in the environment
     def self.from_env(key = 'PUSHER_URL')
       url = ENV[key] || raise(ConfigurationError, key)
+      from_url(url)
+    end
+
+    # Loads the configuration from a url
+    def self.from_url(url)
       client = new
       client.url = url
       client
@@ -127,7 +132,7 @@ def timeout=(value)
       @connect_timeout, @send_timeout, @receive_timeout = value, value, value
     end
 
-    ## INTERACE WITH THE API ##
+    ## INTERACT WITH THE API ##
 
     def resource(path)
       Resource.new(self, path)

spec/channel_spec.rb

@@ -71,15 +71,17 @@ def stub_post_to_raise(e)
 
   describe '#info' do
     it "should call the Client#channel_info" do
-      expect(@client).to receive(:get).with("/channels/mychannel", anything)
+      expect(@client).to receive(:get)
+                           .with("/channels/mychannel", anything)
+                           .and_return({:occupied => true, :subscription_count => 12})
       @channel = @client['mychannel']
       @channel.info
     end
 
     it "should assemble the requested attributes into the info option" do
-      expect(@client).to receive(:get).with(anything, {
-        :info => "user_count,connection_count"
-      })
+      expect(@client).to receive(:get)
+                           .with(anything, {:info => "user_count,connection_count"})
+                           .and_return({:occupied => true, :subscription_count => 12, :user_count => 12})
       @channel = @client['presence-foo']
       @channel.info(%w{user_count connection_count})
     end

spec/client_spec.rb

@@ -87,13 +87,13 @@
         expect(@client.host).to eq('api.staging.pusherapp.com')
       end
 
-      it 'should get override the url configuration if it comes after' do
+      it 'should 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
+      it 'should override 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')
@@ -109,6 +109,10 @@
     end
 
     describe 'configuring from env' do
+      after do
+        ENV['PUSHER_URL'] = nil
+      end
+
       it "works" do
         url = "http://somekey:somesecret@api.staging.pusherapp.com:8080/apps/87"
         ENV['PUSHER_URL'] = url
@@ -118,7 +122,18 @@
         expect(client.secret).to eq("somesecret")
         expect(client.app_id).to eq("87")
         expect(client.url.to_s).to eq("http://api.staging.pusherapp.com:8080/apps/87")
-        ENV['PUSHER_URL'] = nil
+      end
+    end
+
+    describe 'configuring from url' do
+      it "works" do
+        url = "http://somekey:somesecret@api.staging.pusherapp.com:8080/apps/87"
+
+        client = Pusher::Client.from_url(url)
+        expect(client.key).to eq("somekey")
+        expect(client.secret).to eq("somesecret")
+        expect(client.app_id).to eq("87")
+        expect(client.url.to_s).to eq("http://api.staging.pusherapp.com:8080/apps/87")
       end
     end
 
@@ -612,4 +627,3 @@
     end
   end
 end
-