fog-core 2.1.2 → 2.5.0

data/lib/fog/core/mock.rb

@@ -25,6 +25,7 @@ module Fog
 
     def self.delay=(new_delay)
       raise ArgumentError, "delay must be non-negative" unless new_delay >= 0
+
       @delay = new_delay
     end
 
@@ -32,7 +33,7 @@ module Fog
       raise Fog::Errors::MockNotImplemented, message
     end
 
-    def self.random_ip(opts = { :version => :v4 })
+    def self.random_ip(opts = { version: :v4 })
       version = opts[:version]
       if version == :v6
         bit_length = 128
@@ -80,7 +81,7 @@ module Fog
     end
 
     def self.random_selection(characters, length)
-      selection = ""
+      selection = +""
       length.times do
         position = rand(characters.length)
         selection << characters[position..position]
@@ -92,12 +93,15 @@ module Fog
       mocked_services = []
       Fog.constants.map do |x|
         next if Fog.autoload?(x)
+
         x_const = Fog.const_get(x)
         x_const.respond_to?(:constants) && x_const.constants.map do |y|
           next if x_const.autoload?(y)
+
           y_const = x_const.const_get(y)
           y_const.respond_to?(:constants) && y_const.constants.map do |z|
             next if y_const.autoload?(z)
+
             mocked_services << y_const.const_get(z) if z.to_sym == :Mock
           end
         end
@@ -105,6 +109,7 @@ module Fog
 
       mocked_services.each do |mocked_service|
         next unless mocked_service.respond_to?(:reset)
+
         mocked_service.reset
       end
     end

data/lib/fog/core/model.rb

@@ -21,6 +21,33 @@ module Fog
       merge_attributes(attribs)
     end
 
+    # Creates new or updates existing model
+    # @return [self]
+    def save
+      persisted? ? update : create
+    end
+
+    # Creates new entity from model
+    # @raise [Fog::Errors::NotImplemented] you must implement #create method in child class and return self
+    # @return [self]
+    def create
+      raise Fog::Errors::NotImplemented, "Implement method #create for #{self.class}. Method must return self"
+    end
+
+    # Updates new entity with model
+    # @raise [Fog::Errors::NotImplemented] you must implement #update method in child class and return self
+    # @return [self]
+    def update
+      raise Fog::Errors::NotImplemented, "Implement method #update for #{self.class}. Method must return self"
+    end
+
+    # Destroys entity by model identity
+    # @raise [Fog::Errors::NotImplemented] you must implement #destroy method in child class and return self
+    # @return [self]
+    def destroy
+      raise Fog::Errors::NotImplemented, "Implement method #destroy for #{self.class}. Method must return self"
+    end
+
     def cache
       Fog::Cache.new(self)
     end
@@ -41,6 +68,8 @@ module Fog
       end
     end
 
+    # @return [self] if model successfully reloaded
+    # @return [nil] if something went wrong or model was not found
     def reload
       requires :identity
 
@@ -61,6 +90,7 @@ module Fog
 
     def symbolize_keys(hash)
       return nil if hash.nil?
+
       hash.reduce({}) do |options, (key, value)|
         options[(key.to_sym rescue key) || key] = value
         options
@@ -69,6 +99,7 @@ module Fog
 
     def wait_for(timeout = Fog.timeout, interval = Fog.interval, &block)
       reload_has_succeeded = false
+
       duration = Fog.wait_for(timeout, interval) do # Note that duration = false if it times out
         if reload
           reload_has_succeeded = true
@@ -77,11 +108,9 @@ module Fog
           false
         end
       end
-      if reload_has_succeeded
-        return duration # false if timeout; otherwise {:duration => elapsed time }
-      else
-        raise Fog::Errors::Error, "Reload failed, #{self.class} #{identity} not present."
-      end
+      raise Fog::Errors::Error, "Reload failed, #{self.class} #{identity} not present." unless reload_has_succeeded
+
+      duration # false if timeout; otherwise {:duration => elapsed time }
     end
   end
 end

data/lib/fog/core/provider.rb

@@ -8,9 +8,22 @@ module Fog
   end
 
   module Provider
-    def self.extended(base)
-      provider = base.to_s.split("::").last
-      Fog.providers[provider.downcase.to_sym] = provider
+    class << self
+      def extended(base)
+        provider = base.to_s.split("::").last
+        Fog.providers[provider.downcase.to_sym] = provider
+        Fog.providers[underscore_name(provider).to_sym] = provider
+      end
+    
+      private
+
+      def underscore_name(string)
+        string.gsub("::", "/")
+              .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+              .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+              .tr("-", "_")
+              .downcase
+      end
     end
 
     def [](service_key)
@@ -28,14 +41,24 @@ module Fog
       @services_registry.keys
     end
 
+    # Returns service constant path, with provider, as string. If
+    # "provider::service" is defined (the preferred format) then it returns that
+    # string, otherwise it returns the deprecated string "service::provider".
     def service_klass(constant_string)
-      eval([to_s, constant_string].join("::"))
-      [to_s, constant_string].join("::")
-    rescue NameError
-      provider = to_s.split("::").last
-      Fog::Logger.deprecation("Unable to load #{[to_s, constant_string].join("::")}")
-      Fog::Logger.deprecation("The format #{['Fog', constant_string, provider].join("::")} is deprecated")
-      ['Fog', constant_string, provider].join("::")
+      if const_defined?([to_s, constant_string].join("::"))
+        [to_s, constant_string].join("::")
+      else
+        provider = to_s.split("::").last
+        Fog::Logger.deprecation("Unable to load #{[to_s, constant_string].join('::')}")
+        Fog::Logger.deprecation(
+          format(
+            Fog::ServicesMixin::E_SERVICE_PROVIDER_CONSTANT,
+            service: constant_string,
+            provider: provider
+          )
+        )
+        ["Fog", constant_string, provider].join("::")
+      end
     end
   end
 end

data/lib/fog/core/scp.rb

@@ -22,19 +22,23 @@ module Fog
       end
 
       def upload(local_path, remote_path, upload_options = {})
-        self.class.data[@address] << { :username       => @username,
-                                       :options        => @options,
-                                       :local_path     => local_path,
-                                       :remote_path    => remote_path,
-                                       :upload_options => upload_options }
+        self.class.data[@address] << {
+          username: @username,
+          options: @options,
+          local_path: local_path,
+          remote_path: remote_path,
+          upload_options: upload_options
+        }
       end
 
       def download(remote_path, local_path, download_options = {})
-        self.class.data[@address] << { :username         => @username,
-                                       :options          => @options,
-                                       :remote_path      => remote_path,
-                                       :local_path       => local_path,
-                                       :download_options => download_options }
+        self.class.data[@address] << {
+          username: @username,
+          options: @options,
+          remote_path: remote_path,
+          local_path: local_path,
+          download_options: download_options
+        }
       end
     end
 
@@ -64,8 +68,9 @@ module Fog
 
         @address  = address
         @username = username
-        @options  = { :paranoid => false, :verify_host_key => false }.merge(options)
+        @options  = { paranoid: false, verify_host_key: :never }.merge(options)
         @options.delete(:paranoid) if Net::SSH::VALID_OPTIONS.include? :verify_host_key
+        @options[:verify_host_key] = false unless Net::SSH::Verifiers.const_defined?(:Never)
       end
 
       def upload(local_path, remote_path, upload_options = {}, &block)

data/lib/fog/core/service.rb

@@ -11,7 +11,7 @@ module Fog
 
     module NoLeakInspector
       def inspect
-        "#<#{self.class}:#{object_id} #{(instance_variables - service.secrets).map { |iv| [iv, instance_variable_get(iv).inspect].join("=") }.join(" ")}>"
+        "#<#{self.class}:#{object_id} #{(instance_variables - service.secrets).map { |iv| [iv, instance_variable_get(iv).inspect].join('=') }.join(' ')}>"
       end
     end
 
@@ -119,7 +119,7 @@ module Fog
       # @deprecated
       def fetch_credentials(_options)
         # attempt to load credentials from config file
-        Fog.credentials.reject { |key, _value| !(recognized | requirements).include?(key) }
+        Fog.credentials.select { |key, _value| (recognized | requirements).include?(key) }
       rescue ::Fog::Errors::LoadError
         # if there are no configured credentials, do nothing
         {}
@@ -212,7 +212,7 @@ module Fog
           @secrets ||= []
         else
           args.reduce(secrets) do |secrets, secret|
-            secrets << "@#{secret}".to_sym
+            secrets << :"@#{secret}"
           end
         end
       end
@@ -241,13 +241,13 @@ module Fog
         missing = requirements - keys
 
         unless missing.empty?
-          raise ArgumentError, "Missing required arguments: #{missing.join(", ")}"
+          raise ArgumentError, "Missing required arguments: #{missing.join(', ')}"
         end
 
         unless recognizes.empty?
           unrecognized = options.keys - requirements - recognized
           unless unrecognized.empty?
-            Fog::Logger.warning("Unrecognized arguments: #{unrecognized.join(", ")}")
+            Fog::Logger.warning("Unrecognized arguments: #{unrecognized.join(', ')}")
           end
         end
       end

data/lib/fog/core/services_mixin.rb

@@ -1,21 +1,37 @@
 module Fog
   module ServicesMixin
+    E_SERVICE_PROVIDER_CONSTANT = <<-EOS.gsub(/\s+/, " ").strip.freeze
+      Falling back to deprecated constant Fog::%<service>s::%<provider>s. The
+      preferred format of service provider constants has changed from
+      service::provider to provider::service. Please update this service
+      provider to use the preferred format.
+    EOS
+    E_SERVICE_PROVIDER_PATH = <<-EOS.gsub(/\s+/, " ").strip.freeze
+      Falling back to deprecated path fog/%<service>s/%<provider>s. The
+      preferred file path format has changed from service/provider to
+      provider/service. Please update this service provider to use the preferred
+      format.
+    EOS
+
     def [](provider)
-      new(:provider => provider)
+      new(provider: provider)
     end
 
     def new(attributes)
-      attributes    = attributes.dup # Prevent delete from having side effects
-      provider      = check_provider_alias(attributes.delete(:provider).to_s.downcase.to_sym)
-      provider_name = Fog.providers[provider]
+      attributes     = attributes.dup # Prevent delete from having side effects
+      provider       = attributes.delete(:provider).to_s.downcase.to_sym
+      provider_alias = check_provider_alias(provider)
+      provider_name  = Fog.providers[provider_alias]
 
-      raise ArgumentError, "#{provider} is not a recognized provider" unless providers.include?(provider)
+      raise ArgumentError, "#{provider_alias} is not a recognized provider" unless providers.include?(provider) || providers.include?(provider_alias)
 
-      require_service_provider_library(service_name.downcase, provider)
+      require_service_provider_library(service_name.downcase, provider_alias)
       spc = service_provider_constant(service_name, provider_name)
       spc.new(attributes)
-    rescue LoadError, NameError  # Only rescue errors in finding the libraries, allow connection errors through to the caller
-      raise Fog::Service::NotFound, "#{provider} has no #{service_name.downcase} service"
+    rescue LoadError, NameError => e  # Only rescue errors in finding the libraries, allow connection errors through to the caller
+      Fog::Logger.warning("Error while loading provider #{provider_alias}: #{e.message}")
+      Fog::Logger.debug("backtrace: #{e.backtrace.join("\n")}")
+      raise Fog::Service::NotFound, "#{provider_alias} has no #{service_name.downcase} service"
     end
 
     def providers
@@ -32,7 +48,9 @@ module Fog
       require "fog/#{provider}/#{service}"
     rescue LoadError  # Try to require the service provider in an alternate location
       Fog::Logger.deprecation("Unable to require fog/#{provider}/#{service}")
-      Fog::Logger.deprecation("The format fog/#{service}/#{provider} is deprecated")
+      Fog::Logger.deprecation(
+        format(E_SERVICE_PROVIDER_PATH, service: service, provider: provider)
+      )
       require "fog/#{service}/#{provider}"
     end
 
@@ -40,7 +58,9 @@ module Fog
       Fog.const_get(provider_name).const_get(*const_get_args(service_name))
     rescue NameError  # Try to find the constant from in an alternate location
       Fog::Logger.deprecation("Unable to load Fog::#{provider_name}::#{service_name}")
