gcm 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b27baf730ba346c79357e983c7c44c03527300c
-  data.tar.gz: 4a2387383fd90c378bfb58ec669484b3255edfa0
+  metadata.gz: dbbe0aa081da1b94de83f82e56ffb7c9cdc7869c
+  data.tar.gz: 319b8cab6eea37aad1f9d852ee85abf146286299
 SHA512:
-  metadata.gz: 0ee69d0a009f6f99bc9cce3e7fc5f1462c709d1d10d53069d04ff7ff8abe618de869772f37a76614f532bf1e78f67b3ac84bd430aacf99e8436078af11f974cc
-  data.tar.gz: d1e2b6606961975e16aef602a58f006ae6cb5d17300ecc03168eae6966e11416599a816aa7b858499daf0724c4f16926a20a1c8674923e5159de4e779f5b36eb
+  metadata.gz: 37a76c47d0278b570a3d161f7343038053baf627017ec4a7cf620d716436a53689348b4fc195d26e57fb0c504590aefeb21bba01a9853c25fa08f580b7884a56
+  data.tar.gz: ee5dc6e0ffe73ca211cfe49126bd46dca629e5ff2086fe06abbd2d756220d31046c3922a50d9d51d1ee99eb43d97b665affd9516c469b65ea3c56b8969d1a4c9

data/.travis.yml

@@ -2,4 +2,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.2
+  - 2.1.3

data/README.md

@@ -84,7 +84,7 @@ response = gcm.remove(key_name: "appUser-Chris",
                 registration_ids:["8", "15"])
 ```
 
-## Blog posts
+## Blog Posts
 
 * [How to send iOS and Android notifications from your Rails backend](http://juretriglav.si/how-to-send-ios-and-android-notifications-from-your-rails-backend/)
 * [Как отправлять push уведомления из Вашего Rails приложения](http://habrahabr.ru/post/214607/)
@@ -97,19 +97,20 @@ You can find an Android Client app to receive notifications from here: [Google C
 
 ## ChangeLog
 
-## 0.0.8
+### 0.0.9
+* Check for NotRegistered error and return unregistered ids if this occurs
+
+### 0.0.8
 * Added support for User Notifications API
 * Added alias method `send` for `send_notification`
 
-## 0.0.7
+### 0.0.7
 * All responses now have a body and header hashes
 
 ### 0.0.6
-
 * You can initialise GCM class with [HTTParty Options](https://github.com/jnunemaker/httparty/blob/master/lib/httparty.rb#L41-L69)
 
 ### 0.0.5
-
 * Added support for [canonical registration ID](http://developer.android.com/google/gcm/adv.html#canonical)
 * 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

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.8"
+  s.version     = "0.0.9"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Kashif Rasul", "Shoaib Burq"]
   s.email       = ["kashif@spacialdb.com", "shoaib@spacialdb.com"]

data/lib/gcm.rb

@@ -113,7 +113,9 @@ class GCM
     case response.code
       when 200
         response_hash[:response] = 'success'
+        body = JSON.parse(body) unless body.empty?
         response_hash[:canonical_ids] = build_canonical_ids(body, registration_ids) unless registration_ids.empty?
+        response_hash[:not_registered_ids] = build_not_registered_ids(body,registration_ids) unless registration_ids.empty?
       when 400
         response_hash[:response] = 'Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields.'
       when 401
@@ -129,7 +131,6 @@ class GCM
   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)
@@ -139,7 +140,23 @@ class GCM
     canonical_ids
   end
 
+  def build_not_registered_ids(body, registration_id)
+    not_registered_ids = []
+    unless body.empty?
+      if body['failure'] > 0
+        body['results'].each_with_index do |result,index|
+          not_registered_ids << registration_id[index] if is_not_registered?(result)
+        end
+      end
+    end
+    not_registered_ids
+  end
+
   def has_canonical_id?(result)
     !result['registration_id'].nil?
   end
+
+  def is_not_registered?(result)
+    result['error'] == 'NotRegistered'
+  end
 end

data/spec/gcm_spec.rb

@@ -50,13 +50,13 @@ describe GCM do
 
     it "should send notification using POST to GCM server" do
       gcm = GCM.new(api_key)
-      gcm.send(registration_ids).should eq({:response => 'success', :body => {}, :headers => {}, :status_code => 200, :canonical_ids => []})
+      gcm.send(registration_ids).should eq({:response => 'success', :body => {}, :headers => {}, :status_code => 200, :canonical_ids => [], :not_registered_ids => []})
       stub_gcm_send_request.should have_been_made.times(1)
     end
 
     it "should use basic authentication provided by options" do
       gcm = GCM.new(api_key, basic_auth: {username: 'a', password: 'b'})
-      gcm.send(registration_ids).should eq({:response => 'success', :body => {}, :headers => {}, :status_code => 200, :canonical_ids => []})
+      gcm.send(registration_ids).should eq({:response => 'success', :body => {}, :headers => {}, :status_code => 200, :canonical_ids => [],:not_registered_ids => []})
       stub_gcm_send_request_with_basic_auth.should have_been_made.times(1)
     end
 
@@ -186,7 +186,7 @@ describe GCM do
 
       let(:valid_response_body_with_canonical_ids) do
         {
-          :canonical_ids => 1, :results => [{:registration_id => "43", :message_id => "0:1385025861956342%572c22801bb3" }]
+          :failure => 0, :canonical_ids => 1, :results => [{:registration_id => "43", :message_id => "0:1385025861956342%572c22801bb3" }]
         }
       end
 
@@ -210,11 +210,52 @@ describe GCM do
         response.should eq({
           :headers => {},
           :canonical_ids => [{:old => "42", :new => "43"}],
+          :not_registered_ids => [],
           :status_code => 200,
           :response => 'success',
-          :body => "{\"canonical_ids\":1,\"results\":[{\"registration_id\":\"43\",\"message_id\":\"0:1385025861956342%572c22801bb3\"}]}"
+          :body => "{\"failure\":0,\"canonical_ids\":1,\"results\":[{\"registration_id\":\"43\",\"message_id\":\"0:1385025861956342%572c22801bb3\"}]}"
         })
       end
     end
+
+    context "when send_notification responds with NotRegistered" do
+
+      subject { GCM.new(api_key) }
+
+      let(:mock_request_attributes) do
+        {
+            :body => valid_request_body.to_json,
+            :headers => valid_request_headers
+        }
+      end
+
+      let(:valid_response_body_with_not_registered_ids) do
+        {
+          :canonical_ids => 0, :failure => 1, :results => [{ :error => "NotRegistered" }]
+        }
+      end
+
+      before do
+        stub_request(:post,send_url).with(
+          mock_request_attributes
+        ).to_return(
+          :body => valid_response_body_with_not_registered_ids.to_json,
+          :headers => {},
+          :status => 200
+        )
+      end
+
+      it "should contain not_registered_ids" do
+        response = subject.send(registration_ids)
+        response.should eq(
+          :headers => {},
+          :canonical_ids => [],
+          :not_registered_ids => registration_ids,
+          :status_code => 200,
+          :response => 'success',
+          :body => "{\"canonical_ids\":0,\"failure\":1,\"results\":[{\"error\":\"NotRegistered\"}]}"
+        )
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gcm
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Kashif Rasul
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: gcm
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: send data to Android applications on Android devices