speedy_c2dm 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use "ruby-1.9.2-p290@speedy_c2dm"

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in speedy_c2dm.gemspec
+gemspec
+
+group :development do
+	gem "shoulda"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Amro Mousa, (c) 2011 Brandon Keene, (c) 2011 Sandeep Ghael
+
+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.markdown

@@ -0,0 +1,34 @@
+# c2dm
+
+c2dm sends push notifications to Android devices via google [c2dm](http://code.google.com/android/c2dm/index.html).
+
+# How is this GEM different than other C2DM gems?
+
+To use C2DM the server needs to fetch and store authenticaion tokens from Google.  This token will periodically expire, and the recommendation from Google is that "the server should store the token and have a policy to refresh it periodically."   Other C2DM gems take a brute force method around this issue, by requesting a new authenticaion token from Google for *each* notification request they send.  This effectively doubles the number of HTTP calls being made for each notification.  
+
+This GEM will request the token when the SpeedyC2DM::API class is first initialized.  From then on, it will use the auth token stored as an instance variable.  On subsequent notification calls, it will check for 'Update-Client-Auth' or check for status 401 (auth failed).  When it detects either of these, it will then request new tokens from Google servers.  In the case of status 503 (service unavailable), a return message indicating 503 is returned.  It is suggested that you retry after exponential back-off in the case of 503 (using something like resque-retry).
+
+##Installation
+
+    $ gem install speedy_c2dm
+    
+##Requirements
+
+An Android device running 2.2 or newer, its registration token, and a google account registered for c2dm.
+
+##Usage
+
+c2dm = SpeedyC2DM::API.new(TEST_EMAIL, TEST_PASSWORD)
+
+options = {
+  :registration_id => TEST_REGISTRATION_ID,
+  :message => "Hi!",
+  :extra_data => 42,
+  :collapse_key => "some-collapse-key"
+}
+
+response = c2dm.send_notification(options)
+
+##Copyrights
+
+* See LICENSE.txt for details.

data/Rakefile

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

data/lib/speedy_c2dm/version.rb

@@ -0,0 +1,3 @@
+module SpeedyC2dm
+  VERSION = "0.1.0"
+end

data/lib/speedy_c2dm.rb

@@ -0,0 +1,110 @@
+require "speedy_c2dm/version"
+require 'typhoeus'
+
+module SpeedyC2DM
+      
+  class API
+    AUTH_URL = 'https://www.google.com/accounts/ClientLogin'
+    PUSH_URL = 'https://android.apis.google.com/c2dm/send'
+    
+    # Initialize with an API key and config options
+    def initialize(email, password)
+      @email = email
+      @password = password
+
+      @auth_token = get_auth_token(@email, @password)
+    end
+
+    def get_auth_token(email, password)
+      post_body = "accountType=HOSTED_OR_GOOGLE&Email=#{email}&Passwd=#{password}&service=ac2dm"
+      params = {
+        :body => post_body,
+        :headers => {
+          'Content-type' => 'application/x-www-form-urlencoded',
+          'Content-length' => "#{post_body.length}"
+        }
+      }
+      response = Typhoeus::Request.post(AUTH_URL, params)
+      return response.body.split("\n")[2].gsub("Auth=", "")      
+    end
+
+    # Send a notification
+    #
+    # :registration_id is required.
+    # :collapse_key is optional.
+    #
+    # Other +options+ will be sent as "data.<key>=<value>"
+    #
+    # +options+ = {
+    #   :registration_id => "...",
+    #   :message => "Hi!",
+    #   :extra_data => 42,
+    #   :collapse_key => "some-collapse-key"
+    # }
+    def send_notification(options)
+      request = requestObject(options)
+
+      hydra = Typhoeus::Hydra.new
+      hydra.queue request
+      hydra.run # this is a blocking call that returns once all requests are complete
+      
+      # the response object will be set after the request is run
+      response = request.response
+      
+      # the response can be one of three codes:  
+      #   200 (success)
+      #   401 (auth failed)
+      #   503 (retry later with exponential backoff)
+      #   see more documentation here:  http://code.google.com/android/c2dm/#testing
+      if response.code.eql? 200
+
+        # look for the header 'Update-Client-Auth' 
+        # in the response you get after sending a message. It indicates that 
+        # this is the token to be used for the next message to send.
+        if response.headers_hash['Update-Client-Auth']
+          @auth_token = get_auth_token(@email, @password)
+        end
+        return "success: 200"
+
+      elsif response.code.eql? 401
+
+        # auth failed.  Refresh auth key and requeue
+        @auth_token = get_auth_token(@email, @password)
+        hydra.queue request(options)
+        hydra.run # this is a blocking call that returns once all requests are complete
+
+        response_inner = request.response
+        if response_inner.code.eql? 200
+          return "success"
+        elsif response_inner.code.eql? 401
+          return "failed: 401 - auth failed"
+        elsif response_inner.code.eql? 503
+          return "failed: 503 - service unavailable"        
+        end
+
+      elsif response.code.eql? 503
+
+        # service un-available.
+        return "failed: 503 - service unavailable"
+
+      end
+    end
+  
+    def requestObject(options)
+      payload = {}
+      payload[:registration_id] = options.delete(:registration_id)
+      payload[:collapse_key] = options.delete(:collapse_key)
+      options.each {|key, value| payload["data.#{key}"] = value}
+
+      Typhoeus::Request.new(PUSH_URL, {
+        :method => :post,
+        :params   => payload,
+        :headers  => {
+          'Authorization' => "GoogleLogin auth=#{@auth_token}"
+        }
+      })
+    end
+    
+  end
+
+end

data/speedy_c2dm.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "speedy_c2dm/version"
+
+Gem::Specification.new do |s|
+  s.name        = "speedy_c2dm"
+  s.version     = SpeedyC2dm::VERSION
+  s.authors     = ["Sandeep Ghael"]
+  s.email       = ["sghael@ravidapp.com"]
+  s.homepage    = ""
+  s.summary     = %q{Speedy C2DM is an intelligent gem for sending push notifications to Android devices via Google C2DM.}
+  s.description = %q{Speedy C2DM sends push notifications to Android devices via google c2dm.}
+
+  s.rubyforge_project = "speedy_c2dm"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "typhoeus"
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'speedy_c2dm'
+
+class Test::Unit::TestCase
+end

data/test/test_speedy_c2dm.rb

@@ -0,0 +1,38 @@
+current_dir = File.expand_path(File.dirname(__FILE__))
+require File.join(current_dir, 'helper')
+
+class TestSpeedyC2DM < Test::Unit::TestCase
+    
+  TEST_EMAIL = "TODO - Fill me"
+  TEST_PASSWORD = "TODO - Fill me"
+  INVALID_TEST_EMAIL = "foo-bar.com"
+  TEST_REGISTRATION_ID = "TODO - Fill me"
+
+  should "not raise an error if the API key is valid" do
+    assert_nothing_raised do
+      SpeedyC2DM::API.new(TEST_EMAIL, TEST_PASSWORD)
+    end
+  end
+  
+  should "raise an error if the email/password is not provided" do
+    assert_raise(ArgumentError) do
+      SpeedyC2DM::API.new()
+    end
+  end
+
+  should "not raise an error if a send notification call succeeds" do
+    assert_nothing_raised do
+      speedyC2DM = SpeedyC2DM::API.new(TEST_EMAIL, TEST_PASSWORD)
+
+      options = {
+        :registration_id => TEST_REGISTRATION_ID,
+        :message => "Hi!",
+        :extra_data => 42,
+        :collapse_key => "some-collapse-key"
+      }
+
+      response = speedyC2DM.send_notification(options)
+    end
+  end
+      
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: speedy_c2dm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sandeep Ghael
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-01 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &2157328800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157328800
+description: Speedy C2DM sends push notifications to Android devices via google c2dm.
+email:
+- sghael@ravidapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- lib/speedy_c2dm.rb
+- lib/speedy_c2dm/version.rb
+- speedy_c2dm.gemspec
+- test/helper.rb
+- test/test_speedy_c2dm.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: speedy_c2dm
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Speedy C2DM is an intelligent gem for sending push notifications to Android
+  devices via Google C2DM.
+test_files:
+- test/helper.rb
+- test/test_speedy_c2dm.rb