-      Fog::Logger.deprecation("The format Fog::#{service_name}::#{provider_name} is deprecated")
+      Fog::Logger.deprecation(
+        format(E_SERVICE_PROVIDER_CONSTANT, service: service_name, provider: provider_name)
+      )
       Fog.const_get(service_name).const_get(*const_get_args(provider_name))
     end
 
@@ -55,22 +75,22 @@ module Fog
     def check_provider_alias(provider)
       case provider
       when :baremetalcloud
-        Fog::Logger.deprecation(':baremetalcloud is deprecated. Use :bare_metal_cloud instead!')
+        Fog::Logger.deprecation(":baremetalcloud is deprecated. Use :bare_metal_cloud instead!")
         :bare_metal_cloud
       when :gogrid
-        Fog::Logger.deprecation(':gogrid is deprecated. Use :go_grid instead!')
+        Fog::Logger.deprecation(":gogrid is deprecated. Use :go_grid instead!")
         :go_grid
       when :internetarchive
-        Fog::Logger.deprecation(':internetarchive is deprecated. Use :internet_archive instead!')
+        Fog::Logger.deprecation(":internetarchive is deprecated. Use :internet_archive instead!")
         :internet_archive
       when :new_servers
-        Fog::Logger.deprecation(':new_servers is deprecated. Use :bare_metal_cloud instead!')
+        Fog::Logger.deprecation(":new_servers is deprecated. Use :bare_metal_cloud instead!")
         :bare_metal_cloud
       when :stormondemand
-        Fog::Logger.deprecation(':stormondemand is deprecated. Use :storm_on_demand instead!')
+        Fog::Logger.deprecation(":stormondemand is deprecated. Use :storm_on_demand instead!")
         :storm_on_demand
       when :vclouddirector
-        Fog::Logger.deprecation(':vclouddirector is deprecated. Use :vcloud_director instead!')
+        Fog::Logger.deprecation(":vclouddirector is deprecated. Use :vcloud_director instead!")
         :vcloud_director
       else provider
       end

data/lib/fog/core/ssh.rb

@@ -28,7 +28,7 @@ module Fog
       end
 
       def run(commands, &_blk)
-        self.class.data[@address] << { :commands => commands, :username => @username, :options => @options }
+        self.class.data[@address] << { commands: commands, username: @username, options: @options }
       end
     end
 
@@ -61,6 +61,7 @@ module Fog
 
                   channel.on_extended_data do |_ch, type, data|
                     next unless type == 1
+
                     result.stderr << data
                     yield ["", data] if blk
                   end
@@ -116,10 +117,11 @@ module Fog
 
         # net-ssh has deprecated :paranoid in favor of :verify_host_key
         # https://github.com/net-ssh/net-ssh/pull/524
-        opts = { :paranoid => false, :verify_host_key => false }.merge(options)
+        opts = { paranoid: false, verify_host_key: :never }.merge(options)
         if Net::SSH::VALID_OPTIONS.include? :verify_host_key
           opts.delete(:paranoid)
         end
+        opts[:verify_host_key] = false unless Net::SSH::Verifiers.const_defined?(:Never)
         opts
       end
 

data/lib/fog/core/stringify_keys.rb

@@ -7,8 +7,6 @@ module Fog
       end
     end
 
-    private
-
     # http://devblog.avdi.org/2009/11/20/hash-transforms-in-ruby/
     def self.transform_hash(original, &block)
       original.reduce({}) do |result, (key, value)|

data/lib/fog/core/time.rb

@@ -2,8 +2,8 @@ require "time"
 
 module Fog
   class Time < ::Time
-    DAYS = %w(Sun Mon Tue Wed Thu Fri Sat)
-    MONTHS = %w(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec)
+    DAYS = %w(Sun Mon Tue Wed Thu Fri Sat).freeze
+    MONTHS = %w(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec).freeze
 
     def self.now
       at(::Time.now - offset)

data/lib/fog/core/uuid.rb

