fog-brightbox 0.9.0 → 0.10.0

data/.travis.yml

@@ -4,8 +4,9 @@ rvm:
   - 2.2.0
   - 2.1.5
   - 2.0.0
-  - 1.9.3
 matrix:
   include:
     - rvm: 1.8.7
       gemfile: gemfiles/Gemfile.1.8.7
+    - rvm: 1.9.3
+      gemfile: gemfiles/Gemfile.1.9.3

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 0.10.0 / 2015-11-30
+
+Changes:
+
+* Updated auto-generated documentation for requests
+* Added `options` to all requests. Select options are passed through to the API
+  to alter behaviour for all requests.
+* Allow requests to use `nested=false` option to collapse nested (or children)
+  resources from the JSON which is faster to render and less content.
+* Make `list_accounts` default to `nested=false` because it is very slow for
+  large accounts and the nested resources are rarely used.
+
 ### 0.9.0 / 2015-08-18
 
 Changes:

data/gemfiles/Gemfile.1.8.7

@@ -1,6 +1,7 @@
 source "https://rubygems.org"
 
 gem "fog-core", :github => "fog/fog-core"
+gem "json"
 gem "mime-types", "~> 1.22"
 gem "inflecto", "~> 0.0.2"
 

data/gemfiles/Gemfile.1.9.3

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "net-ssh", "< 3.0"
+
+gemspec :path => ".."

data/lib/fog/brightbox/compute.rb

@@ -282,9 +282,13 @@ module Fog
             :expects  => expected_responses
           }
 
+          query = {}
+
           # Select the account to scope for this request
           account = scoped_account(parameters.fetch(:account_id, nil))
-          request_options[:query] = { :account_id => account } if account
+          query.merge!(:account_id => account) if account
+          query.merge!(:nested => parameters[:nested]) if parameters.key?(:nested)
+          request_options[:query] = query unless query.empty?
 
           request_options[:body] = Fog::JSON.encode(parameters) unless parameters.empty?
 

data/lib/fog/brightbox/models/compute/accounts.rb

@@ -6,8 +6,8 @@ module Fog
       class Accounts < Fog::Collection
         model Fog::Compute::Brightbox::Account
 
-        def all
-          data = service.list_accounts
+        def all(options = {})
+          data = service.list_accounts(options)
           load(data)
         end
 

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

@@ -5,14 +5,16 @@ module Fog
         # Accepts the collaboration giving access to the account
         #
         # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         #
         # @see https://api.gb1.brightbox.com/1.0/#user_collaboration_accept_user_collaboration
         #
-        def accept_user_collaboration(identifier)
+        def accept_user_collaboration(identifier, options = {})
           return nil if identifier.nil? || identifier == ""
-          wrapped_request("post", "/1.0/user/collaborations/#{identifier}/accept", [200])
+          wrapped_request("post", "/1.0/user/collaborations/#{identifier}/accept", [200], options)
         end
       end
     end

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

@@ -5,14 +5,16 @@ module Fog
         # Enable console access via VNC to the server for 15 minutes.
         #
         # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         #
         # @see https://api.gb1.brightbox.com/1.0/#server_activate_console_server
         #
-        def activate_console_server(identifier)
+        def activate_console_server(identifier, options = {})
           return nil if identifier.nil? || identifier == ""
-          wrapped_request("post", "/1.0/servers/#{identifier}/activate_console", [202])
+          wrapped_request("post", "/1.0/servers/#{identifier}/activate_console", [202], options)
         end
       end
     end

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

