Class: Clerk::ProxyChecks

Inherits:
Object
  • Object
show all
Defined in:
lib/clerk/proxychecks.rb

Instance Method Summary collapse

Constructor Details

#initialize(sdk_config) ⇒ ProxyChecks

Returns a new instance of ProxyChecks.



20
21
22
23
 
# File 'lib/clerk/proxychecks.rb', line 20

def initialize(sdk_config)
  @sdk_configuration = sdk_config
  
end

Instance Method Details

#get_url(base_url:, url_variables: nil) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/clerk/proxychecks.rb', line 26

def get_url(base_url:, url_variables: nil)
  sd_base_url, sd_options = @sdk_configuration.get_server_details

  if base_url.nil?
    base_url = sd_base_url
  end

  if url_variables.nil?
    url_variables = sd_options
  end

  return Utils.template_url base_url, url_variables
end

#verify(request: nil, retries: nil, timeout_ms: nil) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/clerk/proxychecks.rb', line 42

def verify(request: nil, retries: nil, timeout_ms: nil)
  # verify - Verify the proxy configuration for your domain
  # This endpoint can be used to validate that a proxy-enabled domain is operational.
  # It tries to verify that the proxy URL provided in the parameters maps to a functional proxy that can reach the Clerk Frontend API.
  # 
  # You can use this endpoint before you set a proxy URL for a domain. This way you can ensure that switching to proxy-based
  # configuration will not lead to downtime for your instance.
  # 
  # The `proxy_url` parameter allows for testing proxy configurations for domains that don't have a proxy URL yet, or operate on
  # a different proxy URL than the one provided. It can also be used to re-validate a domain that is already configured to work with a proxy.
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = "#{base_url}/proxy_checks"
  headers = {}
  
  req_content_type, data, form = Utils.serialize_request_body(request, false, true, :request, :json)
  headers['content-type'] = req_content_type

  if form
    body = Utils.encode_form(form)
  elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
    body = URI.encode_www_form(data)
  else
    body = data
  end
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent
  retries ||= @sdk_configuration.retry_config
  retries ||= Utils::RetryConfig.new(
    backoff: Utils::BackoffStrategy.new(
      exponent: 1.5,
      initial_interval: 500,
      max_elapsed_time: 3_600_000,
      max_interval: 60_000
    ),
    retry_connection_errors: true,
    strategy: 'backoff'
  )
  retry_options = retries.to_faraday_retry_options(initial_time: Time.now)
  retry_options[:retry_statuses] = [500, 501, 502, 503, 504, 505]

  security = @sdk_configuration.security_source&.call

  timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
  timeout ||= @sdk_configuration.timeout
  

  connection = @sdk_configuration.client.dup
  connection.request :retry, retry_options

  hook_ctx = SDKHooks::HookContext.new(
    config: @sdk_configuration,
    base_url: base_url,
    oauth2_scopes: nil,
    operation_id: 'VerifyDomainProxy',
    security_source: @sdk_configuration.security_source
  )

  error = nil
  http_response = nil
  
  
  begin
    http_response = connection.post(url) do |req|
      req.body = body
      req.headers.merge!(headers)
      req.options.timeout = timeout unless timeout.nil?
      Utils.configure_request_security(req, security)

      @sdk_configuration.hooks.before_request(
        hook_ctx: SDKHooks::BeforeRequestHookContext.new(
          hook_ctx: hook_ctx
        ),
        request: req
      )
    end
  rescue StandardError => e
    error = e
  ensure
    if http_response.nil? || Utils.error_status?(http_response.status)
      http_response = @sdk_configuration.hooks.after_error(
        error: error,
        hook_ctx: SDKHooks::AfterErrorHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
    else
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
    end
    
    if http_response.nil?
      raise error if !error.nil?
      raise 'no response'
    end
  end
  
  content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
  if Utils.match_status_code(http_response.status, ['200'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Components::ProxyCheck)
      response = Models::Operations::VerifyDomainProxyResponse.new(
        status_code: http_response.status,
        content_type: content_type,
        raw_response: http_response,
        proxy_check: obj
      )

      return response
    else
      raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['400', '422'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::ClerkErrors)
      obj.raw_response = http_response
      raise obj
    else
      raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['4XX'])
    raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
  elsif Utils.match_status_code(http_response.status, ['5XX'])
    raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
  else
    raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'

  end
end