c2dm_batch 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*.gem
+.bundle
+Gemfile.lock
+pkg
+tmp
+config.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2010
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
+the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+C2dmBatch
+===========
+
+A library to send c2dm notifications in parallel.
+
+This code is based on https://github.com/amro/c2dm
+
+Requirements
+------------
+
+<pre>
+gem install typhoeus
+</pre>
+
+Send a single notification
+--------------------------
+<pre>
+C2dmBatch.email = 'your_c2dm_sender@gmail.com' 
+C2dmBatch.password = 'password'
+C2dmBatch.source = 'your app name'
+notification = {
+  :registration_id => "your_reg_id",
+    :data => { 
+      :test => "test"
+    }
+}
+C2dmBatch.send_notification(notification)
+</pre>
+
+Send notifications in batch
+-----------------------------
+
+<pre>
+C2dmBatch.email = 'your_c2dm_sender@gmail.com' 
+C2dmBatch.password = 'password'
+C2dmBatch.source = 'your app name'
+notification = [
+  {
+    :registration_id => "your_reg_id",
+      :data => { 
+        :test => "foo"
+      }
+  },
+  {
+    :registration_id => "your_reg_id2",
+      :data => { 
+        :test => "bar"
+      }
+  }
+]
+errors = C2dmBatch.send_batch_notification(notification)
+</pre>
+
+Using Typhoeus, the send_batch_notification will parallelize the request in up to 200 parallel requests. Once a request finishes, a new request will automatically get send out. The return value is an array of hashes. The hash is of the form { :registration_id => 'reg_id', :error => 'error_code' }
+
+Possible Error Codes
+--------------------
+The error code and description are taken from the official c2dm docuementation at: http://code.google.com/android/c2dm/
+
+* QuotaExceeded — Too many messages sent by the sender. Retry after a while.
+* DeviceQuotaExceeded — Too many messages sent by the sender to a specific device. Retry after a while.
+* InvalidRegistration — Missing or bad registration_id. Sender should stop sending messages to this device.
+* NotRegistered — The registration_id is no longer valid, for example user has uninstalled the application or turned off notifications. Sender should stop sending messages to this device.
+* MessageTooBig — The payload of the message is too big, see the limitations. Reduce the size of the message.
+* MissingCollapseKey — Collapse key is required. Include collapse key in the request.
+* 503 - Must retry later. c2dm batch aborts all in-flight requests and returns all unsent requests with a 503 error code. Resending with honoring the Retry-After and exponentail backoff are not implemented. 

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/c2dm_batch

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require File.expand_path("../../lib/c2dm_batch", __FILE__)

data/c2dm_batch.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+root = File.expand_path('../', __FILE__)
+lib = "#{root}/lib"
+
+$:.unshift lib unless $:.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name        = "c2dm_batch"
+  s.version     = '0.1.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Alex Rockwell"]
+  s.email       = ["arockwell@gmail.com"]
+  s.homepage    = "http://alexrockwell.org"
+  s.summary     = %q{Gem to send android c2dm notifications in batch}
+  s.description = %q{Gem to send android c2dm notifications in batch}
+
+  s.executables = `cd #{root} && git ls-files bin/*`.split("\n").collect { |f| File.basename(f) }
+  s.files = `cd #{root} && git ls-files`.split("\n")
+  s.require_paths = %w(lib)
+  s.test_files = `cd #{root} && git ls-files -- {features,test,spec}/*`.split("\n")
+
+  s.add_development_dependency "rspec", "~> 1.0"
+  s.add_dependency "typhoeus", "= 0.2.4"
+end

data/config.example.yml

@@ -0,0 +1,4 @@
+test:
+  email: test@example.com
+  password: abc123
+  source: your_name

data/lib/c2dm_batch/core.rb

@@ -0,0 +1,120 @@
+module C2dmBatch
+  @auth_url = 'https://www.google.com/accounts/ClientLogin'
+  @send_url = 'https://android.apis.google.com/c2dm/send'
+
+  @email = nil
+  @password = nil 
+  @source = nil
+
+  @hydra = Typhoeus::Hydra.new
+
+  class << self
+    attr_accessor :auth_url, :send_url, :email, :password, :source
+  end
+
+  def self.authenticate!
+    request = Typhoeus::Request.new(@auth_url)
+    auth_options = {
+      'accountType' => 'HOSTED_OR_GOOGLE',
+      'service'     => 'ac2dm',
+      'Email'       => @email,
+      'Passwd'      => @password,
+      'source'      => @source,
+    }
+    request.body = build_post_body(auth_options)
+
+    headers = {
+      'Content-length' => request.body.length.to_s
+    }
+    request.headers = headers
+
+    @hydra.queue(request)
+    @hydra.run
+    response = request.response
+
+    auth_token = ""
+    if response.success?
+      response.body.split("\n").each do |line|
+        if line =~ /^Auth=/
+          auth_token = line.gsub('Auth=', '')
+        end
+      end
+    end
+    @auth_token = auth_token
+  end
+
+  def self.send_notification(notification)
+    authenticate!
+    request = create_notification_request(notification)
+
+    @hydra.queue(request)
+    @hydra.run
+    response = request.response
+  end
+
+  def self.send_batch_notifications(notifications)
+    authenticate!
+    requests = []
+    errors = []
+    notifications.each do |notification|
+      request = create_notification_request(notification)
+      requests << request
+      request.method = :post
+      request.on_complete do |response|
+        if response.success?
+          if response.body =~ /Error=(\w+)/
+            errors << { :registration_id => notification[:registration_id], :error => $1 }
+          else
+            requests.delete(request)
+          end
+        elsif response.code == 503
+          @hydra.abort
+          raise RuntimeError
+        end
+      end
+      @hydra.queue(request)
+    end
+    begin 
+      @hydra.run
+    rescue RuntimeError
+      requests.each do |failed_request|
+        errors << { 
+          :registration_id => failed_request.body.match(/registration_id=(\w+)/)[1], 
+          :error => 503 
+        }
+      end
+    end
+    errors
+  end
+
+  private
+  def self.build_post_body(options={})
+    post_body = []
+
+    # data attributes need a key in the form of "data.key"...
+    data_attributes = options.delete(:data)
+    data_attributes.each_pair do |k,v|
+      post_body << "data.#{k}=#{CGI::escape(v.to_s)}"
+    end if data_attributes
+
+    options.each_pair do |k,v|
+      post_body << "#{k}=#{CGI::escape(v.to_s)}"
+    end
+
+    post_body.join('&')
+  end
+
+  def self.create_notification_request(notification)
+    request = Typhoeus::Request.new(@send_url)
+    notification[:collapse_key] = 'collapse'
+    request.body = build_post_body(notification)
+
+    headers = {
+      'Authorization'  => "GoogleLogin auth=#{@auth_token}",
+      'Content-type'   => 'application/x-www-form-urlencoded',
+        'Content-length' => request.body.length.to_s
+    }
+    request.headers = headers
+    request
+  end
+end

