nucleus 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a510c433f1548f80c42ce3d32804e73b7c71640
-  data.tar.gz: 46ff6af1d76e37cc945ea45a455968dded34533e
+  metadata.gz: 07e7129693ceadca0091a9e0f2e47260aa1ada94
+  data.tar.gz: b6383e24f2e138f8f9d6062546bf0663de185f2d
 SHA512:
-  metadata.gz: 44ffe6b03100aebabed7d6dbbc25cf714252b5985bbbc8708620688b84367082bdd2b39af34aa0c32094f0b155cf687a5e182385686dc505fbc6c1ab0f9a4bb4
-  data.tar.gz: 5668c6da41e685a1e6b65e0d7d6c0f84a93ac70d1f936e89227aa93558c76d949ffa2a8d7164ba18bb4ec68a7ce7692874279201dae9476ec7613f94e6ddb239
+  metadata.gz: 27460f6056c47b7faaa142478bff8990b51bd3ac580b3e3b782c94825fca2edf987f853e64ddae9778e07f0271375fb4303be96313e6c057ce8c8bcecdd29dc9
+  data.tar.gz: 276f1fff90199a3c0291279381eca3782182138df6c928dd8b452aae18d392b2c4df92bd2f7e237bdaecd55dac266fc2e10e34fddd8176942511c4bff6e9d72e

data/.rubocop.yml

@@ -36,6 +36,9 @@ Style/Documentation:
 Style/AlignHash:
   Enabled: false
 
+Style/GuardClause:
+  Enabled: false
+
 Style/ExtraSpacing:
   Exclude:
     - nucleus.gemspec

data/CHANGELOG.md

@@ -8,9 +8,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+### Removed
+
+
+## [0.3.1] - 2016-03-07
 
 ### Removed
+* Removed cloudControl adapter due to bankruptcy of the vendor
 
+## [0.3.0] - 2016-03-07
+* Yanked due to unnecessary Gem contents increasing the overall file size
 
 ## [0.2.0] - 2016-01-22
 
@@ -31,3 +38,5 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 
 [0.1.0]: https://github.com/stefan-kolb/nucleus/releases/tag/0.1.0
+[0.2.0]: https://github.com/stefan-kolb/nucleus/releases/tag/0.2.0
+[0.3.0]: https://github.com/stefan-kolb/nucleus/releases/tag/0.3.0

data/README.md

@@ -34,7 +34,6 @@ It provides fully compliant [swagger](http://swagger.io/) schemas that serve for
   * [Heroku](#heroku)
   * [Cloud Foundry v2](#cloud-foundry-v2)
   * [Openshift v2](#openshift-v2)
-  * [cloudControl](#cloudcontrol)
 * [Configuration](#configuration)
   * [Vendors, Providers and Endpoints](#vendors-providers-and-endpoints)
   * [Application configuration](#application-configuration)
@@ -57,8 +56,6 @@ It provides fully compliant [swagger](http://swagger.io/) schemas that serve for
   - [AppFog][appfog], [Anynines][anynines], [IBM Bluemix][bluemix], [Pivotal Web Services][pivotal_ws], [HP Helion][hp_helion]
 - [Openshift][openshift_v2] (v2)
   - [OpenShift Online][openshift_online], [getup Cloud][getup]
-- [cloudControl][cloudcontrol]
-  - [dotCloud][dotcloud], [Cloud&Heat App Elevator][cloud&heat], [exoscale Apps][exoscale]
 
 [heroku]: https://www.heroku.com
 
@@ -73,11 +70,6 @@ It provides fully compliant [swagger](http://swagger.io/) schemas that serve for
 [openshift_online]: https://www.openshift.com/features/index.html
 [getup]: https://getupcloud.com/index_en.html
 
-[cloudcontrol]: https://www.cloudcontrol.com
-[dotcloud]: https://www.dotcloud.com/
-[cloud&heat]: https://www.cloudandheat.com/de/paas.html
-[exoscale]: https://www.exoscale.ch/add-on/apps/
-
 More information on the vendors and the associated adapter can be found in the [adapters section](#adapters).
 
 ## Usage
@@ -186,13 +178,13 @@ resolver.adapters
 ```
 
 ```ruby
-{ "cloudcontrol"=>Nucleus::Adapters::V1::CloudControl, "cloud_foundry_v2"=>Nucleus::Adapters::V1::CloudFoundryV2, "heroku"=>Nucleus::Adapters::V1::Heroku, "openshift_v2"=>Nucleus::Adapters::V1::OpenshiftV2 }
+{ "cloud_foundry_v2"=>Nucleus::Adapters::V1::CloudFoundryV2, "heroku"=>Nucleus::Adapters::V1::Heroku, "openshift_v2"=>Nucleus::Adapters::V1::OpenshiftV2 }
 ```
 
 5) Load your desired adapter implementation:
 
 ```ruby
-adapter = resolver.load('cloudcontrol', 'api.cloudcontrol.com', 'your_username', 'your_password')
+adapter = resolver.load('cloud_foundry_v2', 'api.pivotal.io', 'your_username', 'your_password')
 ```
 
 By default, the adapter will be populated with the default configuration options that are defined in the vendor's configuration for the selected endpoint_url.
@@ -263,47 +255,47 @@ This list can be auto-generated via:
 $ bundle exec rake evaluation:compatibility:markdown
 ```
 
-**State: 10/14/2015**
-
-Method / Vendor|cloudControl|Cloud Foundry v2|Heroku|Openshift v2
-:--|:-:|:-:|:-:|:-:
-auth_client|✓|✓|✓|✓
-regions|✓|✓|✓|✓
-region|✓|✓|✓|✓
-applications|✓|✓|✓|✓
-application|✓|✓|✓|✓
-create_application|✓|✓|✓|✓
-update_application|✗|✓|✓|✗
-delete_application|✓|✓|✓|✓
-domains|✓|✓|✓|✓
-domain|✓|✓|✓|✓
-create_domain|✓|✓|✓|✓
-delete_domain|✓|✓|✓|✓
-env_vars|✓|✓|✓|✓
-env_var|✓|✓|✓|✓
-create_env_var|✓|✓|✓|✓
-update_env_var|✓|✓|✓|✓
-delete_env_var|✓|✓|✓|✓
-start|✓|✓|✓|✓
-stop|✗|✓|✓|✓
-restart|✗|✓|✓|✓
-deploy|✓|✓|✓|✓
-rebuild|✓|✓|✓|✓
-download|✓|✓|✓|✓
-scale|✓|✓|✓|✓
-log?|✓|✓|✓|✓
-logs|✓|✓|✓|✓
-log_entries|✓|✓|✓|✓
-tail|✓|✓|✓|✗
-services|✓|✓|✓|✓
-service|✓|✓|✓|✓
-service_plans|✓|✓|✓|✓
-service_plan|✓|✓|✓|✓
-installed_services|✓|✓|✓|✓
-installed_service|✓|✓|✓|✓
-add_service|✓|✓|✓|✓
-change_service|✓|✓|✓|✗
-remove_service|✓|✓|✓|✓
+**State: 3/7/2016**
+
+Method / Vendor|Cloud Foundry v2|Heroku|Openshift v2
+:--|:-:|:-:|:-:
+auth_client|✓|✓|✓
+regions|✓|✓|✓
+region|✓|✓|✓
+applications|✓|✓|✓
+application|✓|✓|✓
+create_application|✓|✓|✓
+update_application|✓|✓|✗
+delete_application|✓|✓|✓
+domains|✓|✓|✓
+domain|✓|✓|✓
+create_domain|✓|✓|✓
+delete_domain|✓|✓|✓
+env_vars|✓|✓|✓
+env_var|✓|✓|✓
+create_env_var|✓|✓|✓
+update_env_var|✓|✓|✓
+delete_env_var|✓|✓|✓
+start|✓|✓|✓
+stop|✓|✓|✓
+restart|✓|✓|✓
+deploy|✓|✓|✓
+rebuild|✓|✓|✓
+download|✓|✓|✓
+scale|✓|✓|✓
+log?|✓|✓|✓
+logs|✓|✓|✓
+log_entries|✓|✓|✓
+tail|✓|✓|✓
+services|✓|✓|✓
+service|✓|✓|✓
+service_plans|✓|✓|✓
+service_plan|✓|✓|✓
+installed_services|✓|✓|✓
+installed_service|✓|✓|✓
+add_service|✓|✓|✓
+change_service|✓|✓|✗
+remove_service|✓|✓|✓
 
 ### Core constructs
 
@@ -477,27 +469,6 @@ further configuration are not supported as of now.
 
 Recording is really slow. Even worse, actions quite often fail with Openshift internal timeouts.
 
-### cloudControl
-
-Providers: [cloudControl][cloudcontrol], [dotCloud][dotcloud], [Cloud&Heat App Elevator][cloud&heat], [exoscale Apps][exoscale]
-
-#### Issues
-
-**Application update**
-
-An application can't be updated, the `name` and `runtimes` can't be changed once created.
-
-**Application lifecycle**
-
-Applications on cloudControl can't be explicitly stopped or restarted.
-They start after a successful build of the application, which is therefore postponed to the first invocation of the start operation.
-Applications only stop once the corresponding _deployment_ has been deleted.
-
-**Logs**
-
-Log messages, for instance the request entries, do not appear instantly in the log.
-It may take some seconds or even minutes for them to show up.
-
 ## Configuration
 
 Several parts of Nucleus can be configured, e.g. whether to persist your data or always start with a clean instance.

data/lib/nucleus/adapter_resolver.rb

@@ -5,7 +5,7 @@ module Nucleus
     include Nucleus::UrlConverter
 
     def initialize(requested_version)
-      fail 'No such version supported' unless Nucleus::VersionDetector.api_versions.include?(requested_version)
+      raise 'No such version supported' unless Nucleus::VersionDetector.api_versions.include?(requested_version)
       @api_version = requested_version
     end
 
@@ -33,7 +33,7 @@ module Nucleus
     # @return [Nucleus::Adapters::BaseAdapter] loaded adapter implementation
     def load(vendor, username, password, options = {})
       setup
-      fail StandardError, "Could not find adapter for vendor '#{vendor}'" unless @adapters.key?(vendor)
+      raise StandardError, "Could not find adapter for vendor '#{vendor}'" unless @adapters.key?(vendor)
 
       # load the endpoint's HTTPS enabled API URL
       endpoint_url = load_endpoint(vendor, options)
@@ -73,7 +73,7 @@ module Nucleus
         # use default endpoint
         endpoint_url = @configurations[vendor].keys.first
       else
-        fail StandardError, "Could not identify an API endpoint for the vendor '#{vendor}'. "\
+        raise StandardError, "Could not identify an API endpoint for the vendor '#{vendor}'. "\
           "Please specify the API URL to use with the ':api_url' option."
       end
 

data/lib/nucleus/adapters/base_adapter.rb

@@ -1,109 +1,109 @@
-module Nucleus
-  # The {Adapters} module combines all application logic to communicate with the different vendor platforms
-  # and created the unified API.
-  module Adapters
-    # The {BaseAdapter} is an abstract class that shall be extended by all actual Adapters.
-    # It provides methods to common functionality:<br>
-    # * authentication (+cache)
-    # * http client with general error handling
-    # * native platform API calls
-    # @abstract
-    class BaseAdapter
-      include HttpClient
-      include HttpTailClient
-      include Logging
-
-      attr_reader :endpoint_url
-
-      def initialize(endpoint_url, endpoint_app_domain = nil, check_certificates = true)
-        fail ArgumentError, "'endpoint_url' must be a valid URL" unless endpoint_url =~ /\A#{URI.regexp(['https'])}\z/
-        @endpoint_url = endpoint_url
-        @endpoint_app_domain = endpoint_app_domain
-        @check_certificates = check_certificates
-      end
-
-      # thread-based cache for the api authorization headers
-      thread_config_accessor :auth_objects_cache, default: {}
-
-      # Cache the auth information.
-      # @param [String] key cache key
-      # @param [Nucleus::Adapters::AuthClient] auth_object authentication client to be cached
-      # @return [void]
-      def cache(key, auth_object)
-        auth_objects_cache[key] = auth_object
-      end
-
-      # Are there cached information for this key?
-      # @param [String] key cache key
-      # @return [true, false] true if has cached auth info, else false
-      def cache?(key)
-        auth_objects_cache.key? key
-      end
-
-      # Get the currently cached authentication object.
-      # @param [String] key cache key
-      # @return [Hash<String,String>, Nucleus::Adapters::AuthClient] cached authentication client
-      def cached(key)
-        return nil unless cache?(key)
-        auth_objects_cache[key]
-      end
-
-      # Create the cache key for the username / password combination and save it in the {::RequestStore} to make it
-      # available throughout the current request.
-      # @param [String] username the username for the authentication
-      # @param [String] password the password for the authentication
-      # @return [String] calculated hash key for the input values
-      def cache_key(username, password)
-        # calculate the cache only once per request
-        return RequestStore.store[:cache_key] if RequestStore.exist?(:cache_key)
-        key = Digest::SHA256.hexdigest "#{endpoint_url}#{username}:#{password}"
-        RequestStore.store[:cache_key] = key
-        key
-      end
-
-      # Get the cached authentication object and retrieve the presumably valid authentication header.
-      # @return [Hash<String,String>] hash including a valid authentication header
-      def headers
-        auth_object = auth_objects_cache[RequestStore.store[:cache_key]]
-        # AuthClient, generates the header for us
-        auth_object.auth_header
-      end
-
-      # Execute an API call, targeted directly against the vendors API.
-      # @param [Symbol] method http method to use, one of: [:GET, :POST, :DELETE, :PUT, :PATCH]
-      # @param [String] path url path to append to the endpoint's URL
-      # @param [Hash] params body params to use for PATCH, :PUT and :POST requests
-      # @return [Object] the actual response body of the vendor platform
-      def endpoint_call(method, path, params)
-        case method
-        when :GET
-          get(path, native_call: true).body
-        when :POST
-          post(path, native_call: true, body: params).body
-        when :DELETE
-          delete(path, native_call: true).body
-        when :PUT
-          put(path, native_call: true, body: params).body
-        when :PATCH
-          patch(path, native_call: true, body: params).body
-        else
-          fail AdapterRequestError, 'Unsupported adapter call method. Allowed are: GET, POST, PATCH, PUT, DELETE'
-        end
-      end
-
-      # Fail with a {Errors::PlatformSpecificSemanticError} error and format the error message to include the values
-      # that are passed in the params. Requires the adapter to provide a +semantic_error_messages+ method, which shall
-      # return a Hash with the platform specific semantic errors.
-      # @param [Symbol] error_name error that shall be returned
-      # @param [Array<String>] params values that are to be included in the error message template
-      # @raise [Errors::PlatformSpecificSemanticError]
-      def fail_with(error_name, params = nil)
-        unless respond_to?(:semantic_error_messages)
-          fail StandardError 'Invalid adapter implementation, no :semantic_error_messages method provided'
-        end
-        error = semantic_error_messages[error_name]
-        fail Errors::PlatformSpecificSemanticError.new(error[:message] % params, error[:code])
-      end
-    end
-  end
-end
+module Nucleus
+  # The {Adapters} module combines all application logic to communicate with the different vendor platforms
+  # and created the unified API.
+  module Adapters
+    # The {BaseAdapter} is an abstract class that shall be extended by all actual Adapters.
+    # It provides methods to common functionality:<br>
+    # * authentication (+cache)
+    # * http client with general error handling
+    # * native platform API calls
+    # @abstract
+    class BaseAdapter
+      include HttpClient
+      include HttpTailClient
+      include Logging
+
+      attr_reader :endpoint_url
+
+      def initialize(endpoint_url, endpoint_app_domain = nil, check_certificates = true)
+        raise ArgumentError, "'endpoint_url' must be a valid URL" unless endpoint_url =~ /\A#{URI.regexp(['https'])}\z/
+        @endpoint_url = endpoint_url
+        @endpoint_app_domain = endpoint_app_domain
+        @check_certificates = check_certificates
+      end
+
+      # thread-based cache for the api authorization headers
+      thread_config_accessor :auth_objects_cache, default: {}
+
+      # Cache the auth information.
+      # @param [String] key cache key
+      # @param [Nucleus::Adapters::AuthClient] auth_object authentication client to be cached
+      # @return [void]
+      def cache(key, auth_object)
+        auth_objects_cache[key] = auth_object
+      end
+
+      # Are there cached information for this key?
+      # @param [String] key cache key
+      # @return [true, false] true if has cached auth info, else false
+      def cache?(key)
+        auth_objects_cache.key? key
+      end
+
+      # Get the currently cached authentication object.
+      # @param [String] key cache key
+      # @return [Hash<String,String>, Nucleus::Adapters::AuthClient] cached authentication client
+      def cached(key)
+        return nil unless cache?(key)
+        auth_objects_cache[key]
+      end
+
+      # Create the cache key for the username / password combination and save it in the {::RequestStore} to make it
+      # available throughout the current request.
+      # @param [String] username the username for the authentication
+      # @param [String] password the password for the authentication
+      # @return [String] calculated hash key for the input values
+      def cache_key(username, password)
+        # calculate the cache only once per request
+        return RequestStore.store[:cache_key] if RequestStore.exist?(:cache_key)
+        key = Digest::SHA256.hexdigest "#{endpoint_url}#{username}:#{password}"
+        RequestStore.store[:cache_key] = key
+        key
+      end
+
+      # Get the cached authentication object and retrieve the presumably valid authentication header.
+      # @return [Hash<String,String>] hash including a valid authentication header
+      def headers
+        auth_object = auth_objects_cache[RequestStore.store[:cache_key]]
+        # AuthClient, generates the header for us
+        auth_object.auth_header
+      end
+
+      # Execute an API call, targeted directly against the vendors API.
+      # @param [Symbol] method http method to use, one of: [:GET, :POST, :DELETE, :PUT, :PATCH]
+      # @param [String] path url path to append to the endpoint's URL
+      # @param [Hash] params body params to use for PATCH, :PUT and :POST requests
+      # @return [Object] the actual response body of the vendor platform
+      def endpoint_call(method, path, params)
+        case method
+        when :GET
+          get(path, native_call: true).body
+        when :POST
+          post(path, native_call: true, body: params).body
+        when :DELETE
+          delete(path, native_call: true).body
+        when :PUT
+          put(path, native_call: true, body: params).body
+        when :PATCH
+          patch(path, native_call: true, body: params).body
+        else
+          raise AdapterRequestError, 'Unsupported adapter call method. Allowed are: GET, POST, PATCH, PUT, DELETE'
+        end
+      end
+
+      # Fail with a {Errors::PlatformSpecificSemanticError} error and format the error message to include the values
+      # that are passed in the params. Requires the adapter to provide a +semantic_error_messages+ method, which shall
+      # return a Hash with the platform specific semantic errors.
+      # @param [Symbol] error_name error that shall be returned
+      # @param [Array<String>] params values that are to be included in the error message template
+      # @raise [Errors::PlatformSpecificSemanticError]
+      def fail_with(error_name, params = nil)
+        unless respond_to?(:semantic_error_messages)
+          raise StandardError 'Invalid adapter implementation, no :semantic_error_messages method provided'
+        end
+        error = semantic_error_messages[error_name]
+        raise Errors::PlatformSpecificSemanticError.new(error[:message] % params, error[:code])
+      end
+    end
+  end
+end