WebRequestBuilder.h

// Copyright eeGeo Ltd (2012-2015), All Rights Reserved

#pragma once

#include "Types.h"
#include "Web.h"
#include "WebPostData.h"
#include "Helpers.h"
#include "UrlHelpers.h"

#include <string>
#include <map>
#include <vector>

namespace Eegeo
{
    namespace Web
    {
        class WebRequestBuilder
        {
        public:
            WebRequestBuilder(
                    const TWebRequestId requestId,
                    Eegeo::Web::IWebRequestService& webRequestService,
                    Helpers::IHttpCache& httpCache,
                    const Eegeo::Web::HttpVerbs::Values httpVerb,
                    const std::string& url,
                    IWebLoadRequestCompletionCallback& callback,
                    Helpers::UrlHelpers::IUrlEncoder& encoder);

            WebRequestBuilder& AddHeader(const std::string& headerFieldName, const std::string& value);
            WebRequestBuilder& AddQueryParam(const std::string& keyName, const std::string& value);            
            WebRequestBuilder& AddFormData(const std::string& keyName, const std::string& value);
            WebRequestBuilder& AddPostData(const std::string& keyName, const WebPostData& postData);

            WebRequestBuilder& SetUserData(void* pUserData);
            WebRequestBuilder& SetPostBodyData(const WebPostData& bodyData);
            WebRequestBuilder& SetUserAgent(const std::string& userAgent);
            WebRequestBuilder& SetRetryLimit(const u32 retryLimit);
            WebRequestBuilder& SetTimeout(const u32 timeoutInSeconds);
            
            WebRequestBuilder& SetShouldCacheAggressively(const bool shouldCacheAggressively);
            WebRequestBuilder& SetShouldRequestOnlyFromCache(const bool cacheOnly);
            WebRequestBuilder& SetShouldCacheResponse(const bool cacheResponse);
            WebRequestBuilder& SetAllowCacheFetchWithoutHeaders(const bool allowCacheFetchWithoutHeaders);
            
            WebRequestBuilder& AcceptContentType(const std::string& mimeType);
            WebRequestBuilder& AcceptBinaryContentTypes();
            WebRequestBuilder& AcceptProxyWorkaroundBinaryContentTypes();
            WebRequestBuilder& AcceptTextureContentTypes();
            WebRequestBuilder& RequireResponseHeader(const std::string& requiredHeaderName);

            Eegeo::Web::IWebLoadRequest* Build();
            
            bool HasPostBodyData();
        private:
            bool TryAddConditionalGetHeaders();
            
            Eegeo::Web::HttpVerbs::Values m_httpVerb;
            std::string m_url;
            IWebLoadRequestCompletionCallback* m_pCallback;
            Helpers::UrlHelpers::IUrlEncoder* m_pEncoder;

            void* m_pUserData;
            bool m_hasUserData;
            std::string m_userAgent;
            int m_retryLimit;
            int m_timeoutInSeconds;
            WebPostData m_postBodyData;
            bool m_hasPostBodyData;
            std::map<std::string, std::string> m_httpRequestHeaders;
            std::map<std::string, WebPostData> m_httpPostData;
            std::vector<std::string> m_acceptableMimeTypes;
            std::vector<std::string> m_requiredResponseHeaderNames;

            TWebRequestId m_requestId;
            Eegeo::Web::IWebRequestService* m_pWebRequestService;
            Helpers::IHttpCache* m_pHttpCache;
            bool m_hasBeenBuilt;
            bool m_shouldCacheAggressively;
            bool m_cacheOnly;
            bool m_shouldCacheResponse;
            bool m_allowCacheFetchWithoutHeaders;
        };
    }
}