passkit 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 759d9f1d6698e06c21d68d76e55edfa52f4e6e687148b2e553709471158597db
-  data.tar.gz: 90453db3b78892ab6ec2df6466288242a23b782b7524734c92bf08f057fbc032
+  metadata.gz: c3980bb0fab949c93cc8821dd050f784f97f6a20b3ad9b16ac2c0a73a930529f
+  data.tar.gz: d0a4be1ab9846f71e4bc7806bb54a110519785c4d2086e33106eb83d5f0e06af
 SHA512:
-  metadata.gz: f3fa0b1df59c67f5ea94426c9c18bfcfd89aa90ed02a1499fc0e429ad666160a231b6a6b413c8a4399bcc5a8e0285d72d34d4a41e8aca433ca1ff8eb02e5963b
-  data.tar.gz: 17f3a2d0abd18a192f52757a1c256ea9d8645dbdba16bdc7aa921e9575194a1ce3c188f2ee698888697a374e9c672bf73c0305c242689897810cd7332aaf51ad
+  metadata.gz: 5b9cd2a244f8e5b7ffb9e14d18a6004080ea55e0b302f25862d2f23bd28ce7277ca062436100f6aeec638f0827bf78674ef63c22d7c82c852e3c32be139461ab
+  data.tar.gz: 5acf99ef60dc001f047e89771431bdb46fcf4417e70f76a9859df94520805a6b355109de4cc0eee67601ff5047f4825b6b753865120e25413864ce1480242933

data/.env.test

@@ -0,0 +1,8 @@
+PASSKIT_WEB_SERVICE_HOST=https://localhost:3000
+PASSKIT_CERTIFICATE_KEY=passkit
+PASSKIT_PRIVATE_P12_CERTIFICATE=certificates/certificate.p12
+PASSKIT_APPLE_INTERMEDIATE_CERTIFICATE=certificates/intermediate.cer
+PASSKIT_APPLE_TEAM_IDENTIFIER=XXXXXXXXXX
+PASSKIT_PASS_TYPE_IDENTIFIER=pass.com.example.pass
+PASSKIT_DASHBOARD_USERNAME=admin
+PASSKIT_DASHBOARD_PASSWORD=admin

data/.semaphore/release.yml

@@ -0,0 +1,21 @@
+version: "v1.0"
+name: Release gem
+agent:
+  machine:
+    type: f1-standard-2
+    os_image: ubuntu2204
+
+blocks:
+  - name: publish
+    execution_time_limit:
+      minutes: 10
+    task:
+      secrets:
+        - name: rubygems
+      jobs:
+        - name: build and push to rubygems.org
+          commands:
+            - checkout
+            - sem-version ruby 3.3
+            - gem build passkit.gemspec
+            - gem push passkit-*.gem < /dev/null

data/.semaphore/semaphore.yml

