passkit 0.1.0 → 0.3.0

data/config/routes.rb

@@ -1,12 +1,22 @@
 # frozen_string_literal: true
 
 Passkit::Engine.routes.draw do
-  resources :devices, only: [] do
-    post 'registrations/:pass_type_id/:serial_number' => 'registrations#create', as: :register
-    delete 'registrations/:pass_type_id/:serial_number' => 'registrations#destroy', as: :unregister
-    get 'registrations/:pass_type_id' => 'registrations#show', as: :registrations
+  scope :api, constraints: {pass_type_id: /.*/} do
+    scope :v1 do
+      resources :devices, only: [] do
+        post "registrations/:pass_type_id/:serial_number" => "api/v1/registrations#create", :as => :register
+        delete "registrations/:pass_type_id/:serial_number" => "api/v1/registrations#destroy", :as => :unregister
+        get "registrations/:pass_type_id" => "api/v1/registrations#show", :as => :registrations
+      end
+      get "passes/:pass_type_id/:serial_number" => "api/v1/passes#show", :as => :pass
+      get "passes/:payload", to: "api/v1/passes#create", as: :passes_api
+      post "log" => "api/v1/logs#create", :as => :log
+    end
+  end
+
+  unless Rails.env.production?
+    resources :previews, only: [:index, :show], param: :class_name
+    resources :logs, only: [:index]
+    resources :passes, only: [:index]
   end
-  get 'passes/:pass_type_id/:serial_number' => 'passes#show', as: :pass
-  get 'passes/:payload', to: 'passes#create', as: :passes
-  post 'log' => 'logs#create'
 end

data/docs/passkit_environment_variables.md

