RestClient.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef IGNITION_FUEL_TOOLS_RESTCLIENT_HH_
#define IGNITION_FUEL_TOOLS_RESTCLIENT_HH_

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

#include "ignition/fuel_tools/Export.hh"

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::string
#pragma warning(push)
#pragma warning(disable: 4251)
// TODO(jrivero): rename the DELETE method which is a reserved word in Windows
#undef DELETE
#endif

namespace ignition
{
  namespace fuel_tools
  {
    struct IGNITION_FUEL_TOOLS_VISIBLE RestResponse
    {
      // cppcheck-suppress unusedStructMember
      public: int statusCode = 0;

      public: std::string data = "";

      public: std::map<std::string, std::string> headers;
    };

    enum class HttpMethod
    {
      GET,

      POST,

      DELETE,

      PUT,

      PATCH,

      POST_FORM,

      PATCH_FORM
    };

    class IGNITION_FUEL_TOOLS_VISIBLE Rest
    {
      public: Rest() = default;

      public: virtual RestResponse Request(const HttpMethod _method,
          const std::string &_url,
          const std::string &_version,
          const std::string &_path,
          const std::vector<std::string> &_queryStrings,
          const std::vector<std::string> &_headers,
          const std::string &_data,
          const std::multimap<std::string, std::string> &_form =
          std::multimap<std::string, std::string>()) const;

      public: void SetUserAgent(const std::string &_agent);

      public: const std::string &UserAgent() const;

      private: std::string userAgent;
    };
  }
}

#ifdef _MSC_VER
#pragma warning(pop)
#endif

#endif