bubbles-rest-client 0.4.1 → 0.5.0

data/bubbles.gemspec

@@ -40,6 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock", "~> 3.5"
   spec.add_development_dependency "vcr", "~> 3.0"
   spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "os"
   spec.add_dependency "addressable", "~> 2.5"
   spec.add_dependency "rest-client", "~> 2.0"
-end
+end

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
-

data/lib/bubbles/config.rb

@@ -43,6 +43,7 @@ module Bubbles
       @environment_host = '127.0.0.1'
       @environment_port = '1234'
       @environment_api_key = nil
+      @environment_api_key_name = 'X-API-Key'
 
       @endpoints = Hash.new
     end
@@ -53,7 +54,8 @@ module Bubbles
     # Note that this constructs a new +RestEnvironment+ and returns it, rather than returning an existing object.
     #
     def environment
-      RestEnvironment.new(@environment_scheme, @environment_host, @environment_port, @environment_api_key)
+      RestEnvironment.new(@environment_scheme, @environment_host, @environment_port, @environment_api_key,
+                          @environment_api_key_name)
     end
 
     ##
@@ -66,7 +68,9 @@ module Bubbles
     #      config.environment = {
     #         :scheme => 'https',
     #         :host => 'stage.api.somehost.com',
-    #         :port => '443'
+    #         :port => '443',
+    #         :api_key => 'something',
+    #         :api_key_name => 'X-API-Key' # Optional
     #      }
     #    end
     #
@@ -75,6 +79,11 @@ module Bubbles
       @environment_host = env[:host]
       @environment_port = env[:port]
       @environment_api_key = env[:api_key]
+      if env.has_key? :api_key_name
+        @environment_api_key_name = env[:api_key_name]
+      else
+        @environment_api_key_name = 'X-API-Key'
+      end
     end
 
     ##
@@ -129,18 +138,24 @@ module Bubbles
             Bubbles::RestEnvironment.class_exec do
               if endpoint.has_uri_params?
                 define_method(endpoint_name_as_sym) do |auth_token, uri_params|
-                  RestClientResources.execute_get_authenticated self, endpoint, auth_token, uri_params, endpoint.additional_headers
+                  RestClientResources.execute_get_authenticated self, endpoint, auth_token, uri_params, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               else
                 define_method(endpoint_name_as_sym) do |auth_token|
-                  RestClientResources.execute_get_authenticated self, endpoint, auth_token,{}, endpoint.additional_headers
+                  RestClientResources.execute_get_authenticated self, endpoint, auth_token, {}, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               end
             end
           else
             Bubbles::RestEnvironment.class_exec do
-              define_method(endpoint_name_as_sym) do
-                RestClientResources.execute_get_unauthenticated self, endpoint, endpoint.additional_headers
+              if endpoint.has_uri_params?
+                define_method(endpoint_name_as_sym) do |uri_params|
+                  RestClientResources.execute_get_unauthenticated self, endpoint, uri_params, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
+                end
+              else
+                define_method(endpoint_name_as_sym) do
+                  RestClientResources.execute_get_unauthenticated self, endpoint, {}, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
+                end
               end
             end
           end
@@ -148,79 +163,56 @@ module Bubbles
           if endpoint.authenticated?
             Bubbles::RestEnvironment.class_exec do
               define_method(endpoint_name_as_sym) do |auth_token, data|
-                RestClientResources.execute_post_authenticated self, endpoint, auth_token, data, endpoint.additional_headers
+                RestClientResources.execute_post_authenticated self, endpoint, auth_token, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
               end
             end
           else
-            if endpoint.api_key_required?
-              Bubbles::RestEnvironment.class_exec do
-                define_method(endpoint_name_as_sym) do |data|
-                  additional_headers = endpoint.additional_headers
-                  if endpoint.encode_authorization_header?
-                    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
-                    }
-
-                    additional_headers[:Authorization] = 'Basic ' + Base64.strict_encode64(auth_value)
-                  end
-
-                  RestClientResources.execute_post_with_api_key self, endpoint, self.api_key, data, additional_headers
+            Bubbles::RestEnvironment.class_exec do
+              define_method(endpoint_name_as_sym) do |data|
+                composite_headers = endpoint.additional_headers
+                if endpoint.encode_authorization_header?
+                  auth_value = RestClientResources.get_encoded_authorization(endpoint, data)
+                  composite_headers = RestClientResources.build_composite_headers(endpoint.additional_headers, {
+                    :Authorization => 'Basic ' + Base64.strict_encode64(auth_value)
+                  })
                 end
