nucleus 0.2.0 → 0.3.1

data/lib/nucleus/adapters/v1/cloud_foundry_v2/data.rb

@@ -1,97 +1,97 @@
-module Nucleus
-  module Adapters
-    module V1
-      class CloudFoundryV2 < Stub
-        module Data
-          # @see Stub#deploy
-          def deploy(application_name_or_id, file, file_compression_format)
-            # could be made async, too
-            # resources: [] says that no previous data shall be reused, see also:
-            # http://apidocs.cloudfoundry.org/202/apps/uploads_the_bits_for_an_app.html
-
-            app_guid = app_guid(application_name_or_id)
-            # deploy by guid
-            # deploy_response = put("/v2/apps/#{app_guid}/bits", body: { resources: [], application: file.read },
-            #                       headers: { 'Content-Type' => 'multipart/form-data; '\
-            #                       'boundary=nucleus-cloud-foundry-adapter-file-upload-boundary' })
-
-            begin
-              # convert all archives to .zip archives
-              converted_file = ArchiveConverter.convert(file, file_compression_format, 'zip', true)
-              unless converted_file.respond_to?(:path) && converted_file.respond_to?(:read)
-                tmpfile = Tempfile.new(["nucleus-cf-deploy-upload-#{app_guid}", '.zip'])
-                tmpfile.binmode
-                tmpfile.write converted_file.read
-                tmpfile.rewind
-                converted_file = tmpfile
-              end
-
-              # TODO: this is only a temporary solution until excon supports multipart requests
-              # See also: https://github.com/excon/excon/issues/353
-              url = "#{@endpoint_url}/v2/apps/#{app_guid}/bits"
-              request_body = { multipart: true, application: converted_file, async: false, resources: '[]' }
-              begin
-                RestClient::Request.execute(method: :put, url: url, payload: request_body,
-                                            headers: headers, verify_ssl: @check_certificates)
-              rescue RestClient::BadRequest => e
-                raise Errors::AdapterRequestError, e.http_body
-              end
-            ensure
-              if tmpfile
-                tmpfile.close
-                tmpfile.unlink # deletes this temporary file
-              end
-            end
-          end
-
-          # @see Stub#download
-          def download(application_name_or_id, compression_format)
-            app_guid = app_guid(application_name_or_id)
-            # fail if there is no deployment
-            unless deployed?(app_guid)
-              fail Errors::SemanticAdapterRequestError, 'Application must be deployed before data can be downloaded'
-            end
-
-            download_response = get("/v2/apps/#{app_guid}/download", follow_redirects: false, expects: [200, 302])
-            if download_response.status == 200
-              data = download_response.body
-            else
-              download_location = download_response.headers[:Location]
-              # if IBM f*cked with the download URL, fix the address
-              download_location = download_location.gsub(/objectstorage.service.networklayer.com/, 'objectstorage.softlayer.net')
-              # omit_default_port: https://github.com/excon/excon/issues/475
-              data = Excon.new(download_location, omit_default_port: true).get.body
-            end
-
-            # write data to tmpfile so that it can be converted
-            downloaded_application_archive = Tempfile.new(["nucleus-cf-deployment-download-#{app_guid}", '.zip'])
-            downloaded_application_archive.binmode
-            downloaded_application_archive.write StringIO.new(data).read
-            downloaded_application_archive.rewind
-
-            # convert from current format (which is always a zip archive) to the destination format
-            ArchiveConverter.convert(downloaded_application_archive, 'zip', compression_format, false)
-          ensure
-            if downloaded_application_archive
-              downloaded_application_archive.close
-              downloaded_application_archive.unlink
-            end
-          end
-
-          # @see Stub#rebuild
-          def rebuild(application_name_or_id)
-            app_guid = app_guid(application_name_or_id)
-            # fail if there is no deployment
-            unless deployed?(app_guid)
-              fail Errors::SemanticAdapterRequestError, 'Application must be deployed before it can be rebuild'
-            end
-
-            # rebuild by name or id
-            rebuild_response = post("/v2/apps/#{app_guid}/restage")
-            to_nucleus_app(rebuild_response.body)
-          end
-        end
-      end
-    end
-  end
-end
+module Nucleus
+  module Adapters
+    module V1
+      class CloudFoundryV2 < Stub
+        module Data
+          # @see Stub#deploy
+          def deploy(application_name_or_id, file, file_compression_format)
+            # could be made async, too
+            # resources: [] says that no previous data shall be reused, see also:
+            # http://apidocs.cloudfoundry.org/202/apps/uploads_the_bits_for_an_app.html
+
+            app_guid = app_guid(application_name_or_id)
+            # deploy by guid
+            # deploy_response = put("/v2/apps/#{app_guid}/bits", body: { resources: [], application: file.read },
+            #                       headers: { 'Content-Type' => 'multipart/form-data; '\
+            #                       'boundary=nucleus-cloud-foundry-adapter-file-upload-boundary' })
+
+            begin
+              # convert all archives to .zip archives
+              converted_file = ArchiveConverter.convert(file, file_compression_format, 'zip', true)
+              unless converted_file.respond_to?(:path) && converted_file.respond_to?(:read)
+                tmpfile = Tempfile.new(["nucleus-cf-deploy-upload-#{app_guid}", '.zip'])
+                tmpfile.binmode
+                tmpfile.write converted_file.read
+                tmpfile.rewind
+                converted_file = tmpfile
+              end
+
+              # TODO: this is only a temporary solution until excon supports multipart requests
+              # See also: https://github.com/excon/excon/issues/353
+              url = "#{@endpoint_url}/v2/apps/#{app_guid}/bits"
+              request_body = { multipart: true, application: converted_file, async: false, resources: '[]' }
+              begin
+                RestClient::Request.execute(method: :put, url: url, payload: request_body,
+                                            headers: headers, verify_ssl: @check_certificates)
+              rescue RestClient::BadRequest => e
+                raise Errors::AdapterRequestError, e.http_body
+              end
+            ensure
+              if tmpfile
+                tmpfile.close
+                tmpfile.unlink # deletes this temporary file
+              end
+            end
+          end
+
+          # @see Stub#download
+          def download(application_name_or_id, compression_format)
+            app_guid = app_guid(application_name_or_id)
+            # fail if there is no deployment
+            unless deployed?(app_guid)
+              raise Errors::SemanticAdapterRequestError, 'Application must be deployed before data can be downloaded'
+            end
+
+            download_response = get("/v2/apps/#{app_guid}/download", follow_redirects: false, expects: [200, 302])
+            if download_response.status == 200
+              data = download_response.body
+            else
+              download_location = download_response.headers[:Location]
+              # if IBM f*cked with the download URL, fix the address
+              download_location = download_location.gsub(/objectstorage.service.networklayer.com/, 'objectstorage.softlayer.net')
+              # omit_default_port: https://github.com/excon/excon/issues/475
+              data = Excon.new(download_location, omit_default_port: true).get.body
+            end
+
+            # write data to tmpfile so that it can be converted
+            downloaded_application_archive = Tempfile.new(["nucleus-cf-deployment-download-#{app_guid}", '.zip'])
+            downloaded_application_archive.binmode
+            downloaded_application_archive.write StringIO.new(data).read
+            downloaded_application_archive.rewind
+
+            # convert from current format (which is always a zip archive) to the destination format
+            ArchiveConverter.convert(downloaded_application_archive, 'zip', compression_format, false)
+          ensure
+            if downloaded_application_archive
+              downloaded_application_archive.close
+              downloaded_application_archive.unlink
+            end
+          end
+
+          # @see Stub#rebuild
+          def rebuild(application_name_or_id)
+            app_guid = app_guid(application_name_or_id)
+            # fail if there is no deployment
+            unless deployed?(app_guid)
+              raise Errors::SemanticAdapterRequestError, 'Application must be deployed before it can be rebuild'
+            end
+
+            # rebuild by name or id
+            rebuild_response = post("/v2/apps/#{app_guid}/restage")
+            to_nucleus_app(rebuild_response.body)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nucleus/adapters/v1/cloud_foundry_v2/domains.rb

