passbook 0.2.1 → 0.3.1

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/pkpass.rb

@@ -1,12 +1,14 @@
 require 'digest/sha1'
 require 'openssl'
-require 'zip/zip'
+require 'zip'
 require 'base64'
 
 module Passbook
   class PKPass
     attr_accessor :pass, :manifest_files
 
+    TYPES = ['boarding-pass', 'coupon', 'event-ticket', 'store-card', 'generic']
+
     def initialize pass
       @pass      = pass
       @manifest_files     = []
@@ -67,9 +69,9 @@ module Passbook
         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 
+        key_hash[:key], key_hash[:cert] = p12.key, p12.certificate
       end
-      key_hash 
+      key_hash
     end
 
     def createSignature manifest
@@ -99,6 +101,7 @@ module Passbook
       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
 
@@ -119,7 +122,7 @@ module Passbook
 
     def outputZip manifest, signature
 
-      Zip::ZipOutputStream.write_buffer do |zip|
+      Zip::OutputStream.write_buffer do |zip|
         zip.put_next_entry 'pass.json'
         zip.write @pass
         zip.put_next_entry 'manifest.json'

data/lib/rack/passbook_rack.rb

@@ -3,9 +3,12 @@ module Rack
 
     def initialize(app)
       @app = app
+      @parameters = {}
     end
 
     def call(env)
+      @parameters['authToken'] = env['HTTP_AUTHORIZATION'].gsub(/ApplePass /,'') if env['HTTP_AUTHORIZATION']
+      @parameters.merge!(Rack::Utils.parse_nested_query(env['QUERY_STRING']))
       method_and_params = find_method env['PATH_INFO']
       if method_and_params
         case method_and_params[:method]
@@ -30,7 +33,7 @@ module Rack
             [204, {}, {}]
           end
         when 'log'
-          Passbook::PassbookNotification.log JSON.parse(env['rack.input'].read 10000)
+          Passbook::PassbookNotification.passbook_log JSON.parse(env['rack.input'].read 10000)
           [200, {}, {}]
         else
         end
@@ -76,15 +79,16 @@ module Rack
       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
+          :params => @parameters.merge!({'passTypeIdentifier' => parsed_path[url_beginning + 2],
+            'serialNumber' => parsed_path[url_beginning + 3]})}
+      else
+        return_hash = {:method => method, :params =>
+          @parameters.merge!({'deviceLibraryIdentifier' => parsed_path[url_beginning + 2],
+            'passTypeIdentifier' => parsed_path[url_beginning + 4]})}
+        if method == 'device_register_delete'
+          return_hash[:params]['serialNumber'] = parsed_path[url_beginning + 5]
+        end
+        return_hash
       end
     end
 

data/lib/utils/command_utils.rb

@@ -0,0 +1,12 @@
+# this was added for testability because I couldn't figure out something better.
+class CommandUtils
+  def self.get_assets(directory)
+    Dir[File.join(directory, '*')]
+  end
+  
+  def self.get_current_directory
+    File.dirname(__FILE__)
+  end
+end
+
+

data/passbook.gemspec

@@ -2,16 +2,18 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: passbook 0.3.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "passbook"
-  s.version = "0.2.1"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thomas Lauro", "Lance Gleason"]
-  s.date = "2013-03-08"
+  s.date = "2013-10-29"
   s.description = "This gem allows you to create IOS Passbooks.  Unlike some,  this works with Rails but does not require it."
   s.email = ["thomas@lauro.fr", "lgleason@polyglotprogramminginc.com"]
+  s.executables = ["pk"]
   s.extra_rdoc_files = [
     "LICENSE",
     "README.md"
@@ -24,6 +26,15 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "bin/pk",
+    "lib/commands/build.rb",
+    "lib/commands/commands.rb",
+    "lib/commands/generate.rb",
+    "lib/commands/templates/boarding-pass.json",
+    "lib/commands/templates/coupon.json",
+    "lib/commands/templates/event-ticket.json",
+    "lib/commands/templates/generic.json",
+    "lib/commands/templates/store-card.json",
     "lib/passbook.rb",
     "lib/passbook/pkpass.rb",
     "lib/passbook/push_notification.rb",
@@ -31,11 +42,16 @@ Gem::Specification.new do |s|
     "lib/rack/passbook_rack.rb",
     "lib/rails/generators/passbook/config/config_generator.rb",
     "lib/rails/generators/passbook/config/templates/initializer.rb",
+    "lib/utils/command_utils.rb",
     "passbook.gemspec",
     "spec/data/icon.png",
     "spec/data/icon@2x.png",
     "spec/data/logo.png",
     "spec/data/logo@2x.png",
+    "spec/lib/commands/build_spec.rb",
+    "spec/lib/commands/commands_spec.rb",
+    "spec/lib/commands/commands_spec_helper.rb",
+    "spec/lib/commands/generate_spec.rb",
     "spec/lib/passbook/pkpass_spec.rb",
     "spec/lib/passbook/push_notification_spec.rb",
     "spec/lib/rack/passbook_rack_spec.rb",
@@ -44,15 +60,17 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/frozon/passbook"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "2.1.10"
   s.summary = "A IOS Passbook generator."
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rubyzip>, [">= 0"])
+      s.add_runtime_dependency(%q<rubyzip>, ["~> 1.0.0"])
       s.add_runtime_dependency(%q<grocer>, [">= 0"])
