fog 1.7.0 → 1.8.0

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

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

@@ -2,7 +2,17 @@ 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?
@@ -12,4 +22,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,17 @@ 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?
@@ -12,4 +22,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,18 @@ 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?
@@ -12,4 +23,4 @@ module Fog
       end
     end
   end
-end
+end

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

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

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

@@ -2,7 +2,22 @@ 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?
@@ -12,4 +27,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Update some details of the load balancer.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @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_update_load_balancer
+        #
         def update_load_balancer(identifier, options)
           return nil if identifier.nil? || identifier == ""
           return nil if options.empty? || options.nil?
@@ -12,4 +25,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,29 +2,22 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
         # Requests an update to the currently scoped account
         #
-        # === Parameters:
-        #
-        # <tt>options</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 ’+’
+        # @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 `+`
         #
-        # === Returns:
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
         #
-        # <tt>Hash</tt>:: The JSON response parsed to a Hash
-        # <tt>nil</tt>:: If no options were passed to update
+        # @see https://api.gb1.brightbox.com/1.0/#account_update_account
         #
         def update_scoped_account(options)
           return nil if options.empty? || options.nil?

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

@@ -2,7 +2,17 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Update some details of the server.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [String] :name Editable label
+        # @option options [String] :user_data User defined metadata
+        #
+        # @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_update_server
+        #
         def update_server(identifier, options)
           return nil if identifier.nil? || identifier == ""
           return nil if options.empty? || options.nil?
@@ -12,4 +22,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,17 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Update some details of the server group.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @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_update_server_group
+        #
         def update_server_group(identifier, options)
           return nil if identifier.nil? || identifier == ""
           return nil if options.empty? || options.nil?
@@ -12,4 +22,4 @@ module Fog
       end
     end
   end
-end
+end

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

@@ -2,7 +2,20 @@ module Fog
   module Compute
     class Brightbox
       class Real
-
+        # Update some details of your user profile.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [String] :name
+        # @option options [String] :email_address
+        # @option options [String] :ssh_key
+        # @option options [String] :password A password string that conforms to the minimum requirements
+        # @option options [String] :password_confirmation A password string that conforms to the minimum requirements
+        #
+        # @return [Hash, nil] The JSON response parsed to a Hash or nil if no options passed
+        #
+        # @see https://api.gb1.brightbox.com/1.0/#user_update_user
+        #
         def update_user(identifier, options)
           return nil if identifier.nil? || identifier == ""
           return nil if options.empty? || options.nil?
@@ -12,4 +25,4 @@ module Fog
       end
     end
   end
-end
+end

data/lib/fog/cloudstack/models/compute/server.rb

@@ -33,6 +33,7 @@ module Fog
         attribute :guest_os_id,                             :aliases => 'guestosid'
         attribute :root_device_id,                          :aliases => 'rootdeviceid'
         attribute :root_device_type,                        :aliases => 'rootdevicetype'
+        attribute :group
         attribute :security_group_list,    :type => :array, :aliases => 'securitygroup'
         attribute :nics,                   :type => :array, :aliases => 'nic'
 
@@ -85,6 +86,7 @@ module Fog
             'networkids'        => network_ids,
             'diskofferingid'    => disk_offering_id,
             'displayname'       => display_name,
+            'group'             => group,
             'domainid'          => domain_id,
             'hostid'            => host_id,
             'ipaddress'         => ip_address,
@@ -93,7 +95,7 @@ module Fog
           }
 
           options.merge!('networkids' => network_ids) if network_ids
-          options.merge!('securitygroupids' => security_group_ids) if security_group_ids
+          options.merge!('securitygroupids' => security_group_ids) unless security_group_ids.empty?
 
           data = connection.deploy_virtual_machine(options)
           merge_attributes(data['deployvirtualmachineresponse'])

data/lib/fog/core.rb

@@ -15,6 +15,7 @@ require 'time'
 require 'timeout'
 
 # internal core dependencies
+require "fog/version"
 require 'fog/core/attributes'
 require 'fog/core/collection'
 require 'fog/core/connection'

data/lib/fog/core/connection.rb

@@ -2,6 +2,7 @@ module Fog
   class Connection
 
     def initialize(url, persistent=false, params={})
+      Excon.defaults[:headers]['User-Agent'] ||= "fog/#{Fog::VERSION}"
       @excon = Excon.new(url, params)
       @persistent = persistent
     end

data/lib/fog/google/storage.rb

@@ -225,8 +225,19 @@ DATA
           string_to_sign << "#{canonical_google_headers}"
 
           subdomain = params[:host].split(".#{@host}").first
-          unless subdomain =~ /^(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}$))(?:[a-z0-9]|\.(?![\.\-])|\-(?![\.])){1,61}[a-z0-9]$/
-            Fog::Logger.warning("fog: the specified google storage bucket name(#{subdomain}) is not a valid dns name.  See: http://code.google.com/apis/storage/docs/developer-guide.html#naming")
+          unless subdomain =~ /^(?!goog)(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}$))(?:[a-z0-9]|\.(?![\.\-])|\-(?![\.])){1,61}[a-z0-9]$/
+            if subdomain =~ /_/
+              # https://github.com/fog/fog/pull/1258#issuecomment-10248620.
+              Fog::Logger.warning("fog: the specified google storage bucket name (#{subdomain}) is not DNS compliant (only characters a through z, digits 0 through 9, and the hyphen).")
+            else
+              # - Bucket names must contain only lowercase letters, numbers, dashes (-), underscores (_), and dots (.). Names containing dots require verification.
+              # - Bucket names must start and end with a number or letter.
+              # - Bucket names must contain 3 to 63 characters. Names containing dots can contain up to 222 characters, but each dot-separated component can be no longer than 63 characters.
+              # - Bucket names cannot be represented as an IP address in dotted-decimal notation (for example, 192.168.5.4).
+              # - Bucket names cannot begin with the "goog" prefix.
+              # - Also, for DNS compliance, you should not have a period adjacent to another period or dash. For example, ".." or "-." or ".-" are not acceptable.
+              Fog::Logger.warning("fog: the specified google storage bucket name (#{subdomain}) is not a valid dns name.  See: https://developers.google.com/storage/docs/bucketnaming")
+            end
             params[:host] = params[:host].split("#{subdomain}.")[-1]
             if params[:path]
               params[:path] = "#{subdomain}/#{params[:path]}"

data/lib/fog/libvirt/models/compute/server.rb

@@ -335,6 +335,7 @@ module Fog
             end
           else
             # If no template volume was given, let's create our own volume
+            options[:pool_name]   = volume_pool_name   if volume_pool_name
             options[:format_type] = volume_format_type if volume_format_type
             options[:capacity]    = volume_capacity    if volume_capacity
             options[:allocation]  = volume_allocation  if volume_allocation

data/lib/fog/libvirt/requests/compute/list_domains.rb

@@ -58,7 +58,7 @@ module Fog
             :max_memory_size => dom.info.max_mem,
             :cputime         => dom.info.cpu_time,
             :memory_size     => dom.info.memory,
-            :vcpus           => dom.info.nr_virt_cpu,
+            :cpus            => dom.info.nr_virt_cpu,
             :autostart       => dom.autostart?,
             :os_type         => dom.os_type,
             :active          => dom.active?,
@@ -89,7 +89,7 @@ module Fog
               :max_memory_size => 8,
               :cputime         => 7,
               :memory_size     => 6,
-              :vcpus           => 5,
+              :cpus            => 5,
               :autostart       => false,
               :os_type         => "RHEL6",
               :active          => false,

data/lib/fog/openstack.rb

@@ -72,48 +72,27 @@ module Fog
 
     # Keystone Style Auth
     def self.authenticate_v2(options, connection_options = {})
-      uri = options[:openstack_auth_uri]
-      connection = Fog::Connection.new(uri.to_s, false, connection_options)
-      @openstack_api_key  = options[:openstack_api_key]
-      @openstack_username = options[:openstack_username]
-      @openstack_tenant   = options[:openstack_tenant]
-      @openstack_auth_token = options[:openstack_auth_token]
-      @service_name         = options[:openstack_service_name]
-      @identity_service_name = options[:openstack_identity_service_name]
-      @endpoint_type         = options[:openstack_endpoint_type] || 'publicURL'
-      @openstack_region      = options[:openstack_region]
-
-      if @openstack_auth_token
-        req_body = {
-          'auth' => {
-            'token' => {
-              'id' => @openstack_auth_token
-            }
-          }
-        }
-      else
-        req_body = {
-          'auth' => {
-            'passwordCredentials'  => {
-              'username' => @openstack_username.to_s,
-              'password' => @openstack_api_key.to_s
-            }
-          }
-        }
-      end
-      req_body['auth']['tenantName'] = @openstack_tenant if @openstack_tenant
+      uri                   = options[:openstack_auth_uri]
+      tenant_name           = options[:openstack_tenant]
+      service_name          = options[:openstack_service_name]
+      identity_service_name = options[:openstack_identity_service_name]
+      endpoint_type         = (options[:openstack_endpoint_type] || 'publicURL').to_s
+      openstack_region      = options[:openstack_region]
 
-      body = retrieve_tokens_v2(connection, req_body, uri)
 
-      svc = body['access']['serviceCatalog'].
-        detect{|x| @service_name.include?(x['type']) }
+      body = retrieve_tokens_v2(options, connection_options)
+      service = body['access']['serviceCatalog'].
+        detect {|s| service_name.include?(s['type']) }
 
