fog-maestrodev 1.7.0.20121114190951 → 1.8.0.20130109172219

data/lib/fog/brightbox/requests/compute/destroy_server.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Destroy the server and free up the resources.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#server_destroy_server
+        #
         def destroy_server(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("delete", "/1.0/servers/#{identifier}", [202])
+          wrapped_request("delete", "/1.0/servers/#{identifier}", [202])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/destroy_server_group.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Destroy the server group if not in use.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#server_group_destroy_server_group
+        #
         def destroy_server_group(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("delete", "/1.0/server_groups/#{identifier}", [202])
+          wrapped_request("delete", "/1.0/server_groups/#{identifier}", [202])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_account.rb

@@ -2,32 +2,24 @@ module Fog
   module Compute
     class Brightbox
       class Real
-        # Requests details about an account from the API
+        # Get full details of the account.
         #
-        # === Parameters:
+        # @overload get_account(identifier)
+        #   @param [String] identifier Unique reference to identify the resource
         #
-        # <tt>identifier <String></tt>:: The identifier to request (Default is +nil+)
+        # @overload get_account()
+        #   @deprecated Use {Fog::Compute::Brightbox::Real#get_scoped_account} instead
         #
-        # === Returns:
+        # @return [Hash] The JSON response parsed to a Hash
         #
-        # <tt>Hash</tt>:: The JSON response parsed to a Hash
-        #
-        # === Notes:
-        #
-        # This also supports a deprecated form where if an identifier is not
-        # passed then the scoping account is returned instead. This should not
-        # be used in new code. Use #get_scoped_account instead.
-        #
-        # === Reference:
-        #
-        # https://api.gb1.brightbox.com/1.0/#account_get_account
+        # @see https://api.gb1.brightbox.com/1.0/#account_get_account
         #
         def get_account(identifier = nil)
           if identifier.nil? || identifier.empty?
             Fog::Logger.deprecation("get_account() without a parameter is deprecated, use get_scoped_account instead [light_black](#{caller.first})[/]")
             get_scoped_account
           else
-            request("get", "/1.0/accounts/#{identifier}", [200])
+            wrapped_request("get", "/1.0/accounts/#{identifier}", [200])
           end
         end
 

data/lib/fog/brightbox/requests/compute/get_api_client.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get full details of the API client.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#api_client_get_api_client
+        #
         def get_api_client(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/api_clients/#{identifier}", [200])
+          wrapped_request("get", "/1.0/api_clients/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_application.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get full details of the application.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#application_get_application
+        #
         def get_application(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/applications/#{identifier}", [200])
+          wrapped_request("get", "/1.0/applications/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_authenticated_user.rb

@@ -4,12 +4,10 @@ module Fog
       class Real
         # Requests details about authenticated user from the API
         #
-        # === Returns:
-        #
-        # <tt>Hash</tt>:: The JSON response parsed to a Hash
+        # @return [Hash] The JSON response parsed to a Hash
         #
         def get_authenticated_user
-          request("get", "/1.0/user", [200])
+          wrapped_request("get", "/1.0/user", [200])
         end
 
       end

data/lib/fog/brightbox/requests/compute/get_cloud_ip.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get full details of the cloud IP address.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#cloud_ip_get_cloud_ip
+        #
         def get_cloud_ip(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/cloud_ips/#{identifier}", [200])
+          wrapped_request("get", "/1.0/cloud_ips/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_firewall_policy.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get details of the firewall policy
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#firewall_policy_get_firewall_policy
+        #
         def get_firewall_policy(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/firewall_policies/#{identifier}", [200])
+          wrapped_request("get", "/1.0/firewall_policies/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_firewall_rule.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get full details of the firewall rule.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#firewall_rule_get_firewall_rule
+        #
         def get_firewall_rule(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/firewall_rules/#{identifier}", [200])
+          wrapped_request("get", "/1.0/firewall_rules/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_image.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get full details of the image.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#image_get_image
+        #
         def get_image(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/images/#{identifier}", [200])
+          wrapped_request("get", "/1.0/images/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_interface.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get full details of the interface.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#interface_get_interface
+        #
         def get_interface(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/interfaces/#{identifier}", [200])
+          wrapped_request("get", "/1.0/interfaces/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_load_balancer.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get full details of the load balancer.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#load_balancer_get_load_balancer
+        #
         def get_load_balancer(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/load_balancers/#{identifier}", [200])
+          wrapped_request("get", "/1.0/load_balancers/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_scoped_account.rb

@@ -2,15 +2,11 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
         # Requests details about currently scoped account
         #
-        # === Returns:
-        #
-        # <tt>Hash</tt>:: The JSON response parsed to a Hash
-        #
+        # @return [Hash] The JSON response parsed to a Hash
         def get_scoped_account
-          request("get", "/1.0/account", [200])
+          wrapped_request("get", "/1.0/account", [200])
         end
 
       end

data/lib/fog/brightbox/requests/compute/get_server.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get full details of the server.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#server_get_server
+        #
         def get_server(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/servers/#{identifier}", [200])
+          wrapped_request("get", "/1.0/servers/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_server_group.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get details of the server group.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#server_group_get_server_group
+        #
         def get_server_group(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/server_groups/#{identifier}", [200])
+          wrapped_request("get", "/1.0/server_groups/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_server_type.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get full details of the server type.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#server_type_get_server_type
+        #
         def get_server_type(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/server_types/#{identifier}", [200])
+          wrapped_request("get", "/1.0/server_types/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end

data/lib/fog/brightbox/requests/compute/get_user.rb

@@ -2,32 +2,24 @@ module Fog
   module Compute
     class Brightbox
       class Real
-        # Requests details about a user from the API
+        # Get full details of the user.
         #
-        # === Parameters:
+        # @overload get_user(identifier)
+        #   @param [String] identifier Unique reference to identify the resource
         #
-        # <tt>identifier <String></tt>:: The identifier to request (Default is +nil+)
+        # @overload get_user()
+        #   @deprecated Use {Fog::Compute::Brightbox::Real#get_authenticated_user} instead
         #
-        # === Returns:
+        # @return [Hash] The JSON response parsed to a Hash
         #
-        # <tt>Hash</tt>:: The JSON response parsed to a Hash
-        #
-        # === Notes:
-        #
-        # This also supports a deprecated form where if an identifier is not
-        # passed then the requesting user is returned instead. This should not
-        # be used in new code. Use #get_authenticated_user instead.
-        #
-        # === Reference:
-        #
-        # https://api.gb1.brightbox.com/1.0/#user_get_user
+        # @see https://api.gb1.brightbox.com/1.0/#user_get_user
         #
         def get_user(identifier = nil)
           if identifier.nil? || identifier == ""
             Fog::Logger.deprecation("get_user() without a parameter is deprecated, use get_authenticated_user instead [light_black](#{caller.first})[/]")
             get_authenticated_user
           else
-            request("get", "/1.0/users/#{identifier}", [200])
+            wrapped_request("get", "/1.0/users/#{identifier}", [200])
           end
         end
 

data/lib/fog/brightbox/requests/compute/get_zone.rb

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Get full details of the zone.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#zone_get_zone
+        #
         def get_zone(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("get", "/1.0/zones/#{identifier}", [200])
+          wrapped_request("get", "/1.0/zones/#{identifier}", [200])
         end
 
       end
     end
   end
-end
+end