@@ -4,16 +4,10 @@ module Fog
   class UUID
     class << self
       def uuid
-        if supported?
-          SecureRandom.uuid
-        else
-          ary = SecureRandom.random_bytes(16).unpack("NnnnnN")
-          ary[2] = (ary[2] & 0x0fff) | 0x4000
-          ary[3] = (ary[3] & 0x3fff) | 0x8000
-          "%08x-%04x-%04x-%04x-%04x%08x" % ary
-        end
+        SecureRandom.uuid
       end
 
+      # :nodoc: This method is used by other plugins, so preserve it for the compatibility
       def supported?
         SecureRandom.respond_to?(:uuid)
       end

data/lib/fog/core/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Core
-    VERSION = "2.1.2"
+    VERSION = "2.5.0".freeze
   end
 end

data/lib/fog/core/wait_for.rb

@@ -8,9 +8,10 @@ module Fog
       if duration > timeout
         raise Errors::TimeoutError, "The specified wait_for timeout (#{timeout} seconds) was exceeded"
       end
+
       sleep(interval.respond_to?(:call) ? interval.call(retries += 1).to_f : interval.to_f)
       duration = Time.now - start
     end
-    { :duration => duration }
+    { duration: duration }
   end
 end

data/lib/fog/core/wait_for_defaults.rb

@@ -22,6 +22,7 @@ module Fog
 
   def self.timeout=(timeout)
     raise ArgumentError, "timeout must be non-negative" unless timeout >= 0
+
     @timeout = timeout
   end
 
@@ -33,6 +34,7 @@ module Fog
 
   def self.max_interval=(interval)
     raise ArgumentError, "interval must be non-negative" unless interval >= 0
+
     @max_interval = interval
   end
 end

data/lib/fog/core.rb

@@ -1,5 +1,4 @@
 # external core dependencies
-require "base64"
 require "cgi"
 require "uri"
 require "excon"
@@ -11,67 +10,66 @@ require "timeout"
 require "ipaddr"
 
 # internal core dependencies
-require File.expand_path('../core/version', __FILE__)
+require File.expand_path("core/version", __dir__)
 
 # Mixins
-require File.expand_path('../core/services_mixin', __FILE__)
+require File.expand_path("core/services_mixin", __dir__)
 
