sant0sk1-dreamy 0.1.1 → 0.1.2

data/README.md

@@ -22,7 +22,7 @@ To get started with the library:
     require 'rubygems'
     require 'dreamy'
     
-    account = Dreamy::Control.new(username,api_key)
+    account = Dreamy::Base.new(username,api_key)
     
     # fetch an array of Dreamy::Domain objects
     account.domains

data/VERSION.yml

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

data/lib/dreamy.rb

@@ -7,13 +7,16 @@ require 'uuid'
 
 
 $:.unshift(File.dirname(__FILE__) + "/dreamy")
+require 'dreamy/core_extensions'
 require 'dreamy/easy_class_maker'
-require 'dreamy/control'
+require 'dreamy/base'
 require 'dreamy/domain'
 require 'dreamy/dns'
+require 'dreamy/subscriber'
 require 'dreamy/user'
 
 module Dreamy
     class CantConnect < StandardError; end
     class Unavailable < StandardError; end
+    class ApiError    < StandardError; end
 end

data/lib/dreamy/{control.rb → base.rb}

@@ -1,5 +1,5 @@
 module Dreamy
-  class Control
+  class Base
 
     @@host = "api.dreamhost.com"
 
@@ -7,13 +7,14 @@ module Dreamy
       @username = username
       @key      = key
     end
-    
+
     # returns an array of domain objects
     def domains
       doc = request("domain-list_domains")
+      raise ApiError if (doc/:result).innerHTML == "error"
       (doc/:data).inject([]) { |domains, domain| domains << Domain.new_from_xml(domain); domains }
     end
-    
+
     # returns an array of user objects
     def users(passwords=false)
       if passwords
@@ -21,32 +22,41 @@ module Dreamy
       else
         doc = request("user-list_users_no_pw")
       end
-      
+      raise ApiError 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"
       (doc/:data).inject([]) { |records, dns| records << Dns.new_from_xml(dns); records }
     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"
+      (doc/:data).inject([]) { |subs, sub| subs << Subscriber.new_from_xml(sub); subs }
+    end
+
+    private
+
     def request(cmd,values={})
       handle_response!(response(cmd,values))
     end
-    
-     private
+
 
     def response(cmd,values={})
-      params = [
-        "username=#{@username}",
-        "key=#{@key}",
-        "cmd=#{cmd}",
-        "format=xml",
-        "unique_id=#{UUID.new.generate}",
-      ]
-      
-      path = "/?#{params.join("&")}"
+      values = {
+        "username"  => @username,
+        "key"       => @key,
+        "cmd"       => cmd,
+        "format"    => "xml",
+        "unique_id" => UUID.new.generate
+      }.merge(values)
+
+      path = "/?#{values.to_param_array.join("&")}"
       http = Net::HTTP.new(@@host, 443)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
@@ -57,7 +67,7 @@ module Dreamy
         raise CantConnect, error.message
       end
     end
-    
+
     def handle_response!(response)
       if %w[200 304].include?(response.code)
         response = parse(response.body)
@@ -69,7 +79,7 @@ module Dreamy
         raise CantConnect, "Dreamy is returning a #{response.code}: #{response.message}"
       end
     end
-    
+
     # Converts a string response into an Hpricot xml element.
     def parse(response)
       Hpricot.XML(response || '')

data/lib/dreamy/commands/announce.rb

@@ -0,0 +1,31 @@
+module Dreamy::Command
+  class Announce < Base
+
+    def list
+      if args.length > 0
+        listname, domain = extract_values(args.shift)
+        subscribers = @account.announce_list(listname,domain)
+        if subscribers.empty?
+          display "No subscribers to this list"
+        else
+          subscriber_table = table do |t|
+            t.headings = 'email', 'name', 'subscribe_date', 'bounces'
+            subscribers.each { |s| t << [s.email, s.name, s.subscribe_date, s.num_bounces] }
+          end
+          display subscriber_table
+          display "#{subscribers.size} total subscribers"
+        end
+      else
+        display "Must specify announcement list. eg - 'my_list@example.com'"
+      end
+    end
+
+    private
+
+    def extract_values(arg)
+      arg =~ /^(.*)@(.*)$/
+      return $1, $2
+    end
+
+  end
+end

data/lib/dreamy/commands/base.rb

@@ -53,7 +53,7 @@ module Dreamy::Command
     private
     
     def configure_account
-			Dreamy::Control.new(user,key)
+			Dreamy::Base.new(user,key)
     end
     
     def user

data/lib/dreamy/commands/help.rb

