passifier-rails 0.0.3

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+end
+
+gem "rake"
+gem "rubyzip"

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) Paperless Post, http://www.paperlesspost.com
+
+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,143 @@
+# Passifier
+
+Generate Apple Passbook passes in Ruby
+
+Passifier does most of the hard work and will more easily allow you to automate generating pkpass files. You simply supply
+
+* A Hash of metadata and layout (the contents of pass.json for those experienced)
+* Image URLs and paths
+* The location of your key and certificate .pem files
+* Output path where you'd like the generated .pkpass file
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'passifier'
+```
+
+## Usage
+
+### Metadata and Layout
+
+First, supply a bunch of pass information and styling.  This will become the file pass.json within the pass archive.  More information on pass.json and creating a layout can be found at [developers.apple.com](https://developer.apple.com/library/prerelease/ios/documentation/UserExperience/Reference/PassKit_Bundle/Chapters/Introduction.html).
+
+```ruby
+
+serial_number = "SO_SERIAL"
+
+spec = {
+  "formatVersion": 1,
+  "passTypeIdentifier": "pass.example.example",
+  "teamIdentifier": "METS",
+  "relevantDate": "2012-07-30T14:19Z",          
+  "organizationName": "Example Inc.",
+  "serialNumber": serial_number,
+  "description": "The example pass from README.md",
+  "labelColor": "rgb(122, 16, 38)",
+  "backgroundColor": "rgb(227, 227, 227)",
+  "foregroundColor": "rgb(110,110,110)",
+  "generic": {
+    "headerFields": [
+      {
+        "key": "date",
+        "label": "Date",
+        "value": "October 30th"
+      }
+    ],
+    "primaryFields": [
+      {
+        "key": "title",
+        "label": "",
+        "value": "Passifier!"
+      }
+    ],
+    "secondaryFields": [
+      {
+        "key": "host",
+        "label": "Host",
+        "value": "paperlesspost.com",
+      }
+    ]
+  }
+}
+```
+
+### Images
+
+Specify a Hash of images. Notice that you can use either paths or urls here.
+
+```ruby
+
+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"
+}
+```
+
+### Signing
+
+Give Passifier some info about your `.pem` files.
+
+To get your certificates and keys in order, follow these steps:
+
+1. Sign in to the iOS Provisioning Portal, add a Pass Type ID, download the certificate
+2. Add the `.cer` file you're given to your keychain
+3. Right click on the certificate, export it to `Certificates.p12`, create a secure password when prompted
+4. `openssl pkcs12 -in Certificates.p12 -clcerts -nokeys -out certificate.pem -passin pass:<THAT_SECRET_PASSWORD>`
+5. `openssl pkcs12 -in Certificates.p12 -nocerts -out key.pem -passin pass:<THAT_SECRET_PASSWORD> -passout pass:<ANOTHER_SECRET_PASSWORD>`
+
+Download the [Worldwide Developer Relations](https://www.apple.com/certificateauthority/)
+certificate and export it as a `.pem` file to include in the signature.
+
+```ruby
+key_pem = "path/to/a/key.pem"
+pass_phrase = "<ANOTHER_SECRET_PASSWORD>"
+cert_pem = "path/to/a/certificate.pem"
+wwdr_pem = "path/to/the/wwdr_certificate.pem"
+
+# Create a Signing object
+signing = Passifier::Signing.new(key_pem, pass_phrase, cert_pem, wwdr_pem)
+```
+
+### Generate!
+
+Now it's time to create your pass.
+
+```ruby
+Passifier::Pass.generate("readme.pkpass", serial_number, spec, assets, signing)
+```
+
+Passifier will have created the file `readme.pkpass` for you.  When opened in Passbook, that pass looks something like:
+
+![image](http://i.imgur.com/fooaB.jpg)
+
+## Further Reading
+
+* Find a similar example with some more explanation [here](http://github.com/paperlesspost/passifier/blob/master/examples/simple.rb)
+* Read a blog post about Passifier [here]()
+
+## Documentation
+
+* [rubydoc](http://rubydoc.info/github/paperlesspost/passifier)
+
+## Contributing to Passifier
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Create an issue in the issue tracker
+* Fork the project.
+* Start a feature/bugfix branch; include the issue number in the branch name.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+
+## Copyright
+
+Copyright © 2012 Paperless Post. See LICENSE.md for details.

data/Rakefile

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+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|
+  $LOAD_PATH.unshift 'lib'
+  require "passifier"
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.version = Passifier::VERSION
+  gem.name = "passifier"
+  gem.homepage = "http://github.com/paperlesspost/passifier"
+  gem.license = "MIT"
+  gem.summary = %Q{Generate Apple Passbook passes in Ruby}
+  gem.description = %Q{Generate Apple Passbook passes in Ruby}
+  gem.email = "ari.russo@gmail.com"
+  gem.authors = ["Ari Russo"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "blah #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/examples/simple.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+$:.unshift File.join( File.dirname( __FILE__ ), '../lib')
+
+require "passifier"
+
+# This is an example that will generate a simple pass file
+
+# 1. Pass metadata and layout
+# This is used to generate the pass.json file for the archive.
+# See () for more information about pass.json usage
+# 
+serial = "SO_SERIAL"
+spec = {
+  "formatVersion" => 1,
+  "passTypeIdentifier" => "pass.example.example",
+  "teamIdentifier" => "ATEAMID",
+  "relevantDate" => "2012-07-30T14:19Z",          
+  "organizationName" => "Example Inc.",
+  "serialNumber" => serial,
+  "description" => "this is a pass",
+  "labelColor" => "rgb(122, 16, 38)",
+  "backgroundColor" => "rgb(227, 227, 227)",
+  "foregroundColor" => "rgb(110,110,110)",
+  "generic" => {
+    "headerFields" => [
+      {
+        "key" => "date",
+        "label" => "Date",
+        "value" => "October 30th"
+      }
+    ],
+    "primaryFields" => [
+      {
+        "key" => "title",
+        "label" => "",
+        "value" => "Passifier!"
+      }
+    ],
+    "secondaryFields" => [
+      {
+        "key" => "host",
+        "label" => "Host",
+        "value" => "dev.paperlesspost.com",
+      }
+    ]
+  }
+}
+
+#
+# 2. Image assets
+# notice that you can use either paths or urls here
+#
+images = {
+  "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"
+}
+
+#
+# 3. Signing settings
+# Replace with your own paths/password if you plan on running this example
+# 
+key_pem = "../test/assets/signing/key/key.pem"
+pass_phrase = File.read("../test/assets/signing/pass_phrase.txt").strip.lstrip # you can just replace this with a string if you want
+cert_pem = "../test/assets/signing/certificate/certificate.pem"
+
+# Create a signing object
+signing = Passifier::Signing.new(key_pem, pass_phrase, cert_pem)
+
+#
+#
+# Now, generate the pass!
+#
+#
+
+# Create the pass archive
+output_file = "./simple.pkpass"
+Passifier::Pass.generate(output_file, serial, spec, images, signing)
+
+# Finished!
+puts "Finished generating the pass archive: #{output_file}"

data/lib/passifier.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+# libs
+require "forwardable"
+require "json"
+require "net/http"
+require "zip/zip"
+require "digest/sha1"
+
+# modules
+require "passifier/signing"
+
+# classes
+require "passifier/archive"
+require "passifier/manifest"
+require "passifier/manifest_signature"
+require "passifier/pass"
+require "passifier/spec"
+require "passifier/static_file"
+require "passifier/storage"
+require "passifier/url_source"
+
+module Passifier
+
+  VERSION = "0.0.3"
+
+end

data/lib/passifier/archive.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+module Passifier
+
+  # Represents the .pkpass archive file for the pass.  Despite the extension, a .pkpass file is actually
+  # a zip archive.
+  class Archive
+
+    attr_reader :assets, 
+                :id,
+                :path
+
+    # @param [String] path The archive path
+    # @param [String] id An ID to represent the Archive
+    def initialize(path, id, assets)
+      @assets = assets
+      @path = path
+      @id = id
+    end
+
+    # The raw data of this archive file
+    # @return [String] The raw data of this archive file
+    def data
+      File.open(@path, 'rb') {|file| file.read } unless @path.nil?
+    end
+
+    def destroy
+      unless @storage.nil?
+        @storage.cleanup
+        @storage.remove_zip(@path)
+      end
+    end
+
+    # Write the zip archive to disk
+    # @param [Hash] options The options to store an Archive with.
+    # @option opts [String] :scratch_directory The directory to use for temp files while creating the archive. 
+    #                                          (not to be confused with the archive path)
+    def store(options = {})
+      scratch_dir = options[:scratch_directory] || "/tmp/passkit/#{@id}"
+      @storage = Storage.new(scratch_dir, @assets)
+      @storage.store
+      @storage.zip(@path)
+      @storage.cleanup
+    end
+    alias_method :save, :store
+
+  end
+
+end
+
+
+

data/lib/passifier/manifest.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+module Passifier
+
+  class Manifest
+
+    attr_reader :hash
+    alias_method :to_hash, :hash
+
+    # @param [Array<Passifier::StaticFile, Passifier::UrlSource>] asset_files The asset files to populate the manifest with
+    # @param [Passifier::Spec] spec The spec generated from the hash used to initialise a pass
+    def initialize(asset_files, spec)
+      @asset_files = asset_files
+      @spec = spec
+      populate_content
+    end
+
+    def filename
+      "manifest.json"
+    end
+
+    def content
+      to_hash.to_json
+    end
+
+    private
+
+    # Convert the image files into SHA1 digests for use in the manifest file
+    # @return [String] The resulting contents of the manifest file (aka Passifier::Manifest#content)
+    def populate_content
+      @hash = {}
+      @asset_files.each { |file| @hash[file.name] = Digest::SHA1.hexdigest file.content }
+      @hash["pass.json"] = Digest::SHA1.hexdigest @spec.to_json
+    end
+
+  end
+
+end
+