Skip to content

max-power/passbook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Passbook

This is inspired by Passifier which i couldn't get to run with p12 signing. So here is my take on iOS Passbook passes. It's used here: https://chefcards.herokuapp.com

Installation

Add this line to your application's Gemfile:

gem 'power-passbook', github: 'max-power/passbook'

And then execute:

$ bundle

Usage

First setup Signing:

signer = Passbook::Authority.new(File.read("/path/to/certificate.p12"), "secret-password")

The basic usage is:

pass = Passbook::PKPass.new(pass_specifications, pass_assets, signer)
pass.to_file("my/path/to/the/pass.pkpass")
pass.to_s
pass.content_type  # "application/vnd.apple.pkpass"

Pass specifications is a hash that should match the Apple Passbook Format Reference.

pass_specifications = {
  "formatVersion"      => 1,
  "passTypeIdentifier" => "pass.com.flycheap.boardingpass",
  "teamIdentifier"     => "XXXXXXXX",
  "organizationName"   => "XXXXXXXX",
  "labelColor"         => "#ffffff",
  "backgroundColor"    => "#618d04",
  "foregroundColor"    => "#ffffff",
  "serialNumber"       => "123",
  "logoText"           => "Hi",
  ...
}

The assets parameter is a hash with filenames as keys and local or remote paths to the file as value. See the Apple Pass Design and Creation guidelines to see which files are used for the different pass types.

pass_assets = {
  "background.png"    => "assets/background.png",
  "background@2x.png" => "assets/background@2x.png",
  "icon.png"          => "assets/icon.png",
  "icon@2x.png"       => "assets/icon@2x.png",
  "logo.png"          => "http://i.imgur.com/WLUf6.png",
  "logo@2x.png"       => "http://i.imgur.com/mOpQo.png",
  "thumbnail.png"     => "assets/thumbnail.png",
  "thumbnail@2x.png"  => "assets/thumbnail@2x.png"
}

See Also

There is also a very tiny (60 LOC) version available here: https://gist.github.com/max-power/9262053

Contributing

  1. Fork it ( http://github.com/max-power/passbook/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request