gcm 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c2094f1f941e71303802d03af0af0c60841598e
-  data.tar.gz: 533de2aad017e25cc44b8d56af68932655869881
+  metadata.gz: 48e5d1ac537918960d5702a017f448561502ad78
+  data.tar.gz: 2524bc50e068dbd90fc0b2d1c5eb012011edc963
 SHA512:
-  metadata.gz: b9d5138d41d34d02bffc3b8c0c6a71d61b7862b4eb9c8de5647df9cc52e127b9e5510709de0bfb13a346823588eb6740b41e4de51c7fa19ef4192a5560b2cb83
-  data.tar.gz: a838377705386fe708f8cdfc281fba52d586c36d9da3472fe3d7086016a2ee1228ae6a22745b0049c8d5ad5d3afe25b242b61f894bf68c1b9dbbc6d164d2e648
+  metadata.gz: 35fb8ca2fd2b83e4226a6d24a034923ce5a2281accf4261c1663873f2d3cd79c47306dcca9d9dd1e79a97ffeb3ba21477d8bc3102c63f441610634bdb3263c86
+  data.tar.gz: 994846feefe82634bd46e0aa530367cc8e7514cb635a9d977cc29dfdd9859bf1c3b3820258d9a90e6772462e4d47552c68d6219e1421dc7c3f4e28b34a1c13b9

data/.travis.yml

@@ -1,3 +1,5 @@
+language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -2,6 +2,6 @@ source "https://rubygems.org"
 gemspec
 
 gem 'rake'
-gem 'rspec'
+gem 'rspec', '~> 3.0.0.beta'
 gem 'webmock'
 gem "ci_reporter"

data/README.md

