fog-maestrodev 1.7.0.20121114190951 → 1.8.0.20130109172219

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

@@ -3,11 +3,30 @@ module Fog
     class Brightbox
       class Real
 
-        def reset_ftp_password_account
-          request("post", "/1.0/account/reset_ftp_password", [200])
+        # Reset the image library ftp password for the account.
+        #
+        # @note The response is the only time the new password is available in plaintext.
+        #
+        # @overload reset_ftp_password_account(identifier)
+        #   @param [String] identifier Unique reference to identify the resource
+        #
+        # @overload reset_ftp_password_account()
+        #   @deprecated Use {Fog::Compute::Brightbox::Real#get_scoped_account} instead
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#account_reset_ftp_password_account
+        #
+        def reset_ftp_password_account(identifier = nil)
+          if identifier.nil? || identifier.empty?
+            Fog::Logger.deprecation("reset_ftp_password_account() without a parameter is deprecated, use reset_ftp_password_scoped_account instead [light_black](#{caller.first})[/]")
+            reset_ftp_password_scoped_account
+          else
+            wrapped_request("post", "/1.0/accounts/#{identifier}/reset_ftp_password", [200])
+          end
         end
 
       end
     end
   end
-end
+end

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

@@ -0,0 +1,18 @@
+module Fog
+  module Compute
+    class Brightbox
+      class Real
+        # Resets the image library ftp password for the scoped account
+        #
+        # @note The response is the only time the new password is available in plaintext.
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        def reset_ftp_password_scoped_account
+          wrapped_request("post", "/1.0/account/reset_ftp_password", [200])
+        end
+      end
+
+    end
+  end
+end

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

@@ -3,12 +3,24 @@ module Fog
     class Brightbox
       class Real
 
+        # Resets the secret used by the API client to a new generated value.
+        #
+        # The response is the only time the new secret is available in plaintext.
+        #
+        # Already authenticated tokens will still continue to be valid until expiry.
+        #
+        # @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_reset_secret_api_client
+        #
         def reset_secret_api_client(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("post", "/1.0/api_clients/#{identifier}/reset_secret", [200])
+          wrapped_request("post", "/1.0/api_clients/#{identifier}/reset_secret", [200])
         end
 
       end
     end
   end
-end
+end

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

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Resets the secret used by the application to a new generated value.
+        #
+        # @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_reset_secret_application
+        #
         def reset_secret_application(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("post", "/1.0/applications/#{identifier}/reset_secret", [200])
+          wrapped_request("post", "/1.0/applications/#{identifier}/reset_secret", [200])
         end
 
       end
     end
   end
-end
+end

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

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Will issue a safe shutdown request for 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_shutdown_server
+        #
         def shutdown_server(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("post", "/1.0/servers/#{identifier}/shutdown", [202])
+          wrapped_request("post", "/1.0/servers/#{identifier}/shutdown", [202])
         end
 
       end
     end
   end
-end
+end

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

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Will issue a request to snapshot 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_snapshot_server
+        #
         def snapshot_server(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("post", "/1.0/servers/#{identifier}/snapshot", [202])
+          wrapped_request("post", "/1.0/servers/#{identifier}/snapshot", [202])
         end
 
       end
     end
   end
-end
+end

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

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Will issue a start request for the server to become active.
+        #
+        # @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_start_server
+        #
         def start_server(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("post", "/1.0/servers/#{identifier}/start", [202])
+          wrapped_request("post", "/1.0/servers/#{identifier}/start", [202])
         end
 
       end
     end
   end
-end
+end

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

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Will issue a stop request for the server to become inactive.
+        #
+        # @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_stop_server
+        #
         def stop_server(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("post", "/1.0/servers/#{identifier}/stop", [202])
+          wrapped_request("post", "/1.0/servers/#{identifier}/stop", [202])
         end
 
       end
     end
   end
-end
+end

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

@@ -2,13 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Unmaps a cloud IP address from its current destination making it available to remap. This remains in the account's pool of addresses.
+        #
+        # @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_unmap_cloud_ip
+        #
         def unmap_cloud_ip(identifier)
           return nil if identifier.nil? || identifier == ""
-          request("post", "/1.0/cloud_ips/#{identifier}/unmap", [202])
+          wrapped_request("post", "/1.0/cloud_ips/#{identifier}/unmap", [202])
         end
 
       end
     end
   end
-end
+end

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

@@ -2,40 +2,38 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
-        # Requests an update to the currently scoped account
-        #
-        # === Parameters:
-        #
-        # <tt>identifier <String></tt>:: The identifier to request (Default is +nil+)
-        # <tt>options <Hash></tt>:: Hash of options for update
-        #
-        # === Options:
-        #
-        # <tt>name</tt>:: Account name
-        # <tt>address_1</tt>:: First line of address
-        # <tt>address_2</tt>:: Second line of address
-        # <tt>city</tt>:: City part of address
-        # <tt>county</tt>:: County part of address
-        # <tt>postcode</tt>:: Postal code
-        # <tt>country_code</tt>:: ISO 3166-1 two letter code (example: +GB+)
-        # <tt>vat_registration_number</tt>:: Valid EU VAT Number or +nil+
-        # <tt>telephone_number</tt>:: Valid International telephone number in E.164 format prefixed with ’+’
-        #
-        # === Returns:
-        #
-        # <tt>Hash</tt>:: The JSON response parsed to a Hash
-        # <tt>nil</tt>:: If no options were passed to update
-        #
-        # === Notes:
-        #
-        # This also supports a deprecated form where if an identifier is not
-        # passed then the scoping account is updated instead. This should not
-        # be used in new code. Use #update_scoped_account instead.
-        #
-        # === Reference:
-        #
-        # https://api.gb1.brightbox.com/1.0/#account_update_account
+        # Update some details of the account.
+        #
+        # @overload update_account(identifier, options)
+        #   @param [String] identifier Unique reference to identify the resource
+        #   @param [Hash] options
+        #   @option options [String] :name Account name
+        #   @option options [String] :address_1 First line of address
+        #   @option options [String] :address_2 Second line of address
+        #   @option options [String] :city City part of address
+        #   @option options [String] :county County part of address
+        #   @option options [String] :postcode Postcode or Zipcode
+        #   @option options [String] :country_code ISO 3166-1 two letter code (example: `GB`)
+        #   @option options [String] :vat_registration_number Must be a valid EU VAT number or `nil`
+        #   @option options [String] :telephone_number Valid International telephone number in E.164 format prefixed with `+`
+        #
+        # @overload update_account(options)
+        #   @deprecated Use {Fog::Compute::Brightbox::Real#update_scoped_account} instead
+        #
+        #   @param [Hash] options
+        #   @option options [String] :name Account name
+        #   @option options [String] :address_1 First line of address
+        #   @option options [String] :address_2 Second line of address
+        #   @option options [String] :city City part of address
+        #   @option options [String] :county County part of address
+        #   @option options [String] :postcode Postcode or Zipcode
+        #   @option options [String] :country_code ISO 3166-1 two letter code (example: `GB`)
+        #   @option options [String] :vat_registration_number Must be a valid EU VAT number or `nil`
+        #   @option options [String] :telephone_number Valid International telephone number in E.164 format prefixed with `+`
+        #
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#account_update_account
         #
         def update_account(*args)
           if args.size == 2
@@ -52,7 +50,7 @@ module Fog
             Fog::Logger.deprecation("update_account() without a parameter is deprecated, use update_scoped_account instead [light_black](#{caller.first})[/]")
             update_scoped_account(options)
           else
-            request("put", "/1.0/accounts/#{identifier}", [200], options)
+            wrapped_request("put", "/1.0/accounts/#{identifier}", [200], options)
           end
         end
 

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

@@ -2,14 +2,24 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Update some details of the API client.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [String] :name
+        # @option options [String] :description
+        #
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#api_client_update_api_client
+        #
         def update_api_client(identifier, options)
           return nil if identifier.nil? || identifier == ""
           return nil if options.empty? || options.nil?
-          request("put", "/1.0/api_clients/#{identifier}", [200], options)
+          wrapped_request("put", "/1.0/api_clients/#{identifier}", [200], options)
         end
 
       end
     end
   end
-end
+end

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

@@ -2,14 +2,24 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Update some details of the application.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [String] :name
+        # @option options [String] :description
+        #
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#application_update_application
+        #
         def update_application(identifier, options)
           return nil if identifier.nil? || identifier == ""
           return nil if options.empty? || options.nil?
-          request("put", "/1.0/applications/#{identifier}", [200], options)
+          wrapped_request("put", "/1.0/applications/#{identifier}", [200], options)
         end
 
       end
     end
   end
-end
+end

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

@@ -2,14 +2,25 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Update some details of the cloud IP address.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [String] :reverse_dns Reverse DNS hostname
+        # @option options [String] :name Name for Cloud IP
+        # @option options [Array] :port_translators Port on which external clients connect and port on which your service is listening.
+        #
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#cloud_ip_update_cloud_ip
+        #
         def update_cloud_ip(identifier, options)
           return nil if identifier.nil? || identifier == ""
           return nil if options.empty? || options.nil?
-          request("put", "/1.0/cloud_ips/#{identifier}", [200], options)
+          wrapped_request("put", "/1.0/cloud_ips/#{identifier}", [200], options)
         end
 
       end
     end
   end
-end
+end

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

@@ -2,11 +2,26 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Update some settings of the firewall rule.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [String] :protocol
+        # @option options [String] :source Required unless destination is set.
+        # @option options [String] :source_port
+        # @option options [String] :destination Required unless source is set
+        # @option options [String] :destination_port
+        # @option options [String] :icmp_type_name
+        # @option options [String] :description
+        #
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#firewall_rule_update_firewall_rule
+        #
         def update_firewall_rule(identifier, options)
           return nil if identifier.nil? || identifier == ""
           return nil if options.empty? || options.nil?
-          request("put", "/1.0/firewall_rules/#{identifier}", [202], options)
+          wrapped_request("put", "/1.0/firewall_rules/#{identifier}", [202], options)
         end
 
       end

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

@@ -2,14 +2,29 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Update some details of the image.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [String] :name
+        # @option options [String] :username
+        # @option options [String] :arch
+        # @option options [String] :status
+        # @option options [Boolean] :public
+        # @option options [Boolean] :compatibility_mode
+        # @option options [String] :description
+        #
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#image_update_image
+        #
         def update_image(identifier, options)
           return nil if identifier.nil? || identifier == ""
           return nil if options.empty? || options.nil?
-          request("put", "/1.0/images/#{identifier}", [200], options)
+          wrapped_request("put", "/1.0/images/#{identifier}", [200], options)
         end
 
       end
     end
   end
-end
+end