gcm 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbbe0aa081da1b94de83f82e56ffb7c9cdc7869c
-  data.tar.gz: 319b8cab6eea37aad1f9d852ee85abf146286299
+  metadata.gz: 2d3097180eb7e2fdcf713691a11c2d4e9dcc7d89
+  data.tar.gz: 8bc696acca36e7b4472a6ceaa1aa69663339e945
 SHA512:
-  metadata.gz: 37a76c47d0278b570a3d161f7343038053baf627017ec4a7cf620d716436a53689348b4fc195d26e57fb0c504590aefeb21bba01a9853c25fa08f580b7884a56
-  data.tar.gz: ee5dc6e0ffe73ca211cfe49126bd46dca629e5ff2086fe06abbd2d756220d31046c3922a50d9d51d1ee99eb43d97b665affd9516c469b65ea3c56b8969d1a4c9
+  metadata.gz: 2bc02dc787c817c1b4a3b6a45141f13d62672946e55c927c60cd56ff998b4f8fbef93e8ee1155a56ad62c01d7db0662f56893ec0e03a3f63c86ffbe07e46928f
+  data.tar.gz: 4228c061988eec7e0409bea59404ffe1c047f78a4c910738cd0008896516fcccf0268228c9705104741754198eeecb7a0b52948fa29e2912d81d07c763e79bd6

data/.travis.yml

@@ -2,4 +2,5 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.3
+  - 2.1.5
+  - 2.2.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Kashif Rasul and Shoaib Burq
+Copyright (c) 2015 Kashif Rasul and Shoaib Burq
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -15,13 +15,14 @@ gem 'gcm'
 
 ##Requirements
 
