com.ghostframe.postmandoc.postman.PostmanCollectionFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of postmandoc-maven-plugin Show documentation
Maven plugin for generating Postman collections from Spring REST Docs snippets
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 com.ghostframe.postmandoc.postman;

import com.ghostframe.postmandoc.postman.domain.PostmanCollection;
import com.ghostframe.postmandoc.postman.domain.PostmanCollectionFolderItem;
import com.ghostframe.postmandoc.postman.domain.PostmanCollectionInfo;
import com.ghostframe.postmandoc.postman.domain.PostmanCollectionItem;
import com.ghostframe.postmandoc.postman.domain.PostmanCollectionRequestItem;
import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import static java.util.Collections.EMPTY_LIST;
import java.util.List;
import java.util.UUID;
import static java.util.stream.Collectors.toList;
import java.util.stream.Stream;
import lombok.SneakyThrows;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.WordUtils;
import org.apache.http.HttpException;

public class PostmanCollectionFactory {

    private static final String HTTP_REQUEST_SNIPPET_FILENAME = "http-request.adoc";
    private static final String COLLECTION_V2_0_0_SCHEMA = "https://schema.getpostman.com/json/collection/v2.0.0/collection.json";
    private static final String TEST_CLASS_SUFFIX_REGEX = "(rest|controller|tests|test)";

    @SneakyThrows(IOException.class)
    public static PostmanCollection fromSnippetsFolder(String collectionName, File generatedSnippetsFolder, String replacementHost) {
        return PostmanCollection.builder()
                .info(PostmanCollectionInfo.builder()
                        .name(collectionName)
                        .schema(COLLECTION_V2_0_0_SCHEMA)
                        ._postman_id(UUID.randomUUID().toString())
                        .build())
                .item(scanGeneratedSnippetsFolder(generatedSnippetsFolder, replacementHost))
                .variables(EMPTY_LIST)
                .build();
    }

    public static PostmanCollection fromSnippetsFolder(String collectionName, File generatedSnippetsFolder) {
        return fromSnippetsFolder(collectionName, generatedSnippetsFolder, null);
    }

    private static List scanGeneratedSnippetsFolder(File generatedSnippetsFolder, String replacementHost) throws IOException {
        return filesIn(generatedSnippetsFolder)
                .map(file -> folderToCollectionItem(file, replacementHost))
                .collect(toList());
    }

    private static PostmanCollectionItem folderToCollectionItem(File folder, String replacementHost) {
        File httpRequestSnippet = FileUtils.getFile(folder, HTTP_REQUEST_SNIPPET_FILENAME);
        if (httpRequestSnippet.exists()) {
            return createRequest(folder.getName(), httpRequestSnippet, replacementHost);
        } else {
            PostmanCollectionFolderItem postmanCollectionItem = createFolder(folder);
            postmanCollectionItem.setItem(filesIn(folder)
                    .map(file -> folderToCollectionItem(file, replacementHost))
                    .collect(toList()));
            return postmanCollectionItem;
        }
    }

    private static PostmanCollectionFolderItem createFolder(File folder) {
        PostmanCollectionFolderItem postmanCollectionFolder = new PostmanCollectionFolderItem();
        postmanCollectionFolder.setName(testClassNameToFolderName(humanizeCase(folder.getName())));
        return postmanCollectionFolder;
    }

    private static String testClassNameToFolderName(String text) {
        return text.replaceAll(TEST_CLASS_SUFFIX_REGEX, "").trim();
    }

    @SneakyThrows({HttpException.class, IOException.class})
    private static PostmanCollectionItem createRequest(String name, File httpRequestSnippet, String replacementHost) {
        PostmanCollectionRequestItem postmanCollectionRequest = new PostmanCollectionRequestItem();
        postmanCollectionRequest.setName(humanizeCase(name));
        postmanCollectionRequest.setResponse(EMPTY_LIST);
        String httpRequest = FileUtils.readFileToString(httpRequestSnippet, StandardCharsets.UTF_8);
        postmanCollectionRequest.setRequest(PostmanRequestFactory.fromHttpRequestSnippet(httpRequest, replacementHost));
        return postmanCollectionRequest;
    }

    private static String humanizeCase(String text) {
        String dashReplacedWithSpace = text.replace('-', ' ').replace('_', ' ');
        String capitalized = WordUtils.capitalize(dashReplacedWithSpace);
        String camelCase = capitalized.replace(" ", "");
        return StringUtils.capitalize(StringUtils.join(StringUtils.splitByCharacterTypeCamelCase(camelCase), " ").toLowerCase());
    }

    @SneakyThrows(IOException.class)
    private static Stream filesIn(File folder) {
        return Files
                .list(folder.toPath())
                .filter(path -> !path.toString().contains("stubs"))
                .map(java.nio.file.Path::toFile);
    }
}