passbook-iid 0.4.0

data/bin/pk

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+require 'terminal-table'
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'passbook'
+require 'utils/command_utils'
+
+HighLine.track_eof = false # Fix for built-in Ruby
+Signal.trap("INT") {} # Suppress backtrace when exiting command
+
+program :version, '0.1'
+program :description, 'A command-line interface for generating and previewing passbook passes'
+
+program :help, 'Author', 'Thomas Lauro <>, Lance Gleason <lgleason@polyglotprogramminginc.com>'
+program :help, 'Website', 'https://github.com/frozon/passbook'
+program :help_formatter, :compact
+
+default_command :help
+
+require 'commands/commands'

data/lib/commands/build.rb

@@ -0,0 +1,62 @@
+command :build do |c|
+  c.syntax = 'pk build [PASSNAME]'
+  c.summary = 'Creates a .pkpass archive'
+  c.description = ''
+
+  c.example 'description', 'pk archive mypass -o mypass.pkpass'
+  c.option '-w', '--wwdc_certificate /path/to/wwdc_cert.pem', 'Pass certificate'
+  c.option '-k', '--p12_key /path/to/cert.p12'
+  c.option '-c', '--p12_certificate /path/to/cert.p12'
+  c.option '-p', '--password password', 'certificate password'
+  c.option '-o', '--output /path/to/out.pkpass', '.pkpass output filepath'
+
+  c.action do |args, options|
+    determine_directory! unless @directory = args.first
+    validate_directory!
+
+    @filepath = options.output || "#{@directory}.pkpass"
+    validate_output_filepath!
+
+    @certificate = options.wwdc_certificate
+    validate_certificate!
+
+    @password = (options.password ? options.password : (ask("Enter certificate password:"){|q| q.echo = false}))
+
+    Passbook.configure do |passbook|
+      passbook.wwdc_cert = @certificate
+      passbook.p12_key = options.p12_key
+      passbook.p12_certificate = options.p12_certificate
+      passbook.p12_password = @password
+    end
+
+    assets = CommandUtils.get_assets @directory
+    pass_json = File.read(assets.delete(assets.detect{|file| File.basename(file) == 'pass.json'}))
+    pass = Passbook::PKPass.new(pass_json)
+    pass.addFiles assets
+
+    begin
+      pass_stream = pass.stream
+      pass_string = pass_stream.string
+
+      File.open(@filepath, 'w') do |f|
+        f.write  pass_string
+      end
+    rescue OpenSSL::PKCS12::PKCS12Error => error
+      say_error "Error: #{error.message}"
+      say_warning "You may be getting this error because the certificate password is either incorrect or missing"
+      abort
+    rescue => error
+      say_error "Error: #{error.message}" and abort
+    end
+  end
+end
+
+alias_command :archive, :build
+alias_command :b, :build
+
+private
+
+def validate_output_filepath!
+  say_error "Filepath required" and abort if @filepath.nil? or @filepath.empty?
+  say_error "#{@filepath} already exists" and abort if File.exist?(@filepath)
+end

data/lib/commands/commands.rb

@@ -0,0 +1,31 @@
+$:.push File.expand_path('../', __FILE__)
+
+require 'commands/build'
+require 'commands/generate'
+#require 'commands/serve'
+# this was added for testability because I couldn't figure out something better.
+
+private
+
+def determine_directory!
+  files = Dir['*/pass.json']
+  @directory ||= case files.length
+                 when 0 then nil
+                 when 1 then File.dirname(files.first)
+                 else
+                   @directory = choose "Select a directory:", *files.collect{|f| File.dirname(f)}
+                 end
+end
+
+def validate_directory!
+  say_error "Missing argument" and abort if @directory.nil?
+  say_error "Directory #{@directory} does not exist" and abort unless File.directory?(@directory)
+  say_error "Directory #{@directory} is not a valid pass" and abort unless File.exist?(File.join(@directory, "pass.json"))
+end
+
+def validate_certificate!
+  say_error "Missing or invalid certificate file" and abort if @certificate.nil? or not File.exist?(@certificate) 
+end
+
+
+

data/lib/commands/generate.rb

