fog 1.7.0 → 1.8.0

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

@@ -4,9 +4,7 @@ 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])

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -2,13 +2,9 @@ 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])
         end

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

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

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

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

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

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

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

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

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

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

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

@@ -2,7 +2,11 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#account_list_accounts
+        #
         def list_accounts
           request("get", "/1.0/accounts", [200])
         end
@@ -10,4 +14,4 @@ module Fog
       end
     end
   end
-end
+end

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

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

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

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

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

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

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

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

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

@@ -2,7 +2,13 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Lists summary details of images available for use by the Account. It includes those available to all customers
+        #
+        #
+        # @return [Hash] The JSON response parsed to a Hash
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#image_list_images
+        #
         def list_images
           request("get", "/1.0/images", [200])
         end
@@ -10,4 +16,4 @@ module Fog
       end
     end
   end
-end
+end

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

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

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

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