Class: Idcf::Dns::Client

Inherits:
Object
  • Object
show all
Includes:
Idcf::Dns::ClientExtensions::Record, Idcf::Dns::ClientExtensions::Zone
Defined in:
lib/idcf/dns/client.rb

Overview

Client for IDCF DNS service

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Idcf::Dns::ClientExtensions::Zone

#create_zone, #delete_zone, #get_zone, #list_zones, #update_zone, #zone, #zones

Methods included from Idcf::Dns::ClientExtensions::Record

#create_record, #delete_record, #get_record, #list_records, #record, #records, #update_record

Constructor Details

#initialize(api_key:, secret_key:, host: "dns.idcfcloud.com", endpoint: "/api/v1", verify_ssl: true) ⇒ Client

The constructor of Dns::Client uses keyword arguments.

Parameters:

  • api_key (String) —

    API key for IDCF Cloud

  • secret_key (String) —

    Secret key for IDCF Cloud



17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/idcf/dns/client.rb', line 17

def initialize(api_key:,
               secret_key:,
               host: "dns.idcfcloud.com",
               endpoint: "/api/v1",
               verify_ssl: true
              )

  @api_key    = api_key
  @secret_key = secret_key
  @host       = host
  @endpoint   = endpoint
  @verify_ssl = verify_ssl
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



11
12
13
 
# File 'lib/idcf/dns/client.rb', line 11

def api_key
  @api_key
end

#endpoint ⇒ Object (readonly)

Returns the value of attribute endpoint.



11
12
13
 
# File 'lib/idcf/dns/client.rb', line 11

def endpoint
  @endpoint
end

#host ⇒ Object (readonly)

Returns the value of attribute host.



11
12
13
 
# File 'lib/idcf/dns/client.rb', line 11

def host
  @host
end

#secret_key ⇒ Object (readonly)

Returns the value of attribute secret_key.



11
12
13
 
# File 'lib/idcf/dns/client.rb', line 11

def secret_key
  @secret_key
end

Instance Method Details

#connection ⇒ Object 



32
33
34
35
36
37
38
39
 
# File 'lib/idcf/dns/client.rb', line 32

def connection
  @connection ||=
    Faraday.new(url: url_prefix, ssl: ssl_options) do |connection|
      connection.request :json
      connection.response :json
      connection.adapter Faraday.default_adapter
    end
end

#delete(resource, parameters = {}, headers = {}) ⇒ Response

Send DELETE request.

Parameters:

  • resource (String) —

    resource name

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

    request parameters

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

    HTTP request headers

Returns:



47
48
49
 
# File 'lib/idcf/dns/client.rb', line 47

def delete(resource, parameters = {}, headers = {})
  send(:delete, resource, parameters, headers)
end

#delete!(resource, parameters = {}, headers = {}) ⇒ Response

Send DELETE request with handling error

Parameters:

  • resource (String) —

    resource name

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

    request parameters

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

    HTTP request headers

Returns:



57
58
59
 
# File 'lib/idcf/dns/client.rb', line 57

def delete!(resource, parameters = {}, headers = {})
  send!(:delete, resource, parameters, headers)
end

#get(resource, parameters = {}, headers = {}) ⇒ Response

Send GET request

Parameters:

  • resource (String) —

    Resource name

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

    Parameters

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

    HTTP request headers

Returns:



67
68
69
 
# File 'lib/idcf/dns/client.rb', line 67

def get(resource, parameters = {}, headers = {})
  send(:get, resource, parameters, headers)
end

#get!(resource, parameters = {}, headers = {}) ⇒ Response

Send GET request with handling error

Parameters:

  • resource (String) —

    resource name

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

    request parameters

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

    HTTP request headers

Returns:



77
78
79
 
# File 'lib/idcf/dns/client.rb', line 77

def get!(resource, parameters = {}, headers = {})
  send!(:get, resource, parameters, headers)
end

#post(resource, parameters = {}, headers = {}) ⇒ Response

Send POST request

Parameters:

  • resource (String) —

    resource name

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

    request parameters

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

    HTTP request headers

Returns:



87
88
89
 
# File 'lib/idcf/dns/client.rb', line 87

def post(resource, parameters = {}, headers = {})
  send(:post, resource, parameters, headers)
end

#post!(resource, parameters = {}, headers = {}) ⇒ Response

Send POST request with handling error

Parameters:

  • resource (String) —

    resource name

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

    request parameters

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

    HTTP request headers

Returns:



97
98
99
 
# File 'lib/idcf/dns/client.rb', line 97

def post!(resource, parameters = {}, headers = {})
  send!(:post, resource, parameters, headers)
end

#put(resource, parameters = {}, headers = {}) ⇒ Response

Send PUT request

Parameters:

  • resource (String) —

    resource name

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

    request parameters

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

    HTTP request headers

Returns:



107
108
109
 
# File 'lib/idcf/dns/client.rb', line 107

def put(resource, parameters = {}, headers = {})
  send(:put, resource, parameters, headers)
end

#put!(resource, parameters = {}, headers = {}) ⇒ Response

Send PUT request with handling error

Parameters:

  • resource (String) —

    resource name

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

    request parameters

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

    HTTP request headers

Returns:



117
118
119
 
# File 'lib/idcf/dns/client.rb', line 117

def put!(resource, parameters = {}, headers = {})
  send!(:put, resource, parameters, headers)
end