Many tickets (coorasse#27)

* Enhanced examples

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

* fix dev host

* Enable multiple passes/tickets in a single link

* Update test/api/v1/test_passes_controller.rb

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

---------

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

Author: annaswims

README.md

@@ -136,12 +136,19 @@ to be included in the pass.
 ### Serve your Wallet Pass
 
 Use the [Passkit::UrlGenerator](lib/passkit/url_generator.rb) to generate the URL to serve your Wallet Pass.
-You can initialize it with:
+For one pass, you can initialize it with:
 
 ```ruby
 Passkit::UrlGenerator.new(Passkit::MyPass, User.find(1))
 ```
 
+For one passes, you can initialize it with:
+
+```ruby
+Passkit::UrlGenerator.new(Passkit::UserTicket, User.find(1), :tickets)
+```
+(this presumes you have `User.find(1).tickets` would return the ticket records)
+
 and then use `.android` or `.ios` to get the URL to serve the Wallet Pass.
 Again, check the example mailer included in the gem to see how to use it.
 

app/controllers/passkit/api/v1/passes_controller.rb

@@ -5,7 +5,18 @@ class PassesController < ActionController::API
         before_action :decrypt_payload, only: :create
 
         def create
-          send_file(fetch_pass(@payload), type: "application/vnd.apple.pkpass", disposition: "attachment")
+          set_generator
+
+          if @generator && @payload[:collection_name].present?
+            files = @generator.public_send(@payload[:collection_name]).collect do |collection_item|
+              Passkit::Factory.create_pass(@payload[:pass_class], collection_item)
+            end
+            file = Passkit::Generator.compress_passes_files(files)
+            send_file(file, type: 'application/vnd.apple.pkpasses', disposition: 'attachment')
+          else
+            file = Passkit::Factory.create_pass(@payload[:pass_class], @generator)
+            send_file(file, type: 'application/vnd.apple.pkpass', disposition: 'attachment')
+          end
         end
 
         # @return If request is authorized, returns HTTP status 200 with a payload of the pass data.
@@ -44,13 +55,13 @@ def decrypt_payload
           end
         end
 
-        def fetch_pass(payload)
-          generator = nil
-          if payload[:generator_class].present? && payload[:generator_id].present?
-            generator_class = payload[:generator_class].constantize
-            generator = generator_class.find(payload[:generator_id])
-          end
-          Passkit::Factory.create_pass(payload[:pass_class], generator)
+        def set_generator
+          @generator = nil
+
+          return unless @payload[:generator_class].present? && @payload[:generator_id].present?
+
+          generator_class = @payload[:generator_class].constantize
+          @generator = generator_class.find(@payload[:generator_id])
         end
       end
     end

lib/passkit/base_pass.rb

@@ -95,7 +95,8 @@ def voided
     def add_other_files(path)
     end
 
-    # Distance in meters from locations; if blank uses pass default
+    # Distance in meters from locations; if blank uses pass default.
+    # The system uses the smaller of either this distance or the default distance.
     def max_distance
     end
 

lib/passkit/generator.rb

@@ -23,6 +23,19 @@ def generate_and_sign
       compress_pass_file
     end
 
+    def self.compress_passes_files(files)
+      zip_path = TMP_FOLDER.join("#{SecureRandom.uuid}.pkpasses")
+      zipped_file = File.open(zip_path, "w")
+
+      Zip::OutputStream.open(zipped_file.path) do |z|
+        files.each do |file|
+          z.put_next_entry(File.basename(file))
+          z.print File.read(file)
+        end
+      end
+      zip_path
+    end
+
   private
 
     def check_necessary_files

lib/passkit/payload_generator.rb

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

lib/passkit/url_generator.rb

@@ -2,9 +2,9 @@ module Passkit
   class UrlGenerator
     include Passkit::Engine.routes.url_helpers
 
-    def initialize(pass_class, generator = nil)
+    def initialize(pass_class, generator = nil, collection_name = nil)
       @url = passes_api_url(host: ENV["PASSKIT_WEB_SERVICE_HOST"],
-        payload: PayloadGenerator.encrypted(pass_class, generator))
+        payload: PayloadGenerator.encrypted(pass_class, generator, collection_name))
     end
 
     def ios

test/api/v1/test_passes_controller.rb

@@ -18,6 +18,17 @@ def test_create
     assert_equal 7, zip_file.size
   end
 
+  def test_create_collection
+    payload = Passkit::PayloadGenerator.encrypted(Passkit::UserTicket, User.find(1), :tickets)
+    get passes_api_path(payload)
+    assert_response :success
+    assert_equal 2, Passkit::Pass.count
+    unzipped_passes = Zip::File.open_buffer(StringIO.new(response.body))
+    assert_equal 2, unzipped_passes.size # the main zip file contains two passes
+    unzipped_pass =  Zip::File.open_buffer(unzipped_passes.first.zipfile)
+    assert_includes unzipped_passes.first.name, '.pkpass'
+  end
+
   def test_show
     _pkpass = Passkit::Factory.create_pass(Passkit::ExampleStoreCard)
     assert_equal 1, Passkit::Pass.count

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

@@ -0,0 +1,111 @@
+module Passkit
+  class UserTicket < BasePass
+    def pass_type
+      :eventTicket
+    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: "#{@generator.name}@hey.com"
+        }]
+    end
+
+  private
+
+    def folder_name
+      'user_store_card'
+    end
+  end
+end

test/dummy/test/fixtures/tickets.yml

@@ -0,0 +1,11 @@
+first_ticket:
+  name: FirstUser Ticket1
+  user_id: 1
+
+second_ticket:
+  name: FirstUser Ticket2
+  user_id: 1
+
+third_ticket:
+  name: SecondUser Ticket1
+  user_id: 2

test/dummy/test/fixtures/users.yml

@@ -0,0 +1,7 @@
+one:
+  id: 1
+  name: first user
+
+two:
+  id: 2
+  name: second user

test/rails_helper.rb

@@ -19,7 +19,6 @@
 
 # Load fixtures from the engine
 if ActiveSupport::TestCase.respond_to?(:fixture_path=)
-  ActiveSupport::TestCase.fixture_path = File.expand_path("fixtures", __dir__)
   ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
   ActiveSupport::TestCase.file_fixture_path = ActiveSupport::TestCase.fixture_path + "/files"
   ActiveSupport::TestCase.fixtures :all