sant0sk1-dreamy 0.1.2 → 0.2.0

data/README.md

@@ -17,22 +17,50 @@ Library Usage
 
 DreamHost requires a username (email or webID) and API key (available from your DH Panel) to make API requests. When creating a Dreamy instance you'll need to provide this data. The Dreamy command line tool (dh) gathers the necessary info from a configuration file or environment variables, but you can do it however you'd like.
 
-To get started with the library:
+To get started with the library, just require the gem:
 
     require 'rubygems'
     require 'dreamy'
     
+Create a new object using your username and API key.
+    
     account = Dreamy::Base.new(username,api_key)
     
-    # fetch an array of Dreamy::Domain objects
+Fetch an array of Dreamy::Domain objects:
+
     account.domains
     
+Now that you have an array you can have your way with the data:
+
+    account.domains.each do |d|
+      puts d.home
+      puts d.user
+      puts d.www_or_not
+    end
+    
+Same goes with Users, DNS records and announcement list subscribers
+    
     # fetch an array of Dreamy::User objects
     account.users
     
     # fetch an array of Dreamy::Dns objects
     account.dns
     
+    # fetch an array of Dreamy::Subscribers to an announcement list
+    account.announce_list(listname,domain)
+    
+You can interact with announcement lists by adding and removing subscribers
+    
+    # add a new subscriber to an announcement list
+    account.announce_add(listname,domain,email)
+    
+    # remove a subscriber from an announcement list
+    account.announce_remove(listname,domain,email)
+    
+More and more functions will be added as time allows. If there's something missing that you want in, please:
+
+fork -> commit -> pull request
+    
 Command Line Usage
 ==================
 
@@ -58,16 +86,20 @@ Run this from the command line to print the usage:
     dh help
     
     === Commands
+     help                           # show this usage
+
+     domains                        # list domains
+     domains:status                 # check availability of all domains (pingability)
 
-     help                         # show this usage
+     dns                            # list your DNS records
+     dns <name>                     # list DNS records for <ame>
 
-     domains                      # list domains
-     domains:status               # check availability of all domains
+     announce:list <list>           # lists all subscribers to <name> list (eg - 'my_list@example.com')
+     announce:add <list> <email>    # add a subscriber with <email> to <list>
+     announce:remove <list> <email> # remove subscriber with <email> from <list>
 
-     dns                          # list your DNS records
-     dns <name>                   # list DNS records for <ame>
+     users                          # list user accounts
 
-     users                        # list user accounts
      
 That's it for now. New commands should be springing up as Dreamy and the DreamHost API mature!
 
@@ -75,8 +107,7 @@ TODO
 ====
 
 * more tests
-* create rdocs
-* mailing lists
+* add real rdocs
 
 [1]:http://github.com/sant0sk1/dreamy
 [2]:http://wiki.Dreamy.com/API

data/VERSION.yml

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

data/lib/dreamy/base.rb

@@ -39,6 +39,21 @@ module Dreamy
       raise ApiError if (doc/:result).innerHTML == "error"
       (doc/:data).inject([]) { |subs, sub| subs << Subscriber.new_from_xml(sub); subs }
     end
+    
+    # adds new subscriber to announce list
+    def announce_add(listname,domain,email,name="")
+      doc = request("announcement_list-add_subscriber",
+                      {"listname" => listname, "domain" => domain, "email" => email, "name" => name})
+      return true if (doc/:result).innerHTML == "success"
+      false
+    end
+    
+    def announce_remove(listname,domain,email)
+      doc = request("announcement_list-remove_subscriber",
+                      {"listname" => listname, "domain" => domain, "email" => email} )
+      return true if (doc/:result).innerHTML == "success"
+      false
+    end
 
     private
 

data/lib/dreamy/commands/announce.rb

@@ -2,7 +2,7 @@ module Dreamy::Command
   class Announce < Base
 
     def list
-      if args.length > 0
+      if args.length >= 1
         listname, domain = extract_values(args.shift)
         subscribers = @account.announce_list(listname,domain)
         if subscribers.empty?
@@ -16,7 +16,35 @@ module Dreamy::Command
           display "#{subscribers.size} total subscribers"
         end
       else
-        display "Must specify announcement list. eg - 'my_list@example.com'"
+        display "Usage: dh announce:list my_list@example.com"
+      end
+    end
+    
+    def add
+      if args.length >= 2
+        listname, domain = extract_values(args.shift)
+        email = args.shift
+        if @account.announce_add(listname,domain,email)
+          display "Successfully added #{email} to #{listname} list"
+        else
+          display "Failed to add #{email} to #{listname} list"
+        end
+      else
+        display "Usage: dh announce:add my_list@example.com new_guy@gmail.com"
+      end
+    end
+    
+    def remove
+      if args.length >= 2
+        listname, domain = extract_values(args.shift)
+        email = args.shift
+        if @account.announce_remove(listname,domain,email)
+          display "Successfully removed #{email} from #{listname} list"
+        else
+          display "Failed to remove #{email} from #{listname} list"
+        end
+      else
+        display "Usage: dh announce:remove my_list@example.com new_guy@gmail.com"
       end
     end
 

data/lib/dreamy/commands/help.rb

@@ -8,20 +8,19 @@ module Dreamy::Command
 			usage = <<EOTXT
 
 === Commands
+ help                           # show this usage
 
- help                         # show this usage
-
- domains                      # list domains
- domains:status               # check availability of all domains
+ domains                        # list domains
+ domains:status                 # check availability of all domains (pingability)
  
- dns                          # list your DNS records
- dns <name>                   # list DNS records for <ame>
+ 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)
+ announce:list <list>           # lists all subscribers to <name> list (eg - 'my_list@example.com')
+ announce:add <list> <email>    # add a subscriber with <email> to <list>
+ announce:remove <list> <email> # remove subscriber with <email> from <list>
  
- users                        # list user accounts
+ users                          # list user accounts
 
 EOTXT
 		end

data/test/base_test.rb

@@ -56,14 +56,30 @@ class DreamyBaseTest < Test::Unit::TestCase
       
     end
     
-    context "add subscriber" do
+    context "adding a subscriber" do
+      
+      should "require values for listname, domain, and email" do
+        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
+      
     end
     
-    context "remove subscriber" do
+    context "removing a subscriber" do
+      
+      should "require values for listname, domain, and email" do
+        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
+      
     end
-
-  end
-  
-  
+    
+  end # announcement lists
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sant0sk1-dreamy
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jerod Santo