+      s.add_runtime_dependency(%q<commander>, [">= 0"])
+      s.add_runtime_dependency(%q<terminal-table>, [">= 0"])
       s.add_development_dependency(%q<rack-test>, [">= 0"])
       s.add_development_dependency(%q<activesupport>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
@@ -61,8 +79,10 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
-      s.add_dependency(%q<rubyzip>, [">= 0"])
+      s.add_dependency(%q<rubyzip>, ["~> 1.0.0"])
       s.add_dependency(%q<grocer>, [">= 0"])
+      s.add_dependency(%q<commander>, [">= 0"])
+      s.add_dependency(%q<terminal-table>, [">= 0"])
       s.add_dependency(%q<rack-test>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
@@ -72,8 +92,10 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<yard>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rubyzip>, [">= 0"])
+    s.add_dependency(%q<rubyzip>, ["~> 1.0.0"])
     s.add_dependency(%q<grocer>, [">= 0"])
+    s.add_dependency(%q<commander>, [">= 0"])
+    s.add_dependency(%q<terminal-table>, [">= 0"])
     s.add_dependency(%q<rack-test>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])

data/spec/lib/commands/build_spec.rb

@@ -0,0 +1,92 @@
+require 'lib/commands/commands_spec_helper'
+require 'passbook'
+
+describe 'Build' do
+
+  before :each do
+    $stderr = StringIO.new
+    mock_terminal
+  end
+
+  context 'command' do
+    specify 'missing directory' do
+      run_command 'build' do
+        @output.string.should eq "\e[31mMissing argument\e[0m\n"
+      end
+    end
+
+    context 'good directory' do
+
+      before :each do
+        File.should_receive(:directory?).with('scraps').and_return true
+        File.should_receive(:exist?).once.with('scraps/pass.json').and_return true
+        File.should_receive(:exist?).once.with('scraps.pkpass').and_return false
+      end
+
+      specify 'no certificate file' do
+        run_command 'build', 'scraps' do
+          @output.string.should eq "\e[31mMissing or invalid certificate file\e[0m\n" 
+        end
+      end
+
+      context 'good certificate file' do
+        before :each do
+          File.should_receive(:exist?).with('jackels').and_return true
+        end
+
+        specify 'no certificate password entered' do
+          run_command 'build', 'scraps', '-w', 'jackels' do
+            @output.string.should eq "Enter certificate password:\n\n"
+          end    
+        end
+
+        context 'all required values' do
+
+          let(:pass_json) {'{"this":"is awesome json"}'}
+          let(:pass_assets) {['pass.json', 'something.jpeg']}
+
+          before :each do
+            Passbook.should_receive(:wwdc_cert=).with 'jackels'      
+            Passbook.should_receive(:p12_key=).with 'badger_key'      
+            Passbook.should_receive(:p12_certificate=).with 'badger_cert'      
+            Passbook.should_receive(:p12_password=).with 'bees'    
+            CommandUtils.should_receive(:get_assets).with('scraps').and_return pass_assets 
+            @pk_pass = double 'pk pass'
+            File.should_receive(:read).with('pass.json').and_return pass_json 
+            Passbook::PKPass.should_receive(:new).with(pass_json).and_return @pk_pass
+            @pk_pass.should_receive(:addFiles).with pass_assets
+          end
+
+          specify 'are set from command line' do
+            pass_stream = double 'passbook stream' 
+            pass_stream.should_receive(:string).and_return 'my badass pass'
+            @pk_pass.should_receive(:stream).and_return pass_stream
+            File.should_receive(:open).with('scraps.pkpass', 'w')
+
+            run_command 'build', 'scraps', '-w', 'jackels',
+              '-p', 'bees', '-k', 'badger_key', '-c', 'badger_cert' do
+              @output.string.should eq ""
+              end    
+          end
+
+          specify 'should catch a general error' do
+            @pk_pass.should_receive(:stream).and_raise(StandardError.new('I have failed'))
+            run_command 'build', 'scraps', '-w', 'jackels',
+              '-p', 'bees', '-k', 'badger_key', '-c', 'badger_cert' do
+              @output.string.should eq "\e[31mError: I have failed\e[0m\n"
+              end    
+          end
+
+          specify 'should catch a general error' do
+            @pk_pass.should_receive(:stream).and_raise(OpenSSL::PKCS12::PKCS12Error.new('I am a failure'))
+            run_command 'build', 'scraps', '-w', 'jackels',
+              '-p', 'bees', '-k', 'badger_key', '-c', 'badger_cert' do
+              @output.string.should eq "\e[31mError: I am a failure\e[0m\n\e[33mYou may be getting this error because the certificate password is either incorrect or missing\e[0m\n"
+              end    
+          end
+        end
+      end
+    end
+  end
+
+end

