dnsimple-ruby 0.4.1 → 0.5.0

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2010 Aetrion LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.textile

@@ -16,11 +16,16 @@ In this file add the following:
 password: YOUR_PASSWORD
 </code></pre>
 
+Alternatively you can pass the credentials via command-line arguments, as in:
+
+<pre><code>dnsimple -u username -p password list</code></pre>
+
 h2. Commands
 
 There are two ways to interact with the DNSimple Ruby wrapper. The first is
-to use the command line utility that is included. The commands available 
-are as follows:
+to use the command line utility that is included.
+
+The commands available are as follows:
 
 For help:
 

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/bin/dnsimple.rb

@@ -20,6 +20,10 @@ directory and add the following to that file:
 username: YOUR_USERNAME
 password: YOUR_PASSWORD
 
+Alternatively you can pass the credentials via command-line arguments, as in:
+
+dnsimple -u username -p password command
+
 == Commands
 
 All commands are executed as dnsimple [options] command [command-options] args
@@ -30,17 +34,28 @@ The following commands are available:
 help                                    # Show this usage
 info                                    # Show your account information
 
-list                                    # List all domains
+list                                                        # List all domains
+describe domain.com                                         # Describe the given domain
+create [--template=short_name] domain.com                   # Add the given domain
+register [--template=short_name] domain.com registrant_id   # Register the given domain with DNSimple
+transfer domain.com registrant_id [authinfo]                # Transfer the given domain into DNSimple
+delete domain.com                                           # Delete the given domain
+apply domain.com template_short_name                        # Apply a template to the domain
+
+record:create [--prio=priority] domain.com name type \\
+  content [ttl]                                             # Create the DNS record on the domain
+record:list domain.com                                      # List all records for the domain
+record:delete domain.com record_id                          # Delete the given domain
+
+template:create name short_name [description]               # Create a template
+template:list                                               # List all templates
+template:delete short_name                                  # Delete the given template
 
-describe domain.com                     # Describe the given domain
-create domain.com                       # Add the given domain
-delete domain.com                       # Delete the given domain
-apply domain.com template_short_name    # Apply a template to the domain
+template:list_records short_name                            # List all of the records for a template
+template:add_record [--prio=priority] short_name name \\ 
+  type content [ttl]                                        # Add a template record to the given template
+template:delete_record short_name template_record_id        # Delete the given template record
 
-record:create [--prio=priority] \\
-  domain.com name type content [ttl]    # Create the DNS record on the domain
-record:list domain.com                  # List all records for the domain
-record:delete domain.com record_id      # Delete the given domain
 
 EOF
 end
@@ -57,18 +72,31 @@ global = OptionParser.new do |opts|
   opts.on("-p", "--password [ARG]") do |password|
     DNSimple::Client.password = password
   end
+  opts.on("-d") do
+    DNSimple::Client.debug = true
+  end
 end
 
 subcommands = { 
   'create' => OptionParser.new do |opts|
-     opts.on("--template [ARG]") do |opt|
-       options[:template] = opt 
-     end
-   end,
+    opts.on("--template [ARG]") do |opt|
+      options[:template] = opt 
+    end
+  end,
+  'register' => OptionParser.new do |opts|
+    opts.on("--template [ARG]") do |opt|
+      options[:template] = opt
+    end
+  end,
   'record:create' => OptionParser.new do |opts|
-     opts.on("--prio [ARG]") do |prio|
-       options[:prio] = prio 
-     end
+    opts.on("--prio [ARG]") do |prio|
+      options[:prio] = prio 
+    end
+  end,
+  'template:add_record' => OptionParser.new do |opts|
+    opts.on("--prio [ARG]") do |prio|
+      options[:prio] = prio
+    end
   end,
 }
 

data/lib/dnsimple.rb

@@ -8,3 +8,5 @@ require 'dnsimple/user'
 require 'dnsimple/domain'
 require 'dnsimple/record'
 require 'dnsimple/template'
+require 'dnsimple/template_record'
+require 'dnsimple/transfer_order'

data/lib/dnsimple/cli.rb

@@ -32,6 +32,8 @@ module DNSimple
         'info' => DNSimple::Commands::DescribeUser,
 
         'create' => DNSimple::Commands::CreateDomain,
