pusher 0.12.0 → 0.14.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 529c89c30b29ce1e8ba4558f0efbab8e2983e898
+  data.tar.gz: 328df39b09ed4f244a2a8576de2d4c16d7c6d53b
+SHA512:
+  metadata.gz: 7d38ac2d891c4c5772f2f37511ff132a9258bff1fed9a2c23edddda00c034b3bca4b3d0d6673b45d3787271ac1366bf1d17382b7487167e3db9d87a2eff2d8cc
+  data.tar.gz: e9ff5af00c144d87fbe2de78f88b7b5d54b82a16968b01377c75154950ba1eb4efc15a5e10c0df99f2acb2016adbd43980af97481ff5c8c97dbff44c2276d670

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011 Pusher
+Copyright (c) 2010-2013 Pusher
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -73,26 +73,22 @@ Errors are logged to `Pusher.logger`. It will by default log at info level to ST
 
 ### Publishing events
 
-An event can be sent to Pusher in in the following ways:
+An event can be published to one or more channels (limited to 100) in one API call:
 
-    # on the Pusher class
-    Pusher.trigger('channel_name', 'event_name', {some: 'data'})
-    Pusher.trigger(['channel_1', 'channel_2'], 'event_name', {some: 'data'})
-    
-    # or on a pusher_client
-    pusher_client.trigger(['your_channels'], 'your_event_name', {some: 'data'})
+    Pusher.trigger('channel', 'event', {foo: 'bar'})
+    Pusher.trigger(['channel_1', 'channel_2'], 'event_name', {foo: 'bar'})
 
-Note: the first `channels` argument can contain multiple channels you'd like your event and data payload to go to. There is a limit of 100 on the number of channels this can contain.
+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).
 
-An optional fourth argument of this method can specify a `socket_id` that will be excluded from receiving the event (generally the user where the event originated -- see <http://pusher.com/docs/publisher_api_guide/publisher_excluding_recipients> for more info).
+    Pusher.trigger('channel', 'event', {foo: 'bar'}, {socket_id: '123.456'})
 
-#### Original publisher API
+#### Deprecated publisher API
 
 Most examples and documentation will refer to the following syntax for triggering an event:
 
     Pusher['a_channel'].trigger('an_event', {:some => 'data'})
 
-This will continue to work, but will be replaced as the canonical version by `Pusher.trigger` which supports multiple channels.
+This will continue to work, but has been replaced by `Pusher.trigger` which supports one or multiple channels.
 
 ### Generic requests to the Pusher REST API
 
@@ -142,7 +138,7 @@ A HTTP error or an error response from pusher will cause the errback to be calle
 
 #### Without eventmachine
 
-If the eventmachine reactor is not running, async requests will be make using threads (managed by the httpclient gem).
+If the eventmachine reactor is not running, async requests will be made using threads (managed by the httpclient gem).
 
 An `HTTPClient::Connection` object is returned immediately which can be [interrogated](http://rubydoc.info/gems/httpclient/HTTPClient/Connection) to discover the status of the request. The usual response checking and processing is not done when the request completes, and frankly this method is most useful when you're not interested in waiting for the response.
 

data/lib/pusher/channel.rb

@@ -5,9 +5,14 @@ module Pusher
   # Trigger events on Channels
   class Channel
     attr_reader :name
-
+    INVALID_CHANNEL_REGEX = /[^A-Za-z0-9_\-=@,.;]/
     def initialize(base_url, name, client = Pusher)
       @uri = base_url.dup
+      if Pusher::Channel::INVALID_CHANNEL_REGEX.match(name)
+        raise Pusher::Error, "Illegal channel name '#{name}'"
+      elsif name.length > 200
+        raise Pusher::Error, "Channel name too long (limit 100 characters) '#{name}'"
+      end
       @uri.path = @uri.path + "/channels/#{name}/"
       @name = name
       @client = client

data/lib/pusher/client.rb

@@ -168,7 +168,9 @@ module Pusher
     #   Pusher['my-channel']
     # @return [Channel]
     # @raise [ConfigurationError] unless key, secret and app_id have been
-    #   configured
+    #   configured. Channel names should be less than 200 characters, and
+    #   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)
@@ -195,7 +197,7 @@ module Pusher
     #
     # GET /apps/[id]/channels/[channel_name]
     #
-    # @param channel_name [String] Channel name
+    # @param channel_name [String] Channel name (max 200 characters)
     # @param params [Hash] Hash of parameters for the API - see REST API docs
     #
     # @return [Hash] See Pusher API docs
@@ -211,7 +213,7 @@ module Pusher
     #
     # POST /apps/[app_id]/events
     #
-    # @param channels [String or Array] One of more channel names
+    # @param channels [String or Array] 1-10 channel names
     # @param event_name [String]
     # @param data [Object] Event data to be triggered in javascript.
     #   Objects other than strings will be converted to JSON
@@ -279,6 +281,7 @@ module Pusher
 
     def trigger_params(channels, event_name, data, params)
       channels = Array(channels).map(&:to_s)
+      raise Pusher::Error, "Too many channels (#{channels.length}), max 10" if channels.length > 10
 
       encoded_data = case data
       when String

data/lib/pusher/request.rb

@@ -53,7 +53,7 @@ module Pusher
             :query => @params, :head => @head
           })
         else
