Class: SynsbasenApi::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/synsbasen_api/client.rb

Overview

The Client class serves as the base class for interacting with the Synsbasen API.

Direct Known Subclasses

Resource

Constant Summary collapse

DEFAULT_BASE_URL = 
"https://api.synsbasen.dk".freeze

Class Method Summary collapse

Class Method Details

.delete(path, params = {}, body = {}) ⇒ ApiResponse

Sends a DELETE request to Synsbasen API.

Parameters:

  • path (String) —

    The API endpoint path.

  • params (Hash) (defaults to: {}) —

    Query parameters for the request.

  • body (Hash) (defaults to: {}) —

    Request body.

Returns:

Raises:



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/synsbasen_api/client.rb', line 61

def delete(path, params = {}, body = {})
  request = build_request(path, method: Net::HTTP::Delete, params: params, body: body)

  response = connection.request(request)

  raise_errors(response)

  handle_after_request_callback(response)

  ApiResponse.new(parse_json(response.body))
end

.get(path, params: {}, expand: []) ⇒ ApiResponse

Sends a GET request to Synsbasen API.

Parameters:

  • path (String) —

    The API endpoint path.

  • params (Hash) (defaults to: {}) —

    Query parameters for the request.

  • expand (Array) (defaults to: []) —

    List of fields to expand in the response.

Returns:

  • (ApiResponse) —

    An instance of ApiResponse containing the API response.

Raises:



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/synsbasen_api/client.rb', line 22

def get(path, params: {}, expand: [])
  request = build_request(path, method: Net::HTTP::Get, params: params, expand: expand)

  response = connection.request(request)

  raise_errors(response)

  handle_after_request_callback(response)

  ApiResponse.new(parse_json(response.body))
end

.post(path, params: {}, body: {}, expand: []) ⇒ ApiResponse

Sends a POST request to Synsbasen API.

Parameters:

  • path (String) —

    The API endpoint path.

  • params (Hash) (defaults to: {}) —

    Query parameters for the request.

  • body (Hash) (defaults to: {}) —

    Request body.

  • expand (Array) (defaults to: []) —

    List of fields to expand in the response.

Returns:

  • (ApiResponse) —

    An instance of ApiResponse containing the API response.

Raises:



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/synsbasen_api/client.rb', line 42

def post(path, params: {}, body: {}, expand: [])
  request = build_request(path, method: Net::HTTP::Post, params: params, body: body, expand: expand)

  response = connection.request(request)

  raise_errors(response)

  handle_after_request_callback(response)

  ApiResponse.new(parse_json(response.body))
end