gcm_middleware 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc7668b6b374a402eb48242976980c89934f56f5
+  data.tar.gz: 23873b9160246094485e34826fa579af29e3b2ed
+SHA512:
+  metadata.gz: 6a4eff5600ad2e560fe4ebbe0eeb7f6c1affa7152abbe64a97e606a7cc009bbd3c85976cf499276e5304e887299b0469809d9ca083ff56de2e4f971d28689fc0
+  data.tar.gz: a0df42a0aafd8228d73b480c1ea238e3d3d12b6cfe02fc7bb6f67c4bd4518b2e80ecd8cb718adf4faa69174fbd4069fea2acf20b0753c2968a3ac38fbf0d8d6d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Trevor John
+
+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,45 @@
+# GcmMiddleware
+
+Faraday ( https://github.com/lostisland/faraday ) middleware for Google Cloud Messaging. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gcm_middleware'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gcm_middleware
+
+## Usage
+
+There are two separate Middleware files, the first is for authorization and adds the request header with your api key.
+The second is for storing your original device registration ids. Because GCM does not return your original id, and only returns the new canonical id. This piece will inject the original id into the response body.
+
+```ruby
+Faraday.new('https://android.googleapis.com/') do |f|
+  f.request :gcm_authentication, key: '<your api key'
+
+  f.use :gcm_canonical_id
+  f.use :json
+end
+```
+
+## TODO
+
+* GCMMiddleware::CanonicalId requires the body to have been parsed into a hash. It should handle both cases where it is not already parsed, thus removing the dependency on faraday_middleware.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gcm_middleware/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/gcm_middleware.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gcm_middleware/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gcm_middleware"
+  spec.version       = GCMMiddleware::VERSION
+  spec.authors       = ["Trevor John"]
+  spec.email         = ["trevor@john.tj"]
+  spec.summary       = %q{A collection of faraday middleware for Google Cloud Messaging}
+  spec.description   = %q{Adds authentication key and stores original device registration ids on requests}
+  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_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/lib/gcm_middleware/authentication.rb

@@ -0,0 +1,21 @@
+module GCMMiddleware
+  class Authentication
+    def initialize(app, options = {})
+      @app, @options = app, options
+    end
+
+    def call(env)
+      env.request_headers['Authorization'] = auth_key
+
+      app.call(env).on_complete { |env| }
+    end
+
+    private
+
+    attr_reader :app, :options
+
+    def auth_key
+      @auth_key ||= "key=#{options[:key]}".freeze
+    end
+  end
+end

data/lib/gcm_middleware/canonical_id.rb

@@ -0,0 +1,33 @@
+module GCMMiddleware
+  class CanonicalId
+    def initialize(app, options = {})
+      @app = app
+    end
+
+    def call(env)
+      save_ids(env.body)
+
+      app.call(env).on_complete do |env|
+        inject_original_ids(env.body) if has_registration_ids && env.body
+      end
+    end
+
+    private
+
+    attr_reader :registration_ids, :app
+
+    def inject_original_ids(body)
+      body['results'].each_with_index do |result, i|
+        result['original_id'] = registration_ids[i]
+      end
+    end
+
+    def save_ids(body)
+      @registration_ids = body.fetch('registration_ids', []) if body
+    end
+
+    def has_registration_ids
+      registration_ids && registration_ids.any?
+    end
+  end
+end

data/lib/gcm_middleware/version.rb

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

data/lib/gcm_middleware.rb

@@ -0,0 +1,17 @@
+require 'faraday'
+require 'gcm_middleware/version'
+
+module GCMMiddleware
+  autoload :Authentication, 'gcm_middleware/authentication'
+  autoload :CanonicalId, 'gcm_middleware/canonical_id'
+
+  if Faraday::Middleware.respond_to? :register_middleware
+    Faraday::Request.register_middleware \
+      :gcm_authentication => lambda { Authentication }
+
+    Faraday::Middleware.register_middleware \
+      :gcm_canonical_id => lambda { CanonicalId }
+  end
+end
+
+require 'faraday_middleware/backwards_compatibility'

data/spec/gcm_middleware_spec.rb

@@ -0,0 +1,36 @@
+describe GCMMiddleware do
+  context 'authentication' do
+    let(:faraday) do
+      Faraday.new('http://www.example.com') do |f|
+        f.request :gcm_authentication, key: 'my-api-key'
+
+        f.adapter :test do |stub|
+          stub.get('/test') { |env| [ 200, {}, {} ] }
+        end
+      end
+    end
+
+    it 'registers :gcm_authentication' do
+      response = faraday.get('test')
+      expect(response.env.request_headers['Authorization']).to eq 'key=my-api-key'
+    end
+  end
+
+  context 'canonical id' do
+    let(:faraday) do
+      Faraday.new('http://www.example.com') do |f|
+        f.use :gcm_canonical_id
+
+        f.adapter :test do |stub|
+          stub.post('/test') { |env| [ 200, {}, {'results' => [{}]} ] }
+        end
+      end
+    end
+
+    it 'registers :gcm_canonical_id' do
+      response = faraday.post('test', { 'registration_ids' => ['1'] })
+
+      expect(response.body['results'][0]['original_id']).to eq '1'
+    end
+  end
+end

data/spec/middleware/authentication_spec.rb

@@ -0,0 +1,18 @@
+describe GCMMiddleware::Authentication do
+  let(:faraday) do
+    Faraday.new('http://www.example.com') do |builder|
+      builder.use GCMMiddleware::Authentication, key: 'auth-key'
+
+      builder.adapter :test do |stub|
+        stub.get('/test') { |env| [ 200, {}, {} ] }
+      end
+    end
+  end
+
+  it 'injects the key into the header' do
+    response = faraday.get '/test'
+
+    expect(response.env.request_headers['Authorization']).to eq('key=auth-key')
+  end
+end
+

data/spec/middleware/canonical_id_spec.rb

@@ -0,0 +1,75 @@
+describe GCMMiddleware::CanonicalId do
+  let(:faraday) do
+    Faraday.new('http://www.example.com') do |builder|
+      builder.use GCMMiddleware::CanonicalId
+
+      builder.adapter :test do |stub|
+        stub.post('/test') { |env| [ 200, {}, {'results' => raw_results} ] }
+        stub.post('/error') { |env| [ 200, {}, nil ] }
+      end
+    end
+  end
+  let(:raw_results) { [] }
+
+  context 'with no body' do
+    it 'does not modify request' do
+      response = faraday.post '/test', nil
+
+      expect(response.body).to eq({'results' => []})
+    end
+  end
+
+  context 'when no registration ids' do
+    let(:body) { {'foo' =>  'bar'} }
+
+    it 'does nothing with the request' do
+      response = faraday.post '/test', body
+
+      expect(response.body).to eq({'results' => []})
+    end
+  end
+
+  context 'with registration ids' do
+    let(:raw_results) do
+      [
+        {
+          'message_id' => 'message-1',
+          'registration_id' => 'registration-1',
+          'error' => nil
+        },
+        {
+          'message_id' => 'message-2',
+          'registration_id' => 'registration-2',
+          'error' => nil
+        }
+      ]
+    end
+    let(:body) { {'registration_ids' => ['first-id', 'second-id']} }
+
+    it 'stores the original ids in the response' do
+      response = faraday.post '/test', body
+
+      results = response.body['results']
+      expect(results[0]).to eq({
+          'message_id' => 'message-1',
+          'registration_id' => 'registration-1',
+          'error' => nil,
+          'original_id' => 'first-id'
+      })
+      expect(results[1]).to eq({
+          'message_id' => 'message-2',
+          'registration_id' => 'registration-2',
+          'error' => nil,
+          'original_id' => 'second-id'
+      })
+    end
+
+    context 'with no response body' do
+      it 'does not throw exception' do
+        response = faraday.post '/error', body
+
+        expect(response.body).to be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'gcm_middleware'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: gcm_middleware
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Trevor John
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday_middleware
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Adds authentication key and stores original device registration ids on
+  requests
+email:
+- trevor@john.tj
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gcm_middleware.gemspec
+- lib/gcm_middleware.rb
+- lib/gcm_middleware/authentication.rb
+- lib/gcm_middleware/canonical_id.rb
+- lib/gcm_middleware/version.rb
+- spec/gcm_middleware_spec.rb
+- spec/middleware/authentication_spec.rb
+- spec/middleware/canonical_id_spec.rb
+- spec/spec_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.2.2
+signing_key: 
+specification_version: 4
+summary: A collection of faraday middleware for Google Cloud Messaging
+test_files:
+- spec/gcm_middleware_spec.rb
+- spec/middleware/authentication_spec.rb
+- spec/middleware/canonical_id_spec.rb
+- spec/spec_helper.rb