@@ -1,5 +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)
+[![Build Status](https://secure.travis-ci.org/spacialdb/gcm.png?branch=master)](http://travis-ci.org/spacialdb/gcm)
 
 GCM sends notifications to Android devices via [GCM](http://developer.android.com/guide/google/gcm/gcm.html).
 
@@ -11,6 +11,12 @@ GCM sends notifications to Android devices via [GCM](http://developer.android.co
 
 An Android device running 2.0 or newer and an API key as per [GCM getting started guide](http://developer.android.com/guide/google/gcm/gs.html).
 
+One of the following, tested Ruby versions:
+
+* `1.9.3`
+* `2.0.0`
+* `2.1.0`
+
 ##Usage
 
 Sending notifications:
@@ -30,6 +36,18 @@ If the above code is stored in a file like `trigger_gcm.rb`, thats how you can c
 
 	$ ruby -rubygems trigger_gcm.rb
 
+## Blog posts
+
+* [How to send iOS and Android notifications from your Rails backend](http://blog.wellwith.me/how-to-send-ios-and-android-notifications-from-your-rails-backend)
+
+## ChangeLog
+
+### Version 0.0.5
+
+* Added support for canonical registration ID
+* Only support Ruby versions [>= 1.9.3](https://www.ruby-lang.org/en/news/2014/01/10/ruby-1-9-3-will-end-on-2015/)
+* Fixed Rspec deprecation warnings for Rspec 3.0.0.beta
+
 ##MIT License
 
 * Copyright (c) 2012 Kashif Rasul and Shoaib Burq. See LICENSE.txt for details.

data/gcm.gemspec

@@ -3,14 +3,17 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "gcm"
-  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"
+  s.version     = "0.0.5"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kashif Rasul", "Shoaib Burq"]
+  s.email       = ["kashif@spacialdb.com", "shoaib@spacialdb.com"]
+  s.homepage    = "https://github.com/spacialdb/gcm"
   s.summary     = %q{send data to Android applications on Android devices}
   s.description = %q{gcm is a service that helps developers send data from servers to their Android applications on Android devices.}
   s.license     = "MIT"
 
+  s.required_ruby_version     = '>= 1.9.3'
+
   s.rubyforge_project = "gcm"
 
   s.files         = `git ls-files`.split("\n")

data/lib/gcm.rb

@@ -39,7 +39,7 @@ class GCM
     }
 
     response = self.class.post('', params)
-    build_response(response)
+    build_response(response, registration_ids)
   end
 
   private
@@ -48,11 +48,11 @@ class GCM
     { :registration_ids => registration_ids }.merge(options)
   end
 
-  def build_response(response)
+  def build_response(response, registration_ids)
     case response.code
       when 200
         body = response.body || {}
-        { :response => 'success', :body => body, :headers => response.headers, :status_code => response.code }
+        { :response => 'success', :body => body, :headers => response.headers, :status_code => response.code, :canonical_ids => build_canonical_ids(body, registration_ids) }
       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
@@ -63,4 +63,21 @@ class GCM
         { :response => 'Server is temporarily unavailable.', :status_code => response.code }
     end
   end
+
+  def build_canonical_ids(body, registration_ids)
+    canonical_ids = []
+    unless body.empty?
+      body = JSON.parse(body)
+      if body['canonical_ids'] > 0
+        body['results'].each_with_index do |result, index|
+          canonical_ids << { :old => registration_ids[index], :new => result['registration_id'] } if has_canonical_id?(result)
+        end
+      end
+    end
+    canonical_ids
+  end
+
+  def has_canonical_id?(result)
+    !result['registration_id'].nil?
+  end
 end

data/spec/gcm_spec.rb

@@ -36,13 +36,13 @@ describe GCM do
 
     it "should send notification using POST to GCM server" do
       gcm = GCM.new(api_key)
-      gcm.send_notification(registration_ids).should eq({:response => 'success', :body => {}, :headers => {}, :status_code => 200})
+      gcm.send_notification(registration_ids).should eq({:response => 'success', :body => {}, :headers => {}, :status_code => 200, :canonical_ids => []})
     end
 
     context "send notification with data" do
       let!(:stub_with_data){
         stub_request(:post, GCM::PUSH_URL).
-          with(:body => "{\"data\":{\"score\":\"5x1\",\"time\":\"15:10\"},\"registration_ids\":[\"42\"]}",
+          with(:body => "{\"registration_ids\":[\"42\"],\"data\":{\"score\":\"5x1\",\"time\":\"15:10\"}}",
                :headers => valid_request_headers ).
           to_return(:status => 200, :body => "", :headers => {})
       }
@@ -145,5 +145,47 @@ describe GCM do
         end
       end
     end
+
+    context " when send_notification responds canonical_ids" do
+
+      let(:mock_request_attributes) do
+        {
+            :body => valid_request_body.to_json,
+            :headers => valid_request_headers
+        }
+      end
+
+      let(:valid_response_body_with_canonical_ids) do
+        {
+            :canonical_ids => 1, :results => [{:registration_id => "43", :message_id => "0:1385025861956342%572c22801bb3" }]
+        }
+      end
+
+      subject { GCM.new(api_key) }
+
+
+      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 => valid_response_body_with_canonical_ids.to_json,
+            :headers => {},
+            :status => 200
+        )
+      end
+
+      it "should contain canonical_ids" do
+        response = subject.send_notification(registration_ids)
+
+        response.should  eq({
+                                                                  :headers => {},
+                                                                  :canonical_ids => [{:old => "42", :new => "43"}],
+                                                                  :status_code => 200,
+                                                                  :response => 'success',
+                                                                  :body => "{\"canonical_ids\":1,\"results\":[{\"registration_id\":\"43\",\"message_id\":\"0:1385025861956342%572c22801bb3\"}]}"
+                                                                })
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -5,7 +5,9 @@ require 'webmock/rspec'
 require 'gcm'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
   # config.filter_run :focus
 end

metadata

@@ -1,58 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: gcm
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
-- Amro Mousa
 - Kashif Rasul
 - Shoaib Burq
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-04 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: gcm is a service that helps developers send data from servers to their
   Android applications on Android devices.
 email:
-- amromousa@gmail.com
 - kashif@spacialdb.com
 - shoaib@spacialdb.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -61,7 +59,7 @@ files:
 - lib/gcm.rb
 - spec/gcm_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/spacialdb/gcm
+homepage: https://github.com/spacialdb/gcm
 licenses:
 - MIT
 metadata: {}
@@ -71,17 +69,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: gcm
-rubygems_version: 2.0.0
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: send data to Android applications on Android devices