sant0sk1-dreamy 0.2.4 → 0.3.0

data/README.md

@@ -46,6 +46,9 @@ Same goes with Users, DNS records and announcement list subscribers
     # fetch an array of Dreamy::Dns objects
     account.dns
     
+    # fetch an array of Dreamy::AnnounceList objects
+    account.announce_lists 
+    
     # fetch an array of Dreamy::Subscribers to an announcement list
     account.announce_list(listname,domain)
     
@@ -57,6 +60,14 @@ You can interact with announcement lists by adding and removing subscribers
     # remove a subscriber from an announcement list
     account.announce_remove(listname,domain,email)
     
+You can interact with DNS by adding and removing records
+
+    # add a new A record for a subdomain of an hosted domain
+    account.dns_add(subdomain,"A","123.321.123.321")
+    
+    # remove the A record just created
+    account.dns_remove(subdomain,"A","123.321.123.321")
+    
 More and more functions will be added as time allows. If there's something missing that you want in, please:
 
 fork -> commit -> pull request
@@ -88,19 +99,22 @@ Run this from the command line to print the usage:
     === Commands
      help                           # show this usage
 
-     domains:http                   # list HTTP domain details
-     domains:mysql                  # list MySQL domains
-     domains:status                 # check availability of all domains (pingability)
+     domains:http                       # list HTTP domain details
+     domains:mysql                      # list MySQL domains
+     domains:status                     # check availability of all domains (pingability)
 
-     dns                            # list DNS records
-     dns <name>                     # list DNS records for <name>
+     dns                                # list DNS records
+     dns <name>                         # list DNS records for <name>
+     dns:add <record> <type> <value>    # add DNS record 
+     dns:remove <record> <type> <value> # remove DNS record
 
-     announce:list <list>           # lists all subscribers to <name> list (eg - 'my_list@example.com')
-     announce:add <list> <email>    # add subscriber with <email> to <list>
-     announce:remove <list> <email> # remove subscriber with <email> from <list>
+     announce                           # list announce lists
+     announce:list <list>               # list all subscribers to <name> list
+     announce:add <list> <email>        # add subscriber with <email> to <list>
+     announce:remove <list> <email>     # remove subscriber with <email> from <list>
 
-     users                          # list user accounts: details
-     users:pw                       # list user accounts: usernames & passwords
+     users                              # list user accounts: details
+     users:pw                           # list user accounts: usernames & passwords
 
      
 That's it for now. New commands should be springing up as Dreamy and the DreamHost API mature!
@@ -108,7 +122,7 @@ That's it for now. New commands should be springing up as Dreamy and the DreamHo
 TODO
 ====
 
-* more tests
+* add PS commands (once DH creates test account)
 * add real rdocs
 
 [1]:http://github.com/sant0sk1/dreamy

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 4
+:patch: 0
 :major: 0
-:minor: 2
+:minor: 3

data/lib/dreamy.rb

@@ -12,6 +12,7 @@ require 'dreamy/easy_class_maker'
 require 'dreamy/base'
 require 'dreamy/domain'
 require 'dreamy/dns'
+require 'dreamy/announce_list'
 require 'dreamy/subscriber'
 require 'dreamy/user'
 

data/lib/dreamy/announce_list.rb

@@ -0,0 +1,19 @@
+module Dreamy
+  class AnnounceList
+    include EasyClassMaker
+
+    attributes  :account_id, :name, :domain, :short_name, :start_date, :max_bounces, :subscribers
+
+    def self.new_from_xml(xml)
+      l = new
+      l.account_id      = (xml).at('account_id').innerHTML.to_i
+      l.short_name      = (xml).at('listname').innerHTML
+      l.domain          = (xml).at('domain').innerHTML
+      l.name            = (xml).at('name').innerHTML
+      l.start_date      = (xml).at('start_date').innerHTML
+      l.max_bounces     = (xml).at('max_bounces').innerHTML.to_i
+      l.subscribers     = (xml).at('num_subscribers').innerHTML.to_i
+      l
+    end
+  end
+end

data/lib/dreamy/base.rb