data/spec/lib/commands/commands_spec.rb

@@ -0,0 +1,102 @@
+require 'lib/commands/commands_spec_helper'
+
+describe 'Commands' do
+
+  before :each do
+    program :version, '1.2.3'
+    program :description, "Honey Badger Don't Care"
+  end
+
+  context 'determine directory' do
+
+    specify 'no directories' do
+      Dir.should_receive(:[]).and_return []
+      determine_directory!
+      @directory.should eq nil
+    end
+
+    specify 'one directory present' do
+      Dir.should_receive(:[]).and_return ['ass']
+      File.should_receive(:dirname).with('ass').and_return('/honey/badger/is/bad/ass')
+      determine_directory!
+      @directory.should eq '/honey/badger/is/bad/ass'
+    end
+
+    specify 'multiple directories' do
+      Dir.should_receive(:[]).and_return ['cobras', 'bee_larvae']
+      File.should_receive(:dirname).with('cobras').and_return('/yummy/cobras')
+      File.should_receive(:dirname).with('bee_larvae').and_return('/disgusting/bee_larvae')
+      self.should_receive(:choose).with('Select a directory:', 
+                                        '/yummy/cobras', '/disgusting/bee_larvae').and_return '/yummy/cobras'
+      determine_directory!
+      @directory.should eq '/yummy/cobras' 
+    end
+
+  end
+
+  context 'validate directory' do
+
+    specify 'missing directory' do
+      self.should_receive(:say_error).with('Missing argument').and_return true
+      lambda {
+        @directory = nil
+        validate_directory!
+      }.should exit_with_code(1)
+    end
+
+    specify 'directory does not exist' do
+      self.should_receive(:say_error).with("Directory scraps does not exist").and_return true
+      File.should_receive(:directory?).with('scraps').and_return false
+      lambda {
+        @directory = 'scraps'
+        validate_directory!
+      }.should exit_with_code(1) 
+    end
+
+    specify 'directory does not have a valid pass' do
+      self.should_receive(:say_error).with("Directory scraps is not a valid pass").and_return true
+      File.should_receive(:directory?).with('scraps').and_return true
+      File.should_receive(:exist?).with('scraps/pass.json').and_return false
+      lambda {
+        @directory = 'scraps'
+        validate_directory!
+      }.should exit_with_code(1) 
+    end
+
+    specify 'directory has valid pass' do
+      File.should_receive(:directory?).with('scraps').and_return true
+      File.should_receive(:exist?).with('scraps/pass.json').and_return true
+      lambda {
+        @directory = 'scraps'
+        validate_directory!
+      }.should_not exit_with_code(1) 
+    end
+  end
+
+  context 'validate certificate' do
+    specify 'nil certificate' do
+      self.should_receive(:say_error).with("Missing or invalid certificate file").and_return true
+      lambda {
+        @certificate = nil
+        validate_certificate!
+      }.should exit_with_code(1) 
+    end
+
+    specify 'certificate file does not exist' do
+      self.should_receive(:say_error).with("Missing or invalid certificate file").and_return true
+      File.should_receive(:exist?).with('jackels').and_return false
+      lambda {
+        @certificate = 'jackels'
+        validate_certificate!
+      }.should exit_with_code(1) 
+    end
+
+    specify 'certificate file exists' do
+      File.should_receive(:exist?).with('jackels').and_return true
+      lambda {
+        @certificate = 'jackels'
+        validate_certificate!
+      }.should_not exit_with_code(1) 
+    end
+  end 
+end