+        'register' => DNSimple::Commands::RegisterDomain,
+        'transfer' => DNSimple::Commands::TransferDomain,
         'describe' => DNSimple::Commands::DescribeDomain,
         'list' => DNSimple::Commands::ListDomains,
         'delete' => DNSimple::Commands::DeleteDomain,
@@ -41,6 +43,14 @@ module DNSimple
         'record:create' => DNSimple::Commands::CreateRecord,
         'record:list' => DNSimple::Commands::ListRecords,
         'record:delete' => DNSimple::Commands::DeleteRecord,
+
+        'template:create' => DNSimple::Commands::CreateTemplate,
+        'template:list' => DNSimple::Commands::ListTemplates,
+        'template:delete' => DNSimple::Commands::DeleteTemplate,
+
+        'template:list_records' => DNSimple::Commands::ListTemplateRecords,
+        'template:add_record' => DNSimple::Commands::AddTemplateRecord,
+        'template:delete_record' => DNSimple::Commands::DeleteTemplateRecord,
       }
     end
 
@@ -53,6 +63,8 @@ end
 
 require 'dnsimple/commands/describe_user'
 require 'dnsimple/commands/create_domain'
+require 'dnsimple/commands/register_domain'
+require 'dnsimple/commands/transfer_domain'
 require 'dnsimple/commands/describe_domain'
 require 'dnsimple/commands/list_domains'
 require 'dnsimple/commands/delete_domain'
@@ -62,3 +74,10 @@ require 'dnsimple/commands/apply_template'
 require 'dnsimple/commands/create_record'
 require 'dnsimple/commands/list_records'
 require 'dnsimple/commands/delete_record'
+
+require 'dnsimple/commands/create_template'
+require 'dnsimple/commands/list_templates'
+require 'dnsimple/commands/delete_template'
+require 'dnsimple/commands/list_template_records'
+require 'dnsimple/commands/add_template_record'
+require 'dnsimple/commands/delete_template_record'

data/lib/dnsimple/commands/add_template_record.rb

@@ -0,0 +1,18 @@
+module DNSimple
+  module Commands
+    class AddTemplateRecord
+      def execute(args, options={})
+        short_name = args.shift
+        record_name = args.shift
+        record_type = args.shift
+        content = args.shift
+        ttl = args.shift
+
+        template = Template.find(short_name)
+        record = TemplateRecord.create(template.short_name, record_name, record_type, content, :ttl => ttl, :prio => options[:prio])
+        
+        puts "Created #{record.record_type} with content '#{record.content}' record for template #{template.name}"
+      end
+    end
+  end
+end

data/lib/dnsimple/commands/create_template.rb

@@ -0,0 +1,14 @@
+module DNSimple
+  module Commands
+    class CreateTemplate
+      def execute(args, options={})
+        name = args.shift
+        short_name = args.shift
+        description = args.shift unless args.empty?
+
+        template = Template.create(name, short_name, description)
+        puts "Created #{template.name} (short_name:#{template.short_name})"
+      end
+    end
+  end
+end

data/lib/dnsimple/commands/delete_template.rb

@@ -0,0 +1,13 @@
+module DNSimple
+  module Commands
+    class DeleteTemplate
+      def execute(args, options={})
+        short_name = args.shift
+        template = Template.find(short_name)
+        template.delete
+
+        puts "Deleted template #{short_name}"
+      end
+    end
+  end
+end

data/lib/dnsimple/commands/delete_template_record.rb

@@ -0,0 +1,16 @@
+module DNSimple
+  module Commands
+    class DeleteTemplateRecord
+      def execute(args, options={})
+        short_name = args.shift
+        id = args.shift
+
+        template = Template.find(short_name)
+        record = TemplateRecord.find(template.short_name, id)
+        record.delete
+
+        puts "Deleted #{record.id} from template #{short_name}"
+      end
+    end
+  end
+end

data/lib/dnsimple/commands/list_template_records.rb

