passbookpgh 0.4.5

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

@@ -0,0 +1,121 @@
+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
+
+      [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.binmode
+      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
+
+      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

data/lib/passbook/push_notification.rb

@@ -0,0 +1,19 @@
+module Passbook
+  class PushNotification
+    class << self
+      def pusher
+        @pusher ||= Grocer.pusher(
+          :certificate => Passbook.notification_cert,
+          :passphrase => Passbook.notification_passphrase || "",
+          :gateway => Passbook.notification_gateway
+        )
+      end
+
+      def send_notification(device_token)
+        notification = Grocer::PassbookNotification.new(:device_token => device_token)
+
+        pusher.push notification
+      end
+    end
+  end
+end

data/lib/passbook/signer.rb

@@ -0,0 +1,40 @@
+require 'openssl'
+require 'base64'
+
+module Passbook
+  class Signer
+    attr_accessor :certificate, :password, :key, :wwdc_cert, :key_hash, :p12_cert
+
+    def initialize(params = {})
+      @certificate = params[:certificate] || Passbook.p12_certificate
+      @password    = params[:password] || Passbook.p12_password
+      @key         = params[:key] || (params.empty? ? Passbook.p12_key : nil)
+      @wwdc_cert   = params[:wwdc_cert] || Passbook.wwdc_cert
+      compute_cert
+    end
+
+    def sign(data)
+      wwdc  = OpenSSL::X509::Certificate.new File.read(wwdc_cert)
+      pk7   = OpenSSL::PKCS7.sign key_hash[:cert], key_hash[:key], data.to_s, [wwdc], OpenSSL::PKCS7::BINARY | OpenSSL::PKCS7::DETACHED
+      data  = OpenSSL::PKCS7.write_smime pk7
+
+      str_debut = "filename=\"smime.p7s\"\n\n"
+      data      = data[data.index(str_debut)+str_debut.length..data.length-1]
+      str_end   = "\n\n------"
+      data      = data[0..data.index(str_end)-1]
+
+      Base64.decode64(data)
+    end
+
+    def compute_cert
+      @key_hash = {}
+      if key
+        @key_hash[:key]  = OpenSSL::PKey::RSA.new File.read(key), password
+        @key_hash[:cert] = OpenSSL::X509::Certificate.new File.read(certificate)
+      else
+        p12 = OpenSSL::PKCS12.new File.read(certificate), password
+        @key_hash[:key], @key_hash[:cert] = p12.key, p12.certificate
+      end
+    end
+  end
+end

data/lib/passbook/version.rb

@@ -0,0 +1,3 @@
+module Passbook
+  VERSION = "0.4.2"
+end

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'
+require 'rack/passbook_rack'
+
+module Passbook
+  mattr_accessor :p12_certificate, :p12_password, :wwdc_cert, :p12_key, :notification_cert, :notification_gateway, :notification_passphrase
+
+  def self.configure
+    yield self
+  end
+end

data/lib/rack/passbook_rack.rb

@@ -0,0 +1,98 @@
+module Rack
+  class PassbookRack
+
+    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]
+        when 'device_register_delete'
+          if env['REQUEST_METHOD'] == 'POST'
+            [Passbook::PassbookNotification.
+              register_pass(method_and_params[:params].merge! JSON.parse(env['rack.input'].read 1000))[:status],
+              {}, ['']]
+          elsif env['REQUEST_METHOD'] == 'DELETE'
+            [Passbook::PassbookNotification.unregister_pass(method_and_params[:params])[:status], {}, {}]
+          end
+        when 'passes_for_device'
+          response = Passbook::PassbookNotification.passes_for_device(method_and_params[:params])
+          [response ? 200 : 204, {}, [response.to_json]]
+        when 'latest_pass'
+          response = Passbook::PassbookNotification.latest_pass(method_and_params[:params])
+          if response[:status] == 200
+            [200, {'Content-Type' => 'application/vnd.apple.pkpass',
+              'Content-Disposition' => 'attachment',
+              'filename' => "#{method_and_params[:params]['serialNumber']}.pkpass","last-modified" => response[:last_modified]}, [response[:latest_pass]]]
+          else
+            [response[:status], {}, {}]
+          end
+        when 'log'
+          Passbook::PassbookNotification.passbook_log JSON.parse(env['rack.input'].read 10000)
+          [200, {}, {}]
+        else
+        end
+      else
+        @app.call env
+      end
+    end
+
+    def append_parameter_separator url
+    end
+
+    def each(&block)
+    end
+
+
+    def find_method(path)
+      parsed_path = path.split '/'
+      url_beginning = parsed_path.index 'v1'
+      if url_beginning
+        args_length = parsed_path.size - url_beginning
+
+        if  (parsed_path[url_beginning + 1 ] == 'devices') and
+          (parsed_path[url_beginning + 3 ] == 'registrations')
+          if args_length == 6
+            return method_and_params_hash 'device_register_delete', path
+          elsif args_length == 5
+            return method_and_params_hash 'passes_for_device', path
+          end
+        elsif parsed_path[url_beginning + 1] == 'passes' and args_length == 4
+          return method_and_params_hash 'latest_pass', path
+        elsif parsed_path[url_beginning + 1] == 'log' and args_length == 2
+          return {:method => 'log'}
+        end
+      end
+
+      return nil
+    end
+
+    private
+
+    def method_and_params_hash(method, path)
+      parsed_path = path.split '/'
+      url_beginning = parsed_path.index 'v1'
+      if method == 'latest_pass'
+        {:method => 'latest_pass',
+          :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
+
+
+  end
+end
+

data/lib/rails/generators/passbook/config/config_generator.rb

@@ -0,0 +1,16 @@
+module Passbook
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :wwdc_cert_path, type: :string, default: '', optional: true, banner: "Absolute path to your wwdc cert file"
+      argument :p12_cert_path, type: :string, default: '', optional: true, banner: "Absolute path to your cert.p12 file"
+      argument :p12_password, type: :string, default: '', optional: true, banner: "Password for your certificate"
+
+      desc 'Create passbook initializer'
+      def create_initializer_file
+        template 'initializer.rb', File.join('config', 'initializers', 'passbook.rb')
+      end
+    end
+  end
+end

data/lib/rails/generators/passbook/config/templates/initializer.rb

@@ -0,0 +1,13 @@
+require 'passbook'
+
+Passbook.configure do |passbook|
+
+  # Path to your wwdc cert file
+  passbook.wwdc_cert = '<%= wwdc_cert_path %>'
+
+  # Path to your cert.p12 file
+  passbook.p12_certificate = '<%= p12_cert_path %>'
+  
+  # Password for your certificate
+  passbook.p12_password = '<%= p12_password %>'
+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/passbookpgh.gemspec

@@ -0,0 +1,110 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: passbook 0.4.4 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "passbookpgh"
+  s.version = "0.4.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Thomas Lauro", "Lance Gleason", "Danielle Greaves"]
+  s.date = "2022-01-26"
+  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", "greaves@trustarts.org"]
+  s.executables = ["pk"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "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",
+    "lib/passbook/signer.rb",
+    "lib/passbook/version.rb",
+    "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",
+    "passbookpgh.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/passbook/signer_spec.rb",
+    "spec/lib/rack/passbook_rack_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "https://github.com/pgharts/passbookpgh"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.8"
+  s.summary = "A IOS Passbook generator."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      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"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      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"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    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"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+