gcm 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b91b8dd5c3122716b7790b84bf488997af4481b4
-  data.tar.gz: c61dcbb7792c73561ae858d02ea792dac6e8f193
+  metadata.gz: 5b27baf730ba346c79357e983c7c44c03527300c
+  data.tar.gz: 4a2387383fd90c378bfb58ec669484b3255edfa0
 SHA512:
-  metadata.gz: 88d2177d41c159d051057eea20c8171ab7fadb07cf5b2913005656df76fa3ddb5da451386ee299f8ca8884258b07eee1ea8f9f8e07d17b6f8151c501f918d8d6
-  data.tar.gz: aba44c2d89ea740c2ccf0abfef14a4d05283a0a51e979d4b5c1160b23906e9c0c8ecf53b932b94704cf2f62fe8407b4c5dfe90cfb6750a78eb0f202e0aed8695
+  metadata.gz: 0ee69d0a009f6f99bc9cce3e7fc5f1462c709d1d10d53069d04ff7ff8abe618de869772f37a76614f532bf1e78f67b3ac84bd430aacf99e8436078af11f974cc
+  data.tar.gz: d1e2b6606961975e16aef602a58f006ae6cb5d17300ecc03168eae6966e11416599a816aa7b858499daf0724c4f16926a20a1c8674923e5159de4e779f5b36eb

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -21,42 +21,92 @@ One of the following, tested Ruby versions:
 
 * `1.9.3`
 * `2.0.0`
-* `2.1.0`
+* `2.1.2`
 
 ##Usage
 
