pling 0.2.0 → 0.3.0

data/lib/pling/gcm/gateway.rb

@@ -0,0 +1,87 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+
+module Pling
+  module GCM
+    ##
+    # Pling gateway to communicate with Google's Android GCM service.
+    #
+    # The gateway is implemented using Faraday. It defaults to Faraday's :net_http adapter.
+    # You can customize the adapter by passing the :adapter configuration.
+    #
+    # @example
+    #
+    #   Pling::GCM::Gateway.new({
+    #     :key                => 'your-api-key', # Your google account's api key (Required)
+    #     :push_url           => 'http://...',   # The push url to use (Optional, Default: GCM default authentication url)
+    #     :adapter            => :net_http,      # The Faraday adapter you want to use (Optional, Default: :net_http)
+    #     :connection         => {}              # Options you want to pass to Faraday (Optional, Default: {})
+    #   })
+    class Gateway < Pling::Gateway
+
+      handles :android, :gcm
+
+      ##
+      # Initializes a new gateway to Apple's Push Notification service
+      #
+      # @param [Hash] configuration
+      # @option configuration [String] :key Your google account's api key (Required)
+      # @option configuration [String] :push_url The URL to push to (Optional)
+      # @option configuration [Symbol] :adapter The Faraday adapter to use (Optional)
+      # @option configuration [String] :connection Any options for Faraday (Optional)
+      # @raise Pling::AuthenticationFailed
+      def initialize(configuration)
+        super
+        require_configuration([:key])
+      end
+
+      ##
+      # Sends the given message to the given device.
+      #
+      # @param [#to_pling_message] message
+      # @param [#to_pling_device] device
+      # @raise Pling::DeliveryFailed
+      def deliver!(message, device)
+        data = {
+          :registration_ids => [device.identifier],
+          :data => {
+            :body  => message.body,
+            :badge => message.badge,
+            :sound => message.sound,
+            :subject => message.subject
+          }.delete_if { |_, value| value.nil? },
+          :collapse_key => "collapse-#{message.body.hash}"
+        }
+
+        data[:data].merge!(message.payload) if configuration[:payload] && message.payload
+
+        response = connection.post(configuration[:push_url], data, { :Authorization => "key=#{configuration[:key]}"})
+
+        if !response.success? || response.body['failure'].to_i > 0
+          error_class = Pling::GCM.const_get(response.body['results'][0]['error']) rescue Pling::DeliveryFailed
+          raise error_class.new("GCM Delivery failed: [#{response.status}] #{response.body}", message, device)
+        end
+      end
+
+    private
+
+     def default_configuration
+        super.merge({
+          :push_url           => 'https://android.googleapis.com/gcm/send',
+          :adapter            => :net_http,
+          :connection         => {}
+        })
+      end
+
+      def connection
+        @connection ||= Faraday.new(configuration[:connection]) do |builder|
+          builder.use FaradayMiddleware::EncodeJson
+          builder.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
+          builder.use Faraday::Response::Logger if configuration[:debug]
+          builder.adapter(configuration[:adapter])
+        end
+      end
+    end
+  end
+end

data/lib/pling/gcm.rb

@@ -0,0 +1,21 @@
+module Pling
+  ##
+  # This module adds support for Google Cloud Messaging for Android (GCM) to pling.
+  # Please refer to {Pling::GCM::Gateway} for documentation.
+  #
+  # @see Pling::GCM::Gateway
+  module GCM
+    autoload :Gateway, 'pling/gcm/gateway'
+
+    class MissingRegistration < Pling::DeliveryFailed; end
+    class InvalidRegistration < Pling::DeliveryFailed; end
+    class MismatchSenderId    < Pling::DeliveryFailed; end
+    class NotRegistered       < Pling::DeliveryFailed; end
+    class MessageTooBig       < Pling::DeliveryFailed; end
+    class InvalidTtl          < Pling::DeliveryFailed; end
+    class Unavailable         < Pling::DeliveryFailed; end
+    class InternalServerError < Pling::DeliveryFailed; end
+  end
+end
+
+

data/lib/pling/version.rb

@@ -1,3 +1,3 @@
 module Pling
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/pling.rb

@@ -8,6 +8,7 @@ module Pling
   autoload :Gateway,      'pling/gateway'
   autoload :APN,          'pling/apn'
   autoload :C2DM,         'pling/c2dm'
+  autoload :GCM,          'pling/gcm'
   autoload :Middleware,   'pling/middleware'
   autoload :Adapter,      'pling/adapter'
   autoload :Configurable, 'pling/configurable'

data/pling.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "faraday", "~> 0.7"
+  s.add_runtime_dependency "faraday_middleware", "~> 0.8"
   s.add_runtime_dependency "json", "~> 1.4"
   s.add_runtime_dependency("jruby-openssl") if RUBY_PLATFORM == 'java'
 

data/spec/pling/gcm/gateway_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+
+describe Pling::GCM::Gateway do
+
+  let(:valid_configuration) do
+    { :key => 'some-key' }
+  end
+
+  let(:push_response_mock) do
+    mock('Faraday send response', :success? => true, :status => 200, :body => "")
+  end
+
+  let(:connection_mock) do
+    mock('Faraday connection').tap do |mock|
+      mock.stub(:post).
+        with('https://android.googleapis.com/gcm/send', anything, anything).
+        and_return(push_response_mock)
+    end
+  end
+
+  let(:message) { Pling::Message.new('Hello from Pling') }
+  let(:device)  { Pling::Device.new(:identifier => 'DEVICEIDENTIFIER', :type => :android) }
+
+
+  before { Faraday.stub(:new).and_return(connection_mock) }
+
+  it 'should handle various apn related device types' do
+    Pling::GCM::Gateway.handled_types.should =~ [:android, :gcm]
+  end
+
+  context 'when created with an invalid configuration' do
+    [:key].each do |attribute|
+      it "should raise an error when :#{attribute} is missing" do
+        configuration = valid_configuration
+        configuration.delete(attribute)
+        expect { Pling::GCM::Gateway.new(configuration) }.to raise_error(ArgumentError, /:#{attribute} is missing/)
+      end
+    end
+  end
+
+  context 'when created with valid configuration' do
+
+    context 'configuration' do
+      it 'should allow configuring Faraday\'s :connection settings' do
+        Faraday.should_receive(:new).with(:ssl => { :verify => false })
+        Pling::GCM::Gateway.new(valid_configuration.merge(:connection => { :ssl => { :verify => false }})).deliver(message, device)
+      end
+
+      it 'should use Faraday::Response::Logger when :debug is set to true' do
+        builder = mock(:use => true, :adapter => true)
+        builder.should_receive(:use).with(Faraday::Response::Logger)
+        Faraday.stub(:new).and_yield(builder).and_return(connection_mock)
+
+        Pling::GCM::Gateway.new(valid_configuration.merge(:debug => true)).deliver(message, device)
+      end
+
+      it 'should use the adapter set with :adapter' do
+        builder = mock(:use => true, :adapter => true)
+        builder.should_receive(:adapter).with(:typheus)
+        Faraday.stub(:new).and_yield(builder).and_return(connection_mock)
+
+        Pling::GCM::Gateway.new(valid_configuration.merge(:adapter => :typheus)).deliver(message, device)
+      end
+
+    end
+  end
+
+  describe '#deliver' do
+    subject { Pling::GCM::Gateway.new(valid_configuration) }
+
+    let(:valid_push_params) do
+      {
+        :registration_ids => [device.identifier],
+        :data => { :body => message.body },
+        :collapse_key => "collapse-#{message.body.hash}"
+      }
+    end
+
+    let(:valid_push_headers) do
+      {
+        :Authorization => 'key=some-key'
+      }
+    end
+
+    it 'should raise an error if no message is given' do
+      expect { subject.deliver(nil, device) }.to raise_error
+    end
+
+    it 'should raise an error the device is given' do
+      expect { subject.deliver(message, nil) }.to raise_error
+    end
+
+    it 'should call #to_pling_message on the given message' do
+      message.should_receive(:to_pling_message).and_return(message)
+      subject.deliver(message, device)
+    end
+
+    it 'should call #to_pling_device on the given device' do
+      device.should_receive(:to_pling_device).and_return(device)
+      subject.deliver(message, device)
+    end
+
+    it 'should try to deliver the given message' do
+      connection_mock.should_receive(:post).
+        with('https://android.googleapis.com/gcm/send', valid_push_params, valid_push_headers).
+        and_return(push_response_mock)
+
+      subject.deliver(message, device)
+    end
+
+    it 'should raise a Pling::DeliveryFailed exception if the delivery was not successful' do
+      connection_mock.should_receive(:post).and_return(push_response_mock)
+      push_response_mock.stub(:status => 401, :success? => false, :body => "Something went wrong")
+
+      expect { subject.deliver(message, device) }.to raise_error Pling::DeliveryFailed, /Something went wrong/
+    end
+
+    it 'should raise a Pling::DeliveryFailed exception if the response body contained an error' do
+      connection_mock.should_receive(:post).and_return(push_response_mock)
+      push_response_mock.stub(:status => 200, :success? => true, :body => { 'failure' => 1, 'results' => ['error' => 'SomeError'] })
+
+      expect { subject.deliver(message, device) }.to raise_error Pling::DeliveryFailed, /SomeError/
+    end
+
+    it 'should send data.badge if the given message has a badge' do
+      connection_mock.should_receive(:post).
+        with(anything, hash_including(:data => hash_including({ :badge => '10' })), anything).
+        and_return(push_response_mock)
+      message.badge = 10
+      subject.deliver(message, device)
+    end
+
+    it 'should send data.sound if the given message has a sound' do
+      connection_mock.should_receive(:post).
+        with(anything, hash_including(:data => hash_including({ :sound => 'pling' })), anything).
+        and_return(push_response_mock)
+      message.sound = :pling
+      subject.deliver(message, device)
+    end
+
+    it 'should send data.subject if the given message has a subject' do
+      connection_mock.should_receive(:post).
+        with(anything, hash_including(:data => hash_including({ :subject => 'Important!' })), anything).
+        and_return(push_response_mock)
+      message.subject = 'Important!'
+      subject.deliver(message, device)
+    end
+
+    context 'when configured to include payload' do
+      before do
+        valid_configuration.merge!(:payload => true)
+        message.payload = { :data => 'available' }
+      end
+
+      it 'should include the given payload' do
+        connection_mock.should_receive(:post).
+          with(anything, hash_including(:data => hash_including({ :data => 'available' })), anything).
+          and_return(push_response_mock)
+        subject.deliver(message, device)
+      end
+    end
+
+    context 'when configured to not include payload' do
+      before do
+        valid_configuration.merge!(:payload => false)
+        message.payload = { :data => 'available' }
+      end
+
+      it 'should include the given payload' do
+        connection_mock.should_receive(:post).
+          with(anything, hash_not_including(:'data.data' => 'available'), anything).
+          and_return(push_response_mock)
+        subject.deliver(message, device)
+      end
+    end
+
+    [:MissingRegistration, :InvalidRegistration, :MismatchSenderId,
+     :NotRegistered, :MessageTooBig, :InvalidTtl, :Unavailable,
+     :InternalServerError].each do |exception|
+      it "should raise a Pling::GCM::#{exception} when the response body is ''" do
+        push_response_mock.stub(:body => { 'failure' => 1, 'results' => [{ 'error' => exception }]})
+        expect { subject.deliver(message, device) }.to raise_error Pling::GCM.const_get(exception)
+      end
+    end
+  end
+end     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pling
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-11 00:00:00.000000000Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70316014249500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,31 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70316014249500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70316014248240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +55,15 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70316014248240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70316014247280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +71,15 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *70316014247280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70316014246260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +87,15 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70316014246260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70316014245540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,7 +103,12 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70316014245540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Pling is a notification framework that supports multiple gateways. Currently
   supported are Android Push and SMS.
 email:
@@ -98,6 +139,8 @@ files:
 - lib/pling/delayed_initializer.rb
 - lib/pling/device.rb
 - lib/pling/gateway.rb
+- lib/pling/gcm.rb
+- lib/pling/gcm/gateway.rb
 - lib/pling/message.rb
 - lib/pling/middleware.rb
 - lib/pling/middleware/base.rb
@@ -113,6 +156,7 @@ files:
 - spec/pling/delayed_initializer_spec.rb
 - spec/pling/device_spec.rb
 - spec/pling/gateway_spec.rb
+- spec/pling/gcm/gateway_spec.rb
 - spec/pling/message_spec.rb
 - spec/pling_spec.rb
 - spec/spec_helper.rb
@@ -136,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Pling is a notification framework that supports multiple gateways
@@ -151,6 +195,7 @@ test_files:
 - spec/pling/delayed_initializer_spec.rb
 - spec/pling/device_spec.rb
 - spec/pling/gateway_spec.rb
+- spec/pling/gcm/gateway_spec.rb
 - spec/pling/message_spec.rb
 - spec/pling_spec.rb
 - spec/spec_helper.rb