rack-passbook 0.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    rack-passbook (0.0.1)
+      rack (~> 1.4)
+      sequel (~> 3.37.0)
+      sinatra (~> 1.3.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rack (1.4.1)
+    rack-protection (1.3.2)
+      rack
+    rake (0.9.6)
+    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)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-passbook!
+  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,126 @@
+![Passbook](http://cl.ly/JPjc/title_passbook.png)
+
+# Rack::Passbook
+
+> 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.
+
+[Passbook](http://www.apple.com/ios/whats-new/#passbook) is an iOS 6 feature that manages boarding passes, movie tickets, retail coupons, & loyalty cards. Using the [PassKit API](https://developer.apple.com/library/prerelease/ios/#documentation/UserExperience/Reference/PassKit_Framework/_index.html), developers can register web services to automatically update content on the pass, such as gate changes on a boarding pass, or adding credit to a loyalty card.
+
+Apple [provides a specification](https://developer.apple.com/library/prerelease/ios/#documentation/PassKit/Reference/PassKit_WebService/WebService.html) for a REST-style web service protocol to communicate with Passbook, with endpoints to get the latest version of a pass, register / unregister devices to receive push notifications for a pass, and query for passes registered for a device.
+
+This project is an example implementation of this web service specification in Rails, and will serve the basis for a more comprehensive Rails generator in the near future.
+
+> If you're just starting out Passbook development, you should definitely check out [this great two-part tutorial](http://www.raywenderlich.com/20734/beginning-passbook-part-1) by [Marin Todorov](http://www.raywenderlich.com/about#marintodorov) ([Part 1](http://www.raywenderlich.com/20734/beginning-passbook-part-1) [Part 2](http://www.raywenderlich.com/20785/beginning-passbook-in-ios-6-part-22)).
+
+## Requirements
+
+- Ruby 1.9
+- PostgreSQL 9.1 running locally ([Postgres.app](http://postgresapp.com) is the easiest way to get a Postgres server running on your Mac)
+
+## Example Usage
+
+Rack::Passbook 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
+
+run Rack::Passbook
+```
+
+An example application can be found in the `/example` directory of this repository.
+
+---
+
+## Specification
+
+What follows is a summary of the specification. The complete specification can be found in the [Passbook Web Service Reference](https://developer.apple.com/library/prerelease/ios/#documentation/PassKit/Reference/PassKit_WebService/WebService.html).
+
+### Getting the Latest Version of a Pass
+
+```
+GET http://example.com/v1/passes/:passTypeIdentifier/:serialNumber
+```
+
+- **passTypeIdentifier** The pass’s type, as specified in the pass.
+- **serialNumber** The unique pass identifier, as specified in the pass.
+
+**Response**
+
+- If request is authorized, return HTTP status 200 with a payload of the pass data.
+- If the request is not authorized, return HTTP status 401.
+- Otherwise, return the appropriate standard HTTP status.
+
+### Getting the Serial Numbers for Passes Associated with a Device
+
+```
+GET http://example.com/v1/devices/:deviceLibraryIdentifier/registrations/:passTypeIdentifier[?passesUpdatedSince=tag]
+```
+
+- **deviceLibraryIdentifier** A unique identifier that is used to identify and authenticate the device.
+- **passTypeIdentifier** The pass’s type, as specified in the pass.
+- **serialNumber** The unique pass identifier, as specified in the pass.
+- **passesUpdatedSince** _Optional_ A tag from a previous request. 
+
+**Response**
+
+If the `passesUpdatedSince` parameter is present, return only the passes that have been updated since the time indicated by tag. Otherwise, return all passes.
+
+- If there are matching passes, return HTTP status 200 with a JSON dictionary with the following keys and values:
+    - **lastUpdated** _(string)_ The current modification tag.
+    - **serialNumbers** _(array of strings)_ The serial numbers of the matching passes.
+- If there are no matching passes, return HTTP status 204.
+- Otherwise, return the appropriate standard HTTP status.
+
+### Registering a Device to Receive Push Notifications for a Pass
+
+```
+POST http://example.com/v1/devices/:deviceLibraryIdentifier/registrations/:passTypeIdentifier/:serialNumber
+```
+
+- **deviceLibraryIdentifier** A unique identifier that is used to identify and authenticate the device.
+- **passTypeIdentifier** The pass’s type, as specified in the pass.
+- **serialNumber** The unique pass identifier, as specified in the pass.
+
+The POST payload is a JSON dictionary, containing a single key and value:
+
+- **pushToken** The push token that the server can use to send push notifications to this device.
+
+**Response**
+
+- If the serial number is already registered for this device, return HTTP status 200.
+- If registration succeeds, return HTTP status 201.
+- If the request is not authorized, return HTTP status 401.
+- Otherwise, return the appropriate standard HTTP status.
+
+### Unregistering a Device
+
+```
+DELETE http://example.com/v1/devices/:deviceLibraryIdentifier/registrations/:passTypeIdentifier/:serialNumber
+```
+
+- **deviceLibraryIdentifier** A unique identifier that is used to identify and authenticate the device.
+- **passTypeIdentifier** The pass’s type, as specified in the pass.
+- **serialNumber** The unique pass identifier, as specified in the pass.
+
+**Response**
+
+- If disassociation succeeds, return HTTP status 200.
+- If the request is not authorized, return HTTP status 401.
+- Otherwise, return the appropriate standard HTTP status.
+
+---
+
+## Contact
+
+Mattt Thompson
+
+- http://github.com/mattt
+- http://twitter.com/mattt
+- m@mattt.me
+
+## License
+
+Rack::Passbook 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-passbook.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["rack-passbook.gemspec"] do
+  system "gem build rack-passbook.gemspec"
+end

data/lib/rack/passbook.rb

@@ -0,0 +1,102 @@
+require 'rack'
+require 'rack/contrib'
+
+require 'sinatra/base'
+require 'sinatra/param'
+
+require 'sequel'
+
+module Rack
+  class Passbook < Sinatra::Base
+    VERSION = '0.0.1'
+
+    use Rack::PostBodyContentTypeParser
+    helpers Sinatra::Param
+
+    Sequel.extension :core_extensions, :migration, :pg_hstore, :pg_hstore_ops
+
+    autoload :Pass,         ::File.join(::File.dirname(__FILE__), 'passbook/models/pass')
+    autoload :Registration, ::File.join(::File.dirname(__FILE__), 'passbook/models/registration')
+
+    disable :raise_errors, :show_exceptions
+
+    before do
+      content_type :json
+    end
+
+    # Get the latest version of a pass.
+    get '/passes/:pass_type_identifier/:serial_number/?' do
+      @pass = Pass.filter(pass_type_identifier: params[:pass_type_identifier], serial_number: params[:serial_number]).first
+      halt 404 if @pass.nil?
+      filter_authorization_for_pass!(@pass)
+  
+      last_modified @pass.updated_at.utc
+
+      @pass.to_json
+    end
+
+
+    # Get the serial numbers for passes associated with a device.
+    # This happens the first time a device communicates with our web service.
+    # Additionally, when a device gets a push notification, it asks our
+    # web service for the serial numbers of passes that have changed since
+    # a given update tag (timestamp).
+    get '/devices/:device_library_identifier/registrations/:pass_type_identifier/?' do
+      @passes = Pass.filter(pass_type_identifier: params[:pass_type_identifier]).join(Registration.dataset, device_library_identifier: params[:device_library_identifier])
+      halt 404 if @passes.empty?
+
+      @passes = @passes.filter('passes.updated_at > ?', params[:passesUpdatedSince]) if params[:passesUpdatedSince]
+
+      if @passes.any?
+        {
+          lastUpdated: @passes.collect(&:updated_at).max,
+          serialNumbers: @passes.collect(&:serial_number).collect(&:to_s)
+        }.to_json
+      else
+        halt 204
+      end
+    end
+
+
+    # Register a device to receive push notifications for a pass.
+    post '/devices/:device_library_identifier/registrations/:pass_type_identifier/:serial_number/?' do
+      @pass = Pass.where(pass_type_identifier: params[:pass_type_identifier], serial_number: params[:serial_number]).first
+      halt 404 if @pass.nil?
+      filter_authorization_for_pass!(@pass)
+
+      param :pushToken, String, required: true
+
+      @registration = @pass.registrations.detect{|registration| registration.device_library_identifier == params[:device_library_identifier]}
+      @registration ||= Registration.new(pass_id: @pass.id, device_library_identifier: params[:device_library_identifier])
+      @registration.push_token = params[:pushToken]
+
+      status = @registration.new? ? 201 : 200
+
+      @registration.save
+      p @registration
+      halt 406 unless @registration.valid?
+
+      halt status
+    end
+
+    # Unregister a device so it no longer receives push notifications for a pass.
+    delete '/devices/:device_library_identifier/registrations/:pass_type_identifier/:serial_number/?' do
+      @pass = Pass.filter(pass_type_identifier: params[:pass_type_identifier], serial_number: params[:serial_number]).first
+      halt 404 if @pass.nil?
+      filter_authorization_for_pass!(@pass)
+
+      @registration = @pass.registrations.detect{|registration| registration.device_library_identifier == params[:device_library_identifier]}
+      halt 404 if @registration.nil?
+
+      @registration.destroy
+
+      halt 200
+    end
+
+    private
+
+    def filter_authorization_for_pass!(pass)
+      halt 401 if request.env['HTTP_AUTHORIZATION'] != "ApplePass #{pass.authentication_token}"
+    end
+  end
+end

data/lib/rack/passbook/migrations/001_base_schema.rb

@@ -0,0 +1,36 @@
+Sequel.migration do
+  up do
+    run %{CREATE EXTENSION hstore;}
+
+    create_table :passbook_devices do
+      primary_key :id
+
+      column :pass_type_identifier, :varchar, unique: true, empty: false
+      column :serial_number,        :varchar, empty: false
+      column :authentication_token, :varchar
+      column :data,                 :hstore
+      column :created_at,           :timestamp
+      column :updated_at,           :timestamp
+
+      index :pass_type_identifier
+      index :serial_number
+    end
+
+    create_table :passbook_registrations do
+      primary_key :id
+
+      column :pass_id,                    :int8,    null: false
+      column :device_library_identifier,  :varchar, empty: false
+      column :push_token,                 :varchar
+      column :created_at,                 :timestamp
+      column :updated_at,                 :timestamp
+
+      index :device_library_identifier
+    end
+  end
+  
+  down do
+    drop_table :devices
+    drop_table :registrations
+  end
+end

data/lib/rack/passbook/models/pass.rb

@@ -0,0 +1,28 @@
+module Rack
+  class Passbook
+    DB = Sequel.connect(ENV['DATABASE_URL'] || "postgres://localhost:5432/passbook_example")
+    Sequel::Migrator.run(DB, ::File.join(::File.dirname(__FILE__), "../migrations"))
+
+    class Pass < Sequel::Model
+      plugin :json_serializer, naked: true, except: :id 
+      plugin :validation_helpers
+      plugin :timestamps, force: true, update_on_create: true
+      plugin :schema
+      plugin :typecast_on_load
+      
+      self.dataset = :passbook_devices
+      self.strict_param_setting = false
+      self.raise_on_save_failure = false
+
+      one_to_many :registrations, class_name: "Rack::Passbook::Registration"
+
+      def validate
+        super
+      
+        validates_presence [:pass_type_identifier, :serial_number]
+        validates_unique :pass_type_identifier
+        validates_unique [:serial_number, :pass_type_identifier]
+      end
+    end
+  end
+end

data/lib/rack/passbook/models/registration.rb

@@ -0,0 +1,33 @@
+module Rack
+  class Passbook
+    class Registration < Sequel::Model
+      plugin :json_serializer, naked: true, except: :id 
+      plugin :validation_helpers
+      plugin :timestamps, force: true, update_on_create: true
+      plugin :schema
+
+      self.dataset = :passbook_registrations
+      self.strict_param_setting = false
+      self.raise_on_save_failure = false
+
+      def before_validation
+        normalize_push_token! if self.push_token
+      end
+
+      def validate
+        super
+
+        validates_presence :device_library_identifier
+        validates_unique [:device_library_identifier, :pass_id]
+        validates_format /[[:xdigit:]]+/, :push_token
+        validates_exact_length 40, :push_token
+      end
+
+      private
+
+      def normalize_push_token!
+        self.push_token = self.push_token.strip.gsub(/[<\s>]/, '')
+      end
+    end
+  end
+end

data/rack-passbook.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/passbook"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-passbook"
+  s.authors     = ["Mattt Thompson"]
+  s.email       = "m@mattt.me"
+  s.homepage    = "http://mattt.me"
+  s.version     = Rack::Passbook::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Rack::Passbook"
+  s.description = "Automatically generate REST APIs for Passbook registration."
+
+  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 "sinatra", "~> 1.3.2"
+  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,140 @@
+--- !ruby/object:Gem::Specification
+name: rack-passbook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mattt Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-03 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: 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: 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: Automatically generate REST APIs for Passbook registration.
+email: m@mattt.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./Gemfile
+- ./Gemfile.lock
+- ./lib/rack/passbook/migrations/001_base_schema.rb
+- ./lib/rack/passbook/models/pass.rb
+- ./lib/rack/passbook/models/registration.rb
+- ./lib/rack/passbook.rb
+- ./LICENSE
+- ./rack-passbook.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: -4311652005948836172
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4311652005948836172
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack::Passbook
+test_files: []