fog-core 1.21.1 → 1.22.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTA5YWE2M2M1MTU2YzQxMzJkZWFhMTc2MmE4YThiYmE4MjlkMWY2MA==
+    YTNmYzY5ZmZiYjA4OTVkZWU2MTA0OTQ3ZmVmZmYxM2M0Y2UxY2ZkMA==
   data.tar.gz: !binary |-
-    Mjc5ZGYxMDllM2FmNmIwNjNhZjNiOGQxZjM1ODFkYzM3YjI3NDkwYg==
+    MGJmMDEwODNmZjRiYjA5MTYzMmNkZjA3OTY4NTAzNzAzZGJkZjE0ZQ==
 SHA512:
   metadata.gz: !binary |-
-    MDEzNGZmNzE3Zjg4NTZhZDNjMmE3YmIxZDQ1OTNiYTE3NDNjY2MzNjVjNjE4
-    MTFiYzY0ZjA1ZmEzMTlhZjIzYTFmZmZhNDBlMDdjY2IxY2EwNGE0NjA5NTky
-    MzJhMDcwOWY0ZmQ2NTIwZTNkZjIxYjc5NzgzMWJmYzVjYWE4Nzg=
+    NTNmYzVjYzdjMmJiN2NjMjU3ZmFmYTYxZGJiYTA1MTEzZjBmNWFmMWY3Zjg0
+    NDU0YTcxYWY5ZTU0ODViMGIwMTYyN2IzMWI4YWFlOTVhZjgyYjM5ODU0MTcx
+    ZTY2MGZkZTVmYmFlMDI4NmVlZGFkNWMxMmY1YTcyOWZhNjJlYTc=
   data.tar.gz: !binary |-
-    NzFkYmI1MzUzNWQ0M2Y5OTZmMzgxOTU0NDRkMWU3MjMwODgyZDA2ODcyNjQ3
-    YzNkMzNlZWI1MGI3NTFkYzUxNGVkZmQyNjZhOWI4NjM0NDkwZjVhOWFjODU1
-    ZDMxNDllN2Y5YWUyZTkzMTVkOGMzZmRjMTBkMTdhNDY5NTgyYWY=
+    YTgyMTQ0MWQzOWI5NWM5OWYwNjcxZTE3NWExNWNhZmM1ODU0Y2RlNTNmMDlm
+    NGFjOThlNDNkNDNmMjA4YTlkNTU4NmU0YjRjNmE4Mzk0ZTExODYyODQzMzg4
+    OWVlZmQxNDRlM2U2YzViY2ZhOTA0MGY2YzUwOTFjNjFiZWQ2OWI=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.#*

data/.travis.yml

@@ -0,0 +1,59 @@
+language: ruby
+
+gemfile:
+  - Gemfile
+  - Gemfile.1.8.7
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-head
+
+script: bundle exec rake travis
+
+matrix:
+  include:
+    - rvm: 2.1.0
+      gemfile: Gemfile
+      env: COVERAGE=true
+  exclude:
+    - rvm: 1.8.7
+      gemfile: Gemfile
+    - rvm: 1.9.2
+      gemfile: Gemfile.1.8.7
+    - rvm: 1.9.3
+      gemfile: Gemfile.1.8.7
+    - rvm: 2.0.0
+      gemfile: Gemfile.1.8.7
+    - rvm: 2.1.0
+      gemfile: Gemfile.1.8.7
+    - rvm: jruby-18mode
+      gemfile: Gemfile
+    - rvm: jruby-19mode
+      gemfile: Gemfile.1.8.7
+    - rvm: jruby-head
+      gemfile: Gemfile.1.8.7
+
+  allow_failures:
+    - rvm: jruby-head
+
+notifications:
+  email: false
+  irc:
+    channels:
+      - "irc.freenode.org#ruby-fog"
+    template:
+    - "[#%{build_number}] %{message} %{build_url}"
+    - "[#%{build_number}] %{commit} on %{branch} by %{author}"
+    - "[#%{build_number}] %{compare_url}"
+    on_success: always
+    on_failure: always
+    use_notice: false
+
+before_install:
+  - gem update --system #  todo: workaround for https://github.com/rubygems/rubygems/pull/763

