dnsimple 2.0.0.alpha2 → 2.0.0.alpha3

data/lib/dnsimple/client/client_service.rb

@@ -0,0 +1,8 @@
+module Dnsimple
+  class Client
+
+    class ClientService < ::Struct.new(:client)
+    end
+
+  end
+end

data/lib/dnsimple/client/contacts_service.rb

@@ -0,0 +1,82 @@
+module Dnsimple
+  class Client
+    class ContactsService < ClientService
+
+      # Lists the contacts in the account.
+      #
+      # @see http://developer.dnsimple.com/contacts/#list
+      #
+      # @return [Array<Struct::Contact>]
+      # @raise  [RequestError] When the request fails.
+      def list
+        response = client.get("v1/contacts")
+
+        response.map { |r| Struct::Contact.new(r["contact"]) }
+      end
+
+      # Creates a contact in the account.
+      #
+      # @see http://developer.dnsimple.com/contacts/#create
+      #
+      # @param  [Hash] attributes
+      #
+      # @return [Struct::Contact]
+      # @raise  [RequestError] When the request fails.
+      def create(attributes = {})
+        Extra.validate_mandatory_attributes(attributes, [:first_name, :last_name, :address1, :city, :state_province, :postal_code, :country, :phone, :email_address])
+        options  = { contact: attributes }
+        response = client.post("v1/contacts", options)
+
+        Struct::Contact.new(response["contact"])
+      end
+
+      # Gets a contact from the account.
+      #
+      # @see http://developer.dnsimple.com/contacts/#get
+      #
+      # @param  [Fixnum] contact The contact id.
+      #
+      # @return [Struct::Contact]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def find(contact)
+        response = client.get("v1/contacts/#{contact}")
+
+        Struct::Contact.new(response["contact"])
+      end
+
+      # Updates a contact in the account.
+      #
+      # @see http://developer.dnsimple.com/contacts/#update
+      #
+      # @param  [Fixnum] contact The contact id.
+      # @param  [Hash] attributes
+      #
+      # @return [Struct::Contact]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def update(contact, attributes = {})
+        options  = { contact: attributes }
+        response = client.put("v1/contacts/#{contact}", options)
+
+        Struct::Contact.new(response["contact"])
+      end
+
+      # Deletes a contact from the account.
+      #
+      # WARNING: this cannot be undone.
+      #
+      # @see http://developer.dnsimple.com/contacts/#delete
+      #
+      # @param  [Fixnum] contact The contact id.
+      #
+      # @return [void]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def delete(contact)
+        client.delete("v1/contacts/#{contact}")
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/domains_service.rb

