passbook 0.2.1 → 0.3.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2U1MTYxOTRhMDk5YmJmYWRhMDcxNWEyZTU0MjAzMmIyZGU5ZGQ4NA==
+  data.tar.gz: !binary |-
+    Yzk2Mzk1NzA5OTEzYTNkZTI2ZWM3YTZiYWZkMjBiNjE5ZDhiMzJkZA==
+SHA512:
+  metadata.gz: !binary |-
+    OWVjYzI2ODJlNTcxNzdiZDcxMDBkOGJmMTdjMzJiNTBhMTJkOTBjZWExZTdm
+    ODdhMzkzNGYyOGRhM2VkNGJlNDg3YzBhNTY5NDhlMmM2YjI3ZGNkMWJmYWEy
+    OGJhN2E2ZjU4ZTU1YTNlOWUyMzcxYTQ1MDRiNmFhNzk0NjgyNmI=
+  data.tar.gz: !binary |-
+    ODY0NDc4NWNhZWNhMjFiN2M0NjQwNjA3ODM0ZDlmNzRkYTIzZjdiYmRiNWY5
+    NjAyNDE1NGZhMzcxMmQ2OWJiZDk4OGIxNmRjMDdhMzZiMGNlNzk2ZjEzNjM2
+    YmE3YjM2OWQxYzM3MDA2MzFjNWJmYzE5YTIwNGY0NjFiYzQ0YmU=

data/Gemfile

@@ -1,13 +1,15 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in passbook.gemspec
-gem 'rubyzip'
+gem 'rubyzip', '~> 1.0.0'
 gem 'grocer'
+gem 'commander'
+gem 'terminal-table'
 
 group :test, :development do
   gem 'rack-test'
   gem 'activesupport'
-  gem 'jeweler'
+  gem 'jeweler', :git => 'git://github.com/foxnewsnetwork/jeweler.git', :branch => 'ruby-2.0.0-ifying'
   gem 'simplecov'
   gem 'rspec'
   gem 'rake' 

data/Gemfile.lock

@@ -1,41 +1,51 @@
-GEM
-  remote: https://rubygems.org/
+GIT
+  remote: git://github.com/foxnewsnetwork/jeweler.git
+  revision: f05c62e168cfc29bd82cebe06df8fd11e1ef09ee
+  branch: ruby-2.0.0-ifying
   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)
+      bundler (~> 1.3.0.pre)
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.7.5)
-    json (1.7.5-java)
-    multi_json (1.3.6)
-    rack (1.4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    commander (4.1.5)
+      highline (~> 1.6.11)
+    diff-lcs (1.2.4)
+    git (1.2.6)
+    grocer (0.4.1)
+    highline (1.6.19)
+    i18n (0.6.5)
+    json (1.8.0)
+    json (1.8.0-java)
+    multi_json (1.8.0)
+    rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (0.9.2.2)
-    rdoc (3.12)
+    rake (10.1.0)
+    rdoc (4.0.1)
       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)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    rubyzip (1.0.0)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    yard (0.8.3)
+    terminal-table (1.4.5)
+    yard (0.8.7.2)
 
 PLATFORMS
   java
@@ -43,11 +53,13 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport
+  commander
   grocer
-  jeweler
+  jeweler!
   rack-test
   rake
   rspec
-  rubyzip
+  rubyzip (~> 1.0.0)
   simplecov
+  terminal-table
   yard

data/README.md

@@ -128,7 +128,7 @@ Your pass will need to have a field called 'webServiceURL' with the base url to
 ...
 ```
 
-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.
+Passbook 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
@@ -144,9 +144,13 @@ module Passbook
       the_passes_serial_number = options['serialNumber']
       the_devices_device_library_identifier = options['deviceLibraryIdentifier']
       the_devices_push_token = options['pushToken']
+      the_pass_type_identifier = options["passTypeIdentifier"]
+      the_authentication_token = options['authToken']
 
       # this is if the pass registered successfully
       # change the code to 200 if the pass has already been registered
+      # 404 if pass not found for serialNubmer and passTypeIdentifier
+      # 401 if authorization failed
       # or another appropriate code if something went wrong.
       {:status => 201}
     end
@@ -157,6 +161,7 @@ module Passbook
 
     def self.passes_for_device(options)
       device_library_identifier = options['deviceLibraryIdentifier']
+      passes_updated_since = options['passesUpdatedSince']
 
       # 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
@@ -171,6 +176,8 @@ module Passbook
       # a solid unique pair of identifiers to identify the pass are
       serial_number = options['serialNumber']
       device_library_identifier = options['deviceLibraryIdentifier']
+      the_pass_type_identifier = options["passTypeIdentifier"]
+      the_authentication_token = options['authToken']
       # return a status 200 to indicate that the pass was successfully unregistered.
       {:status => 200}
     end
@@ -187,7 +194,7 @@ module Passbook
 
     # This is called whenever there is something from the update process that is a warning
     # or error
-    def self.log(log)
+    def self.passbook_log(log)
       # this is a VERY crude logging example.  use the logger of your choice here.
       p "#{Time.now} #{log}"
     end

data/Rakefile

@@ -19,6 +19,7 @@ Jeweler::Tasks.new do |gem|
   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']
+  gem.executables = ['pk']
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.1

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"
+            }
+        ]
+    }
+}