rack-push-notification 0.0.1 → 0.1.0

data/Gemfile.lock

@@ -1,16 +1,46 @@
 PATH
   remote: .
   specs:
-    rack-push-notification (0.0.1)
+    rack-push-notification (0.1.0)
+      bootstrap-sass (~> 2.1.1)
+      coffee-script (~> 2.2.0)
+      eco (~> 1.0.0)
+      haml (~> 3.1.7)
+      houston (~> 0.1.1)
       rack (~> 1.4)
       rack-contrib (~> 1.1.0)
+      sass (~> 3.2.3)
       sequel (~> 3.37.0)
       sinatra (~> 1.3.2)
       sinatra-param (~> 0.1.1)
+      sprockets (~> 2.8.1)
+      sprockets-sass (~> 0.9.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    bootstrap-sass (2.1.1.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.4.0)
+    commander (4.1.2)
+      highline (~> 1.6.11)
+    eco (1.0.0)
+      coffee-script
+      eco-source
+      execjs
+    eco-source (1.1.0.rc.1)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    haml (3.1.7)
+    highline (1.6.15)
+    hike (1.2.1)
+    houston (0.1.1)
+      commander (~> 4.1.2)
+      json (~> 1.7.3)
+    json (1.7.5)
+    multi_json (1.3.7)
     rack (1.4.1)
     rack-contrib (1.1.0)
       rack (>= 0.9.1)
@@ -18,6 +48,7 @@ GEM
       rack
     rake (0.9.2.2)
     rspec (0.6.4)
+    sass (3.2.3)
     sequel (3.37.0)
     sinatra (1.3.3)
       rack (~> 1.3, >= 1.3.6)
@@ -25,6 +56,14 @@ GEM
       tilt (~> 1.3, >= 1.3.3)
     sinatra-param (0.1.1)
       sinatra (~> 1.3)
+    sprockets (2.8.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-sass (0.9.1)
+      sprockets (~> 2.0)
+      tilt (~> 1.1)
     tilt (1.3.3)
 
 PLATFORMS

data/README.md

@@ -1,10 +1,13 @@
 Rack::PushNotification
 ======================
-**An extensible, Rack-mountable webservice for managing push notification information**
+**A Rack-mountable webservice for managing push notifications**
 
-There is misconception that managing push notification information is a difficult problem. It's really not.
+> This is still in early stages of development, so proceed with caution when using this in a production application. Any bug reports, feature requests, or general feedback at this point would be greatly appreciated.
 
-This library is generates a `/devices` API endpoint, that can be used by iOS apps to register and unregister for push notifications.
+`Rack::PushNotification` generates API endpoints that can be consumed by iOS apps to register and unregister for push notifications. Along with the registration API, `Rack::PushNotification` spawns an admin console that gives you a convenient interface to manage device tokens and compose targeted push notification messages.
+
+![Devices Screenshot](https://raw.github.com/mattt/rack-push-notification/screenshots/rack-push-notifications-screenshot-devices.png)
+![Compose Screenshot](https://raw.github.com/mattt/rack-push-notification/screenshots/rack-push-notifications-screenshot-compose.png)
 
 ## Example Record
 
@@ -25,7 +28,7 @@ Each device has a `token`, which uniquely identifies the app installation on a p
 
 A device's `locale` & `language` can be used to localize outgoing communications to that particular user. Having `timezone` information gives you the ability to schedule messages for an exact time of day, to ensure maximum impact (and minimum annoyance). `ip_address` as well as `lat` and `lng` allows you to specifically target users according to their geographic location.
 
-> It is recommended that you use `Rack::PushNotification` in conjunction with some sort of Rack authentication middleware, so that the registration endpoints are not accessible without some form of credentials.
+**It is strongly recommended that you use `Rack::PushNotification` in conjunction with some sort of Rack authentication middleware, so that the registration endpoints are not accessible without some form of credentials.**
 
 ## Example Usage
 
@@ -37,8 +40,12 @@ Rack::PushNotification can be run as Rack middleware or as a single web applicat
 require 'bundler'
 Bundler.require
 
-DB = Sequel.connect(ENV['DATABASE_URL'])
+Rack::PushNotification::Admin.use Rack::Auth::Basic do |username, password|
+  [username, password] == ['admin', ENV['ADMIN_CONSOLE_PASSWORD'] || ""]
+end
 
+use Rack::PushNotification::Admin, certificate: "/path/to/apn_certificate.pem",
+                                   environment: :production
 run Rack::PushNotification
 ```
 
@@ -64,6 +71,16 @@ didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
 }
 ```
 
+## Deployment
+
+`Rack::PushNotification` can be deployed to Heroku with the following commands:
+
+```
+$ heroku create
+$ heroku credentials:add ADMIN_CONSOLE_PASSWORD="YourPa55wordG0esH3r3"
+$ git push heroku master
+```
+
 ## Contact
 
 Mattt Thompson

data/lib/rack/push-notification.rb

@@ -6,129 +6,51 @@ require 'sinatra/param'
 
 require 'sequel'
 
-require 'rack/push-notification/version'
-
-Sequel.extension(:pg_array)
-
-module Rack::PushNotification
-end
+Sequel.extension(:pg_array, :migration)
 
 module Rack
-  def self.PushNotification(options = {})
-    klass = Rack::PushNotification.const_set("Device", Class.new(Sequel::Model))
-    klass.dataset = :devices
-
-    klass.class_eval do
-      self.strict_param_setting = false
-      self.raise_on_save_failure = false
+  class PushNotification < Sinatra::Base
+    VERSION = '0.1.0'
 
-      plugin :json_serializer, naked: true, except: :id 
-      plugin :validation_helpers
-      plugin :timestamps, force: true
-      plugin :schema
+    use Rack::PostBodyContentTypeParser
+    helpers Sinatra::Param
 
-      set_schema do
-        primary_key :id
-
-        column :token,      :varchar,       null: false, unique: true
-        column :alias,      :varchar 
-        column :badge,      :int4,          null: false, default: 0
-        column :locale,     :varchar
-        column :language,   :varchar
-        column :timezone,   :varchar,       null: false, default: 'UTC'
-        column :ip_address, :inet
-        column :lat,        :float8
-        column :lng,        :float8
-        column :tags,       :'text[]'
-
-        index :token
-        index :alias
-        index [:lat, :lng]
-      end
+    disable :raise_errors, :show_exceptions
 
-      create_table unless table_exists?
-
-      def before_validation
-        normalize_token!
-      end
-
-      private
-
-      def normalize_token!
-        self.token = self.token.strip.gsub(/[<\s>]/, '')
-      end
+    before do
+      content_type :json
     end
 
-    app = Class.new(Sinatra::Base) do
-      use Rack::PostBodyContentTypeParser
-      helpers Sinatra::Param
+    put '/devices/:token/?' do
+      param :languages, Array
+      param :tags, Array
 
-      disable :raise_errors, :show_exceptions
+      @record = Device.find(token: params[:token]) || Device.new
+      @record.set(params)
 
-      before do
-        content_type :json
-      end
+      code = @record.new? ? 201 : 200
 
-      get '/devices/?' do
-        param :languages, Array
-        param :tags, Array
-
-        @devices = klass.dataset
-        [:alias, :badge, :locale, :languages, :timezone, :tags].each do |attribute|
-          @devices = @devices.filter(attribute => params[attribute]) if params[attribute]
-        end
-        
-        @devices.to_json
-      end
-
-      put '/devices/:token/?' do
-        param :languages, Array
-        param :tags, Array
-
-        @record = klass.new(params)
-        @record.tags = nil
-        if @record.save
-          status 201
-          @record.to_json
-        else
-          status 406
-          {errors: @record.errors}.to_json
-        end
-      end
-
-      get '/devices/:token/?' do
-        @record = klass.find(token: params[:token])
-        if @record
-          @record.to_json
-        else
-          status 404
-        end
-      end
-
-      delete '/devices/:token/?' do
-        @record = klass.find(token: params[:token]) or halt 404
-        if @record.destroy
-          status 200
-        else
-          status 406
-          {errors: record.errors}.to_json
-        end
+      if @record.save
+        status code
+        @record.to_json
+      else
+        status 406
+        {errors: @record.errors}.to_json
       end
     end
 
-    return app
-  end
-
-  module PushNotification
-    class << self
-      def new(options = {})
-        @app ||= ::Rack::PushNotification()
-      end
+    delete '/devices/:token/?' do
+      @record = Device.find(token: params[:token]) or halt 404
 
-      def call(*args)
-        @app ||= ::Rack::PushNotification()
-        @app.call(*args)
+      if @record.destroy
+        status 200
+      else
+        status 406
+        {errors: record.errors}.to_json
       end
     end
   end
 end
+
+require 'rack/push-notification/device'
+require 'rack/push-notification/admin'

data/lib/rack/push-notification/admin.rb

@@ -0,0 +1,129 @@
+require 'coffee-script'
+require 'eco'
+require 'sass'
+require 'compass'
+require 'bootstrap-sass'
+require 'sprockets'
+require 'sprockets-sass'
+require 'houston'
+
+module Rack
+  class PushNotification::Admin < Sinatra::Base
+    use Rack::Static, urls: ['/images'], root: ::File.join(root, "assets")
+    use Rack::PostBodyContentTypeParser
+
+    helpers Sinatra::Param
+
+    set :root, ::File.dirname(__FILE__)
+    set :views, Proc.new { ::File.join(root, "assets/views") }
+    
+    set :assets, Sprockets::Environment.new(::File.join(settings.root, "assets"))
+    settings.assets.append_path "javascripts"
+    settings.assets.append_path "stylesheets"
+
+    def initialize(app = nil, options = {})
+      super(app)
+
+      self.class.set :apn_certificate, options.delete(:certificate)
+      self.class.set :apn_environment, options.delete(:environment)
+    end
+
+    before do
+      content_type :json
+    end
+
+    get '/devices/?' do
+      param :q, String
+      param :offset, Integer, default: 0
+      param :limit, Integer, max: 100, min: 1, default: 25
+
+      @devices = ::Rack::PushNotification::Device.dataset
+      @devices = @devices.filter("tsv @@ to_tsquery('english', ?)", "#{params[:q]}:*") if params[:q] and not params[:q].empty?
+      
+      {
+        devices: @devices.limit(params[:limit], params[:offset]),
+        total: @devices.count
+      }.to_json
+    end
+
+    get '/devices/:token/?' do
+      @record = ::Rack::PushNotification::Device.find(token: params[:token])
+
+      if @record
+        @record.to_json
+      else
+        status 404
+      end
+    end
+
+    head '/message' do
+      status 503 and return unless client
+
+      status 204
+    end
+
+    post '/message' do
+      status 503 and return unless client
+
+      param :payload, String, empty: false
+      param :tokens, Array, empty: false
+
+      tokens = params[:tokens] || ::Rack::PushNotification::Device.all.collect(&:token)
+
+      options = JSON.parse(params[:payload])
+      options[:alert] = options["aps"]["alert"]
+      options[:badge] = options["aps"]["badge"]
+      options[:sound] = options["aps"]["sound"]
+      options.delete("aps")
+
+      begin
+        notifications = tokens.collect{|token| Houston::Notification.new(options.update({device: token}))}
+        client.push(*notifications)
+
+        status 204
+      rescue => error
+        status 500
+
+        {error: error}.to_json
+      end
+    end
+
+    get "/javascripts/:file.js" do
+      content_type "application/javascript"
+
+      settings.assets["#{params[:file]}.js"]
+    end
+
+    get "/stylesheets/:file.css" do
+      content_type "text/css"
+
+      settings.assets["#{params[:file]}.css"]
+    end
+
+    get '*' do
+      content_type :html
+
+      haml :index
+    end
+
+    private
+
+    def client
+      begin
+        return nil unless settings.apn_certificate and ::File.exist?(settings.apn_certificate)
+        
+        client = case settings.apn_environment.to_sym
+                  when :development 
+                    Houston::Client.development
+                  when :production
+                    Houston::Client.production
+                  end
+        client.certificate = ::File.read(settings.apn_certificate)
+        
+        return client
+      rescue
+        return nil
+      end
+    end
+  end
+end

data/lib/rack/push-notification/assets/javascripts/application.coffee

@@ -0,0 +1,28 @@
+#= require ./vendor/date
+#= require ./vendor/jquery
+#= require ./vendor/underscore
+#= require ./vendor/backbone
+#= require ./vendor/backbone.paginator
+#= require ./vendor/codemirror
+#= require ./vendor/codemirror.javascript
+
+#= require ./rpn
+#= require_tree ./models
+#= require_tree ./collections
+#= require_tree ./templates
+#= require_tree ./views
+#= require_tree ./routers
+
+$ ->
+  $('a').live 'click', (event) ->
+    href = $(this).attr('href')
+    event.preventDefault()
+    window.app.navigate(href, {trigger: true})
+
+  $('.iphone .slider input').live 'change', (event) ->
+    $(this).siblings("span").css(opacity: (100 - $(this).val()) / 100.0)
+  $('.alert button.close').live 'click', (event) ->
+    $(this).parents(".alert").remove()
+
+  RPN.devices = new RPN.Collections.Devices
+  RPN.devices.fetch(success: RPN.initialize)

data/lib/rack/push-notification/assets/javascripts/collections/devices.coffee

@@ -0,0 +1,28 @@
+class RPN.Collections.Devices extends Backbone.Paginator.requestPager
+  model: RPN.Models.Device
+
+  paginator_core:
+    type: 'GET'
+    dataType: 'json'
+    url: '/devices?'
+
+  paginator_ui:
+    firstPage: 1,
+    currentPage: 1,
+    perPage: 20
+
+  server_api:
+    'q': -> 
+      @query || ""
+    'limit': ->
+      @perPage
+    'offset': ->
+      (@currentPage - 1) * @perPage
+
+  parse: (response) ->
+    @total = response.total
+    @totalPages = Math.ceil(@total / @perPage)
+    response.devices
+
+  comparator: (database) ->
+    database.get('token')