bubbles-rest-client 0.3.1 → 0.7.0

data/lib/bubbles/rest_client_resources.rb

@@ -3,28 +3,27 @@ require 'bubbles/rest_environment'
 
 module Bubbles
   class RestClientResources
-    def environment
-      Bubbles.configuration.environment
+    def environment(env_name = nil)
+      Bubbles.configuration.environment(env_name)
     end
 
     ##
     # Create a new instance of +RestClientResources+.
     #
     # @param env The +RestEnvironment+ that should be used for this set of resources.
-    # @param api_key The API key to use to send to the host for unauthenticated requests.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
     #
-    def initialize(env, api_key)
-      unless env
-        env = :local
-      end
-
+    def initialize(env, api_key = nil, api_key_name='X-API-Key')
       unless api_key
         api_key = ''
       end
 
-      @environment = get_environment env
       @api_key = api_key
       @auth_token = nil
+      @api_key_name = api_key_name
     end
 
     ##
@@ -32,17 +31,16 @@ module Bubbles
     #
     # @param [RestEnvironment] env The +RestEnvironment+ to use to execute the request
     # @param [Endpoint] endpoint The +Endpoint+ which should be requested
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the GET call.
     #
-    def self.execute_get_unauthenticated(env, endpoint)
-      execute_rest_call(env, endpoint, nil, nil, nil) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .get(headers)
-        else
-          next RestClient.get(url.to_s, headers)
-        end
+    def self.execute_get_unauthenticated(env, endpoint, uri_params, additional_headers = {}, api_key = nil, api_key_name='X-API-Key')
+      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+
+      execute_rest_call(env, endpoint, nil, nil, composite_headers, uri_params) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).get(headers)
       end
     end
 
@@ -53,19 +51,30 @@ module Bubbles
     #
     # @param [RestEnvironment] env The +RestEnvironment+ to use to execute the request
     # @param [Endpoint] endpoint The +Endpoint+ which should be requested
-    # @param [String] auth_token The authorization token to use for authentication.
+    # @param [Symbol] auth_type The authorization type to use (Bearer, or Basic)
+    # @param [String] auth_value The authorization token OR encoded value (login/password )to use for authentication.
     # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the GET call.
     #
-    def self.execute_get_authenticated(env, endpoint, auth_token, uri_params)
-      execute_rest_call(env, endpoint, nil, auth_token, nil, uri_params) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .get(headers)
-        else
-          next RestClient.get(url.to_s, headers)
-        end
+    def self.execute_get_authenticated(env, endpoint, auth_type, auth_value, uri_params, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      if auth_type == :basic
+        composite_headers = RestClientResources.build_composite_headers(endpoint.additional_headers, {
+          Authorization: 'Basic ' + Base64.strict_encode64(auth_value)
+        })
+        auth_value = nil
+      else
+        composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+      end
+
+      execute_rest_call(env, endpoint, nil, auth_value, composite_headers, uri_params) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).get(headers)
       end
     end
 
@@ -76,17 +85,21 @@ module Bubbles
     #
     # @param [RestEnvironment] env The +RestEnvironment+ to use to execute the request
     # @param [Endpoint] endpoint The +Endpoint+ which should be requested
+    # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the GET call.
     #
-    def self.execute_head_unauthenticated(env, endpoint, uri_params, additional_headers)
-      execute_rest_call(env, endpoint, nil, nil, additional_headers, uri_params) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .head(headers)
-        else
-          next RestClient.head(url.to_s, headers)
-        end
+    def self.execute_head_unauthenticated(env, endpoint, uri_params, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+
+      execute_rest_call(env, endpoint, nil, nil, composite_headers, uri_params) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).head(headers)
       end
     end
 
@@ -100,49 +113,20 @@ module Bubbles
     # @param [Endpoint] endpoint The +Endpoint+ which should be requested
     # @param [String] auth_token The authorization token to use for authentication.
     # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the HEAD call.
     #
-    def self.execute_head_authenticated(env, endpoint, auth_token, uri_params)
-      execute_rest_call(env, endpoint, nil, auth_token, nil, uri_params) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .head(headers)
-        else
-          next RestClient.head(url.to_s, headers)
-        end
-      end
-    end
-
-    ##
-    # Execute a HEAD request without authentication but with some parameters encoded in the URI string.
-    #
-    # @param [RestEnvironment] env The +RestEnvironment+ to use to execute the request
-    # @param [Endpoint] endpoint The +Endpoint+ which should be requested
-    # @param [String] api_key The API key to use to validate the client.
-    # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
-    # @param [Hash] headers An optional +Hash+ of additional headers to pass with the request.
-    #
-    # @return [RestClient::Response] The +Response+ resulting from the execution of the HEAD call.
-    #
-    def self.execute_head_unauthenticated_with_uri_params(env, endpoint, api_key, uri_params, headers=nil)
-      additional_headers = {
-          'X-Api-Key' => api_key
-      }
+    def self.execute_head_authenticated(env, endpoint, auth_token, uri_params, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
 
-      unless headers.nil?
-        headers.each { |nextHeader|
-          additional_headers[nextHeader[0]] = nextHeader[1]
-        }
-      end
-
-      execute_rest_call(env, endpoint, nil, nil, additional_headers, uri_params) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .head(headers)
-        else
-          next RestClient.head(url.to_s, headers)
-        end
+      execute_rest_call(env, endpoint, nil, auth_token, composite_headers, uri_params) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).head(headers)
       end
     end
 
@@ -153,29 +137,20 @@ module Bubbles
     # @param [Endpoint] endpoint The +Endpoint+ which should be requested
     # @param [String] api_key The API key to use to process the request. Will be placed in an 'X-API-KEY' header.
     # @param [Hash] data A +Hash+ of key-value pairs that will be sent in the body of the http request.
-    # @param [Hash] headers (Optional) A +Hash+ of key-value pairs that will be sent as HTTP headers as part of the
-    #        request. Defaults to +nil+.
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the POST call.
     #
-    def self.execute_post_with_api_key(env, endpoint, api_key, data, headers=nil)
-      additional_headers = {
-        'X-Api-Key' => api_key
-      }
+    def self.execute_post_unauthenticated(env, endpoint, data, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
 
-      unless headers.nil?
-        headers.each { |nextHeader|
-          additional_headers[nextHeader[0]] = nextHeader[1]
-        }
-      end
-
-      execute_rest_call(env, endpoint, data, nil, additional_headers) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .post(data.to_json, additional_headers)
-        else
-          next RestClient.post url.to_s, data.to_json, additional_headers
-        end
+      execute_rest_call(env, endpoint, data, nil, composite_headers) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).post(data.to_json, headers)
       end
     end
 
@@ -187,18 +162,27 @@ module Bubbles
     # @param [String] auth_token The authorization token retrieved during some former authentication call. Will be
     #        placed into a Authorization header.
     # @param [Hash] data A +Hash+ of key-value pairs that will be sent in the body of the http request.
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the POST call.
     #
-    def self.execute_post_authenticated(env, endpoint, auth_token, data)
-      return execute_rest_call(env, endpoint, data, auth_token, nil) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .post(data.to_json, headers)
+    def self.execute_post_authenticated(env, endpoint, auth_type, auth_value, data, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      if auth_type == :basic
+        composite_headers = RestClientResources.build_composite_headers(endpoint.additional_headers, {
+          Authorization: 'Basic ' + Base64.strict_encode64(auth_value)
+        })
+        auth_value = nil
+      else
+        composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+      end
 
-        else
-          next RestClient.post(url.to_s, data.to_json, headers)
-        end
+      execute_rest_call(env, endpoint, data, auth_value, composite_headers) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).post(data.to_json, headers)
       end
     end
 
@@ -211,18 +195,20 @@ module Bubbles
     #        placed into a Authorization header.
     # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
     # @param [Hash] data A +Hash+ of key-value pairs that will be sent in the body of the http request.
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the PATCH call.
     #
-    def self.execute_patch_authenticated(env, endpoint, auth_token, uri_params, data)
-      return execute_rest_call(env, endpoint, data, auth_token, nil, uri_params) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .patch(data.to_json, headers)
+    def self.execute_patch_authenticated(env, endpoint, auth_token, uri_params, data, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
 
-        else
-          next RestClient.patch(url.to_s, data.to_json, headers)
-        end
+      return execute_rest_call(env, endpoint, data, auth_token, composite_headers, uri_params) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).patch(data.to_json, headers)
       end
     end
 
@@ -233,17 +219,20 @@ module Bubbles
     # @param [Endpoint] endpoint The +Endpoint+ which should be requested
     # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
     # @param [Hash] data A +Hash+ of key-value pairs that will be sent in the body of the http request.
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the PATCH call.
     #
-    def self.execute_patch_unauthenticated(env, endpoint, uri_params, data)
-      return execute_rest_call(env, endpoint, data, nil, nil, uri_params) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .patch(data.to_json, headers)
-        else
-          next RestClient.patch(url.to_s, data.to_json, headers)
-        end
+    def self.execute_patch_unauthenticated(env, endpoint, uri_params, data, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+
+      return execute_rest_call(env, endpoint, data, nil, composite_headers, uri_params) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).patch(data.to_json, headers)
       end
     end
 
@@ -256,18 +245,20 @@ module Bubbles
     #        placed into a Authorization header.
     # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
     # @param [Hash] data A +Hash+ of key-value pairs that will be sent in the body of the http request.
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the PUT call.
     #
-    def self.execute_put_authenticated(env, endpoint, auth_token, uri_params, data)
-      return execute_rest_call(env, endpoint, data, auth_token, nil, uri_params) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .put(data.to_json, headers)
+    def self.execute_put_authenticated(env, endpoint, auth_token, uri_params, data, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
 
-        else
-          next RestClient.put(url.to_s, data.to_json, headers)
-        end
+      return execute_rest_call(env, endpoint, data, auth_token, composite_headers, uri_params) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).put(data.to_json, headers)
       end
     end
 
@@ -278,17 +269,20 @@ module Bubbles
     # @param [Endpoint] endpoint The +Endpoint+ which should be requested
     # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
     # @param [Hash] data A +Hash+ of key-value pairs that will be sent in the body of the http request.
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the PUT call.
     #
-    def self.execute_put_unauthenticated(env, endpoint, uri_params, data)
-      return execute_rest_call(env, endpoint, data, nil, nil, uri_params) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .put(data.to_json, headers)
-        else
-          next RestClient.put(url.to_s, data.to_json, headers)
-        end
+    def self.execute_put_unauthenticated(env, endpoint, uri_params, data, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+
+      return execute_rest_call(env, endpoint, data, nil, composite_headers, uri_params) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).put(data.to_json, headers)
       end
     end
 
@@ -300,17 +294,43 @@ module Bubbles
     # @param [String] auth_token The authorization token retrieved during some former authentication call. Will be
     #        placed into a Authorization header.
     # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the DELETE call.
     #
-    def self.execute_delete_authenticated(env, endpoint, auth_token, uri_params)
-      execute_rest_call(env, endpoint, nil, auth_token, nil, uri_params) do |env, url, data, headers|
-        if env.scheme == 'https'
-          next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-            .delete(headers)
-        else
-          next RestClient.delete(url.to_s, headers)
-        end
+    def self.execute_delete_authenticated(env, endpoint, auth_token, uri_params, additional_headers = {}, api_key = nil, api_key_name = 'X-API-Key')
+      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+
+      execute_rest_call(env, endpoint, nil, auth_token, composite_headers, uri_params) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).delete(headers)
+      end
+    end
+
+    ##
+    # Execute a DELETE request without authentication.
+    #
+    # @param [RestEnvironment] env The +RestEnvironment+ to use to execute the request
+    # @param [Endpoint] endpoint The +Endpoint+ which should be requested
+    # @param [Hash] uri_params A +Hash+ of identifiers to values to replace in the URI string.
+    # @param [Hash] additional_headers A +Hash+ of key-value pairs that will be sent as additional headers in the API
+    #        call. Defaults to an empty +Hash+.
+    # @param [String] api_key (Optional) The API key to use to send to the host for unauthenticated requests. Defaults
+    #        to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header in which to send the API key. Defaults to
+    #        +"X-API-Key"+.
+    #
+    # @return [RestClient::Response] The +Response+ resulting from the execution of the DELETE call.
+    #
+    def self.execute_delete_unauthenticated(env, endpoint, uri_params, additional_headers = {}, api_key = nil, api_key_name = 'X-Api-Key')
+      composite_headers = self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers)
+
+      execute_rest_call(env, endpoint, nil, nil, composite_headers, uri_params) do |env, url, data, headers|
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).delete(headers)
       end
     end
 
@@ -333,8 +353,81 @@ module Bubbles
     #   self.local_environment
     # end
 
+    ##
+    # Build a set of headers from two existing sets.
+    #
+    # This takes two sets of headers, as +Hash+es and merges them to create a single +Hash+ with all of the members of
+    # the previous two.
+    #
+    # @param [Hash] headers A set of existing headers.
+    # @param [Hash] additional_headers Another set of headers
+    #
+    # @return A +Hash+ containing all of the members of the input parameters. Key conflicts will be resolved to the
+    #         benefit of +additional_headers+, meaning that whatever is in the value of the key within the
+    #         +additional_headers+ +Hash+ will be used.
+    #
+    def self.build_composite_headers(headers, additional_headers)
+      composite_headers = headers
+
+      unless additional_headers.empty?
+        additional_headers.each { |nextHeader|
+          composite_headers[nextHeader[0]] = nextHeader[1]
+        }
+      end
+
+      composite_headers
+    end
+
+    ##
+    # Retrieve an encoded authorization (username and password) for a given
+    # +Endpoint+ and data set.
+    #
+    # @param endpoint The +Endpoint+ that this authorization will be used for.
+    # @param data A set of elements (typically username and password) that
+    #        should be encoded.
+    #
+    # @return A +String+ containing an encoding of the values passed in as
+    #         +data+, concatenated with a colon.
+    #
+    def self.get_encoded_authorization(endpoint, data)
+      count = 0
+      auth_value = ''
+      endpoint.encode_authorization.each { |auth_key|
+        if data[auth_key]
+          if count > 0
+            auth_value = auth_value + ':' + data[auth_key]
+          else
+            auth_value = data[auth_key]
+          end
+
+          count = count + 1
+
+          data.delete(auth_key)
+        end
+      }
+
+      auth_value
+    end
+
     private
 
+    def self.get_headers_with_api_key(endpoint, api_key, api_key_name, additional_headers = {})
+      if api_key and endpoint.api_key_required?
+        composite_headers = RestClientResources.build_composite_headers(additional_headers, {
+            api_key_name.to_s => api_key,
+            :content_type => :json,
+            :accept => :json
+        })
+      else
+        composite_headers = RestClientResources.build_composite_headers(additional_headers, {
+            :content_type => :json,
+            :accept => :json
+        })
+      end
+
+      composite_headers
+    end
+
     ##
     # Execute a REST call to the API.
     #
@@ -354,8 +447,12 @@ module Bubbles
     #         will return an +OpenStruct+; otherwise, the +Response+ will be returned.
     #
     def self.execute_rest_call(env, endpoint, data, auth_token, headers, uri_params = {}, &block)
+      unless headers
+        raise ArgumentError.new('Expected headers to be non-nil')
+      end
+
       unless block
-        raise ArgumentError('This method requires that a block is given.')
+        raise ArgumentError.new('This method requires that a block is given')
       end
 
       url = endpoint.get_expanded_url env, uri_params
@@ -365,23 +462,19 @@ module Bubbles
           data = {}
         end
 
-        if headers == nil
-          headers = {
-            :content_type => :json
-          }
-        else
-          headers[:content_type] = :json
-        end
-
         unless auth_token == nil
           headers[:authorization] = 'Bearer ' + auth_token
         end
 
