dnsimple 3.0.0 → 3.1.0

data/lib/dnsimple/client/identity.rb

@@ -7,15 +7,12 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/identity/#whoami
       #
       # @param  [Hash] options
-      # @return [Dnsimple::Response<Hash>]
+      # @return [Dnsimple::Response<Dnsimple::Struct::Whoami>]
       # @raise  [Dnsimple::RequestError]
       def whoami(options = {})
         response = client.get(Client.versioned("/whoami"), options)
 
-        data = response["data"]
-        account = data["account"] ? Struct::Account.new(data["account"]) : nil
-        user = data["user"] ? Struct::User.new(data["user"]) : nil
-        Response.new(response, account: account, user: user)
+        Dnsimple::Response.new(response, Struct::Whoami.new(response["data"]))
       end
 
 

data/lib/dnsimple/client/registrar.rb

@@ -28,7 +28,7 @@ module Dnsimple
       #
       # @example Initiate the registration of example.com using the contact 1234 as registrant
       #   including WHOIS privacy for the domain and enabling auto renewal:
-      #   client.registrar.register(1010, "example.com", registrant_id: 1234, privacy: true, auto_renew: true)
+      #   client.registrar.register(1010, "example.com", registrant_id: 1234, private_whois: true, auto_renew: true)
       #
       # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_name the domain name to register

data/lib/dnsimple/client/registrar_auto_renewal.rb

@@ -6,7 +6,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/registrar/auto-renewal/
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_name the domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]
@@ -23,7 +23,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/registrar/auto-renewal/
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] domain_name the domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]

data/lib/dnsimple/client/services.rb

@@ -9,13 +9,22 @@ module Dnsimple
       # @example List one-click services:
       #   client.services.list_services
       #
-      # @param  [Hash] options
+      # @example List one-click services, provide a specific page:
+      #   client.services.list_services(page: 2)
+      #
+      # @example List one-click services, provide a sorting policy:
+      #   client.services.list_services(sort: "short_name:asc")
+      #
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Service>]
       #
       # @raise  [RequestError] When the request fails.
       def services(options = {})
         endpoint = Client.versioned("/services")
-        response = client.get(endpoint, options)
+        response = client.get(endpoint, Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Service.new(r) })
       end
@@ -36,7 +45,10 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/services/#list
       # @see #services
       #
-      # @param  [Hash] options
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Service>]
       #
       # @raise  [RequestError] When the request fails.

data/lib/dnsimple/client/templates.rb

@@ -9,14 +9,23 @@ module Dnsimple
       # @example List the templates for account 1010:
       #   client.templates.list_templates(1010)
       #
+      # @example List the templates for account 1010, provide a specific page:
+      #   client.templates.list_templates(1010, page: 2)
+      #
+      # @example List the templates for account 1010, provide sorting policy:
+      #   client.templates.list_templates(1010, sort: "short_name:asc")
+      #
       # @param  [Fixnum] account_id the account ID
-      # @param  [Hash] options
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Template>]
       #
       # @raise  [RequestError] When the request fails.
       def templates(account_id, options = {})
         endpoint = Client.versioned("/%s/templates" % [account_id])
-        response = client.get(endpoint, options)
+        response = client.get(endpoint, Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Template.new(r) })
       end
@@ -38,7 +47,10 @@ module Dnsimple
       # @see #templates
       #
       # @param  [Fixnum] account_id the account ID
-      # @param  [Hash] options
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Template>]
       #
       # @raise  [RequestError] When the request fails.
@@ -95,7 +107,7 @@ module Dnsimple
       # @example Change the name of template 1 in account 1010:
       #   client.templates.update_template(1010, 1, name: "New name")
       #
-      # @param  [Fixnum] account_iduthe account ID
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] template_id The template ID
       # @param  [Hash] attributes
       # @param  [Hash] options

data/lib/dnsimple/client/templates_records.rb