@@ -11,7 +11,7 @@ module Dreamy
     # returns an array of domain objects
     def domains
       doc = request("domain-list_domains")
-      raise ApiError if (doc/:result).innerHTML == "error"
+      raise ApiError, (doc/:data).innerHTML if (doc/:result).innerHTML == "error"
       (doc/:data).inject([]) { |domains, domain| domains << Domain.new_from_xml(domain); domains }
     end
 
@@ -22,21 +22,39 @@ module Dreamy
       else
         doc = request("user-list_users_no_pw")
       end
-      raise ApiError if (doc/:result).innerHTML == "error"
+      raise ApiError, (doc/:data).innerHTML if (doc/:result).innerHTML == "error"
       (doc/:data).inject([]) { |users, user| users << User.new_from_xml(user); users }
     end
 
     # returns an array of dns objects
     def dns
       doc = request("dns-list_records")
-      raise ApiError if (doc/:result).innerHTML == "error"
+      raise ApiError, (doc/:data).innerHTML if (doc/:result).innerHTML == "error"
       (doc/:data).inject([]) { |records, dns| records << Dns.new_from_xml(dns); records }
     end
-
+    
+    def dns_add(record,type,value)
+      doc = request("dns-add_record", {"record" => record, "type" => type, "value" => value})
+      raise ApiError, (doc/:data).innerHTML if (doc/:result).innerHTML == "error"
+      true
+    end
+    
+    def dns_remove(record,type,value)
+      doc = request("dns-remove_record", {"record" => record, "type" => type, "value" => value})
+      raise ApiError, (doc/:data).innerHTML if (doc/:result).innerHTML == "error"
+      true
+    end
+    
+    def announce_lists
+      doc = request("announcement_list-list_lists")
+      raise ApiError, (doc/:data).innerHTML if (doc/:result).innerHTML == "error"
+      (doc/:data).inject([]) { |lists, list| lists << AnnounceList.new_from_xml(list); lists }
+    end
+    
     # returns an array of subscriber objects
     def announce_list(listname,domain)
       doc = request("announcement_list-list_subscribers",{ "listname" => listname, "domain" => domain})
-      raise ApiError if (doc/:result).innerHTML == "error"
+      raise ApiError, (doc/:data).innerHTML if (doc/:result).innerHTML == "error"
       (doc/:data).inject([]) { |subs, sub| subs << Subscriber.new_from_xml(sub); subs }
     end
     

data/lib/dreamy/command.rb

@@ -3,23 +3,14 @@ require 'commands/base'
 module Dreamy
   module Command
     class InvalidCommand < RuntimeError; end
-    class CommandFailed  < RuntimeError; end
-    class Unauthorized   < RuntimeError; end
 
     class << self
-      def run(command, args, retries=0)
+      def run(command, args)
         run_internal(command, args)
       rescue InvalidCommand
         error "Unknown command. Run 'dh help' for usage information."
-      rescue Unauthorized
-        if retries < 3
-          STDERR.puts "Authentication failure"
-          run(command, args, retries+1)
-        else
-          error "Authentication failure"
-        end
-      rescue CommandFailed => e
-        error e.message
+      rescue ApiError => e
+        error "DreamHost returned this error: #{e}"
       rescue Interrupt => e
         error "\n[canceled]"
       end

data/lib/dreamy/commands/announce.rb

@@ -1,6 +1,20 @@
 module Dreamy::Command
   class Announce < Base
-
+    
+    def index
+      lists = @account.announce_lists
+      
+      if lists.empty?
+        display "No announcement lists on this account"
+      else
+        list_table = table do |t|
+          t.headings = 'Name', 'Short Name', 'Domain', 'Subscribers', 'Max Bounces', 'Start Date'
+          lists.each { |l| t << [l.name, l.short_name, l.domain, l.subscribers, l.max_bounces, l.start_date]}
+        end
+        display list_table
+      end
+    end
+    
     def list
       if args.length >= 1
         listname, domain = extract_values(args.shift)

data/lib/dreamy/commands/dns.rb

@@ -22,5 +22,27 @@ module Dreamy::Command
     end
     alias :index :list
     
