passkit 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9497741a31a5d15fa1851b3e6fbb3630fdb4d6af850a3a8350f98dc48f22d48
-  data.tar.gz: 80eef27f99457b8c43636e447fcb80de4b550a6f34234a0df67cc53aa7a94d44
+  metadata.gz: 7f0014535dcee793bfad66fd1424eb76f7b93bd5125585c65a2fbbd0ed48e145
+  data.tar.gz: e96bd5782db486f9cdec37721094ed11307e7fda581aa21223c7300c1757cc2a
 SHA512:
-  metadata.gz: 78c6bb6a55584dcba885ea10e3a285bb594830a6fedbbc92d865cd50ff547010e0ae5a47435377f60ad06718e94494bc7fd66db6904a2d9897b296874f536aea
-  data.tar.gz: c8790f8dd33ae6d33fa557f9c2d4bec831be29f663e013941cd0bf1fe94ffac7f9fe41abc17034c77966cb2d2f778b811ea26051ea5599fa6f762d2acc24c614
+  metadata.gz: e1d58e15fff676e4dc197676d5d71d8814a21669086f90e9f19c8e136f64d47205c69b71ffd612efd3411f51d3f6014736571f4e64caab992fa308d737872cff
+  data.tar.gz: 5327cad119f6060ace0e4fe2d485d3df18c412d1e6d4cc652eeded28e77108f91b8a7a6b322caebd87581846ee2fc4c268cd6f5b93fe980d2e1e5d12b1339ba8

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.6.0]
+
+- [#20](https://github.com/coorasse/passkit/pull/20): Many new attributes added.
+
 ## [0.5.4]
 
 - Fix last-modified header format. Return it in RFC 2616 format.

data/app/models/passkit/pass.rb

@@ -7,30 +7,46 @@ module Passkit
     has_many :registrations, foreign_key: :passkit_pass_id
     has_many :devices, through: :registrations
 
-    delegate :file_name,
-      :pass_path,
-      :language,
-      :format_version,
-      :apple_team_identifier,
-      :foreground_color,
+    delegate :apple_team_identifier,
+      :app_launch_url,
+      :associated_store_identifiers,
+      :auxiliary_fields,
+      :back_fields,
       :background_color,
-      :label_color,
-      :web_service_url,
       :barcode,
-      :voided,
-      :organization_name,
+      :barcodes,
+      :beacons,
+      :boarding_pass,
+      :coupon,
       :description,
-      :logo_text,
+      :event_ticket,
+      :expiration_date,
+      :file_name,
+      :foreground_color,
+      :format_version,
+      :generic,
+      :grouping_identifier,
+      :header_fields,
+      :label_color,
+      :language,
       :locations,
-      :pass_type_identifier,
+      :logo_text,
+      :max_distance,
+      :nfc,
+      :organization_name,
+      :pass_path,
       :pass_type,
-      :header_fields,
+      :pass_type_identifier,
       :primary_fields,
+      :relevant_date,
       :secondary_fields,
-      :auxiliary_fields,
-      :back_fields,
+      :semantics,
       :sharing_prohibited,
-      :max_distance,
+      :store_card,
+      :suppress_strip_shine,
+      :user_info,
+      :voided,
+      :web_service_url,
       to: :instance
 
     before_validation on: :create do

data/docs/passkit_environment_variables.md

@@ -1,6 +1,6 @@
 # Setup Passkit Environment variables
 
-## `PASSKIT_WEB_SERVICE_HOST`
+### `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.
@@ -8,19 +8,19 @@ In production, it will simply be your domain name, but in development you can us
 
 **Remember that it must always start with `https://`.**
 
-## `PASSKIT_APPLE_INTERMEDIATE_CERTIFICATE`
+### `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.
+You might want to choose the one with the longest expiration date.
 
-
-## `PASSKIT_APPLE_TEAM_IDENTIFIER`
+### `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`
+### `PASSKIT_PASS_TYPE_IDENTIFIER`, `PASSKIT_PRIVATE_P12_CERTIFICATE` and `PASSKIT_CERTIFICATE_KEY`
 
 Head to your Apple Developers console and generate a new certificate.
 
@@ -40,9 +40,11 @@ And create the certificate:
 
 At the end, you'll have a `pass.cer` file.
 
-Open it in the Keychain Access tool and export it:
+Open it in the Keychain Access tool and export it (you must be in the My Certificates tab):
 
 ![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.
+
+`PKCS12_parse: unsupported`: you might encounter this issue: https://help.heroku.com/88GYDTB2/how-do-i-configure-openssl-to-allow-the-use-of-legacy-cryptographic-algorithms

data/lib/passkit/base_pass.rb

@@ -37,6 +37,9 @@ module Passkit
     def pass_type
       :storeCard
       # :coupon
+      # :eventTicket
+      # :generic
+      # :boardingPass
     end
 
     def web_service_url
@@ -83,16 +86,111 @@ module Passkit
     def max_distance
     end
 
+    # URL to launch the associated app (nil by default)
+    # Returns a String
+    def app_launch_url
+    end
+
+    # A list of Apple App Store identifiers for apps associated
+    # with the pass. The first one that is compatible with the
+    # device is picked.
+    # Returns an array of numbers
+    def associated_store_identifiers
+      []
+    end
+
+    # An array of barcodes, the first one that can
+    # be displayed on the device is picked.
+    # Returns an array of hashes representing Pass.Barcodes
+    def barcodes
+      []
+    end
+
+    # List of iBeacon identifiers to identify when the
+    # pass should be displayed.
+    # Returns an array of hashes representing Pass.Beacons
+    def beacons
+      []
+    end
+
+    # Information specific to a boarding pass
+    # Returns a hash representing Pass.BoardingPass
+    def boarding_pass
+    end
+
+    # Information specific to a coupon
+    # Returns a hash representing Pass.Coupon
+    def coupon
+    end
+
+    # Information specific to an event ticket
+    # Returns a hash representing Pass.EventTicket
+    def event_ticket
+    end
+
+    # 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
+    def expiration_date
+    end
+
+    # Information specific to a generic pass
+    # Returns a hash representing Pass.Generic
+    def generic
+    end
+
+    # A key to identify group multiple passes together
+    # (e.g. a number of boarding passes for the same trip)
+    # Returns a String
+    def grouping_identifier
+    end
+
+    # Information specific to Value Added Service Protocol
+    # transactions
+    # Returns a hash representing Pass.NFC
+    def nfc
+    end
+
+    # 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
+    def relevant_date
+    end
+
+    # Machine readable metadata that the device can use
+    # to suggest actions
+    # Returns a hash representing SemanticTags
+    def semantics
+    end
+
+    # Information specific to a store card
+    # Returns a hash representing Pass.StoreCard
+    def store_card
+    end
+
+    # Display the strip image without a shine effect
+    # Returns a boolean
+    def suppress_strip_shine
+      true
+    end
+
+    # JSON dictionary to display custom information for
+    # companion apps. Data isn't displayed to the user. e.g.
+    # a machine readable version of the user's favourite coffee
+    def user_info
+    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"}
+      { messageEncoding: "iso-8859-1",
+        format: "PKBarcodeFormatQR",
+        message: "https://github.com/coorasse/passkit",
+        altText: "https://github.com/coorasse/passkit" }
     end
 
     # Barcode example
@@ -131,7 +229,7 @@ module Passkit
       false
     end
 
-    private
+  private
 
     def folder_name
       self.class.name.demodulize.underscore

data/lib/passkit/example_store_card.rb

@@ -37,11 +37,13 @@ module Passkit
     end
 
     # QRCode by default
-    def barcode
-      {messageEncoding: "iso-8859-1",
-       format: "PKBarcodeFormatQR",
-       message: "https://github.com/coorasse/passkit",
-       altText: "https://github.com/coorasse/passkit"}
+    def barcodes
+      [
+        { messageEncoding: "iso-8859-1",
+          format: "PKBarcodeFormatQR",
+          message: "https://github.com/coorasse/passkit",
+          altText: "https://github.com/coorasse/passkit" }
+      ]
     end
 
     # Barcode example
@@ -56,6 +58,28 @@ module Passkit
       "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")
+    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",
@@ -101,7 +125,7 @@ module Passkit
         }]
     end
 
