rgcm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d996818f09f71cff4eb15f5192e5139f5fe384d
+  data.tar.gz: f53dd56ea6fe510e402b0df4135849b7ddfdba43
+SHA512:
+  metadata.gz: c3e4be4a1b81007d31d5ddd0d16d8a5155e4369b7ef36c17a502e3e0e628dd478b586aad7316bdebab04f12fc9db6c1476dc7da4ee4fd369593b51e1185e60b3
+  data.tar.gz: c5dac96c370149f9e3f6570cc003b4a54cda7a75c93bbcb0f0ab19dca08bebc7d0529dcaab5683a7dcc2515ea26b34c55c28c6906dba76e089de6b749deec5d4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,3 @@
+script: "bundle exec rake spec"
+rvm:
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rgcm.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexander Klaiber
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Rgcm
+
+[![Build Status](https://api.travis-ci.org/aklaiber/rgcm.svg)][travis]
+[![Gem Version](http://img.shields.io/gem/v/rgcm.svg)][gem]
+[![Code Climate](https://codeclimate.com/github/aklaiber/rgcm.png)][codeclimate]
+[![Dependencies Status](http://img.shields.io/gemnasium/aklaiber/rgcm.svg)][gemnasium]
+
+[travis]: https://travis-ci.org/aklaiber/rgcm
+[gem]: https://rubygems.org/gems/rgcm
+[codeclimate]: https://codeclimate.com/github/aklaiber/rgcm
+[gemnasium]: https://gemnasium.com/aklaiber/rgcm
+
+
+Ruby mapper for [Google Cloud Messaging](http://developer.android.com/guide/google/gcm/index.html)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rgcm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rgcm
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/rgcm/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/rgcm/config.rb

@@ -0,0 +1,14 @@
+module Rgcm
+  class Config
+
+    URI = 'https://android.googleapis.com/gcm/send'.freeze
+
+    class << self
+      attr_writer :config
+    end
+
+    def self.api_key
+      @config['api_key']
+    end
+  end
+end

data/lib/rgcm/message.rb

@@ -0,0 +1,25 @@
+module Rgcm
+  class Message
+
+    attr_reader :api_key
+
+    def initialize(config = Rgcm::Config)
+      if config.kind_of?(String)
+        @api_key = config
+      elsif config.kind_of?(Hash)
+        @api_key = config[:api_key]
+      elsif config.kind_of?(Class)
+        @api_key = config.api_key
+      end
+    end
+
+    def post(registration_ids, collapse_key, data)
+      request = RequestBuilder.new(api_key, registration_ids,  collapse_key, data).build
+
+      response = request.run
+
+      Rgcm::Response.new(response.body)
+    end
+
+  end
+end

data/lib/rgcm/railtie.rb

@@ -0,0 +1,15 @@
+module Rgcm
+  class Railtie < Rails::Railtie
+
+    initializer 'setup rgcm' do
+      config_file = Rails.root.join('config', 'rgcm.yml')
+      if config_file.file?
+        Rgcm::Config.config = YAML.load(ERB.new(config_file.read).result)[Rails.env]
+      end
+      config.after_initialize do
+        puts "\nRgcm config not found. Create a config file at: config/rgcm.yml" unless config_file.file?
+      end
+    end
+
+  end
+end

data/lib/rgcm/request_builder.rb

@@ -0,0 +1,32 @@
+module Rgcm
+  class RequestBuilder
+
+    URI = 'https://android.googleapis.com/gcm/send'.freeze
+
+    attr_reader :api_key, :registration_ids, :collapse_key, :data
+
+    def initialize(api_key, registration_ids,  collapse_key, data)
+      @api_key = api_key
+      @registration_ids = registration_ids.kind_of?(Array) ? registration_ids : [registration_ids]
+      @collapse_key = collapse_key
+      @data = data
+    end
+
+    def build
+      Typhoeus::Request.new(URI, headers: headers, method: :post, body: body.to_json, followlocation: true)
+    end
+
+    private
+
+    def headers
+      {'Authorization' => "key=#{api_key}", 'Content-Type' => 'application/json'}
+    end
+
+    def body
+      body = {'registration_ids' => registration_ids}
+      body.merge!('collapse_key' => collapse_key) if collapse_key.present?
+      body.merge!('data' => data) if data.present?
+    end
+
+  end
+end

data/lib/rgcm/response.rb

@@ -0,0 +1,38 @@
+module Rgcm
+  class Response
+    attr_reader :body
+
+    def initialize(json)
+      @body = JSON.parse(json, symbolize_names: true)
+    end
+
+    def count_successes
+      self.body[:success]
+    end
+
+    def has_successes?
+      self.count_successes > 0
+    end
+
+    def count_failures
+      self.body[:failure]
+    end
+
+    def has_failures?
+      self.count_failures > 0
+    end
+
+    def results
+      self.body[:results]
+    end
+
+    def errors
+      self.results.select { |result| result.key?(:error) }
+    end
+
+    def successes
+      self.results.select { |result| !result.key?(:error) }
+    end
+
+  end
+end

data/lib/rgcm/version.rb

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

data/lib/rgcm.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+
+require 'active_support/core_ext'
+require 'typhoeus'
+
+require 'rgcm/config'
+require 'rgcm/response'
+require 'rgcm/request_builder'
+require 'rgcm/message'
+require 'rgcm/version'
+require 'rgcm/railtie' if defined?(Rails)
+
+module Rgcm
+
+end

data/rgcm.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rgcm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rgcm"
+  spec.version       = Rgcm::VERSION
+  spec.authors       = ["Alexander Klaiber"]
+  spec.email         = ["alex.klaiber@gmail.com"]
+  spec.summary       = "Google Cloud Messaging"
+  spec.description   = "Google Cloud Messaging"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "typhoeus"
+end

data/spec/fixtures/responses/failure.json

@@ -0,0 +1,9 @@
+{
+    "multicast_id":5030383832068975557,
+    "success":0,
+    "failure":1,
+    "canonical_ids":0,
+    "results":[
+        { "error":"NotRegistered" }
+    ]
+}

data/spec/fixtures/responses/multi.json

@@ -0,0 +1,25 @@
+{
+    "multicast_id":5958304298192430760,
+    "success":3,
+    "failure":11,
+    "canonical_ids":1,
+    "results":[
+        { "message_id":"0:1403426982650227%62dfd0f6e116c072"},
+        { "error":"NotRegistered"},
+        { "error":"NotRegistered"},
+        { "error":"NotRegistered"},
+        { "error":"NotRegistered"},
+        { "error":"NotRegistered"},
+        { "error":"NotRegistered"},
+        { "error":"NotRegistered"},
+        { "error":"NotRegistered"},
+        {
+            "message_id":"0:1403426982651391%b930435be116c072",
+            "registration_id":"APA91bFgaPSr9eX0VKsgFT15bg8umQBftGGOVEsKjBm9KtLfU5pz1ytEZkCm7YKjXbpavurXSqMdh1Sviry4ZoXZIZmzLTDI2ti6mxFjuY4tNom5uO8VcvH2EjPu2mwFuZyfQomJpRmVsraCJWpyOzms5WMgrYIdQXb08UvOKKe72ByOcClxlAo"
+        },
+        { "error":"NotRegistered"},
+        { "error":"NotRegistered"},
+        { "error":"NotRegistered"},
+        { "message_id":"0:1403426982652703%b930435be116c072"}
+    ]
+}

data/spec/fixtures/responses/successfully.json

@@ -0,0 +1,9 @@
+{
+    "multicast_id":5030383832068975557,
+    "success":1,
+    "failure":0,
+    "canonical_ids":0,
+    "results":[
+        { "message_id":"0:1403425286258916%62dfd0f6e116c072" }
+    ]
+}

data/spec/rgcm/message_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Rgcm::Message do
+
+  let(:data) { {score: '4x8', time: '15:16.2342'} }
+
+  before do
+    Typhoeus.stub(Rgcm::Config::URI).and_return(Typhoeus::Response.new(code: 200, body: json))
+  end
+
+  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)
+
+    expect(response).to be_kind_of(Rgcm::Response)
+  end
+
+end

data/spec/rgcm/request_builder_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Rgcm::RequestBuilder do
+
+  let(:api_key) { 'TEST_API_KEY' }
+  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) }
+
+  it 'returns uri' do
+    expect(request.build.base_url).to eql(Rgcm::Config::URI)
+  end
+
+  it 'returns authorization' do
+    expect(request.build.options[:headers]['Authorization']).to eql("key=#{api_key}")
+  end
+
+  it 'returns content type' do
+    expect(request.build.options[:headers]['Content-Type']).to eql('application/json')
+  end
+
+  it 'returns registration_id' 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)
+  end
+
+  it 'returns data' do
+    expect(json(request.build.options[:body])[:data]).to eql(data)
+  end
+end

data/spec/rgcm/response_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Rgcm::Response do
+  let(:response) { Rgcm::Response.new(json) }
+
+  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
+    end
+    it '#has_failures?' do
+      expect(response.has_failures?).to be_false
+    end
+    it '#count_successes' do
+      expect(response.count_successes).to eql(1)
+    end
+    it '#has_failures?' do
+      expect(response.count_failures).to eql(0)
+    end
+  end
+
+  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
+    end
+    it '#has_failures?' do
+      expect(response.has_failures?).to be_true
+    end
+    it '#count_successes' do
+      expect(response.count_successes).to eql(0)
+    end
+    it '#has_failures?' do
+      expect(response.count_failures).to eql(1)
+    end
+    it '#errors' do
+      expect(response.errors.size).to eql(1)
+    end
+  end
+
+  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
+    end
+    it '#has_failures?' do
+      expect(response.has_failures?).to be_true
+    end
+    it '#count_successes' do
+      expect(response.count_successes).to eql(3)
+    end
+    it '#has_failures?' do
+      expect(response.count_failures).to eql(11)
+    end
+    it '#errors' do
+      expect(response.errors.size).to eql(11)
+    end
+    it '#successes' do
+      expect(response.successes.size).to eql(3)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+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'
+
+  config.include(JsonHelper)
+end

data/spec/support/json_helper.rb

@@ -0,0 +1,5 @@
+module JsonHelper
+  def json(str)
+    JSON.parse(str, symbolize_names: true)
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: rgcm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Klaiber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Google Cloud Messaging
+email:
+- alex.klaiber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rgcm.rb
+- lib/rgcm/config.rb
+- lib/rgcm/message.rb
+- lib/rgcm/railtie.rb
+- lib/rgcm/request_builder.rb
+- lib/rgcm/response.rb
+- lib/rgcm/version.rb
+- rgcm.gemspec
+- spec/fixtures/responses/failure.json
+- spec/fixtures/responses/multi.json
+- spec/fixtures/responses/successfully.json
+- spec/rgcm/message_spec.rb
+- spec/rgcm/request_builder_spec.rb
+- spec/rgcm/response_spec.rb
+- spec/spec_helper.rb
+- spec/support/json_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Google Cloud Messaging
+test_files:
+- spec/fixtures/responses/failure.json
+- spec/fixtures/responses/multi.json
+- spec/fixtures/responses/successfully.json
+- spec/rgcm/message_spec.rb
+- spec/rgcm/request_builder_spec.rb
+- spec/rgcm/response_spec.rb
+- spec/spec_helper.rb
+- spec/support/json_helper.rb