rgcm 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d996818f09f71cff4eb15f5192e5139f5fe384d
-  data.tar.gz: f53dd56ea6fe510e402b0df4135849b7ddfdba43
+  metadata.gz: 50ad8b8a68265daf27de38132b97c7974276b0c8
+  data.tar.gz: 469a26eff7f8c36eaa1a4290399fc960de42cb6d
 SHA512:
-  metadata.gz: c3e4be4a1b81007d31d5ddd0d16d8a5155e4369b7ef36c17a502e3e0e628dd478b586aad7316bdebab04f12fc9db6c1476dc7da4ee4fd369593b51e1185e60b3
-  data.tar.gz: c5dac96c370149f9e3f6570cc003b4a54cda7a75c93bbcb0f0ab19dca08bebc7d0529dcaab5683a7dcc2515ea26b34c55c28c6906dba76e089de6b749deec5d4
+  metadata.gz: 6b0da80664bf797975ef787575dcc841253c8563cbd7a45951628f49a8c1e9009e4d425abf5e0ff875ac9d9482aa482438321f3e14c3732f36bb443ba51362c7
+  data.tar.gz: d24bca2d2663a9f74faa6d34899e79bbd218eb9d4c3c7e5efb2f0cd4f6a00a1e9f81efa0b962b27284d979999f753c4825410c8e79a34d6691198162ed4b1208

data/README.md

@@ -29,7 +29,62 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+``` ruby
+collapse_key = '_GCM_COLLAPS_KEY_' 
+data = { foo: 'bar' }
+
+Rgcm::Message.new('_API_KEY_').post('_GCM_REGESTRATION_ID_', collapse_key, data) # => Rgcm::Response
+
+Rgcm::Message.new('_API_KEY_').post(['_GCM_REGESTRATION_ID_1_', '_GCM_REGESTRATION_ID_2_'], collapse_key, data) # => Rgcm::Response
+```
+
+With rails YML config file:
+
+``` yml
+development:
+  api_key: '_API_KEY_'
+
+test:
+  api_key: '_API_KEY_'
+
+production:
+  api_key: '_API_KEY_'
+```
+
+``` ruby
+collapse_key = '_GCM_COLLAPS_KEY_' 
+data = { foo: 'bar' }
+
+Rgcm::Message.new.post('_GCM_REGESTRATION_ID_', collapse_key, data) # => Rgcm::Response
+
+Rgcm::Message.new.post(['_GCM_REGESTRATION_ID_1_', '_GCM_REGESTRATION_ID_2_'], collapse_key, data) # => Rgcm::Response
+```
+
+Rgcm::Response methods:
+
+```json
+{
+    "multicast_id":5030383832068975557,
+    "success":1,
+    "failure":0,
+    "canonical_ids":0,
+    "results":[
+        { "message_id":"0:1403425286258916%62dfd0f6e116c072" }
+    ]
+}
+```
+
+``` ruby
+response = Rgcm::Message.new('_API_KEY_').post('_GCM_REGESTRATION_ID_', collapse_key, data)
+
+response.count_successes # => 1
+response.count_failures # => 0
+response.has_successes? # => true
+response.has_failures? # => false
+response.results # => '{ "message_id":"0:1403425286258916%62dfd0f6e116c072" }' 
+response.successes # => '{ "message_id":"0:1403425286258916%62dfd0f6e116c072" }' 
+response.errors # => nil
+```
 
 ## Contributing
 

data/lib/rgcm/message.rb

@@ -13,8 +13,8 @@ module Rgcm
       end
     end
 
-    def post(registration_ids, collapse_key, data)
-      request = RequestBuilder.new(api_key, registration_ids,  collapse_key, data).build
+    def post(registration_ids, data, options=nil)
+      request = RequestBuilder.new(api_key, registration_ids, options, data).build
 
       response = request.run
 

data/lib/rgcm/request_builder.rb

@@ -3,12 +3,12 @@ module Rgcm
 
     URI = 'https://android.googleapis.com/gcm/send'.freeze
 
-    attr_reader :api_key, :registration_ids, :collapse_key, :data
+    attr_reader :api_key, :registration_ids, :options, :data
 
-    def initialize(api_key, registration_ids,  collapse_key, data)
+    def initialize(api_key, registration_ids,  options, data)
       @api_key = api_key
       @registration_ids = registration_ids.kind_of?(Array) ? registration_ids : [registration_ids]
-      @collapse_key = collapse_key
+      @options = options
       @data = data
     end
 
@@ -24,8 +24,13 @@ module Rgcm
 
     def body
       body = {'registration_ids' => registration_ids}
-      body.merge!('collapse_key' => collapse_key) if collapse_key.present?
+      if options.present?
+        body.merge!('collapse_key' => options[:collapse_key]) if options.has_key?(:collapse_key)
+        body.merge!('time_to_live' => options[:time_to_live]) if options.has_key?(:time_to_live)
+        body.merge!('delay_while_idle' => true) if options.has_key?(:time_to_live)
+      end
       body.merge!('data' => data) if data.present?
+      body
     end
 
   end

data/lib/rgcm/version.rb

@@ -1,3 +1,3 @@
 module Rgcm
-  VERSION = "0.0.1"
+  VERSION = '1.0.0'
 end