data/lib/c2dm_batch.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+require "yaml"
+require "cgi"
+gem 'typhoeus', '= 0.2.4'
+require "typhoeus"
+
+$:.unshift File.dirname(__FILE__)
+
+module C2dmBatch
+end
+
+require 'c2dm_batch/core'

data/spec/c2dm_batch/core_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe C2dmBatch do
+  before do
+    @config = YAML::load(File.open("config.yml"))
+    C2dmBatch.email = @config['server']['username']
+    C2dmBatch.password = @config['server']['password']
+    C2dmBatch.source = @config['server']['source']
+    @reg_id = @config['client']['registration_id']
+  end
+
+  it "should give an auth token" do
+    auth_code = C2dmBatch.authenticate!
+    auth_code.should_not eql("")
+  end
+
+  it "should send a notifcation" do
+    C2dmBatch.send_notification(create_notification(@reg_id, "boston-college-football"))
+  end
+
+  it "should send notifications in batches" do
+    teams = [ "buffalo-bills", "miami-dolphins", "new-york-jets"]
+    notifications = []
+    teams.each do |team|
+      notifications << create_notification(@reg_id, team)
+    end
+    errors = C2dmBatch.send_batch_notifications(notifications)
+    errors.size.should == 0
+  end
+
+  it "should return InvalidRegistration and registration_id" do
+    teams = [ "buffalo-bills", "miami-dolphins"]
+    notifications = []
+    bad_reg_id = "bad_reg_id"
+    notifications << create_notification(bad_reg_id, teams[0])
+    notifications << create_notification(@reg_id, teams[1])
+    errors = C2dmBatch.send_batch_notifications(notifications)
+    errors.size.should == 1
+    errors[0][:registration_id].should == bad_reg_id
+    errors[0][:error].should == "InvalidRegistration"
+  end
+
+  it "should return MessageToBig status code" do
+    notifications = []
+    notifications << create_notification(@reg_id, "1" * 1025)
+    errors = C2dmBatch.send_batch_notifications(notifications)
+    errors[0][:registration_id].should == @reg_id
+    errors[0][:error].should == "MessageTooBig"
+  end
+
+  it "should abort on 503 and return remaining requests" do
+    hydra = Typhoeus::Hydra.new
+    response = Typhoeus::Response.new(:code => 503, :headers => "", :body => "registration=123")
+    hydra.stub(:post, 'https://android.apis.google.com/c2dm/send').and_return(response)
+    C2dmBatch.instance_variable_set("@hydra", hydra)
+    teams = [ "buffalo-bills", "miami-dolphins", "new-york-jets"]
+    notifications = []
+    teams.each do |team|
+      notifications << create_notification(@reg_id, team)
+    end
+    errors = C2dmBatch.send_batch_notifications(notifications)
+    errors.size.should == 3
+    errors[0][:error].should == 503
+  end
+  
+  private
+  def create_notification(reg_id, team)
+      {
+        :registration_id => reg_id,
+        :collapse_key => "#{1 + rand(100000)}",
+        :data => { 
+          :alert => team,
+          :url => "/articles/816975-nfl-5-players-who-wont-replicate-last-years-success",
+          :tag => team
+        }
+      }
+  end
+
+end

data/spec/c2dm_batch_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe C2dmBatch do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "pp"
+require "bundler"
+
+Bundler.require(:development)
+
+$root = File.expand_path('../../', __FILE__)
+
+require "#{$root}/lib/c2dm_batch"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: c2dm_batch
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Rockwell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: typhoeus
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 2
+        - 4
+        version: 0.2.4
+  type: :runtime
+  version_requirements: *id002
+description: Gem to send android c2dm notifications in batch
+email: 
+- arockwell@gmail.com
+executables: 
+- c2dm_batch
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/c2dm_batch
+- c2dm_batch.gemspec
+- config.example.yml
+- lib/c2dm_batch.rb
+- lib/c2dm_batch/core.rb
+- spec/c2dm_batch/core_spec.rb
+- spec/c2dm_batch_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://alexrockwell.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Gem to send android c2dm notifications in batch
+test_files: 
+- spec/c2dm_batch/core_spec.rb
+- spec/c2dm_batch_spec.rb
+- spec/spec_helper.rb