pushlet 0.2.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+gemspec
+
+platform :jruby do
+  gem 'jruby-openssl'
+end
+
+group :test do
+  platform :mri do
+    gem 'simplecov', require: nil
+  end
+end

data/README.md

@@ -0,0 +1,187 @@
+Pushlet
+=======
+
+Pushlet is a simple, stateless HTTP API for interacting with Apple and Google's push services for mobile devices. It's goal is to simplify your push notifications by providing a simple SoA API that does this one thing, and does it well.
+
+Pushlet integrates [Grocer](http://github.com/highgroove/grocer) for APNS, and is designed to be thread safe.
+
+Because it is containerized and requires no data store, it can be easily put on a hosted service like AppFog or Heroku.
+
+## Requirements
+
+* Ruby 1.9, JRuby 1.7, Rubinius 2.0 or later.
+
+## Installation and Configuration
+
+First, install the gem via Rubygems:
+
+    gem install pushlet
+
+Then, setup a `config.ru` with the following. Setup an HTTP Auth so that you can control access (we provide a simple helper for you that returns JSON error messages, but you can use any Rack Middleware you like):
+
+    require 'pushlet'
+
+    map '/' do
+      Pushlet::API.http_basic_auth 'YOUR_USERNAME', 'YOUR_PASSWORD'
+      run Pushlet::API
+    end
+
+Pushlet is **thread optimized**, so use a threaded web server. I highly recommend using [Puma](http://puma.io), which is designed for threaded applications. You can add it by putting `gem 'puma'` in your Gemfile:
+
+    $ bundle exec puma
+    
+You can also use `rackup`:
+
+    $ bundle exec rackup -s puma
+
+If using Heroku, setup a `Procfile` to make it start with Puma by default:
+
+    web: bundle exec puma -p $PORT
+
+## Apple Push Notifications (APNS)
+
+Sending push notifications to apple is a two step process. First, you need to register the application via the `register_application` route:
+
+    $ curl http://127.0.0.1:9292/register_application -F "apns_p12=@/PATH/TO/YOUR/CERT.p12" -F "application_id=YOUR_APPLICATION_NAME"
+
+Now you can send push notifications via the `send_notification` route, and the socket connection for that application will handle them:
+
+    $ curl http://127.0.0.1:9292/send_notification -d "device_token=YOUR_DEVICE_TOKEN&alert=YOUR+TEXT+MESSAGE&application_id=YOUR_APPLICATION_NAME"
+
+## Google Cloud Messaging (GCM)
+
+Google does not require a stateful socket connection, because it uses HTTPS. It's simple enough to implement the protocol that this project doesn't add a lot of value for this, but we've included it for convenience.
+
+GCM does not have a concept of a "message" field. You are given a data input that can be JSON, and you need to program your application to send a message based on which column you send. For example, if your pre-defined field is `text`, encode with something like `Rack::Utils.escape({text: 'hello'}.to_json)`, and then send this way:
+
+    curl http://127.0.0.1:9292/send_notification -d "device_token=YOUR_GCM_DEVICE_KEY&gcm_api_key=YOUR_GCM_API_KEY&data=%7B%22text%22%3A%22hello%22%7D"
+
+## POST /application_feedback
+
+Returns the feedback information from Apple. Not required for GCM.
+
+### Arguments
+
+* application\_id - required
+
+### Example Response
+
+    {
+      "response": [
+        {
+          "device_token": "abcd",
+          "timestamp": "2012-11-27T22:24:07Z"
+        },
+        {
+          "device_token": "efgh",
+          "timestamp": "2012-11-27T22:24:07Z"
+        }
+      ]
+    }
+
+### Possible errors
+
+    {
+      "error": "missing_application_id",
+      "message": "an application_id is required for this call"
+    }
+
+    {
+      "error": "application_not_found", 
+      "message": "no application found for the provided application_id"
+    }
+
+## POST /register_application
+
+Registers the APNS application with a certificate. This will create a socket connection when the first message is sent, providing a persistent connection to the Apple push servers.
+
+* application_id - a unique identifier for this application. If none is provided, a UUID-based one will be generated and returned to you, and you will need to store it somewhere to use the connection.
+* apns\_p12 - Apple certificate in P12 format. Either this or apns\_pem are required.
+* apns\_pem - Apple certificate in PEM format. Either this or apns\_p12 are required.
+* apns_mode - toggles whether to use sandbox mode or not. If set to "development", the sandbox is used. Defaults to production.
+* apns\_p12\_pass - password for P12. Optional.
+
+### Example Response
+
+    {
+      "application_id": "id_you_supplied_or_uuid"
+    }
+
+### Possible errors
+
+    {
+      "error": "missing_apns_certificate",
+      "message": "an apns_p12 or apns_pem certificate is required for this call"
+    }
+
+    {
+      "error": "invalid_apns_p12",
+      "message": "could not process apns_p12 certificate, check that it is in p12 format and is valid"
+    }
+
+
+## POST /send_notification
+
+Sends a message to either the GCM REST service or the APNS application socket.
+
+* type - "apns" or "gcm". Required.
+* application\_id - application\_id provided for registered APNS application. Either this or gcm\_api\_key are required.
+* gcm\_api\_key - GCM secret key from Google. Either this or application_id are required.
+* device\_token - the device push token provided by the phone for your application. Required.
+* data - the generic data JSON payload to send to either APNS or GCM.
+
+APNS specific:
+
+* alert - the text to send as a popup message. Optional.
+* badge - the number to show on the menu icon. Optional.
+* sound - the application sound file to play on the phone. Optional.
+* identifier - 4-byte unique identifier for the message. Optional.
+
+### Example Response (APNS)
+
+    {
+      "response": "ok"
+    }
+
+### Example Response (GCM)
+
+    { "multicast_id": 108,
+      "success": 1,
+      "failure": 0,
+      "canonical_ids": 0,
+      "results": [
+        { "message_id": "1:08" }
+      ]
+    }
+
+### Possible errors
+
+    {
+      "error": "missing_identifier",
+      "message": "an application_id or gcm_api_key are required for this call"
+    }
+    
+    {
+      "error": "device_token_required",
+      "message": "device_token is required, which is registed with the application on your phone"
+    }
+    
+    {
+      "error": "application_not_found",
+      "message": "no application found for the provided application_id"
+    }
+    
+    {
+      "error": "invalid_data_json",
+      "message": "data could not be converted to json: ERROR_MESSAGE_FROM_JSON_PARSER"
+    }
+    
+    {
+      "error": "invalid_data_json",
+      "message": "data could not be converted to json: ERROR_MESSAGE_FROM_JSON_PARSER"
+    }
+    
+    {
+      "error": "invalid_gcm_credentials",
+      "message": "the provided credentials were rejected by google servers"
+    }

data/Rakefile

@@ -0,0 +1,10 @@
+require "rake/testtask"
+
+desc "Run all tests"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/SPEC-OLD.md

@@ -0,0 +1,238 @@
+# `POST /register_application`
+
+TODO: Update spec with updated parameter names.
+
+TODO: feedback_url not yet implemented.
+
+* app_id: Required. A unique identifier for this application.
+* feedback\_url: http://yoursite.com/notification_errors
+* mode: development or production. Only applies to apple.
+
+Provide either a P12 certificate or a Google GCM API Key
+
+* p12: The P12 certificate as a string
+* gcm\_api\_key: sefsdjfsdlkfj
+
+## Response
+
+```
+{
+  "application_id": "a9b20610187a0130d39614109feae54c"
+}
+```
+
+## Errors
+
+### /application_feedback
+
+```
+{
+  "error": "missing_identifier",
+  "message": "an application\_id or gcm\_api\_key are required for this call"
+}
+```
+
+```
+{
+  "error": "application\_not\_found", 
+  "message": "no application found for the provided application_id"
+}
+```
+
+```
+{
+  "error": "expired_certificate",
+  "message": "The certificate provided has expired. Please generate a new certificate."
+}
+```
+
+
+# `/send_notification?type=apns`
+
+TODO: Explain why the "device_token" parameter implemented but not the plural version.
+
+* device_tokens - array or string. Apple does not support multiple, so just loop for that case.x
+* alert         - "text message to send or see apple docs for other options"
+* badge         - example: 5
+* sound         - "soundfile.aiff"
+* identifier    - unique key for message. enforce as a 32 bit integer if grocer does not
+* data          - JSON to dump in the root with the aps payload.
+
+## Errors
+
+```
+{
+  "error": "invalid_input", 
+  "message": "badge must be an integer"
+}
+```
+
+```
+{
+  "error": "missing_application", 
+  "message": "The application could not be found. Register the application first using POST /register\_application"
+}
+```
+
+### APNS Error Codes
+
+TODO: Error responses are not sent back from the send_notification endpoint. Why not?
+
+* 1: processing error
+* 2: missing device token
+* 3: missing topic
+* 4: missing payload
+* 5: invalid token size
+* 6: invalid topic size
+* 7: invalid payload size
+* 8: invalid token
+* 255: unknown
+
+```
+{
+  "error": "missing_topic", 
+  "code": 3, 
+  "device_token": "b85a40425e91a68512259b40f480a2a645efd185106dc66a3e73f6c89e95c963", 
+  "identifier": "asdjfhd"
+}
+```
+
+## APNS Payload Examples (Internal use only)
+
+### Send text:
+```
+{
+  "aps": {
+    "alert": "hello"
+  }
+}
+```
+
+### Set number on badge:
+```
+{
+  "aps": {
+    "badge": 9
+  }
+}
+```
+
+### Sound (plays sound)
+```
+{
+  "aps": {
+    "sound": "ping.aiff"
+  }
+}
+```
+
+All three of these parameters can be combined. You can also send a push notification with custom data and leave out the standard "aps" keys.
+
+Other keys can be sent outside of the aps root. Example: 
+
+```
+{
+  "aps": {
+    "alert": "hello"
+  }, 
+  "hello": "kitty"
+}
+```
+
+
+# `/send_notification?type=gcm`
+
+* app_id OR gcm\_api\_key
+* device_tokens - json array or string (one device)
+* data - the notification payload
+* collapse\_key - if you send multiple pushes with the same collapse\_key, only the last will be delivered when the phone comes back online
+* delay\_while\_idle - this will send the message when the device comes back from idle. Default: false
+* time\_to\_live - number of seconds the message should be kept if the device is offline. Default: 4 weeks
+* dry\_run - default: false
+
+## Input/Format Errors
+
+```
+{
+  "error": "missing_input", 
+  "message": "data is required"
+}
+```
+
+```
+{
+  "error": "missing_input", 
+  "message": "device_tokens is required"
+}
+```
+
+```
+{
+  "error": "missing_input", 
+  "message": "app_id OR gcm_api_key is required"
+}
+```
+
+These errors will come from the GCM service
+
+`{"error": "message_too_big"}`
+
+`{"error": "invalid_data_key"}`
+
+`{"error": "invalid_ttl"}`
+
+## Error format for multiple responses
+
+If the input format is valid, the service will attempt to send the notification. The results of sending each notification will be returned in "results".
+
+```
+{
+  "results": [
+    {"device_token": "fsdsfegr", "error": "invalid_registration"},
+    {"device_token": "dsdfdgfg", "success": true}
+  ]
+}
+```
+
+## Other possbile errors from the GCM service
+
+* 401: "Invalid API Key"
+* MissingRegistration
+* InvalidRegistration
+* MismatchSenderId
+* NotRegistered
+* MessageTooBig
+* InvalidDataKey
+* InvalidTtl
+* InternalServerError
+
+{"type": "MissingRegistration", device_token: "sdfsdf"} <- maybe convert to undercase?
+
+## GCM Documentation
+
+* http://developer.android.com/guide/google/gcm/index.html
+* http://developer.android.com/guide/google/gcm/adv.html
+
+
+# `apns\_feedback`
+
+TODO: Update this explanation with a reason why this was implemented as a GET API 
+method instead of as described below.
+
+The Pushlet service will periodically check the APNS feedback service for errors. If any 
+errors are reported by Apple, Pushlet will deliver a POST to the registered `callback_url`
+for the application. 
+
+The feedback payload will contain the device token and the timestamp of the error.
+
+
+```
+{
+  "app_id": "14002",
+  "type": "feedback",
+  "device_token": "b85a40425e91a68512259b40f480a2a645efd185106dc66a3e73f6c89e95c963", 
+  "timestamp": 1352502272
+}
+```
+
+

data/lib/pushlet.rb

@@ -0,0 +1,20 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+require 'json'
+require 'sinatra'
+require 'escape'
+require 'openssl'
+require 'base64'
+require 'tempfile'
+require 'escape'
+require 'uuid'
+require 'running'
+require 'sinatra/jsonapi'
+require 'grocer'
+require 'httpclient'
+
+require 'pushlet/version'
+require 'pushlet/apns_gateway'
+require 'pushlet/gateway_pool'
+require 'pushlet/auth_middleware'
+require 'pushlet/api'

data/lib/pushlet/api.rb

@@ -0,0 +1,122 @@
+module Pushlet
+  class API < Sinatra::Base
+    register Sinatra::JSONAPI
+    set :show_exceptions, false
+
+    class << self
+      def gateway_pool
+        @gateway_pool ||= GatewayPool.new
+      end
+
+      def uuid
+        @uuid ||= UUID.new
+      end
+
+      def http_client
+        @http_client ||= HTTPClient.new
+      end
+
+      def http_basic_auth(user, pass)
+        use AuthMiddleware, user, pass
+      end
+    end
+
+    get '/application_feedback' do
+      if p[:application_id].nil?
+        api_error :missing_application_id, 'an application_id is required for this call'
+      end
+
+      app = self.class.gateway_pool.get p[:application_id]
+      api_error :application_not_found, 'no application found for the provided application_id' if app.nil?
+
+      api_response response: app.feedback.collect {|fda| {device_token: fda.device_token, timestamp: fda.timestamp.utc.iso8601}}
+    end
+
+    post '/register_application' do
+      id = p[:application_id] || self.class.uuid.generate(:compact)
+
+      if p[:apns_p12].nil? && p[:apns_pem].nil?
+        api_error :missing_apns_certificate, 'an apns_p12 or apns_pem certificate is required for this call'
+      end
+
+      api_error :apns_mode_required, 'specify apns_mode=production or apns_mode=development' unless ['production','development'].include? p[:apns_mode]
+
+      apns_p12 = p[:apns_p12].is_a?(Hash) ? p[:apns_p12][:tempfile].read : p[:apns_p12]
+      apns_pem = p[:apns_pem].is_a?(Hash) ? p[:apns_pem][:tempfile].read : p[:apns_pem]
+
+      begin
+        apns_gateway = APNSGateway.new({
+          mode:     p[:apns_mode],
+          p12:      apns_p12,
+          pem:      apns_pem,
+          p12_pass: p[:apns_p12_pass]
+        })
+      rescue OpenSSL::PKCS12::PKCS12Error
+        api_error :invalid_apns_p12, 'could not process apns_p12 file, check that it is in p12 format and is valid'
+      end
+
+      self.class.gateway_pool.add id, apns_gateway
+
+      api_response application_id: id
+    end
+
+    post '/send_notification' do
+      if p[:application_id].nil? && p[:gcm_api_key].nil?
+        api_error :missing_identifier, 'an application_id or gcm_api_key are required for this call'
+      end
+
+      if p[:device_token].nil? || p[:device_token].empty?
+        api_error :device_token_required, 'device_token is required, which is registed with the application on your phone'
+      end
+
+      if p[:application_id]
+        app = self.class.gateway_pool.get p[:application_id]
+        api_error :application_not_found, 'no application found for the provided application_id' if app.nil?
+
+        api_error :missing_payload, 'at least one of alert, badge, sound or data is required' if p[:alert].nil? && p[:badge].nil? && p[:sound].nil? && p[:data].nil?
+
+        app.push({
+            device_token: p[:device_token],
+            alert:        p[:alert],
+            badge:        p[:badge],
+            sound:        p[:sound],
+            identifier:   p[:identifier],
+            custom:       p[:data]
+        })
+
+        api_response response: 'ok'
+      else
+        api_error :gcm_api_key_required, 'must provide gcm_api_key' if p[:gcm_api_key].nil?
+
+        payload = {registration_ids: [p[:device_token]]}
+
+        [:collapse_key, :data, :delay_while_idle, :time_to_live, :restricted_package_name, :dry_run].each do |key|
+          if key == :data
+            begin
+              payload[key] = JSON.parse params[:data] if params[:data]
+            rescue JSON::ParserError => e
+              api_error :invalid_data_json, "data could not be converted to json: #{e.message}"
+            end
+          else
+            payload[key] = p[key] unless p[key].nil?
+          end
+        end
+
+        headers = {
+          'Content-Type'  => 'application/json',
+          'Authorization' => "key=#{p[:gcm_api_key]}"
+        }
+
+        resp = self.class.http_client.post 'https://android.googleapis.com/gcm/send', payload.to_json, headers
+
+        if resp.status == 401
+          api_error :invalid_gcm_credentials, 'the provided credentials were rejected by google servers'
+        else
+          api_response response: JSON.parse(resp.body)
+        end
+      end
+    end
+
+    def p; params end
+  end
+end

data/lib/pushlet/apns_gateway.rb

@@ -0,0 +1,101 @@
+require 'digest'
+require 'time'
+
+module Pushlet
+  class APNSGateway
+    def initialize(o={})
+      @mode = o[:mode]
+      @pass = o[:p12_pass]
+      @pem = o[:pem] || self.class.p12_to_pem_text(o[:p12], o[:p12_pass])
+      create_pusher
+    end
+
+    def feedback
+      feedback = Grocer.feedback(
+        certificate: StringIO.new(@pem),
+        passphrase:  @pass,
+        gateway:     (@mode == "development" ? gateway_sandbox : gateway_production),
+        port:        feedback_port,
+        retries:     retries
+      )
+
+      failed_delivery_attempts = []
+
+      feedback.each do |fda|
+        failed_delivery_attempts << fda
+      end
+
+      failed_delivery_attempts
+    end
+
+    def create_pusher
+      @pusher = Grocer.pusher(
+        certificate: StringIO.new(@pem),
+        passphrase:  @pass,
+        gateway:     (@mode == "development" ? gateway_sandbox : gateway_production),
+        port:        port,
+        retries:     retries
+      )
+    end
+
+    def gateway_sandbox;    'gateway.sandbox.push.apple.com' end
+    def gateway_production; 'gateway.push.apple.com' end
+    def port;               2195 end
+    def feedback_port;      2196 end
+    def retries;            3 end
+
+    def push(args={})
+      if args[:identifier]
+        identifier = args[:identifier]
+      else
+        # Seriously Apple, a 4 byte identifier? Really guys?
+        identifier = SecureRandom.random_bytes(4)
+      end
+
+      payload = {}
+      
+      [:device_token, :alert, :badge, :sound, :expiry, :identifier].each do |a|
+        if a == :expiry
+          payload[a] = args[a] || Time.now + 60*10
+        else
+          payload[a] = args[a] if args[a]
+        end
+      end
+
+      notification = Grocer::Notification.new payload
+
+      @pusher.push(notification)
+    end
+
+    def self.p12_to_pem_text(p12, p12_pass='')
+      p12_pass = '' if p12_pass.nil?
+
+      if Running.jruby?
+        tf_p12 = Tempfile.new 'tf_p12'
+        tf_p12.write p12
+        tf_p12.rewind
+        tf_p12.close
+
+        tf_pem = Tempfile.new 'tf_pem'
+        tf_pem.close
+
+        cmd = Escape.shell_command(['openssl', 'pkcs12', '-in', tf_p12.path, '-out', tf_pem.path,
+                                    '-nodes', '-clcerts', '-password', 'pass:'+p12_pass]).to_s + ' &> /dev/null'
+
+        begin
+          result = system cmd
+          raise CommandFailError if result.nil? || result == false
+          pem = File.read tf_pem.path
+        ensure
+          tf_pem.unlink
+          tf_p12.unlink
+        end
+
+        pem
+      else
+        pkcs12 = OpenSSL::PKCS12.new p12, p12_pass
+        pkcs12.certificate.to_s + pkcs12.key.to_s
+      end
+    end
+  end
+end

data/lib/pushlet/auth_middleware.rb

@@ -0,0 +1,29 @@
+module Pushlet  
+  class AuthMiddleware
+    def initialize(app, username, password)
+      @app = app
+      @username = username
+      @password = password
+    end
+
+    def call(env)
+      return error_json if env['HTTP_AUTHORIZATION'].nil? || env['HTTP_AUTHORIZATION'] == ''
+
+      begin
+          username, password = Base64.strict_decode64(env['HTTP_AUTHORIZATION'].split('Basic ').last).split(':')
+      rescue
+        return error_json
+      end
+
+      return error_json if username != @username || password != @password
+
+      @app.call env
+    end
+
+    def error_json(type='access denied', message='invalid credentials')
+      payload = {error: {type: type, message: message}}.to_json
+
+      [200, {'Content-Type' => 'application/json', 'Content-Length' => payload.length.to_s}, [payload]]
+    end
+  end
+end

data/lib/pushlet/gateway_pool.rb

@@ -0,0 +1,30 @@
+module Pushlet  
+  class GatewayPool
+    def initialize
+      @mutex = Mutex.new
+      @pool = {}
+    end
+
+    def get(id)
+      @pool[id.to_sym]
+    end
+
+    def add(id, gateway)
+      lock {
+        @pool[id.to_sym] = gateway
+      }
+    end
+
+    def remove(id)
+      lock {
+        @pool.delete id.to_sym
+      }
+    end
+
+    private
+
+    def lock(&block)
+      @mutex.synchronize { yield }
+    end
+  end
+end

data/lib/pushlet/version.rb

@@ -0,0 +1,8 @@
+module Pushlet
+  # The current version of the Pushlet ruby gem.
+  #
+  # @return [String]
+  def self.version
+    '0.2.0'
+  end
+end

data/pushlet.gemspec

@@ -0,0 +1,33 @@
+require './lib/pushlet/version.rb'
+Gem::Specification.new do |s|
+  s.name = 'pushlet'
+  s.version = Pushlet.version
+  s.authors = ['Kyle Drake', 'Aaron Parecki']
+  s.email = ['kyledrake@gmail.com', 'aaron@parecki.com']
+  s.homepage = 'http://github.com/geoloqi/pushlet'
+  s.summary = 'Powerful, simple, stateless, multi-threaded push notification service API for APNS and Google GCM'
+  s.description = 'Powerful, simple, stateless, multi-threaded push notification service API for APNS and Google GCM!'
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = %w[lib]
+  s.rubyforge_project = s.name
+  s.required_rubygems_version = '>= 1.3.4'
+
+  s.add_dependency 'json'
+  s.add_dependency 'httpclient'
+  s.add_dependency 'sinatra'
+  s.add_dependency 'sinatra-jsonapi'
+  s.add_dependency 'escape'
+  s.add_dependency 'running'
+  s.add_dependency 'httpclient'
+  s.add_dependency 'uuid'
+  s.add_dependency 'grocer'
+  s.add_dependency 'puma'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'mocha'
+end

data/test/env.rb

@@ -0,0 +1,21 @@
+ENV['RACK_ENV'] = 'test'
+require 'rubygems'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'rack/test'
+require 'webmock'
+require './lib/pushlet.rb'
+
+include WebMock::API
+include Rack::Test::Methods
+
+# For rack-test
+def app
+  @app ||= Sinatra.new Pushlet::API do
+    enable :raise_errors
+  end
+end
+
+def resp
+  JSON.parse last_response.body, symbolize_names: true
+end

data/test/files/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/test/files/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/test/files/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/test/gcm_push_test.rb

@@ -0,0 +1,32 @@
+require './test/env.rb'
+
+describe 'send gcm push' do
+  it 'fails without key' do
+    post '/send_notification'
+    resp[:error][:type].must_equal 'missing_identifier'
+  end
+
+  it 'fails without one or more device tokens' do
+    post '/send_notification', gcm_api_key: 'ABCD', data: {text: 'hello'}
+    resp[:error][:type].must_equal 'device_token_required'
+  end
+
+  it 'should fail gracefully for invalid key' do
+    
+  end
+
+  it 'works' do
+    
+    stub_request(:post, "https://android.googleapis.com/gcm/send").
+      with(:body => "{\"registration_ids\":[\"1234\"],\"data\":{\"text\":\"hello\"},\"collapse_key\":null,\"delay_while_idle\":null,\"time_to_live\":null,\"dry_run\":null}",
+           :headers => {'Authorization'=>'key=ABCD', 'Content-Type'=>'application/json'}).
+      to_return(:status => 200, :body => %{{"multicast_id":6782339717028231855,"success":0,"failure":1,"canonical_ids":0,"results":[{"error":"InvalidRegistration"}]}})
+    
+    post '/send_notification', gcm_api_key: 'ABCD', data: {text: 'hello'}, device_tokens: ['1234']
+    
+  
+
+  # binding.pry
+    
+  end
+end

data/test/register_application_test.rb

@@ -0,0 +1,51 @@
+require './test/env.rb'
+
+describe 'registering apns applications' do
+  it 'should fail without input' do
+    post '/register_application'
+    resp[:application_id].must_be_nil
+    resp[:error][:type].must_equal 'missing_apns_certificate'
+  end
+
+  it 'fails with bad cert' do
+    post '/register_application', apns_p12: File.read('./test/files/example.pem'), apns_mode: 'production'
+    resp[:application_id].must_be_nil
+    resp[:error][:type].must_equal 'invalid_apns_p12'
+  end
+
+  it 'works' do
+    post '/register_application', apns_p12: File.read('./test/files/example.p12'), apns_mode: 'production'
+    resp[:application_id].wont_be_nil
+  end
+
+  it 'works with provided id' do
+    post '/register_application', apns_p12: File.read('./test/files/example.p12'), application_id: 'specialapp', apns_mode: 'production'
+    resp[:application_id].must_equal 'specialapp'
+  end
+
+  it 'fails for passworded p12 with bad pass' do
+    post '/register_application', apns_p12: File.read('./test/files/example_with_pass.p12'), apns_p12_pass: 'fail', apns_mode: 'production'
+    resp[:application_id].must_be_nil
+    resp[:error][:type].must_equal 'invalid_apns_p12'
+  end
+
+  it 'works with pass' do
+    post '/register_application', apns_p12: File.read('./test/files/example_with_pass.p12'), apns_p12_pass: 'test', apns_mode: 'production'
+    resp[:application_id].wont_be_nil
+  end
+
+  it 'works with pem instead of p12' do
+    post '/register_application', apns_pem: File.read('./test/files/example.pem'), apns_mode: 'production'
+    resp[:application_id].wont_be_nil
+  end
+
+  it 'fails if no apns_mode provided' do
+    post '/register_application', apns_pem: File.read('./test/files/example.pem')
+    resp[:error][:type].must_equal 'apns_mode_required'
+  end
+
+  it 'fails on invalid apns_mode' do
+    post '/register_application', apns_pem: File.read('./test/files/example.pem'), apns_mode: 'whatever'
+    resp[:error][:type].must_equal 'apns_mode_required'
+  end
+end

metadata

@@ -0,0 +1,326 @@
+--- !ruby/object:Gem::Specification
+name: pushlet
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Kyle Drake
+- Aaron Parecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-jsonapi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: escape
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: running
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grocer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Powerful, simple, stateless, multi-threaded push notification service
+  API for APNS and Google GCM!
+email:
+- kyledrake@gmail.com
+- aaron@parecki.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- SPEC-OLD.md
+- lib/pushlet.rb
+- lib/pushlet/api.rb
+- lib/pushlet/apns_gateway.rb
+- lib/pushlet/auth_middleware.rb
+- lib/pushlet/gateway_pool.rb
+- lib/pushlet/version.rb
+- pushlet.gemspec
+- test/env.rb
+- test/files/example.cer
+- test/files/example.key
+- test/files/example.p12
+- test/files/example.pem
+- test/files/example_with_pass.p12
+- test/gcm_push_test.rb
+- test/register_application_test.rb
+homepage: http://github.com/geoloqi/pushlet
+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: 1.3.4
+requirements: []
+rubyforge_project: pushlet
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Powerful, simple, stateless, multi-threaded push notification service API
+  for APNS and Google GCM
+test_files: []
+has_rdoc: