rack-push-notification 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    rack-push-notification (0.0.1)
+      rack (~> 1.4)
+      rack-contrib (~> 1.1.0)
+      sequel (~> 3.37.0)
+      sinatra (~> 1.3.2)
+      sinatra-param (~> 0.1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rack (1.4.1)
+    rack-contrib (1.1.0)
+      rack (>= 0.9.1)
+    rack-protection (1.2.0)
+      rack
+    rake (0.9.2.2)
+    rspec (0.6.4)
+    sequel (3.37.0)
+    sinatra (1.3.3)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    sinatra-param (0.1.1)
+      sinatra (~> 1.3)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-push-notification!
+  rake (~> 0.9.2)
+  rspec (~> 0.6.1)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Mattt Thompson (http://mattt.me/)
+
+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,77 @@
+Rack::PushNotification
+======================
+**An extensible, Rack-mountable webservice for managing push notification information**
+
+There is misconception that managing push notification information is a difficult problem. It's really not.
+
+This library is generates a `/devices` API endpoint, that can be used by iOS apps to register and unregister for push notifications.
+
+## Example Record
+
+<table>
+  <tr><td><tt>token</tt></td><td>"ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969"</td></tr>
+  <tr><td><tt>alias</tt></td><td>mattt@heroku.com</td></tr>
+  <tr><td><tt>badge</tt></td><td>0</td></tr>
+  <tr><td><tt>locale</tt></td><td>en_US</td></tr>
+  <tr><td><tt>language</tt></td><td>en</td></tr>
+  <tr><td><tt>timezone</tt></td><td>America/Los_Angeles</td></tr>
+  <tr><td><tt>ip_address</tt></td><td>0.0.0.0</td></tr>
+  <tr><td><tt>lat</tt></td><td>37.7716</td></tr>
+  <tr><td><tt>lng</tt></td><td>-122.4137</td></tr>
+  <tr><td><tt>tags</tt></td><td><tt>["iPhone OS 6.0", "v1.0", "iPhone"]</tt></td></tr>
+</table>
+
+Each device has a `token`, which uniquely identifies the app installation on a particular device. This token can be associated with an `alias`, which can be a domain-specific piece of identifying information, such as a username or e-mail address. A running `badge` count is used to keep track of the badge count to show on the app icon.
+
+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.
+
+## Example Usage
+
+Rack::PushNotification can be run as Rack middleware or as a single web application. All that is required is a connection to a Postgres database.
+
+### config.ru
+
+```ruby
+require 'bundler'
+Bundler.require
+
+DB = Sequel.connect(ENV['DATABASE_URL'])
+
+run Rack::PushNotification
+```
+
+An example application can be found in the `/example` directory of this repository.
+
+## iOS Client Library
+
+To get the full benefit of `Rack::PushNotification`, use the [Orbiter](https://github.com/mattt/Orbiter) library to register for Push Notifications on iOS.
+
+```objective-c
+#import "Orbiter.h"
+
+- (void)application:(UIApplication *)application
+didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
+{
+    NSURL *serverURL = [NSURL URLWithString:@"http://raging-notification-3556.herokuapp.com/"]
+    Orbiter *orbiter = [[Orbiter alloc] initWithBaseURL:serverURL credential:nil];
+    [orbiter registerDeviceToken:deviceToken withAlias:nil success:^(id responseObject) {
+        NSLog(@"Registration Success: %@", responseObject);
+    } failure:^(NSError *error) {
+        NSLog(@"Registration Error: %@", error);
+    }];
+}
+```
+
+## Contact
+
+Mattt Thompson
+
+- http://github.com/mattt
+- http://twitter.com/mattt
+- m@mattt.me
+
+## License
+
+Rack::PushNotification is available under the MIT license. See the LICENSE file for more info.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler"
+Bundler.setup
+
+gemspec = eval(File.read("rack-push-notification.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["rack-push-notification.gemspec"] do
+  system "gem build rack-push-notification.gemspec"
+end

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

@@ -0,0 +1,5 @@
+module Rack
+  module PushNotification
+    VERSION = '0.0.1'
+  end
+end

data/lib/rack/push-notification.rb

@@ -0,0 +1,134 @@
+require 'rack'
+require 'rack/contrib'
+
+require 'sinatra/base'
+require 'sinatra/param'
+
+require 'sequel'
+
+require 'rack/push-notification/version'
+
+Sequel.extension(:pg_array)
+
+module Rack::PushNotification
+end
+
+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
+
+      plugin :json_serializer, naked: true, except: :id 
+      plugin :validation_helpers
+      plugin :timestamps, force: true
+      plugin :schema
+
+      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
+
+      create_table unless table_exists?
+
+      def before_validation
+        normalize_token!
+      end
+
+      private
+
+      def normalize_token!
+        self.token = self.token.strip.gsub(/[<\s>]/, '')
+      end
+    end
+
+    app = Class.new(Sinatra::Base) do
+      use Rack::PostBodyContentTypeParser
+      helpers Sinatra::Param
+
+      disable :raise_errors, :show_exceptions
+
+      before do
+        content_type :json
+      end
+
+      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
+      end
+    end
+
+    return app
+  end
+
+  module PushNotification
+    class << self
+      def new(options = {})
+        @app ||= ::Rack::PushNotification()
+      end
+
+      def call(*args)
+        @app ||= ::Rack::PushNotification()
+        @app.call(*args)
+      end
+    end
+  end
+end

data/rack-push-notification.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/push-notification"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-push-notification"
+  s.authors     = ["Mattt Thompson"]
+  s.email       = "m@mattt.me"
+  s.homepage    = "http://mattt.me"
+  s.version     = Rack::PushNotification::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Rack::PushNotification"
+  s.description = "Generate a REST API for registering and querying push notification device tokens."
+  s.add_development_dependency "rspec", "~> 0.6.1"
+  s.add_development_dependency "rake",  "~> 0.9.2"
+
+  s.add_dependency "rack", "~> 1.4"
+  s.add_dependency "rack-contrib", "~> 1.1.0"
+  s.add_dependency "sinatra", "~> 1.3.2"
+  s.add_dependency "sinatra-param", "~> 0.1.1"
+  s.add_dependency "sequel", "~> 3.37.0"
+
+  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|example|log|pkg|script|spec|test|vendor)/ }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: rack-push-notification
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mattt Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rack-contrib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: sinatra-param
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.37.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.37.0
+description: Generate a REST API for registering and querying push notification device
+  tokens.
+email: m@mattt.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./Gemfile
+- ./Gemfile.lock
+- ./lib/rack/push-notification/version.rb
+- ./lib/rack/push-notification.rb
+- ./LICENSE
+- ./rack-push-notification.gemspec
+- ./Rakefile
+- ./README.md
+homepage: http://mattt.me
+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'
+      segments:
+      - 0
+      hash: 1277678436408848925
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1277678436408848925
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack::PushNotification
+test_files: []