com.stehno.ersatz.cfg.PatchExpectations Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ersatz Show documentation
Mock server library for testing HTTP clients.
The newest version!
/**
 * Copyright (C) 2019 Christopher J. Stehno
 *
 * 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 com.stehno.ersatz.cfg;

import groovy.lang.Closure;
import groovy.lang.DelegatesTo;
import org.hamcrest.Matcher;
import space.jasan.support.groovy.closure.ConsumerWithDelegate;

import java.util.function.Consumer;

import static com.stehno.ersatz.match.ErsatzMatchers.pathMatcher;
import static groovy.lang.Closure.DELEGATE_FIRST;

/**
 * Defines the available PATCH request expectations.
 */
public interface PatchExpectations {

    /**
     * Allows configuration of a PATCH request expectation.
     *
     * @param path the expected request path
     * @return a RequestWithContent configuration object
     */
    default RequestWithContent PATCH(String path) {
        return PATCH(pathMatcher(path));
    }

    /**
     * Allows configuration of a PATCH request expectation.
     *
     * @param matcher the path matcher
     * @return a RequestWithContent configuration object
     */
    default RequestWithContent PATCH(Matcher matcher) {
        return PATCH(matcher, (Consumer) null);
    }

    /**
     * Allows configuration of a PATCH request expectation using the Groovy DSL.
     *
     * @param path the expected request path
     * @return a RequestWithContent configuration object
     * @param closure the Groovy closure containing the configuration
     */
    default RequestWithContent PATCH(String path, @DelegatesTo(value = RequestWithContent.class, strategy = DELEGATE_FIRST) Closure closure) {
        return PATCH(pathMatcher(path), closure);
    }

    /**
     * Allows configuration of a PATCH request expectation using the Groovy DSL.
     *
     * @param matcher the path matcher
     * @return a RequestWithContent configuration object
     * @param closure the Groovy closure containing the configuration
     */
    default RequestWithContent PATCH(Matcher matcher, @DelegatesTo(value = RequestWithContent.class, strategy = DELEGATE_FIRST) Closure closure) {
        return PATCH(matcher, ConsumerWithDelegate.create(closure));
    }

    /**
     * Allows configuration of a PATCH request expectation using the provided Consumer<RequestWithContent>. The
     * Consumer<RequestWithContent> will have an instance of RequestWithContent passed into it for configuration.
     *
     * @param path the expected request path
     * @return a RequestWithContent configuration object
     * @param config the configuration consumer
     */
    default RequestWithContent PATCH(String path, Consumer config) {
        return PATCH(pathMatcher(path), config);
    }

    /**
     * Allows configuration of a PATCH request expectation using the provided Consumer<RequestWithContent>. The
     * Consumer<RequestWithContent> will have an instance of RequestWithContent passed into it for configuration.
     *
     * @param matcher the path matcher
     * @return a RequestWithContent configuration object
     * @param config the configuration consumer
     */
    RequestWithContent PATCH(Matcher matcher, Consumer config);
}