Initial commit

Author: coorasse

.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

.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.env
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+

.standard.yml

@@ -0,0 +1,2 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard

CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-09-21
+
+- Initial release

CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in passkit.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Alessandro Rodi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,160 @@
+# <img src="./docs/wallet.png" alt="Goboony" height="50"/> Passkit
+
+Your out-of-the-box solution to start serving Wallet Passes in your Ruby On Rails application.
+
+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 necessary to distribute Wallet Passes in pkpass format, and gives you all the steps to follow for what we cannot provide.
+
+**We provide:**
+
+* 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 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):**
+
+* 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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'passkit'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install passkit
+
+Run the initializer:
+
+    $ rails g passkit:install
+
+that will generate the migrations and the initializer file.
+
+Mount the engine in your `config/routes.rb`:
+
+```ruby
+mount Passkit::Engine => '/passkit', as: 'passkit'
+```
+
+and run `bin/rails db:migrate`.
+
+### 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 with the necessary APIs already implemented.
+
+Now is your turn. Before proceeding, you need to set these ENV variables:
+* `PASSKIT_WEB_SERVICE_HOST`
+* `PASSKIT_CERTIFICATE_KEY`
+* `PASSKIT_PRIVATE_P12_CERTIFICATE`
+* `PASSKIT_APPLE_INTERMEDIATE_CERTIFICATE`
+* `PASSKIT_APPLE_TEAM_IDENTIFIER`
+* `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 start using this library without these variables set, and we cannot do the work for you.
+
+## Usage
+
+If you followed the installation steps and you have the ENV variables set, we can start looking at what is provided for you.
+
+### 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`:
+
+```ruby
+module Passkit
+  class ExampleMailerPreview < ActionMailer::Preview
+    def example_email
+      Passkit::ExampleMailer.example_email
+    end
+  end
+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.
+
+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 define colors, fields and texts. You can also define the logo and the background image.
+
+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:
+
+```ruby
+Passkit::UrlGenerator.new(pass_class: Passkit::MyPass, generator: User.find(1))
+```
+
+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.
+
+## Debug issues 
+
+* On Mac, open the `Console.app` to view the errors.
+* Check the logs on http://localhost:3000/passkit/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.
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/coorasse/passkit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/coorasse/passkit/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Passkit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/coorasse/passkit/blob/master/CODE_OF_CONDUCT.md).
+
+## Credits
+
+* <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/

Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

app/assets/images/passkit/add_to_apple_wallet_de.png

@@ -0,0 +1,14 @@
+module Passkit
+  module Api
+    module V1
+      class LogsController < ActionController::API
+        def create
+          params[:logs].each do |message|
+            Log.create!(content: message)
+          end
+          render json: {}, status: :ok
+        end
+      end
+    end
+  end
+end