+    def add
+      if args.length == 3
+        record, type, value = args[0], args[1], args[2]
+        @account.dns_add(record,type,value)
+        display "Successfully added #{type} record of #{value} to #{record}"
+        display "Please wait for DNS to propagate"
+      else
+        display "Usage: dh dns:add [new record] [type] [value]"
+      end
+    end
+    
+    def remove
+      if args.length == 3
+        record, type, value = args[0], args[1], args[2]
+        @account.dns_remove(record,type,value)
+        display "Successfully removed #{type} record of #{value} to #{record}"
+        display "Please wait for DNS to propagate"
+      else
+        display "Usage: dh dns:remove [new record] [type] [value]"
+      end
+    end
+    
   end
 end

data/lib/dreamy/commands/help.rb

@@ -10,19 +10,22 @@ module Dreamy::Command
 === Commands
  help                           # show this usage
 
- domains:http                   # list HTTP domain details
- domains:mysql                  # list MySQL domains
- domains:status                 # check availability of all domains (pingability)
+ domains:http                       # list HTTP domain details
+ domains:mysql                      # list MySQL domains
+ domains:status                     # check availability of all domains (pingability)
  
- dns                            # list DNS records
- dns <name>                     # list DNS records for <name>
+ dns                                # list DNS records
+ dns <name>                         # list DNS records for <name>
+ dns:add <record> <type> <value>    # add DNS record 
+ dns:remove <record> <type> <value> # remove DNS record
  
- announce:list <list>           # list all subscribers to <name> list (eg - 'my_list@example.com')
- announce:add <list> <email>    # add subscriber with <email> to <list>
- announce:remove <list> <email> # remove subscriber with <email> from <list>
+ announce                           # list announce lists
+ announce:list <list>               # list all subscribers to <name> list
+ announce:add <list> <email>        # add subscriber with <email> to <list>
+ announce:remove <list> <email>     # remove subscriber with <email> from <list>
  
- users                          # list user accounts: details
- users:pw                       # list user accounts: usernames & passwords
+ users                              # list user accounts: details
+ users:pw                           # list user accounts: usernames & passwords
 
 EOTXT
 		end

data/lib/dreamy/dns.rb

@@ -6,9 +6,9 @@ module Dreamy
 
     def self.new_from_xml(xml)
       d = new
-      d.account_id  = (xml).at('account_id').innerHTML
+      d.account_id  = (xml).at('account_id').innerHTML.to_i
       d.comment     = (xml).at('comment').innerHTML
-      d.editable    = (xml).at('editable').innerHTML
+      d.editable    = (xml).at('editable').innerHTML.to_i
       d.record      = (xml).at('record').innerHTML
       d.type        = (xml).at('type').innerHTML
       d.value       = (xml).at('value').innerHTML

data/lib/dreamy/domain.rb

@@ -8,24 +8,24 @@ module Dreamy
     def self.new_from_xml(xml)
       d = new
       
-      d.account_id    = (xml).at('account_id').innerHTML
+      d.account_id    = (xml).at('account_id').innerHTML.to_i
       d.domain        = (xml).at('domain').innerHTML
       d.home          = (xml).at('home').innerHTML
       d.type          = (xml).at('type').innerHTML
       d.unique_ip     = (xml).at('unique_ip').innerHTML
       
       if d.type == 'http'
-        d.fastcgi       = (xml).at('fastcgi').innerHTML
+        d.fastcgi       = (xml).at('fastcgi').innerHTML.to_i
         d.hosting_type  = (xml).at('hosting_type').innerHTML
         d.outside_url   = (xml).at('outside_url').innerHTML
-        d.passenger     = (xml).at('passenger').innerHTML
+        d.passenger     = (xml).at('passenger').innerHTML.to_i
         d.path          = (xml).at('path').innerHTML
         d.php           = (xml).at('php').innerHTML
-        d.php_fcgid     = (xml).at('php_fcgid').innerHTML
-        d.security      = (xml).at('security').innerHTML
+        d.php_fcgid     = (xml).at('php_fcgid').innerHTML.to_i
+        d.security      = (xml).at('security').innerHTML.to_i
         d.user          = (xml).at('user').innerHTML
         d.www_or_not    = (xml).at('www_or_not').innerHTML