@@ -0,0 +1,48 @@
+# Setup Passkit Environment variables
+
+## `PASSKIT_WEB_SERVICE_HOST`
+
+This is the host where your Rails app is running. It is used to generate the URLs for the passes. 
+When the device wants to update the Pass, it will invoke services on this host.
+In production, it will simply be your domain name, but in development you can use [ngrok](https://ngrok.com/) to expose your local server to the internet.
+
+**Remember that it must always start with `https://`.**
+
+## `PASSKIT_APPLE_INTERMEDIATE_CERTIFICATE`
+
+This is the easy one.
+Head to https://www.apple.com/certificateauthority/ and download the latest Apple Intermediate Certificate Worldwide Developer Relations.
+
+
+## `PASSKIT_APPLE_TEAM_IDENTIFIER`
+
+You find this in your Apple Developer dashboard, under Membership.
+
+![Membership](membership.png)
+
+## `PASSKIT_PASS_TYPE_IDENTIFIER`, `PASSKIT_PRIVATE_P12_CERTIFICATE` and `PASSKIT_CERTIFICATE_KEY`
+
+Head to your Apple Developers console and generate a new certificate.
+
+![Step 1](step1.png)
+
+![Step 2](step2.png)
+
+![Step 3](step3.png)
+
+The identifier is the `PASSKIT_PASS_TYPE_IDENTIFIER` variable.
+
+Now, create a certificate signing request: https://help.apple.com/developer-account/#/devbfa00fef7
+
+And create the certificate:
+
+![Step 4](step4.png)
+
+At the end, you'll have a `pass.cer` file.
+
+Open it in the Keychain Access tool and export it:
+
+![Step 5](step5.png)
+
+Set a password and get your p12 file. The path to this file is the `PASSKIT_PRIVATE_P12_CERTIFICATE` variable.
+Save the password. This is the `PASSKIT_CERTIFICATE_KEY` variable.

data/lib/generators/passkit/install_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+require "rails/generators/migration"
+
+module Passkit
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      desc "Copy all files to your application."
+      def generate_files
+        migration_template "create_passkit_tables.rb", "db/migrate/create_passkit_tables.rb"
+        copy_file "passkit.rb", "config/initializers/passkit.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/create_passkit_tables.rb.tt

@@ -0,0 +1,32 @@
+class CreatePasskitTables < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :passkit_passes do |t|
+      t.string :generator_type
+      t.string :klass
+      t.bigint :generator_id
+      t.string :serial_number
+      t.string :authentication_token
+      t.json :data
+      t.integer :version
+      t.timestamps null: false
+      t.index [:generator_type, :generator_id], name: 'index_passkit_passes_on_generator'
+    end
+
+    create_table :passkit_devices do |t|
+      t.string :identifier
+      t.string :push_token
+      t.timestamps null: false
+    end
+
+    create_table :passkit_registrations do |t|
+      t.belongs_to :passkit_pass, index: true
+      t.belongs_to :passkit_device, index: true
+      t.timestamps null: false
+    end
+
+    create_table :passkit_logs do |t|
+      t.text :content
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/templates/passkit.rb

@@ -0,0 +1,3 @@
+Passkit.configure do |config|
+  # config.available_passes['Passkit::YourPass'] = -> { User.create }
+end

data/lib/passkit/base_pass.rb

@@ -0,0 +1,124 @@
+module Passkit
+  class BasePass
+    def initialize(generator = nil)
+      @generator = generator
+    end
+
+    def format_version
+      ENV["PASSKIT_FORMAT_VERSION"] || 1
+    end
+
+    def apple_team_identifier
+      ENV["PASSKIT_APPLE_TEAM_IDENTIFIER"] || raise(Error.new("Missing environment variable: PASSKIT_APPLE_TEAM_IDENTIFIER"))
+    end
+
+    def pass_type_identifier
+      ENV["PASSKIT_PASS_TYPE_IDENTIFIER"] || raise(Error.new("Missing environment variable: PASSKIT_PASS_TYPE_IDENTIFIER"))
+    end
+
+    def language
+      nil
+    end
+
+    def last_update
+      @generator&.updated_at
+    end
+
+    def pass_path
+      rails_folder = Rails.root.join("private/passkit/#{folder_name}")
+      # if folder exists, otherwise is in the gem itself under lib/passkit/base_pass
+      if File.directory?(rails_folder)
+        rails_folder
+      else
+        File.join(File.dirname(__FILE__), folder_name)
+      end
+    end
+
+    def pass_type
+      :storeCard
+      # :coupon
+    end
+
+    def web_service_url
+      raise Error.new("Missing environment variable: PASSKIT_WEB_SERVICE_HOST") unless ENV["PASSKIT_WEB_SERVICE_HOST"]
+      "#{ENV["PASSKIT_WEB_SERVICE_HOST"]}/passkit/api"
+    end
+
+    def foreground_color
+      "rgb(0, 0, 0)"
+    end
+
+    def background_color
+      "rgb(255, 255, 255)"
+    end
+
+    def organization_name
+      "Passkit"
+    end
+
+    def description
+      "A basic description for a pass"
+    end
+
+    # A pass can have up to ten relevant locations
+    #
+    # @see https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/Creating.html
+    def locations
+      []
+    end
+
+    def voided
+      false
+    end
+
+    def file_name
+      @file_name ||= SecureRandom.uuid
+    end
+
+    # QRCode by default
+    def barcode
+      {messageEncoding: "iso-8859-1",
+       format: "PKBarcodeFormatQR",
+       message: "https://github.com/coorasse/passkit",
+       altText: "https://github.com/coorasse/passkit"}
+    end
+
+    # Barcode example
+    # def barcode
+    #   { messageEncoding: 'iso-8859-1',
+    #     format: 'PKBarcodeFormatCode128',
+    #     message: '12345',
+    #     altText: '12345' }
+    # end
+
+    def logo_text
+      "Logo text"
+    end
+
+    def header_fields
+      []
+    end
+
+    def primary_fields
+      []
+    end
+
+    def secondary_fields
+      []
+    end
+
+    def auxiliary_fields
+      []
+    end
+
+    def back_fields
+      []
+    end
+
+    private
+
+    def folder_name
+      self.class.name.demodulize.underscore
+    end
+  end
+end

data/lib/passkit/example_store_card.rb

@@ -0,0 +1,110 @@
+module Passkit
+  class ExampleStoreCard < BasePass
+    def pass_type
+      :storeCard
+      # :coupon
+    end
+
+    def foreground_color
+      "rgb(0, 0, 0)"
+    end
+
+    def background_color
+      "rgb(255, 255, 255)"
+    end
+
+    def organization_name
+      "Passkit"
+    end
+
+    def description
+      "A basic description for a pass"
+    end
+
+    # A pass can have up to ten relevant locations
+    #
+    # @see https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/Creating.html
+    def locations
+      []
+    end
+
+    def voided
+      false
+    end
+
+    def file_name
+      @file_name ||= SecureRandom.uuid
+    end
+
+    # QRCode by default
+    def barcode
+      {messageEncoding: "iso-8859-1",
+       format: "PKBarcodeFormatQR",
+       message: "https://github.com/coorasse/passkit",
+       altText: "https://github.com/coorasse/passkit"}
+    end
+
+    # Barcode example
+    # def barcode
+    #   { messageEncoding: 'iso-8859-1',
+    #     format: 'PKBarcodeFormatCode128',
+    #     message: '12345',
+    #     altText: '12345' }
+    # end
+
+    def logo_text
+      "Loyalty Card"
+    end
+
+    def header_fields
+      [{
+        key: "balance",
+        label: "Balance",
+        value: 100,
+        currencyCode: "$"
+      }]
+    end
+
+    def back_fields
+      [{
+        key: "example1",
+        label: "Code",
+        value: "0123456789"
+      },
+        {
+          key: "example2",
+          label: "Creator",
+          value: "https://github.com/coorasse"
+        },
+        {
+          key: "example3",
+          label: "Contact",
+          value: "rodi@hey.com"
+        }]
+    end
+
+    def auxiliary_fields
+      [{
+        key: "name",
+        label: "Name",
+        value: "Alessandro Rodi"
+      },
+        {
+          key: "email",
+          label: "Email",
+          value: "rodi@hey.com"
+        },
+        {
+          key: "phone",
+          label: "Phone",
+          value: "+41 1234567890"
+        }]
+    end
+
+    private
+
+    def folder_name
+      self.class.name.demodulize.underscore
+    end
+  end
+end

data/lib/passkit/factory.rb

@@ -1,8 +1,8 @@
 module Passkit
   class Factory
     class << self
-      def create_pass(generator)
-        pass = Pass.create!(generator: generator)
+      def create_pass(pass_class, generator = nil)
+        pass = Pass.create!(klass: pass_class, generator: generator)
         Passkit::Generator.new(pass).generate_and_sign
       end
     end

data/lib/passkit/generator.rb

@@ -1,13 +1,16 @@
+require "zip"
+
 module Passkit
   class Generator
-    TMP_FOLDER = Rails.root.join('tmp/pass_kit').freeze
+    TMP_FOLDER = Rails.root.join("tmp/passkit").freeze
 
-    def initialize(pass_name, pass)
+    def initialize(pass)
       @pass = pass
       @generator = pass.generator
     end
 
     def generate_and_sign
+      check_necessary_files
       create_temporary_directory
       copy_pass_to_tmp_location
       clean_ds_store_files
@@ -21,9 +24,13 @@ module Passkit
 
     private
 
+    def check_necessary_files
+      raise "icon.png is not present in #{@pass.pass_path}" unless File.exist?(File.join(@pass.pass_path, "icon.png"))
+    end
+
     def create_temporary_directory
       FileUtils.mkdir_p(TMP_FOLDER) unless File.directory?(TMP_FOLDER)
-      @temporary_path = TMP_FOLDER.join(@pass.file_name)
+      @temporary_path = TMP_FOLDER.join(@pass.file_name.to_s)
 
       FileUtils.rm_rf(@temporary_path) if File.directory?(@temporary_path)
     end
@@ -33,10 +40,9 @@ module Passkit
     end
 
     def clean_ds_store_files
-      Dir.glob(@temporary_path.join('**/.DS_Store')).each { |file| File.delete(file) }
+      Dir.glob(@temporary_path.join("**/.DS_Store")).each { |file| File.delete(file) }
     end
 
-    # rubocop:disable Metrics/AbcSize
     def generate_json_pass
       pass = {
         formatVersion: @pass.format_version,
@@ -53,35 +59,37 @@ module Passkit
       }
 
       pass = pass.merge({
-                          serialNumber: @wallet_pass.serial_number,
-                          passTypeIdentifier: @wallet_pass.pass_type_identifier,
-                          authenticationToken: @wallet_pass.authentication_token
-                        })
+        serialNumber: @pass.serial_number,
+        passTypeIdentifier: @pass.pass_type_identifier,
+        authenticationToken: @pass.authentication_token
+      })
 
       pass[@pass.pass_type] = {
         headerFields: @pass.header_fields,
+        primaryFields: @pass.primary_fields,
+        secondaryFields: @pass.secondary_fields,
         auxiliaryFields: @pass.auxiliary_fields,
         backFields: @pass.back_fields
       }
 