-An Android device running 2.2 or newer and an API key as per [GCM getting started guide](http://developer.android.com/google/gcm/gs.html).
+An Android device running 2.3 or newer and an API key as per [GCM getting started guide](http://developer.android.com/google/gcm/gs.html).
 
 One of the following, tested Ruby versions:
 
 * `1.9.3`
 * `2.0.0`
-* `2.1.2`
+* `2.1.5`
+* `2.2.0`
 
 ##Usage
 
@@ -59,11 +60,10 @@ response = gcm.create(key_name: "appUser-Chris",
 ```
 
 ### Send to Notification Key
-Now you can send a message to a particular `notification_key` via the `send` method. This allows the server to send a single data to multiple app instances  (typically on multiple devices) owned by a single user (instead of sending to registration IDs). Note: the maximum number of members allowed for a `notification_key` is 10.
+Now you can send a message to a particular `notification_key` via the `send_with_notification_key` method. This allows the server to send a single data to multiple app instances  (typically on multiple devices) owned by a single user (instead of sending to registration IDs). Note: the maximum number of members allowed for a `notification_key` is 10.
 
 ```ruby
-response = gcm.send([], {
-            notification_key: "appUser-Chris-key",
+response = gcm.send_with_notification_key("notification_key", {
             data: {score: "3x1"},
             collapse_key: "updated_score"})
 ```
@@ -75,12 +75,12 @@ You can also add/remove registration IDs to/from a particular `notification_key`
 ```ruby
 response = gcm.add(key_name: "appUser-Chris",
                 project_id: "my_project_id",
-                notification_key:"appUser-Chris-key"
+                notification_key:"appUser-Chris-key",
                 registration_ids:["7", "3"])
 
 response = gcm.remove(key_name: "appUser-Chris",
                 project_id: "my_project_id",
-                notification_key:"appUser-Chris-key"
+                notification_key:"appUser-Chris-key",
                 registration_ids:["8", "15"])
 ```
 
@@ -90,15 +90,19 @@ response = gcm.remove(key_name: "appUser-Chris",
 * [Как отправлять push уведомления из Вашего Rails приложения](http://habrahabr.ru/post/214607/)
 * [GCM – 서버 만들기](http://susemi99.kr/1023)
 * [ruby から gcm を使って android 端末へメッセージを送信する](http://qiita.com/ma2saka/items/5852308b7c2855eef552)
+* [titanium alloy android push通知 by ruby](http://shoprev.hatenablog.com/entry/2014/08/30/202531)
 
 ## Android Client
 
-You can find an Android Client app to receive notifications from here: [Google Cloud Message - Client Android](https://github.com/mikebolivar/gcm)
+You can find a guide to implement an Android Client app to receive notifications here: [Implementing GCM Client](https://developer.android.com/google/gcm/client.html).
 
 ## ChangeLog
 
+### 0.1.0
+* Added `send_with_notification_key` to send message to a notification key since the documented API for it is [wrong]( http://stackoverflow.com/questions/19720767/gcm-user-notifications-missing-registration-ids-field/25183892#25183892).
+
 ### 0.0.9
-* Check for NotRegistered error and return unregistered ids if this occurs
+* Check for [NotRegistered](http://developer.android.com/google/gcm/adv.html#unreg) error and return unregistered ids if this occurs
 
 ### 0.0.8
 * Added support for User Notifications API
@@ -117,8 +121,13 @@ You can find an Android Client app to receive notifications from here: [Google C
 
 ##MIT License
 
-* Copyright (c) 2014 Kashif Rasul and Shoaib Burq. See LICENSE.txt for details.
+* Copyright (c) 2015 Kashif Rasul and Shoaib Burq. See LICENSE.txt for details.
 
 ##Many thanks to all the contributors
 
 * [Contributors](https://github.com/spacialdb/gcm/contributors)
+
+## Donations
+We accept tips through [Gratipay](https://gratipay.com/spacialdb/).
+
+[![Gratipay](https://img.shields.io/gratipay/spacialdb.svg)](https://www.gittip.com/spacialdb/)

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

data/lib/gcm.rb

@@ -101,6 +101,20 @@ class GCM
   end
   alias_method :remove, :remove_registration_ids
 
+  def send_with_notification_key(notification_key, options)
+    body = { :to => notification_key }.merge(options)
+
+    params = {
+      :body => body.to_json,
+      :headers => {
+        'Authorization' => "key=#{@api_key}",
+        'Content-Type' => 'application/json',
+      }
+    }
+    response = self.class.post('/send', params.merge(@client_options))
+    build_response(response)
+  end
+
   private
 
   def build_post_body(registration_ids, options={})

data/spec/gcm_spec.rb

@@ -30,7 +30,7 @@ describe GCM do
         :headers => valid_request_headers
       ).to_return(
         # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
-        :body => {},
+        :body => "{}",
         :headers => {},
         :status => 200
       )
@@ -40,7 +40,7 @@ describe GCM do
       uri = URI.parse(send_url)
       uri.user = 'a'
       uri.password = 'b'
-      stub_request(:post, uri.to_s).to_return(:body => {}, :headers => {}, :status => 200)
+      stub_request(:post, uri.to_s).to_return(:body => "{}", :headers => {}, :status => 200)
     end
 
     before(:each) do
@@ -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 => [], :not_registered_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 => [],:not_registered_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
 
@@ -93,14 +93,14 @@ describe GCM do
             mock_request_attributes
           ).to_return(
             # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
-            :body => {},
+            :body => "{}",
             :headers => {},
             :status => 400
           )
         end
         it "should not send notification due to 400" do
           subject.send(registration_ids).should eq({
-            :body => {},
+            :body => "{}",
             :headers => {},
             :response => "Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields.",
             :status_code => 400
@@ -114,7 +114,7 @@ describe GCM do
             mock_request_attributes
           ).to_return(
             # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
-            :body => {},
+            :body => "{}",
             :headers => {},
             :status => 401
           )
@@ -122,7 +122,7 @@ describe GCM do
 
         it "should not send notification due to 401" do
           subject.send(registration_ids).should eq({
-            :body => {},
+            :body => "{}",
             :headers => {},
             :response => "There was an error authenticating the sender account.",
             :status_code => 401
@@ -136,7 +136,7 @@ describe GCM do
             mock_request_attributes
           ).to_return(
             # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
-            :body => {},
+            :body => "{}",
             :headers => {},
             :status => 503
           )
@@ -144,7 +144,7 @@ describe GCM do
 
         it "should not send notification due to 503" do
           subject.send(registration_ids).should eq({
-            :body => {},
+            :body => "{}",
             :headers => {},
             :response => 'Server is temporarily unavailable.',
             :status_code => 503
@@ -158,7 +158,7 @@ describe GCM do
             mock_request_attributes
           ).to_return(
             # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
-            :body => { "body-key" => "Body value" },
+            :body => "{\"body-key\" => \"Body value\"}",
             :headers => { "header-key" => "Header value" },
             :status => 599
           )
@@ -166,7 +166,7 @@ describe GCM do
 
         it "should not send notification due to 599" do
           subject.send(registration_ids).should eq({
-            :body => { "body-key" => "Body value" },
+            :body => "{\"body-key\" => \"Body value\"}",
             :headers => { "header-key" => ["Header value"] },
             :response => 'There was an internal error in the GCM server while trying to process the request.',
             :status_code => 599

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gcm
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Kashif Rasul
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2015-01-15 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.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: send data to Android applications on Android devices