-        d.xcache        = (xml).at('xcache').innerHTML
+        d.xcache        = (xml).at('xcache').innerHTML.to_i
       end
       
       d

data/lib/dreamy/subscriber.rb

@@ -7,10 +7,10 @@ module Dreamy
     def self.new_from_xml(xml)
       s = new
       s.email           = (xml).at('email').innerHTML
-      s.confirmed       = (xml).at('confirmed').innerHTML
+      s.confirmed       = (xml).at('confirmed').innerHTML.to_i
       s.subscribe_date  = (xml).at('subscribe_date').innerHTML
       s.name            = (xml).at('name').innerHTML
-      s.num_bounces     = (xml).at('num_bounces').innerHTML
+      s.num_bounces     = (xml).at('num_bounces').innerHTML.to_i
       s
     end
   end

data/lib/dreamy/user.rb

@@ -6,12 +6,12 @@ module Dreamy
 
     def self.new_from_xml(xml)
       u = new
-      u.account_id    = (xml).at('account_id').innerHTML
-      u.disk_used_mb  = (xml).at('disk_used_mb').innerHTML
+      u.account_id    = (xml).at('account_id').innerHTML.to_i
+      u.disk_used_mb  = (xml).at('disk_used_mb').innerHTML.to_f
       u.gecos         = (xml).at('gecos').innerHTML
       u.home          = (xml).at('home').innerHTML
       u.password      = (xml).at('password').innerHTML
-      u.quota_mb      = (xml).at('quota_mb').innerHTML
+      u.quota_mb      = (xml).at('quota_mb').innerHTML.to_i
       u.shell         = (xml).at('shell').innerHTML
       u.type          = (xml).at('type').innerHTML
       u.username      = (xml).at('username').innerHTML

data/test/announce_test.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + "/test_helper.rb"
+
+class DreamyAnnounceListTest < Test::Unit::TestCase
+
+  context "Creation" do
+    setup do
+      @xml = <<EOF
+<data>
+  <name>Super Announce</name>
+  <account_id>8675309</account_id>
+  <domain>anessalee.net</domain>
+  <listname>testlist</listname>
+  <max_bounces>5</max_bounces>
+  <num_subscribers>22</num_subscribers>
+  <start_date>2009-04-20</start_date>
+</data>
+EOF
+    end
+
+    should "create a new list of announce lists from xml" do
+      l = Dreamy::AnnounceList.new_from_xml(Hpricot.XML(@xml))
+      assert_equal "Super Announce", l.name
+      assert_equal 8675309, l.account_id
+      assert_equal "anessalee.net", l.domain
+      assert_equal "testlist", l.short_name
+      assert_equal 5, l.max_bounces
+      assert_equal 22, l.subscribers
+      assert_equal "2009-04-20", l.start_date
+    end
+  end
+  
+end

data/test/base_test.rb

@@ -15,8 +15,9 @@ class DreamyBaseTest < Test::Unit::TestCase
   context "Domains" do
 
     should "return array of domain objects" do
-      assert_kind_of Array, @@base.domains
-      assert_kind_of Dreamy::Domain, @@base.domains.first
+      domains = @@base.domains
+      assert_kind_of Array, domains
+      assert_kind_of Dreamy::Domain, domains.first unless domains.empty?
     end
     
   end
@@ -24,8 +25,9 @@ class DreamyBaseTest < Test::Unit::TestCase
   context "Users" do
 
     should "return array of user objects" do
-      assert_kind_of Array, @@base.users
-      assert_kind_of Dreamy::User, @@base.users.first
+      users = @@base.users
+      assert_kind_of Array, users
+      assert_kind_of Dreamy::User, users.first unless users.empty?
     end
     
     should "not include user passwords by default" do
@@ -36,12 +38,64 @@ class DreamyBaseTest < Test::Unit::TestCase
   context "DNS" do
 
     should "return array of DNS records" do
