nuge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 621e407ad8f5cd31a3f7a321b40c770286904065
+  data.tar.gz: fc6e9f6a73fb5ec6d6579e38e1c689c12c0b9d5a
+SHA512:
+  metadata.gz: 002b0082d6f5b08254331d0e4b96afc96f550c4dd740b084c2f98464a5306f920062000d73eb99fe0d55e8a576e4f1864cf4ae0574ac0d02e41198af482a9f56
+  data.tar.gz: 86514737fee19dfb4ffd5b34d20b00fd6d0ee62ed49f0bac6e41c48ebefb4dfaf862cc36a073bc7338f8db03dbc2fbd1d9b6cc30c410d94b4eb1628a7a894cad

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+bin/
+pkg/
+TODO

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+-I spec/spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0
+
+* Initial release, supporting Grocer and Urbanairship clients.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dscout, Inc
+
+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,70 @@
+[![Build Status](https://travis-ci.org/dscout/nuge.png?branch=master)](https://travis-ci.org/dscout/nuge)
+[![Code Climate](https://codeclimate.com/github/dscout/nuge.png)](https://codeclimate.com/github/dscout/nuge)
+
+# Nuge
+
+The biz of pushing to multiple notification clients from a single source. Nuge
+presents a uniform interface for pushing out messages from a single source.
+
+Supported services (some pending):
+
+* Grocer
+* Urbanairship
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nuge'
+```
+
+## Usage
+
+By default Nuge is a no-op. You'll need to configure any clients that you wish
+to push with.
+
+### Grocer Client
+
+```ruby
+require 'nuge/clients/grocer'
+
+Nuge::Pusher.clients << Nuge::Clients::Grocer(certificate: '/path/to/cert.pem')
+```
+
+### Urbanairship Client
+
+```ruby
+require 'nuge/clients/urbanairship'
+
+# Using the alternate config block style
+Nuge.configure do |config|
+  config.clients << Nuge::Clients::Urbanairship.new(
+    application_key:    ENV['URBANAIRSHIP_APPLICATION_KEY'],
+    application_secret: ENV['URBANAIRSHIP_APPLICATION_SECRET'],
+    master_secret:      ENV['URBANAIRSHIP_MASTER_SECRET']
+  )
+end
+```
+
+You can then register devices:
+
+```ruby
+pusher = Nuge.pusher
+pusher.register(token)
+pusher.register(token, provider: 'android')
+```
+
+Notification pushing can be configured with custom expanders and formatters:
+
+```ruby
+Nuge.pusher.push(['1234abcd'], alert: 'hello!')
+```
+
+## Contributing
+
+1. Fork it
+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 @@
+require 'bundler/gem_tasks'

data/lib/nuge.rb

@@ -0,0 +1,13 @@
+require 'nuge/client'
+require 'nuge/pusher'
+require 'nuge/version'
+
+module Nuge
+  def self.configure
+    yield Nuge::Pusher
+  end
+
+  def self.pusher(*args)
+    Nuge::Pusher.new(args)
+  end
+end

data/lib/nuge/client.rb

@@ -0,0 +1,12 @@
+module Nuge
+  class Client
+    def register(id, options = {})
+    end
+
+    def unregister(id, options = {})
+    end
+
+    def push(ids, message)
+    end
+  end
+end

data/lib/nuge/clients/grocer.rb

@@ -0,0 +1,36 @@
+require 'grocer'
+require 'nuge/client'
+
+module Nuge
+  module Clients
+    class Grocer < Nuge::Client
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def pusher
+        @pusher ||= ::Grocer.pusher(options)
+      end
+
+      def push(ids, message)
+        notifications(ids, message).each do |notification|
+          pusher.push(notification)
+        end
+      end
+
+      private
+
+      def notifications(ids, message)
+        ids.map do |token|
+          ::Grocer::Notification.new(
+            device_token: token,
+            alert:        message.delete(:alert),
+            custom:       message
+          )
+        end
+      end
+    end
+  end
+end

data/lib/nuge/clients/urbanairship.rb

@@ -0,0 +1,45 @@
+require 'urbanairship'
+
+module Nuge
+  module Clients
+    class Urbanairship
+      attr_reader :options
+      attr_writer :expander
+
+      def initialize(options = {})
+        @expander = options[:expander]
+        @options  = options
+      end
+
+      def pusher
+        @pusher ||= ::Urbanairship.tap do |serv|
+          serv.application_key    = options[:application_key]
+          serv.application_secret = options[:application_secret]
+          serv.master_secret      = options[:master_secret]
+        end
+      end
+
+      def register(id, options = {})
+        pusher.register_device(id, options)
+      end
+
+      def unregister(id, options = {})
+        pusher.unregister_device(id, options)
+      end
+
+      def push(ids, message)
+        formatter = message.delete(:formatter) || Nuge::Formatters::Aps
+
+        pusher.push(formatter.call(ids, message))
+      end
+    end
+  end
+
+  module Formatters
+    module Aps
+      def self.call(ids, message)
+        { device_tokens: ids, aps: message }
+      end
+    end
+  end
+end

data/lib/nuge/pusher.rb

@@ -0,0 +1,40 @@
+require 'set'
+
+module Nuge
+  class Pusher
+    def self.clients=(clients)
+      @clients = Set.new(clients)
+    end
+
+    def self.clients
+      @clients ||= Set.new
+    end
+
+    attr_reader :clients
+    attr_writer :expander
+
+    def initialize(clients = nil)
+      @clients = Set.new(clients || self.class.clients)
+    end
+
+    def push(ids, message)
+      clients.each { |client| client.push(expanded(ids), message) }
+    end
+
+    def register(id, options = {})
+      clients.each { |client| client.register(expanded(id).first, options) }
+    end
+
+    def unregister(id, options = {})
+      clients.each { |client| client.unregister(expanded(id).first, options) }
+    end
+
+    def expander
+      @expander ||= -> (obj) { obj }
+    end
+
+    def expanded(*objects)
+      objects.flatten.map { |obj| expander.call(obj) }
+    end
+  end
+end

data/lib/nuge/version.rb

@@ -0,0 +1,3 @@
+module Nuge
+  VERSION = '0.1.0'
+end

data/nuge.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nuge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nuge'
+  spec.version       = Nuge::VERSION
+  spec.authors       = ['Parker Selbert']
+  spec.email         = ["parker@sorentwo.com"]
+  spec.homepage      = 'https://github.com/dscout/nuge'
+  spec.license       = "MIT"
+  spec.description   = 'Uniform interface for pushing notifications to multiple clients'
+  spec.summary       = 'Uniform interface for pushing notifications to multiple clients'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',      '~> 1.0'
+  spec.add_development_dependency 'rake',         '~> 10.1'
+  spec.add_development_dependency 'rspec',        '~> 2.14'
+  spec.add_development_dependency 'grocer',       '~> 0.4'
+  spec.add_development_dependency 'urbanairship', '~> 2.3'
+end

data/spec/nuge/client_spec.rb

@@ -0,0 +1,11 @@
+require 'nuge/client'
+
+describe Nuge::Client do
+  it 'defines empty methods for the interface' do
+    client = Nuge::Client.new
+
+    expect(client).to respond_to(:register)
+    expect(client).to respond_to(:unregister)
+    expect(client).to respond_to(:push)
+  end
+end

data/spec/nuge/clients/grocer_spec.rb

@@ -0,0 +1,24 @@
+require 'nuge/clients/grocer'
+
+describe Nuge::Clients::Grocer do
+  describe '#initialize' do
+    it 'passes initialization options directly to the service class' do
+      client = Nuge::Clients::Grocer.new(certificate: '/path/to/cert.pem')
+
+      expect(::Grocer).to receive(:pusher).with(certificate: '/path/to/cert.pem')
+
+      client.pusher
+    end
+  end
+
+  describe '#push' do
+    it 'forwards formatted payloads through the service' do
+      client = Nuge::Clients::Grocer.new(certificate: '/path/to/cert.pem')
+
+      expect(client.pusher).to receive(:push).twice
+
+      client.push(['1234', '5678'], alert: 'Hello!')
+    end
+  end
+end
+

data/spec/nuge/clients/urbanairship_spec.rb

@@ -0,0 +1,69 @@
+require 'nuge/clients/urbanairship'
+
+describe Nuge::Clients::Urbanairship do
+  describe '#initialize' do
+    it 'passes initialization options directly to the pusher class' do
+      client  = Nuge::Clients::Urbanairship.new(
+        application_key:    'applicationkey',
+        application_secret: 'applicationsecret',
+        master_secret:      'mastersecret'
+      )
+
+      expect(Urbanairship).to receive(:application_key=).with('applicationkey')
+      expect(Urbanairship).to receive(:application_secret=).with('applicationsecret')
+      expect(Urbanairship).to receive(:master_secret=).with('mastersecret')
+
+      client.pusher
+    end
+  end
+
+  describe '#register' do
+    it 'forwards the registration call through the pusher' do
+      client = Nuge::Clients::Urbanairship.new
+
+      expect(client.pusher).to receive(:register_device).with('1234', {})
+
+      client.register('1234')
+    end
+  end
+
+  describe '#unregister' do
+    it 'forwards the unregistration call through the pusher' do
+      client = Nuge::Clients::Urbanairship.new
+
+      expect(client.pusher).to receive(:unregister_device).with('1234', {})
+
+      client.unregister('1234')
+    end
+  end
+
+  describe '#push' do
+    it 'forwards client configured payloads through the pusher, assuming apns' do
+      client = Nuge::Clients::Urbanairship.new
+      message = { 'alert' => 'hello', 'some_id' => '99' }
+
+      expect(client.pusher).to receive(:push).with(
+        device_tokens: ['1234'],
+        aps: message
+      )
+
+      client.push(['1234'], message)
+    end
+
+    it 'allows the payload to be configured with a formatter' do
+      client = Nuge::Clients::Urbanairship.new
+      message = { 'alert' => 'hello', 'some_id' => '99' }
+
+      expect(client.pusher).to receive(:push).with(
+        ids: ['1234'],
+        message: message
+      )
+
+      formatter = -> (ids, messsage) do
+        { ids: ids, message: message }
+      end
+
+      client.push(['1234'], message.merge(formatter: formatter))
+    end
+  end
+end

data/spec/nuge/pusher_spec.rb

@@ -0,0 +1,80 @@
+require 'nuge/pusher'
+require 'nuge/client'
+
+describe Nuge::Pusher do
+  before do
+    @clients = Nuge::Pusher.clients
+  end
+
+  after do
+    Nuge::Pusher.clients = @clients
+  end
+
+  describe '.clients' do
+    it 'is an empty set if it has not been defined' do
+      expect(Nuge::Pusher.clients).to be_empty
+    end
+  end
+
+  describe '.clients=' do
+    it 'persists client instances at the class level' do
+      client = Nuge::Client.new
+
+      Nuge::Pusher.clients = [client]
+
+      expect(Nuge::Pusher.clients).to include(client)
+      expect(Nuge::Pusher.new.clients).to include(client)
+    end
+  end
+
+  describe '#clients' do
+    it 'defaults to an empty set of clients' do
+      expect(Nuge::Pusher.new).to respond_to(:clients)
+      expect(Nuge::Pusher.new.clients).to be_empty
+    end
+
+    it 'accepts changes to the client set' do
+      nuge   = Nuge::Pusher.new
+      client = Nuge::Client.new
+
+      nuge.clients << client
+      expect(nuge.clients).to include(client)
+    end
+  end
+
+  describe 'forwarding' do
+    it 'forwards client methods to all instantiated clients' do
+      nuge = Nuge::Pusher.new([double(:client), double(:client)])
+
+      nuge.clients.each do |client|
+        expect(client).to receive(:push).with(['1234'], message: 'hello')
+        expect(client).to receive(:register).with('1234', option: true)
+        expect(client).to receive(:unregister).with('1234', option: true)
+      end
+
+      nuge.push(['1234'], message: 'hello')
+      nuge.register('1234', option: true)
+      nuge.unregister('1234', option: true)
+    end
+  end
+
+  describe 'expanders' do
+    it 'applies an identity function against id objects by default' do
+      nuge = Nuge::Pusher.new
+
+      expect(nuge.expanded('abc')).to eq(['abc'])
+    end
+
+    it 'applies expansion against the all supplied id objects' do
+      nuge = Nuge::Pusher.new
+      nuge.expander = -> (obj) { obj[:token] }
+
+      reg_a = { token: 'abc' }
+      reg_b = { token: 'def' }
+
+      expect(nuge.expanded(reg_a)).to eq(%w[abc])
+      expect(nuge.expanded(reg_a, reg_b)).to eq(%w[abc def])
+      expect(nuge.expanded([reg_a, reg_b])).to eq(%w[abc def])
+    end
+  end
+end

data/spec/nuge_spec.rb

@@ -0,0 +1,21 @@
+require 'nuge'
+
+describe Nuge do
+  describe '.configure 'do
+    it 'applies the provided block to the pusher class' do
+      client = Object.new
+
+      Nuge.configure do |config|
+        config.clients = [client]
+      end
+
+      expect(Nuge::Pusher.clients).to include(client)
+    end
+  end
+
+  describe '.pusher' do
+    it 'provides a shortcut to creating a pusher instance' do
+      expect(Nuge.pusher).to be_instance_of(Nuge::Pusher)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+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'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: nuge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Parker Selbert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: grocer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: urbanairship
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Uniform interface for pushing notifications to multiple clients
+email:
+- parker@sorentwo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nuge.rb
+- lib/nuge/client.rb
+- lib/nuge/clients/grocer.rb
+- lib/nuge/clients/urbanairship.rb
+- lib/nuge/pusher.rb
+- lib/nuge/version.rb
+- nuge.gemspec
+- spec/nuge/client_spec.rb
+- spec/nuge/clients/grocer_spec.rb
+- spec/nuge/clients/urbanairship_spec.rb
+- spec/nuge/pusher_spec.rb
+- spec/nuge_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dscout/nuge
+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.0
+signing_key: 
+specification_version: 4
+summary: Uniform interface for pushing notifications to multiple clients
+test_files:
+- spec/nuge/client_spec.rb
+- spec/nuge/clients/grocer_spec.rb
+- spec/nuge/clients/urbanairship_spec.rb
+- spec/nuge/pusher_spec.rb
+- spec/nuge_spec.rb
+- spec/spec_helper.rb