@@ -17,6 +17,10 @@ module Dreamy::Command
  dns                          # list your DNS records
  dns <name>                   # list DNS records for <ame>
  
+ announce:list <name>         # lists all subscribers to <name> list (eg - 'my_list@example.com')
+ announce:add <name>          # add a subscriber to <name> list (COMING SOON)
+ announce:remove <name>       # remove a subscriber from <name> list (COMING SOON)
+ 
  users                        # list user accounts
 
 EOTXT

data/lib/dreamy/core_extensions.rb

@@ -0,0 +1,9 @@
+class Hash
+  def to_param_array
+    p = Array.new
+    self.each do |k,v|
+      p << "#{k}=#{v}"
+    end
+    p
+  end
+end

data/lib/dreamy/subscriber.rb

@@ -0,0 +1,17 @@
+module Dreamy
+  class Subscriber
+    include EasyClassMaker
+
+    attributes  :email, :confirmed, :subscribe_date, :name, :num_bounces
+
+    def self.new_from_xml(xml)
+      s = new
+      s.email           = (xml).at('email').innerHTML
+      # s.confirmed       = (xml).at('confirmed').innerHTML
+      s.subscribe_date  = (xml).at('subscribe_date').innerHTML
+      s.name            = (xml).at('name').innerHTML
+      s.num_bounces     = (xml).at('num_bounces').innerHTML
+      s
+    end
+  end
+end

data/test/{control_test.rb → base_test.rb}

@@ -1,13 +1,13 @@
 require File.dirname(__FILE__) + "/test_helper.rb"
 
-class DreamyControlTest < Test::Unit::TestCase
+class DreamyBaseTest < Test::Unit::TestCase
   
-  @@base = Dreamy::Control.new(CREDS["user"],CREDS["key"])
+  @@base = Dreamy::Base.new(CREDS["user"],CREDS["key"])
   
   context "Initialization" do
 
     should "require email and API key" do
-      assert_raise(ArgumentError) { Dreamy::Control.new }
+      assert_raise(ArgumentError) { Dreamy::Base.new }
     end
     
   end
@@ -41,5 +41,29 @@ class DreamyControlTest < Test::Unit::TestCase
     end
   end
   
+  context "Announcement lists" do
+    context "subscribers" do
+      
+      should "require values for listname and domain" do
+        assert_raise(ArgumentError) { @@base.announce_list() }
+      end
+      
+      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
+      end
+      
+    end
+    
+    context "add subscriber" do
+    end
+    
+    context "remove subscriber" do
+    end
+
+  end
+  
+  
   
 end

data/test/subscriber_test.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + "/test_helper.rb"
+
+class DreamySubscriberTest < Test::Unit::TestCase
+
+  context "Creation" do
+    setup do
+      @xml = <<EOF
+<data>
+    <email>joe@schmoe.com</email>
+    <confirmed>1</confirmed>
+    <subscribe_date>2007-12-13 16:55:15</subscribe_date>
+    <name>Josh</name>
+    <num_bounces>0</num_bounces>
+</data>
+EOF
+    end
+
+    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 "2007-12-13 16:55:15", s.subscribe_date
+      assert_equal "Josh", s.name
+      assert_equal "0", s.num_bounces
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sant0sk1-dreamy
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Jerod Santo
@@ -36,20 +36,24 @@ files:
 - VERSION.yml
 - bin/dh
 - lib/dreamy.rb
+- lib/dreamy/base.rb
 - lib/dreamy/command.rb
+- lib/dreamy/commands/announce.rb
 - lib/dreamy/commands/base.rb
 - lib/dreamy/commands/dns.rb
 - lib/dreamy/commands/domains.rb
 - lib/dreamy/commands/help.rb
 - lib/dreamy/commands/users.rb
-- lib/dreamy/control.rb
+- lib/dreamy/core_extensions.rb
 - lib/dreamy/dns.rb
 - lib/dreamy/domain.rb
 - lib/dreamy/easy_class_maker.rb
+- lib/dreamy/subscriber.rb
 - lib/dreamy/user.rb
-- test/control_test.rb
+- test/base_test.rb
 - test/dns_test.rb
 - test/domain_test.rb
+- test/subscriber_test.rb
 - test/test_helper.rb
 - test/user_test.rb
 has_rdoc: true
@@ -79,8 +83,9 @@ signing_key:
 specification_version: 2
 summary: A Ruby library and command line tool for accessing DreamHost's API
 test_files: 
-- test/control_test.rb
+- test/base_test.rb
 - test/dns_test.rb
 - test/domain_test.rb
+- test/subscriber_test.rb
 - test/test_helper.rb
 - test/user_test.rb