@@ -0,0 +1,135 @@
+module Dnsimple
+  class Client
+    module TemplatesRecords
+
+      # Lists the records in the template.
+      #
+      # @see https://developer.dnsimple.com/v2/templates/records/#list
+      # @see #all_records
+      #
+      # @example List the first page of records for the template "alpha"
+      #   client.templates.records(1010, "alpha")
+      #
+      # @example List records for the template "alpha", providing a specific page
+      #   client.templates.records(1010, "alpha", page: 2)
+      #
+      # @example List records for the template "alpha", providing sorting policy
+      #   client.templates.records(1010, "alpha", sort: "type:asc")
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [String] template_id the template name
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
+      # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::TemplateRecord>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def records(account_id, template_id, options = {})
+        endpoint = Client.versioned("/%s/templates/%s/records" % [account_id, template_id])
+        response = client.get(endpoint, Options::ListOptions.new(options))
+
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::TemplateRecord.new(r) })
+      end
+      alias list_records records
+
+      # Lists ALL the records in the template.
+      #
+      # This method is similar to {#records}, but instead of returning the results of a specific page
+      # it iterates all the pages and returns the entire collection.
+      #
+      # Please use this method carefully, as fetching the entire collection will increase the number of requests
+      # you send to the API server and you may eventually risk to hit the throttle limit.
+      #
+      # @see https://developer.dnsimple.com/v2/templates/records/#list
+      # @see #all_records
+      #
+      # @example List all the records for "alpha template
+      #   client.templates.all_records(1010, "alpha")
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [String] template_id the template name
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
+      # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::TemplateRecord>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def all_records(account_id, template_id, options = {})
+        paginate(:records, account_id, template_id, options)
+      end
+
+      # Creates a record in the template.
+      #
+      # @see https://developer.dnsimple.com/v2/templates/records/#create
+      #
+      # @example Create an A record for "alpha" template
+      #   client.templates.create_record(1010, "alpha", name: "", type: "A", content: "192.168.1.1", ttl: 600)
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [String] template_id the template name
+      # @param  [Hash] attributes
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::TemplateRecord>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def create_record(account_id, template_id, attributes, options = {})
+        Extra.validate_mandatory_attributes(attributes, [:type, :name, :content])
+        endpoint = Client.versioned("/%s/templates/%s/records" % [account_id, template_id])
+        response = client.post(endpoint, attributes, options)
+
+        Dnsimple::Response.new(response, Struct::TemplateRecord.new(response["data"]))
+      end
+
+      # Gets a record from the template.
+      #
+      # @see https://developer.dnsimple.com/v2/templates/records/#get
+      #
+      # @example Get record 123 in "alpha template
+      #   client.templates.record(1010, "alpha", 123)
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [String] template_id the template name
+      # @param  [Fixnum] record_id the record ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::TemplateRecord>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def record(account_id, template_id, record_id, options = {})
+        endpoint = Client.versioned("/%s/templates/%s/records/%s" % [account_id, template_id, record_id])
+        response = client.get(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::TemplateRecord.new(response["data"]))
+      end
+
+      # Deletes a record from the template.
+      #
+      # WARNING: this cannot be undone.
+      #
+      # @see https://developer.dnsimple.com/v2/templates/records/#delete
+      #
+      # @example Delete record 123 in "alpha template
+      #   client.templates.delete_record(1010, "alpha", 123)
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [String] template_id the template name
+      # @param  [Fixnum] record_id the record ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def delete_record(account_id, template_id, record_id, options = {})
+        endpoint = Client.versioned("/%s/templates/%s/records/%s" % [account_id, template_id, record_id])
+        response = client.delete(endpoint, options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+    end
+  end
+end

data/lib/dnsimple/client/tlds.rb

@@ -9,14 +9,20 @@ module Dnsimple
       #   client.tlds.list
       #
       # @example List TLDs, providing a specific page
-      #   client.tlds.list(query: { page: 2 })
+      #   client.tlds.list(page: 2)
       #
-      # @param  [Hash] options the filtering and sorting option
+      # @example List TLDs, providing sorting policy
+      #   client.tlds.list(sort: "tld:asc")
+      #
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Tld>]
       #
       # @raise [Dnsimple::RequestError]
       def tlds(options = {})
-        response = client.get(Client.versioned("/tlds"), options)
+        response = client.get(Client.versioned("/tlds"), Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Tld.new(r) })
       end
@@ -37,7 +43,10 @@ module Dnsimple
       # @example List all TLDs in DNSimple
       #     client.tlds.all
       #
-      # @param  [Hash] options the filtering and sorting option
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
       # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Tld>]
       #
       # @raise [Dnsimple::RequestError]

data/lib/dnsimple/client/webhooks.rb

@@ -9,13 +9,22 @@ module Dnsimple
       # @example List all webhooks
       #   client.webhooks.list(1010)
       #
+      # @example List all webhooks, provide a specific page
+      #   client.webhooks.list(1010, page: 2)
+      #
+      # @example List all webhooks, provide sorting policy
+      #   client.webhooks.list(1010, sort: "id:asc")
+      #
       # @param  [Fixnum] account_id the account ID
-      # @param  [Hash] options the filtering and sorting option
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
       # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Webhook>]
       #
       # @raise  [Dnsimple::RequestError]
       def webhooks(account_id, options = {})
-        response = client.get(Client.versioned("/%s/webhooks" % [account_id]), options)
+        response = client.get(Client.versioned("/%s/webhooks" % [account_id]), Options::ListOptions.new(options))
 
         Dnsimple::CollectionResponse.new(response, response["data"].map { |r| Struct::Webhook.new(r) })
       end

data/lib/dnsimple/client/zones.rb

@@ -11,15 +11,25 @@ module Dnsimple
       #   client.zones.list(1010, "example.com")
       #
       # @example List zones, provide a specific page
-      #   client.zones.list(1010, "example.com", query: { page: 2 })
+      #   client.zones.list(1010, "example.com", page: 2)
+      #
+      # @example List zones, provide sorting policy
+      #   client.zones.list(1010, "example.com", sort: "name:desc")
+      #
+      # @example List zones, provide filtering policy
+      #   client.zones.list(1010, "example.com", filter: { name_like: "example" })
       #
       # @param  [Fixnum] account_id the account ID
-      # @param  [Hash] options the filtering and sorting option
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
+      # @option options [Hash] :filter filtering policy
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Zone>]
       #
       # @raise  [Dnsimple::RequestError]
       def zones(account_id, options = {})
-        response = client.get(Client.versioned("/%s/zones" % [account_id]), options)
+        response = client.get(Client.versioned("/%s/zones" % [account_id]), Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Zone.new(r) })
       end
@@ -38,7 +48,11 @@ module Dnsimple
       # @see #zones
       #
       # @param  [Fixnum] account_id the account ID
-      # @param  [Hash] options the filtering and sorting option
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
+      # @option options [Hash] :filter filtering policy
       # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Zone>]
       #
       # @raise  [Dnsimple::RequestError]
@@ -50,7 +64,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/zones/#get
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [Fixnum] account_id the account ID
       # @param  [#to_s] zone_id the zone name
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Zone>]

data/lib/dnsimple/client/zones_records.rb

@@ -11,19 +11,31 @@ module Dnsimple
       #   client.zones.records(1010, "example.com")
       #
       # @example List records for the zone "example.com", provide a specific page
-      #   client.zones.records(1010, "example.com", query: { page: 2 })
+      #   client.zones.records(1010, "example.com", page: 2)
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @example List records for the zone "example.com", provide sorting policy
+      #   client.zones.records(1010, "example.com", sort: "type:asc")
+      #
+      # @example List records for the zone "example.com", provide filtering policy
+      #   client.zones.records(1010, "example.com", sort: "type:asc")
+      #
+      # @param  [Fixnum] account_id the account ID
       # @param  [String] zone_id the zone name
-      # @param  [Hash] options the filtering and sorting option
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
+      # @option options [Hash] :filter filtering policy
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Record>]
       #
+      # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
       def records(account_id, zone_id, options = {})
-        response = client.get(Client.versioned("/%s/zones/%s/records" % [account_id, zone_id]), options)
+        response = client.get(Client.versioned("/%s/zones/%s/records" % [account_id, zone_id]), Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Record.new(r) })
       end
+      alias list records
       alias list_records records
 
       # Lists ALL the zone records in the account.
@@ -37,26 +49,39 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/zones/records/#list
       # @see #records
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @example List all records for the zone "example.com"
+      #   client.zones.all_records(1010, "example.com")
+      #
+      # @param  [Fixnum] account_id the account ID
       # @param  [String] zone_id the zone name
-      # @param  [Hash] options the filtering and sorting option
+      # @param  [Hash] options the filtering and sorting options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
+      # @option options [Hash] :filter filtering policy
       # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Record>]
       #
+      # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
       def all_records(account_id, zone_id, options = {})
         paginate(:records, account_id, zone_id, options)
       end
+      alias all all_records
 
       # Creates a zone record in the account.
       #
       # @see https://developer.dnsimple.com/v2/zones/records/#create
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @example Create a URL record in zone "example.com"
+      #   client.zones.create_record(1010, "example.com", name: "www", type: "url", content: "example.com")
+      #
+      # @param  [Fixnum] account_id the account ID
       # @param  [String] zone_id the zone name
       # @param  [Hash] attributes
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Record>]
       #
+      # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
       def create_record(account_id, zone_id, attributes, options = {})
         Extra.validate_mandatory_attributes(attributes, [:type, :name, :content])
@@ -64,16 +89,20 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Record.new(response["data"]))
       end
+      alias create create_record
 
       # Gets a zone record from the account.
       #
       # @see https://developer.dnsimple.com/v2/zones/records/#get
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @example Get record 123 in zone "example.com"
+      #   client.zones.record(1010, "example.com", 123)
+      #
+      # @param  [Fixnum] account_id the account ID
       # @param  [String] zone_id the zone name
       # @param  [Fixnum] record_id the record ID
       # @param  [Hash] options
-      # @return [Dnsimple::Response<Dnsimple::Struct::Domain>]
+      # @return [Dnsimple::Response<Dnsimple::Struct::Record>]
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
@@ -87,7 +116,10 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/zones/records/#update
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @example Update the TTL to 600 of record 123 in zone "example.com"
+      #   client.zones.update_record(1010, "example.com", 123, ttl: 600)
+      #
+      # @param  [Fixnum] account_id the account ID
       # @param  [String] zone_id the zone name
       # @param  [Fixnum] record_id the record ID
       # @param  [Hash] attributes
@@ -101,6 +133,7 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Record.new(response["data"]))
       end
+      alias update update_record
 
       # Deletes a zone record from the account.
       #
@@ -108,7 +141,10 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/zones/records/#delete
       #
-      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @example Delete record 123 in zone "example.com"
+      #   client.zones.delete_record(1010, "example.com", 123)
+      #
+      # @param  [Fixnum] account_id the account ID
       # @param  [String] zone_id the zone name
       # @param  [Fixnum] record_id the record ID
       # @param  [Hash] options
@@ -121,6 +157,7 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
+      alias delete delete_record
 
     end
   end