Class: Dnsimple::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/dnsimple/client.rb,
lib/dnsimple/client/tlds.rb,
lib/dnsimple/client/oauth.rb,
lib/dnsimple/client/zones.rb,
lib/dnsimple/client/clients.rb,
lib/dnsimple/client/domains.rb,
lib/dnsimple/client/accounts.rb,
lib/dnsimple/client/contacts.rb,
lib/dnsimple/client/identity.rb,
lib/dnsimple/client/services.rb,
lib/dnsimple/client/webhooks.rb,
lib/dnsimple/client/registrar.rb,
lib/dnsimple/client/templates.rb,
lib/dnsimple/client/certificates.rb,
lib/dnsimple/client/zones_records.rb,
lib/dnsimple/client/domains_dnssec.rb,
lib/dnsimple/client/domains_pushes.rb,
lib/dnsimple/client/services_domains.rb,
lib/dnsimple/client/templates_domains.rb,
lib/dnsimple/client/templates_records.rb,
lib/dnsimple/client/vanity_name_servers.rb,
lib/dnsimple/client/zones_distributions.rb,
lib/dnsimple/client/registrar_delegation.rb,
lib/dnsimple/client/domains_collaborators.rb,
lib/dnsimple/client/domains_email_forwards.rb,
lib/dnsimple/client/registrar_auto_renewal.rb,
lib/dnsimple/client/registrar_whois_privacy.rb,
lib/dnsimple/client/domains_delegation_signer_records.rb

Overview

Client for the DNSimple API

Examples:

Default (Production)

require "dnsimple"

client = Dnsimple::Client.new(access_token: "abc")

Custom Base URL (Sandbox)

require 'dnsimple'

client = Dnsimple::Client.new(base_url: "https://api.sandbox.dnsimple.com", access_token: "abc")

See Also:

Defined Under Namespace

Modules: Accounts, Certificates, Contacts, Domains, DomainsCollaborators, DomainsDelegationSignerRecords, DomainsDnssec, DomainsEmailForwards, DomainsPushes, Identity, Oauth, Registrar, RegistrarAutoRenewal, RegistrarDelegation, RegistrarWhoisPrivacy, Services, ServicesDomains, Templates, TemplatesDomains, TemplatesRecords, Tlds, VanityNameServers, Webhooks, Zones, ZonesDistributions, ZonesRecords Classes: AccountsService, CertificatesService, ClientService, ContactsService, DomainsService, IdentityService, OauthService, RegistrarService, ServicesService, TemplatesService, TldsService, VanityNameServersService, WebhooksService, ZonesService

Constant Summary collapse

HEADER_AUTHORIZATION =
"Authorization"
API_VERSION =

Returns The current API version.

Returns:

  • (String)

    The current API version.

"v2"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.


71
72
73
74
75
76
77
78
79
# File 'lib/dnsimple/client.rb', line 71

def initialize(options = {})
  defaults = Dnsimple::Default.options

  Dnsimple::Default.keys.each do |key| # rubocop:disable Style/HashEachMethods
    instance_variable_set(:"@#{key}", options[key] || defaults[key])
  end

  @services = {}
end

Instance Attribute Details

#access_tokenString

Returns Domain API access token for authentication.

Returns:

  • (String)

    Domain API access token for authentication

See Also:


60
61
62
# File 'lib/dnsimple/client.rb', line 60

def access_token
  @access_token
end

#domain_api_tokenString

Returns Domain API access token for authentication.

Returns:

  • (String)

    Domain API access token for authentication

See Also:


55
56
57
# File 'lib/dnsimple/client.rb', line 55

def domain_api_token
  @domain_api_token
end

#passwordString

Returns DNSimple password for Basic Authentication.

Returns:

  • (String)

    DNSimple password for Basic Authentication

See Also:


50
51
52
# File 'lib/dnsimple/client.rb', line 50

def password
  @password
end

#proxyString?

Returns Configure address:port values for proxy server.

Returns:

  • (String, nil)

    Configure address:port values for proxy server


68
69
70
# File 'lib/dnsimple/client.rb', line 68

def proxy
  @proxy
end

#user_agentString

Returns Configure User-Agent header for requests.

Returns:

  • (String)

    Configure User-Agent header for requests.


64
65
66
# File 'lib/dnsimple/client.rb', line 64

def user_agent
  @user_agent
end

#usernameString

Returns DNSimple username for Basic Authentication.

