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/errors.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

Defined Under Namespace

Modules: CORS, Controller, Core, Env, JWT, Logging Classes: AuthError, AuthResult, Credentials, EnvError, Middleware, Railtie, Result, SupabaseContext, SupabaseEnv, UserClaims

Constant Summary collapse

CONTEXT_KEY = 
"supabase.context"
VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

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



56
57
58
59
60
61
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
 
# File 'lib/supabase/rails/context.rb', line 56

def self.build_context_result(auth_result, env:, supabase_options:)
  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
  )

  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
    )
  )
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) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/supabase/rails/context.rb', line 41

def self.create_context(request, auth: :user, env: nil, supabase_options: 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)
end

.extract_headers(request) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/supabase/rails/context.rb', line 91

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 



114
115
116
117
118
119
 
# File 'lib/supabase/rails/context.rb', line 114

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