JSONUtils.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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 ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_JSON_JSONUTILS_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_JSON_JSONUTILS_H_

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

#include <rapidjson/document.h>

#include "AVSCommon/Utils/Logger/LoggerUtils.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {
namespace json {
namespace jsonUtils {

inline static std::string getTag() {
    return "JsonUtils";
}

bool findNode(
    const rapidjson::Value& jsonNode,
    const std::string& key,
    rapidjson::Value::ConstMemberIterator* iteratorPtr);

bool parseJSON(const std::string& jsonContent, rapidjson::Document* document);

bool convertToValue(const rapidjson::Value& documentNode, std::string* value);

bool convertToValue(const rapidjson::Value& documentNode, int64_t* value);

bool convertToValue(const rapidjson::Value& documentNode, uint64_t* value);

bool convertToValue(const rapidjson::Value& documentNode, bool* value);

bool convertToValue(const rapidjson::Value& documentNode, double* value);

template <typename T>
bool retrieveValue(const rapidjson::Value& jsonNode, const std::string& key, T* value) {
    if (!value) {
        logger::acsdkError(logger::LogEntry(getTag(), "retrieveValueFailed").d("reason", "nullValue"));
        return false;
    }

    rapidjson::Value::ConstMemberIterator iterator;
    if (!findNode(jsonNode, key, &iterator)) {
        return false;
    }

    return convertToValue(iterator->value, value);
}

template <typename T>
bool retrieveValue(const std::string jsonString, const std::string& key, T* value) {
    if (!value) {
        logger::acsdkError(logger::LogEntry(getTag(), "retrieveValueFailed").d("reason", "nullValue"));
        return false;
    }

    rapidjson::Document document;
    if (!parseJSON(jsonString, &document)) {
        logger::acsdkError(logger::LogEntry(getTag(), "retrieveValueFailed").d("reason", "parsingError"));
        return false;
    }

    return retrieveValue(document, key, value);
}

bool jsonArrayExists(const rapidjson::Value& parsedDocument, const std::string& key);

template <class CollectionT>
CollectionT retrieveStringArray(const std::string& jsonString, const std::string& key);

template <class CollectionT>
CollectionT retrieveStringArray(const std::string& jsonString);

template <class CollectionT>
CollectionT retrieveStringArray(const rapidjson::Value& value);

template <class CollectionT>
std::string convertToJsonString(const CollectionT& elements);

std::map<std::string, std::string> retrieveStringMap(const rapidjson::Value& value, const std::string& key);

void retrieveStringMapFromArray(
    const rapidjson::Value& value,
    const std::string& key,
    std::map<std::string, std::string>& elements);

bool retrieveArrayOfStringMapFromArray(
    const rapidjson::Value& value,
    const std::string& key,
    std::vector<std::map<std::string, std::string>>& elements);

//----- Templated functions implementation and specializations.

template <>
std::vector<std::string> retrieveStringArray<std::vector<std::string>>(
    const std::string& jsonString,
    const std::string& key);

template <>
std::vector<std::string> retrieveStringArray<std::vector<std::string>>(const std::string& jsonString);

template <>
std::vector<std::string> retrieveStringArray<std::vector<std::string>>(const rapidjson::Value& value);

template <>
std::string convertToJsonString<std::vector<std::string>>(const std::vector<std::string>& elements);

template <class CollectionT>
CollectionT retrieveStringArray(const std::string& jsonString, const std::string& key) {
    auto values = retrieveStringArray<std::vector<std::string>>(jsonString, key);
    return CollectionT{values.begin(), values.end()};
}

template <class CollectionT>
CollectionT retrieveStringArray(const std::string& jsonString) {
    auto values = retrieveStringArray<std::vector<std::string>>(jsonString);
    return CollectionT{values.begin(), values.end()};
}

template <class CollectionT>
CollectionT retrieveStringArray(const rapidjson::Value& value) {
    auto values = retrieveStringArray<std::vector<std::string>>(value);
    return CollectionT{values.begin(), values.end()};
}

template <class CollectionT>
std::string convertToJsonString(const CollectionT& elements) {
    return convertToJsonString(std::vector<std::string>{elements.begin(), elements.end()});
}

}  // namespace jsonUtils
}  // namespace json
}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_JSON_JSONUTILS_H_