-    private
+  private
 
     def folder_name
       self.class.name.demodulize.underscore

data/lib/passkit/generator.rb

@@ -23,7 +23,7 @@ module Passkit
       compress_pass_file
     end
 
-    private
+  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"))
@@ -48,24 +48,49 @@ module Passkit
       pass = {
         formatVersion: @pass.format_version,
         teamIdentifier: @pass.apple_team_identifier,
-        foregroundColor: @pass.foreground_color,
+        authenticationToken: @pass.authentication_token,
         backgroundColor: @pass.background_color,
-        webServiceURL: @pass.web_service_url,
-        barcode: @pass.barcode,
-        voided: @pass.voided,
-        organizationName: @pass.organization_name,
         description: @pass.description,
-        logoText: @pass.logo_text,
-        locations: @pass.locations,
+        foregroundColor: @pass.foreground_color,
         labelColor: @pass.label_color,
-        sharingProhibited: @pass.sharing_prohibited,
-        serialNumber: @pass.serial_number,
+        locations: @pass.locations,
+        logoText: @pass.logo_text,
+        organizationName: @pass.organization_name,
         passTypeIdentifier: @pass.pass_type_identifier,
-        authenticationToken: @pass.authentication_token
+        serialNumber: @pass.serial_number,
+        sharingProhibited: @pass.sharing_prohibited,
+        suppressStripShine: @pass.suppress_strip_shine,
+        voided: @pass.voided,
+        webServiceURL: @pass.web_service_url
       }
 
       pass[:maxDistance] = @pass.max_distance if @pass.max_distance
 
+      # If the newer barcodes attribute has been used, then
+      # include the list of barcodes, otherwise fall back to
+      # the original barcode attribute
+      barcodes = @pass.barcodes || []
+      if barcodes.empty?
+        pass[:barcode] = @pass.barcode
+      else
+        pass[:barcodes] = @pass.barcodes
+      end
+
+      pass[:appLaunchURL] = @pass.app_launch_url if @pass.app_launch_url
+      pass[:associatedStoreIdentifiers] = @pass.associated_store_identifiers unless @pass.associated_store_identifiers.empty?
+      pass[:beacons] = @pass.beacons unless @pass.beacons.empty?
+      pass[:boardingPass] = @pass.boarding_pass if @pass.boarding_pass
+      pass[:coupon] = @pass.coupon if @pass.coupon
+      pass[:eventTicket] = @pass.event_ticket if @pass.event_ticket
+      pass[:expirationDate] = @pass.expiration_date if @pass.expiration_date
+      pass[:generic] = @pass.generic if @pass.generic
+      pass[:groupingIdentifier] = @pass.grouping_identifier if @pass.grouping_identifier
+      pass[:nfc] = @pass.nfc if @pass.nfc
+      pass[:relevantDate] = @pass.relevant_date if @pass.relevant_date
+      pass[:semantics] = @pass.semantics if @pass.semantics
+      pass[:store_card] = @pass.store_card if @pass.store_card
+      pass[:userInfo] = @pass.user_info if @pass.user_info
+
       pass[@pass.pass_type] = {
         headerFields: @pass.header_fields,
         primaryFields: @pass.primary_fields,

data/lib/passkit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passkit
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails