Module: Supabase::Rails

Defined in:
lib/supabase/rails.rb,
lib/supabase/rails/env.rb,
lib/supabase/rails/jwt.rb,
lib/supabase/rails/core.rb,
lib/supabase/rails/cors.rb,
lib/supabase/rails/user.rb,
lib/supabase/rails/engine.rb,
lib/supabase/rails/errors.rb,
lib/supabase/rails/routes.rb,
lib/supabase/rails/context.rb,
lib/supabase/rails/logging.rb,
lib/supabase/rails/railtie.rb,
lib/supabase/rails/version.rb,
lib/supabase/rails/controller.rb,
lib/supabase/rails/middleware.rb,
lib/supabase/rails/session_store.rb,
lib/supabase/rails/authentication.rb,
lib/supabase/rails/web/auth_error_mapper.rb,
lib/supabase/rails/web/redirect_validator.rb,
lib/supabase/rails/web/auth_client_factory.rb,
lib/supabase/rails/web/refresh_coordinator.rb,
app/controllers/supabase/rails/otp_controller.rb,
lib/supabase/rails/web/request_scoped_storage.rb,
app/controllers/supabase/rails/base_controller.rb,
app/controllers/supabase/rails/oauth_controller.rb,
lib/supabase/rails/web/cookie_credential_strategy.rb,
app/controllers/supabase/rails/sessions_controller.rb,
app/controllers/supabase/rails/passwords_controller.rb,
app/controllers/supabase/rails/registrations_controller.rb

Defined Under Namespace

Modules: Authentication, CORS, Controller, Core, Env, JWT, Logging, Routes, Web Classes: AuthError, AuthResult, BaseController, ConfigError, Credentials, Engine, EnvError, Middleware, OauthController, OtpController, PasswordsController, Railtie, RegistrationsController, Result, SessionStore, SessionsController, SupabaseContext, SupabaseEnv, User, UserClaims

Constant Summary collapse

CONTEXT_KEY = 
"supabase.context"
VERSION = 
"1.0.0"

Class Method Summary collapse

Class Method Details

.build_context_result(auth_result, env:, supabase_options:, user_model: nil) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/supabase/rails/context.rb', line 62

def self.build_context_result(auth_result, env:, supabase_options:, user_model: nil)
  publishable_key_name = auth_result.auth_mode == :publishable ? auth_result.key_name : nil
  supabase = Core.create_context_client(
    auth: { token: auth_result.token, key_name: publishable_key_name },
    env: env,
    supabase_options: supabase_options
  )

  admin_key_name = auth_result.auth_mode == :secret ? auth_result.key_name : nil
  supabase_admin = Core.create_admin_client(
    auth: { key_name: admin_key_name },
    env: env,
    supabase_options: supabase_options
  )

  # `current_user` is the default `Current.user` value (FR-W15).
  # Built only when `user_model` is unset (the host hasn't opted into a
  # shadow AR model via FR-W14). When `user_model` is set, the
  # Authentication concern populates `Current.user` with the AR record
  # in `start_new_session_for` and this stays nil.
  current_user =
    if user_model.nil? && auth_result.jwt_claims.is_a?(Hash)
      User.from_claims(auth_result.jwt_claims)
    end

  Result.success(
    SupabaseContext.new(
      supabase: supabase,
      supabase_admin: supabase_admin,
      user_claims: auth_result.user_claims,
      jwt_claims: auth_result.jwt_claims,
      auth_mode: auth_result.auth_mode,
      auth_key_name: auth_result.key_name,
      current_user: current_user
    )
  )
rescue EnvError => e
  wrapped = AuthError.new(e.message, e.code, 500)
  Logging.log(:error, "[#{wrapped.code}] #{wrapped.message}")
  Result.failure(wrapped)
rescue ::Supabase::SupabaseException, ArgumentError => e
  wrapped = AuthError.create_supabase_client_error
  Logging.log(:error, "[#{wrapped.code}] #{e.class}: #{e.message}")
  Result.failure(wrapped)
end

.create_context(request, auth: :user, env: nil, supabase_options: nil, user_model: nil) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/supabase/rails/context.rb', line 42

def self.create_context(request, auth: :user, env: nil, supabase_options: nil, user_model: nil)
  headers = extract_headers(request)
  credentials = Core.extract_credentials(headers)

  auth_result =
    begin
      Core.verify_credentials(credentials, auth: auth, env: env)
    rescue AuthError => e
      Logging.log(:warn, "[#{e.code}] #{e.message}")
      return Result.failure(e)
    end

  build_context_result(
    auth_result,
    env: env,
    supabase_options: supabase_options,
    user_model: user_model
  )
end

.extract_headers(request) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/supabase/rails/context.rb', line 108

def self.extract_headers(request)
  return {} if request.nil?
  return request if request.is_a?(Hash)

  if request.respond_to?(:headers)
    headers = request.headers
    return {
      "Authorization" => header_value(headers, "Authorization"),
      "apikey" => header_value(headers, "apikey")
    }
  end

  if request.respond_to?(:env)
    env = request.env
    return {
      "Authorization" => env["HTTP_AUTHORIZATION"],
      "apikey" => env["HTTP_APIKEY"]
    }
  end

  {}
end

.header_value(headers, name) ⇒ Object 



131
132
133
134
135
136
 
# File 'lib/supabase/rails/context.rb', line 131

def self.header_value(headers, name)
  return nil if headers.nil?
  return headers[name] if headers.respond_to?(:[])

  nil
end

.logger ⇒ Object 



30
31
32
 
# File 'lib/supabase/rails/logging.rb', line 30

def self.logger
  Logging.logger
end

.logger=(value) ⇒ Object 



34
35
36
 
# File 'lib/supabase/rails/logging.rb', line 34

def self.logger=(value)
  Logging.logger = value
end