-      File.open(@temporary_path.join('pass.json'), 'w') { |f| f.write(pass.to_json) }
+      File.write(@temporary_path.join("pass.json"), pass.to_json)
     end
 
     # rubocop:enable Metrics/AbcSize
 
     def generate_json_manifest
       manifest = {}
-      Dir.glob(@temporary_path.join('**')).each do |file|
+      Dir.glob(@temporary_path.join("**")).each do |file|
         manifest[File.basename(file)] = Digest::SHA1.hexdigest(File.read(file))
       end
 
-      @manifest_url = @temporary_path.join('manifest.json')
-      File.open(@manifest_url, 'w') { |f| f.write(manifest.to_json) }
+      @manifest_url = @temporary_path.join("manifest.json")
+      File.write(@manifest_url, manifest.to_json)
     end
 
-    CERTIFICATE = Rails.root.join(ENV['PASSKIT_PRIVATE_P12_CERTIFICATE'])
-    INTERMEDIATE_CERTIFICATE = Rails.root.join(ENV['APPLE_INTERMEDIATE_CERTIFICATE'])
-    CERTIFICATE_PASSWORD = ENV['PASSKIT_CERTIFICATE_KEY']
+    CERTIFICATE = Rails.root.join(ENV["PASSKIT_PRIVATE_P12_CERTIFICATE"])
+    INTERMEDIATE_CERTIFICATE = Rails.root.join(ENV["PASSKIT_APPLE_INTERMEDIATE_CERTIFICATE"])
+    CERTIFICATE_PASSWORD = ENV["PASSKIT_CERTIFICATE_KEY"]
 
     # :nocov:
     def sign_manifest
@@ -90,21 +98,21 @@ module Passkit
 
       flag = OpenSSL::PKCS7::DETACHED | OpenSSL::PKCS7::BINARY
       signed = OpenSSL::PKCS7.sign(p12_certificate.certificate,
-                                   p12_certificate.key, File.read(@manifest_url),
-                                   [intermediate_certificate], flag)
+        p12_certificate.key, File.read(@manifest_url),
+        [intermediate_certificate], flag)
 
-      @signature_url = @temporary_path.join('signature')
-      File.open(@signature_url, 'w') { |f| f.syswrite signed.to_der }
+      @signature_url = @temporary_path.join("signature")
+      File.open(@signature_url, "w") { |f| f.syswrite signed.to_der }
     end
 
     # :nocov:
 
     def compress_pass_file
       zip_path = TMP_FOLDER.join("#{@pass.file_name}.pkpass")
-      zipped_file = File.open(zip_path, 'w')
+      zipped_file = File.open(zip_path, "w")
 
       Zip::OutputStream.open(zipped_file.path) do |z|
-        Dir.glob(@temporary_path.join('**')).each do |file|
+        Dir.glob(@temporary_path.join("**")).each do |file|
           z.put_next_entry(File.basename(file))
           z.print File.read(file)
         end

data/lib/passkit/payload_generator.rb

@@ -0,0 +1,18 @@
+module Passkit
+  class PayloadGenerator
+    VALIDITY = 30.days
+
+    def self.encrypted(pass_class, generator = nil)
+      UrlEncrypt.encrypt(hash(pass_class, generator))
+    end
+
+    def self.hash(pass_class, generator = nil)
+      valid_until = VALIDITY.from_now
+
+      {valid_until: valid_until,
+       generator_class: generator&.class&.name,
+       generator_id: generator&.id,
+       pass_class: pass_class.name}
+    end
+  end
+end

