firebase-auth-rails
This is a plugin that performs firebase authentication in rails.
Supported Rails version is 5.x, 6.0
As of version 4.2, the test environment is not ready and I do not know if it will work.
Made influenced by firebase_id_token and knock
Thanks to the author.
Status
Now it's a beta version. Only login feature is available. It does not have firebase user creation feature.
Usage
Add database migrate method.
class AddUidToUsers < ActiveRecord::Migration[5.1]
def change
add_column :users, :uid, :string
end
endAdd the following code to the controller to use.
include Firebase::Auth::Authenticable
before_action :authenticate_userThe current user is defined
current_user.user_name
# => yamadaThe following is a generic user creation code
- api/v1/application_controller
module Api
class V1::ApplicationController < ActionController::API
include Firebase::Auth::Authenticable
before_action :authenticate_user
end
end- api/v1/auth/registrations_controller
require_dependency 'api/v1/application_controller'
module Api
module V1
module Auth
class RegistrationsController < V1::ApplicationController
skip_before_action :authenticate_user
def create
raise ArgumentError, 'BadRequest Parameter' if payload.blank?
user = User.create!(sign_up_params.merge(uid: payload['sub']))
render json: user, serializer: V1::AuthSerializer, status: :ok
end
private
def sign_up_params
params.require(:registration).permit(:user_name, :display_name)
end
def token_from_request_headers
request.headers['Authorization']&.split&.last
end
def token
params[:token] || token_from_request_headers
end
def payload
@payload ||= FirebaseIdToken::Signature.verify token
end
end
end
end
end
Installation
Add this line to your application's Gemfile:
gem 'firebase-auth-rails'And then execute:
$ bundleOr install it yourself as:
$ gem install firebase-auth-railsinitializer
# frozen_string_literal: true
FirebaseIdToken.configure do |config|
config.redis = Redis.new
config.project_ids = ['firebase_project_id']
end
Testing
There is preparation for testing firebase certification. Please click here. link
Contributing
We welcome PR.
development
getting started
- Test preparation
cd test/dummy/
bin/rails migrate- The test is a minitest
# Project root dir
rake testLicense
The gem is available as open source under the terms of the MIT License.