-      assert_kind_of Array, @@base.dns
-      assert_kind_of Dreamy::Dns, @@base.dns.first
+      records = @@base.dns
+      assert_kind_of Array, records
+      assert_kind_of Dreamy::Dns, records.first unless records.empty?
     end
+    
+    context "adding a record" do
+      setup { @record_count = @@base.dns.size }
+      
+      should "require 3 arguments" do
+        assert_raise(ArgumentError) { @@base.dns_add("first","second") }
+      end
+      
+      should "add record and return true with valid data" do
+        assert @@base.dns_add("test." + CREDS["domain"],"A","208.97.188.35")
+        assert_equal @record_count + 1, @@base.dns.size
+      end
+      
+      should "not add record and raise error with invalid data" do
+        assert_raise(Dreamy::ApiError) { @@base.dns_add("test." + CREDS["domain"],"B","208.97.188.35") }
+        assert_equal @record_count, @@base.dns.size
+      end
+      
+    end
+    
+    context "removing a record" do
+      setup { @record_count = @@base.dns.size }
+      
+      should "require 3 arguments" do
+        assert_raise(ArgumentError) { @@base.dns_remove("first","second") }
+      end
+      
+      should "remove record and return true with valid data" do
+        assert @@base.dns_remove("test." + CREDS["domain"],"A","208.97.188.35")
+        @record_count -= 1
+        assert_equal @record_count, @@base.dns.size
+      end
+      
+      should "not remove record and raise error with invalid data" do
+        assert_raise(Dreamy::ApiError) { @@base.dns_remove("test." + CREDS["domain"],"B","208.97.188.35") }
+        assert_equal @record_count, @@base.dns.size
+      end
+      
+    end
+    
   end
   
   context "Announcement lists" do
+    
+    context "listing lists" do
+      
+      should "return array of AnnounceList records" do
+        lists = @@base.announce_lists
+        assert_kind_of Array, lists
+        assert_kind_of Dreamy::AnnounceList, lists.first unless lists.empty?
+      end
+      
+    end
+    
     context "subscribers" do
       
       should "require values for listname and domain" do
@@ -51,7 +105,7 @@ class DreamyBaseTest < Test::Unit::TestCase
       should "return array of Subscriber records" do
         subscribers = @@base.announce_list(CREDS["listname"],CREDS["domain"])
         assert_kind_of Array, subscribers
-        assert_kind_of Dreamy::Subscriber, subscribers.first
+        assert_kind_of Dreamy::Subscriber, subscribers.first unless subscribers.empty?
       end
       
     end
@@ -62,9 +116,9 @@ class DreamyBaseTest < Test::Unit::TestCase
         assert_raise(ArgumentError) { @@base.announce_add() }
       end
       
-      should "return true on success" do
-        assert @@base.announce_add(CREDS["listname"],CREDS["domain"],"new_guy@test.com")
-      end
+      # should "return true on success" do
+      #         assert @@base.announce_add(CREDS["listname"],CREDS["domain"],"new_guy@test.com")
+      #       end
       
     end
     
@@ -74,9 +128,9 @@ class DreamyBaseTest < Test::Unit::TestCase
         assert_raise(ArgumentError) { @@base.announce_remove() }
       end
       
-      should "return true on success" do
-        assert @@base.announce_remove(CREDS["listname"],CREDS["domain"],"new_guy@test.com")
-      end
+      # should "return true on success" do
+      #         assert @@base.announce_remove(CREDS["listname"],CREDS["domain"],"new_guy@test.com")
+      #       end
       
     end
     

data/test/dns_test.rb

@@ -19,9 +19,9 @@ EOF
 
     should "create a new DNS entry from xml" do
       d = Dreamy::Dns.new_from_xml(Hpricot.XML(@xml))
-      assert_equal "8675309", d.account_id
+      assert_equal 8675309, d.account_id
       assert_equal "", d.comment
-      assert_equal "0", d.editable
+      assert_equal 0, d.editable
       assert_equal "anessalee.net", d.record
       assert_equal "A", d.type
       assert_equal "202.22.191.4", d.value

data/test/domain_test.rb

@@ -40,26 +40,26 @@ EOF
     end
 
     should "assign valid http domain from xml" do