Returns:

  • (String)

    DNSimple username for Basic Authentication

See Also:


45
46
47
# File 'lib/dnsimple/client.rb', line 45

def username
  @username
end

Class Method Details

.versioned(path) ⇒ String

Prepends the correct API version to path.

Returns:

  • (String)

    The versioned path.


37
38
39
# File 'lib/dnsimple/client.rb', line 37

def self.versioned(path)
  File.join(API_VERSION, path)
end

Instance Method Details

#accountsDnsimple::Client::AccountsService

Returns The account-related API proxy.

Returns:


7
8
9
# File 'lib/dnsimple/client/clients.rb', line 7

def accounts
  @services[:accounts] ||= Client::AccountsService.new(self)
end

#base_urlString

Base URL for API requests.

It defaults to "https://api.dnsimple.com". For testing purposes use "https://api.sandbox.dnsimple.com".

Examples:

Default (Production)

require "dnsimple"

client = Dnsimple::Client.new(access_token: "abc")

Custom Base URL (Sandbox)

require 'dnsimple'

client = Dnsimple::Client.new(base_url: "https://api.sandbox.dnsimple.com", access_token: "abc")

Returns:

  • (String)

    Base URL

See Also:


100
101
102
# File 'lib/dnsimple/client.rb', line 100

def base_url
  Extra.join_uri(@base_url, "")
end

#certificatesDnsimple::Client::CertificatesService

Returns The certificate-related API proxy.

Returns:


12
13
14
# File 'lib/dnsimple/client/clients.rb', line 12

def certificates
  @services[:certificates] ||= Client::CertificatesService.new(self)
end

#contactsDnsimple::Client::ContactsService

Returns The contact-related API proxy.

Returns:


17
18
19
# File 'lib/dnsimple/client/clients.rb', line 17

def contacts
  @services[:contacts] ||= Client::ContactsService.new(self)
end

#delete(path, data = nil, options = {}) ⇒ HTTParty::Response

Make a HTTP DELETE request.

Parameters:

  • path (String)

    The path, relative to #base_url

  • options (Hash) (defaults to: {})

    The query and header params for the request

Returns:

  • (HTTParty::Response)

149
150
151
# File 'lib/dnsimple/client.rb', line 149

def delete(path, data = nil, options = {})
  execute :delete, path, data, options
end

#domain_servicesDnsimple::Client::DomainServicesService

Returns The domain-services-related API proxy.

Returns:

  • (Dnsimple::Client::DomainServicesService)

    The domain-services-related API proxy.


27
28
29
# File 'lib/dnsimple/client/clients.rb', line 27

def domain_services
  @services[:domains] ||= Client::DomainServicesService.new(self)
end

#domainsDnsimple::Client::DomainsService

Returns The domain-related API proxy.

Returns:


22
23
24
# File 'lib/dnsimple/client/clients.rb', line 22

def domains
  @services[:domains] ||= Client::DomainsService.new(self)
end

#execute(method, path, data = nil, options = {}) ⇒ HTTParty::Response

Executes a request, validates and returns the response.

Parameters:

  • method (String)

    The HTTP method

  • path (String)

    The path, relative to #base_url

  • data (Hash) (defaults to: nil)

    The body for the request

  • options (Hash) (defaults to: {})

    The query and header params for the request

Returns:

  • (HTTParty::Response)

Raises:


164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/dnsimple/client.rb', line 164

def execute(method, path, data = nil, options = {})
  response = request(method, path, data, options)

  case response.code
  when 200..299
    response
  when 401
    raise AuthenticationFailed, response["message"]
  when 404
    raise NotFoundError, response
  else
    raise RequestError, response
  end
end

#get(path, options = {}) ⇒ HTTParty::Response

Make a HTTP GET request.

Parameters:

  • path (String)

    The path, relative to #base_url

  • options (Hash) (defaults to: {})

    The query and header params for the request

Returns:

  • (HTTParty::Response)

110
111
112
# File 'lib/dnsimple/client.rb', line 110

def get(path, options = {})
  execute :get, path, nil, options.to_h
end

#identityDnsimple::Client::IdentityService

Returns The identity-related API proxy.

Returns:


32
33
34
# File 'lib/dnsimple/client/clients.rb', line 32

def identity
  @services[:auth] ||= Client::IdentityService.new(self)
end

#oauthDnsimple::Client::OauthService

Returns The oauth-related API proxy.

Returns:


