fr.speekha.httpmocker.serialization.Mapper.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mocker Show documentation
A simple mocking lib for OkHttp
The newest version!
/*
 * Copyright 2019 David Blanc
 *
 * 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.
 */

package fr.speekha.httpmocker.serialization

import fr.speekha.httpmocker.io.readAsString
import fr.speekha.httpmocker.model.Matcher
import java.io.File
import java.io.FileInputStream
import java.io.InputStream
import java.io.OutputStream

/**
 * Mapper object allowing to load and save mock scenarios. It is basically a file parser,
 * allowing to convert lists of Matcher objects to text file (JSON or other) and back
 */
interface Mapper {

    val supportedFormat: String

    /**
     * Parses a string as a list of Matchers
     * @param payload the serialized data to parse
     * @return the corresponding list
     */
    fun deserialize(payload: String): List?

    /**
     * Serializes a list of matchers as a string (JSON, XML, CSV...)
     * @param matchers the list of matchers to serialize
     * @return a text formatted string representing the list
     */
    fun serialize(matchers: List): String
}

/**
 * Reads possible matches from a JSON input stream
 * @param stream the JSON data as an input stream
 * @return the corresponding data objects
 */
fun Mapper.readMatches(stream: InputStream): List? = deserialize(stream.readAsString())

/**
 * Reads possible matches from a JSON input stream
 * @param file the JSON data as a File
 * @return the corresponding data objects
 */
fun Mapper.readMatches(file: File): List? = readMatches(FileInputStream(file))

/**
 * Writes possible matches in JSON in an output stream
 * @param outputStream the stream in which the data will be saved
 * @param matchers the list of Matchers to serialize
 */
fun Mapper.writeValue(outputStream: OutputStream, matchers: List) = outputStream.use {
    it.write(serialize(matchers).toByteArray())
}