passkit 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abe44c75069e0fc397f9a1f7155dd811a0341de723223ca3fdfbe7543b9a8a6c
-  data.tar.gz: c8a36754d91a1dd241064cdf0e5b3d3defbf5df54d13c3135bf56b5dc8564b19
+  metadata.gz: 37dfbf2ceba4423e2a1eba28d94aa8f5fbf676c011429efb8759af2f7fd8c477
+  data.tar.gz: 5909695a00d94a28da5f4ae1ee318a1d7d7320c8599646457a408b7c2a780af0
 SHA512:
-  metadata.gz: 1137d58cf9f2b560a0363ab2c14868eca913960bd1eea70e3737dcdc5cff3411de06a72988ffce0cb910d14ab30de68502da3542bbe48d4f17e262b1c3c48f8e
-  data.tar.gz: 4d6e5d66d65705b8b01c84820559b4244be5ad1f9ea71ec58b9c86fd133933bea766783c192250571cc80ad28c4b90c0e57e22affc8bbdfeff8c9ded6cbc3827
+  metadata.gz: 637340fef65ed2655a1e8bedaf9d86a5ece533782bbd6c3c92a26d2e49d5153de1be57e27977994b13b63e1f47a2b39b30e481c57539771b8c06b3f2db4b6691
+  data.tar.gz: 5350a3793c359fbbf00d197541e7b51577c93c46c68068f8e0f7cb852ff46f6c9d1f60e4a3a8c00fc66a52c82c6e95b94b768ff602b1c188bb887f3128214821

data/.example.env

@@ -0,0 +1,6 @@
+PASSKIT_WEB_SERVICE_HOST=https://localhost:3000
+PASSKIT_CERTIFICATE_KEY=path/to/certificate.key
+PASSKIT_PRIVATE_P12_CERTIFICATE=path/to/certificate.p12
+PASSKIT_APPLE_INTERMEDIATE_CERTIFICATE=path/to/AppleWWDRCA.cer
+PASSKIT_APPLE_TEAM_IDENTIFIER=XXXXXXXXXX
+PASSKIT_PASS_TYPE_IDENTIFIER=pass.com.example.pass

data/README.md

@@ -4,24 +4,28 @@ Your out-of-the-box solution to start serving Wallet Passes in your Ruby On Rail
 
 Do you have a QRCode or a Barcode anywhere in your app that you want to distribute as Wallet Pass, compatible for iOS and Android? Look no further!
 
-This gem provides everything that is necessary, and gives you all the steps to follow for what we cannot provide.
+This gem provides everything necessary to distribute Wallet Passes in pkpass format, and gives you all the steps to follow for what we cannot provide.
 
-We provide:
+**We provide:**
 
-* A (not yet) fancy dashboard to manage your passes, registered devices and logs
+* A (not yet) fancy dashboard to manage your passes, registered devices and logs.
 * All API endpoints to serve your passes: create, register, update, unregister, etc...
-* All ActiveRecord models necessary
-* A BasePass model that you can extend to create your own passes
-* Some helpers to generate the necessary URLs, so that you can include them in the emails
-* Examples for everything
+* All necessary ActiveRecord models.
+* A BasePass model that you can extend to create your own passes.
+* Some helpers to generate the necessary URLs, so that you can include them in the emails.
+* Examples for everything.
 
-We don't provide yet (WIP):
+**We don't provide (yet):**
 
-* Full tests coverage. We are working on it!
-* A fancy dashboard. Pull requests are welcome!
-* Push notifications. Pull requests are welcome!
-* Google Wallet passes. We use https://walletpasses.io/ on Android to read .pkpass format.
+* Full tests coverage: we are working on it!
+* A fancy dashboard: our dashboard is really really simple right now. Pull requests are welcome!
+* Push notifications: this is the most wanted feature I believe. Pull requests are welcome!
+* Google Wallet integration: we use https://walletpasses.io/ on Android to read .pkpass format.
 
