gcm 0.0.2 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c2094f1f941e71303802d03af0af0c60841598e
+  data.tar.gz: 533de2aad017e25cc44b8d56af68932655869881
+SHA512:
+  metadata.gz: b9d5138d41d34d02bffc3b8c0c6a71d61b7862b4eb9c8de5647df9cc52e127b9e5510709de0bfb13a346823588eb6740b41e4de51c7fa19ef4192a5560b2cb83
+  data.tar.gz: a838377705386fe708f8cdfc281fba52d586c36d9da3472fe3d7086016a2ee1228ae6a22745b0049c8d5ad5d3afe25b242b61f894bf68c1b9dbbc6d164d2e648

data/.gitignore

@@ -14,7 +14,7 @@ doc
 # jeweler generated
 pkg
 
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
 #
 # * Create a file at ~/.gitignore
 # * Include files you want ignored
@@ -47,3 +47,4 @@ gems
 specifications
 Gemfile.lock
 .rvmrc
+spec/reports

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -1,6 +1,7 @@
-source "http://rubygems.org"
-
+source "https://rubygems.org"
 gemspec
 
+gem 'rake'
 gem 'rspec'
 gem 'webmock'
+gem "ci_reporter"

data/README.md

@@ -1,4 +1,5 @@
 # Google Cloud Messaging for Android (GCM)
