inc/CurlUrlCreator.h

   1 //! \file CurlUrlCreator.h
   2
   3 #ifndef WIKIWALKER_CURLURLCREATOR_H
   4 #define WIKIWALKER_CURLURLCREATOR_H
   5
   6 #include <map>
   7 #include <string>
   8 #include <unordered_map>
   9
  10 #include <curl/curl.h>
  11
  12 namespace WikiWalker
  13 {
  14   /*! Creates GET URLs with parameters.
  15    *  With the help of curl
  16    */
  17   class CurlUrlCreator
  18   {
  19   public:
  20     /*! Create a new instance, given a base URL
  21      * \param baseUrl Base URL that will be used for adding parameters
  22      */
  23     explicit CurlUrlCreator(std::string baseUrl);
  24
  25     //! delete copy constructor, because of CURL handle
  26     CurlUrlCreator(const CurlUrlCreator&) = delete;
  27
  28     //! default move constructor
  29     CurlUrlCreator(CurlUrlCreator&&) = default;
  30
  31     //! delete copy assignment, because of CURL handle
  32     CurlUrlCreator& operator=(const CurlUrlCreator&) = delete;
  33
  34     //! default move assignment
  35     CurlUrlCreator& operator=(CurlUrlCreator&&) = default;
  36
  37     /*! Add GET parameters to URL.
  38      *  If parameter keys are specified multiple times, later occurrences
  39      *  overwrite earlier ones.
  40      *  \param param the parameter name
  41      *  \param value the parameter value - UNESCAPED!
  42      *               This will be done by curl. If you already escape
  43      *               it will be double-escaped.
  44      *  \return reference to self, so method chaining is possible.
  45      */
  46     CurlUrlCreator& addParameter(const std::string& param,
  47                                  const std::string& value);
  48
  49     /*! Add GET parameters to URL.
  50      *  \param params a map of keys and values.
  51      *                values have to be UNESCAPED!
  52      *                This will be done by curl. If you already escape
  53      *                it will be double-escaped.
  54      *  \return reference to self, so method chaining is possible.
  55      */
  56     CurlUrlCreator& addParameter(
  57         const std::map<const std::string, const std::string>& params);
  58
  59     //! Reset parameters
  60     void reset();
  61
  62     /*! Creates the URL
  63      *  \return Complete GET URL.
  64      */
  65     std::string buildUrl() const;
  66
  67     ~CurlUrlCreator();
  68
  69   private:
  70     std::string baseUrl_;
  71     std::unordered_map<std::string, std::string> args_;
  72     CURL* handle_;
  73   };
  74 }  // namespace WikiWalker
  75 #endif  // WIKIWALKER_CURLURLCREATOR_H