Class: Dnsimple::Client
- Inherits:
-
Object
- Object
- Dnsimple::Client
- 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/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/zones_records.rb,
lib/dnsimple/client/registrar_delegation.rb,
lib/dnsimple/client/domains_email_forwards.rb,
lib/dnsimple/client/registrar_auto_renewal.rb,
lib/dnsimple/client/registrar_whois_privacy.rb
Overview
Client for the DNSimple API
Defined Under Namespace
Modules: Contacts, Domains, DomainsEmailForwards, Identity, Oauth, Registrar, RegistrarAutoRenewal, RegistrarDelegation, RegistrarWhoisPrivacy, Services, Templates, Tlds, Webhooks, Zones, ZonesRecords Classes: ClientService, ContactsService, DomainsService, IdentityService, OauthService, RegistrarService, ServicesService, TemplatesService, TldsService, WebhooksService, ZonesService
Constant Summary collapse
- HEADER_AUTHORIZATION =
"Authorization".freeze
- WILDCARD_ACCOUNT =
"_".freeze
- API_VERSION =
Returns The current API version.
"v2".freeze
Instance Attribute Summary collapse
-
#access_token ⇒ String
Domain API access token for authentication.
-
#base_url ⇒ String
Base URL for API requests.
-
#domain_api_token ⇒ String
Domain API access token for authentication.
-
#password ⇒ String
DNSimple password for Basic Authentication.
-
#proxy ⇒ String?
Configure address:port values for proxy server.
-
#user_agent ⇒ String
Configure User-Agent header for requests.
-
#username ⇒ String
DNSimple username for Basic Authentication.
Class Method Summary collapse
-
.versioned(path) ⇒ String
Prepends the correct API version to
path
.
Instance Method Summary collapse
-
#contacts ⇒ Dnsimple::Client::ContactsService
The contact-related API proxy.
-
#delete(path, data = nil, options = {}) ⇒ HTTParty::Response
Make a HTTP DELETE request.
-
#domains ⇒ Dnsimple::Client::DomainsService
The domain-related API proxy.
-
#execute(method, path, data = nil, options = {}) ⇒ HTTParty::Response
Executes a request, validates and returns the response.
-
#get(path, options = {}) ⇒ HTTParty::Response
Make a HTTP GET request.
-
#identity ⇒ Dnsimple::Client::IdentityService
The identity-related API proxy.
-
#initialize(options = {}) ⇒ Client
constructor
A new instance of Client.
-
#oauth ⇒ Dnsimple::Client::OauthService
The oauth-related API proxy.
-
#patch(path, data = nil, options = {}) ⇒ HTTParty::Response
Make a HTTP PATCH request.
-
#post(path, data = nil, options = {}) ⇒ HTTParty::Response
Make a HTTP POST request.
-
#put(path, data = nil, options = {}) ⇒ HTTParty::Response
Make a HTTP PUT request.
-
#registrar ⇒ Dnsimple::Client::RegistrarService
The registrar-related API proxy.
-
#request(method, path, data = nil, options = {}) ⇒ HTTParty::Response
Make a HTTP request.
-
#services ⇒ Dnsimple::Client::ServicesService
The one-click-service-related API proxy.
-
#templates ⇒ Dnsimple::Client::TemplatesService
The templates-related API proxy.
-
#tlds ⇒ Dnsimple::Client::TldsService
The tld-related API proxy.
-
#webhooks ⇒ Dnsimple::Client::WebhooksService
The webhooks-related API proxy.
-
#zones ⇒ Dnsimple::Client::ZonesService
The zone-related API proxy.
Constructor Details
#initialize(options = {}) ⇒ Client
Returns a new instance of Client.
53 54 55 56 57 58 59 60 61 |
# File 'lib/dnsimple/client.rb', line 53 def initialize( = {}) defaults = Dnsimple::Default. Dnsimple::Default.keys.each do |key| instance_variable_set(:"@#{key}", [key] || defaults[key]) end @services = {} end |
Instance Attribute Details
#access_token ⇒ String
Returns Domain API access token for authentication.
49 50 |
# File 'lib/dnsimple/client.rb', line 49 attr_accessor :username, :password, :domain_api_token, :access_token, :base_url, :user_agent, :proxy |
#base_url ⇒ String
Returns Base URL for API requests.
49 50 |
# File 'lib/dnsimple/client.rb', line 49 attr_accessor :username, :password, :domain_api_token, :access_token, :base_url, :user_agent, :proxy |
#domain_api_token ⇒ String
Returns Domain API access token for authentication.
49 50 |
# File 'lib/dnsimple/client.rb', line 49 attr_accessor :username, :password, :domain_api_token, :access_token, :base_url, :user_agent, :proxy |
#password ⇒ String
Returns DNSimple password for Basic Authentication.
49 50 |
# File 'lib/dnsimple/client.rb', line 49 attr_accessor :username, :password, :domain_api_token, :access_token, :base_url, :user_agent, :proxy |
#proxy ⇒ String?
Returns Configure address:port values for proxy server.
49 50 |
# File 'lib/dnsimple/client.rb', line 49 attr_accessor :username, :password, :domain_api_token, :access_token, :base_url, :user_agent, :proxy |
#user_agent ⇒ String
Returns Configure User-Agent header for requests.
49 50 |
# File 'lib/dnsimple/client.rb', line 49 attr_accessor :username, :password, :domain_api_token, :access_token, :base_url, :user_agent, :proxy |
#username ⇒ String
Returns DNSimple username for Basic Authentication.
49 50 51 |
# File 'lib/dnsimple/client.rb', line 49 def username @username end |
Class Method Details
.versioned(path) ⇒ String
Prepends the correct API version to path
.
25 26 27 |
# File 'lib/dnsimple/client.rb', line 25 def self.versioned(path) File.join(API_VERSION, path) end |
Instance Method Details
#contacts ⇒ Dnsimple::Client::ContactsService
Returns The contact-related API proxy.
5 6 7 |
# File 'lib/dnsimple/client/clients.rb', line 5 def contacts @services[:contacts] ||= Client::ContactsService.new(self) end |
#delete(path, data = nil, options = {}) ⇒ HTTParty::Response
Make a HTTP DELETE request.
114 115 116 |
# File 'lib/dnsimple/client.rb', line 114 def delete(path, data = nil, = {}) execute :delete, path, data, end |
#domains ⇒ Dnsimple::Client::DomainsService
Returns The domain-related API proxy.
10 11 12 |
# File 'lib/dnsimple/client/clients.rb', line 10 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.
129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/dnsimple/client.rb', line 129 def execute(method, path, data = nil, = {}) response = request(method, path, data, ) 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.
75 76 77 |
# File 'lib/dnsimple/client.rb', line 75 def get(path, = {}) execute :get, path, nil, end |
#identity ⇒ Dnsimple::Client::IdentityService
Returns The identity-related API proxy.
15 16 17 |
# File 'lib/dnsimple/client/clients.rb', line 15 def identity @services[:auth] ||= Client::IdentityService.new(self) end |
#oauth ⇒ Dnsimple::Client::OauthService
Returns The oauth-related API proxy.
20 21 22 |
# File 'lib/dnsimple/client/clients.rb', line 20 def oauth @services[:oauth] ||= Client::OauthService.new(self) end |
#patch(path, data = nil, options = {}) ⇒ HTTParty::Response
Make a HTTP PATCH request.
105 106 107 |
# File 'lib/dnsimple/client.rb', line 105 def patch(path, data = nil, = {}) execute :patch, path, data, end |
#post(path, data = nil, options = {}) ⇒ HTTParty::Response
Make a HTTP POST request.
85 86 87 |
# File 'lib/dnsimple/client.rb', line 85 def post(path, data = nil, = {}) execute :post, path, data, end |
#put(path, data = nil, options = {}) ⇒ HTTParty::Response
Make a HTTP PUT request.
95 96 97 |
# File 'lib/dnsimple/client.rb', line 95 def put(path, data = nil, = {}) execute :put, path, data, end |
#registrar ⇒ Dnsimple::Client::RegistrarService
Returns The registrar-related API proxy.
25 26 27 |
# File 'lib/dnsimple/client/clients.rb', line 25 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.
157 158 159 160 161 162 163 164 165 166 |
# File 'lib/dnsimple/client.rb', line 157 def request(method, path, data = nil, = {}) = Extra.deep_merge!(, ) if data [:headers]["Content-Type"] = content_type([:headers]) [:body] = content_data([:headers], data) end HTTParty.send(method, base_url + path, ) end |
#services ⇒ Dnsimple::Client::ServicesService
Returns The one-click-service-related API proxy.
30 31 32 |
# File 'lib/dnsimple/client/clients.rb', line 30 def services @services[:services] ||= Client::ServicesService.new(self) end |
#templates ⇒ Dnsimple::Client::TemplatesService
Returns The templates-related API proxy.
35 36 37 |
# File 'lib/dnsimple/client/clients.rb', line 35 def templates @services[:templates] ||= Client::TemplatesService.new(self) end |
#tlds ⇒ Dnsimple::Client::TldsService
Returns The tld-related API proxy.
40 41 42 |
# File 'lib/dnsimple/client/clients.rb', line 40 def tlds @services[:tlds] ||= Client::TldsService.new(self) end |
#webhooks ⇒ Dnsimple::Client::WebhooksService
Returns The webhooks-related API proxy.
50 51 52 |
# File 'lib/dnsimple/client/clients.rb', line 50 def webhooks @services[:webhooks] ||= Client::WebhooksService.new(self) end |
#zones ⇒ Dnsimple::Client::ZonesService
Returns The zone-related API proxy.
45 46 47 |
# File 'lib/dnsimple/client/clients.rb', line 45 def zones @services[:zones] ||= Client::ZonesService.new(self) end |