dnsimple 2.0.0.alpha2 → 2.0.0.alpha3

data/lib/dnsimple/client/registrars_service.rb

@@ -0,0 +1,105 @@
+module Dnsimple
+  class Client
+    class RegistrarsService < ClientService
+
+      # Checks the availability of a domain name.
+      #
+      # @see http://developer.dnsimple.com/domains/registry/#check
+      #
+      # @param  [#to_s] name The domain name to check.
+      #
+      # @return [String] "available" or "registered"
+      # @raise  [RequestError] When the request fails.
+      def check(name, options={})
+        begin
+          client.get("v1/domains/#{name}/check", options)
+          "registered"
+        rescue RecordNotFound
+          "available"
+        end
+      end
+
+      # Registers a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/registry/#register
+      #
+      # @param  [#to_s] name The domain name to register.
+      # @param  [Fixnum] registrant_id The id of the contact to use as registrant.
+      # @param  [Hash] extended_attributes
+      # @param  [Hash] options
+      #
+      # @return [Struct::Domain]
+      # @raise  [RequestError] When the request fails.
+      def register(name, registrant_id, extended_attributes = {}, options = {})
+        options = Extra.deep_merge(options, { domain: { name: name, registrant_id: registrant_id }, extended_attribute: extended_attributes })
+        response = client.post("v1/domain_registrations", options)
+
+        Struct::Domain.new(response["domain"])
+      end
+
+      # Transfers a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/registry/#transfer
+      #
+      # @param  [#to_s] name The domain name to register.
+      # @param  [String] auth_code
+      # @param  [Fixnum] registrant_id The id of the contact to use as registrant.
+      # @param  [Hash] extended_attributes
+      # @param  [Hash] options
+      #
+      # @return [Struct::TransferOrder]
+      # @raise  [RequestError] When the request fails.
+      def transfer(name, auth_code, registrant_id, extended_attributes = {}, options = {})
+        options = Extra.deep_merge(options, { domain: { name: name, registrant_id: registrant_id }, extended_attribute: extended_attributes, transfer_order: { authinfo: auth_code }})
+        response = client.post("v1/domain_transfers", options)
+
+        Struct::TransferOrder.new(response["transfer_order"])
+      end
+
+      # Renew a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/registry/#renew
+      #
+      # @param  [#to_s] name The domain name to renew.
+      # @param  [Hash] options
+      #
+      # @return [Struct::Domain]
+      # @raise  [RequestError] When the request fails.
+      def renew(name, options = {})
+        options = Extra.deep_merge(options, { domain: { name: name }})
+        response = client.post("v1/domain_renewals", options)
+
+        Struct::Domain.new(response["domain"])
+      end
+
+
+      # List the extended attributes for a TLD.
+      #
+      # @see http://developer.dnsimple.com/registrar/extended-attributes/#list
+      #
+      # @param  [#to_s] tld The TLD name.
+      #
+      # @return [Array<Struct::ExtendedAttribute>]
+      # @raise  [RequestError] When the request fails.
+      def list_extended_attributes(tld)
+        response = client.get("v1/extended_attributes/#{tld}")
+
+        response.map { |r| Struct::ExtendedAttribute.new(r) }
+      end
+
+
+      # List all the TLD prices.
+      #
+      # @see http://developer.dnsimple.com/registrar/prices/#list
+      #
+      # @return [Array<Struct::Price>]
+      # @raise  [RequestError] When the request fails.
+      def list_prices
+        response = client.get("v1/prices")
+
+        response.map { |r| Struct::Price.new(r["price"]) }
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/services_service.rb

@@ -0,0 +1,95 @@
+module Dnsimple
+  class Client
+    class ServicesService < ClientService
+
+      # Lists the supported services.
+      #
+      # @see http://developer.dnsimple.com/services/#list
+      #
+      # @return [Array<Struct::Service>]
+      # @raise  [RequestError] When the request fails.
+      def list
+        response = client.get("v1/services")
+
+        response.map { |r| Struct::Service.new(r["service"]) }
+      end
+
+      # Gets a service.
+      #
+      # @see http://developer.dnsimple.com/services/#get
+      #
+      # @param  [Fixnum] service The service id.
+      #
+      # @return [Struct::Service]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def find(service)
+        response = client.get("v1/services/#{service}")
+
+        Struct::Service.new(response["service"])
+      end
+
+      # Lists the services applied to a domain.
+      #
+      # @see http://developer.dnsimple.com/services/#applied
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [Array<Struct::Service>]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def applied(domain)
+        response = client.get("v1/domains/#{domain}/applied_services")
+
+        response.map { |r| Struct::Service.new(r["service"]) }
+      end
+
+      # Lists the services not applied to a domain.
+      #
+      # @see http://developer.dnsimple.com/services/#available
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [Array<Struct::Service>]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def available(domain)
+        response = client.get("v1/domains/#{domain}/available_services")
+
+        response.map { |r| Struct::Service.new(r["service"]) }
+      end
+
+      # Applies a service to a domain.
+      #
+      # @see http://developer.dnsimple.com/services/#apply
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Fixnum] service The service id.
+      #
+      # @return [void]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def apply(domain, service)
+        options  = { service: { id: service }}
+        response = client.post("v1/domains/#{domain}/applied_services", options)
+        response.code == 200
+      end
+
+      # Un-applies a service from a domain.
+      #
+      # @see http://developer.dnsimple.com/services/#unapply
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Fixnum] service The service id.
+      #
+      # @return [void]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def unapply(domain, service)
+        response = client.delete("v1/domains/#{domain}/applied_services/#{service}")
+        response.code == 200
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/templates_service.rb

@@ -0,0 +1,180 @@
+module Dnsimple
+  class Client
+    class TemplatesService < ClientService
+
+      # Lists the templates in the account.
+      #
+      # @see http://developer.dnsimple.com/templates/#list
+      #
+      # @return [Array<Struct::Template>]
+      # @raise  [RequestError] When the request fails.
+      def list
+        response = client.get("v1/templates")
+
+        response.map { |r| Struct::Template.new(r["dns_template"]) }
+      end
+
+      # Creates a template in the account.
+      #
+      # @see http://developer.dnsimple.com/templates/#create
+      #
+      # @param  [Hash] attributes
+      #
+      # @return [Struct::Template]
+      # @raise  [RequestError] When the request fails.
+      def create(attributes = {})
+        Extra.validate_mandatory_attributes(attributes, [:name, :short_name])
+        options  = { dns_template: attributes }
+        response = client.post("v1/templates", options)
+
+        Struct::Template.new(response["dns_template"])
+      end
+
+      # Gets a template from the account.
+      #
+      # @see http://developer.dnsimple.com/templates/#get
+      #
+      # @param  [#to_s] template The template id or short-name.
+      #
+      # @return [Struct::Template]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def find(template)
+        response = client.get("v1/templates/#{template}")
+
+        Struct::Template.new(response["dns_template"])
+      end
+
+      # Updates a template in the account.
+      #
+      # @see http://developer.dnsimple.com/templates/#update
+      #
+      # @param  [#to_s] template The template id or short-name.
+      # @param  [Hash] attributes
+      #
+      # @return [Struct::Template]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def update(template, attributes = {})
+        options  = { dns_template: attributes }
+        response = client.put("v1/templates/#{template}", options)
+
+        Struct::Template.new(response["dns_template"])
+      end
+
+      # Deletes a template from the account.
+      #
+      # WARNING: this cannot be undone.
+      #
+      # @see http://developer.dnsimple.com/templates/#delete
+      #
+      # @param  [#to_s] template The template id or short-name.
+      #
+      # @return [void]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def delete(template)
+        client.delete("v1/templates/#{template}")
+      end
+
+
+      # Applies the template to the domain.
+      #
+      # @see http://developer.dnsimple.com/templates/#apply
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [#to_s] template The template id or short-name.
+      #
+      # @return [void]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def apply(domain, template)
+        response = client.post("v1/domains/#{domain}/templates/#{template}/apply")
+        response.code == 200
+      end
+
+
+      # Lists the records for a template.
+      #
+      # @see http://developer.dnsimple.com/templates/records/#list
+      #
+      # @param  [#to_s] template The template id or short-name.
+      #
+      # @return [Array<Struct::TemplateRecord>]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def list_records(template)
+        response = client.get("v1/templates/#{template}/records")
+
+        response.map { |r| Struct::TemplateRecord.new(r["dns_template_record"]) }
+      end
+
+      # Creates a record for a template.
+      #
+      # @see http://developer.dnsimple.com/templates/records/#create
+      #
+      # @param  [#to_s] template The template id or short-name.
+      # @param  [Hash] attributes
+      #
+      # @return [Struct::TemplateRecord]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def create_record(template, attributes = {})
+        Extra.validate_mandatory_attributes(attributes, [:name, :record_type, :content])
+        options  = { dns_template_record: attributes }
+        response = client.post("v1/templates/#{template}/records", options)
+
+        Struct::TemplateRecord.new(response["dns_template_record"])
+      end
+
+      # Gets a record for a template.
+      #
+      # @see http://developer.dnsimple.com/templates/records/#delete
+      #
+      # @param  [#to_s] template The template id or short-name.
+      # @param  [Fixnum] record The record id.
+      #
+      # @return [Struct::TemplateRecord]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def find_record(template, record)
+        response = client.get("v1/templates/#{template}/records/#{record}")
+
+        Struct::TemplateRecord.new(response["dns_template_record"])
+      end
+
+      # Updates a record for a template.
+      #
+      # @see http://developer.dnsimple.com/templates/#update
+      #
+      # @param  [#to_s] template The template id or short-name.
+      # @param  [Fixnum] record The record id.
+      # @param  [Hash] attributes
+      #
+      # @return [Struct::TemplateRecord]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def update_record(template, record, attributes = {})
+        options  = { dns_template_record: attributes }
+        response = client.put("v1/templates/#{template}/records/#{record}", options)
+
+        Struct::TemplateRecord.new(response["dns_template_record"])
+      end
+
+      # Deletes a record for a template.
+      #
+      # @see http://developer.dnsimple.com/templates/records/#get
+      #
+      # @param  [#to_s] template The template id or short-name.
+      # @param  [Fixnum] record The record id.
+      #
+      # @return [Template]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def delete_record(template, record)
+        client.delete("v1/templates/#{template}/records/#{record}")
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/users_service.rb

@@ -0,0 +1,37 @@
+module Dnsimple
+  class Client
+    class UsersService < ClientService
+
+      # Fetches the information about the authenticated user.
+      #
+      # @return [Struct::User] The authenticated user.
+      # @raise  [RequestError] When the request fails.
+      def user
+        response = client.get("v1/user")
+
+        Struct::User.new(response["user"])
+      end
+
+      # Requests a new two-factor authentication exchange token.
+      #
+      # The exchange-token is required to validate API requests
+      # using HTTP Basic Authentication when the account has two-factor authentication enabled.
+      #
+      # @see http://developer.dnsimple.com/authentication/#twofa
+      #
+      # @example Request an Exchange Token
+      #   Dnsimple::User.two_factor_exchange_token('0000000')
+      #   # => "cda038832591e34f5df642ce2b61dc78"
+      #
+      # @param  [String] otp_token the two-factor one time (OTP) token.
+      #
+      # @return [String] The two-factor API exchange token.
+      # @raise  [AuthenticationFailed] if the provided OTP token is invalid.
+      def exchange_token(otp_token)
+        response = client.get("v1/user", headers: { Client::HEADER_2FA_STRICT => "1", Client::HEADER_OTP_TOKEN => otp_token })
+        response.headers[Client::HEADER_EXCHANGE_TOKEN]
+      end
+
+    end
+  end
+end

data/lib/dnsimple/compatibility.rb

@@ -0,0 +1,46 @@
+module Dnsimple
+
+  # {Client} backwards compatibility
+  module Compatibility
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        class << self
+          attr_accessor :base_uri, :username, :password, :exchange_token, :api_token, :domain_api_token
+        end
+      end
+    end
+
+    module ClassMethods
+      def client
+        options = {}
+        options[:api_endpoint] = base_uri if base_uri
+        options[:username] = username if username
+        options[:password] = password if password
+        options[:api_token] = api_token if api_token
+        options[:domain_api_token] = domain_api_token if domain_api_token
+        options[:exchange_token] = exchange_token if exchange_token
+
+        new(options)
+      end
+
+      def get(*args)
+        client.get(*args)
+      end
+
+      def post(*args)
+        client.post(*args)
+      end
+
+      def put(*args)
+        client.put(*args)
+      end
+
+      def delete(*args)
+        client.delete(*args)
+      end
+    end
+
+  end
+
+end