fanny_pack 0.1.0 → 0.1.1

data/lib/fanny_pack/errors.rb

@@ -1,5 +1,5 @@
 module FannyPack
-  module Errors #:nodoc: all
+  module Errors
     # Fault codes and error messages that are returned by the Fantastico API
     FAULT_CODES = {
       1302 => "You have specified an invalid hash.",
@@ -17,5 +17,11 @@ module FannyPack
         super "Must set FannyPack.account_hash"
       end
     end
+
+    class MissingArgument < ArgumentError
+      def initialize(param = nil)
+        super "Missing required parameter: #{param}"
+      end
+    end
   end
 end

data/lib/fanny_pack/ip.rb

@@ -11,20 +11,18 @@ module FannyPack
 
     # Add an IP address to your Fantastico account.
     #
-    # Returns a Hash containing the new IP info on success
-    # Returns a Hash containing an error code and message on error
+    # @param [String] ip
+    #   The IP address to add
     #
-    # ==== Options
+    # @param [Symbol] ip_type
+    #   The type of IP address (+:vps+ or +:normal+)
     #
-    # * +ip+ - The cPanel IP address to add
-    # * +ip_type* - The type of IP address (:vps or :normal)
+    # @return [Hash]
     #
-    # ==== Examples
-    #
-    #   # Add normal IP
+    # @example Add normal IP
     #   FannyPack::IP.add '127.0.0.1'
     #
-    #   # Add vps IP
+    # @example Add vps IP
     #   FannyPack::IP.add '127.0.0.1', :vps
     def self.add(ip, ip_type = :normal)
       Request.new.commit :addIp, :ip => ip, :type => IP_TYPES[ip_type]
@@ -32,16 +30,15 @@ module FannyPack
 
     # Edit an IP address, replacing +ip+ with +new_ip+
     #
-    # Returns a Hash containing the new IP info on success
-    # Returns a Hash containing an error code and message on error
-    #
-    # ==== Options
+    # @param [String] ip
+    #   The current IP address
     #
-    # * +ip+ - The current IP address
-    # * +new_ip+ - The new IP address
+    # @param [String] new_ip
+    #   The new IP address
     #
-    # ==== Example
+    # @return [Hash]
     #
+    # @example
     #   FannyPack::IP.edit '127.0.0.1', '127.0.0.2'
     def self.edit(ip, new_ip)
       Request.new.commit :editIp, :ip => ip, :new_ip => new_ip
@@ -50,42 +47,38 @@ module FannyPack
     # Get a list of IP addresses on your Fantastico account
     #
     # The Fantastico API allows you to filter for only normal IPs, or only
-    # vps IPs. Use +list_type+ :all to get all IPs, :normal to get only normal
-    # IPs, or :vps to get only vps IPs.
-    #
-    # Raises ArgumentError if list_type is invalid
-    #
-    # If +details+ is false:
-    # Returns an Array containing IP addresses
+    # vps IPs. Use +list_type+ +:all+ to get all IPs, +:normal+ to get only
+    # normal IPs, or +:vps+ to get only vps IPs.
     #
-    # If +details+ is true:
-    # Returns an Array of Hashes containing info for each IP
+    # @param [Symbol] list_type
+    #   The list type, one of +:normal+, +:vps+, +:all+
     #
-    # Returns a Hash containing an error code and message on error
+    # @param [Boolean] details
+    #   Set to true to return details for each IP
     #
-    # ==== Options
+    # @raise [ArgumentError]
+    #   Raised if list_type is invalid
     #
-    # * +list_type+ - The list type, one of :normal, :vps, :all
-    # * +details+ - Set to true to return details for each IP
+    # @return [Array]
+    #   If +details+ is false, an array of IPs as +Strings+ is returned. If
+    #   +details+ is true, an array of IPs as Hashes is returned.
     #
-    # ==== Examples
-    #
-    #   # Show all IPs (simple list)
+    # @example Show all IPs (simple list)
     #   FannyPack::IP.list :all
     #
-    #   # Show all IPs (detailed list)
+    # @example Show all IPs (detailed list)
     #   FannyPack::IP.list :all, true
     #
-    #   # Show normal IPs (simple list)
+    # @example Show normal IPs (simple list)
     #   FannyPack::IP.list :normal
     #
-    #   # Show normal IPs (detailed list)
+    # @example Show normal IPs (detailed list)
     #   FannyPack::IP.list :normal, true
     #
-    #   # Show vps IPs (simple list)
+    # @example Show vps IPs (simple list)
     #   FannyPack::IP.list :vps
     #
-    #   # Show normal IPs (detailed list)
+    # @example Show normal IPs (detailed list)
     #   FannyPack::IP.list :vps, true
     def self.list(list_type, details = false)
       cmd = details ? :getIpListDetailed : :getIpList
@@ -97,15 +90,12 @@ module FannyPack
 
     # Delete an IP address from your Fantastico Account
     #
-    # Returns a Hash containing the IP info
-    # Returns a Hash containing an error code and message on error
-    #
-    # ==== Options
-    #
-    # * +ip+ - The IP address to delete
+    # @param [String] ip
+    #   The IP address to delete
     #
-    # ==== Example
+    # @return [Hash]
     #
+    # @example
     #   FannyPack::IP.delete '127.0.0.1'
     def self.delete(ip)
       Request.new.commit :deleteIp, :ip => ip
@@ -113,15 +103,12 @@ module FannyPack
 
     # Reactivate a deactivated IP address
     #
-    # Returns a Hash containing the IP info
-    # Returns a Hash containing an error code and message on error
+    # @param [String] ip
+    #   The IP address to reactivate
     #
-    # ==== Options
-    #
-    # * +ip+ - The IP address to reactivate
-    #
-    # ==== Example
+    # @return [Hash]
     #
+    # @example
     #   FannyPack::IP.reactivate '127.0.0.1'
     def self.reactivate(ip)
       Request.new.commit :reactivateIp, :ip => ip
@@ -129,15 +116,12 @@ module FannyPack
 
     # Deactivate an IP address
     #
-    # Returns a Hash containing the IP info
-    # Returns a Hash containing an error code and message on error
-    #
-    # ==== Options
+    # @param [String] ip
+    #   The IP address to deactivate
     #
-    # * +ip+ - The IP address to deactivate
-    #
-    # ==== Example
+    # @return [Hash]
     #
+    # @example
     #   FannyPack::IP.deactivate '127.0.0.1'
     def self.deactivate(ip)
       Request.new.commit :deactivateIp, :ip => ip
@@ -145,15 +129,12 @@ module FannyPack
 
     # Get details for an IP address
     #
-    # Returns a Hash containing the IP info
-    # Returns a Hash containing an error code and message on error
-    #
-    # ==== Options
-    #
-    # * +ip+ - The IP address to lookup
+    # @param [String] ip
+    #    The IP address to look up
     #
-    # ==== Example
+    # @return [Hash]
     #
+    # @example
     #   FannyPack::IP.details '127.0.0.1'
     def self.details(ip)
       Request.new.commit :getIpDetails, :ip => ip

data/lib/fanny_pack/request.rb

@@ -7,7 +7,15 @@ module FannyPack
   # FannyPack::Request handles forming the XML request to be sent to the
   # Fantastico API, and parsing the response.
   class Request
-    attr_reader :params, :response
+    # Parameters for the API request
+    #
+    # @return [Hash]
+    attr_reader :params
+
+    # The parsed API response
+    #
+    # @return [Hash]
+    attr_reader :response
 
     # The Fantastico API supports these methods
     VALID_ACTIONS = [
@@ -28,10 +36,13 @@ module FannyPack
     #
     # Returns a Hash or Array, depending on the response from Fantastico
     #
-    # ==== Options
+    # @param [Symbol] action
+    #   The action to perform, one of +VALID_ACTIONS+
     #
-    # * +action+ - The action to perform, one of VALID_ACTIONS
-    # * +params+ - A hash containing parameters for the API method
+    # @param [Hash]
+    #   Parameters for the API method
+    #
+    # @return [Hash, Array]
     def commit(action, params = {})
       unless VALID_ACTIONS.include? action.to_sym
         raise "Invalid action"
@@ -50,9 +61,10 @@ module FannyPack
     #
     # Returns an Array or Hash depending on the API method called
     #
-    # ==== Options
+    # @param [String] data
+    #   The XML response from Fantastico
     #
-    # * +data+ - The XML response from Fantastico
+    # @return [Hash, Array]
     def parse(data)
       res = find_key_in_hash(Crack::XML.parse(data), 'item')
       if @action.to_sym == :getIpListDetailed
@@ -69,12 +81,16 @@ module FannyPack
       res
     end
 
-    # Returns true or false
+    # Returns true if a commit was successful
+    #
+    # @return [Boolean]
     def success?
       @success
     end
 
     # Builds the SOAP Envelope to be sent to Fantastico for this request
+    #
+    # @return [String]
     def to_xml
       xml = Builder::XmlMarkup.new :indent => 2
       xml.instruct!
@@ -95,10 +111,11 @@ module FannyPack
 
     # Finds +index+ in +hash+ by searching recursively
     #
-    # ==== Options
+    # @param [Hash] hash
+    #   The hash to search
     #
-    # * +hash+ - The hash to search
-    # * +index+ - The hash key to look for
+    # @param index
+    #   The hash key to look for
     def find_key_in_hash(hash, index)
       hash.each do |key, val|
         if val.respond_to? :has_key?

data/lib/fanny_pack/version.rb

@@ -1,3 +1,3 @@
 module FannyPack
-  Version = VERSION = '0.1.0'
+  Version = VERSION = '0.1.1'
 end

data/lib/fanny_pack.rb

@@ -5,8 +5,12 @@ module FannyPack
   autoload :IP,      'fanny_pack/ip'
 
   class << self
-    # FannyPack.account_hash stores your Fantastico account hash. This is used
-    # to authenticate your account with the Fantastico API.
+    # Your Fantastico account hash, used for API authentication
+    #
+    # @param [String] hash
+    #   Your Fantastico account hash
+    #
+    # @return [String]
     attr_accessor :account_hash
   end
 

data/spec/fanny_pack/ip_spec.rb

@@ -21,9 +21,7 @@ describe FannyPack::IP do
 
   describe "::add" do
     it "raises ArgumentError without IP" do
-      expect {
-        FannyPack::IP.add
-      }.to raise_error(ArgumentError)
+      requires_ip { FannyPack::IP.add }
     end
 
     it "returns a Hash" do
@@ -35,7 +33,7 @@ describe FannyPack::IP do
 
   describe "::edit" do
     it "raises ArgumentError without IP" do
-      expect { FannyPack::IP.edit }.to raise_error(ArgumentError)
+      requires_ip { FannyPack::IP.edit }
     end
 
     it "edits the IP" do
@@ -47,7 +45,7 @@ describe FannyPack::IP do
 
   describe "::list" do
     it "raises ArgumentError without type" do
-      expect { FannyPack::IP.list }.to raise_error(ArgumentError)
+      requires_ip { FannyPack::IP.list }
     end
 
     it "raises error with invalid type" do
@@ -79,7 +77,7 @@ describe FannyPack::IP do
 
   describe "::delete" do
     it "raises ArgumentError without IP" do
-      expect { FannyPack::IP.delete }.to raise_error(ArgumentError)
+      requires_ip { FannyPack::IP.delete }
     end
 
     it "deletes the IP" do
@@ -94,7 +92,7 @@ describe FannyPack::IP do
   %w[reactivate deactivate].each do |method|
     describe "::#{method}" do
       it "raises ArgumentError without IP" do
-        expect { FannyPack::IP.send method }.to raise_error(ArgumentError)
+        requires_ip { FannyPack::IP.send(method) }
       end
 
       it "#{method}s the IP" do
@@ -110,7 +108,7 @@ describe FannyPack::IP do
 
   describe "::details" do
     it "raises ArgumentError without IP" do
-      expect { FannyPack::IP.details }.to raise_error(ArgumentError)
+      requires_ip { FannyPack::IP.details }
     end
 
     it "returns a hash of IP details" do

data/spec/spec_helper.rb

@@ -15,3 +15,7 @@ def register_url(body)
   FakeWeb.allow_net_connect = false
   FakeWeb.register_uri :any, FannyPack::Request::API_URL, :body => body
 end
+
+def requires_ip(&block)
+  expect { block.call }.to raise_error(ArgumentError)
+end

metadata

@@ -2,7 +2,7 @@
 name: fanny_pack
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Joshua Priddle
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 -04:00
+date: 2011-05-31 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,9 +19,9 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 3.0.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -30,66 +30,77 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.1.8
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: rake
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.5.0
+        version: 0.8.7
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: fakeweb
+  name: rspec
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.3.0
+        version: 2.6.0
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: awesome_print
+  name: fakeweb
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.3.0
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  name: awesome_print
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "0.9"
+        version: 0.4.0
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: metric_fu
+  name: rcov
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "2.1"
+        version: "0.9"
   type: :development
   version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: metric_fu
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+  type: :development
+  version_requirements: *id008
 description: "    Ruby bindings for the Fantastico API\n"
 email: jpriddle@site5.com
 executables: []