@@ -0,0 +1,44 @@
+require 'fileutils'
+
+command :generate do |c|
+  c.syntax = 'pk generate PASSNAME'
+  c.summary = 'Generates a template pass directory'
+  c.description = ''
+
+  c.example 'description', 'pk generate mypass'
+  c.option '-T', '--type [boardingPass|coupon|eventTicket|storeCard|generic]', 'Type of pass'
+
+  c.action do |args, options|
+    @directory = args.first
+    @directory ||= ask "Enter a passbook name: "
+    say_error "Missing pass name" and abort if @directory.nil? or @directory.empty?
+    say_error "Directory #{@directory} already exists" and abort if File.directory?(@directory)
+    say_error "File exists at #{@directory}" and abort if File.exist?(@directory)
+
+    @type = options.type
+    determine_type! unless @type
+    validate_type!
+
+    FileUtils.mkdir_p @directory
+    FileUtils.cp File.join(CommandUtils.get_current_directory, '..', 'commands/templates', "#{@type}.json"), File.join(@directory, 'pass.json')
+    ['icon.png', 'icon@2x.png'].each do |file|
+      FileUtils.touch File.join(@directory, file)
+    end
+
+    say_ok "Pass generated in #{@directory}"
+  end
+end
+
+alias_command :new, :generate
+alias_command :g, :generate
+
+private
+
+def determine_type!
+  @type ||= choose "Select a pass type", *Passbook::PKPass::TYPES
+end
+
+def validate_type!
+  say_error %{Invalid type: "#{@type}", expected one of: [#{Passbook::PKPass::TYPES.join(', ')}]} and abort unless Passbook::PKPass::TYPES.include?(@type)
+end
+

data/lib/commands/templates/boarding-pass.json

@@ -0,0 +1,56 @@
+{
+    "formatVersion" : 1,
+    "passTypeIdentifier" : "pass.com.example.boarding-pass",
+    "description" : "Example Boarding Pass",
+    "teamIdentifier": "Example",
+    "organizationName": "Example",
+    "serialNumber" : "123456",
+    "foregroundColor": "#866B23",
+    "backgroundColor": "#FFD248",
+    "boardingPass" : {
+        "primaryFields" : [
+            {
+                "key" : "origin",
+                "label" : "Atlanta",
+                "value" : "ATL"
+            },
+            {
+                "key" : "destination",
+                "label" : "Johannesburg",
+                "value" : "JNB"
+            }
+        ],
+        "secondaryFields" : [
+            {
+                "key" : "boarding-gate",
+                "label" : "Gate",
+                "value" : "F12"
+            }
+        ],
+        "auxiliaryFields" : [
+            {
+                "key" : "seat",
+                "label" : "Seat",
+                "value" : "7A"
+            },
+            {
+                "key" : "passenger-name",
+                "label" : "Passenger",
+                "value" : "Honey Badger"
+            }
+        ],
+        "transitType" : "PKTransitTypeAir",
+        "barcode" : {
+            "message" : "DL123",
+            "format" : "PKBarcodeFormatQR",
+            "messageEncoding" : "iso-8859-1"
+        },
+        "backFields" : [
+            {
+                "key" : "terms",
+                "label" : "Terms and Conditions",
+                "value" : "Valid for date of travel only"
+            }
+        ]
+    }
+}

data/lib/commands/templates/coupon.json

@@ -0,0 +1,33 @@
+{
+    "formatVersion" : 1,
+    "passTypeIdentifier" : "pass.com.example.coupon",
+    "description" : "Example Coupon",
+    "teamIdentifier": "Example",
+    "organizationName": "Example",
+    "serialNumber" : "123456",
+    "foregroundColor": "#FFFFFF",
+    "backgroundColor": "#C799FF",
+    "generic" : {
+        "primaryFields" : [
+
+        ],
+        "secondaryFields" : [
+            
+        ],
+        "auxiliaryFields" : [
+            
+        ],
+        "barcode" : {
+            "message" : "ABCD 123 EFGH 456 IJKL 789 MNOP",
+            "format" : "PKBarcodeFormatPDF417",
+            "messageEncoding" : "iso-8859-1"
+        },
+        "backFields" : [
+            {
+                "key" : "terms",
+                "label" : "Terms and Conditions",
+                "value" : "T's and C's Apply"
+            }
+        ]
+    }
+}

data/lib/commands/templates/event-ticket.json

@@ -0,0 +1,33 @@
+{
+    "formatVersion" : 1,
+    "passTypeIdentifier" : "pass.com.example.event-ticket",
+    "description" : "Example Event Ticket",
+    "teamIdentifier": "Example",
+    "organizationName": "Example",
+    "serialNumber" : "123456",
+    "foregroundColor": "#FFFFFF",
+    "backgroundColor": "#FF5453",
+    "generic" : {
+        "primaryFields" : [
+
+        ],
+        "secondaryFields" : [
+            
+        ],
+        "auxiliaryFields" : [
+            
+        ],
+        "barcode" : {
+            "message" : "ABCD 123 EFGH 456 IJKL 789 MNOP",
+            "format" : "PKBarcodeFormatPDF417",
+            "messageEncoding" : "iso-8859-1"
+        },
+        "backFields" : [
+            {
+                "key" : "terms",
+                "label" : "Terms and Conditions",
+                "value" : "T's and C's apply"
+            }
+        ]
+    }
+}

data/lib/commands/templates/generic.json

@@ -0,0 +1,33 @@
+{
+    "formatVersion" : 1,
+    "passTypeIdentifier" : "pass.com.example.generic",
+    "description" : "Example Generic Pass",
+    "teamIdentifier": "Example",
+    "organizationName": "Example",
+    "serialNumber" : "123456",
+    "foregroundColor": "#FFFFFF",
+    "backgroundColor": "#444444",
+    "generic" : {
+        "primaryFields" : [
+
+        ],
+        "secondaryFields" : [
+            
+        ],
+        "auxiliaryFields" : [
+            
+        ],
+        "barcode" : {
+            "message" : "ABCD 123 EFGH 456 IJKL 789 MNOP",
+            "format" : "PKBarcodeFormatPDF417",
+            "messageEncoding" : "iso-8859-1"
+        },
+        "backFields" : [
+            {
+                "key" : "terms",
+                "label" : "Terms and Conditions",
+                "value" : "Put your terms here"
+            }
+        ]
+    }
+}

data/lib/commands/templates/store-card.json

@@ -0,0 +1,33 @@
+{
+    "formatVersion" : 1,
+    "passTypeIdentifier" : "pass.com.example.store-card",
+    "description" : "Example Store Card",
+    "teamIdentifier": "Example",
+    "organizationName": "Example",
+    "serialNumber" : "123456",
+    "foregroundColor": "#FFFFFF",
+    "backgroundColor": "#AFC1E3",
+    "generic" : {
+        "primaryFields" : [
+
+        ],
+        "secondaryFields" : [
+            
+        ],
+        "auxiliaryFields" : [
+            
+        ],
+        "barcode" : {
+            "message" : "ABCD 123 EFGH 456 IJKL 789 MNOP",
+            "format" : "PKBarcodeFormatPDF417",
+            "messageEncoding" : "iso-8859-1"
+        },
+        "backFields" : [
+            {
+                "key" : "terms",
+                "label" : "Terms and Conditions",
+                "value" : "T's and C's apply"
+            }
+        ]
+    }
+}

data/lib/passbook.rb

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

data/lib/passbook/pkpass.rb

@@ -0,0 +1,120 @@
+require 'digest/sha1'
+require 'openssl'
+require 'zip'
+require 'base64'
+
+module Passbook
+  class PKPass
+    attr_accessor :pass, :manifest_files, :signer
+
+    TYPES = ['boarding-pass', 'coupon', 'event-ticket', 'store-card', 'generic']
+
+    def initialize pass, init_signer = nil
+      @pass           = pass
+      @manifest_files = []
+      @signer         = init_signer || Passbook::Signer.new
+    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 = @signer.sign 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
+
+    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 'Format Version should be a numeric' unless JSON.parse(@pass)['formatVersion'].is_a?(Numeric)
+      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::OutputStream.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