c2dm 0.2.2 → 0.3.0

data/.gitignore

@@ -1,9 +1,3 @@
-<<<<<<< HEAD
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-=======
 # rcov generated
 coverage
 
@@ -33,7 +27,7 @@ pkg
 #
 # For MacOS:
 #
-#.DS_Store
+.DS_Store
 #
 # For TextMate
 #*.tmproj
@@ -51,4 +45,5 @@ bin
 cache
 gems
 specifications
->>>>>>> a574da36fd93ce0acc0703513e6c77a5b586b502
+Gemfile.lock
+.rvmrc

data/Gemfile

@@ -1,4 +1,3 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in c2dm.gemspec
 gemspec

data/LICENSE.txt

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

data/README.markdown

@@ -1,6 +1,6 @@
 # c2dm
 
-c2dm sends push notifications to Android devices via google [c2dm](http://code.google.com/android/c2dm/index.html).
+c2dm sends push notifications to Android devices via c2dm sends push notifications to Android devices via [Google Cloud Messaging (GCM)](http://code.google.com/android/c2dm/index.html).
 
 ##Installation
 
@@ -8,59 +8,54 @@ c2dm sends push notifications to Android devices via google [c2dm](http://code.g
     
 ##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 [GCM api key](https://code.google.com/apis/console).
 
 ##Usage
 
-*Important*: Version 0.2.0+ decouples auth from sending so the API changed. Please update your code.
-
 There are two ways to use c2dm.
 
-Sending many notifications:
+Sending many individual notifications using a static method:
 
 	notifications = [
 	  {
-	    :registration_id => "...", 
-	    :data => {
-	      :some_message => "Some payload"
-	      :another_message => 10
+	    registration_id: "...1", 
+	    data: {
+	      some_message: "Some payload",
+	      a_value: 10
 	    },
-	    :collapse_key => "foobar" #optional
+	    collapse_key: "foobar" #optional
+    },
+	  {
+	    registration_id: "...2", 
+	    data: {
+	      some_message: "Some other payload",
+	      a_value: 20
+	    }
 	  }
 	]
 	
-	C2DM.authenticate!("your@googleuser.com", "somepassword", "YourCo-App-1.0.0")
+	C2DM.api_key = "YourGCMApiKey" # This initializes all future instances of C2DM with "YourGCMApiKey"
 	C2DM.send_notifications(notifications)
 
-...or one at a time:
-
-	C2DM.authenticate!("your@googleuser.com", "somepassword", "YourCo-App-1.0.0")
-	c2dm = C2DM.new
-
-	notification = {
-	  :registration_id => "...", 
-	  :data => {
-	    :some_message => "Some payload",
-	    :another_message => 10
-	  },
-	  :collapse_key => "foobar" #optional
-	}
+Sending this way will not raise an error but `send_notifications` will return an array of 
+hashes including the `registration_id` and the `response`. If GCM returns an error while C2DM
+is sending one of the notifications, the `response` in the hash of the appropriate notification 
+will be an object of type `C2DM::GCMError`.
 
-	c2dm.send_notification(notification)
+...or one at a time by creating an instance:
 
-Note that calling *authenticate!* will authenticate all new instances of C2DM. You can override this by passing in your own auth_token:
+	c2dm = C2DM.new("YourGCMApiKey")
+	data = {some_message: "Some payload", a_value: 10}
+	collapse_key = "optional_collapse_key"
+	c2dm.send_notification("aRegistrationId", data, collapse_key)
 
-	c2dm = C2DM.new(auth_token)
+Sending using an instance of C2DM will raise a `C2DM::GCMError` error when sending fails.
 
 ##Copyrights
 
-* Copyright (c) 2010-2012 Amro Mousa, Shawn Veader. See LICENSE.txt for details.
+* Copyright (c) 2010-2012 Amro Mousa. See LICENSE.txt for details.
 
 ##Thanks
-
+* [Shawn Veader](https://github.com/veader)
 * [Paul Chun](https://github.com/sixofhearts)
-* [gowalla](https://github.com/gowalla)
-
-##Other stuff
-
-You might want to checkout GroupMe's fork of this gem as well.
+* [gowalla](https://github.com/gowalla)

data/c2dm.gemspec

@@ -3,14 +3,17 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "c2dm"
-  s.version     = "0.2.2"
+  s.version     = "0.3.0"
   s.authors     = ["Amro Mousa"]
   s.email       = ["amromousa@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "http://github.com/amro/c2dm"
   s.summary     = %q{sends push notifications to Android devices}
-  s.description = %q{c2dm sends push notifications to Android devices via google c2dm}
+  s.description = %q{c2dm sends push notifications to Android devices via Google Cloud Messaging (GCM)}
   s.license     = "MIT"
   
+  s.post_install_message = "Warning: C2DM versions 0.3.0 and newer include breaking changes like raising exceptions by default\n" +
+                           "and a slightly different API! Please read more at http://github.com/amro/c2dm before upgrading from 0.2.x!"
+  
   s.rubyforge_project = "c2dm"
 
   s.files         = `git ls-files`.split("\n")

data/lib/c2dm.rb

@@ -1,98 +1,83 @@
 require 'httparty'
-require 'cgi'
+require 'json'
 
 class C2DM
   include HTTParty
-  default_timeout 30
+  format :plain
+  default_timeout 10
 
-  attr_accessor :timeout, :auth_token
+  attr_accessor :timeout, :api_key
 
-  AUTH_URL = 'https://www.google.com/accounts/ClientLogin'
-  PUSH_URL = 'https://android.apis.google.com/c2dm/send'
+  GCMError = Class.new(StandardError)
+  API_ENDPOINT = 'https://android.googleapis.com/gcm/send'
 
   class << self
-    attr_accessor :auth_token
-
-    def authenticate!(username, password, source = nil)
-      auth_options = {
-        'accountType' => 'HOSTED_OR_GOOGLE',
-        'service'     => 'ac2dm',
-        'Email'       => username,
-        'Passwd'      => password,
-        'source'      => source || 'MyCompany-MyAppName-1.0'
-      }
-      post_body = build_post_body(auth_options)
-
-      params = {
-        :body    => post_body,
-        :headers => {
-          'Content-type'   => 'application/x-www-form-urlencoded',
-          'Content-length' => post_body.length.to_s
-        }
-      }
-
-      response = self.post(AUTH_URL, params)
-
-      # check for authentication failures
-      raise response.parsed_response if response['Error=']
-
-      @auth_token = response.body.split("\n")[2].gsub('Auth=', '')
-    end
+    attr_accessor :api_key
 
+    # send_notifications([
+    #   {registration_id: "aRegId1", data: {some_message: "hello", a_value: 5}, collapse_key: "optional_collapse_key"},
+    #   {registration_id: "aRegId2", data: {some_message: "weeee", a_value: 1}},
+    #   ...
+    # ])
     def send_notifications(notifications = [])
-      c2dm = C2DM.new(@auth_token)
+      c2dm = C2DM.new(@api_key)
       notifications.collect do |notification|
+        response = nil
+
+        begin
+          response = c2dm.send_notification(notification[:registration_id], notification[:data], notification[:collapse_key])
+        rescue GCMError => e
+          response = e
+        end
+        
         {
-          :body => c2dm.send_notification(notification),
-          :registration_id => notification[:registration_id]
+          "registration_id" => notification[:registration_id],
+          "response" => response
         }
       end
     end
-    
-    def 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
-    
   end
 
-  def initialize(auth_token = nil)
-    @auth_token = auth_token || self.class.auth_token
+  def initialize(api_key = nil)
+    @api_key = api_key || self.class.api_key
   end
 
-  # {
-  #   :registration_id => "...",
-  #   :data => {
-  #     :some_message => "Hi!", 
-  #     :another_message => 7
-  #   }
-  #   :collapse_key => "optional collapse_key string"
-  # }
-  def send_notification(options)
-    options[:collapse_key] ||= 'foo'
-    post_body = self.class.build_post_body(options)
-
-    params = {
-      :body    => post_body,
-      :headers => {
-        'Authorization'  => "GoogleLogin auth=#{@auth_token}",
-        'Content-type'   => 'application/x-www-form-urlencoded',
-        'Content-length' => "#{post_body.length}"
-      }
+  # send_notification("aRegId...", {some_message: "hello", a_value: 5}, "optional collapse_key")
+  def send_notification(registration_id, data, collapse_key = nil)
+    raise GCMError.new("registration_id must be a String") unless registration_id.is_a?(String)
+    
+    payload = {
+      registration_ids: [registration_id],
+      data: data, 
+      collapse_key: collapse_key
     }
 
-    self.class.post(PUSH_URL, params)
+    parse_response(send(payload))
+  end
+  
+  private
+  def send(payload)
+    self.class.post(API_ENDPOINT, body: payload.to_json, headers: request_headers)
+  end
+  
+  def request_headers
+    {
+      "Authorization" => "key=#{@api_key}",
+      "Content-Type" => "application/json"
+    }
+  end
+  
+  def parse_response(response)
+    begin
+      parsed_response = JSON.parse(response.body)
+      
+      if (parsed_response["results"].first["error"])
+        raise GCMError.new(parsed_response["results"].first["error"])
+      end
+      
+      parsed_response
+    rescue JSON::ParserError
+      raise GCMError.new(response.body)
+    end
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: c2dm
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-24 00:00:00.000000000 Z
+date: 2013-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -43,7 +43,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: c2dm sends push notifications to Android devices via google c2dm
+description: c2dm sends push notifications to Android devices via Google Cloud Messaging
+  (GCM)
 email:
 - amromousa@gmail.com
 executables: []
@@ -58,10 +59,14 @@ files:
 - Rakefile
 - c2dm.gemspec
 - lib/c2dm.rb
-homepage: ''
+homepage: http://github.com/amro/c2dm
 licenses:
 - MIT
-post_install_message: 
+post_install_message: ! 'Warning: C2DM versions 0.3.0 and newer include breaking changes
+  like raising exceptions by default
+
+  and a slightly different API! Please read more at http://github.com/amro/c2dm before
+  upgrading from 0.2.x!'
 rdoc_options: []
 require_paths:
 - lib