@@ -0,0 +1,17 @@
+module DNSimple
+  module Commands
+    class ListTemplateRecords
+      def execute(args, options={})
+        short_name = args.shift
+        template_records = TemplateRecord.all(short_name)
+        puts "Found #{template_records.length} records for #{short_name}"
+        template_records.each do |record|
+          extra = ["ttl:#{record.ttl}", "id:#{record.id}"]
+          extra << "prio:#{record.prio}" if record.record_type == "MX"
+          extra = "(#{extra.join(', ')})"
+          puts "\t#{record.name} (#{record.record_type})-> #{record.content} #{extra}"
+        end
+      end
+    end
+  end
+end

data/lib/dnsimple/commands/list_templates.rb

@@ -0,0 +1,13 @@
+module DNSimple
+  module Commands
+    class ListTemplates
+      def execute(args, options={})
+        templates = Template.all
+        puts "Found #{templates.length} templates:"
+        templates.each do |template|
+          puts "\t#{template.name} (short_name:#{template.short_name})" 
+        end
+      end
+    end
+  end
+end

data/lib/dnsimple/commands/register_domain.rb

@@ -0,0 +1,17 @@
+module DNSimple
+  module Commands
+    class RegisterDomain
+      def execute(args, options={})
+        name = args.shift
+        registrant = {:id => args.shift}
+        domain = Domain.register(name, registrant)
+        puts "Registered #{domain.name}"
+
+        if template = options.delete(:template)
+          domain.apply(template)
+          puts "Applied template #{template} to #{domain.name}"
+        end
+      end
+    end
+  end
+end

data/lib/dnsimple/commands/transfer_domain.rb

@@ -0,0 +1,15 @@
+module DNSimple
+  module Commands
+    class TransferDomain
+      def execute(args, options={})
+        name = args.shift
+        registrant = {:id => args.shift}
+        authinfo = args.shift unless args.empty?
+        authinfo ||= ''
+
+        transfer_order = TransferOrder.create(name, authinfo, registrant)
+        puts "Transfer order issued for #{name}"
+      end
+    end
+  end
+end

data/lib/dnsimple/domain.rb

@@ -42,7 +42,7 @@ module DNSimple #:nodoc:
 
     # Create the domain with the given name in DNSimple. This
     # method returns a Domain instance if the name is created
-    # and raises 
+    # and raises an error otherwise.
     def self.create(name, options={})
       domain_hash = {:name => name}
       
@@ -63,6 +63,34 @@ module DNSimple #:nodoc:
       end
     end
 
+    def self.register(name, registrant={}, extended_attributes={}, options={})
+      body = {:domain => {:name => name}}
+
+      if registrant[:id]
+        body[:domain][:registrant_id] = registrant[:id]
+      else
+        body.merge!(:contact => registrant)
+      end
+
+      body.merge!(:extended_attribute => extended_attributes)
+      
+      options.merge!({:body => body})
+      options.merge!({:basic_auth => Client.credentials})
+
+      response = self.post("#{Client.base_uri}/domain_registrations.json", options)
+      
+      pp response if Client.debug?
+      
+      case response.code
+      when 201
+        return Domain.new(response["domain"])
+      when 401
+        raise RuntimeError, "Authentication failed"
+      else
+        raise DNSimple::Error.new(name, response["errors"])
+      end
+    end
+
     def self.find(id_or_name, options={})
       options.merge!({:basic_auth => Client.credentials})
       response = self.get("#{Client.base_uri}/domains/#{id_or_name}.json", options)

data/lib/dnsimple/template.rb

@@ -21,6 +21,38 @@ module DNSimple
         self.send(m, value) if self.respond_to?(m)
       end
     end
+    
+    # Delete the template from DNSimple. WARNING: this cannot
+    # be undone.
+    def delete(options={})
+      options.merge!({:basic_auth => Client.credentials})
+      self.class.delete("#{Client.base_uri}/templates/#{id}.json", options)
+    end
+    alias :destroy :delete
+
+    def self.create(name, short_name, description=nil, options={})
+      template_hash = {
+        :name => name, 
+        :short_name => short_name,
+        :description => description
+      }
+
+      options.merge!(:body => {:dns_template => template_hash})
+      options.merge!({:basic_auth => Client.credentials})
+
+      response = self.post("#{Client.base_uri}/templates.json", options)
+
+      pp response if Client.debug?
+
+      case response.code
+      when 201
+        return Template.new(response["dns_template"])
+      when 401
+        raise RuntimeError, "Authentication failed"
+      else
+        raise DNSimple::Error.new(name, response["errors"])
+      end
+    end
 
     def self.find(id_or_short_name, options={})
       options.merge!({:basic_auth => Client.credentials})