-          raise "Unsuported verb"
+          raise "Unsupported verb"
         end
         http.callback {
           begin

data/pusher.gemspec

@@ -3,13 +3,14 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "pusher"
-  s.version     = "0.12.0"
+  s.version     = "0.14.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Pusher"]
   s.email       = ["support@pusher.com"]
   s.homepage    = "http://github.com/pusher/pusher-gem"
   s.summary     = %q{Pusher API client}
   s.description = %q{Wrapper for pusher.com REST api}
+  s.license     = "MIT"
 
   s.add_dependency "multi_json", "~> 1.0"
   s.add_dependency 'signature', "~> 0.1.6"

data/spec/channel_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'spec_helper'
 
 describe Pusher::Channel do
@@ -51,6 +52,16 @@ describe Pusher::Channel do
     end
   end
 
+  describe "#initialization" do
+    it "should not be too long" do
+      lambda { @client['b'*201] }.should raise_error(Pusher::Error)
+    end
+
+    it "should not use bad characters" do
+      lambda { @client['*^!±`/""'] }.should raise_error(Pusher::Error)
+    end
+  end
+
   describe "#trigger_async" do
     it "should use @client.trigger_async internally" do
       @client.should_receive(:trigger_async)

data/spec/client_spec.rb

@@ -22,6 +22,10 @@ describe Pusher do
       @client2.secret = 'bbbbbbbb'
     end
 
+    it "default should be configured automatically from environment variable" do
+      Pusher.default_client.url.host.should == "api.secret.pusherapp.com"
+    end
+
     it "should send scheme messages to different objects" do
       @client1.scheme.should_not == @client2.scheme
     end
@@ -129,6 +133,10 @@ describe Pusher do
         @client.scheme.should == 'https'
         @client.port.should == 443
       end
+
+      it "should fail on bad urls" do
+        expect { @client.url = "gopher/somekey:somesecret@://api.staging.pusherapp.co://m:8080\apps\87" }.to raise_error
+      end
     end
 
     describe 'configuring a http proxy' do
@@ -213,6 +221,14 @@ describe Pusher do
             should == {}
         end
 
+        it "should not allow too many channels" do
+          lambda {
+            @client.trigger((0..11).map{|i| 'mychannel#{i}'},
+              'event', {'some' => 'data'}, {
+                :socket_id => "1234"
+              })}.should raise_error(Pusher::Error)
+        end
+
         it "should pass any parameters in the body of the request" do
           @client.trigger(['mychannel', 'c2'], 'event', {'some' => 'data'}, {
             :socket_id => "1234"

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@ rescue LoadError
   puts 'although not required, it is recommended that you use bundler when running the tests'
 end
 
+ENV['PUSHER_URL']= 'http://some:secret@api.secret.pusherapp.com:441/apps/54'
+
 require 'rspec'
 require 'rspec/autorun'
 require 'em-http' # As of webmock 1.4.0, em-http must be loaded first

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: pusher
 version: !ruby/object:Gem::Version
-  version: 0.12.0
-  prerelease: 
+  version: 0.14.0
 platform: ruby
 authors:
 - Pusher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: signature
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,23 +69,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: em-http-request
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,33 +97,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Wrapper for pusher.com REST api
@@ -168,34 +151,28 @@ files:
 - spec/spec_helper.rb
 - spec/web_hook_spec.rb
 homepage: http://github.com/pusher/pusher-gem
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1060459840263191989
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1060459840263191989
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Pusher API client
 test_files:
 - spec/channel_spec.rb