Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stytchauth/stytch-ruby
Official Stytch Backend SDK for Ruby
https://github.com/stytchauth/stytch-ruby
authentication ruby sdk stytch
Last synced: 3 days ago
JSON representation
Official Stytch Backend SDK for Ruby
- Host: GitHub
- URL: https://github.com/stytchauth/stytch-ruby
- Owner: stytchauth
- License: mit
- Created: 2020-10-29T18:34:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-31T18:05:07.000Z (11 days ago)
- Last Synced: 2025-02-02T00:07:46.352Z (10 days ago)
- Topics: authentication, ruby, sdk, stytch
- Language: Ruby
- Homepage:
- Size: 451 KB
- Stars: 38
- Watchers: 6
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Stytch Ruby Gem
The Stytch Ruby gem makes it easy to use the Stytch user infrastructure API in Ruby applications.
It pairs well with the Stytch [Web SDK](https://www.npmjs.com/package/@stytch/vanilla-js) or your own custom authentication flow.
## Install
Add this line to your application's Gemfile:
```ruby
gem 'stytch'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install stytch
## Usage
You can find your API credentials in the [Stytch Dashboard](https://stytch.com/dashboard/api-keys).
This client library supports all Stytch's live products:
### B2C
- [x] [Email Magic Links](https://stytch.com/docs/api/send-by-email)
- [x] [Embeddable Magic Links](https://stytch.com/docs/guides/magic-links/embeddable-magic-links/api)
- [x] [OAuth logins](https://stytch.com/docs/guides/oauth/idp-overview)
- [x] [SMS passcodes](https://stytch.com/docs/api/send-otp-by-sms)
- [x] [WhatsApp passcodes](https://stytch.com/docs/api/whatsapp-send)
- [x] [Email passcodes](https://stytch.com/docs/api/send-otp-by-email)
- [x] [Session Management](https://stytch.com/docs/guides/sessions/using-sessions)
- [x] [WebAuthn](https://stytch.com/docs/guides/webauthn/api)
- [x] [Time-based one-time passcodes (TOTPs)](https://stytch.com/docs/guides/totp/api)
- [x] [Crypto wallets](https://stytch.com/docs/guides/web3/api)
- [x] [Passwords](https://stytch.com/docs/guides/passwords/api)
### B2B
- [x] [Organizations](https://stytch.com/docs/b2b/api/organization-object)
- [x] [Members](https://stytch.com/docs/b2b/api/member-object)
- [x] [Email Magic Links](https://stytch.com/docs/b2b/api/send-login-signup-email)
- [x] [OAuth logins](https://stytch.com/docs/b2b/api/oauth-google-start)
- [x] [Session Management](https://stytch.com/docs/b2b/api/session-object)
- [x] [Single-Sign On](https://stytch.com/docs/b2b/api/sso-authenticate-start)
- [x] [Discovery](https://stytch.com/docs/b2b/api/discovered-organization-object)
- [x] [Passwords](https://stytch.com/docs/b2b/api/passwords-authenticate)
### Example B2C usage
Create an API client:
```ruby
client = Stytch::Client.new(
env: :test, # available environments are :test and :live
project_id: "***",
secret: "***"
)
```
Send a magic link by email:
```ruby
client.magic_links.email.login_or_create(
email: "[email protected]"
)
```
Authenticate the token from the magic link:
```ruby
client.magic_links.authenticate(
token: "SeiGwdj5lKkrEVgcEY3QNJXt6srxS3IK2Nwkar6mXD4="
)
```
### Example B2B usage
Create an API client:
```ruby
require 'stytch'
client = StytchB2B::Client.new(
project_id: "project-test-uuid",
secret: "secret-test-uuid"
)
```
Create an organization
```ruby
resp = client.organizations.create(
organization_name: 'Example Org Inc.',
organization_slug: 'example-org'
)
puts resp
```
Log the first user into the organization
```ruby
resp = client.magic_links.email.login_or_signup(
organization_id: 'organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931',
email_address: '[email protected]'
)
puts resp
```
## Handling Errors
When possible the response will contain an `error_type` and an `error_message` that can be used to distinguish errors.
Learn more about errors in the [docs](https://stytch.com/docs/api/errors).
## Documentation
See example requests and responses for all the endpoints in the [Stytch API Reference](https://stytch.com/docs/api).
Follow one of the [integration guides](https://stytch.com/docs/guides) or start with one of our [example apps](https://stytch.com/docs/example-apps).
## Support
If you've found a bug, [open an issue](https://github.com/stytchauth/stytch-ruby/issues/new)!
If you have questions or want help troubleshooting, join us in [Slack](https://stytch.com/docs/resources/support/overview) or email [email protected].
If you've found a security vulnerability, please follow our [responsible disclosure instructions](https://stytch.com/docs/resources/security-and-trust/security#:~:text=Responsible%20disclosure%20program).
## Development
See [DEVELOPMENT.md](DEVELOPMENT.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 Stytch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).