@@ -0,0 +1,42 @@
+version: "v1.0"
+name: passkit
+agent:
+  machine:
+    type: f1-standard-2
+    os_image: ubuntu2204
+auto_cancel:
+  running:
+    when: "true"
+
+blocks:
+  - name: tests
+    execution_time_limit:
+      minutes: 10
+    task:
+      env_vars:
+        - name: RAILS_ENV
+          value: test
+        - name: BUNDLE_PATH
+          value: vendor/bundle
+      prologue:
+        commands:
+          - checkout --use-cache
+          - sem-version ruby 3.3
+          - cache restore gems-$(checksum passkit.gemspec)-$(checksum Gemfile)
+          - bundle install -j 4
+          - cache store gems-$(checksum passkit.gemspec)-$(checksum Gemfile) vendor/bundle
+          - bin/generate_test_certificates
+      jobs:
+        - name: linter
+          commands:
+            - bundle exec standardrb
+        - name: tests
+          commands:
+            - bundle exec rake test
+        - name: system tests
+          commands:
+            - bundle exec rake test:system
+
+promotions:
+  - name: Release gem
+    pipeline_file: release.yml

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.8.2]
+- Set up the Semaphore CI pipeline with a manual promotion to release the gem.
+- Self-signed certificates for the test suite, so it runs without an Apple Developer certificate.
+- Code formatting cleanup (standardrb).
+- Relax the `sqlite3` development dependency to `>= 1.4`.
+
+## [0.8.1]
+- [#45](https://github.com/coorasse/passkit/pull/45): Fix broken build.
+
 ## [0.8.0]
 - [#36](https://github.com/coorasse/passkit/pull/36): More flexible configuration parameters.
 - [#44](https://github.com/coorasse/passkit/pull/44): Add `stripColor` option.

data/README.md

@@ -188,9 +188,15 @@ or the certificate trust chain could not be verified." the certificate (p12) mig
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies and to generate the self-signed certificates
+used to sign the passes in the test suite. Then, run `rake test` to run the tests and `rake test:system` to run the
+system tests (they require Chrome). You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+The test suite reads its configuration from `.env.test`, so no Apple Developer certificate is needed to run it.
+Values defined in your own `.env` take precedence, in case you want to run the dummy app with real certificates.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/Rakefile

@@ -9,6 +9,12 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
+Rake::TestTask.new("test:system") do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/system/**/*_test.rb"]
+end
+
 require "standard/rake"
 
 task default: %i[test standard]

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

@@ -12,10 +12,10 @@ module Passkit
               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')
+            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')
+            send_file(file, type: "application/vnd.apple.pkpass", disposition: "attachment")
           end
         end
 

data/app/models/passkit/pass.rb

@@ -39,7 +39,7 @@ module Passkit
       :secondary_fields,
       :semantics,
       :sharing_prohibited,
-      :strip_color
+      :strip_color,
       :suppress_strip_shine,
       :user_info,
       :voided,

data/bin/generate_test_certificates

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Generates a self-signed pass certificate and a fake "Apple intermediate"
+# certificate, so that the test suite can sign passes without a real Apple
+# Developer certificate.
+
+require "openssl"
+require "fileutils"
+
+output_directory = File.expand_path("../test/dummy/certificates", __dir__)
+password = ENV.fetch("PASSKIT_CERTIFICATE_KEY", "passkit")
+
+FileUtils.mkdir_p(output_directory)
+
+intermediate_key = OpenSSL::PKey::RSA.new(2048)
+intermediate_certificate = OpenSSL::X509::Certificate.new
+intermediate_certificate.version = 2
+intermediate_certificate.serial = 1
+intermediate_certificate.subject = OpenSSL::X509::Name.parse("/CN=Passkit Test Intermediate CA")
+intermediate_certificate.issuer = intermediate_certificate.subject
+intermediate_certificate.public_key = intermediate_key.public_key
+intermediate_certificate.not_before = Time.now - 60
+intermediate_certificate.not_after = Time.now + (10 * 365 * 24 * 60 * 60)
+
+extension_factory = OpenSSL::X509::ExtensionFactory.new
+extension_factory.subject_certificate = intermediate_certificate
+extension_factory.issuer_certificate = intermediate_certificate
+intermediate_certificate.add_extension(extension_factory.create_extension("basicConstraints", "CA:TRUE", true))
+intermediate_certificate.add_extension(extension_factory.create_extension("keyUsage", "keyCertSign, cRLSign", true))
+intermediate_certificate.sign(intermediate_key, OpenSSL::Digest.new("SHA256"))
+
+pass_key = OpenSSL::PKey::RSA.new(2048)
+pass_certificate = OpenSSL::X509::Certificate.new
+pass_certificate.version = 2
+pass_certificate.serial = 2
+pass_certificate.subject = OpenSSL::X509::Name.parse("/CN=#{ENV.fetch("PASSKIT_PASS_TYPE_IDENTIFIER", "pass.com.example.pass")}")
+pass_certificate.issuer = intermediate_certificate.subject
+pass_certificate.public_key = pass_key.public_key
+pass_certificate.not_before = Time.now - 60
+pass_certificate.not_after = Time.now + (10 * 365 * 24 * 60 * 60)
+
+extension_factory = OpenSSL::X509::ExtensionFactory.new
+extension_factory.subject_certificate = pass_certificate
+extension_factory.issuer_certificate = intermediate_certificate
+pass_certificate.add_extension(extension_factory.create_extension("basicConstraints", "CA:FALSE", true))
+pass_certificate.add_extension(extension_factory.create_extension("keyUsage", "digitalSignature", true))
+pass_certificate.sign(intermediate_key, OpenSSL::Digest.new("SHA256"))
+
+p12 = OpenSSL::PKCS12.create(password, "Passkit Test Certificate", pass_key, pass_certificate)
+
+File.binwrite(File.join(output_directory, "intermediate.cer"), intermediate_certificate.to_der)
+File.binwrite(File.join(output_directory, "certificate.p12"), p12.to_der)
+
+puts "Certificates written to #{output_directory}"

data/bin/setup

@@ -5,4 +5,4 @@ set -vx
 
 bundle install
 
-# Do any other automated setup that you need to do here
+bin/generate_test_certificates

data/lib/passkit/base_pass.rb

@@ -189,10 +189,10 @@ module Passkit
 
     # 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
@@ -231,7 +231,7 @@ module Passkit
       false
     end
 
-  private
+    private
 
     def folder_name
       self.class.name.demodulize.underscore

data/lib/passkit/example_store_card.rb

@@ -39,10 +39,10 @@ module Passkit
     # QRCode by default
     def barcodes
       [
-        { 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
 
@@ -59,12 +59,12 @@ module 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 + 1.day).strftime('%Y-%m-%dT%H:%M:%S%:z')
+      (Time.current + 1.day).strftime("%Y-%m-%dT%H:%M:%S%:z")
     end
 
     def semantics
@@ -121,7 +121,7 @@ module Passkit
         }]
     end
 
-  private
+    private
 
     def folder_name
       self.class.name.demodulize.underscore

data/lib/passkit/generator.rb

@@ -36,7 +36,7 @@ module Passkit
       zip_path
     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"))

data/lib/passkit/version.rb

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

data/lib/passkit.rb

@@ -22,7 +22,7 @@ module Passkit
   end
 
   def self.configured?
-    self.configuration&.configured?
+    configuration&.configured?
   end
 
   class Configuration
@@ -68,7 +68,7 @@ module Passkit
       # Optional
       @skip_verification = false
       @web_service_host = ENV["PASSKIT_WEB_SERVICE_HOST"] || "https://localhost:3000"
-      @available_passes = { "Passkit::ExampleStoreCard" => -> {} }
+      @available_passes = {"Passkit::ExampleStoreCard" => -> {}}
       @format_version = ENV["PASSKIT_FORMAT_VERSION"] || 1
       @dashboard_username = ENV["PASSKIT_DASHBOARD_USERNAME"]
       @dashboard_password = ENV["PASSKIT_DASHBOARD_PASSWORD"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passkit
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Alessandro Rodi
@@ -41,14 +41,14 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
@@ -143,7 +143,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.test"
 - ".example.env"
+- ".semaphore/release.yml"
+- ".semaphore/semaphore.yml"
 - ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -179,6 +182,7 @@ files:
 - app/views/passkit/example_mailer/example_email.html.erb
 - app/views/shared/passkit/_navigation.html.erb
 - bin/console
+- bin/generate_test_certificates
 - bin/setup
 - config/routes.rb
 - docs/membership.png
@@ -235,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.9
 specification_version: 4
 summary: Serve Wallet Passes for iOS and Android directly from your Rails app
 test_files: []