@@ -0,0 +1,333 @@
+module Dnsimple
+  class Client
+    class DomainsService < ClientService
+
+      # Lists the domains in the account.
+      #
+      # @see http://developer.dnsimple.com/domains/#list
+      #
+      # @return [Array<Struct::Domain>]
+      # @raise  [RequestError] When the request fails.
+      def list(options = {})
+        response = client.get("v1/domains", options)
+
+        response.map { |r| Struct::Domain.new(r["domain"]) }
+      end
+
+      # Gets a domain from the account.
+      #
+      # @see http://developer.dnsimple.com/domains/#get
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [Struct::Domain]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def find(domain)
+        response = client.get("v1/domains/#{domain}")
+
+        Struct::Domain.new(response["domain"])
+      end
+
+      # Creates a domain in the account.
+      #
+      # @see http://developer.dnsimple.com/domains/#create
+      #
+      # @param  [Hash] attributes
+      #
+      # @return [Struct::Domain]
+      # @raise  [RequestError] When the request fails.
+      def create(attributes = {})
+        Extra.validate_mandatory_attributes(attributes, [:name])
+        options  = { domain: attributes }
+        response = client.post("v1/domains", options)
+
+        Struct::Domain.new(response["domain"])
+      end
+
+      # Deletes a domain from the account.
+      #
+      # WARNING: this cannot be undone.
+      #
+      # @see http://developer.dnsimple.com/domains/#delete
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [void]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def delete(domain)
+        client.delete("v1/domains/#{domain}")
+      end
+
+
+      # Lists the records for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/records/#list
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Hash] options
+      #
+      # @return [Array<Struct::Record>]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def list_records(domain, options = {})
+        response = client.get("v1/domains/#{domain}/records", options)
+
+        response.map { |r| Struct::Record.new(r["record"]) }
+      end
+
+      # Creates a record for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/records/#create
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Hash] attributes
+      #
+      # @return [Struct::Record]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def create_record(domain, attributes = {})
+        Extra.validate_mandatory_attributes(attributes, [:name, :record_type, :content])
+        options  = { record: attributes }
+        response = client.post("v1/domains/#{domain}/records", options)
+
+        Struct::Record.new(response["record"])
+      end
+
+      # Gets a record for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/records/#get
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Fixnum] record The record id.
+      #
+      # @return [Struct::Record]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def find_record(domain, record)
+        response = client.get("v1/domains/#{domain}/records/#{record}")
+
+        Struct::Record.new(response["record"])
+      end
+
+      # Updates a record for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/records/#update
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Fixnum] record The record id.
+      # @param  [Hash] attributes
+      #
+      # @return [Struct::Record]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def update_record(domain, record, attributes = {})
+        options  = { record: attributes }
+        response = client.put("v1/domains/#{domain}/records/#{record}", options)
+
+        Struct::Record.new(response["record"])
+      end
+
+      # Deletes a record for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/records/#delete
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Fixnum] record The record id.
+      #
+      # @return [void]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def delete_record(domain, record)
+        client.delete("v1/domains/#{domain}/records/#{record}")
+      end
+
+
+      # Enables auto-renewal for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/autorenewal/#enable
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [Struct::Domain]
+      # @raise  [RequestError] When the request fails.
+      def enable_auto_renewal(domain)
+        response = client.post("v1/domains/#{domain}/auto_renewal")
+
+        Struct::Domain.new(response["domain"])
+      end
+
+      # Disables auto-renewal for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/autorenewal/#disable
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [Struct::Domain]
+      # @raise  [RequestError] When the request fails.
+      def disable_auto_renewal(domain)
+        response = client.delete("v1/domains/#{domain}/auto_renewal")
+
+        Struct::Domain.new(response["domain"])
+      end
+
+
+      # Enables WHOIS privacy for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/privacy/#enable
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [Struct::WhoisPrivacy]
+      # @raise  [RequestError] When the request fails.
+      def enable_whois_privacy(domain)
+        response = client.post("v1/domains/#{domain}/whois_privacy")
+
+        Struct::WhoisPrivacy.new(response["whois_privacy"])
+      end
+
+      # Disables WHOIS privacy for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/privacy/#disable
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [Struct::WhoisPrivacy]
+      # @raise  [RequestError] When the request fails.
+      def disable_whois_privacy(domain)
+        response = client.delete("v1/domains/#{domain}/whois_privacy")
+
+        Struct::WhoisPrivacy.new(response["whois_privacy"])
+      end
+
+
+      # Lists the memberships.
+      #
+      # @see http://developer.dnsimple.com/domains/sharing/#list
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [Array<Struct::Membership>]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def list_memberships(domain)
+        response = client.get("v1/domains/#{domain}/memberships")
+
+        response.map { |r| Struct::Membership.new(r["membership"]) }
+      end
+
+      # Shares a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/sharing/#create
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [String] email
+      #
+      # @return [Struct::Membership]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def create_membership(domain, email)
+        options  = { membership: { email: email }}
+        response = client.post("v1/domains/#{domain}/memberships", options)
+
+        Struct::Membership.new(response["membership"])
+      end
+
+      # Un-shares a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/sharing/#delete
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Fixnum] membership The membership id.
+      #
+      # @return [void]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def delete_membership(domain, membership)
+        client.delete("v1/domains/#{domain}/memberships/#{membership}")
+      end
+
+
+      # Lists the email forwards for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/forwards/#list
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [Array<Struct::EmailForward>]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def list_email_forwards(domain)
+        response = client.get("v1/domains/#{domain}/email_forwards")
+
+        response.map { |r| Struct::EmailForward.new(r["email_forward"]) }
+      end
+
+      # Creates an email forward for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/forwards/#create
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Hash] attributes
+      #
+      # @return [Struct::EmailForward]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def create_email_forward(domain, attributes = {})
+        Extra.validate_mandatory_attributes(attributes, [:from, :to])
+        options  = { email_forward: attributes }
+        response = client.post("v1/domains/#{domain}/email_forwards", options)
+
+        Struct::EmailForward.new(response["email_forward"])
+      end
+
+      # Gets an email forward for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/forwards/#get
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Fixnum] forward The forward id.
+      #
+      # @return [Struct::EmailForward]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def find_email_forward(domain, forward)
+        response = client.get("v1/domains/#{domain}/email_forwards/#{forward}")
+
+        Struct::EmailForward.new(response["email_forward"])
+      end
+
+      # Deletes an email forward for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/forwards/#delete
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Fixnum] forward The forward id.
+      #
+      # @return [void]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def delete_email_forward(domain, forward)
+        client.delete("v1/domains/#{domain}/email_forwards/#{forward}")
+      end
+
+
+      # Gets a domain zone as zone file.
+      #
+      # @see http://developer.dnsimple.com/domains/zones/#get
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [String]
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def zone(domain)
+        response = client.get("v1/domains/#{domain}/zone")
+
+        response["zone"]
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/name_servers_service.rb

@@ -0,0 +1,69 @@
+module Dnsimple
+  class Client
+    class NameServersService < ClientService
+
+      # Lists the name servers for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/nameservers/#list
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      #
+      # @return [Array<String>] The delegates name servers.
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def list(domain)
+        response = client.get("v1/domains/#{domain}/name_servers")
+
+        response.parsed_response
+      end
+
+      # Changes the name servers for a domain.
+      #
+      # @see http://developer.dnsimple.com/domains/nameservers/#change
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [Array<String>] servers The name server list.
+      #
+      # @return [Array<String>] The delegates name servers.
+      # @raise  [RecordNotFound]
+      # @raise  [RequestError] When the request fails.
+      def change(domain, servers)
+        servers = servers.inject({}) { |hash, server| hash.merge("ns#{hash.length + 1}" => server) }
+        options = { name_servers: servers }
+        response = client.post("v1/domains/#{domain}/name_servers", options)
+
+        response.parsed_response
+      end
+
+
+      # Registers a name server at the registry.
+      #
+      # @see http://developer.dnsimple.com/nameservers/#register
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [String] name The hostname to register.
+      # @param  [String] ip The hostname IP address.
+      #
+      # @return [void]
+      # @raise  [RequestError] When the request fails.
+      def register(domain, name, ip)
+        options = { name_server: { name: name, ip: ip } }
+        client.post("v1/domains/#{domain}/registry_name_servers", options)
+      end
+
+      # De-registers a name server at the registry.
+      #
+      # @see http://developer.dnsimple.com/nameservers/#deregister
+      #
+      # @param  [#to_s] domain The domain id or domain name.
+      # @param  [String] name The hostname to register.
+      #
+      # @return [void]
+      # @raise  [RequestError] When the request fails.
+      def deregister(domain, name)
+        client.delete("v1/domains/#{domain}/registry_name_servers/#{name}")
+      end
+
+    end
+  end
+end