+[![Build Status](https://secure.travis-ci.org/shamithc/gcm.png?branch=master)](http://travis-ci.org/shamithc/gcm)
 
 GCM sends notifications to Android devices via [GCM](http://developer.android.com/guide/google/gcm/gcm.html).
 
@@ -12,24 +13,27 @@ An Android device running 2.0 or newer and an API key as per [GCM getting starte
 
 ##Usage
 
-
 Sending notifications:
 
 ```ruby
+require 'gcm'
+
 gcm = GCM.new(api_key)
 registration_ids= ["12", "13"] # an array of one or more client registration IDs
-options = {body: data: {key: "value"}}
+options = {data: {score: "123"}, collapse_key: "updated_score"}
 response = gcm.send_notification(registration_ids, options)
 ```
 
 Currently `response` is just a hash containing the response `body`, `headers` and `status`.
 
-##Copyright
+If the above code is stored in a file like `trigger_gcm.rb`, thats how you can call it.
 
-* Copyright (c) 2012 Kashif Rasul and Shoaib Burq. See LICENSE.txt for details.
+	$ ruby -rubygems trigger_gcm.rb
 
-##Thanks
+##MIT License
+
+* Copyright (c) 2012 Kashif Rasul and Shoaib Burq. See LICENSE.txt for details.
 
-This gem is based on a fork of the older Google push service:
+##Many thanks to all the contributors
 
-* [Amro Mousa](https://github.com/amro/c2dm/)
+* [Contributors](https://github.com/spacialdb/gcm/contributors)

data/Rakefile

@@ -1 +1,17 @@
+require 'rspec/core/rake_task'
 require "bundler/gem_tasks"
+require "rake/tasklib"
+require 'ci/reporter/rake/rspec'
+
+RSpec::Core::RakeTask.new(:spec => ["ci:setup:rspec"]) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--format documentation']
+end
+
+
+task :default => :spec

data/gcm.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "gcm"
-  s.version     = "0.0.2"
+  s.version     = "0.0.4"
   s.authors     = ["Amro Mousa", "Kashif Rasul", "Shoaib Burq"]
   s.email       = ["amromousa@gmail.com", "kashif@spacialdb.com", "shoaib@spacialdb.com"]
   s.homepage    = "http://github.com/spacialdb/gcm"

data/lib/gcm.rb

@@ -31,22 +31,36 @@ class GCM
     post_body = build_post_body(registration_ids, options)
 
     params = {
-      :body    => post_body.to_json,
+      :body => post_body.to_json,
       :headers => {
-        'Authorization'  => "key=#{@api_key}",
-        'Content-Type'   => 'application/json',
+        'Authorization' => "key=#{@api_key}",
+        'Content-Type' => 'application/json',
       }
     }
 
     response = self.class.post('', params)
-    {body: response.body, headers: response.headers, status: response.code}
+    build_response(response)
   end
 
   private
 
   def build_post_body(registration_ids, options={})
-    body = {registration_ids: registration_ids}.merge(options)
-    #raise exception if options[:time_to_live] && !options[:collapse_key]
+    { :registration_ids => registration_ids }.merge(options)
   end
 
+  def build_response(response)
+    case response.code
+      when 200
+        body = response.body || {}
+        { :response => 'success', :body => body, :headers => response.headers, :status_code => response.code }
+      when 400
+        { :response => 'Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields.', :status_code => response.code }
+      when 401
+        { :response => 'There was an error authenticating the sender account.', :status_code => response.code }
+      when 500
+        { :response => 'There was an internal error in the GCM server while trying to process the request.', :status_code => response.code }
+      when 503
+        { :response => 'Server is temporarily unavailable.', :status_code => response.code }
+    end
+  end
 end

data/spec/gcm_spec.rb

@@ -13,7 +13,7 @@ describe GCM do
     let(:api_key) { 'AIzaSyB-1uEai2WiUapxCs2Q0GZYzPu7Udno5aA' }
     let(:registration_ids) { [ "42" ]}
     let(:valid_request_body) do
-      { registration_ids: registration_ids }
+      { :registration_ids => registration_ids }
     end
     let(:valid_request_headers) do
       {
@@ -24,35 +24,126 @@ describe GCM do
 
     before(:each) do
       stub_request(:post, GCM::PUSH_URL).with(
-        body: valid_request_body.to_json,
-        headers: valid_request_headers
+        :body => valid_request_body.to_json,
+        :headers => valid_request_headers
       ).to_return(
         # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
-        body: {},
-        headers: {},
-        status: 200
+        :body => {},
+        :headers => {},
+        :status => 200
       )
     end
 
     it "should send notification using POST to GCM server" do
       gcm = GCM.new(api_key)
-      gcm.send_notification(registration_ids).should eq({body: {}, headers: {}, status: 200})
+      gcm.send_notification(registration_ids).should eq({:response => 'success', :body => {}, :headers => {}, :status_code => 200})
     end
 
     context "send notification with data" do
       let!(:stub_with_data){
         stub_request(:post, GCM::PUSH_URL).
-          with(body: "{\"registration_ids\":[\"42\"],\"data\":{\"score\":\"5x1\",\"time\":\"15:10\"}}",
-               headers: valid_request_headers ).
-          to_return(status: 200, body: "", headers: {})
+          with(:body => "{\"data\":{\"score\":\"5x1\",\"time\":\"15:10\"},\"registration_ids\":[\"42\"]}",
+               :headers => valid_request_headers ).
+          to_return(:status => 200, :body => "", :headers => {})
       }
       before do
       end
       it "should send the data in a post request to gcm" do
         gcm = GCM.new(api_key)
-        gcm.send_notification(registration_ids, { data: { score: "5x1", time: "15:10"} })
+        gcm.send_notification(registration_ids, { :data => { :score => "5x1", :time => "15:10"} })
         stub_with_data.should have_been_requested
       end
     end
+
+    context " when send_notification responds with failure" do
+
+      let(:mock_request_attributes) do
+        {
+          :body => valid_request_body.to_json,
+          :headers => valid_request_headers
+        }
+      end
+
+      subject { GCM.new(api_key) }
+
+      context "on failure code 400" do
+        before do
+          stub_request(:post, GCM::PUSH_URL).with(
+            mock_request_attributes
+          ).to_return(
+            # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
+            :body => {},
+            :headers => {},
+            :status => 400
+          )
+        end
+        it "should not send notification due to 400" do
+          subject.send_notification(registration_ids).should eq({
+            :response => "Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields.",
+            :status_code => 400
+          })
+        end
+      end
+
+      context "on failure code 401" do
+        before do
+          stub_request(:post, GCM::PUSH_URL).with(
+            mock_request_attributes
+          ).to_return(
+            # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
+            :body => {},
+            :headers => {},
+            :status => 401
+          )
+        end
+
+        it "should not send notification due to 401" do
+          subject.send_notification(registration_ids).should eq({
+            :response => "There was an error authenticating the sender account.",
+            :status_code => 401
+          })
+        end
+      end
+
+      context "on failure code 500" do
+        before do
+          stub_request(:post, GCM::PUSH_URL).with(
+            mock_request_attributes
+          ).to_return(
+            # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
+            :body => {},
+            :headers => {},
+            :status => 500
+          )
+        end
+
+        it "should not send notification due to 500" do
+          subject.send_notification(registration_ids).should eq({
+            :response => 'There was an internal error in the GCM server while trying to process the request.',
+            :status_code => 500
+          })
+        end
+      end
+
+      context "on failure code 503" do
+        before do
+          stub_request(:post, GCM::PUSH_URL).with(
+            mock_request_attributes
+          ).to_return(
+            # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
+            :body => {},
+            :headers => {},
+            :status => 503
+          )
+        end
+
+        it "should not send notification due to 503" do
+          subject.send_notification(registration_ids).should eq({
+            :response => 'Server is temporarily unavailable.',
+            :status_code => 503
+          })
+        end
+      end
+    end
   end
-end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gcm
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Amro Mousa
@@ -11,38 +10,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2013-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: gcm is a service that helps developers send data from servers to their
@@ -57,6 +52,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -68,29 +64,27 @@ files:
 homepage: http://github.com/spacialdb/gcm
 licenses:
 - MIT
+metadata: {}
 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: gcm
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: send data to Android applications on Android devices
 test_files:
 - spec/gcm_spec.rb
 - spec/spec_helper.rb
-has_rdoc: