dnsimple 2.2.0 → 3.0.0.pre.beta1

data/lib/dnsimple/client/tlds.rb

@@ -0,0 +1,88 @@
+module Dnsimple
+  class Client
+    module Tlds
+      # Lists the tlds available for registration
+      #
+      # @see https://developer.dnsimple.com/v2/tlds/#list
+      #
+      # @example List TLDs in the first page
+      #   client.tlds.list
+      #
+      # @example List TLDs, providing a specific page
+      #   client.tlds.list(query: { page: 2 })
+      #
+      # @param  [Hash] options the filtering and sorting option
+      # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Tld>]
+      #
+      # @raise [Dnsimple::RequestError]
+      def tlds(options = {})
+        response = client.get(Client.versioned("/tlds"), options)
+
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Tld.new(r) })
+      end
+      alias :list :tlds
+      alias :list_tlds :tlds
+
+      # Lists ALL the TLDs in DNSimple.
+      #
+      # This method is similar to {#tlds}, 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/tlds/#list
+      # @see #tlds
+      #
+      # @example List all TLDs in DNSimple
+      #     client.tlds.all
+      #
+      # @param  [Hash] options the filtering and sorting option
+      # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Tld>]
+      #
+      # @raise [Dnsimple::RequestError]
+      def all_tlds(options = {})
+        paginate(:tlds, options)
+      end
+      alias :all :all_tlds
+
+      # Gets a TLD's details
+      #
+      # @see https://developer.dnsimple.com/v2/tlds/#get
+      #
+      # @example Get information on a specific TLD
+      #     client.tlds.tld('com')
+      #
+      # @param  [#to_s] tld The TLD name.
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::Tld>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def tld(tld, options = {})
+        response = client.get(Client.versioned("/tlds/%s" % tld), options)
+
+        Dnsimple::Response.new(response, Struct::Tld.new(response["data"]))
+      end
+
+      # Gets the extended attributes for a TLD.
+      #
+      # @see https://developer.dnsimple.com/v2/tlds/#extended-attributes
+      #
+      # @example Get extended attributes for a specific TLD
+      #     client.tlds.extended_attributes('uk')
+      #
+      # @param  [#to_s] tld The TLD name.
+      # @param  [Hash] options
+      # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::ExtendedAttribute>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def extended_attributes(tld, options = {})
+        response = client.get(Client.versioned("/tlds/%s/extended_attributes" % tld), options)
+
+        Dnsimple::CollectionResponse.new(response, response["data"].map { |r| Struct::ExtendedAttribute.new(r) })
+      end
+    end
+  end
+end

data/lib/dnsimple/client/webhooks.rb

@@ -0,0 +1,82 @@
+module Dnsimple
+  class Client
+    module Webhooks
+
+      # Lists ALL the webhooks in the account.
+      #
+      # @see https://developer.dnsimple.com/v2/webhooks/#list
+      #
+      # @example List all webhooks
+      #   client.webhooks.list(1010)
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [Hash] options the filtering and sorting option
+      # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Webhook>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def webhooks(account_id, options = {})
+        response = client.get(Client.versioned("/%s/webhooks" % [account_id]), options)
+
+        Dnsimple::CollectionResponse.new(response, response["data"].map { |r| Struct::Webhook.new(r) })
+      end
+      alias :list :webhooks
+      alias :list_webhooks :webhooks
+
+      # Creates a webhook in the account.
+      #
+      # @see https://developer.dnsimple.com/v2/webhooks/#create
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [Hash] attributes
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::Webhook>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def create_webhook(account_id, attributes, options = {})
+        Extra.validate_mandatory_attributes(attributes, [:url])
+        response = client.post(Client.versioned("/%s/webhooks" % [account_id]), attributes, options)
+
+        Dnsimple::Response.new(response, Struct::Webhook.new(response["data"]))
+      end
+      alias :create :create_webhook
+
+      # Gets a webhook from the account.
+      #
+      # @see https://developer.dnsimple.com/v2/webhooks/#get
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] webhook_id The webhook ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::Webhook>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def webhook(account_id, webhook_id, options = {})
+        response = client.get(Client.versioned("/%s/webhooks/%s" % [account_id, webhook_id]), options)
+
+        Dnsimple::Response.new(response, Struct::Webhook.new(response["data"]))
+      end
+
+      # Deletes a webook from the account.
+      #
+      # WARNING: this cannot be undone.
+      #
+      # @see https://developer.dnsimple.com/v2/webooks/#delete
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] webhook_id The webhook ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def delete_webhook(account_id, webhook_id, options = {})
+        response = client.delete(Client.versioned("/%s/webhooks/%s" % [account_id, webhook_id]), nil, options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+      alias :delete :delete_webhook
+
+    end
+  end
+end

data/lib/dnsimple/client/zones.rb

@@ -0,0 +1,68 @@
+module Dnsimple
+  class Client
+    module Zones
+
+      # Lists the zones in the account.
+      #
+      # @see https://developer.dnsimple.com/v2/zones/#list
+      # @see #all_zones
+      #
+      # @example List zones in the first page
+      #   client.zones.list(1010, "example.com")
+      #
+      # @example List zones, provide a specific page
+      #   client.zones.list(1010, "example.com", query: { page: 2 })
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [Hash] options the filtering and sorting option
+      # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Zone>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def zones(account_id, options = {})
+        response = client.get(Client.versioned("/%s/zones" % [account_id]), options)
+
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Zone.new(r) })
+      end
+      alias :list :zones
+      alias :list_zones :zones
+
+      # Lists ALL the zones in the account.
+      #
+      # This method is similar to {#zones}, 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/zones/#list
+      # @see #zones
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [Hash] options the filtering and sorting option
+      # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Zone>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def all_zones(account_id, options = {})
+        paginate(:zones, account_id, options)
+      end
+
+      # Gets a zone from the account.
+      #
+      # @see https://developer.dnsimple.com/v2/zones/#get
+      #
+      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [#to_s] zone_id the zone name
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::Zone>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def zone(account_id, zone_id, options = {})
+        response = client.get(Client.versioned("/%s/zones/%s" % [account_id, zone_id]), options)
+
+        Dnsimple::Response.new(response, Struct::Zone.new(response["data"]))
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/zones_records.rb

@@ -0,0 +1,127 @@
+module Dnsimple
+  class Client
+    module ZonesRecords
+
+      # Lists the zone records in the account.
+      #
+      # @see https://developer.dnsimple.com/v2/zones/records/#list
+      # @see #all_records
+      #
+      # @example List records for the zone "example.com" in the first page
+      #   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 })
+      #
+      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [String] zone_id the zone name
+      # @param  [Hash] options the filtering and sorting option
+      # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Record>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def records(account_id, zone_id, options = {})
+        response = client.get(Client.versioned("/%s/zones/%s/records" % [account_id, zone_id]), options)
+
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Record.new(r) })
+      end
+      alias :list_records :records
+
+      # Lists ALL the zone records in the account.
+      #
+      # 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/zones/records/#list
+      # @see #records
+      #
+      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [String] zone_id the zone name
+      # @param  [Hash] options the filtering and sorting option
+      # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Record>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def all_records(account_id, zone_id, options = {})
+        paginate(:records, account_id, zone_id, options)
+      end
+
+      # 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
+      # @param  [String] zone_id the zone name
+      # @param  [Hash] attributes
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::Record>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def create_record(account_id, zone_id, attributes, options = {})
+        Extra.validate_mandatory_attributes(attributes, [:type, :name, :content])
+        response = client.post(Client.versioned("/%s/zones/%s/records" % [account_id, zone_id]), attributes, options)
+
+        Dnsimple::Response.new(response, Struct::Record.new(response["data"]))
+      end
+
+      # 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
+      # @param  [String] zone_id the zone name
+      # @param  [Fixnum] record_id the record ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::Domain>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def record(account_id, zone_id, record_id, options = {})
+        response = client.get(Client.versioned("/%s/zones/%s/records/%s" % [account_id, zone_id, record_id]), options)
+
+        Dnsimple::Response.new(response, Struct::Record.new(response["data"]))
+      end
+
+      # Updates a zone record in the account.
+      #
+      # @see https://developer.dnsimple.com/v2/zones/records/#update
+      #
+      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [String] zone_id the zone name
+      # @param  [Fixnum] record_id the record ID
+      # @param  [Hash] attributes
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::Record>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def update_record(account_id, zone_id, record_id, attributes, options = {})
+        response = client.patch(Client.versioned("/%s/zones/%s/records/%s" % [account_id, zone_id, record_id]), attributes, options)
+
+        Dnsimple::Response.new(response, Struct::Record.new(response["data"]))
+      end
+
+      # Deletes a zone record from the account.
+      #
+      # WARNING: this cannot be undone.
+      #
+      # @see https://developer.dnsimple.com/v2/zones/records/#delete
+      #
+      # @param  [Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT] account_id the account ID or wildcard
+      # @param  [String] zone_id the zone 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, zone_id, record_id, options = {})
+        response = client.delete(Client.versioned("/%s/zones/%s/records/%s" % [account_id, zone_id, record_id]), nil, options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+
+    end
+  end
+end

data/lib/dnsimple/default.rb

@@ -4,7 +4,7 @@ module Dnsimple
   module Default
 
     # Default API endpoint
-    API_ENDPOINT = "https://api.dnsimple.com/".freeze
+    BASE_URL = "https://api.dnsimple.com/".freeze
 
     # Default User Agent header
     USER_AGENT   = "dnsimple-ruby/#{VERSION}".freeze
@@ -15,11 +15,10 @@ module Dnsimple
       # @return [Array] of option keys
       def keys
         @keys ||= [
-            :api_endpoint,
+            :base_url,
             :username,
             :password,
-            :exchange_token,
-            :api_token,
+            :access_token,
             :domain_api_token,
             :user_agent,
             :proxy,
@@ -32,10 +31,10 @@ module Dnsimple
         Hash[keys.map { |key| [key, send(key)]}]
       end
 
-      # Default API endpoint from ENV or {API_ENDPOINT}
+      # Default API endpoint from ENV or {BASE_URL}
       # @return [String]
-      def api_endpoint
-        ENV['DNSIMPLE_API_ENDPOINT'] || API_ENDPOINT
+      def base_url
+        ENV['DNSIMPLE_BASE_URL'] || BASE_URL
       end
 
       # Default DNSimple username for Basic Auth from ENV
@@ -50,10 +49,10 @@ module Dnsimple
         ENV['DNSIMPLE_PASSWORD']
       end
 
-      # Default DNSimple Exchange Token for Basic Auth from ENV
+      # Default DNSimple access token for OAuth authentication from ENV
       # @return [String]
-      def exchange_token
-        ENV['DNSIMPLE_API_EXCHANGE_TOKEN']
+      def access_token
+        ENV['DNSIMPLE_ACCESS_TOKEN']
       end
 
       # Default DNSimple Domain API Token for Token Auth from ENV
@@ -62,12 +61,6 @@ module Dnsimple
         ENV['DNSIMPLE_API_DOMAIN_TOKEN']
       end
 
-      # Default DNSimple API Token for Token Auth from ENV
-      # @return [String]
-      def api_token
-        ENV['DNSIMPLE_API_TOKEN']
-      end
-
       # Default User-Agent header string from ENV or {USER_AGENT}
       # @return [String]
       def user_agent
@@ -83,4 +76,4 @@ module Dnsimple
     end
   end
 
-end
+end

data/lib/dnsimple/error.rb

@@ -3,12 +3,13 @@ module Dnsimple
   class Error < StandardError
   end
 
+  # RequestError is raised when an API request fails for an client, a server error or invalid request information.
   class RequestError < Error
-    attr_reader :response
+    attr_reader :http_response
 
-    def initialize(response)
-      @response = response
-      super("#{response.code}")
+    def initialize(http_response)
+      @http_response = http_response
+      super(http_response.code.to_s)
     end
   end
 
@@ -21,8 +22,4 @@ module Dnsimple
   class AuthenticationFailed < AuthenticationError
   end
 
-  # An exception that is raised if a request is executed for an account that requires two-factor authentication.
-  class TwoFactorAuthenticationRequired < AuthenticationError
-  end
-
 end