data/rgcm.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["alex.klaiber@gmail.com"]
   spec.summary       = "Google Cloud Messaging"
   spec.description   = "Google Cloud Messaging"
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/aklaiber/rgcm"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
 
   spec.add_dependency "activesupport"
   spec.add_dependency "typhoeus"

data/spec/rgcm/message_spec.rb

@@ -10,10 +10,26 @@ describe Rgcm::Message do
 
   let(:json) { File.open("#{FIXTURES_PATH}/responses/successfully.json").read }
 
-  it 'returns rgcm response' do
-    response = Rgcm::Message.new('TEST_API_KEY').post('test', 'test', data)
+  it 'returns gcm response' do
+    response = Rgcm::Message.new('TEST_API_KEY').post('test', data)
 
     expect(response).to be_kind_of(Rgcm::Response)
   end
 
+  context 'with collapse_key' do
+    it 'returns gcm response' do
+      response = Rgcm::Message.new('TEST_API_KEY').post('test', data, collapse_key: 'test')
+
+      expect(response).to be_kind_of(Rgcm::Response)
+    end
+  end
+
+  context 'with time_to_live' do
+    it 'returns gcm response' do
+      response = Rgcm::Message.new('TEST_API_KEY').post('test', data, time_to_live: 0)
+
+      expect(response).to be_kind_of(Rgcm::Response)
+    end
+  end
+
 end

data/spec/rgcm/request_builder_spec.rb

@@ -6,7 +6,7 @@ describe Rgcm::RequestBuilder do
   let(:registration_id) { 123 }
   let(:collapse_key) { 'collapse key' }
   let(:data) { {score: '4x8', time: '15:16.2342'} }
-  let(:request) { Rgcm::RequestBuilder.new(api_key, registration_id, collapse_key, data) }
+  let(:request) { Rgcm::RequestBuilder.new(api_key, registration_id, nil, nil) }
 
   it 'returns uri' do
     expect(request.build.base_url).to eql(Rgcm::Config::URI)
@@ -24,11 +24,26 @@ describe Rgcm::RequestBuilder do
     expect(json(request.build.options[:body])[:registration_ids]).to eql([registration_id])
   end
 
-  it 'returns collapse_key' do
-    expect(json(request.build.options[:body])[:collapse_key]).to eql(collapse_key)
+  context 'with collapse_key' do
+    it 'returns request' do
+      request = Rgcm::RequestBuilder.new(api_key, registration_id, {collapse_key: collapse_key}, nil)
+      expect(json(request.build.options[:body])[:collapse_key]).to eql(collapse_key)
+    end
   end
 
-  it 'returns data' do
-    expect(json(request.build.options[:body])[:data]).to eql(data)
+  context 'with data' do
+    it 'returns request' do
+      request = Rgcm::RequestBuilder.new(api_key, registration_id, nil, data)
+      expect(json(request.build.options[:body])[:data]).to eql(data)
+    end
+  end
+
+  context 'with data' do
+    it 'returns request' do
+      request = Rgcm::RequestBuilder.new(api_key, registration_id, {time_to_live: 0}, data).build
+
+      expect(json(request.options[:body])[:time_to_live]).to eql(0)
+      expect(json(request.options[:body])[:delay_while_idle]).to eql(true)
+    end
   end
 end

data/spec/rgcm/response_spec.rb

@@ -6,10 +6,10 @@ describe Rgcm::Response do
   context 'with successfully response' do
     let(:json) { File.open("#{FIXTURES_PATH}/responses/successfully.json").read }
     it '#has_successes?' do
-      expect(response.has_successes?).to be_true
+      expect(response.has_successes?).to be true
     end
     it '#has_failures?' do
-      expect(response.has_failures?).to be_false
+      expect(response.has_failures?).to be false
     end
     it '#count_successes' do
       expect(response.count_successes).to eql(1)
@@ -22,10 +22,10 @@ describe Rgcm::Response do
   context 'with failure response' do
     let(:json) { File.open("#{FIXTURES_PATH}/responses/failure.json").read }
     it '#has_successes?' do
-      expect(response.has_successes?).to be_false
+      expect(response.has_successes?).to be false
     end
     it '#has_failures?' do
-      expect(response.has_failures?).to be_true
+      expect(response.has_failures?).to be true
     end
     it '#count_successes' do
       expect(response.count_successes).to eql(0)
@@ -41,10 +41,10 @@ describe Rgcm::Response do
   context 'with failure response' do
     let(:json) { File.open("#{FIXTURES_PATH}/responses/multi.json").read }
     it '#has_successes?' do
-      expect(response.has_successes?).to be_true
+      expect(response.has_successes?).to be true
     end
     it '#has_failures?' do
-      expect(response.has_failures?).to be_true
+      expect(response.has_failures?).to be true
     end
     it '#count_successes' do
       expect(response.count_successes).to eql(3)

data/spec/spec_helper.rb

@@ -1,11 +1,9 @@
 require 'support/json_helper'
-
 require 'rgcm'
 
 FIXTURES_PATH = "#{File.dirname(__FILE__)}/fixtures"
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = 'random'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rgcm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Alexander Klaiber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2014-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +110,7 @@ files:
 - spec/rgcm/response_spec.rb
 - spec/spec_helper.rb
 - spec/support/json_helper.rb
-homepage: ''
+homepage: https://github.com/aklaiber/rgcm
 licenses:
 - MIT
 metadata: {}