data/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+## Getting Involved
+
+New contributors are always welcome, when it doubt please ask questions. We strive to be an open and welcoming community. Please be nice to one another.
+
+### Coding
+
+* Pick a task:
+  * Offer feedback on open [pull requests](https://github.com/fog/fog-core/pulls).
+  * Review open [issues](https://github.com/fog/fog-core/issues) for things to help on.
+  * [Create an issue](https://github.com/fog/fog-core/issues/new) to start a discussion on additions or features.
+* Fork the project, add your changes and tests to cover them in a topic branch.
+* Commit your changes and rebase against `fog/fog-core` to ensure everything is up to date.
+* [Submit a pull request](https://github.com/fog/fog-core/compare/)
+
+### Non-Coding
+
+* Offer feedback on open [issues](https://github.com/fog/fog-core/issues).
+* Write and help edit [documentation](https://github.com/fog/fog.github.com).
+* Translate [documentation](https://github.com/fog/fog.github.com) in to other languages.
+* Organize or volunteer at events.
+* [Donate](https://www.gittip.com/geemus/)
+* Discuss other ideas for contribution with [geemus](mailto:geemus+fog@gmail.com).

data/CONTRIBUTORS.md

@@ -0,0 +1,9 @@
+* Anatol <anatol.pomozov@gmail.com>
+* Chris Johnson <wchrisjohnson@gmail.com>
+* Dominic Cleal <dcleal@redhat.com>
+* Evan Light <evan@tripledogdare.net>
+* Paul Thornthwaite <paul@brightbox.co.uk>
+* Paul Thornthwaite <tokengeek@gmail.com>
+* Wesley Beary <geemus+github@gmail.com>
+* geemus <geemus@gmail.com>
+* mountkin <moutkin@gmail.com>

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/Gemfile.1.8.7

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gem 'nokogiri', '~>1.5.11'
+gem 'mime-types', '~>1.16'
+
+group :development, :test do
+  gem 'rake', '~> 10.1.0'
+  # This is here because gemspec doesn't support require: false
+  gem 'coveralls', :require => false
+end
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 [CONTRIBUTORS.md](https://github.com/fog/fog/blob/master/CONTRIBUTORS.md)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Fog::Core
+
+Shared classes and tests for fog providers and services.
+
+[![Build Status](https://secure.travis-ci.org/fog/fog-core.png?branch=master)](http://travis-ci.org/fog/fog-core)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fog-core'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fog-core
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/fog-core/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,33 @@
+require 'bundler/setup'
+
+task :travis  => ['test:travis', 'coveralls_push_workaround']
+task :default => [:test]
+
+require "rake/testtask"
+
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "spec"
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+namespace :test do
+  mock = 'true' || ENV['FOG_MOCK']
+  task :travis do
+    # jruby coveralls causes an OOM in travis
+    ENV['COVERAGE'] = 'false' if RUBY_PLATFORM == 'java'
+    sh("export FOG_MOCK=#{mock} && rake")
+  end
+end
+
+#require "tasks/changelog_task"
+#Fog::Rake::ChangelogTask.new
+task :coveralls_push_workaround do
+  use_coveralls = (Gem::Version.new(RUBY_VERSION) > Gem::Version.new('1.9.2'))
+  if (ENV['COVERAGE'] != 'false') && use_coveralls
+    require 'coveralls/rake/task'
+    Coveralls::RakeTask.new
+    Rake::Task["coveralls:push"].invoke
+  end
+end

data/changelog.md

@@ -0,0 +1,7 @@
+1.21.1 03/18/2014 3a803405ba60ded421f4bd14677cd3c76cb7e6ab
+==========================================================
+
+remove json/xml modules and code
+add travis/coveralls
+update from upstream
+bump/loosen excon dependency

data/fog-core.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fog-core"
+  spec.version       = Fog::VERSION
+  spec.authors       = ["Evan Light", "Wesley Beary"]
+  spec.email         = ["evan@tripledogdare.net", "geemus@gmail.com"]
+  spec.summary       = %q{Shared classes and tests for fog providers and services.}
+  spec.description   = %q{Shared classes and tests for fog providers and services.}
+  spec.homepage      = "https://github.com/fog/fog-core"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('builder')
+  spec.add_dependency('excon', '~>0.33')
+  spec.add_dependency('formatador', '~>0.2')
+  spec.add_dependency('mime-types')
+  spec.add_dependency('net-scp', '~>1.1')
+  spec.add_dependency('net-ssh', '>=2.1.3')
+
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('yard')
+  spec.add_development_dependency('thor')
+  spec.add_development_dependency('minitest')
+  spec.add_development_dependency('minitest-stub-const')
+  spec.add_development_dependency('pry')
+  spec.add_development_dependency('coveralls')
+end

data/lib/fog/compute.rb

@@ -55,9 +55,14 @@ module Fog
       else
         if self.providers.include?(provider)
           require "fog/#{provider}/compute"
-          return Fog::Compute.const_get(Fog.providers[provider]).new(attributes)
+          begin
+            Fog::Compute.const_get(Fog.providers[provider])
+          rescue
+            Fog::const_get(Fog.providers[provider])::Compute
+          end.new(attributes)
+        else
+          raise ArgumentError.new("#{provider} is not a recognized compute provider")
         end
-        raise ArgumentError.new("#{provider} is not a recognized compute provider")
       end
     end
 

data/lib/fog/core.rb

@@ -28,9 +28,9 @@ require 'fog/core/service'
 require 'fog/core/ssh'
 require 'fog/core/scp'
 require 'fog/core/time'
+require 'fog/core/utils'
 require 'fog/core/wait_for'
 require 'fog/core/wait_for_defaults'
-require 'fog/core/class_from_string'
 require 'fog/core/uuid'
 
 # service wrappers

data/lib/fog/core/credentials.rb

@@ -3,19 +3,49 @@ require 'yaml'
 module Fog
   require 'fog/core/deprecation'
 
+  # Sets the global configuration up from a Hash rather than using background loading from a file
+  #
+  # @example
+  #   Fog.credentials = {
+  #     :default => {
+  #       :example_url => "https://example.com/"
+  #       :example_username => "bob",
+  #       :example_password => "obo"
+  #     },
+  #     :production => {
+  #       :example_username => "bob",
+  #       :example_password => "obo"
+  #     }
+  #   }
+  #
+  # @return [Hash] The newly assigned credentials
+  def self.credentials=(new_credentials)
+    @credentials = new_credentials
+  end
+
   # Assign a new credential to use from configuration file
-  #   @param [String, Symbol] new_credential name of new credential to use
-  #   @ return [Symbol] name of the new credential
+  #
+  # @param [String, Symbol] new_credential name of new credential to use
+  # @return [Symbol] name of the new credential
   def self.credential=(new_credential)
     @credentials = nil
     @credential = new_credential && new_credential.to_sym
   end
 
-  # @return [String, Symbol] The credential to use in Fog
+  # This is the named credential from amongst the configuration file being used or +:default+
+  #
+  # @note This can be set using the +FOG_CREDENTIAL+ environment variable
+  #
+  # @return [Symbol] The credential to use in Fog
   def self.credential
     @credential ||= ( ENV["FOG_CREDENTIAL"] && ENV["FOG_CREDENTIAL"].to_sym ) || :default
   end
 
+  # This returns the path to the configuration file being used globally to look for sets of
+  # credentials
+  #
+  # @note This can be set using the +FOG_RC+ environment variable or defaults to +$HOME/.fog+
+  #
   # @return [String] The path for configuration_file
   def self.credentials_path
     @credential_path ||= begin
@@ -35,9 +65,9 @@ module Fog
   # @return [Hash] The credentials pulled from the configuration file
   # @raise [LoadError] Configuration unavailable in configuration file
   def self.credentials
-    @credentials  ||= begin
+    @credentials ||= begin
       if credentials_path && File.exists?(credentials_path)
-        credentials = self.symbolize_credentials(YAML.load_file(credentials_path))
+        credentials = Fog::Core::Utils.prepare_service_settings(YAML.load_file(credentials_path))
         (credentials && credentials[credential]) || Fog::Errors.missing_credentials
       else
         {}
@@ -45,26 +75,15 @@ module Fog
     end
   end
 
-  # @return [Hash] The newly assigned credentials
-  def self.credentials=(new_credentials)
-    @credentials = new_credentials
-  end
-
+  # @deprecated Don't use!
+  # @param [Object] key
+  # @return [true] if key == :headers
   def self.symbolize_credential?(key)
     ![:headers].include?(key)
   end
 
-  def self.symbolize_credentials(args)
-    if args.is_a? Hash
-      copy = Array.new
-      args.each do |key, value|
-        obj = symbolize_credential?(key) ? self.symbolize_credentials(value) : value
-        copy.push(key.to_sym, obj)
-      end
-      Hash[*copy]
-    else
-      args
-    end
+  # @deprecated Use {Fog::Core::Utils.prepare_service_settings} instead
+  def self.symbolize_credentials(hash)
+    Fog::Core::Utils.prepare_service_settings(hash)
   end
-
 end

data/lib/fog/core/model.rb

@@ -12,12 +12,13 @@ module Fog
 
     def initialize(new_attributes = {})
       # TODO Remove compatibility with old connection option
-      @service = new_attributes.delete(:service)
-      if @service.nil? && new_attributes[:connection]
+      attribs = new_attributes.clone
+      @service = attribs.delete(:service)
+      if @service.nil? && attribs[:connection]
         Fog::Logger.deprecation("Passing :connection option is deprecated, use :service instead [light_black](#{caller.first})[/]")
-        @service = new_attributes[:connection]
+        @service = attribs[:connection]
       end
-      merge_attributes(new_attributes)
+      merge_attributes(attribs)
     end
 
     def inspect

data/lib/fog/core/service.rb

@@ -1,11 +1,11 @@
-module Fog
+require "fog/core/utils"
 
+module Fog
   def self.services
     @services ||= {}
   end
 
   class Service
-
     class Error < Fog::Errors::Error; end
     class NotFound < Fog::Errors::NotFound; end
 
@@ -16,7 +16,6 @@ module Fog
     end
 
     module Collections
-
       def collections
         service.collections
       end
@@ -28,11 +27,9 @@ module Fog
       def requests
         service.requests
       end
-
     end
 
     class << self
-
       def inherited(child)
         child.class_eval <<-EOS, __FILE__, __LINE__
           class Error < Fog::Service::Error; end
@@ -52,27 +49,78 @@ module Fog
         EOS
       end
 
-      def new(options={})
-        options = Fog.symbolize_credentials(options)
-        options = fetch_credentials(options).merge(options)
-        validate_options(options)
-        coerce_options(options)
+      # {Fog::Service} is (unfortunately) both a builder class and the subclass for any fog service.
+      #
+      # Creating a {new} instance using the builder will return either an instance of
+      # +Fog::<Service>::<Provider>::Real+ or +Fog::<Service>::<Provider>::Mock+ based on the value
+      # of {Fog.mock?} when the builder is used.
+      #
+      # Each provider can require or recognize different settings (often prefixed with the providers
+      # name). These settings map to keys in the +~/.fog+ file.
+      #
+      # Settings can be passed as either a Hash or an object that responds to +config_service?+ with
+      # +true+. This object will be passed through unchanged to the +Real+ or +Mock+ service that is
+      # created. It is up to providers to adapt services to use these config objects.
+      #
+      # @abstract Subclass and implement real or mock code
+      #
+      # @param [Hash,#config_service?] config
+      #   Settings or an object used to build a service instance
+      # @option config [Hash] :headers
+      #   Passed to the underlying {Fog::Core::Connection} unchanged
+      #
+      # @return [Fog::Service::Provider::Real] if created while mocking is disabled
+      # @return [Fog::Service::Provider::Mock] if created while mocking is enabled
+      # @raise [ArgumentError] if a setting required by the provider was not passed in
+      #
+      # @example Minimal options (dependent on ~/.fog)
+      #   @service = Fog::Compute::Example.new # => <#Fog::Compute::Example::Real>
+      #
+      # @example Mocked service
+      #   Fog.mock!
+      #   @service = Fog::Compute::Example.new # => <#Fog::Compute::Example::Mock>
+      #
+      # @example Configured using many options (options merged into ~/.fog)
+      #   @options = {
+      #     :example_username => "fog",
+      #     :example_password => "fog"
+      #   }
+      #   @service = Fog::Compute::Example.new(@options)
+      #
+      # @example Configured using external config object (~/.fog ignored completely)
+      #   @config = Fog::Example::Config.new(...)
+      #   @service = Fog::Compute::Example.new(@config)
+      #
+      def new(config = {})
+        if config.respond_to?(:config_service?) && config.config_service?
+          cleaned_settings = config
+        else
+          cleaned_settings = handle_settings(config)
+        end
         setup_requirements
 
+        svc = service
         if Fog.mocking?
-          service::Mock.send(:include, service::Collections)
-          service::Mock.new(options)
+          while svc != Fog::Service
+            service::Mock.send(:include, svc::Collections)
+            svc = svc.superclass
+          end
+          service::Mock.new(cleaned_settings)
         else
-          service::Real.send(:include, service::Collections)
+          while svc != Fog::Service
+            service::Real.send(:include, svc::Collections)
+            svc = svc.superclass
+          end
           service::Real.send(:include, service::NoLeakInspector)
-          service::Real.new(options)
+          service::Real.new(cleaned_settings)
         end
       end
 
+      # @deprecated
       def fetch_credentials(options)
         # attempt to load credentials from config file
         begin
-          Fog.credentials.reject {|key, value| !(recognized | requirements).include?(key)}
+          Fog.credentials.reject { |key, value| !(recognized | requirements).include?(key) }
         rescue LoadError
           # if there are no configured credentials, do nothing
           {}
@@ -86,34 +134,14 @@ module Fog
 
         @required ||= false
         unless @required
-          for collection in collections
-            require [@model_path, collection].join('/')
-            constant = collection.to_s.split('_').map {|characters| characters[0...1].upcase << characters[1..-1]}.join('')
-            service::Collections.module_eval <<-EOS, __FILE__, __LINE__
-              def #{collection}(attributes = {})
-                #{service}::#{constant}.new({:service => self}.merge(attributes))
-              end
-            EOS
-          end
-          for model in models
-            require [@model_path, model].join('/')
-          end
-          for request in requests
-            require [@request_path, request].join('/')
-            if service::Mock.method_defined?(request)
-              mocked_requests << request
-            else
-              service::Mock.module_eval <<-EOS, __FILE__, __LINE__
-                def #{request}(*args)
-                  Fog::Mock.not_implemented
-                end
-              EOS
-            end
-          end
+          require_models
+          require_collections_and_define
+          require_requests_and_mock
           @required = true
         end
       end
 
+      # @note This path is used to require model and collection files
       def model_path(new_path)
         @model_path = new_path
       end
@@ -204,6 +232,7 @@ module Fog
           end
         end
         missing = requirements - keys
+
         unless missing.empty?
           raise ArgumentError, "Missing required arguments: #{missing.join(', ')}"
         end
@@ -216,8 +245,66 @@ module Fog
         end
       end
 
-    end
+      private
+
+      # This is the original way service settings were handled. Settings from +~/.fog+ were merged
+      # together with the passed options, keys are turned to symbols and coerced into Boolean or
+      # Fixnums.
+      #
+      # If the class has declared any required settings then {ArgumentError} will be raised.
+      #
+      # Any setting that is not whitelisted will cause a warning to be output.
+      #
+      def handle_settings(settings)
+        combined_settings = fetch_credentials(settings).merge(settings)
+        prepared_settings = Fog::Core::Utils.prepare_service_settings(combined_settings)
+        validate_options(prepared_settings)
+        coerce_options(prepared_settings)
+      end
+
+      # This will attempt to require all model files declared by the service using fog's DSL
+      def require_models
+        models.each do |model|
+          require File.join(@model_path, model.to_s)
+        end
+      end
+
+      def require_collections_and_define
+        collections.each do |collection|
+          require File.join(@model_path, collection.to_s)
+          constant = camel_case_collection_name(collection)
+          service::Collections.module_eval <<-EOS, __FILE__, __LINE__
+            def #{collection}(attributes = {})
+              #{service}::#{constant}.new({ :service => self }.merge(attributes))
+            end
+          EOS
+        end
+      end
+
+      # This converts names of collections from Symbols as defined in the DSL (+:database_server+)
+      # into CamelCase version (+DatabaseServer+) for metaprogramming skulduggery.
+      #
+      # @param [String,Symbol] collection The name of the collection broken with underscores
+      # @return [String] in camel case
+      def camel_case_collection_name(collection)
+        collection.to_s.split('_').map(&:capitalize).join
+      end
 
+      # This will attempt to require all request files declared in the service using fog's DSL
+      def require_requests_and_mock
+        requests.each do |request|
+          require File.join(@request_path, request.to_s)
+          if service::Mock.method_defined?(request)
+            mocked_requests << request
+          else
+            service::Mock.module_eval <<-EOS, __FILE__, __LINE__
+              def #{request}(*args)
+                Fog::Mock.not_implemented
+              end
+            EOS
+          end
+        end
+      end
+    end
   end
 end
-