fog 1.7.0 → 1.8.0

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

@@ -2,7 +2,18 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Create a new firewall policy for the account.
+        #
+        # Optionally applying to a server group at creation time.
+        #
+        # @param [Hash] options
+        # @option options [String] :server_group
+        # @option options [String] :name Editable label
+        #
+        # @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_create_firewall_policy
+        #
         def create_firewall_policy(options)
           request("post", "/1.0/firewall_policies", [201], options)
         end
@@ -10,4 +21,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,22 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Create a new firewall rule for a firewall policy.
+        #
+        # @param [Hash] options
+        # @option options [String] :firewall_policy
+        # @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_create_firewall_rule
+        #
         def create_firewall_rule(options)
           request("post", "/1.0/firewall_rules", [202], options)
         end
@@ -10,4 +25,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,23 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Create a new image for the account by registering it against an image stored within the Brightbox cloud image library.
+        #
+        # The disk image must be in place before you can attempt to create a reference in the API.
+        #
+        # @param [Hash] options
+        # @option options [String] :source Filename of the image file uploaded to /incoming via FTP
+        # @option options [String] :arch OS architecture this image is built for
+        # @option options [String] :name Name for this image. If no name is specified, a name will be autogenerated based on the source filename & current time. Can be modified later.
+        # @option options [String] :username Username for the image
+        # @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_create_image
+        #
         def create_image(options)
           request("post", "/1.0/images", [201], options)
         end
@@ -10,4 +26,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,19 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Create a new load balancer for the account.
+        #
+        # @param [Hash] options
+        # @option options [String] :name Editable label
+        # @option options [Array] :nodes Array of Node parameters
+        # @option options [String] :policy Method of Load balancing to use
+        # @option options [Array] :listeners What port to listen on, port to pass through to and protocol (tcp, http or http+ws) of listener. Timeout is optional and specified in milliseconds (default is 50000).
+        # @option options [String] :healthcheck Healthcheck options - only "port" and "type" required
+        #
+        # @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_create_load_balancer
+        #
         def create_load_balancer(options)
           request("post", "/1.0/load_balancers", [202], options)
         end
@@ -10,4 +22,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,22 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Create a new server for the account based on the required disk image.
+        #
+        # Optionally can setup the type of server, zone to locate it, groups to join and custom metadata.
+        #
+        # @param [Hash] options
+        # @option options [String] :image
+        # @option options [String] :name Editable label
+        # @option options [String] :server_type
+        # @option options [String] :zone Zone in which to create new Server
+        # @option options [String] :user_data
+        # @option options [Array] :server_groups Array of server groups to add server to
+        #
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#server_create_server
+        #
         def create_server(options)
           request("post", "/1.0/servers", [202], options)
         end
@@ -10,4 +25,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,16 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Create a new server group for the account.
+        #
+        # @param [Hash] options
+        # @option options [String] :name Editable user label
+        # @option options [String] :description Editable user 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/#server_group_create_server_group
+        #
         def create_server_group(options)
           request("post", "/1.0/server_groups", [202], options)
         end
@@ -10,4 +19,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Destroy 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_destroy_api_client
+        #
         def destroy_api_client(identifier)
           return nil if identifier.nil? || identifier == ""
           request("delete", "/1.0/api_clients/#{identifier}", [200])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Destroy 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_destroy_application
+        #
         def destroy_application(identifier)
           return nil if identifier.nil? || identifier == ""
           request("delete", "/1.0/applications/#{identifier}", [200])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Release the cloud IP address from the account's ownership.
+        #
+        # @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_destroy_cloud_ip
+        #
         def destroy_cloud_ip(identifier)
           return nil if identifier.nil? || identifier == ""
           request("delete", "/1.0/cloud_ips/#{identifier}", [200])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Destroy the firewall policy 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/#firewall_policy_destroy_firewall_policy
+        #
         def destroy_firewall_policy(identifier)
           return nil if identifier.nil? || identifier == ""
           request("delete", "/1.0/firewall_policies/#{identifier}", [202])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Destroy 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_destroy_firewall_rule
+        #
         def destroy_firewall_rule(identifier)
           return nil if identifier.nil? || identifier == ""
           request("delete", "/1.0/firewall_rules/#{identifier}", [202])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Destroy 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_destroy_image
+        #
         def destroy_image(identifier)
           return nil if identifier.nil? || identifier == ""
           request("delete", "/1.0/images/#{identifier}", [202])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,14 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Destroy the LoadBalancer
+        #
+        # @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_destroy_load_balancer
+        #
         def destroy_load_balancer(identifier)
           return nil if identifier.nil? || identifier == ""
           request("delete", "/1.0/load_balancers/#{identifier}", [202])
@@ -11,4 +18,4 @@ module Fog
       end
     end
   end
-end
+end

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

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

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

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

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

@@ -2,25 +2,17 @@ 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?

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

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

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

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