+
+                RestClientResources.execute_post_unauthenticated self, endpoint, data, composite_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
               end
-            else
-              raise 'Unauthenticated POST requests without an API key are not allowed'
             end
           end
         elsif endpoint.method == :delete
-          if endpoint.authenticated?
-            Bubbles::RestEnvironment.class_exec do
-              if endpoint.has_uri_params?
+          if endpoint.has_uri_params?
+            if endpoint.authenticated?
+              Bubbles::RestEnvironment.class_exec do
                 define_method(endpoint_name_as_sym) do |auth_token, uri_params|
-                  RestClientResources.execute_delete_authenticated self, endpoint, auth_token, uri_params, endpoint.additional_headers
+                  RestClientResources.execute_delete_authenticated self, endpoint, auth_token, uri_params, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
+                end
+              end
+            else
+              Bubbles::RestEnvironment.class_exec do
+                define_method(endpoint_name_as_sym) do |uri_params|
+                  RestClientResources.execute_delete_unauthenticated self, endpoint, uri_params, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
-              else
-                # NOTE: While MDN states that DELETE requests with a body are allowed, it seems that a number of
-                # documentation sites discourage its use. Thus, it's possible that, depending on the server API
-                # framework, the DELETE request could be rejected. As such, we're disallowing it here, BUT if we
-                # get feedback from users that it should be supported, we can add support for it.
-                raise 'DELETE requests without URI parameters are not allowed'
-              #   define_method(endpoint_name_as_sym) do |auth_token|
-              #     RestClientResources.execute_delete_authenticated self, endpoint, auth_token, {}
-              #   end
               end
             end
           else
-            raise 'Unauthenticated DELETE requests are not allowed'
-            # Bubbles::RestEnvironment.class_exec do
-              # define_method(endpoint_name_as_sym) do
-              #   RestClientResources.execute_delete_unauthenticated self, endpoint
-              # end
-            # end
+            # XXX_jwir3: While MDN states that DELETE requests with a body are allowed, it seems that a number of
+            # documentation sites discourage its use. Thus, it's possible that, depending on the server API
+            # framework, the DELETE request could be rejected. In addition, RestClient doesn't seem to support DELETE
+            # requests with a body, so we're a bit stuck on this one, even if we wanted to support it.
+            raise 'DELETE requests without URI parameters are not allowed'
           end
         elsif endpoint.method == :patch
           if endpoint.authenticated?
             Bubbles::RestEnvironment.class_exec do
               if endpoint.has_uri_params?
                 define_method(endpoint_name_as_sym) do |auth_token, uri_params, data|
-                  RestClientResources.execute_patch_authenticated self, endpoint, auth_token, uri_params, data, endpoint.additional_headers
+                  RestClientResources.execute_patch_authenticated self, endpoint, auth_token, uri_params, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               else
                 define_method(endpoint_name_as_sym) do |auth_token, data|
-                  # TODO: Nothing tests this case. We need something to test this case or we run the risk of
-                  #       it having bugs (uri_params was nil previously!)
-                  RestClientResources.execute_patch_authenticated self, endpoint, auth_token, {}, data, endpoint.additional_headers
+                  RestClientResources.execute_patch_authenticated self, endpoint, auth_token, {}, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               end
             end
@@ -228,11 +220,11 @@ module Bubbles
             Bubbles::RestEnvironment.class_exec do
               if endpoint.has_uri_params?
                 define_method(endpoint_name_as_sym) do |uri_params, data|
-                  RestClientResources.execute_patch_unauthenticated self, endpoint, uri_params, data, endpoint.additional_headers
+                  RestClientResources.execute_patch_unauthenticated self, endpoint, uri_params, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               else
                 define_method(endpoint_name_as_sym) do |data|
-                  RestClientResources.execute_patch_unauthenticated self, endpoint, {}, data, endpoint.additional_headers
+                  RestClientResources.execute_patch_unauthenticated self, endpoint, {}, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               end
             end
