passbook 0.2.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - ruby-head

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in passbook.gemspec
+gem 'rubyzip'
+gem 'grocer'
+
+group :test, :development do
+  gem 'rack-test'
+  gem 'activesupport'
+  gem 'jeweler'
+  gem 'simplecov'
+  gem 'rspec'
+  gem 'rake' 
+  gem 'yard'
+end

data/Gemfile.lock

@@ -0,0 +1,53 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    grocer (0.3.0)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    json (1.7.5-java)
+    multi_json (1.3.6)
+    rack (1.4.1)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    rubyzip (0.9.9)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    yard (0.8.3)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  activesupport
+  grocer
+  jeweler
+  rack-test
+  rake
+  rspec
+  rubyzip
+  simplecov
+  yard

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Thomas Lauro
+
+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,237 @@
+[![Build Status](https://travis-ci.org/lgleasain/passbook.png)](https://travis-ci.org/lgleasain/passbook)
+
+# passbook-ios
+
+The passbook-ios gem let's you create a pkpass for passbook in iOS 6+
+
+## Installation
+
+Include the passbook-ios gem in your project.
+
+IE:  In your Gemfile 
+```
+gem 'passbook-ios'
+```
+
+## Configuration
+
+Create initializer
+```
+    rails g passbook:config
+    or with params
+    rails g passbook:config [Absolute path to the wwdc cert file] [Absolute path to your cert.p12 file] [Password for your certificate]
+```
+
+Configure your config/initializers/passbook.rb 
+```
+    Passbook.configure do |passbook|
+      passbook.wwdc_cert = Rails.root.join('wwdc_cert.pem')
+      passbook.p12_cert = Rails.root.join('cert.p12')
+      passbook.p12_password = 'cert password'
+    end
+```
+
+If you are running this on a different machine from what you used to create your WWDC keys
+```
+    Passbook.configure do |passbook|
+      passbook.wwdc_cert = Rails.root.join('wwdc_cert.pem')
+      passbook.p12_key = Rails.root.join('key.pem')
+      passbook.p12_certificate = Rails.root.join('certificate.pem')
+      passbook.p12_password = 'cert password'
+    end
+```
+If you are using Sinatra you can place this in the file you are executing or in a file that you do a require on.  You would also not reference Rails.root when specifying your file path.
+
+If You are doing push notifications then you will need to add some extra configuration options,  namely a push notification certificate and a notification gateway certificate.  Look at the Grocer gem documentation to find information on how to create this certificate.  Settings you will want ot use for the notification gateway are either 'gateway.push.apple.com' for production,  'gateway.sandbox.push.apple.com' for developmetn and 'localhost' for unit tests.
+```
+    Passbook.configure do |passbook|     
+      .....other settings.....
+      passbook.notification_gateway = 'gateway.push.apple.com'
+      passbook.notification_cert = 'lib/assets/my_notification_cert.pem'
+    end
+```
+
+If you want to also support the push notification endpoints you will also need to include the Rack::PassbookRack middleware.  In rails your config will look something like this.
+```
+  config.middleware.use Rack::PassbookRack
+```
+
+## Usage
+
+Please refer to apple iOS dev center for how to build cert and json.  [This article is also helpful.](http://www.raywenderlich.com/20734/beginning-passbook-part-1#more-20734)
+```
+    pass = Passbook::PKPass.new 'your json data'
+
+    # Add file from disk
+    pass.addFile 'file_path'
+
+    # Add file from memory
+    file[:name] = 'file name'
+    file[:content] = 'whatever you want'
+    pass.addFile file
+
+    # Add multiple files
+    pass.addFiles [file_path_1, file_path_2, file_path_3]
+
+    # Add multiple files from memory
+    pass.addFiles [{name: 'file1', content: 'content1'}, {name: 'file2', content: 'content2'}, {name: 'file3', content: 'content3'}]
+
+    # Output a Tempfile
+
+    pkpass = pass.file
+    send_file pkpass.path, type: 'application/vnd.apple.pkpass', disposition: 'attachment', filename: "pass.pkpass"
+
+    # Or a stream
+
+    pkpass = pass.stream
+    send_data pkpass.string, type: 'application/vnd.apple.pkpass', disposition: 'attachment', filename: "pass.pkpass"
+
+```
+If you are using Sinatra you will need to include the 'active_support' gem and will need to require 'active_support/json/encoding'.  Here is an example using the streaming mechanism.
+
+```
+require 'sinatra'
+require 'passbook'
+require 'active_support/json/encoding'
+
+Passbook.configure do |passbook|
+  passbook.p12_password = '12345'
+  passbook.p12_key = 'passkey.pem'
+  passbook.p12_certificate = 'passcertificate.pem'
+  passbook.wwdc_cert = 'WWDR.pem'
+end
+
+get '/passbook' do
+  pass = # valid passbook json.  refer to the wwdc documentation.
+  passbook = Passbook::PKPass.new pass
+  passbook.addFiles ['logo.png', 'logo@2x.png', 'icon.png', 'icon@2x.png']
+  response['Content-Type'] = 'application/vnd.apple.pkpass'
+  attachment 'mypass.pkpass'
+  passbook.stream.string
+end
+```
+
+We will try to make this cleaner in subsequent releases.
+
+### Passbook
+
+If you want to support passbook push notification updates you will need to congigure the appropriate bits above.  
+
+In order to support push notifications you will need to have a basic understanding of the way that push notifications work and how the data is passed back and forth.  See [this](http://developer.apple.com/library/ios/#Documentation/UserExperience/Conceptual/PassKit_PG/Chapters/Creating.html) for basic information about passes and [this](http://developer.apple.com/library/ios/#Documentation/UserExperience/Conceptual/PassKit_PG/Chapters/Updating.html#//apple_ref/doc/uid/TP40012195-CH5-SW1) to understand the information that needs to be exchanged between each device and your application to support the update service.
+
+Your pass will need to have a field called 'webServiceURL' with the base url to your site and a field called 'authenticationToken'.  The json snippet should look like this.  Note that your url needs to be a valid signed https endpoint for production.  You can put your phone in dev mode to test updates against a insecure http endpoint (under settings => developer => passkit testing).
+
+```
+...
+  "webserviceURL" : "https://www.honeybadgers.com/",
+  "authenticationToken" : "yummycobras"
+...  
+```
+
+Passbook-ios includes rack middleware to make the job of supporting the passbook endpoints easier.  You will need to configure the middleware as outlined above and then implement a class called Passbook::PassbookNotification.  Below is an annotated implementation.
+
+```
+module Passbook
+  class PassbookNotification
+
+    # This is called whenever a new pass is saved to a users passbook or the
+    # notifications are re-enabled.  You will want to persist these values to
+    # allow for updates on subsequent calls in the call chain.  You can have 
+    # multiple push tokens and serial numbers for a specific 
+    # deviceLibraryIdentifier.
+
+    def self.register_pass(options)
+      the_passes_serial_number = options['serialNumber']
+      the_devices_device_library_identifier = options['deviceLibraryIdentifier']
+      the_devices_push_token = options['pushToken']
+      
+      # this is if the pass registered successfully
+      # change the code to 200 if the pass has already been registered
+      # or another appropriate code if something went wrong.
+      {:status => 201}
+    end
+
+    # This is called when the device receives a push notification from apple.
+    # You will need to return the serial number of all passes associated with 
+    # that deviceLibraryIdentifier.
+ 
+    def self.passes_for_device(options)
+      device_library_identifier = options['deviceLibraryIdentifier']
+      
+      # the 'lastUpdated' uses integers values to tell passbook if the pass is
+      # more recent than the current one.  If you just set it is the same value 
+      # every time the pass will update and you will get a warning in the log files.
+      # you can use the time in milliseconds,  a counter or any other numbering scheme.
+      # you then also need to return an array of serial numbers.
+      {'lastUpdated' => '1', 'serialNumbers' => ['various', 'serial', 'numbers']}
+    end
+
+    # this is called when a pass is deleted or the user selects the option to disable pass updates.
+    def self.unregister_pass(options)
+      # a solid unique pair of identifiers to identify the pass are
+      serial_number = options['serialNumber']
+      device_library_identifier = options['deviceLibraryIdentifier']
+      # return a status 200 to indicate that the pass was successfully unregistered.
+      {:status => 200}
+    end
+
+    # this returns your updated pass
+    def self.latest_pass(options)
+      the_pass_serial_number = options['serialNumber']
+      # create your PkPass the way you did when your first created the pass.  
+      # you will want to return 
+      my_pass = PkPass.new 'your pass json'
+      # you will want to return the string from the stream of your PkPass object. 
+      mypass.stream.string
+    end
+
+    # This is called whenever there is something from the update process that is a warning
+    # or error
+    def self.log(log)
+      # this is a VERY crude logging example.  use the logger of your choice here.
+      p "#{Time.now} #{log}"
+    end
+
+  end
+end
+ 
+```
+
+To send a push notification for a updated pass simply call Passbook::PassbookPushNotification.send_notifications_for_promotion with the push token for the pass you are updating
+
+```
+  Passbook::PassbookPushNotification.send_notifications_for_promotion the_pass_push_token
+  
+```
+
+Apple will send out a notification to your phone (usually within 15 minutes or less),  which will cause the phone that this push notification is associated with to make a call to your server to get pass serial numbers and to then get the updated pass.  Each phone/pass combination has it's own push token whch will require a separate call for every phone that has push notifications enabled for a pass (this is an Apple thing).  In the future we may look into offering background process support for this as part of this gem.  For now,  if you have a lot of passes to update you will need to do this yourself.
+
+## Tests
+
+  To launch tests : 
+```
+  bundle exec rspec spec/lib/passbook/pkpass_spec.rb
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Changelog
+
+### 0.0.4
+Allow passbook gem to return a ZipOutputStream (needed when garbage collector delete tempfile before beeing able to use it) [Thx to applidget]
+
+### 0.2.0
+Adding support for push notification updates for passes.
+
+License
+-------
+
+passbook-ios is released under the MIT license:
+
+* http://www.opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "passbook"
+  gem.homepage = "http://github.com/frozon/passbook"
+  gem.license = "MIT"
+  gem.summary = %Q{A IOS Passbook generator.}
+  gem.description = %Q{This gem allows you to create IOS Passbooks.  Unlike some,  this works with Rails but does not require it.}
+  gem.email = ['thomas@lauro.fr', 'lgleason@polyglotprogramminginc.com']
+  gem.authors = ['Thomas Lauro', 'Lance Gleason']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/passbook/pkpass.rb

@@ -0,0 +1,142 @@
+require 'digest/sha1'
+require 'openssl'
+require 'zip/zip'
+require 'base64'
+
+module Passbook
+  class PKPass
+    attr_accessor :pass, :manifest_files
+
+    def initialize pass
+      @pass      = pass
+      @manifest_files     = []
+    end
+
+    def addFile file
+      @manifest_files << file
+    end
+
+    def addFiles files
+      @manifest_files += files
+    end
+
+    # for backwards compatibility
+    def json= json
+      @pass = json
+    end
+
+    def build
+      manifest = createManifest
+
+      # Check pass for necessary files and fields
+      checkPass manifest
+
+      # Create pass signature
+      signature = createSignature manifest
+
+      return [manifest, signature]
+    end
+
+    # Backward compatibility
+    def create
+      self.file.path
+    end
+
+    # Return a Tempfile containing our ZipStream
+    def file(options = {})
+      options[:file_name] ||= 'pass.pkpass'
+
+      temp_file = Tempfile.new(options[:file_name])
+      temp_file.write self.stream.string
+      temp_file.close
+
+      temp_file
+    end
+
+    # Return a ZipOutputStream
+    def stream
+      manifest, signature = build
+
+      outputZip manifest, signature
+    end
+
+    def get_p12_cert_and_key
+      key_hash = {}
+      if Passbook.p12_key
+        key_hash[:key] = OpenSSL::PKey::RSA.new File.read(Passbook.p12_key), Passbook.p12_password
+        key_hash[:cert] = OpenSSL::X509::Certificate.new File.read(Passbook.p12_certificate)
+      else
+        p12 = OpenSSL::PKCS12.new File.read(Passbook.p12_cert), Passbook.p12_password
+        key_hash[:key], key_hash[:cert] = p12.key, p12.certificate 
+      end
+      key_hash 
+    end
+
+    def createSignature manifest
+      p12   = get_p12_cert_and_key
+      wwdc  = OpenSSL::X509::Certificate.new File.read(Passbook.wwdc_cert)
+      pk7   = OpenSSL::PKCS7.sign p12[:cert], p12[:key], manifest.to_s, [wwdc], OpenSSL::PKCS7::BINARY | OpenSSL::PKCS7::DETACHED
+      data  = OpenSSL::PKCS7.write_smime pk7
+
+      str_debut = "filename=\"smime.p7s\"\n\n"
+      data = data[data.index(str_debut)+str_debut.length..data.length-1]
+      str_end = "\n\n------"
+      data = data[0..data.index(str_end)-1]
+
+      return Base64.decode64(data)
+    end
+
+    private
+
+    def checkPass manifest
+      # Check for default images
+      raise 'Icon missing' unless manifest.include?('icon.png')
+      raise 'Icon@2x missing' unless manifest.include?('icon@2x.png')
+
+      # Check for developer field in JSON
+      raise 'Pass Type Identifier missing' unless @pass.include?('passTypeIdentifier')
+      raise 'Team Identifier missing' unless @pass.include?('teamIdentifier')
+      raise 'Serial Number missing' unless @pass.include?('serialNumber')
+      raise 'Organization Name Identifier missing' unless @pass.include?('organizationName')
+      raise 'Format Version' unless @pass.include?('formatVersion')
+      raise 'Description' unless @pass.include?('description')
+    end
+
+    def createManifest
+      sha1s = {}
+      sha1s['pass.json'] = Digest::SHA1.hexdigest @pass
+
+      @manifest_files.each do |file|
+        if file.class == Hash
+          sha1s[file[:name]] = Digest::SHA1.hexdigest file[:content]
+        else
+          sha1s[File.basename(file)] = Digest::SHA1.file(file).hexdigest
+        end
+      end
+
+      return sha1s.to_json
+    end
+
+    def outputZip manifest, signature
+
+      Zip::ZipOutputStream.write_buffer do |zip|
+        zip.put_next_entry 'pass.json'
+        zip.write @pass
+        zip.put_next_entry 'manifest.json'
+        zip.write manifest
+        zip.put_next_entry 'signature'
+        zip.write signature
+
+        @manifest_files.each do |file|
+          if file.class == Hash
+            zip.put_next_entry file[:name]
+            zip.print file[:content]
+          else
+            zip.put_next_entry File.basename(file)
+            zip.print IO.read(file)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/passbook/push_notification.rb

@@ -0,0 +1,10 @@
+module Passbook
+  class PushNotification
+    def self.send_notification(device_token)
+      pusher = Grocer.pusher({:certificate => Passbook.notification_cert, :gateway => Passbook.notification_gateway})
+      notification = Grocer::PassbookNotification.new(:device_token => device_token)
+
+      pusher.push notification
+    end
+  end
+end

data/lib/passbook/version.rb

@@ -0,0 +1,3 @@
+module Passbook
+  VERSION = "0.0.4"
+end

data/lib/passbook.rb

@@ -0,0 +1,13 @@
+require "passbook/version"
+require "passbook/pkpass"
+require 'active_support/core_ext/module/attribute_accessors'
+require 'passbook/push_notification'
+require 'grocer/passbook_notification'
+
+module Passbook
+  mattr_accessor :p12_cert, :p12_password, :wwdc_cert, :p12_certificate, :p12_key, :notification_cert, :notification_gateway
+
+  def self.configure
+    yield self
+  end
+end

data/lib/rack/passbook_rack.rb

@@ -0,0 +1,94 @@
+module Rack
+  class PassbookRack
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      method_and_params = find_method env['PATH_INFO']
+      if method_and_params
+        case method_and_params[:method]
+        when 'device_register_delete'
+          if env['REQUEST_METHOD'] == 'POST'
+            [Passbook::PassbookNotification.
+              register_pass(method_and_params[:params].merge! JSON.parse(env['rack.input'].read 1000))[:status], 
+              {}, ['']]
+          elsif env['REQUEST_METHOD'] == 'DELETE'
+            [Passbook::PassbookNotification.unregister_pass(method_and_params[:params])[:status], {}, {}]
+          end
+        when 'passes_for_device'
+          response = Passbook::PassbookNotification.passes_for_device(method_and_params[:params])
+          [response ? 200 : 204, {}, [response.to_json]]
+        when 'latest_pass'
+          response = Passbook::PassbookNotification.latest_pass(method_and_params[:params])
+          if response
+            [200, {'Content-Type' => 'application/vnd.apple.pkpass', 
+              'Content-Disposition' => 'attachment', 
+              'filename' => "#{method_and_params[:params]['serialNumber']}.pkpass"}, [response]]
+          else
+            [204, {}, {}]
+          end
+        when 'log'
+          Passbook::PassbookNotification.log JSON.parse(env['rack.input'].read 10000)
+          [200, {}, {}]
+        else
+        end
+      else
+        @app.call env
+      end
+    end
+
+    def append_parameter_separator url
+    end
+
+    def each(&block)
+    end
+
+
+    def find_method(path)
+      parsed_path = path.split '/'
+      url_beginning = parsed_path.index 'v1'
+      if url_beginning
+        args_length = parsed_path.size - url_beginning
+
+        if  (parsed_path[url_beginning + 1 ] == 'devices') and
+          (parsed_path[url_beginning + 3 ] == 'registrations')
+          if args_length == 6
+            return method_and_params_hash 'device_register_delete', path
+          elsif args_length == 5
+            return method_and_params_hash 'passes_for_device', path
+          end
+        elsif parsed_path[url_beginning + 1] == 'passes' and args_length == 4
+          return method_and_params_hash 'latest_pass', path
+        elsif parsed_path[url_beginning + 1] == 'log' and args_length == 2
+          return {:method => 'log'}
+        end
+      end
+
+      return nil       
+    end
+
+    private 
+
+    def method_and_params_hash(method, path)
+      parsed_path = path.split '/'
+      url_beginning = parsed_path.index 'v1'
+      if method == 'latest_pass'
+        {:method => 'latest_pass',
+          :params => {'passTypeIdentifier' => parsed_path[url_beginning + 2],
+            'serialNumber' => parsed_path[url_beginning + 3]}}
+      else 
+        return_hash = {:method => method, :params => 
+          {'deviceLibraryIdentifier' => parsed_path[url_beginning + 2], 
+            'passTypeIdentifier' => parsed_path[url_beginning + 4]}}
+          return_hash[:params]['serialNumber'] = parsed_path[url_beginning + 5] if 
+          method == 'device_register_delete'
+          return_hash
+      end
+    end
+
+
+  end
+end
+

data/lib/rails/generators/passbook/config/config_generator.rb

@@ -0,0 +1,16 @@
+module Passbook
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :wwdc_cert_path, type: :string, default: '', optional: true, banner: "Absolute path to your wwdc cert file"
+      argument :p12_cert_path, type: :string, default: '', optional: true, banner: "Absolute path to your cert.p12 file"
+      argument :p12_password, type: :string, default: '', optional: true, banner: "Password for your certificate"
+
+      desc 'Create passbook initializer'
+      def create_initializer_file
+        template 'initializer.rb', File.join('config', 'initializers', 'passbook.rb')
+      end
+    end
+  end
+end

data/lib/rails/generators/passbook/config/templates/initializer.rb

@@ -0,0 +1,13 @@
+require 'passbook'
+
+Passbook.configure do |passbook|
+
+  # Path to your wwdc cert file
+  passbook.wwdc_cert = '<%= wwdc_cert_path %>'
+
+  # Path to your cert.p12 file
+  passbook.p12_cert = '<%= p12_cert_path %>'
+  
+  # Password for your certificate
+  passbook.p12_password = '<%= p12_password %>'
+end