pusher 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c321a0933bab4b4ccfbefa2c9e83eadab92d622c
-  data.tar.gz: ecb892017e868a125e8a11bdb130c8f9069d9dcb
+  metadata.gz: 6445dc1dff7034c9fa013bb13c06d797a3d508d3
+  data.tar.gz: cbadd3ea95efed035d3c8f87af33b76d7315b14c
 SHA512:
-  metadata.gz: 9db9cd31686cab8565d2fc2a0b4c57270728b69dc592c2dbb5baaa7c7df509b1c40836e3f9d550703e2e330b5c5198defc7935e5033ab7039bba91015ea3c5b7
-  data.tar.gz: cea7de20ba9b57db2ff5e58fbc8bed35dfd8cf02ca88fb31b3929ba34b7a6036fef6b94fba0e244e0cc3b0549c288b5d3bf8d3d348e9acee0587542c31ab2e87
+  metadata.gz: 4f512577534b021e70ffe2d87838c7be5437139d6f0a38d90d4ef467d8e0d738192033fcdfd21aad3a9c88370908417bf03cb7450d887ccf9cfe05130d29c068
+  data.tar.gz: 3ca887136f17144e1fa3ca1fa8c35a12ce82ee5d0f16711da327c0429f4042f041d2df6b2e6f02f0f3a2a3eaba0ed0f0db0ace46eecff914d330b264ebcf20dd

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+
+0.18.0 / 2016-05-15
+==================
+
+  * Introduce `Pusher::Client.from_env`
+  * Improve error handling on missing config
+
 0.17.0 / 2016-02-22
 ==================
 

data/README.md

@@ -55,10 +55,16 @@ pusher_client = Pusher::Client.new(
 
 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)
+Finally, if you have the configuration set in an `PUSHER_URL` environment
+variable, you can use:
+
+``` ruby
+pusher_client = Pusher::Client.from_env
+```
+
+### Global
 
 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'

data/lib/pusher/client.rb

@@ -9,6 +9,14 @@ module Pusher
 
     ## CONFIGURATION ##
 
+    # Loads the configuration from an url in the environment
+    def self.from_env(key = 'PUSHER_URL')
+      url = ENV[key] || raise(ConfigurationError, key)
+      client = new
+      client.url = url
+      client
+    end
+
     def initialize(options = {})
       default_options = {
         :scheme => 'http',
@@ -40,11 +48,14 @@ module Pusher
 
     # @private Returns the authentication token for the client
     def authentication_token
+      raise ConfigurationError, :key unless @key
+      raise ConfigurationError, :secret unless @secret
       Pusher::Signature::Token.new(@key, @secret)
     end
 
     # @private Builds a url for this app, optionally appending a path
     def url(path = nil)
+      raise ConfigurationError, :app_id unless @app_id
       URI::Generic.build({
         :scheme => @scheme,
         :host => @host,
@@ -133,7 +144,7 @@ module Pusher
     # @raise [Pusher::HTTPError] Error raised inside http client. The original error is wrapped in error.original_error
     #
     def get(path, params = {})
-      Resource.new(self, path).get(params)
+      resource(path).get(params)
     end
 
     # GET arbitrary REST API resource using an asynchronous http client.
@@ -149,20 +160,20 @@ module Pusher
     # @return Either an EM::DefaultDeferrable or a HTTPClient::Connection
     #
     def get_async(path, params = {})
-      Resource.new(self, path).get_async(params)
+      resource(path).get_async(params)
     end
 
     # POST arbitrary REST API resource using a synchronous http client.
     # Works identially to get method, but posts params as JSON in post body.
     def post(path, params = {})
-      Resource.new(self, path).post(params)
+      resource(path).post(params)
     end
 
     # POST arbitrary REST API resource using an asynchronous http client.
     # Works identially to get_async method, but posts params as JSON in post
     # body.
     def post_async(path, params = {})
-      Resource.new(self, path).post_async(params)
+      resource(path).post_async(params)
     end
 
     ## HELPER METHODS ##
@@ -186,7 +197,6 @@ module Pusher
     #   should not contain anything other than letters, numbers, or the
     #   characters "_\-=@,.;"
     def channel(channel_name)
-      raise ConfigurationError, 'Missing client configuration: please check that key, secret and app_id are configured.' unless configured?
       Channel.new(url, channel_name, self)
     end
 

data/lib/pusher.rb

@@ -17,7 +17,11 @@ module Pusher
   #   end
   class Error < RuntimeError; end
   class AuthenticationError < Error; end
-  class ConfigurationError < Error; end
+  class ConfigurationError < Error
+    def initialize(key)
+      super "missing key `#{key}' in the client configuration"
+    end
+  end
   class HTTPError < Error; attr_accessor :original_error; end
 
   class << self
@@ -45,13 +49,12 @@ module Pusher
     end
 
     def default_client
-      @default_client ||= Pusher::Client.new
+      @default_client ||= begin
+        cli = Pusher::Client
+        ENV['PUSHER_URL'] ? cli.from_env : cli.new
+      end
     end
   end
-
-  if ENV['PUSHER_URL']
-    self.url = ENV['PUSHER_URL']
-  end
 end
 
 require 'pusher/channel'

data/pusher.gemspec

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

data/spec/client_spec.rb

@@ -58,6 +58,14 @@ describe Pusher do
       it "should fail on bad urls" do
         expect { @client.url = "gopher/somekey:somesecret@://api.staging.pusherapp.co://m:8080\apps\87" }.to raise_error(URI::InvalidURIError)
       end
+
+      it "should raise exception if app_id is not configured" do
+        @client.app_id = nil
+        expect {
+          @client.url
+        }.to raise_error(Pusher::ConfigurationError)
+      end
+
     end
 
     describe 'configuring the cluster' do
@@ -100,6 +108,20 @@ describe Pusher do
       end
     end
 
+    describe 'configuring from env' do
+      it "works" do
+        url = "http://somekey:somesecret@api.staging.pusherapp.com:8080/apps/87"
+        ENV['PUSHER_URL'] = url
+
+        client = Pusher::Client.from_env
+        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")
+        ENV['PUSHER_URL'] = nil
+      end
+    end
+
     describe 'when configured' do
       before :each do
         @client.app_id = '20'
@@ -116,13 +138,11 @@ describe Pusher do
           expect(@channel).to be_kind_of(Pusher::Channel)
         end
 
-        %w{app_id key secret}.each do |config|
-          it "should raise exception if #{config} not configured" do
-            @client.send("#{config}=", nil)
-            expect {
-              @client['test_channel']
-            }.to raise_error(Pusher::ConfigurationError)
-          end
+        it "should raise exception if app_id is not configured" do
+          @client.app_id = nil
+          expect {
+            @client['test_channel']
+          }.to raise_error(Pusher::ConfigurationError)
         end
       end
 

metadata

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