@@ -7,6 +7,7 @@ module Fog
         # @param [String] identifier Unique reference to identify the resource
         # @param [Hash] options
         # @option options [Array] :listeners Array of Listener parameters. Timeout is optional and specified in milliseconds.
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -7,6 +7,7 @@ module Fog
         # @param [String] identifier Unique reference to identify the resource
         # @param [Hash] options
         # @option options [Array] :nodes Array of Node parameters
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -8,6 +8,7 @@ module Fog
         # @param [Hash] options
         # @option options [Array<Hash>] :servers Array of Hashes containing
         #   +{"server" => server_id}+ for each server to add
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -7,6 +7,7 @@ module Fog
         # @param [String] identifier Unique reference to identify the resource
         # @param [Hash] options
         # @option options [String] :server_group Server Group to apply to
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -7,6 +7,7 @@ module Fog
         # @param [Hash] options
         # @option options [String] :name
         # @option options [String] :description
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -7,6 +7,7 @@ module Fog
         # @param [Hash] options
         # @option options [String] :name
         # @option options [String] :description
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -8,6 +8,7 @@ module Fog
         # @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.
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -9,6 +9,7 @@ module Fog
         # @param [Hash] options
         # @option options [String] :email Email address of user to invite
         # @option options [String] :role Role to grant to the user. Currently only `admin`
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -10,6 +10,7 @@ module Fog
         # @option options [Array] :allow_access ...
         # @option options [String] :snapshot
         # @option options [String] :zone
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -10,6 +10,7 @@ module Fog
         # @option options [String] :server_group
         # @option options [String] :name Editable label
         # @option options [String] :description Longer editable description
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -13,6 +13,7 @@ module Fog
         # @option options [String] :destination_port
         # @option options [String] :icmp_type_name
         # @option options [String] :description
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -7,13 +7,14 @@ module Fog
         # 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] :source Filename of the image uploaded to /images within Orbit. Can consist of letters, numbers or '-_+.~^'
         # @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
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -6,13 +6,15 @@ module Fog
         #
         # @param [Hash] options
         # @option options [String] :name Editable label
-        # @option options [Integer] :buffer_size Buffer size of load balancer. Default is 4096.
         # @option options [Array] :nodes Array of Node parameters
         # @option options [String] :policy Method of Load balancing to use
         # @option options [String] :certificate_pem A X509 SSL certificate in PEM format. Must be included along with 'certificate_key'. If intermediate certificates are required they should be concatenated after the main certificate
         # @option options [String] :certificate_key The RSA private key used to sign the certificate in PEM format. Must be included along with 'certificate_pem'
+        # @option options [Boolean] :sslv3 Allow SSL v3 to be used (default: false)
         # @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
+        # @option options [String] :buffer_size Buffer size in bytes
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -13,6 +13,7 @@ module Fog
         # @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
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -7,6 +7,7 @@ module Fog
         # @param [Hash] options
         # @option options [String] :name Editable user label
         # @option options [String] :description Editable user description
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         # @return [NilClass] if no options were passed

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

@@ -5,14 +5,16 @@ module Fog
         # Destroy the API client.
         #
         # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         #
         # @see https://api.gb1.brightbox.com/1.0/#api_client_delete_api_client
         #
-        def delete_api_client(identifier)
+        def delete_api_client(identifier, options = {})
           return nil if identifier.nil? || identifier == ""
-          wrapped_request("delete", "/1.0/api_clients/#{identifier}", [200])
+          wrapped_request("delete", "/1.0/api_clients/#{identifier}", [200], options)
         end
 
         # Old format of the delete request.

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

@@ -5,14 +5,16 @@ module Fog
         # Destroy the application.
         #
         # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         #
         # @see https://api.gb1.brightbox.com/1.0/#application_delete_application
         #
-        def delete_application(identifier)
+        def delete_application(identifier, options = {})
           return nil if identifier.nil? || identifier == ""
-          wrapped_request("delete", "/1.0/applications/#{identifier}", [200])
+          wrapped_request("delete", "/1.0/applications/#{identifier}", [200], options)
         end
 
         # Old format of the delete request.

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

@@ -5,14 +5,16 @@ module Fog
         # Release the cloud IP address from the account's ownership.
         #
         # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         #
         # @see https://api.gb1.brightbox.com/1.0/#cloud_ip_delete_cloud_ip
         #
-        def delete_cloud_ip(identifier)
+        def delete_cloud_ip(identifier, options = {})
           return nil if identifier.nil? || identifier == ""
-          wrapped_request("delete", "/1.0/cloud_ips/#{identifier}", [200])
+          wrapped_request("delete", "/1.0/cloud_ips/#{identifier}", [200], options)
         end
 
         # Old format of the delete request.

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

@@ -5,14 +5,16 @@ module Fog
         # Cancels or completes the collaboration
         #
         # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         #
         # @see https://api.gb1.brightbox.com/1.0/#collaboration_delete_collaboration
         #
-        def delete_collaboration(identifier)
+        def delete_collaboration(identifier, options = {})
           return nil if identifier.nil? || identifier == ""
-          wrapped_request("delete", "/1.0/collaborations/#{identifier}", [200])
+          wrapped_request("delete", "/1.0/collaborations/#{identifier}", [200], options)
         end
 
         # Old format of the delete request.

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

@@ -3,14 +3,16 @@ module Fog
     class Brightbox
       class Real
         # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         #
         # @see https://api.gb1.brightbox.com/1.0/#database_server_delete_database_server
         #
-        def delete_database_server(identifier)
+        def delete_database_server(identifier, options = {})
           return nil if identifier.nil? || identifier == ""
-          wrapped_request("delete", "/1.0/database_servers/#{identifier}", [202])
+          wrapped_request("delete", "/1.0/database_servers/#{identifier}", [202], options)
         end
 
         # Old format of the delete request.

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

@@ -3,14 +3,16 @@ module Fog
     class Brightbox
       class Real
         # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         #
         # @see https://api.gb1.brightbox.com/1.0/#database_snapshot_delete_database_snapshot
         #
-        def delete_database_snapshot(identifier)
+        def delete_database_snapshot(identifier, options = {})
           return nil if identifier.nil? || identifier == ""
-          wrapped_request("delete", "/1.0/database_snapshots/#{identifier}", [202])
+          wrapped_request("delete", "/1.0/database_snapshots/#{identifier}", [202], options)
         end
 
         # Old format of the delete request.

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

@@ -5,14 +5,16 @@ module Fog
         # Destroy the firewall policy if not in use.
         #
         # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         #
         # @see https://api.gb1.brightbox.com/1.0/#firewall_policy_delete_firewall_policy
         #
-        def delete_firewall_policy(identifier)
+        def delete_firewall_policy(identifier, options = {})
           return nil if identifier.nil? || identifier == ""
-          wrapped_request("delete", "/1.0/firewall_policies/#{identifier}", [202])
+          wrapped_request("delete", "/1.0/firewall_policies/#{identifier}", [202], options)
         end
 
         # Old format of the delete request.

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

@@ -5,14 +5,16 @@ module Fog
         # Destroy the firewall rule.
         #
         # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         #
         # @see https://api.gb1.brightbox.com/1.0/#firewall_rule_delete_firewall_rule
         #
-        def delete_firewall_rule(identifier)
+        def delete_firewall_rule(identifier, options = {})
           return nil if identifier.nil? || identifier == ""
-          wrapped_request("delete", "/1.0/firewall_rules/#{identifier}", [202])
+          wrapped_request("delete", "/1.0/firewall_rules/#{identifier}", [202], options)
         end
 
         # Old format of the delete request.

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

@@ -5,14 +5,16 @@ module Fog
         # Destroy the image.
         #
         # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
         #
         # @return [Hash] if successful Hash version of JSON object
         #
         # @see https://api.gb1.brightbox.com/1.0/#image_delete_image
         #
-        def delete_image(identifier)
+        def delete_image(identifier, options = {})
           return nil if identifier.nil? || identifier == ""
-          wrapped_request("delete", "/1.0/images/#{identifier}", [202])
+          wrapped_request("delete", "/1.0/images/#{identifier}", [202], options)
         end
 
         # Old format of the delete request.