speedy_c2dm 0.1.1 → 1.0.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.rvmrc

data/README.markdown

@@ -1,12 +1,14 @@
-# c2dm
+# Speedy C2DM
 
-c2dm sends push notifications to Android devices via google [c2dm](http://code.google.com/android/c2dm/index.html).
+Speedy C2DM sends push notifications to Android devices via Google's [c2dm](http://code.google.com/android/c2dm/index.html) (Cloud To Device Messaging).
+
+Pull requests are welcome!
 
 # 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.  
+To use C2DM, your application server needs to fetch and store an authentication token 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 approach 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 C2DM notification sent.
 
-This GEM will request the token when the SpeedyC2DM::API class is first initialized.  From then on, calls to SpeedyC2DM::API.send_notification() will use the auth token stored in the class instance variable.  On subsequent notification calls, the object will check for 'Update-Client-Auth' or check for status 401 (auth failed).  If it detects either of these, it will immediately 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](https://github.com/lantins/resque-retry)).
+This GEM will request the token when the SpeedyC2DM::API.send_notification() class method is first called.  From then on, calls to SpeedyC2DM::API.send_notification() will use the auth token stored in the class instance variable.  On subsequent notification calls, the object will check for 'Update-Client-Auth' or check for status 401 (auth failed).  If it detects either the 401 or an 'Update-Client-Auth' header, speedy_c2dm will immediately request new tokens from Google.  In the case of status 503 (service unavailable), a return message indicating 503 is returned from the send_notification() call.  It is suggested (by Google) that you retry after exponential back-off in the case of 503.  Using something like [resque-retry](https://github.com/lantins/resque-retry) would work well in this case.
 
 ##Installation
 
@@ -14,33 +16,46 @@ This GEM will request the token when the SpeedyC2DM::API class is first initiali
     
 ##Requirements
 
-An Android device running 2.2 or newer, its registration token, and a google account registered for c2dm.
+An Android device running 2.2 or newer, its registration token, and a Google account registered for c2dm.
+
+##Compatibility
+
+Speedy_C2DM will work with Rails 3.x & Ruby 1.9x.  It has not been tested on previous versions or Rails or Ruby, and may or may not work with those versions.
 
 ##Usage
 
-c2dm = SpeedyC2DM::API.new(TEST_EMAIL, TEST_PASSWORD)
+For a Rails app, a good place to put the following would be in config/initializers/speedy_c2dm.rb :
+
+    C2DM_API_EMAIL = "myemail@gmail.com"
+    C2DM_API_PASSWORD = "mypassword"
 
-options = {
-  :registration_id => TEST_REGISTRATION_ID,
-  :message => "Hi!",
-  :extra_data => 42,
-  :collapse_key => "some-collapse-key"
-}
+    SpeedyC2DM::API.set_account(C2DM_API_EMAIL, C2DM_API_PASSWORD)
 
-response = c2dm.send_notification(options)
+Then, where you want to make a C2DM call in your code, create an options hash and pass it to send_notification():
 
-Note:  there are blocking calls in both .new() and .send_notification().  You should use an async queue like Resque to ensure non-blocking behavior in your application code.
+    options = {
+      :registration_id => SOME_REGISTRATION_ID,
+      :message => "Hi!",
+      :extra_data => 42,
+      :collapse_key => "some-collapse-key"
+    }
+
+    response = SpeedyC2DM::API.send_notification(options)
+
+Note:  there are blocking calls in both .new() and .send_notification().  You should use an async queue like [Resque](https://github.com/defunkt/resque) to ensure a non-blocking code path in your application code, particularly for the .send_notification() call.
 
 
 ##Testing
 
-to test, first fill out these variables in test/test_speedy_c2dm.rb:
-  TEST_EMAIL = "TODO - Fill me"
-  TEST_PASSWORD = "TODO - Fill me"
-  TEST_REGISTRATION_ID = "TODO - Fill me"  
+To test, first fill out these variables in test/test_speedy_c2dm.rb:
+
+    API_ACCOUNT_EMAIL = "TODO - Your C2DM account email"
+    API_ACCOUNT_PASSWORD = "TODO - Your C2DM account password"
+    TEST_PHONE_C2DM_REGISTRATION_ID = "TODO - Some C2DM registration id you want to test push notification to"
 
 then run:
-	$ ruby test/test_speedy_c2dm.rb
+
+  	$ ruby test/test_speedy_c2dm.rb
 
 ##Copyrights
 

data/lib/speedy_c2dm/version.rb

@@ -1,3 +1,3 @@
 module SpeedyC2dm
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/speedy_c2dm.rb

@@ -1,103 +1,106 @@
 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
+    class << self
 
-    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
+      def set_account(api_email, api_password)
+        @email = api_email
+        @password = api_password
+      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)
+        get_auth_token(@email, @password) unless @auth_token
+
+        response = notificationRequest(options)
+
+        # 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.
+          response.each_header do |key, value|
+            if key == "Update-Client-Auth"
+              @auth_token = value
+            end
+          end
+
+          return response
+
+        elsif response.code.eql? "401"
+
+          # auth failed.  Refresh auth key and requeue
+          @auth_token = get_auth_token(@email, @password)
+
+          response = notificationRequest(options)
+
+          return response
+
+        elsif response.code.eql? "503"
+
+          # service un-available.
+          return response
 
-    # 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 = response.headers_hash['Update-Client-Auth']
         end
-        return response.inspect
+      end
 
-      elsif response.code.eql? 401
+      def get_auth_token(email, password)
+        data = "accountType=HOSTED_OR_GOOGLE&Email=#{email}&Passwd=#{password}&service=ac2dm"
+        headers = { "Content-type" => "application/x-www-form-urlencoded",
+                    "Content-length" => "#{data.length}"}
 
-        # 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
+        uri = URI.parse(AUTH_URL)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
-        response_inner = request.response
-        return response.inspect
+        response, body = http.post(uri.path, data, headers)
+        return body.split("\n")[2].gsub("Auth=", "")
+      end
 
-      elsif response.code.eql? 503
-        
-        # service un-available.
-        return response.inspect
+      def notificationRequest(options)
+        data = {}
+        options.each do |key, value|
+          if [:registration_id, :collapse_key].include? key
+            data[key] = value
+          else
+            data["data.#{key}"] = value
+          end
+        end
+
+        data = data.map{|k, v| "&#{k}=#{URI.escape(v.to_s)}"}.reduce{|k, v| k + v}
+        headers = { "Authorization" => "GoogleLogin auth=#{@auth_token}",
+                    "Content-length" => "#{data.length}" }
+        uri = URI.parse(PUSH_URL)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
+        http.post(uri.path, data, headers)
       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

@@ -17,6 +17,4 @@ Gem::Specification.new do |s|
   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/test_speedy_c2dm.rb

@@ -3,35 +3,34 @@ 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"
+  API_ACCOUNT_EMAIL = "TODO - Fill me"
+  API_ACCOUNT_PASSWORD = "TODO - Fill me"
+  TEST_PHONE_C2DM_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)
+      SpeedyC2DM::API.set_account(API_ACCOUNT_EMAIL, API_ACCOUNT_PASSWORD)
     end
   end
   
   should "raise an error if the email/password is not provided" do
     assert_raise(ArgumentError) do
-      SpeedyC2DM::API.new()
+      SpeedyC2DM::API.set_account()
     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)
+      SpeedyC2DM::API.set_account(API_ACCOUNT_EMAIL, API_ACCOUNT_PASSWORD)
 
       options = {
-        :registration_id => TEST_REGISTRATION_ID,
+        :registration_id => TEST_PHONE_C2DM_REGISTRATION_ID,
         :message => "Hi!",
         :extra_data => 42,
         :collapse_key => "some-collapse-key"
       }
 
-      response = speedyC2DM.send_notification(options)
+      response = SpeedyC2DM::API.send_notification(options)
     end
   end
       

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: speedy_c2dm
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,20 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-01 00:00:00.000000000 -04:00
+date: 2011-11-03 00:00:00.000000000 -04:00
 default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: typhoeus
-  requirement: &2153057240 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *2153057240
+dependencies: []
 description: Speedy C2DM efficiently sends push notifications to Android devices via
   google c2dm.
 email: