Enhanced examples (coorasse#26)

* Enhanced examples

* create an example with user data
* fix date formatting in example
* remove invalid app_launch_url from example

* fix dev host

* fix example PASSKIT_CERTIFICATE_KEY

* Update lib/passkit/base_pass.rb

Co-authored-by: Alessandro Rodi <[email protected]>

---------

Co-authored-by: Alessandro Rodi <[email protected]>

Author: annaswims

.example.env

@@ -1,5 +1,5 @@
 PASSKIT_WEB_SERVICE_HOST=https://localhost:3000
-PASSKIT_CERTIFICATE_KEY=path/to/certificate.key
+PASSKIT_CERTIFICATE_KEY=theCertPassword
 PASSKIT_PRIVATE_P12_CERTIFICATE=path/to/certificate.p12
 PASSKIT_APPLE_INTERMEDIATE_CERTIFICATE=path/to/AppleWWDRCA.cer
 PASSKIT_APPLE_TEAM_IDENTIFIER=XXXXXXXXXX

.gitignore

@@ -8,7 +8,7 @@
 /tmp/
 Gemfile.lock
 .env
-test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3*
 test/dummy/log/*.log
 test/dummy/tmp/
 *.gem

README.md

@@ -148,7 +148,7 @@ Again, check the example mailer included in the gem to see how to use it.
 ## Debug issues 
 
 * On Mac, open the `Console.app` to view the errors.
-* Check the logs on http://localhost:3000/passkit/logs
+* Check the logs on http://localhost:3000/passkit/dashboard/logs
 * In case of error "The passTypeIdentifier or teamIdentifier provided may not match your certificate, 
 or the certificate trust chain could not be verified." the certificate (p12) might be expired.
 

lib/passkit/base_pass.rb

@@ -143,7 +143,8 @@ def event_ticket
 
     # Date and time the pass expires, must include
     # days, hours and minutes (seconds are optional)
-    # Returns a String representing the date and time in W3C format ("%Y-%m-%dT%H:%M:%S%z")
+    # Returns a String representing the date and time in W3C format ('%Y-%m-%dT%H:%M:%S%:z')
+    # For example, 1980-05-07T10:30-05:00.
     def expiration_date
     end
 
@@ -167,7 +168,7 @@ def nfc
     # Date and time when the pass becomes relevant and should be
     # displayed, must include days, hours and minutes
     # (seconds are optional)
-    # Returns a String representing the date and time in W3C format ("%Y-%m-%dT%H:%M:%S%z")
+    # Returns a String representing the date and time in W3C format ('%Y-%m-%dT%H:%M:%S%:z')
     def relevant_date
     end
 

lib/passkit/example_store_card.rb

@@ -58,17 +58,13 @@ def logo_text
       "Loyalty Card"
     end
 
-    def app_launch_url
-      "https://github.com/coorasse/passkit"
-    end
-
     def relevant_date
-      Time.current.strftime("%Y-%m-%dT%H:%M:%S%z")
+      Time.current.strftime('%Y-%m-%dT%H:%M:%S%:z')
     end
 
     def expiration_date
       # Expire the pass tomorrow
-      (Time.current + 60*60*24).strftime("%Y-%m-%dT%H:%M:%S%z")
+      (Time.current + 1.day).strftime('%Y-%m-%dT%H:%M:%S%:z')
     end
 
     def semantics

test/dummy/app/lib/passkit/user_store_card.rb

@@ -0,0 +1,116 @@
+module Passkit
+  class UserStoreCard < BasePass
+    def pass_type
+      :storeCard
+    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
+      [
+        { latitude: 41.2273414693647, longitude: -95.92925748878405 }, # North Entrance
+        { latitude: 41.22476226066285, longitude: -95.92879374051269 } # Main Entrance
+      ]
+    end
+
+    def file_name
+      @file_name ||= SecureRandom.uuid
+    end
+
+    # QRCode by default
+    def barcodes
+      [
+        { 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 expiration_date
+      # Expire the pass tomorrow
+      (Time.current + 60*60*24).strftime('%Y-%m-%dT%H:%M:%S%:z')
+    end
+
+    def semantics
+      {
+        balance: {
+          amount: "100",
+          currencyCode: "USD"
+        }
+      }
+    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: "[email protected]"
+        }]
+    end
+
+    def auxiliary_fields
+      [{
+        key: "name",
+        label: "Name",
+        value: @generator.name
+      },
+        {
+          key: "email",
+          label: "Email",
+          value: "[email protected]"
+        },
+        {
+          key: "phone",
+          label: "Phone",
+          value: "+41 1234567890"
+        }]
+    end
+
+  private
+
+    def folder_name
+      self.class.name.demodulize.underscore
+    end
+  end
+end

test/dummy/app/models/ticket.rb

@@ -0,0 +1,3 @@
+class Ticket < ApplicationRecord
+  belongs_to :user
+end

test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ApplicationRecord
+  has_many :tickets
+end

test/dummy/config/environments/development.rb

@@ -67,4 +67,6 @@
 
   # Uncomment if you wish to allow Action Cable access from any origin.
   # config.action_cable.disable_request_forgery_protection = true
+
+  config.hosts << URI.parse(ENV.fetch("PASSKIT_WEB_SERVICE_HOST")).host
 end

test/dummy/config/initializers/passkit.rb

@@ -1,2 +1,3 @@
-Passkit.configure do |_config|
+Passkit.configure do |config|
+  config.available_passes['Passkit::UserStoreCard'] = -> { User.create!(name: "ExampleName") }
 end

test/dummy/db/migrate/20240411013524_create_users.rb

@@ -0,0 +1,9 @@
+class CreateUsers < ActiveRecord::Migration[7.1]
+  def change
+    create_table :users do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

test/dummy/db/migrate/20240411013721_create_tickets.rb

@@ -0,0 +1,10 @@
+class CreateTickets < ActiveRecord::Migration[7.1]
+  def change
+    create_table :tickets do |t|
+      t.string :name
+      t.references :user, null: false, foreign_key: true
+
+      t.timestamps
+    end
+  end
+end

test/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 2022_09_23_124956) do
+ActiveRecord::Schema[7.1].define(version: 2024_04_11_013721) do
   create_table "passkit_devices", force: :cascade do |t|
     t.string "identifier"
     t.string "push_token"
@@ -45,4 +45,20 @@
     t.index ["passkit_device_id"], name: "index_passkit_registrations_on_passkit_device_id"
     t.index ["passkit_pass_id"], name: "index_passkit_registrations_on_passkit_pass_id"
   end
+
+  create_table "tickets", force: :cascade do |t|
+    t.string "name"
+    t.integer "user_id", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["user_id"], name: "index_tickets_on_user_id"
+  end
+
+  create_table "users", force: :cascade do |t|
+    t.string "name"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  add_foreign_key "tickets", "users"
 end

test/dummy/db/seeds.rb

@@ -0,0 +1,6 @@
+@user1 = User.create!(name: "First User")
+@user2 = User.create!(name: "Second User")
+
+Ticket.create!(name: "Ticket1", user: @user1)
+Ticket.create!(name: "Ticket2", user: @user1)
+Ticket.create!(name: "Ticket3", user: @user2)