-require File.expand_path('../core/attributes', __FILE__)
-require File.expand_path('../core/attributes/default', __FILE__)
-require File.expand_path('../core/attributes/array', __FILE__)
-require File.expand_path('../core/attributes/boolean', __FILE__)
-require File.expand_path('../core/attributes/float', __FILE__)
-require File.expand_path('../core/attributes/integer', __FILE__)
-require File.expand_path('../core/attributes/string', __FILE__)
-require File.expand_path('../core/attributes/time', __FILE__)
-require File.expand_path('../core/attributes/timestamp', __FILE__)
-require File.expand_path('../core/associations/default', __FILE__)
-require File.expand_path('../core/associations/many_identities', __FILE__)
-require File.expand_path('../core/associations/many_models', __FILE__)
-require File.expand_path('../core/associations/one_model', __FILE__)
-require File.expand_path('../core/associations/one_identity', __FILE__)
-require File.expand_path('../core/collection', __FILE__)
-require File.expand_path('../core/association', __FILE__)
-require File.expand_path('../core/connection', __FILE__)
-require File.expand_path('../core/credentials', __FILE__)
-require File.expand_path('../core/current_machine', __FILE__)
-require File.expand_path('../core/deprecation', __FILE__)
-require File.expand_path('../core/errors', __FILE__)
-require File.expand_path('../core/hmac', __FILE__)
-require File.expand_path('../core/logger', __FILE__)
-require File.expand_path('../core/model', __FILE__)
-require File.expand_path('../core/mock', __FILE__)
-require File.expand_path('../core/provider', __FILE__)
-require File.expand_path('../core/service', __FILE__)
-require File.expand_path('../core/ssh', __FILE__)
-require File.expand_path('../core/scp', __FILE__)
-require File.expand_path('../core/time', __FILE__)
-require File.expand_path('../core/utils', __FILE__)
-require File.expand_path('../core/wait_for', __FILE__)
-require File.expand_path('../core/wait_for_defaults', __FILE__)
-require File.expand_path('../core/uuid', __FILE__)
-require File.expand_path('../core/stringify_keys', __FILE__)
-require File.expand_path('../core/whitelist_keys', __FILE__)
-
-require File.expand_path('../account', __FILE__)
-require File.expand_path('../baremetal', __FILE__)
-require File.expand_path('../billing', __FILE__)
-require File.expand_path('../cdn', __FILE__)
-require File.expand_path('../compute', __FILE__)
-require File.expand_path('../dns', __FILE__)
-require File.expand_path('../identity', __FILE__)
-require File.expand_path('../image', __FILE__)
-require File.expand_path('../introspection', __FILE__)
-require File.expand_path('../metering', __FILE__)
-require File.expand_path('../monitoring', __FILE__)
-require File.expand_path('../nfv', __FILE__)
-require File.expand_path('../network', __FILE__)
-require File.expand_path('../orchestration', __FILE__)
-require File.expand_path('../storage', __FILE__)
-require File.expand_path('../support', __FILE__)
-require File.expand_path('../volume', __FILE__)
-require File.expand_path('../vpn', __FILE__)
+require File.expand_path("core/attributes", __dir__)
+require File.expand_path("core/attributes/default", __dir__)
+require File.expand_path("core/attributes/array", __dir__)
+require File.expand_path("core/attributes/boolean", __dir__)
+require File.expand_path("core/attributes/float", __dir__)
+require File.expand_path("core/attributes/integer", __dir__)
+require File.expand_path("core/attributes/string", __dir__)
+require File.expand_path("core/attributes/time", __dir__)
+require File.expand_path("core/attributes/timestamp", __dir__)
+require File.expand_path("core/associations/default", __dir__)
+require File.expand_path("core/associations/many_identities", __dir__)
+require File.expand_path("core/associations/many_models", __dir__)
+require File.expand_path("core/associations/one_model", __dir__)
+require File.expand_path("core/associations/one_identity", __dir__)
+require File.expand_path("core/collection", __dir__)
+require File.expand_path("core/association", __dir__)
+require File.expand_path("core/connection", __dir__)
+require File.expand_path("core/credentials", __dir__)
+require File.expand_path("core/current_machine", __dir__)
+require File.expand_path("core/deprecation", __dir__)
+require File.expand_path("core/errors", __dir__)
+require File.expand_path("core/hmac", __dir__)
+require File.expand_path("core/logger", __dir__)
+require File.expand_path("core/model", __dir__)
+require File.expand_path("core/mock", __dir__)
+require File.expand_path("core/provider", __dir__)
+require File.expand_path("core/service", __dir__)
+require File.expand_path("core/ssh", __dir__)
+require File.expand_path("core/scp", __dir__)
+require File.expand_path("core/time", __dir__)
+require File.expand_path("core/utils", __dir__)
+require File.expand_path("core/wait_for", __dir__)
+require File.expand_path("core/wait_for_defaults", __dir__)
+require File.expand_path("core/uuid", __dir__)
+require File.expand_path("core/stringify_keys", __dir__)
+require File.expand_path("core/whitelist_keys", __dir__)
 
+require File.expand_path("account", __dir__)
+require File.expand_path("baremetal", __dir__)
+require File.expand_path("billing", __dir__)
+require File.expand_path("cdn", __dir__)
+require File.expand_path("compute", __dir__)
+require File.expand_path("dns", __dir__)
+require File.expand_path("identity", __dir__)
+require File.expand_path("image", __dir__)
+require File.expand_path("introspection", __dir__)
+require File.expand_path("metering", __dir__)
+require File.expand_path("monitoring", __dir__)
+require File.expand_path("nfv", __dir__)
+require File.expand_path("network", __dir__)
+require File.expand_path("orchestration", __dir__)
+require File.expand_path("storage", __dir__)
+require File.expand_path("support", __dir__)
+require File.expand_path("volume", __dir__)
+require File.expand_path("vpn", __dir__)
 
 # Utility
-require File.expand_path('../formatador', __FILE__)
+require File.expand_path("formatador", __dir__)