+## Apple documentation
+
+* [Apple Wallet Passes](https://developer.apple.com/documentation/walletpasses)
+* [Send Push Notifications](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns)
 
 ## Installation
 
@@ -45,18 +49,18 @@ Run the initializer:
 
 that will generate the migrations and the initializer file.
 
-Mount the engine in your routes.rb:
+Mount the engine in your `config/routes.rb`:
 
 ```ruby
 mount Passkit::Engine => '/passkit', as: 'passkit'
 ```
 
-and run `rails db:migrate`.
+and run `bin/rails db:migrate`.
 
-## Usage
+### Setup environment variables
 
-If you followed the installation steps, you already saw that Passkit provides 
-you the tables and ActiveRecord models, and also an engine the necessary APIs already implemented.
+If you followed the installation steps, you already saw that Passkit provides
+you the tables and ActiveRecord models, and also an engine with the necessary APIs already implemented.
 
 Now is your turn. Before proceeding, you need to set these ENV variables:
 * `PASSKIT_WEB_SERVICE_HOST`
@@ -67,14 +71,19 @@ Now is your turn. Before proceeding, you need to set these ENV variables:
 * `PASSKIT_PASS_TYPE_IDENTIFIER`
 
 We have a [specific guide on how to get all these](docs/passkit_environment_variables.md), please follow it.
-You cannot do any of the following steps without these variables set, and we cannot do the work for you there.
+You cannot start using this library without these variables set, and we cannot do the work for you.
 
-### Check what is available
+## Usage
 
 If you followed the installation steps and you have the ENV variables set, we can start looking at what is provided for you.
 
-Head to `http://localhost:3000/passkit/previews` and you will see a first ExampleStoreCard available for download.
+### Dashboard
+
+Head to `http://localhost:3000/passkit/previews` and you will see a first `ExampleStoreCard` available for download.
 You can click on the button and you will obtain a `.pkpass` file that you can simply open or install on your phone.
+The dashboard has also a view for logs, and a view for emitted passes.
+
+### Mailer Helpers
 
 If you use mailer previews, you can create the following file in `spec/mailers/previews/passkit/example_mailer_preview.rb`:
 
@@ -89,21 +98,28 @@ end
 ```
 
 and head to `http://localhost:3000/rails/mailers/` to see an example of email with links to download the Wallet Pass.
+Please check the source code of [ExampleMailer](app/mailers/passkit/example_mailer.rb) to see how to distribute your own Wallet Passes.
+
+### Example Passes
+
+Please check the source code of the [ExampleStoreCard](lib/passkit/example_store_card.rb) to see how to create your own Wallet Passes.
 
-Please check the source code of the [ExampleStoreCard](lib/passkit/example_store_card.rb) and [ExampleMailer](app/mailers/passkit/example_mailer.rb) to see how to create and distribute your own Wallet Passes.
-Looking at the examples, is the easiest way to get started.
+Again, looking at these examples, is the easiest way to get started.
 
 ### Create your own Wallet Pass
 
-You can create your own Wallet Passes by creating a new class that inherits from `Passkit::BasePass` and defining the methods that you want to override.
+You can create your own Wallet Passes by creating a new class that inherits from `Passkit::BasePass` and 
+defining the methods that you want to override.
+
 You can define colors, fields and texts. You can also define the logo and the background image.
 
-You can place the images in a 'private/passkit/<your_downcased_passname>' folder.
+You should place the images in a 'private/passkit/<your_downcased_passname>' folder.
 There is a [dummy app in the gem](test/dummy) that you can use to check how to create your own Wallet Passes.
 
 ### 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:
+Use the [Passkit::UrlGenerator](lib/passkit/url_generator.rb) to generate the URL to serve your Wallet Pass. 
+You can initialize it with:
 
 ```ruby
 Passkit::UrlGenerator.new(pass_class: Passkit::MyPass, generator: User.find(1))
@@ -119,21 +135,6 @@ Again, check the example mailer included in the gem to see how to use it.
 * 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.
 
-
-* Setup ngrok and start it
-* Configure your `HOST: 'https://xxx.ngrok.io'` on `config/application.yml` (make sure is https!)
-* Set `config.hosts = nil` in `config/environments/development.rb`
-* Head to the `/rails/mailers/` and preview an email containing a pass
-* Download the pkpass and open it
-
-
- Here are the rough steps to generate a new one:
-* Access https://developer.apple.com/account/resources/identifiers/passTypeId/edit/F578W7LDT9/pass.ch.renuo.loyalty.
-* Click "Create Certificate".
-* Follow the guide to generate a new Certificate Signing Request and use operations@renuo.ch as email address and Renuo AG as organization name.
-* Convert the certificate to p12 using Keychain Access and re-use the same password.
-* Re-upload the new certificate to the servers.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -154,4 +155,6 @@ Everyone interacting in the Passkit project's codebases, issue trackers, chat ro
 
 ## Credits
 
-<a href="https://www.flaticon.com/free-icons/credit-card" title="credit card icons">Credit card icons created by Iconfromus - Flaticon</a>
+* <a href="https://www.flaticon.com/free-icons/credit-card" title="credit card icons">Credit card icons created by Iconfromus - Flaticon</a>
+
+* https://www.sitepoint.com/whats-in-your-wallet-handling-ios-passbook-with-ruby/

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

@@ -12,7 +12,7 @@ module Passkit
         # @return If the request is not authorized, returns HTTP status 401.
         # @return Otherwise, returns the appropriate standard HTTP status.
         def show
-          authentication_token = request.headers["Authorization"]&.split(" ") & [1]
+          authentication_token = request.headers["Authorization"]&.split(" ")&.last
           unless authentication_token.present?
             render json: {}, status: :unauthorized
             return
@@ -26,9 +26,9 @@ module Passkit
 
           pass_output_path = Passkit::Generator.new(pass).generate_and_sign
 
-          response.headers["last-modified"] = pass.generator.updated_at.strftime("%Y-%m-%d %H:%M:%S")
+          response.headers["last-modified"] = pass.last_update.strftime("%Y-%m-%d %H:%M:%S")
           if request.headers["If-Modified-Since"].nil? ||
-              (pass.generator.updated_at.to_i > Time.zone.parse(request.headers["If-Modified-Since"]).to_i)
+              (pass.last_update.to_i > Time.zone.parse(request.headers["If-Modified-Since"]).to_i)
             send_file(pass_output_path)
           else
             head :not_modified
@@ -45,9 +45,12 @@ module Passkit
         end
 
         def fetch_pass(payload)
-          generator_class = payload[:generator_class].constantize
-          generator = generator_class.find(payload[:generator_id])
-          Passkit::Factory.create_pass(generator, payload[:pass_class])
+          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)
         end
       end
     end

data/app/controllers/passkit/api/v1/registrations_controller.rb

@@ -61,7 +61,7 @@ module Passkit
         private
 
         def load_pass
-          authentication_token = request.headers["Authorization"]&.split(" ") & [1]
+          authentication_token = request.headers["Authorization"]&.split(" ")&.last
           unless authentication_token.present?
             render json: {}, status: :unauthorized
             return

data/app/models/passkit/pass.rb

@@ -41,5 +41,9 @@ module Passkit
     def instance
       @instance ||= klass.constantize.new(generator)
     end
+
+    def last_update
+      instance.last_update || updated_at
+    end
   end
 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/passkit/base_pass.rb

@@ -20,6 +20,10 @@ module Passkit
       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

data/lib/passkit/factory.rb

@@ -1,8 +1,8 @@
 module Passkit
   class Factory
     class << self
-      def create_pass(generator, pass_class)
-        pass = Pass.create!(generator: generator, klass: pass_class)
+      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/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_generator.rb

@@ -2,16 +2,9 @@ module Passkit
   class UrlGenerator
     include Passkit::Engine.routes.url_helpers
 
-    VALIDITY = 30.days
-
     def initialize(pass_class, generator = nil)
-      valid_until = VALIDITY.from_now
-
-      payload = {valid_until: valid_until,
-                 generator_class: generator&.class&.name,
-                 generator_id: generator&.id,
-                 pass_class: pass_class.name}
-      @url = passes_api_url(host: ENV["PASSKIT_WEB_SERVICE_HOST"], payload: UrlEncrypt.encrypt(payload))
+      @url = passes_api_url(host: ENV["PASSKIT_WEB_SERVICE_HOST"],
+        payload: PayloadGenerator.encrypted(pass_class, generator))
     end
 
     def ios

data/lib/passkit/version.rb

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

data/lib/passkit.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "rails"
 require "passkit/engine"
 
 require "zeitwerk"
@@ -31,7 +32,7 @@ module Passkit
     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.starts_with?("https://")
+      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")

data/sig/lib/passkit/factory.rbs

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passkit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-30 00:00:00.000000000 Z
+date: 2022-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".example.env"
 - ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -123,6 +138,13 @@ files:
 - bin/console
 - bin/setup
 - config/routes.rb
+- docs/membership.png
+- docs/passkit_environment_variables.md
+- docs/step1.png
+- docs/step2.png
+- docs/step3.png
+- docs/step4.png
+- docs/step5.png
 - docs/wallet.png
 - lib/generators/passkit/install_generator.rb
 - lib/generators/templates/create_passkit_tables.rb.tt
@@ -137,9 +159,11 @@ files:
 - lib/passkit/example_store_card/logo.png
 - lib/passkit/factory.rb
 - lib/passkit/generator.rb
+- lib/passkit/payload_generator.rb
 - lib/passkit/url_encrypt.rb
 - lib/passkit/url_generator.rb
 - lib/passkit/version.rb
+- passkit-0.2.0.gem
 - sig/lib/passkit/encryptable_payload.rbs
 - sig/lib/passkit/factory.rbs
 - sig/lib/passkit/generator.rbs