@@ -29,8 +29,8 @@ module Nucleus
           def create_domain(application_name_or_id, domain)
             domains(application_name_or_id).each do |existing_domain|
               if existing_domain[:name] == domain[:name]
-                fail Errors::SemanticAdapterRequestError,
-                     "Domain '#{domain[:name]}' is already assigned to the application"
+                raise Errors::SemanticAdapterRequestError,
+                      "Domain '#{domain[:name]}' is already assigned to the application"
               end
             end
 
@@ -51,12 +51,12 @@ module Nucleus
             if delete_response.status == 400
               cf_error = delete_response.body[:code]
               if cf_error == 1002
-                fail Errors::AdapterResourceNotFoundError, 'Domain not found. '\
+                raise Errors::AdapterResourceNotFoundError, 'Domain not found. '\
                   'CF context specific: Route does not exist or is not assigned with this application'
               else
                 # delete failed with 400, but not due to invalid domain
-                fail Errors::AdapterRequestError,
-                     "#{delete_response.body[:description]} (#{cf_error} - #{delete_response.body[:error_code]})"
+                raise Errors::AdapterRequestError,
+                      "#{delete_response.body[:description]} (#{cf_error} - #{delete_response.body[:error_code]})"
               end
             end
 

data/lib/nucleus/adapters/v1/cloud_foundry_v2/lifecycle.rb

@@ -1,41 +1,41 @@
-module Nucleus
-  module Adapters
-    module V1
-      class CloudFoundryV2 < Stub
-        module Lifecycle
-          # @see Stub#start
-          def start(application_name_or_id)
-            app_guid = app_guid(application_name_or_id)
-            # fail if there is no deployment
-            unless deployed?(app_guid)
-              fail Errors::SemanticAdapterRequestError, 'Application must be deployed before it can be started'
-            end
-
-            # start by name or id
-            start_response = put("/v2/apps/#{app_guid}", body: { state: 'STARTED' })
-            to_nucleus_app(start_response.body)
-          end
-
-          # @see Stub#stop
-          def stop(application_name_or_id)
-            app_guid = app_guid(application_name_or_id)
-            # fail if there is no deployment
-            unless deployed?(app_guid)
-              fail Errors::SemanticAdapterRequestError, 'Application must be deployed before it can be stopped'
-            end
-
-            # stop by name or id
-            stop_response = put("/v2/apps/#{app_guid}", body: { state: 'STOPPED' })
-            to_nucleus_app(stop_response.body)
-          end
-
-          # @see Stub#restart
-          def restart(application_name_or_id)
-            stop(application_name_or_id)
-            start(application_name_or_id)
-          end
-        end
-      end
-    end
-  end
-end
+module Nucleus
+  module Adapters
+    module V1
+      class CloudFoundryV2 < Stub
+        module Lifecycle
+          # @see Stub#start
+          def start(application_name_or_id)
+            app_guid = app_guid(application_name_or_id)
+            # fail if there is no deployment
+            unless deployed?(app_guid)
+              raise Errors::SemanticAdapterRequestError, 'Application must be deployed before it can be started'
+            end
+
+            # start by name or id
+            start_response = put("/v2/apps/#{app_guid}", body: { state: 'STARTED' })
+            to_nucleus_app(start_response.body)
+          end
+
+          # @see Stub#stop
+          def stop(application_name_or_id)
+            app_guid = app_guid(application_name_or_id)
+            # fail if there is no deployment
+            unless deployed?(app_guid)
+              raise Errors::SemanticAdapterRequestError, 'Application must be deployed before it can be stopped'
+            end
+
+            # stop by name or id
+            stop_response = put("/v2/apps/#{app_guid}", body: { state: 'STOPPED' })
+            to_nucleus_app(stop_response.body)
+          end
+
+          # @see Stub#restart
+          def restart(application_name_or_id)
+            stop(application_name_or_id)
+            start(application_name_or_id)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nucleus/adapters/v1/cloud_foundry_v2/logs.rb

@@ -117,8 +117,8 @@ module Nucleus
               filter = nil
             else
               # invalid log requests --> 404
-              fail Errors::AdapterResourceNotFoundError,
-                   "Invalid log file '#{log_id}', not available for application '#{app_guid}'"
+              raise Errors::AdapterResourceNotFoundError,
+                    "Invalid log file '#{log_id}', not available for application '#{app_guid}'"
             end
             filter
           end
@@ -146,8 +146,8 @@ module Nucleus
             log_files = get("/v2/apps/#{app_guid}/instances/0/files/#{file_path}",
                             follow_redirects: false, expects: expected_statuses, headers: headers_to_use)
             if log_files.status == 400 || log_files.status == 404
-              fail Errors::AdapterResourceNotFoundError,
-                   "Invalid log file: '#{file_path}' not available for application '#{app_guid}'"
+              raise Errors::AdapterResourceNotFoundError,
+                    "Invalid log file: '#{file_path}' not available for application '#{app_guid}'"
             end
             return log_files.body if log_files.status == 200
 
@@ -162,8 +162,8 @@ module Nucleus
             downloaded_logfile_response = connection.request(method: :get, expects: expected_statuses)
 
             if downloaded_logfile_response.status == 404
-              fail Errors::AdapterResourceNotFoundError,
-                   "Invalid log file: '#{file_path}' not available for application '#{app_guid}'"
+              raise Errors::AdapterResourceNotFoundError,
+                    "Invalid log file: '#{file_path}' not available for application '#{app_guid}'"
             end
             downloaded_logfile_response.body
           end

data/lib/nucleus/adapters/v1/cloud_foundry_v2/regions.rb

@@ -1,33 +1,33 @@
-module Nucleus
-  module Adapters
-    module V1
-      class CloudFoundryV2 < Stub
-        module Regions
-          # @see Stub#regions
-          def regions
-            [default_region]
-          end
-
-          # @see Stub#region
-          def region(region_name)
-            unless region_name.casecmp('default') == 0
-              fail Errors::AdapterResourceNotFoundError, "Region '#{region_name}' does not exist at the endpoint"
-            end
-            default_region
-          end
-
-          private
-
-          def default_region
-            {
-              id: 'default',
-              description: 'Default region, Cloud Foundry does not support multi regions yet.',
-              created_at: Time.at(0).to_datetime,
-              updated_at: Time.at(0).to_datetime
-            }
-          end
-        end
-      end
-    end
-  end
-end
+module Nucleus
+  module Adapters
+    module V1
+      class CloudFoundryV2 < Stub
+        module Regions
+          # @see Stub#regions
+          def regions
+            [default_region]
+          end
+
+          # @see Stub#region
+          def region(region_name)
+            unless region_name.casecmp('default') == 0
+              raise Errors::AdapterResourceNotFoundError, "Region '#{region_name}' does not exist at the endpoint"
+            end
+            default_region
+          end
+
+          private
+
+          def default_region
+            {
+              id: 'default',
+              description: 'Default region, Cloud Foundry does not support multi regions yet.',
+              created_at: Time.at(0).to_datetime,
+              updated_at: Time.at(0).to_datetime
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nucleus/adapters/v1/cloud_foundry_v2/services.rb

@@ -46,8 +46,8 @@ module Nucleus
             service_guid = service_guid(service_id_or_name)
             cf_binding = binding(app_guid, service_guid)
             # make sure there is a binding
-            fail Errors::AdapterResourceNotFoundError,
-                 "No such service '#{service_id_or_name}' for application '#{application_name_or_id}'" unless cf_binding
+            raise Errors::AdapterResourceNotFoundError,
+                  "No such service '#{service_id_or_name}' for application '#{application_name_or_id}'" unless cf_binding
             to_nucleus_installed_service(cf_binding)
           end
 
@@ -138,8 +138,8 @@ module Nucleus
             services = get('/v2/services').body[:resources]
             # find a match and use the service's guid
             service_match = services.find { |service| service[:entity][:label] == service_id_or_name }
-            fail error_class,
-                 "Invalid service: Could not find service with name '#{service_id_or_name}'" unless service_match
+            raise error_class,
+                  "Invalid service: Could not find service with name '#{service_id_or_name}'" unless service_match
             service_match[:metadata][:guid]
           end
 
@@ -159,8 +159,8 @@ module Nucleus
             plans = get("/v2/services/#{service_id}/service_plans").body[:resources]
             # find a match and use the plan's guid
             plan_match = plans.find { |plan| plan[:entity][:name] == plan_name_or_id }
-            fail error_class,
-                 "Invalid plan: No such plan '#{plan_name_or_id}' for service '#{service_id}'" unless plan_match
+            raise error_class,
+                  "Invalid plan: No such plan '#{plan_name_or_id}' for service '#{service_id}'" unless plan_match
             plan_match[:metadata][:guid]
           end
 

data/lib/nucleus/adapters/v1/cloud_foundry_v2/vars.rb

@@ -1,80 +1,80 @@
-module Nucleus
-  module Adapters
-    module V1
-      class CloudFoundryV2 < Stub
-        module Vars
-          # @see Stub#env_vars
-          def env_vars(application_name_or_id)
-            app_guid = app_guid(application_name_or_id)
-            app_vars = get("/v2/apps/#{app_guid}/env").body[:environment_json]
-            formatted_vars = []
-            app_vars.each do |key, value|
-              formatted_vars.push(id: key, key: key, value: value)
-            end
-            formatted_vars
-          end
-
-          # @see Stub#env_var
-          def env_var(application_name_or_id, env_var_key)
-            app_guid = app_guid(application_name_or_id)
-            all_vars = get("/v2/apps/#{app_guid}/env").body[:environment_json]
-            fail Errors::AdapterResourceNotFoundError,
-                 "Env. var key '#{env_var_key}' does not exist" unless env_var?(app_guid, env_var_key, all_vars)
-            { id: env_var_key, key: env_var_key, value: all_vars[env_var_key.to_sym] }
-          end
-
-          # @see Stub#create_env_var
-          def create_env_var(application_name_or_id, env_var)
-            app_guid = app_guid(application_name_or_id)
-            fail Errors::SemanticAdapterRequestError,
-                 "Env. var key '#{env_var[:key]}' already taken" if env_var?(app_guid, env_var[:key])
-            set_var(app_guid, env_var[:key].to_sym, env_var[:value])
-          end
-
-          # @see Stub#update_env_var
-          def update_env_var(application_name_or_id, env_var_key, env_var)
-            app_guid = app_guid(application_name_or_id)
-            fail Errors::AdapterResourceNotFoundError,
-                 "Env. var key '#{env_var_key}' does not exist" unless env_var?(app_guid, env_var_key)
-            set_var(app_guid, env_var_key.to_sym, env_var[:value])
-          end
-
-          # @see Stub#delete_env_var
-          def delete_env_var(application_name_or_id, env_var_key)
-            app_guid = app_guid(application_name_or_id)
-            fail Errors::AdapterResourceNotFoundError,
-                 "Env. var key '#{env_var_key}' does not exist" unless env_var?(app_guid, env_var_key)
-            request_body = get("/v2/apps/#{app_guid}/env").body[:environment_json]
-            request_body.delete(env_var_key.to_sym)
-            put("/v2/apps/#{app_guid}", body: { environment_json: request_body }).body[:entity][:environment_json]
-          end
-
-          private
-
-          # Set the variable value (create or update) and include all already existing variables
-          # to protect them from being deleted.
-          # @param [String] app_guid GUID of the CF application
-          # @param [Symbol] key variable key name
-          # @param [String, Integer, Float, Double] value value to apply to the variable
-          # @return [Hash] Nucleus representation of the modified variable
-          def set_var(app_guid, key, value)
-            request_body = get("/v2/apps/#{app_guid}/env").body[:environment_json]
-            request_body[key] = value
-            vars = put("/v2/apps/#{app_guid}", body: { environment_json: request_body }).body[:entity]
-            { id: key, key: key, value: vars[:environment_json][key] }
-          end
-
-          # Checks if a variable with the env_var_key already exists.
-          # @param [String] app_guid GUID of the CF application
-          # @param [Symbol] env_var_key key name that shall be checked for existence
-          # @param [Hash] all_vars collection of currently existing variables for the application
-          # @return [Boolean] true if there is a variable with the env_var_key, otherwise false
-          def env_var?(app_guid, env_var_key, all_vars = nil)
-            all_vars = get("/v2/apps/#{app_guid}/env").body[:environment_json] if all_vars.nil?
-            all_vars.key? env_var_key.to_sym
-          end
-        end
-      end
-    end
-  end
-end
+module Nucleus
+  module Adapters
+    module V1
+      class CloudFoundryV2 < Stub
+        module Vars
+          # @see Stub#env_vars
+          def env_vars(application_name_or_id)
+            app_guid = app_guid(application_name_or_id)
+            app_vars = get("/v2/apps/#{app_guid}/env").body[:environment_json]
+            formatted_vars = []
+            app_vars.each do |key, value|
+              formatted_vars.push(id: key, key: key, value: value)
+            end
+            formatted_vars
+          end
+
+          # @see Stub#env_var
+          def env_var(application_name_or_id, env_var_key)
+            app_guid = app_guid(application_name_or_id)
+            all_vars = get("/v2/apps/#{app_guid}/env").body[:environment_json]
+            raise Errors::AdapterResourceNotFoundError,
+                  "Env. var key '#{env_var_key}' does not exist" unless env_var?(app_guid, env_var_key, all_vars)
+            { id: env_var_key, key: env_var_key, value: all_vars[env_var_key.to_sym] }
+          end
+
+          # @see Stub#create_env_var
+          def create_env_var(application_name_or_id, env_var)
+            app_guid = app_guid(application_name_or_id)
+            raise Errors::SemanticAdapterRequestError,
+                  "Env. var key '#{env_var[:key]}' already taken" if env_var?(app_guid, env_var[:key])
+            set_var(app_guid, env_var[:key].to_sym, env_var[:value])
+          end
+
+          # @see Stub#update_env_var
+          def update_env_var(application_name_or_id, env_var_key, env_var)
+            app_guid = app_guid(application_name_or_id)
+            raise Errors::AdapterResourceNotFoundError,
+                  "Env. var key '#{env_var_key}' does not exist" unless env_var?(app_guid, env_var_key)
+            set_var(app_guid, env_var_key.to_sym, env_var[:value])
+          end
+
+          # @see Stub#delete_env_var
+          def delete_env_var(application_name_or_id, env_var_key)
+            app_guid = app_guid(application_name_or_id)
+            raise Errors::AdapterResourceNotFoundError,
+                  "Env. var key '#{env_var_key}' does not exist" unless env_var?(app_guid, env_var_key)
+            request_body = get("/v2/apps/#{app_guid}/env").body[:environment_json]
+            request_body.delete(env_var_key.to_sym)
+            put("/v2/apps/#{app_guid}", body: { environment_json: request_body }).body[:entity][:environment_json]
+          end
+
+          private
+
+          # Set the variable value (create or update) and include all already existing variables
+          # to protect them from being deleted.
+          # @param [String] app_guid GUID of the CF application
+          # @param [Symbol] key variable key name
+          # @param [String, Integer, Float, Double] value value to apply to the variable
+          # @return [Hash] Nucleus representation of the modified variable
+          def set_var(app_guid, key, value)
+            request_body = get("/v2/apps/#{app_guid}/env").body[:environment_json]
+            request_body[key] = value
+            vars = put("/v2/apps/#{app_guid}", body: { environment_json: request_body }).body[:entity]
+            { id: key, key: key, value: vars[:environment_json][key] }
+          end
+
+          # Checks if a variable with the env_var_key already exists.
+          # @param [String] app_guid GUID of the CF application
+          # @param [Symbol] env_var_key key name that shall be checked for existence
+          # @param [Hash] all_vars collection of currently existing variables for the application
+          # @return [Boolean] true if there is a variable with the env_var_key, otherwise false
+          def env_var?(app_guid, env_var_key, all_vars = nil)
+            all_vars = get("/v2/apps/#{app_guid}/env").body[:environment_json] if all_vars.nil?
+            all_vars.key? env_var_key.to_sym
+          end
+        end
+      end
+    end
+  end
+end