/apple_id

Sign in with Apple backend library in Ruby

Primary LanguageRubyMIT LicenseMIT

AppleID

"Sign-in with Apple" is an implementation of OpenID Connect with small custom features.

This gem handles these Apple custom features.

Installation

Add this line to your application's Gemfile:

gem 'apple_id'

And then execute:

$ bundle

Or install it yourself as:

$ gem install apple_id

Usage

There is a sample rails app running at signin-with-apple.herokuapp.com.

If you run script in your terminal only, do like this.

For more details, see AppleID Wiki.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apple_id. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the AppleID project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.