-For your server to send a message to one or more devices, you must first initialize a new `GCM` class with your api key, and then call the `send_notification` method on this and give it 1 or more (up to 1000) registration IDs as an array of strings. You can also optionally send further [HTTP message parameters](http://developer.android.com/google/gcm/server.html#params) like `data` or `time_to_live` etc. as a hash via the second optional argument to `send_notification`.
+For your server to send a message to one or more devices, you must first initialise a new `GCM` class with your [api key](https://developer.android.com/google/gcm/gs.html#access-key), and then call the `send` method on this and give it 1 or more (up to 1000) registration IDs as an array of strings. You can also optionally send further [HTTP message parameters](http://developer.android.com/google/gcm/server.html#params) like `data` or `time_to_live` etc. as a hash via the second optional argument to `send`.
 
 Example sending notifications:
 
 ```ruby
 require 'gcm'
 
-gcm = GCM.new(api_key)
+gcm = GCM.new("my_api_key")
 # you can set option parameters in here
 #  - all options are pass to HTTParty method arguments
 #  - ref: https://github.com/jnunemaker/httparty/blob/master/lib/httparty.rb#L40-L68
-#  gcm = GCM.new(api_key, timeout: 3)
+#  gcm = GCM.new("my_api_key", timeout: 3)
 
 registration_ids= ["12", "13"] # an array of one or more client registration IDs
 options = {data: {score: "123"}, collapse_key: "updated_score"}
-response = gcm.send_notification(registration_ids, options)
+response = gcm.send(registration_ids, options)
 ```
 
 Currently `response` is just a hash containing the response `body`, `headers` and `status`. Check [here](http://developer.android.com/google/gcm/http.html#response) to see how to interpret the responses.
 
+## User Notifications
+
+With [user notifications](http://developer.android.com/google/gcm/notifications.html), you can send a single message to multiple instance of an app running on devices owned by a single user. To use this feature, you will first need an initialised `GCM` class.
+
+### Generate a Notification Key
+Then you will need a notification key which you can create for a particular `key_name` which needs to be uniquely named per app in case you have multiple apps for the same `project_id`.  This ensures that notifications only go to the intended target app. The `create` method will do this and return the token `notification_key` in the response:
+
+```ruby
+response = gcm.create(key_name: "appUser-Chris",
+                project_id: "my_project_id",
+                registration_ids:["4", "8", "15", "16", "23", "42"])
+```
+
+### 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.
+
+```ruby
+response = gcm.send([], {
+            notification_key: "appUser-Chris-key",
+            data: {score: "3x1"},
+            collapse_key: "updated_score"})
+```
+
+### Add/Remove Registration IDs
+
+You can also add/remove registration IDs to/from a particular `notification_key` of some `project_id`. For example:
+
+```ruby
+response = gcm.add(key_name: "appUser-Chris",
+                project_id: "my_project_id",
+                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"
+                registration_ids:["8", "15"])
+```
+
 ## 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)
+* [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/)
+* [GCM – 서버 만들기](http://susemi99.kr/1023)
+* [ruby から gcm を使って android 端末へメッセージを送信する](http://qiita.com/ma2saka/items/5852308b7c2855eef552)
+
+## Android Client
+
+You can find an Android Client app to receive notifications from here: [Google Cloud Message - Client Android](https://github.com/mikebolivar/gcm)
 
 ## ChangeLog
 
+## 0.0.8
+* Added support for User Notifications API
+* Added alias method `send` for `send_notification`
+
 ## 0.0.7
 * All responses now have a body and header hashes
 
 ### 0.0.6
 
-* You can initialize GCM class with [HTTParty Options](https://github.com/jnunemaker/httparty/blob/master/lib/httparty.rb#L40-L68)
+* You can initialise GCM class with [HTTParty Options](https://github.com/jnunemaker/httparty/blob/master/lib/httparty.rb#L41-L69)
 
 ### 0.0.5
 

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

data/lib/gcm.rb

@@ -4,8 +4,7 @@ require 'json'
 
 class GCM
   include HTTParty
-  PUSH_URL = 'https://android.googleapis.com/gcm/send'
-  base_uri PUSH_URL
+  base_uri 'https://android.googleapis.com/gcm'
   default_timeout 30
   format :json
 
@@ -26,8 +25,8 @@ class GCM
   #     "time": "15:10"
   #   }
   # }
-  # gcm = GCM.new(api_key)
-  # gcm.send_notification({registration_ids: ["4sdsx", "8sdsd"], data: {score: "5x1"}})
+  # gcm = GCM.new("API_KEY")
+  # gcm.send(registration_ids: ["4sdsx", "8sdsd"], {data: {score: "5x1"}})
   def send_notification(registration_ids, options = {})
     post_body = build_post_body(registration_ids, options)
 
@@ -38,9 +37,69 @@ class GCM
         'Content-Type' => 'application/json',
       }
     }
-    response = self.class.post('', params.merge(@client_options))
+    response = self.class.post('/send', params.merge(@client_options))
     build_response(response, registration_ids)
   end
+  alias_method :send, :send_notification
+
+  def create_notification_key(key_name, project_id, registration_ids=[])
+    post_body = build_post_body(registration_ids, {
+                  :operation => "create",
+                  :notification_key_name => key_name})
+
+    params = {
+      :body => post_body.to_json,
+      :headers => {
+        'Content-Type' => 'application/json',
+        'project_id' => project_id,
+        'Authorization' => "key=#{@api_key}"
+      }
+    }
+
+    response = self.class.post('/notification', params.merge(@client_options))
+    build_response(response)
+  end
+  alias_method :create, :create_notification_key
+
+  def add_registration_ids(key_name, project_id, notification_key, registration_ids)
+    post_body = build_post_body(registration_ids, {
+                    :operation => "add",
+                    :notification_key_name => key_name,
+                    :notification_key => notification_key})
+
+    params = {
+      :body => post_body.to_json,
+      :headers => {
+        'Content-Type' => 'application/json',
+        'project_id' => project_id,
+        'Authorization' => "key=#{@api_key}"
+      }
+    }
+
+    response = self.class.post('/notification', params.merge(@client_options))
+    build_response(response)
+  end
+  alias_method :add, :add_registration_ids
+
+  def remove_registration_ids(key_name, project_id, notification_key, registration_ids)
+    post_body = build_post_body(registration_ids, {
+                  :operation => "remove",
+                  :notification_key_name => key_name,
+                  :notification_key => notification_key})
+
+    params = {
+      :body => post_body.to_json,
+      :headers => {
+        'Content-Type' => 'application/json',
+        'project_id' => project_id,
+        'Authorization' => "key=#{@api_key}"
+      }
+    }
+
+    response = self.class.post('/notification', params.merge(@client_options))
+    build_response(response)
+  end
+  alias_method :remove, :remove_registration_ids
 
   private
 
@@ -48,13 +107,13 @@ class GCM
     { :registration_ids => registration_ids }.merge(options)
   end
 
-  def build_response(response, registration_ids)
+  def build_response(response, registration_ids=[])
     body = response.body || {}
     response_hash = {:body => body, :headers => response.headers, :status_code => response.code}
     case response.code
       when 200
         response_hash[:response] = 'success'
-        response_hash[:canonical_ids] = build_canonical_ids(body, registration_ids)
+        response_hash[:canonical_ids] = build_canonical_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

data/spec/gcm_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe GCM do
+  let(:send_url) { "#{GCM::base_uri}/send" }
+
   it "should raise an error if the api key is not provided" do
     expect {GCM.new}.to raise_error
   end
@@ -22,8 +24,8 @@ describe GCM do
       }
     end
 
-    let(:stub_gcm_request) do
-      stub_request(:post, GCM::PUSH_URL).with(
+    let(:stub_gcm_send_request) do
+      stub_request(:post, send_url).with(
         :body => valid_request_body.to_json,
         :headers => valid_request_headers
       ).to_return(
@@ -34,33 +36,33 @@ describe GCM do
       )
     end
 
-    let(:stub_gcm_request_with_basic_auth) do
-      uri = URI.parse(GCM::PUSH_URL)
+    let(:stub_gcm_send_request_with_basic_auth) do
+      uri = URI.parse(send_url)
       uri.user = 'a'
       uri.password = 'b'
       stub_request(:post, uri.to_s).to_return(:body => {}, :headers => {}, :status => 200)
     end
 
     before(:each) do
-      stub_gcm_request
-      stub_gcm_request_with_basic_auth
+      stub_gcm_send_request
+      stub_gcm_send_request_with_basic_auth
     end
 
     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, :canonical_ids => []})
-      stub_gcm_request.should have_been_made.times(1)
+      gcm.send(registration_ids).should eq({:response => 'success', :body => {}, :headers => {}, :status_code => 200, :canonical_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_notification(registration_ids).should eq({:response => 'success', :body => {}, :headers => {}, :status_code => 200, :canonical_ids => []})
-      stub_gcm_request_with_basic_auth.should have_been_made.times(1)
+      gcm.send(registration_ids).should eq({:response => 'success', :body => {}, :headers => {}, :status_code => 200, :canonical_ids => []})
+      stub_gcm_send_request_with_basic_auth.should have_been_made.times(1)
     end
 
     context "send notification with data" do
       let!(:stub_with_data){
-        stub_request(:post, GCM::PUSH_URL).
+        stub_request(:post, send_url).
           with(:body => "{\"registration_ids\":[\"42\"],\"data\":{\"score\":\"5x1\",\"time\":\"15:10\"}}",
                :headers => valid_request_headers ).
           to_return(:status => 200, :body => "", :headers => {})
@@ -69,7 +71,7 @@ describe GCM 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(registration_ids, { :data => { :score => "5x1", :time => "15:10"} })
         stub_with_data.should have_been_requested
       end
     end
@@ -87,7 +89,7 @@ describe GCM do
 
       context "on failure code 400" do
         before do
-          stub_request(:post, GCM::PUSH_URL).with(
+          stub_request(:post, send_url).with(
             mock_request_attributes
           ).to_return(
             # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
@@ -97,7 +99,7 @@ describe GCM do
           )
         end
         it "should not send notification due to 400" do
-          subject.send_notification(registration_ids).should eq({
+          subject.send(registration_ids).should eq({
             :body => {},
             :headers => {},
             :response => "Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields.",
@@ -108,7 +110,7 @@ describe GCM do
 
       context "on failure code 401" do
         before do
-          stub_request(:post, GCM::PUSH_URL).with(
+          stub_request(:post, send_url).with(
             mock_request_attributes
           ).to_return(
             # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
@@ -119,7 +121,7 @@ describe GCM do
         end
 
         it "should not send notification due to 401" do
-          subject.send_notification(registration_ids).should eq({
+          subject.send(registration_ids).should eq({
             :body => {},
             :headers => {},
             :response => "There was an error authenticating the sender account.",
@@ -130,7 +132,7 @@ describe GCM do
 
       context "on failure code 503" do
         before do
-          stub_request(:post, GCM::PUSH_URL).with(
+          stub_request(:post, send_url).with(
             mock_request_attributes
           ).to_return(
             # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
@@ -141,7 +143,7 @@ describe GCM do
         end
 
         it "should not send notification due to 503" do
-          subject.send_notification(registration_ids).should eq({
+          subject.send(registration_ids).should eq({
             :body => {},
             :headers => {},
             :response => 'Server is temporarily unavailable.',
@@ -152,7 +154,7 @@ describe GCM do
 
       context "on failure code 5xx" do
         before do
-          stub_request(:post, GCM::PUSH_URL).with(
+          stub_request(:post, send_url).with(
             mock_request_attributes
           ).to_return(
             # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
@@ -163,7 +165,7 @@ describe GCM do
         end
 
         it "should not send notification due to 599" do
-          subject.send_notification(registration_ids).should eq({
+          subject.send(registration_ids).should eq({
             :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.',
@@ -192,7 +194,7 @@ describe GCM do
 
 
       before do
-        stub_request(:post, GCM::PUSH_URL).with(
+        stub_request(:post, send_url).with(
             mock_request_attributes
         ).to_return(
           # ref: http://developer.android.com/guide/google/gcm/gcm.html#success
@@ -203,7 +205,7 @@ describe GCM do
       end
 
       it "should contain canonical_ids" do
-        response = subject.send_notification(registration_ids)
+        response = subject.send(registration_ids)
 
         response.should eq({
           :headers => {},

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gcm
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Kashif Rasul
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-14 00:00:00.000000000 Z
+date: 2014-08-11 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.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: send data to Android applications on Android devices