@@ -39,5 +71,21 @@ module DNSimple
         raise DNSimple::Error.new(id_or_short_name, response["errors"])
       end
     end
+
+    def self.all(options={})
+      options.merge!({:basic_auth => Client.credentials})
+      response = self.get("#{Client.base_uri}/templates.json", options)
+
+      pp response if Client.debug?
+
+      case response.code
+      when 200
+        response.map { |r| Template.new(r["dns_template"]) }
+      when 401
+        raise RuntimeError, "Authentication failed"
+      else
+        raise RuntimeError, "Error: #{response.code}"
+      end
+    end
   end
 end

data/lib/dnsimple/template_record.rb

@@ -0,0 +1,103 @@
+module DNSimple #:nodoc:
+  # A single record in a template
+  class TemplateRecord
+    include HTTParty
+
+    # The id of the template record
+    attr_accessor :id
+
+    # The template the record belongs to
+    attr_accessor :template
+
+    # The name the record points to. This may be blank.
+    attr_accessor :name
+
+    # The content for the record.
+    attr_accessor :content
+
+    # The record type
+    attr_accessor :record_type
+
+    # The time-to-live
+    attr_accessor :ttl
+
+    # The priority (only for MX records)
+    attr_accessor :prio
+
+    #:nodoc:
+    def initialize(attributes)
+      attributes.each do |key, value|
+        m = "#{key}=".to_sym
+        self.send(m, value) if self.respond_to?(m)
+      end
+    end
+
+    def delete(options={})
+      options.merge!(:basic_auth => Client.credentials)
+      self.class.delete("#{Client.base_uri}/templates/#{template.id}/template_records/#{id}.json", options)
+    end
+    alias :destroy :delete
+
+    def self.create(short_name, name, record_type, content, options={})
+      template = Template.find(short_name)
+
+      record_hash = {:name => name, :record_type => record_type, :content => content}
+      record_hash[:ttl] = options.delete(:ttl) || 3600
+      record_hash[:prio] = options.delete(:prio) || ''
+
+      options.merge!({:query => {:dns_template_record => record_hash}})
+      options.merge!({:basic_auth => Client.credentials})
+
+      response = self.post("#{Client.base_uri}/templates/#{template.id}/template_records.json", options)
+
+      pp response if Client.debug?
+
+      case response.code
+      when 201
+        return TemplateRecord.new({:template => template}.merge(response["dns_template_record"]))
+      when 401
+        raise RuntimeError, "Authentication failed"
+      else
+        raise DNSimple::Error.new("#{name}", response["errors"])
+      end
+    end
+
+    def self.find(short_name, id, options={})
+      template = Template.find(short_name)
+      options.merge!(:basic_auth => Client.credentials)
+      response = self.get("#{Client.base_uri}/templates/#{template.id}/template_records/#{id}.json", options)
+
+      pp response if Client.debug?
+
+      case response.code
+      when 200
+        return TemplateRecord.new({:template => template}.merge(response["dns_template_record"]))
+      when 401
+        raise RuntimeError, "Authentication failed"
+      when 404
+        raise RuntimeError, "Could not find template record #{id} for template #{short_name}"
+      end
+    end
+
+    # Get all of the template records for the template with the
+    # given short name.
+    def self.all(short_name, options={})
+      template = Template.find(short_name)
+      options.merge!({:basic_auth => Client.credentials})
+      response = self.get("#{Client.base_uri}/templates/#{template.id}/template_records.json", options)
+
+      pp response if Client.debug?
+
+      case response.code
+      when 200
+        response.map { |r| TemplateRecord.new({:template => template}.merge(r["dns_template_record"])) }
+      when 401
+        raise RuntimeError, "Authentication failed"
+      else
+        raise RuntimeError, "Error: #{response.code}"
+      end
+    end
+  end
+
+
+end

data/lib/dnsimple/transfer_order.rb

@@ -0,0 +1,45 @@
+module DNSimple #:nodoc:
+  # Class representing a transfer order in DNSimple
+  class TransferOrder
+    include HTTParty
+
+    attr_accessor :id
+
+    attr_accessor :status
+
+    def initialize(attributes)
+      attributes.each do |key, value|
+        m = "#{key}=".to_sym
+        self.send(m, value) if self.respond_to?(m)
+      end
+    end
+
+    def self.create(name, authinfo='', registrant={}, extended_attributes={}, options={})
+      body = {:domain => {:name => name}, :transfer_order => {:authinfo => authinfo}}
+
+      if registrant[:id]
+        body[:domain][:registrant_id] = registrant[:id]
+      else
+        body.merge!(:contact => registrant)
+      end
+
+      body.merge!(:extended_attribute => extended_attributes)
+
+      options.merge!({:body => body})
+      options.merge!({:basic_auth => Client.credentials})
+
+      response = self.post("#{Client.base_uri}/domain_transfers.json", options)
+
+      pp response if Client.debug?
+
+      case response.code
+      when 201
+        return TransferOrder.new(response["transfer_order"])
+      when 401
+        raise RuntimeError, "Authentication failed"
+      else
+        raise DNSimple::Error.new(name, response["errors"])
+      end
+    end
+  end
+end

data/spec/domain_spec.rb

@@ -25,6 +25,35 @@ describe DNSimple::Domain do
     end
   end
 
+  context "registration" do
+    describe "a new domain" do
+      context "with an existing contact" do
+        let(:name) { "testdomain-#{Time.now.to_i}.net" }
+        let(:registrant) { Hash.new(:id => 4) }
+        it "can be registered" do
+          domain = DNSimple::Domain.register(name, registrant)
+          domain.name.should eql(name)
+        end
+      end
+      context "with a new registrant contact" do
+        let(:name) { "testdomain-#{Time.now.to_i}.net" }
+        it "can be registered" do
+          registrant = {
+            :first_name => 'John',
+            :last_name => 'Smith',
+            :address1 => '123 SW 1st Street',
+            :city => 'Miami',
+            :state_or_province => 'FL',
+            :country => 'US',
+            :postal_code => '33143'
+          }
+          domain = DNSimple::Domain.register(name, registrant)
+          domain.name.should eql(name)
+        end
+      end
+    end
+  end
+
   describe ".all" do
     before do
       @domains = []

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 1
-  version: 0.4.1
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Anthony Eden
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-18 00:00:00 -10:00
+date: 2010-09-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,11 +37,13 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE
 - README
 - README.rdoc
 - README.textile
 files: 
 - .gitignore
+- LICENSE
 - README
 - README.rdoc
 - README.textile
@@ -52,20 +54,30 @@ files:
 - lib/dnsimple.rb
 - lib/dnsimple/cli.rb
 - lib/dnsimple/client.rb
+- lib/dnsimple/commands/add_template_record.rb
 - lib/dnsimple/commands/apply_template.rb
 - lib/dnsimple/commands/clear_domain.rb
 - lib/dnsimple/commands/create_domain.rb
 - lib/dnsimple/commands/create_record.rb
+- lib/dnsimple/commands/create_template.rb
 - lib/dnsimple/commands/delete_domain.rb
 - lib/dnsimple/commands/delete_record.rb
+- lib/dnsimple/commands/delete_template.rb
+- lib/dnsimple/commands/delete_template_record.rb
 - lib/dnsimple/commands/describe_domain.rb
 - lib/dnsimple/commands/describe_user.rb
 - lib/dnsimple/commands/list_domains.rb
 - lib/dnsimple/commands/list_records.rb
+- lib/dnsimple/commands/list_template_records.rb
+- lib/dnsimple/commands/list_templates.rb
+- lib/dnsimple/commands/register_domain.rb
+- lib/dnsimple/commands/transfer_domain.rb
 - lib/dnsimple/domain.rb
 - lib/dnsimple/error.rb
 - lib/dnsimple/record.rb
 - lib/dnsimple/template.rb
+- lib/dnsimple/template_record.rb
+- lib/dnsimple/transfer_order.rb
 - lib/dnsimple/user.rb
 - spec/README
 - spec/domain_spec.rb