Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yuta17/fireauth

Simple Firebase Authentication for Ruby
https://github.com/yuta17/fireauth

Last synced: 22 days ago
JSON representation

Simple Firebase Authentication for Ruby

Host: GitHub
URL: https://github.com/yuta17/fireauth
Owner: yuta17
License: mit
Created: 2021-01-22T16:01:52.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2021-01-23T10:53:42.000Z (about 4 years ago)
Last Synced: 2024-04-25T10:41:11.689Z (9 months ago)
Language: Ruby
Homepage:
Size: 9.77 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# Fireauth

Simple Firebase Authentication for Ruby. The source of the idea is [this article](https://medium.com/@Mpierrax/firebase-authentification-with-ruby-on-rails-backend-a9f7afc4d715).

This gem receives the idToken issued by Firebase and sends a request to identitytoolkit.

And It will return the authenticated user's information.

Firebase idToken is a token for authentication, so you need to issue an authorization token in your application.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'fireauth'
```

And then execute:

$ bundle install

Or install it yourself as:

$ gem install fireauth

## Configuration

It's needed to set up your Firebase API Key.

If you are using Rails, this should go into `config/initializers/fireauth.rb`.

```ruby
Fireauth.configure do |config|
config.firebase_api_key = ENV['FIREBASE_API_KEY']
end
```

## Usage

```ruby
response = Fireauth::Authentication.call(id_token)
raise response['error']['message'] if response['error'].present?

authenticated_user = response['users'].first

# Ex.)
user = UserIdentity.find_by!(uid: authenticated_user['localId']).user
tokens = user.generate_tokens
render json: tokens # render (access_token, refresh_token) or jwt
```

### Payload Structure

A example of the payload structure from a Facebook login in JSON.

```json
{
"kind": "identitytoolkit#GetAccountInfoResponse",
"users": [
{
"localId": "dummyLocalId",
"displayName": "dummyDisplayName",
"photoUrl": "https://example.com/picture",
"providerUserInfo": [
{
"providerId": "facebook.com",
"displayName": "dummyDisplayName",
"photoUrl": "https://example.com/picture",
"federatedId": "00000000",
"email": "[email protected]",
"rawId": "0000000000"
}
],
"validSince": "1611130616",
"lastLoginAt": "1611375910133",
"createdAt": "1611130616888",
"lastRefreshAt": "2021-01-23T04:25:10.840Z"
}
]
}
```

When a request is made with an invalid idToken.

```json
{
"error": {
"code": 400,
"message": "INVALID_ID_TOKEN",
"errors": [
{
"domain": "global",
"message": "INVALID_ID_TOKEN",
"reason": "invalid"
}
],
}
}
```

## Development

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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yuta17/fireauth.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).