-        headers[:accept] = :json
-
         response = block.call(env, url, data, headers)
-      rescue Errno::ECONNREFUSED
+
+      rescue *[SocketError, Errno::ECONNREFUSED]
         response = { :error => 'Unable to connect to host ' + env.host.to_s + ':' + env.port.to_s }.to_json
+        if endpoint.return_type == :body_as_object
+          response = JSON.parse(response, object_class: OpenStruct)
+        end
+
+        return response
       end
 
       if endpoint.return_type == :body_as_object and endpoint.method != :head
@@ -393,4 +486,4 @@ module Bubbles
       response
     end
   end
-end
+end

data/lib/bubbles/rest_environment.rb

@@ -1,6 +1,6 @@
 module Bubbles
   class RestEnvironment
-    attr_accessor :scheme, :host, :port, :api_key
+    attr_accessor :host, :port, :api_key, :api_key_name
 
     ##
     # Construct a new instance of +RestEnvironment+.
@@ -9,17 +9,59 @@ module Bubbles
     # @param [String] host The host to communicate with.
     # @param [Integer] port The port on which the communication channel should operate.
     # @param [String] api_key (Optional) The API key to use to identify your client with the API. Defaults to +nil+.
+    # @param [String] api_key_name (Optional) The name of the header that will specify the API key. Defaults to +"X-API-Key"+.
     #
-    def initialize(scheme='https', host='api.foamfactory.com', port=443, api_key=nil)
+    def initialize(scheme='https', host='api.foamfactory.com', port=443, api_key=nil, api_key_name='X-API-Key')
       @scheme = scheme
       @port = port
 
-      if @scheme == 'http' && @port == 443
+      if @scheme == 'http' && @port == nil
         @port = 80
+      elsif @scheme == 'https' && @port == nil
+        @port = 443
       end
 
       @host = host
       @api_key = api_key
+      @api_key_name = api_key_name
+    end
+
+    ##
+    # Retrieve the name of the API key to be used.
+    #
+    # This will be the "key" portion of the key-value of the API key header.
+    #
+    # @return [String] The API key name, if set; "X-API-Key", otherwise.
+    #
+    def api_key_name
+      @api_key_name
+    end
+
+    ##
+    # Retrieve an API key from this +RestEnvironment+, but only if a specific +Endpoint+ requires it.
+    #
+    # If an +Endpoint+ has +api_key_required+ set to +true+, this method will return the API for the current
+    # +RestEnvironment+. If not, then it will return +nil+, rather than just blindly returning the API key for every
+    # possible retrieval, even if the +Endpoint+ doesn't require it.
+    #
+    # @return [String] The API key for this +RestEnvironment+, if the specified +Endpoint+ requires it; +nil+,
+    #         otherwise.
+    #
+    def get_api_key_if_needed(endpoint)
+      if endpoint.api_key_required?
+        @api_key
+      else
+        nil
+      end
+    end
+
+    ##
+    # Retrieve the scheme of the current +RestEnvironment+, as a +Symbol+.
+    #
+    # @return [Symbol] The scheme of the current +RestEnvironment+, as a +Symbol+.
+    #
+    def scheme
+      @scheme.to_s
     end
   end
 end

data/lib/bubbles/version.rb

@@ -7,7 +7,7 @@ module Bubbles
     end
 
     def self.version_name
-      '0.3.1'
+      '0.7.0'
     end
 
     def self.version_code

data/lib/bubbles.rb

@@ -10,11 +10,9 @@ require 'json'
 
 module Bubbles
   class Resources < RestClientResources
-    def initialize
-    # def initialize(env, api_key)
-      # @environment = get_environment env
-      # @api_key = api_key
-      # @auth_token = nil
+    def initialize(api_key='')
+      super
+
       @packageName = Bubbles::VersionInformation.package_name
       @versionName = Bubbles::VersionInformation.version_name
       @versionCode = Bubbles::VersionInformation.version_code
@@ -29,4 +27,3 @@ module Bubbles
     end
   end
 end
-