-      assert_equal "8675309", @d.account_id
+      assert_equal 8675309, @d.account_id
       assert_equal "anessalee.net", @d.domain
-      assert_equal "0", @d.fastcgi
+      assert_equal 0, @d.fastcgi
       assert_equal "juniormint.Dreamy.com", @d.home
       assert_equal "full", @d.hosting_type
       assert_equal "", @d.outside_url
-      assert_equal "0", @d.passenger
+      assert_equal 0, @d.passenger
       assert_equal "anessalee.net", @d.path
       assert_equal "pcgi5", @d.php
-      assert_equal "0", @d.php_fcgid
-      assert_equal "0", @d.security
+      assert_equal 0, @d.php_fcgid
+      assert_equal 0, @d.security
       assert_equal "http", @d.type
       assert_equal "", @d.unique_ip
       assert_equal "sant0sk1", @d.user
       assert_equal "both_work", @d.www_or_not
-      assert_equal "0", @d.xcache
+      assert_equal 0, @d.xcache
     end
     
     should "assign valid mysql domain from xml" do
-      assert_equal "8675309", @m.account_id
+      assert_equal 8675309, @m.account_id
       assert_equal "mysql.anessalee.net", @m.domain
       assert_equal "zechiel.swordfish.Dreamy.com", @m.home
       assert_equal "mysqldns", @m.type

data/test/subscriber_test.rb

@@ -18,10 +18,10 @@ EOF
     should "create a new user from xml" do
       s = Dreamy::Subscriber.new_from_xml(Hpricot.XML(@xml))
       assert_equal "joe@schmoe.com", s.email
-      # assert_equal "1", s.confirmed
+      assert_equal 1, s.confirmed
       assert_equal "2007-12-13 16:55:15", s.subscribe_date
       assert_equal "Josh", s.name
-      assert_equal "0", s.num_bounces
+      assert_equal 0, s.num_bounces
     end
   end
   

data/test/user_test.rb

@@ -7,7 +7,7 @@ class DreamyUserTest < Test::Unit::TestCase
       @xml = <<EOF
 <data>
     <account_id>8675309</account_id>
-    <disk_used_mb>0</disk_used_mb>
+    <disk_used_mb>123.04</disk_used_mb>
     <gecos>Joe Schmoe</gecos>
     <home>spork.Dreamy.com</home>
     <password>YahRight!</password>
@@ -21,12 +21,12 @@ EOF
 
     should "create a new user from xml" do
       u = Dreamy::User.new_from_xml(Hpricot.XML(@xml))
-      assert_equal "8675309", u.account_id
-      assert_equal "0", u.disk_used_mb
+      assert_equal 8675309, u.account_id
+      assert_equal 123.04, u.disk_used_mb
       assert_equal "Joe Schmoe", u.gecos
       assert_equal "spork.Dreamy.com", u.home
       assert_equal "YahRight!", u.password
-      assert_equal "50", u.quota_mb
+      assert_equal 50, u.quota_mb
       assert_equal "/bin/bash", u.shell
       assert_equal "mail", u.type
       assert_equal "joe@schmoe.com", u.username

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sant0sk1-dreamy
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jerod Santo
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-24 00:00:00 -07:00
+date: 2009-04-25 00:00:00 -07:00
 default_executable: dh
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,6 +56,7 @@ files:
 - VERSION.yml
 - bin/dh
 - lib/dreamy.rb
+- lib/dreamy/announce_list.rb
 - lib/dreamy/base.rb
 - lib/dreamy/command.rb
 - lib/dreamy/commands/announce.rb
@@ -70,6 +71,7 @@ files:
 - lib/dreamy/easy_class_maker.rb
 - lib/dreamy/subscriber.rb
 - lib/dreamy/user.rb
+- test/announce_test.rb
 - test/base_test.rb
 - test/dns_test.rb
 - test/domain_test.rb
@@ -103,6 +105,7 @@ signing_key:
 specification_version: 2
 summary: A Ruby library and command line tool for accessing DreamHost's API
 test_files: 
+- test/announce_test.rb
 - test/base_test.rb
 - test/dns_test.rb
 - test/domain_test.rb