@@ -242,26 +234,23 @@ module Bubbles
             Bubbles::RestEnvironment.class_exec do
               if endpoint.has_uri_params?
                 define_method(endpoint_name_as_sym) do |auth_token, uri_params, data|
-                  RestClientResources.execute_put_authenticated self, endpoint, auth_token, uri_params, data, endpoint.additional_headers
+                  RestClientResources.execute_put_authenticated self, endpoint, auth_token, uri_params, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               else
                 define_method(endpoint_name_as_sym) do |auth_token, data|
-                  # TODO: Nothing tests this case. We need something to test this case or we run the risk of
-                  #       it having bugs (uri_params was nil previously!)
-                  RestClientResources.execute_put_authenticated self, endpoint, auth_token, {}, data, endpoint.additional_headers
+                  RestClientResources.execute_put_authenticated self, endpoint, auth_token, {}, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               end
             end
           else
-            # raise 'Unauthenticated PUT requests are not implemented'
             Bubbles::RestEnvironment.class_exec do
               if endpoint.has_uri_params?
                 define_method(endpoint_name_as_sym) do |uri_params, data|
-                  RestClientResources.execute_put_unauthenticated self, endpoint, uri_params, data, endpoint.additional_headers
+                  RestClientResources.execute_put_unauthenticated self, endpoint, uri_params, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               else
                 define_method(endpoint_name_as_sym) do |data|
-                  RestClientResources.execute_put_unauthenticated self, endpoint, {}, data, endpoint.additional_headers
+                  RestClientResources.execute_put_unauthenticated self, endpoint, {}, data, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               end
             end
@@ -271,23 +260,11 @@ module Bubbles
             Bubbles::RestEnvironment.class_exec do
               if endpoint.has_uri_params?
                 define_method(endpoint_name_as_sym) do |auth_token, uri_params|
-                  RestClientResources.execute_head_authenticated self, endpoint, auth_token, uri_params, endpoint.additional_headers
+                  RestClientResources.execute_head_authenticated self, endpoint, auth_token, uri_params, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               else
                 define_method(endpoint_name_as_sym) do |auth_token|
-                  RestClientResources.execute_head_authenticated self, endpoint, auth_token, {}, endpoint.additional_headers
-                end
-              end
-            end
-          elsif endpoint.api_key_required?
-            Bubbles::RestEnvironment.class_exec do
-              if endpoint.has_uri_params?
-                define_method(endpoint_name_as_sym) do |uri_params|
-                  RestClientResources.execute_head_unauthenticated_with_uri_params self, endpoint, self.api_key, uri_params, endpoint.additional_headers
-                end
-              else
-                define_method(endpoint_name_as_sym) do
-                  RestClientResources.execute_head_unauthenticated self, endpoint, self.api_key, endpoint.additional_headers
+                  RestClientResources.execute_head_authenticated self, endpoint, auth_token, {}, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               end
             end
@@ -295,11 +272,11 @@ module Bubbles
             Bubbles::RestEnvironment.class_exec do
               if endpoint.has_uri_params?
                 define_method(endpoint_name_as_sym) do |uri_params|
-                  RestClientResources.execute_head_unauthenticated self, endpoint, uri_params, endpoint.additional_headers
+                  RestClientResources.execute_head_unauthenticated self, endpoint, uri_params, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               else
                 define_method(endpoint_name_as_sym) do
-                  RestClientResources.execute_head_unauthenticated self, endpoint, {}, endpoint.additional_headers
+                  RestClientResources.execute_head_unauthenticated self, endpoint, {}, endpoint.additional_headers, self.get_api_key_if_needed(endpoint), self.api_key_name
                 end
               end
             end

data/lib/bubbles/endpoint.rb

@@ -146,13 +146,10 @@ module Bubbles
     #
     # @param [RestEnvironment] env The +RestEnvironment+ to use to access this +Endpoint+.
     #
-    # @return [String] A +String+ containing the full URL to access this +Endpoint+ on the given {RestEnvironment}.
+    # @return [Addressable::URI] An +Addressable::URI+ containing the full URL to access this +Endpoint+ on the given
+    #         +RestEnvironment+.
     #
     def get_expanded_url(env, uri_params = {})
