grocer 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+-r pry

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  # - rbx-19mode
+  # - jruby-19mode
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Steven Harman
+
+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,124 @@
+# Grocer
+
+[![Build Status](https://secure.travis-ci.org/highgroove/grocer.png)](http://travis-ci.org/highgroove/grocer)
+[![Dependency Status](https://gemnasium.com/highgroove/grocer.png)](https://gemnasium.com/highgroove/grocer)
+
+*grocer* interfaces with the [Apple Push Notification
+Service](http://developer.apple.com/library/mac/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/ApplePushService/ApplePushService.html)
+to send push notifications to iOS devices.
+
+There are other gems out there to do this, but *grocer* plans to be the
+cleanest, most extensible, and best maintained.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grocer'
+```
+
+## Usage
+
+### Connecting
+
+```ruby
+# `certificate` is the only required option; the rest will default to the values
+# shown here.
+#
+# Information on obtaining a `.pem` file for use with `certificate` is shown
+# later.
+pusher = Grocer.pusher.new(
+    certificate: "/path/to/cert.pem",      # required
+    passphrase:  "",                       # optional
+    gateway:     "gateway.push.apple.com", # optional; See note below.
+    port:        2195                      # optional
+)
+```
+
+**NOTE**: The `gateway` option defaults to `gateway.push.apple.com`
+**only** when running in a production environement, as determined by
+either the `RAILS_ENV` or `RACK_ENV` environment variables. In all other
+cases, it defaults to the sandbox gateway,
+`gateway.sandbox.push.apple.com`.
+
+### Sending Notifications
+
+```ruby
+# `device_token` and either `alert` or `badge` are required.
+#
+# Information on obtaining `device_token` is shown later.
+notification = Grocer::Notification.new(
+  device_token: "fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2",
+  alert:        "Hello from Grocer!",
+  badge:        42,
+  sound:        "siren.aiff",         # optional
+  expiry:       Time.now + 60*60,     # optional; 0 is default, meaning the message is not stored
+  identifier:   1234                  # optional
+)
+
+pusher.push(notification)
+```
+
+It is desirable to reuse the same connection to send multiple notifications, as
+is recommended by Apple.
+
+```ruby
+pusher = Grocer.pusher(connection_options)
+notifications.each do |notification|
+  pusher.push(notification)
+end
+```
+
+### Feedback
+
+```ruby
+# `certificate` is the only required option; the rest will default to the values
+# shown here.
+feedback = Grocer.feedback.new(
+  certificate: "/path/to/cert.pem",       # required
+  passphrase:  "",                        # optional
+  gateway:     "feedback.push.apple.com", # optional; See note below.
+  port:        2196                       # optional
+)
+
+feedback.each do |attempt|
+  puts "Device #{attempt.device_token} failed at #{attempt.timestamp}
+end
+```
+
+**NOTE**: The `gateway` option defaults to `feedback.push.apple.com`
+**only** when running in a production environement, as determined by
+either the `RAILS_ENV` or `RACK_ENV` environment variables. In all other
+cases, it defaults to the sandbox gateway,
+`feedback.sandbox.push.apple.com`.
+
+### Device Token
+
+A device token is obtained from within the iOS app. More details are in Apple's
+[Registering for Remote
+Notifications](http://developer.apple.com/library/mac/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/IPhoneOSClientImp/IPhoneOSClientImp.html#//apple_ref/doc/uid/TP40008194-CH103-SW1)
+documentation.
+
+The key code for this purpose is:
+
+```objective-c
+- (void)applicationDidFinishLaunching:(UIApplication *)app {
+   // other setup tasks here....
+   [[UIApplication sharedApplication] registerForRemoteNotificationTypes:(UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeBadge | UIRemoteNotificationTypeSound)];
+}
+
+- (void)application:(UIApplication *)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)devToken {
+    NSLog(@"Got device token: %@", [devToken description]);
+
+    [self sendProviderDeviceToken:[devToken bytes]]; // custom method; e.g., send to a web service and store
+}
+
+- (void)application:(UIApplication *)app didFailToRegisterForRemoteNotificationsWithError:(NSError *)err {
+    NSLog(@"Error in registration. Error: %@", err);
+}
+```
+
+### Certificate File
+
+TODO: Describe how to get a .pem

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/grocer.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/grocer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Andy Lindeman', 'Steven Harman', 'Patrick Van Stee']
+  gem.email         = ['andy@highgroove.com', 'steven@highgroove.com', 'vanstee@highgroove.com']
+  gem.description   = %q{Pushing your Apple notifications since 2012.}
+  gem.summary       = %q{Pushing your Apple notifications since 2012.}
+  gem.homepage      = 'https://github.com/highgroove/grocer'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "grocer"
+  gem.require_paths = ["lib"]
+  gem.version       = Grocer::VERSION
+
+  gem.add_development_dependency 'rspec', '~> 2.9.0'
+  gem.add_development_dependency 'pry', '~> 0.9.8'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'bourne'
+  gem.add_development_dependency 'rake'
+end

data/lib/grocer.rb

@@ -0,0 +1,24 @@
+require_relative 'grocer/feedback'
+require_relative 'grocer/notification'
+require_relative 'grocer/feedback_connection'
+require_relative 'grocer/push_connection'
+require_relative 'grocer/pusher'
+require_relative 'grocer/version'
+
+module Grocer
+
+  def self.env
+    ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+  end
+
+  def self.feedback(options)
+    connection = FeedbackConnection.new(options)
+    Feedback.new(options)
+  end
+
+  def self.pusher(options)
+    connection = PushConnection.new(options)
+    Pusher.new(connection)
+  end
+
+end

data/lib/grocer/connection.rb

@@ -0,0 +1,48 @@
+require 'grocer'
+require 'grocer/no_certificate_error'
+require 'grocer/no_gateway_error'
+require 'grocer/no_port_error'
+require 'grocer/ssl_connection'
+
+module Grocer
+  class Connection
+    attr_reader :certificate, :passphrase, :gateway, :port
+
+    def initialize(options = {})
+      @certificate = options.fetch(:certificate) { fail NoCertificateError }
+      @gateway = options.fetch(:gateway) { fail NoGatewayError }
+      @port = options.fetch(:port) { fail NoPortError }
+      @passphrase = options.fetch(:passphrase) { nil }
+    end
+
+    def read(size = nil, buf = nil)
+      with_open_connection do
+        ssl.read(size, buf)
+      end
+    end
+
+    def write(content)
+      with_open_connection do
+        ssl.write(content)
+      end
+    end
+
+    private
+
+    def ssl
+      @ssl_connection ||= build_connection
+    end
+
+    def build_connection
+      Grocer::SSLConnection.new(certificate: certificate,
+                                passphrase: passphrase,
+                                gateway: gateway,
+                                port: port)
+    end
+
+    def with_open_connection(&block)
+      ssl.connect unless ssl.connected?
+      block.call
+    end
+  end
+end

data/lib/grocer/failed_delivery_attempt.rb

@@ -0,0 +1,18 @@
+require_relative 'invalid_format_error'
+
+module Grocer
+  class FailedDeliveryAttempt
+    LENGTH = 38
+
+    attr_accessor :timestamp, :device_token
+
+    def initialize(binary_tuple)
+      # N   =>  4 byte timestamp
+      # n   =>  2 byte token_length
+      # H64 => 32 byte device_token
+      seconds, _, @device_token = binary_tuple.unpack('NnH64')
+      raise InvalidFormatError unless seconds && @device_token
+      @timestamp = Time.at(seconds)
+    end
+  end
+end

data/lib/grocer/feedback.rb

@@ -0,0 +1,17 @@
+require_relative 'failed_delivery_attempt'
+
+module Grocer
+  class Feedback
+    include Enumerable
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def each
+      while buf = @connection.read(FailedDeliveryAttempt::LENGTH)
+        yield FailedDeliveryAttempt.new(buf)
+      end
+    end
+  end
+end

data/lib/grocer/feedback_connection.rb

@@ -0,0 +1,29 @@
+require 'delegate'
+require_relative 'connection'
+
+module Grocer
+  class FeedbackConnection < SimpleDelegator
+
+    PRODUCTION_GATEWAY = 'feedback.push.apple.com'
+    SANDBOX_GATEWAY = 'feedback.sandbox.push.apple.com'
+
+    def initialize(options)
+      options = defaults.merge(options)
+      super(Connection.new(options))
+    end
+
+    private
+
+    def defaults
+      {
+        gateway: find_default_gateway,
+        port: 2196
+      }
+    end
+
+    def find_default_gateway
+      Grocer.env == 'production' ? PRODUCTION_GATEWAY : SANDBOX_GATEWAY
+    end
+
+  end
+end

data/lib/grocer/invalid_format_error.rb

@@ -0,0 +1,4 @@
+module Grocer
+  class InvalidFormatError < StandardError
+  end
+end

data/lib/grocer/no_certificate_error.rb

@@ -0,0 +1,4 @@
+module Grocer
+  class NoCertificateError < StandardError
+  end
+end

data/lib/grocer/no_gateway_error.rb

@@ -0,0 +1,4 @@
+module Grocer
+  class NoGatewayError < StandardError
+  end
+end

data/lib/grocer/no_payload_error.rb

@@ -0,0 +1,4 @@
+module Grocer
+  class NoPayloadError < StandardError
+  end
+end

data/lib/grocer/no_port_error.rb

@@ -0,0 +1,4 @@
+module Grocer
+  class NoPortError < StandardError
+  end
+end

data/lib/grocer/notification.rb

@@ -0,0 +1,54 @@
+require 'json'
+require_relative 'no_payload_error'
+
+module Grocer
+  class Notification
+    attr_accessor :identifier, :expiry, :device_token, :alert, :badge, :sound
+
+    def initialize(payload = {})
+      @identifier = 0
+
+      payload.each do |key, val|
+        send("#{key}=", val)
+      end
+    end
+
+    def to_bytes
+      validate_payload
+      payload = encoded_payload
+
+      [1, identifier, expiry_epoch_time, device_token_length, sanitized_device_token, payload.length].pack('CNNnH64n') << payload
+    end
+
+    private
+
+    def validate_payload
+      fail NoPayloadError unless alert || badge
+    end
+
+    def encoded_payload
+      JSON.dump(payload_hash)
+    end
+
+    def payload_hash
+      aps_hash = { }
+      aps_hash[:alert] = alert if alert
+      aps_hash[:badge] = badge if badge
+      aps_hash[:sound] = sound if sound
+
+      { aps: aps_hash }
+    end
+
+    def expiry_epoch_time
+      expiry.to_i
+    end
+
+    def sanitized_device_token
+      device_token.tr(' ', '') if device_token
+    end
+
+    def device_token_length
+      32
+    end
+  end
+end

data/lib/grocer/push_connection.rb

@@ -0,0 +1,29 @@
+require 'delegate'
+require_relative 'connection'
+
+module Grocer
+  class PushConnection < SimpleDelegator
+
+    PRODUCTION_GATEWAY = 'gateway.push.apple.com'
+    SANDBOX_GATEWAY = 'gateway.sandbox.push.apple.com'
+
+    def initialize(options)
+      options = defaults.merge(options)
+      super(Connection.new(options))
+    end
+
+    private
+
+    def defaults
+      {
+        gateway: find_default_gateway,
+        port: 2195
+      }
+    end
+
+    def find_default_gateway
+      Grocer.env == 'production' ? PRODUCTION_GATEWAY : SANDBOX_GATEWAY
+    end
+
+  end
+end

data/lib/grocer/pusher.rb

@@ -0,0 +1,11 @@
+module Grocer
+  class Pusher
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def push(notification)
+      @connection.write(notification.to_bytes)
+    end
+  end
+end

data/lib/grocer/ssl_connection.rb

@@ -0,0 +1,47 @@
+require 'socket'
+require 'openssl'
+require 'forwardable'
+
+module Grocer
+  class SSLConnection
+    extend Forwardable
+    def_delegators :@ssl, :write, :read
+
+    attr_accessor :certificate, :passphrase, :gateway, :port
+
+    def initialize(options = {})
+      options.each do |key, val|
+        send("#{key}=", val)
+      end
+    end
+
+    def connected?
+      !@ssl.nil?
+    end
+
+    def connect
+      cert_data    = File.read(certificate)
+      context      = OpenSSL::SSL::SSLContext.new
+      context.key  = OpenSSL::PKey::RSA.new(cert_data, passphrase)
+      context.cert = OpenSSL::X509::Certificate.new(cert_data)
+
+      @sock     = TCPSocket.new(gateway, port)
+      @ssl      = OpenSSL::SSL::SSLSocket.new(@sock, context)
+      @ssl.sync = true
+      @ssl.connect
+    end
+
+    def disconnect
+      @ssl.close if @ssl
+      @ssl = nil
+
+      @sock.close if @sock
+      @sock = nil
+    end
+
+    def reconnect
+      disconnect
+      connect
+    end
+  end
+end

data/lib/grocer/version.rb

@@ -0,0 +1,3 @@
+module Grocer
+  VERSION = '0.0.1'
+end

data/spec/fixtures/example.cer

@@ -0,0 +1,14 @@
+-----BEGIN CERTIFICATE-----
+MIICKzCCAdWgAwIBAgIJAKDDs5zNJQVeMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV
+BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX
+aWRnaXRzIFB0eSBMdGQwHhcNMTIwMzI5MTg1MDEwWhcNMTIwNDI4MTg1MDEwWjBF
+MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50
+ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANlO
+UQLaP+NWbniFq2I0yW7AOyOjrKuEBj9i4cVOR1EWN2wnf64gmRucz+DKmxfYr5kq
++XT6GIpEdw0wrBGsKlUCAwEAAaOBpzCBpDAdBgNVHQ4EFgQUVkHor75NOFIKInJN
+VUpmqRbWfsgwdQYDVR0jBG4wbIAUVkHor75NOFIKInJNVUpmqRbWfsihSaRHMEUx
+CzAJBgNVBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRl
+cm5ldCBXaWRnaXRzIFB0eSBMdGSCCQCgw7OczSUFXjAMBgNVHRMEBTADAQH/MA0G
+CSqGSIb3DQEBBQUAA0EAzPoxFj8j1uUIEGGsViUXkAH9/uoZuCBy9PtHEJcjSkya
+TlKHfzEaEsA8pfmHax3gMgYcIbbWuYVR/HTUEnog9Q==
+-----END CERTIFICATE-----

data/spec/fixtures/example.key

@@ -0,0 +1,9 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIBOwIBAAJBANlOUQLaP+NWbniFq2I0yW7AOyOjrKuEBj9i4cVOR1EWN2wnf64g
+mRucz+DKmxfYr5kq+XT6GIpEdw0wrBGsKlUCAwEAAQJBAISneW67Wrrl/WQXfWri
+/IBeWvvDo9nEK6gwLdCrm3+UZ18Tr9scjdvWsRbHy6fiIYIIZY0KA0mIx1TlPxbD
+ANUCIQDuc5KeAJZ5bVDWK/Qca6/kAtx6jKH0Q8A4M4vhEynHwwIhAOlMXJqUyt4p
+As+jG3jRz820QQW5CkjQ4rNCvDgnEjwHAiArzn+5F1KNrE+ViS2nqwD9Wqk2um9m
+eKvvp0ijaOncEQIgG7dwwQSwXVht9xEfsGjs0Tl7CB0FtcTrSfTBu8IYjn0CIQCh
+tJEYZA1szHnTdHA2V8FvQ9ZDC3KW6pBvKDQJkqPIaw==
+-----END RSA PRIVATE KEY-----

data/spec/fixtures/example.pem

@@ -0,0 +1,23 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIBOwIBAAJBANlOUQLaP+NWbniFq2I0yW7AOyOjrKuEBj9i4cVOR1EWN2wnf64g
+mRucz+DKmxfYr5kq+XT6GIpEdw0wrBGsKlUCAwEAAQJBAISneW67Wrrl/WQXfWri
+/IBeWvvDo9nEK6gwLdCrm3+UZ18Tr9scjdvWsRbHy6fiIYIIZY0KA0mIx1TlPxbD
+ANUCIQDuc5KeAJZ5bVDWK/Qca6/kAtx6jKH0Q8A4M4vhEynHwwIhAOlMXJqUyt4p
+As+jG3jRz820QQW5CkjQ4rNCvDgnEjwHAiArzn+5F1KNrE+ViS2nqwD9Wqk2um9m
+eKvvp0ijaOncEQIgG7dwwQSwXVht9xEfsGjs0Tl7CB0FtcTrSfTBu8IYjn0CIQCh
+tJEYZA1szHnTdHA2V8FvQ9ZDC3KW6pBvKDQJkqPIaw==
+-----END RSA PRIVATE KEY-----
+-----BEGIN CERTIFICATE-----
+MIICKzCCAdWgAwIBAgIJAKDDs5zNJQVeMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV
+BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX
+aWRnaXRzIFB0eSBMdGQwHhcNMTIwMzI5MTg1MDEwWhcNMTIwNDI4MTg1MDEwWjBF
+MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50
+ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANlO
+UQLaP+NWbniFq2I0yW7AOyOjrKuEBj9i4cVOR1EWN2wnf64gmRucz+DKmxfYr5kq
++XT6GIpEdw0wrBGsKlUCAwEAAaOBpzCBpDAdBgNVHQ4EFgQUVkHor75NOFIKInJN
+VUpmqRbWfsgwdQYDVR0jBG4wbIAUVkHor75NOFIKInJNVUpmqRbWfsihSaRHMEUx
+CzAJBgNVBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRl
+cm5ldCBXaWRnaXRzIFB0eSBMdGSCCQCgw7OczSUFXjAMBgNVHRMEBTADAQH/MA0G
+CSqGSIb3DQEBBQUAA0EAzPoxFj8j1uUIEGGsViUXkAH9/uoZuCBy9PtHEJcjSkya
+TlKHfzEaEsA8pfmHax3gMgYcIbbWuYVR/HTUEnog9Q==
+-----END CERTIFICATE-----

data/spec/grocer/connection_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'grocer/connection'
+
+describe Grocer::Connection do
+  subject { described_class.new(connection_options) }
+  let(:connection_options) { { certificate: '/path/to/cert.pem',
+                               gateway: 'push.example.com',
+                               port: 443 } }
+  let(:ssl) { stub_everything('SSLConnection') }
+  before do
+    Grocer::SSLConnection.stubs(:new).returns(ssl)
+  end
+
+  it 'requires a certificate' do
+    connection_options.delete(:certificate)
+    -> { described_class.new(connection_options) }.should raise_error(Grocer::NoCertificateError)
+  end
+
+  it 'can be initialized with a certificate' do
+    subject.certificate.should == '/path/to/cert.pem'
+  end
+
+  it 'defaults to an empty passphrase' do
+    subject.passphrase.should be_nil
+  end
+
+  it 'can be initialized with a passphrase' do
+    connection_options[:passphrase] = 'new england clam chowder'
+    subject.passphrase.should == 'new england clam chowder'
+  end
+
+  it 'requires a gateway' do
+    connection_options.delete(:gateway)
+    -> { described_class.new(connection_options) }.should raise_error(Grocer::NoGatewayError)
+  end
+
+  it 'can be initialized with a gateway' do
+    subject.gateway.should == 'push.example.com'
+  end
+
+  it 'requires a port' do
+    connection_options.delete(:port)
+    -> { described_class.new(connection_options) }.should raise_error(Grocer::NoPortError)
+  end
+
+  it 'can be initialized with a port' do
+    subject.port.should == 443
+  end
+
+  context 'an open SSLConnection' do
+    before do
+      ssl.stubs(:connected?).returns(true)
+    end
+
+    it '#write delegates to open SSLConnection' do
+      subject.write('Apples to Oranges')
+      ssl.should have_received(:write).with('Apples to Oranges')
+    end
+
+    it '#read delegates to open SSLConnection' do
+      subject.read(42, 'IO')
+      ssl.should have_received(:read).with(42, 'IO')
+    end
+  end
+
+  context 'a closed SSLConnection' do
+    before do
+      ssl.stubs(:connected?).returns(false)
+    end
+
+    it '#write connects SSLConnection and delegates to it' do
+      subject.write('Apples to Oranges')
+      ssl.should have_received(:connect)
+      ssl.should have_received(:write).with('Apples to Oranges')
+    end
+
+    it '#read connects SSLConnection delegates to open SSLConnection' do
+      subject.read(42, 'IO')
+      ssl.should have_received(:connect)
+      ssl.should have_received(:read).with(42, 'IO')
+    end
+  end
+end

data/spec/grocer/failed_delivery_attempt_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'grocer/failed_delivery_attempt'
+
+describe Grocer::FailedDeliveryAttempt do
+  let(:timestamp) { Time.utc(1995, 12, 21) }
+  let(:device_token) { 'fe15a27d5df3c34778defb1f4f3980265cc52c0c047682223be59fb68500a9a2' }
+  let(:binary_tuple) { [timestamp.to_i, 32, device_token].pack('NnH64') }
+  let(:invalid_binary_tuple) { 'totally not the right format' }
+
+  describe 'decoding' do
+    it 'accepts a binary tuple and sets each attribute' do
+      failed_delivery_attempt = described_class.new(binary_tuple)
+      failed_delivery_attempt.timestamp.should == timestamp
+      failed_delivery_attempt.device_token.should == device_token
+    end
+
+    it 'raises an exception when there are problems decoding' do
+      -> { described_class.new(invalid_binary_tuple) }.should
+        raise_error(Grocer::InvalidFormatError)
+    end
+  end
+end

data/spec/grocer/feedback_connection_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'grocer/feedback_connection'
+
+describe Grocer::FeedbackConnection do
+  subject { described_class.new(options) }
+  let(:options) { { certificate: '/path/to/cert.pem' } }
+  let(:connection) { stub("Connection") }
+
+  it 'delegates reading to the Connection' do
+    Grocer::Connection.any_instance.expects(:read).with(42, 'lolIO')
+    subject.read(42, 'lolIO')
+  end
+
+  it 'delegates writing to the Connection' do
+    Grocer::Connection.any_instance.expects(:write).with('Note Eye Fly')
+    subject.write('Note Eye Fly')
+  end
+
+  it 'can be initialized with a certificate' do
+    subject.certificate.should == '/path/to/cert.pem'
+  end
+
+  it 'can be initialized with a passphrase' do
+    options[:passphrase] = 'open sesame'
+    subject.passphrase.should == 'open sesame'
+  end
+
+  it 'defaults to Apple feedback gateway in production environment' do
+    Grocer.stubs(:env).returns('production')
+    subject.gateway.should == 'feedback.push.apple.com'
+  end
+
+  it 'defaults to the sandboxed Apple feedback gateway in development environment' do
+    Grocer.stubs(:env).returns('development')
+    subject.gateway.should == 'feedback.sandbox.push.apple.com'
+  end
+
+  it 'defaults to the sandboxed Apple feedback gateway in test environment' do
+    Grocer.stubs(:env).returns('test')
+    subject.gateway.should == 'feedback.sandbox.push.apple.com'
+  end
+
+  it 'defaults to the sandboxed Apple feedback gateway for other random values' do
+    Grocer.stubs(:env).returns('random')
+    subject.gateway.should == 'feedback.sandbox.push.apple.com'
+  end
+
+  it 'can be initialized with a gateway' do
+    options[:gateway] = 'gateway.example.com'
+    subject.gateway.should == 'gateway.example.com'
+  end
+
+  it 'defaults to 2196 as the port' do
+    subject.port.should == 2196
+  end
+
+  it 'can be initialized with a port' do
+    options[:port] = 443
+    subject.port.should == 443
+  end
+end

data/spec/grocer/feedback_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'grocer/feedback'
+
+describe Grocer::Feedback do
+  def stub_feedback
+    # "Reads" two failed deliveries: one on Jan 1; the other on Jan 2
+    connection.stubs(:read).
+               with(38).
+               returns([jan1.to_i, 32, device_token].pack('NnH64')).
+               then.
+               returns([jan2.to_i, 32, device_token].pack('NnH64')).
+               then.
+               returns(nil)
+  end
+
+  let(:connection)   { stub_everything }
+  let(:jan1)         { Time.utc(2012, 1, 1) }
+  let(:jan2)         { Time.utc(2012, 1, 2) }
+  let(:device_token) { 'fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2' }
+
+  subject { described_class.new(connection) }
+
+  it 'is enumerable' do
+    subject.should be_kind_of(Enumerable)
+  end
+
+  it 'reads failed delivery attempt messages from the connection' do
+    stub_feedback
+
+    delivery_attempts = subject.to_a
+
+    delivery_attempts[0].timestamp.should == jan1
+    delivery_attempts[0].device_token.should == device_token
+
+    delivery_attempts[1].timestamp.should == jan2
+    delivery_attempts[1].device_token.should == device_token
+  end
+end

data/spec/grocer/notification_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'grocer/notification'
+
+describe Grocer::Notification do
+  describe 'binary format' do
+    let(:notification) { described_class.new(payload_options) }
+    let(:payload_from_bytes) { notification.to_bytes[45..-1] }
+    let(:payload_dictionary_from_bytes) { JSON.parse(payload_from_bytes, symbolize_names: true) }
+    let(:payload_options) { { alert: 'hi', badge: 2, sound: 'siren.aiff' } }
+
+    subject { notification.to_bytes }
+
+    it 'sets the command byte to 1' do
+      subject[0].should == "\x01"
+    end
+
+    it 'defaults the identifer to 0' do
+      subject[1...5].should == "\x00\x00\x00\x00"
+    end
+
+    it 'allows the identifier to be set' do
+      notification.identifier = 1234
+      subject[1...5].should == [1234].pack('N')
+    end
+
+    it 'defaults expiry to zero' do
+      subject[5...9].should == "\x00\x00\x00\x00"
+    end
+
+    it 'allows the expiry to be set' do
+      expiry = notification.expiry = Time.utc(2013, 3, 24, 12, 34, 56)
+      subject[5...9].should == [expiry.to_i].pack('N')
+    end
+
+    it 'encodes the device token length as 32' do
+      subject[9...11].should == "\x00\x20"
+    end
+
+    it 'encodes the device token as a 256-bit integer' do
+      token = notification.device_token = 'fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2'
+      subject[11...43].should == ['fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2'].pack('H*')
+    end
+
+    it 'as a convenience, flattens the device token to remove spaces' do
+      token = notification.device_token = 'fe15 a27d 5df3c3 4778defb1f4f3880265cc52c0c047682223be59fb68500a9a2'
+      subject[11...43].should == ['fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2'].pack('H*')
+    end
+
+    it 'encodes the payload length' do
+      notification.alert = 'Hello World!'
+      subject[43...45].should == [payload_from_bytes.length].pack('n')
+    end
+
+    it 'encodes alert as part of the payload' do
+      notification.alert = 'Hello World!'
+      payload_dictionary_from_bytes[:aps][:alert].should == 'Hello World!'
+    end
+
+    it 'encodes badge as part of the payload' do
+      notification.badge = 42
+      payload_dictionary_from_bytes[:aps][:badge].should == 42
+    end
+
+    it 'encodes sound as part of the payload' do
+      notification.sound = 'siren.aiff'
+      payload_dictionary_from_bytes[:aps][:sound].should == 'siren.aiff'
+    end
+
+    it 'encodes custom payload attributes'
+
+    context 'invalid payload' do
+      let(:payload_options) { Hash.new }
+
+      it 'raises an error when neither alert nor badge is specified' do
+        -> { notification.to_bytes }.should raise_error(Grocer::NoPayloadError)
+      end
+    end
+  end
+end

data/spec/grocer/push_connection_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'grocer/push_connection'
+
+describe Grocer::PushConnection do
+  subject { described_class.new(options) }
+  let(:options) { { certificate: '/path/to/cert.pem' } }
+  let(:connection) { stub("Connection") }
+
+  it 'delegates reading to the Connection' do
+    Grocer::Connection.any_instance.expects(:read).with(42, 'lolIO')
+    subject.read(42, 'lolIO')
+  end
+
+  it 'delegates writing to the Connection' do
+    Grocer::Connection.any_instance.expects(:write).with('Note Eye Fly')
+    subject.write('Note Eye Fly')
+  end
+
+  it 'can be initialized with a certificate' do
+    subject.certificate.should == '/path/to/cert.pem'
+  end
+
+  it 'can be initialized with a passphrase' do
+    options[:passphrase] = 'open sesame'
+    subject.passphrase.should == 'open sesame'
+  end
+
+  it 'defaults to Apple push gateway in production environment' do
+    Grocer.stubs(:env).returns('production')
+    subject.gateway.should == 'gateway.push.apple.com'
+  end
+
+  it 'defaults to the sandboxed Apple push gateway in development environment' do
+    Grocer.stubs(:env).returns('development')
+    subject.gateway.should == 'gateway.sandbox.push.apple.com'
+  end
+
+  it 'defaults to the sandboxed Apple push gateway in test environment' do
+    Grocer.stubs(:env).returns('test')
+    subject.gateway.should == 'gateway.sandbox.push.apple.com'
+  end
+
+  it 'defaults to the sandboxed Apple push gateway for other random values' do
+    Grocer.stubs(:env).returns('random')
+    subject.gateway.should == 'gateway.sandbox.push.apple.com'
+  end
+
+  it 'can be initialized with a gateway' do
+    options[:gateway] = 'gateway.example.com'
+    subject.gateway.should == 'gateway.example.com'
+  end
+
+  it 'defaults to 2195 as the port' do
+    subject.port.should == 2195
+  end
+
+  it 'can be initialized with a port' do
+    options[:port] = 443
+    subject.port.should == 443
+  end
+
+end

data/spec/grocer/pusher_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'grocer/pusher'
+
+describe Grocer::Pusher do
+  let(:connection) { stub_everything }
+
+  subject { described_class.new(connection) }
+
+  describe '#push' do
+    it 'serializes a notification and sends it via the connection' do
+      notification = stub(:to_bytes => 'abc123')
+      subject.push(notification)
+
+      connection.should have_received(:write).with('abc123')
+    end
+  end
+end

data/spec/grocer/ssl_connection_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'grocer/ssl_connection'
+
+describe Grocer::SSLConnection do
+  def stub_sockets
+    TCPSocket.stubs(:new).returns(mock_socket)
+    OpenSSL::SSL::SSLSocket.stubs(:new).returns(mock_ssl)
+  end
+
+  def stub_certificate
+    example_data = File.read(File.dirname(__FILE__) + '/../fixtures/example.pem')
+    File.stubs(:read).with(connection_options[:certificate]).returns(example_data)
+  end
+
+  let(:mock_socket) { stub_everything }
+  let(:mock_ssl)    { stub_everything }
+
+  let(:connection_options) {
+    {
+      certificate: '/path/to/cert.pem',
+      passphrase:  'abc123',
+      gateway:     'gateway.push.highgroove.com',
+      port:         1234
+    }
+  }
+
+  subject { described_class.new(connection_options) }
+
+  describe 'configuration' do
+    it 'is initialized with a certificate' do
+      subject.certificate.should == connection_options[:certificate]
+    end
+
+    it 'is initialized with a passphrase' do
+      subject.passphrase.should == connection_options[:passphrase]
+    end
+
+    it 'is initialized with a gateway' do
+      subject.gateway.should == connection_options[:gateway]
+    end
+
+    it 'is initialized with a port' do
+      subject.port.should == connection_options[:port]
+    end
+  end
+
+  describe 'connecting' do
+    before do
+      stub_sockets
+      stub_certificate
+    end
+
+    it 'sets up an socket connection' do
+      subject.connect
+      TCPSocket.should have_received(:new).with(connection_options[:gateway],
+                                                connection_options[:port])
+    end
+
+    it 'sets up an SSL connection' do
+      subject.connect
+      OpenSSL::SSL::SSLSocket.should have_received(:new).with(mock_socket, anything)
+    end
+  end
+
+  describe 'writing data' do
+    before do
+      stub_sockets
+      stub_certificate
+    end
+
+    it 'writes data to the SSL connection' do
+      subject.connect
+      subject.write('abc123')
+
+      mock_ssl.should have_received(:write).with('abc123')
+    end
+  end
+
+  describe 'reading data' do
+    before do
+      stub_sockets
+      stub_certificate
+    end
+
+    it 'reads data from the SSL connection' do
+      subject.connect
+      subject.read(42)
+
+      mock_ssl.should have_received(:read).with(42)
+    end
+  end
+end

data/spec/grocer_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'grocer'
+
+describe Grocer do
+  subject { described_class }
+
+  describe '.env' do
+    let(:environment) { nil }
+    before do
+      ENV.stubs(:[]).with('RAILS_ENV').returns(environment)
+      ENV.stubs(:[]).with('RACK_ENV').returns(environment)
+    end
+
+    it 'defaults to development' do
+      subject.env.should == 'development'
+    end
+
+    it 'reads RAILS_ENV from ENV' do
+      ENV.stubs(:[]).with('RAILS_ENV').returns('staging')
+      subject.env.should == 'staging'
+    end
+
+    it 'reads RACK_ENV from ENV' do
+      ENV.stubs(:[]).with('RACK_ENV').returns('staging')
+      subject.env.should == 'staging'
+    end
+  end
+
+  describe 'API facade' do
+    let(:connection_options) { stub('connection options') }
+
+    describe '.pusher' do
+      before do
+        Grocer::PushConnection.stubs(:new).returns(stub('PushConnection'))
+      end
+
+      it 'gets a Pusher' do
+        subject.pusher(connection_options).should be_a Grocer::Pusher
+      end
+
+      it 'passes the connection options on to the underlying Connection' do
+        subject.pusher(connection_options)
+        Grocer::PushConnection.should have_received(:new).with(connection_options)
+      end
+    end
+
+    describe '.feedback' do
+      before do
+        Grocer::FeedbackConnection.stubs(:new).returns(stub('FeedbackConnection'))
+      end
+
+      it 'gets Feedback' do
+        subject.feedback(connection_options).should be_a Grocer::Feedback
+      end
+
+      it 'passes the connection options on to the underlying Connection' do
+        subject.feedback(connection_options)
+        Grocer::FeedbackConnection.should have_received(:new).with(connection_options)
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+ENV['RACK_ENV'] = 'test'
+require 'mocha'
+require 'bourne'
+
+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.mock_with :mocha
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: grocer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andy Lindeman
+- Steven Harman
+- Patrick Van Stee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70193834218040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *70193834218040
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70193834216820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: *70193834216820
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70193834216380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70193834216380
+- !ruby/object:Gem::Dependency
+  name: bourne
+  requirement: &70193834215860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70193834215860
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70193834215440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70193834215440
+description: Pushing your Apple notifications since 2012.
+email:
+- andy@highgroove.com
+- steven@highgroove.com
+- vanstee@highgroove.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- grocer.gemspec
+- lib/grocer.rb
+- lib/grocer/connection.rb
+- lib/grocer/failed_delivery_attempt.rb
+- lib/grocer/feedback.rb
+- lib/grocer/feedback_connection.rb
+- lib/grocer/invalid_format_error.rb
+- lib/grocer/no_certificate_error.rb
+- lib/grocer/no_gateway_error.rb
+- lib/grocer/no_payload_error.rb
+- lib/grocer/no_port_error.rb
+- lib/grocer/notification.rb
+- lib/grocer/push_connection.rb
+- lib/grocer/pusher.rb
+- lib/grocer/ssl_connection.rb
+- lib/grocer/version.rb
+- spec/fixtures/example.cer
+- spec/fixtures/example.key
+- spec/fixtures/example.pem
+- spec/grocer/connection_spec.rb
+- spec/grocer/failed_delivery_attempt_spec.rb
+- spec/grocer/feedback_connection_spec.rb
+- spec/grocer/feedback_spec.rb
+- spec/grocer/notification_spec.rb
+- spec/grocer/push_connection_spec.rb
+- spec/grocer/pusher_spec.rb
+- spec/grocer/ssl_connection_spec.rb
+- spec/grocer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/highgroove/grocer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Pushing your Apple notifications since 2012.
+test_files:
+- spec/fixtures/example.cer
+- spec/fixtures/example.key
+- spec/fixtures/example.pem
+- spec/grocer/connection_spec.rb
+- spec/grocer/failed_delivery_attempt_spec.rb
+- spec/grocer/feedback_connection_spec.rb
+- spec/grocer/feedback_spec.rb
+- spec/grocer/notification_spec.rb
+- spec/grocer/push_connection_spec.rb
+- spec/grocer/pusher_spec.rb
+- spec/grocer/ssl_connection_spec.rb
+- spec/grocer_spec.rb
+- spec/spec_helper.rb