fog 1.7.0 → 1.8.0

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

@@ -2,7 +2,13 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Lists summary details of server types available to the account.
+        #
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#server_type_list_server_types
+        #
         def list_server_types
           request("get", "/1.0/server_types", [200])
         end
@@ -10,4 +16,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,13 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Lists summary details of servers owned by the account.
+        #
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#server_list_servers
+        #
         def list_servers
           request("get", "/1.0/servers", [200])
         end
@@ -10,4 +16,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,13 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Lists summary details of user.
+        #
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#user_list_users
+        #
         def list_users
           request("get", "/1.0/users", [200])
         end
@@ -10,4 +16,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,13 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Lists summary details of zones available to the account.
+        #
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#zone_list_zones
+        #
         def list_zones
           request("get", "/1.0/zones", [200])
         end
@@ -10,4 +16,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,16 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Maps (or points) a cloud IP address at a server's interface or a load balancer to allow them to respond to public requests.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [String] :destination The ID of an Interface or LoadBalancer to map the Cloud IP against
+        #
+        # @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_map_cloud_ip
+        #
         def map_cloud_ip(identifier, options)
           return nil if identifier.nil? || identifier == ""
           request("post", "/1.0/cloud_ips/#{identifier}/map", [202], options)
@@ -11,4 +20,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,21 +2,19 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
-        # Moves a number of servers between two server groups
+        # Removes a number of server from the server group and adds them to another server group given in parameters.
         #
-        #  >> Compute[:brightbox].remove_servers_server_group "grp-12345", :destination => "grp-67890", :servers => [{:server => "srv-abcde"}]
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Array<Hash>] :servers Array of Hashes containing `{"server" => server_id}` for each server to remove
+        # @option options [String] :destination ServerGroup to move servers to
         #
-        # == Parameters:
-        # * identifier - The identifier (String) of the server group to remove from
-        # * options (Hash)
-        #   * destination (String)- The identifier of the server group to move to
-        #   * servers (Array) - Array of Hashes containing {"server" => server_id} for each server to remove
-        #   [\[{"server" => "srv-abcde"}, {"server" => "srv-fghij"}\]]
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
         #
-        # == Returns:
+        # @see https://api.gb1.brightbox.com/1.0/#server_group_move_servers_server_group
         #
-        # A Ruby hash of the server response
+        # @example
+        #    Compute[:brightbox].remove_servers_server_group "grp-12345", :destination => "grp-67890", :servers => [{"server" => "srv-abcde"}, {"server" => "srv-fghij"}]
         #
         def move_servers_server_group(identifier, options)
           return nil if identifier.nil? || identifier == ""
@@ -26,4 +24,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,16 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Removes firewall policy from given server group
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [String] :server_group Server Group to remove
+        #
+        # @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_policy_remove_firewall_policy
+        #
         def remove_firewall_policy(identifier, options)
           return nil if identifier.nil? || identifier == ""
           request("post", "/1.0/firewall_policies/#{identifier}/remove", [202], options)
@@ -11,4 +20,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,16 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Removes a number of listeners from a load balancer to cease balancing across nodes for those settings.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Array] :listeners Array of Listener parameters
+        #
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#load_balancer_remove_listeners_load_balancer
+        #
         def remove_listeners_load_balancer(identifier, options)
           return nil if identifier.nil? || identifier == ""
           request("post", "/1.0/load_balancers/#{identifier}/remove_listeners", [202], options)
@@ -11,4 +20,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,16 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Remove a number of nodes from the load balancer
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Array] :nodes Array of Node parameters
+        #
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#load_balancer_remove_nodes_load_balancer
+        #
         def remove_nodes_load_balancer(identifier, options)
           return nil if identifier.nil? || identifier == ""
           request("post", "/1.0/load_balancers/#{identifier}/remove_nodes", [202], options)
@@ -11,4 +20,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,19 +2,18 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
-        # Remove a number of servers from a server group
+        # Remove a number of servers from the server group.
         #
-        #  >> Compute[:brightbox].remove_servers_server_group "grp-12345", :servers => [{:server => "srv-abcde"}]
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Array<Hash>] :servers Array of Hashes containing {"server" => server_id} for each server
         #
-        # == Parameters:
-        # * identifier (String) - The identifier of the server group to remove from
-        # * options (Array) - An Array of Hashes containing {"server" => server_id} for each server to remove
-        #   [\[{"server" => "srv-abcde"}, {"server" => "srv-fghij"}\]]
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
         #
-        # == Returns:
+        # @see https://api.gb1.brightbox.com/1.0/#server_group_remove_servers_server_group
         #
-        # A Ruby hash of the server response
+        # @example
+        #    Compute[:brightbox].remove_servers_server_group "grp-12345", :servers => [{"server" => "srv-abcde"}, {"server" => "srv-fghij"}]
         #
         def remove_servers_server_group(identifier, options)
           return nil if identifier.nil? || identifier == ""
@@ -24,4 +23,4 @@ module Fog
       end
     end
   end
-end
+end

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
+            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
+          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,6 +3,18 @@ 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])
@@ -11,4 +23,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ 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])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ 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])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ 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])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ 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])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ 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])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ 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])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end