-      unless svc
-        unless @openstack_tenant
+      options[:unscoped_token] = body['access']['token']['id']
+
+      unless service
+        unless tenant_name
           response = Fog::Connection.new(
             "#{uri.scheme}://#{uri.host}:#{uri.port}/v2.0/tenants", false, connection_options).request({
             :expects => [200, 204],
             :headers => {'Content-Type' => 'application/json',
+                         'Accept' => 'application/json',
                          'X-Auth-Token' => body['access']['token']['id']},
             :host    => uri.host,
             :method  => 'GET'
@@ -123,53 +102,73 @@ module Fog
           if body['tenants'].empty?
             raise Errors::NotFound.new('No Tenant Found')
           else
-            req_body['auth']['tenantName'] = body['tenants'].first['name']
+            options[:openstack_tenant] = body['tenants'].first['name']
           end
         end
 
-        body = retrieve_tokens_v2(connection, req_body, uri)
-        if body['access']['token']['tenant'].nil?
-          raise Errors::NotFound.new("Invalid Tenant '#{@openstack_tenant}'")
-        end
-        svc = body['access']['serviceCatalog'].
-          detect{|x| @service_name.include?(x['type']) }
+        body = retrieve_tokens_v2(options, connection_options)
+        service = body['access']['serviceCatalog'].
+          detect{|s| service_name.include?(s['type']) }
       end
 
-      svc['endpoints'] = svc['endpoints'].select{ |x| x['region'] == @openstack_region } if @openstack_region
-      if svc['endpoints'].count > 1
-         regions = svc["endpoints"].map { |x| x['region'] }.uniq.join(',')
-         raise Errors::NotFound.new("Multiple regions available choose one of these '#{regions}'")
+      service['endpoints'] = service['endpoints'].select do |endpoint|
+        endpoint['region'] == openstack_region
+      end if openstack_region
+
+      if service['endpoints'].count > 1
+        regions = service["endpoints"].map{ |e| e['region'] }.uniq.join(',')
+        raise Errors::NotFound.new("Multiple regions available choose one of these '#{regions}'")
       end
 
-      identity_svc = body['access']['serviceCatalog'].
-        detect{|x| @identity_service_name.include?(x['type']) } if @identity_service_name
+      identity_service = body['access']['serviceCatalog'].
+        detect{|x| identity_service_name.include?(x['type']) } if identity_service_name
       tenant = body['access']['token']['tenant']
       user = body['access']['user']
 
-      mgmt_url = svc['endpoints'].detect{|x| x[@endpoint_type]}[@endpoint_type]
-      identity_url = identity_svc['endpoints'].detect{|x| x['publicURL']}['publicURL'] if identity_svc
-      token = body['access']['token']['id']
-      expires = body['access']['token']['expires']
+      management_url = service['endpoints'].detect{|s| s[endpoint_type]}[endpoint_type]
+      identity_url   = identity_service['endpoints'].detect{|s| s['publicURL']}['publicURL'] if identity_service
 
       {
         :user                     => user,
         :tenant                   => tenant,
-        :token                    => token,
-        :expires                  => expires,
-        :server_management_url    => mgmt_url,
         :identity_public_endpoint => identity_url,
-        :current_user_id          => body['access']['user']['id']
+        :server_management_url    => management_url,
+        :token                    => body['access']['token']['id'],
+        :expires                  => body['access']['token']['expires'],
+        :current_user_id          => body['access']['user']['id'],
+        :unscoped_token           => options[:unscoped_token]
       }
     end
 
-    def self.retrieve_tokens_v2(connection, request_body, uri)
+    def self.retrieve_tokens_v2(options, connection_options = {})
+      api_key     = options[:openstack_api_key].to_s
+      username    = options[:openstack_username].to_s
+      tenant_name = options[:openstack_tenant].to_s
+      auth_token  = options[:openstack_auth_token] || options[:unscoped_token]
+      uri         = options[:openstack_auth_uri]
+
+      connection = Fog::Connection.new(uri.to_s, false, connection_options)
+      request_body = {:auth => Hash.new}
+
+      if auth_token
+        request_body[:auth][:token] = {
+          :id => auth_token
+        }
+      else
+        request_body[:auth][:passwordCredentials] = {
+          :username => username,
+          :password => api_key
+        }
+      end
+      request_body[:auth][:tenantName] = tenant_name if tenant_name
+
       response = connection.request({
         :expects  => [200, 204],
         :headers  => {'Content-Type' => 'application/json'},
         :body     => Fog::JSON.encode(request_body),
         :host     => uri.host,
         :method   => 'POST',
-        :path     =>  (uri.path and not uri.path.empty?) ? uri.path : 'v2.0'
+        :path     => (uri.path and not uri.path.empty?) ? uri.path : 'v2.0'
       })
 
       Fog::JSON.decode(response.body)