data/lib/passkit/url_encrypt.rb

@@ -7,13 +7,13 @@ module Passkit
         cipher.key = encryption_key
         s = cipher.update(string) + cipher.final
 
-        s.unpack1('H*').upcase
+        s.unpack1("H*").upcase
       end
 
       def decrypt(string)
         cipher = cypher.decrypt
         cipher.key = encryption_key
-        s = [string].pack('H*').unpack('C*').pack('c*')
+        s = [string].pack("H*").unpack("C*").pack("c*")
 
         JSON.parse(cipher.update(s) + cipher.final, symbolize_names: true)
       end
@@ -25,7 +25,7 @@ module Passkit
       end
 
       def cypher
-        OpenSSL::Cipher.new('AES-128-CBC')
+        OpenSSL::Cipher.new("AES-128-CBC")
       end
     end
   end

data/lib/passkit/url_generator.rb

@@ -0,0 +1,20 @@
+module Passkit
+  class UrlGenerator
+    include Passkit::Engine.routes.url_helpers
+
+    def initialize(pass_class, generator = nil)
+      @url = passes_api_url(host: ENV["PASSKIT_WEB_SERVICE_HOST"],
+        payload: PayloadGenerator.encrypted(pass_class, generator))
+    end
+
+    def ios
+      @url
+    end
+
+    WALLET_PASS_PREFIX = "https://walletpass.io?u=".freeze
+    # @see https://walletpasses.io/developer/
+    def android
+      "#{WALLET_PASS_PREFIX}#{@url}"
+    end
+  end
+end

data/lib/passkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Passkit
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/passkit.rb

@@ -1,9 +1,43 @@
 # frozen_string_literal: true
 
-require_relative "passkit/version"
-require 'passkit/engine'
+require "rails"
+require "passkit/engine"
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/generators")
+loader.setup
 
 module Passkit
   class Error < StandardError; end
-  # Your code goes here...
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :available_passes,
+      :web_service_host,
+      :certificate_key,
+      :private_p12_certificate,
+      :apple_intermediate_certificate,
+      :apple_team_identifier,
+      :pass_type_identifier
+
+    def initialize
+      @available_passes = {"Passkit::ExampleStoreCard" => -> {}}
+      @web_service_host = ENV["PASSKIT_WEB_SERVICE_HOST"] || (raise "Please set PASSKIT_WEB_SERVICE_HOST")
+      raise("PASSKIT_WEB_SERVICE_HOST must start with https://") unless @web_service_host.start_with?("https://")
+      @certificate_key = ENV["PASSKIT_CERTIFICATE_KEY"] || (raise "Please set PASSKIT_CERTIFICATE_KEY")
+      @private_p12_certificate = ENV["PASSKIT_PRIVATE_P12_CERTIFICATE"] || (raise "Please set PASSKIT_PRIVATE_P12_CERTIFICATE")
+      @apple_intermediate_certificate = ENV["PASSKIT_APPLE_INTERMEDIATE_CERTIFICATE"] || (raise "Please set PASSKIT_APPLE_INTERMEDIATE_CERTIFICATE")
+      @apple_team_identifier = ENV["PASSKIT_APPLE_TEAM_IDENTIFIER"] || (raise "Please set PASSKIT_APPLE_TEAM_IDENTIFIER")
+      @pass_type_identifier = ENV["PASSKIT_PASS_TYPE_IDENTIFIER"] || (raise "Please set PASSKIT_PASS_TYPE_IDENTIFIER")
+    end
+  end
 end

data/sig/lib/passkit/encryptable_payload.rbs

@@ -0,0 +1,5 @@
+module Passkit
+  class EncryptablePayload
+    def to_json: () -> Hash[Symbol, String]
+  end
+end

data/sig/lib/passkit/factory.rbs

@@ -0,0 +1,5 @@
+module Passkit
+  class Factory
+    def self.create_pass: (String pass_class, Passkit::GeneratorObject ?generator) -> String
+  end
+end