37
38
39
# File 'lib/dnsimple/client/clients.rb', line 37

def oauth
  @services[:oauth] ||= Client::OauthService.new(self)
end

#patch(path, data = nil, options = {}) ⇒ HTTParty::Response

Make a HTTP PATCH request.

Parameters:

  • path (String)

    The path, relative to #base_url

  • data (Hash) (defaults to: nil)

    The body for the request

  • options (Hash) (defaults to: {})

    The query and header params for the request

Returns:

  • (HTTParty::Response)

140
141
142
# File 'lib/dnsimple/client.rb', line 140

def patch(path, data = nil, options = {})
  execute :patch, path, data, options
end

#post(path, data = nil, options = {}) ⇒ HTTParty::Response

Make a HTTP POST request.

Parameters:

  • path (String)

    The path, relative to #base_url

  • data (Hash) (defaults to: nil)

    The body for the request

  • options (Hash) (defaults to: {})

    The query and header params for the request

Returns:

  • (HTTParty::Response)

120
121
122
# File 'lib/dnsimple/client.rb', line 120

def post(path, data = nil, options = {})
  execute :post, path, data, options
end

#put(path, data = nil, options = {}) ⇒ HTTParty::Response

Make a HTTP PUT request.

Parameters:

  • path (String)

    The path, relative to #base_url

  • data (Hash) (defaults to: nil)

    The body for the request

  • options (Hash) (defaults to: {})

    The query and header params for the request

Returns:

  • (HTTParty::Response)

130
131
132
# File 'lib/dnsimple/client.rb', line 130

def put(path, data = nil, options = {})
  execute :put, path, data, options
end

#registrarDnsimple::Client::RegistrarService

Returns The registrar-related API proxy.

Returns:


42
43
44
# File 'lib/dnsimple/client/clients.rb', line 42

def registrar
  @services[:registrar] ||= Client::RegistrarService.new(self)
end

#request(method, path, data = nil, options = {}) ⇒ HTTParty::Response

Make a HTTP request.

This method doesn't validate the response and never raise errors even in case of HTTP error codes, except for connection errors raised by the underlying HTTP client.

Therefore, it's up to the caller to properly handle and validate the response.

Parameters:

  • method (String)

    The HTTP method

  • path (String)

    The path, relative to #base_url

  • data (Hash) (defaults to: nil)

    The body for the request

  • options (Hash) (defaults to: {})

    The query and header params for the request

Returns:

  • (HTTParty::Response)

192
193
194
195
196
197
198
199
200
201
# File 'lib/dnsimple/client.rb', line 192

def request(method, path, data = nil, options = {})
  request_options = request_options(options)

  if data
    request_options[:headers]["Content-Type"] = content_type(request_options[:headers])
    request_options[:body] = content_data(request_options[:headers], data)
  end

  HTTParty.send(method, base_url + path, request_options)
end

#servicesDnsimple::Client::ServicesService

Returns The one-click-service-related API proxy.

Returns:


47
48
49
# File 'lib/dnsimple/client/clients.rb', line 47

def services
  @services[:services] ||= Client::ServicesService.new(self)
end

#templatesDnsimple::Client::TemplatesService

Returns The templates-related API proxy.

Returns:


52
53
54
# File 'lib/dnsimple/client/clients.rb', line 52

def templates
  @services[:templates] ||= Client::TemplatesService.new(self)
end

#tldsDnsimple::Client::TldsService

Returns The tld-related API proxy.

Returns:


57
58
59
# File 'lib/dnsimple/client/clients.rb', line 57

def tlds
  @services[:tlds] ||= Client::TldsService.new(self)
end

#vanity_name_serversDnsimple::Client::VanityNameServersService

Returns The vanity-name-server-related API proxy.

Returns:


62
63
64
# File 'lib/dnsimple/client/clients.rb', line 62

def vanity_name_servers
  @services[:vanity_name_servers] ||= Client::VanityNameServersService.new(self)
end

#webhooksDnsimple::Client::WebhooksService

Returns The webhooks-related API proxy.

Returns:


72
73
74
# File 'lib/dnsimple/client/clients.rb', line 72

def webhooks
  @services[:webhooks] ||= Client::WebhooksService.new(self)
end

#zonesDnsimple::Client::ZonesService

Returns The zone-related API proxy.

Returns:


67
68
69
# File 'lib/dnsimple/client/clients.rb', line 67

def zones
  @services[:zones] ||= Client::ZonesService.new(self)
end