gcm 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48e5d1ac537918960d5702a017f448561502ad78
-  data.tar.gz: 2524bc50e068dbd90fc0b2d1c5eb012011edc963
+  metadata.gz: e0b2ae57d4b3b71772d8a69cc595ec6272cdb7db
+  data.tar.gz: 1818a7075e84ea587e62a599cb6ffda67a2a925a
 SHA512:
-  metadata.gz: 35fb8ca2fd2b83e4226a6d24a034923ce5a2281accf4261c1663873f2d3cd79c47306dcca9d9dd1e79a97ffeb3ba21477d8bc3102c63f441610634bdb3263c86
-  data.tar.gz: 994846feefe82634bd46e0aa530367cc8e7514cb635a9d977cc29dfdd9859bf1c3b3820258d9a90e6772462e4d47552c68d6219e1421dc7c3f4e28b34a1c13b9
+  metadata.gz: a3fa246decd26545e799c645fc64e788a4be1cbeba209fae04e983559e665135d61f4a33fb48bbe37f18fbe7368bcb53784d02371f3f1fca6ea341d2a0cae52c
+  data.tar.gz: a3f675537384617d32993141954920be7604a4b687951d612d9ddf85539ff788af57433df337a91911c79646edf393d276636c4dffe9d6c965566da37d24d723

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Kashif Rasul and Shoaib Burq
+Copyright (c) 2014 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

@@ -7,9 +7,15 @@ GCM sends notifications to Android devices via [GCM](http://developer.android.co
 
     $ gem install gcm
 
+or in your `Gemfile` just include it:
+
+```ruby
+gem 'gcm'
+```
+
 ##Requirements
 
-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).
+An Android device running 2.0 or newer and an API key as per [GCM getting started guide](http://developer.android.com/google/gcm).
 
 One of the following, tested Ruby versions:
 
@@ -19,22 +25,25 @@ One of the following, tested Ruby versions:
 
 ##Usage
 
-Sending notifications:
+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`.
+
+Example sending notifications:
 
 ```ruby
 require 'gcm'
 
 gcm = GCM.new(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)
+
 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)
 ```
 
-Currently `response` is just a hash containing the response `body`, `headers` and `status`.
-
-If the above code is stored in a file like `trigger_gcm.rb`, thats how you can call it.
-
-	$ ruby -rubygems trigger_gcm.rb
+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.
 
 ## Blog posts
 
@@ -42,15 +51,19 @@ If the above code is stored in a file like `trigger_gcm.rb`, thats how you can c
 
 ## ChangeLog
 
+### 0.0.6
+
+* You can initialize GCM class with [HTTParty Options](https://github.com/jnunemaker/httparty/blob/master/lib/httparty.rb#L40-L68)
+
 ### Version 0.0.5
 
-* Added support for canonical registration ID
+* 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
 
 ##MIT License
 
-* Copyright (c) 2012 Kashif Rasul and Shoaib Burq. See LICENSE.txt for details.
+* Copyright (c) 2014 Kashif Rasul and Shoaib Burq. See LICENSE.txt for details.
 
 ##Many thanks to all the contributors
 

data/Rakefile

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

data/lib/gcm.rb

@@ -11,8 +11,9 @@ class GCM
 
   attr_accessor :timeout, :api_key
 
-  def initialize(api_key)
+  def initialize(api_key, client_options = {})
     @api_key = api_key
+    @client_options = client_options
   end
 
   # {
@@ -37,8 +38,7 @@ class GCM
         'Content-Type' => 'application/json',
       }
     }
-
-    response = self.class.post('', params)
+    response = self.class.post('', params.merge(@client_options))
     build_response(response, registration_ids)
   end
 

data/spec/gcm_spec.rb

@@ -22,7 +22,7 @@ describe GCM do
       }
     end
 
-    before(:each) do
+    let(:stub_gcm_request) do
       stub_request(:post, GCM::PUSH_URL).with(
         :body => valid_request_body.to_json,
         :headers => valid_request_headers
@@ -34,9 +34,28 @@ describe GCM do
       )
     end
 
+    let(:stub_gcm_request_with_basic_auth) do
+      uri = URI.parse(GCM::PUSH_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
+    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)
+    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)
     end
 
     context "send notification with data" do
@@ -157,7 +176,7 @@ describe GCM do
 
       let(:valid_response_body_with_canonical_ids) do
         {
-            :canonical_ids => 1, :results => [{:registration_id => "43", :message_id => "0:1385025861956342%572c22801bb3" }]
+          :canonical_ids => 1, :results => [{:registration_id => "43", :message_id => "0:1385025861956342%572c22801bb3" }]
         }
       end
 
@@ -168,23 +187,23 @@ describe GCM 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
+          # 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\"}]}"
-                                                                })
+        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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gcm
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Kashif Rasul
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty