dnsimple-ruby 0.5.0 → 0.6.0

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem 'httparty'
+
+group :development do
+  gem 'rake'
+  gem 'jeweler'
+  gem 'rspec', '>= 2.0.0'
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rake (0.8.7)
+    rspec (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+      rspec-mocks (= 2.0.0)
+    rspec-core (2.0.0)
+    rspec-expectations (2.0.0)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty
+  jeweler
+  rake
+  rspec (>= 2.0.0)

data/README

@@ -26,15 +26,53 @@ The following commands are available for domains:
 * dnsimple list
 * dnsimple describe domain.com
 * dnsimple create domain.com
+* dnsimple register domain.com registrant_id
+* dnsimple transfer domain.com registrant_id [authinfo]
 * dnsimple delete domain.com
 * dnsimple apply domain.com template_short_name
 
+Please note that domain registration and transfer can only be done through the API for domains that do not require extended attributes. A future version of the API will add support for extended attributes.
+
 The following commands are available for records:
 
 * dnsimple record:create [--prio=priority] domain.com name type content [ttl]
 * dnsimple record:list domain.com
 * dnsimple record:delete domain.com record_id
 
+The following commands are available for custom templates:
+
+* dnsimple template:list
+* dnsimple template:create name short_name [description]
+* dnsimple template:delete short_name
+* dnsimple template:list_records short_name
+* dnsimple template:add_record short_name name type content [ttl] [prio]
+* dnsimple template:delete_record short_name template_record_id
+
+The following commands are available for managing contacts:
+
+* dnsimple contact:list
+* dnsimple contact:describe id
+* dnsimple contact:create [name:value name:value ...]
+* dnsimple contact:update id [name:value name:value ...]
+* dnsimple contact:delete id
+
+The contact name/value pairs are: 
+ 
+* first_name
+* last_name
+* organization_name (optional)
+* job_title (required if organization name is specified)
+* address1
+* address2 (optional)
+* city
+* state_province (also aliased as state)
+* postal_code
+* country
+* email
+* phone
+* phone_ext (optional)
+* fax (optional)
+
 == Wrapper Classes
 
 In addition to the command line utility you may also use the included Ruby

data/README.rdoc

@@ -9,6 +9,11 @@ In this file add the following:
     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
 
 The following commands are available for domains:
@@ -16,11 +21,83 @@ The following commands are available for domains:
 * dnsimple list
 * dnsimple describe domain.com
 * dnsimple create domain.com
+* dnsimple register domain.com registrant_id
+* dnsimple transfer domain.com registrant_id [authinfo]
 * dnsimple delete domain.com
 * dnsimple apply domain.com template_short_name
 
+Please note that domain registration and transfer can only be done through the API for domains that do not require extended attributes. A future version of the API will add support for extended attributes.
+
 The following commands are available for records:
 
 * dnsimple record:create [--prio=priority] domain.com name type content [ttl]
 * dnsimple record:list domain.com
 * dnsimple record:delete domain.com record_id
+
+The following commands are available for custom templates:
+
+* dnsimple template:list
+* dnsimple template:create name short_name [description]
+* dnsimple template:delete short_name
+* dnsimple template:list_records short_name
+* dnsimple template:add_record short_name name type content [ttl] [prio]
+* dnsimple template:delete_record short_name template_record_id
+
+The following commands are available for managing contacts:
+
+* dnsimple contact:list
+* dnsimple contact:describe id
+* dnsimple contact:create [name:value name:value ...]
+* dnsimple contact:update id [name:value name:value ...]
+* dnsimple contact:delete id
+
+=== Contact Attributes
+
+The contact attributes that can be used in the name:value pairs are:
+
+* first_name
+* last_name
+* organization_name (optional)
+* job_title (required if organization name is specified)
+* address1
+* address2 (optional)
+* city
+* state_province (also aliased as state)
+* postal_code
+* country
+* email
+* phone
+* phone_ext (optional)
+* fax (optional)
+
+== Wrapper Classes
+
+In addition to the command line utility you may also use the included Ruby
+classes directly in your Ruby applications.
+
+Sample:
+
+  require 'rubygems'
+  require 'dnsimple'
+  
+  DNSimple::Client.username = 'YOUR_USERNAME'
+  DNSimple::Client.password = 'YOUR_PASSWORD'
+
+  user = User.me
+  puts "#{user.domain_count} domains"
+
+  puts "Domains..."
+  Domain.all.each do |domain|
+    puts "  #{domain.name}"
+  end
+
+  domain = Domain.find("example.com")
+  domain.apply("template") # applies a standard or custom template to the domain
+
+  domain = Domain.create("newdomain.com")
+  puts "Added #{domain.name}"
+  domain.delete # removes from DNSimple
+
+The complete RDoc for the wrapper classes can be found here: 
+
+http://rdoc.info/projects/aetrion/dnsimple-ruby

data/README.textile

@@ -36,15 +36,55 @@ The following commands are available for domains:
 * dnsimple list
 * dnsimple describe domain.com
 * dnsimple create domain.com
+* dnsimple register domain.com registrant_id
+* dnsimple transfer domain.com registrant_id [authinfo]
 * dnsimple delete domain.com
 * dnsimple apply domain.com template_short_name
 
+Please note that domain registration and transfer can only be done through the API for domains that do not require extended attributes. A future version of the API will add support for extended attributes.
+
 The following commands are available for records:
 
 * dnsimple record:create [--prio=priority] domain.com name type content [ttl]
 * dnsimple record:list domain.com
 * dnsimple record:delete domain.com record_id
 
+The following commands are available for custom templates:
+
+* dnsimple template:list
+* dnsimple template:create name short_name [description]
+* dnsimple template:delete short_name
+* dnsimple template:list_records short_name
+* dnsimple template:add_record short_name name type content [ttl] [prio]
+* dnsimple template:delete_record short_name template_record_id
+
+The following commands are available for managing contacts:
+
+* dnsimple contact:list
+* dnsimple contact:describe id
+* dnsimple contact:create [name:value name:value ...]
+* dnsimple contact:update id [name:value name:value ...]
+* dnsimple contact:delete id
+
+h3. Contact Attributes
+
+The contact attributes that can be used in the name:value pairs are: 
+ 
+* first_name
+* last_name
+* organization_name (optional)
+* job_title (required if organization name is specified)
+* address1
+* address2 (optional)
+* city
+* state_province (also aliased as state)
+* postal_code
+* country
+* email
+* phone
+* phone_ext (optional)
+* fax (optional)
+
 h2. Wrapper Classes
 
 In addition to the command line utility you may also use the included Ruby

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/dnsimple.rb

@@ -5,6 +5,7 @@ require 'httparty'
 require 'dnsimple/client'
 require 'dnsimple/error'
 require 'dnsimple/user'
+require 'dnsimple/contact'
 require 'dnsimple/domain'
 require 'dnsimple/record'
 require 'dnsimple/template'

data/lib/dnsimple/cli.rb

@@ -51,6 +51,12 @@ module DNSimple
         'template:list_records' => DNSimple::Commands::ListTemplateRecords,
         'template:add_record' => DNSimple::Commands::AddTemplateRecord,
         'template:delete_record' => DNSimple::Commands::DeleteTemplateRecord,
+
+        'contact:create' => DNSimple::Commands::CreateContact,
+        'contact:list' => DNSimple::Commands::ListContacts,
+        'contact:describe' => DNSimple::Commands::DescribeContact,
+        'contact:update' => DNSimple::Commands::UpdateContact,
+        'contact:delete' => DNSimple::Commands::DeleteContact,
       }
     end
 
@@ -81,3 +87,9 @@ require 'dnsimple/commands/delete_template'
 require 'dnsimple/commands/list_template_records'
 require 'dnsimple/commands/add_template_record'
 require 'dnsimple/commands/delete_template_record'
+
+require 'dnsimple/commands/create_contact'
+require 'dnsimple/commands/list_contacts'
+require 'dnsimple/commands/describe_contact'
+require 'dnsimple/commands/update_contact'
+require 'dnsimple/commands/delete_contact'

data/lib/dnsimple/commands/create_contact.rb

@@ -0,0 +1,21 @@
+module DNSimple
+  module Commands
+    class CreateContact
+      # Execute the contact:create command.
+      # 
+      # Args expected to be:
+      # [name:value name:value ...]
+      def execute(args, options={})
+        attributes = {}
+        attributes['state_province_choice'] = 'S'
+        args.each do |arg|
+          name, value = arg.split(":")
+          attributes[Contact.resolve(name)] = value
+        end
+
+        contact = Contact.create(attributes, options)
+        puts "Created #{contact.name} (id: #{contact.id})"
+      end
+    end
+  end
+end

data/lib/dnsimple/commands/delete_contact.rb

@@ -0,0 +1,14 @@
+module DNSimple
+  module Commands
+    class DeleteContact
+      def execute(args, options={})
+        id = args.shift
+
+        contact = Contact.find(id)
+        contact.delete
+
+        puts "Deleted #{contact.name} (id: #{contact.id})"
+      end
+    end
+  end
+end

data/lib/dnsimple/commands/describe_contact.rb

@@ -0,0 +1,25 @@
+module DNSimple
+  module Commands
+    class DescribeContact
+      def execute(args, options={})
+        id = args.shift
+        contact = Contact.find(id)
+        puts "Contact: #{contact.name}:"
+        puts "\tID: #{contact.id}"
+        puts "\tFirst Name: #{contact.first_name}"
+        puts "\tLast Name: #{contact.last_name}"
+        puts "\tOrganization Name: #{contact.organization_name}" unless contact.organization_name.blank?
+        puts "\tJob Title: #{contact.job_title}" unless contact.job_title.blank?
+        puts "\tAddress 1: #{contact.address1}"
+        puts "\tAddress 2: #{contact.address2}"
+        puts "\tCity: #{contact.city}"
+        puts "\tState or Province: #{contact.state_province}"
+        puts "\tPostal Code: #{contact.postal_code}"
+        puts "\tCountry: #{contact.country}"
+        puts "\tEmail: #{contact.email_address}"
+        puts "\tPhone: #{contact.phone}"
+        puts "\tPhone Ext: #{contact.phone_ext}" unless contact.phone_ext.blank?
+      end
+    end
+  end
+end

data/lib/dnsimple/commands/list_contacts.rb

@@ -0,0 +1,13 @@
+module DNSimple
+  module Commands
+    class ListContacts
+      def execute(args, options={})
+        contacts = Contact.all
+        puts "Found #{contacts.length} contacts:"
+        contacts.each do |contact|
+          puts "\t#{contact.name} (id:#{contact.id})"
+        end
+      end
+    end
+  end
+end

data/lib/dnsimple/commands/update_contact.rb

@@ -0,0 +1,25 @@
+module DNSimple
+  module Commands
+    class UpdateContact
+      # Execute the contact:update command.
+      #
+      # Args expected:
+      # id [name:value name:value ...]
+      def execute(args, options={})
+        attributes = {}
+        id = args.shift
+        args.each do |arg|
+          name, value = arg.split(":")
+          attributes[Contact.resolve(name)] = value
+        end 
+
+        contact = Contact.find(id)
+        attributes.each do |name, value|
+          contact.send("#{name}=", value)
+        end
+        contact.save
+        puts "Updated contact #{contact.name} (id: #{contact.id})"
+      end
+    end
+  end
+end

data/lib/dnsimple/contact.rb

@@ -0,0 +1,171 @@
+module DNSimple #:nodoc:
+  # CLass representing a contact in DNSimple
+  class Contact
+    include HTTParty
+
+    # The contact ID in DNSimple
+    attr_accessor :id
+
+    # The name of the organization in which the contact works
+    # (may be omitted)
+    attr_accessor :organization_name
+
+    # The contact first name
+    attr_accessor :first_name
+
+    # The contact last name
+    attr_accessor :last_name
+
+    # The contact's job title (may be omitted)
+    attr_accessor :job_title
+
+    # The contact street address
+    attr_accessor :address1
+
+    # Apartment or suite number
+    attr_accessor :address2
+
+    # The city name
+    attr_accessor :city
+
+    # The state or province name
+    attr_accessor :state_province
+
+    # The contact postal code
+    attr_accessor :postal_code
+
+    # The contact country (as a 2-character country code)
+    attr_accessor :country
+
+    # The contact email address
+    attr_accessor :email_address
+
+    # The contact phone number
+    attr_accessor :phone
+
+    # The contact phone extension (may be omitted)
+    attr_accessor :phone_ext
+
+    # The contact fax number (may be omitted)
+    attr_accessor :fax
+
+    # When the contact was created in DNSimple
+    attr_accessor :created_at
+
+    # When the contact was last updated in DNSimple
+    attr_accessor :updated_at
+
+    #: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 name
+      [first_name, last_name].join(' ')
+    end
+
+    def save(options={})
+      contact_hash = {}
+      %w(first_name last_name organization_name job_title address1 address2 city
+      state_province postal_code country email_address phone phone_ext fax).each do |attribute|
+        contact_hash[Contact.resolve(attribute)] = self.send(attribute)
+      end
+
+      options.merge!({:basic_auth => Client.credentials})
+      options.merge!({:body => {:contact => contact_hash}})
+      
+      response = self.class.put("#{Client.base_uri}/contacts/#{id}.json", options)
+
+      pp response if Client.debug?
+
+      case response.code
+      when 200
+        return self
+      when 401
+        raise RuntimeError, "Authentication failed"
+      else
+        raise RuntimeError, "Failed to update contact: #{response.inspect}"
+      end
+    end
+
+    # Delete the contact from DNSimple. WARNING: this cannot be undone.
+    def delete(options={})
+      options.merge!({:basic_auth => Client.credentials})
+      self.class.delete("#{Client.base_uri}/contacts/#{id}.json", options)
+    end
+
+    # Map an aliased field name to it's real name. For example, if you
+    # pass "first" it will be resolved to "first_name", "email" is resolved
+    # to "email_address" and so on.
+    def self.resolve(name)
+      aliases = {
+          'first' => 'first_name',
+          'last' => 'last_name',
+          'state' => 'state_province',
+          'province' => 'state_province',
+          'email' => 'email_address',
+      }
+      aliases[name] || name
+    end
+
+    # Create the contact with the given attributes in DNSimple.
+    # This method returns a Contact instance of the contact is created
+    # and raises an error otherwise.
+    def self.create(attributes, options={})
+      contact_hash = attributes
+
+      options.merge!({:body => {:contact => contact_hash}})
+      options.merge!({:basic_auth => Client.credentials})
+
+      response = self.post("#{Client.base_uri}/contacts.json", options)
+
+      pp response if Client.debug?
+
+      case response.code
+      when 201
+        return Contact.new(response["contact"])
+      when 401
+        raise RuntimeError, "Authentication failed"
+      else
+        raise RuntimeError, "Failed to create contact: #{response.inspect}"
+      end
+    end
+
+    def self.find(id, options={})
+      options.merge!({:basic_auth => Client.credentials})
+      response = self.get("#{Client.base_uri}/contacts/#{id}.json", options)
+
+      pp response if Client.debug?
+
+      case response.code
+      when 200
+        return Contact.new(response["contact"])
+      when 401
+        raise RuntimeError, "Authentication failed"
+      when 404
+        raise RuntimeError, "Could not find contact #{id}"
+      else
+        raise DNSimple::Error.new(id, response["errors"])
+      end
+    end
+
+    def self.all(options={})
+      options.merge!({:basic_auth => Client.credentials})
+      response = self.get("#{Client.base_uri}/contacts.json", options)
+
+      pp response if Client.debug?
+
+      case response.code
+      when 200
+        response.map { |r| Contact.new(r["contact"]) }
+      when 401
+        raise RuntimeError, "Authentication failed"
+      else
+        raise RuntimeError, "Error: #{response.code}"
+      end
+    end
+  end
+end

data/lib/dnsimple/domain.rb

@@ -34,6 +34,8 @@ module DNSimple #:nodoc:
     end
     alias :destroy :delete
 
+    # Apply the given named template to the domain. This will add
+    # all of the records in the template to the domain.
     def apply(template_name, options={})
       template = DNSimple::Template.find(template_name)
       options.merge!({:basic_auth => Client.credentials})

data/spec/contact_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe DNSimple::Contact do
+  describe "a new contact" do
+    let(:contact_attributes) {
+      {
+        :first_name => 'John',
+        :last_name => 'Doe',
+        :address1 => '1 SW 1st Street',
+        :city => 'Miami',
+        :state_province => 'FL',
+        :postal_code => '33143',
+        :country => 'US',
+        :email_address => 'john.doe@example.com',
+        :phone => '305 111 2222'
+      }
+    }
+    before do
+      @contact = DNSimple::Contact.create(contact_attributes)
+    end
+    after do
+      @contact.delete
+    end
+    it "has specific attributes" do
+      @contact.first_name.should eql(contact_attributes[:first_name])
+      @contact.id.should_not be_nil
+    end
+    it "can be found by id" do
+      contact = DNSimple::Contact.find(@contact.id)
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dnsimple-ruby
 version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Anthony Eden
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-30 00:00:00 +02:00
+date: 2010-10-19 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -42,7 +45,10 @@ extra_rdoc_files:
 - README.rdoc
 - README.textile
 files: 
+- .bundle/config
 - .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README
 - README.rdoc
@@ -57,21 +63,27 @@ files:
 - lib/dnsimple/commands/add_template_record.rb
 - lib/dnsimple/commands/apply_template.rb
 - lib/dnsimple/commands/clear_domain.rb
+- lib/dnsimple/commands/create_contact.rb
 - lib/dnsimple/commands/create_domain.rb
 - lib/dnsimple/commands/create_record.rb
 - lib/dnsimple/commands/create_template.rb
+- lib/dnsimple/commands/delete_contact.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_contact.rb
 - lib/dnsimple/commands/describe_domain.rb
 - lib/dnsimple/commands/describe_user.rb
+- lib/dnsimple/commands/list_contacts.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/commands/update_contact.rb
+- lib/dnsimple/contact.rb
 - lib/dnsimple/domain.rb
 - lib/dnsimple/error.rb
 - lib/dnsimple/record.rb
@@ -80,6 +92,7 @@ files:
 - lib/dnsimple/transfer_order.rb
 - lib/dnsimple/user.rb
 - spec/README
+- spec/contact_spec.rb
 - spec/domain_spec.rb
 - spec/record_spec.rb
 - spec/spec_helper.rb
@@ -95,27 +108,32 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A ruby wrapper for the DNSimple API
 test_files: 
+- spec/contact_spec.rb
 - spec/domain_spec.rb
 - spec/record_spec.rb
 - spec/spec_helper.rb