-      unless uri_params
-        uri_params = {}
-      end
-
       url = get_base_url env
 
       if is_complex?
@@ -240,7 +237,7 @@ module Bubbles
     #         for the +Endpoint+, to be defined on {RestClientResources}; false, otherwise.
     #
     def name?
-      @name == nil
+      @name != nil
     end
 
     ##

data/lib/bubbles/rest_client_resources.rb

@@ -11,20 +11,19 @@ module Bubbles
     # 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
 
     ##
@@ -37,14 +36,11 @@ module Bubbles
     #
     # @return [RestClient::Response] The +Response+ resulting from the execution of the GET call.
     #
-    def self.execute_get_unauthenticated(env, endpoint, additional_headers = {})
-      execute_rest_call(env, endpoint, nil, 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)
-            .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
 
@@ -59,17 +55,18 @@ module Bubbles
     # @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, additional_headers = {})
-      execute_rest_call(env, endpoint, nil, auth_token, 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)
-            .get(headers)
-        else
-          next RestClient.get(url.to_s, headers)
-        end
+    def self.execute_get_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).get(headers)
       end
     end
 
@@ -83,17 +80,18 @@ module Bubbles
     # @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
 
@@ -109,50 +107,18 @@ module Bubbles
     # @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, additional_headers = {})
-      execute_rest_call(env, endpoint, nil, auth_token, 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
-      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] 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 HEAD call.
-    #
-    def self.execute_head_unauthenticated_with_uri_params(env, endpoint, api_key, uri_params, additional_headers = {})
-      composite_headers = {
-          'X-Api-Key' => api_key
-      }
-
-      unless additional_headers.empty?
-        additional_headers.each { |nextHeader|
-          composite_headers[nextHeader[0]] = nextHeader[1]
-        }
-      end
+    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)
 
-      execute_rest_call(env, endpoint, nil, nil, composite_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
 
@@ -165,27 +131,18 @@ module Bubbles
     # @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_with_api_key(env, endpoint, api_key, data, additional_headers = {})
-      composite_headers = {
-        'X-Api-Key' => api_key
-      }
-
-      unless additional_headers.nil?
-        additional_headers.each { |nextHeader|
-          composite_headers[nextHeader[0]] = nextHeader[1]
-        }
-      end
+    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)
 
       execute_rest_call(env, endpoint, data, nil, composite_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, headers)
-        else
-          next RestClient.post url.to_s, data.to_json, headers
-        end
+        next RestClient::Resource.new(url.to_s, :verify_ssl => OpenSSL::SSL::VERIFY_NONE).post(data.to_json, headers)
       end
     end
 
@@ -199,18 +156,18 @@ module Bubbles
     # @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, additional_headers = {})
-      return execute_rest_call(env, endpoint, data, auth_token, 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, headers)
+    def self.execute_post_authenticated(env, endpoint, auth_token, 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.post(url.to_s, data.to_json, headers)
-        end
+      return execute_rest_call(env, endpoint, data, auth_token, 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
 
@@ -225,18 +182,18 @@ module Bubbles
     # @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, additional_headers = {})
-      return execute_rest_call(env, endpoint, data, auth_token, 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)
-            .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
 
@@ -249,17 +206,18 @@ module Bubbles
     # @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, additional_headers = {})
-      return execute_rest_call(env, endpoint, data, 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)
-            .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
 
@@ -274,18 +232,18 @@ module Bubbles
     # @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, additional_headers = {})
-      return execute_rest_call(env, endpoint, data, auth_token, 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)
-            .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
 
@@ -298,17 +256,18 @@ module Bubbles
     # @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, additional_headers = {})
-      return execute_rest_call(env, endpoint, data, 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)
-            .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
 
@@ -322,17 +281,41 @@ module Bubbles
     # @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, additional_headers = {})
-      execute_rest_call(env, endpoint, nil, auth_token, 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)
-            .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
 
@@ -355,8 +338,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.
     #
@@ -376,8 +432,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
@@ -387,23 +447,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
@@ -415,4 +471,4 @@ module Bubbles
       response
     end
   end
-end
+end