/**

  * Copyright (c) 2011-2017, jcabi.com

  * All rights reserved.

  *

  * Redistribution and use in source and binary forms, with or without

  * modification, are permitted provided that the following conditions

  * are met: 1) Redistributions of source code must retain the above

  * copyright notice, this list of conditions and the following

  * disclaimer. 2) Redistributions in binary form must reproduce the above

  * copyright notice, this list of conditions and the following

  * disclaimer in the documentation and/or other materials provided

  * with the distribution. 3) Neither the name of the jcabi.com nor

  * the names of its contributors may be used to endorse or promote

  * products derived from this software without specific prior written

  * permission.

  *

  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT

  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND

  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL

  * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,

  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED

  * OF THE POSSIBILITY OF SUCH DAMAGE.

  */

 package com.jcabi.http.response;

 import com.jcabi.aspects.Immutable;

 import com.jcabi.http.Request;

 import com.jcabi.http.Response;

 import com.jcabi.log.Logger;

 import java.net.HttpCookie;

 import java.net.URI;

 import java.util.Collections;

 import java.util.Iterator;

 import java.util.List;

 import java.util.Map;

 import javax.ws.rs.core.Cookie;

 import javax.ws.rs.core.HttpHeaders;

 import lombok.EqualsAndHashCode;

 import org.hamcrest.CustomMatcher;

 import org.hamcrest.Matcher;

 import org.hamcrest.MatcherAssert;

 import org.hamcrest.Matchers;

 /**

  * REST response.

  *

  * <p>This response decorator is able to make basic assertions on

  * HTTP response and manipulate with it afterwords, for example:

  *

  * <pre> String name = new JdkRequest("http://my.example.com")

  *   .fetch()

  *   .as(RestResponse.class)

  *   .assertStatus(200)

  *   .assertBody(Matchers.containsString("hello, world!"))

  *   .assertHeader("Content-Type", Matchers.hasItem("text/plain"))

  *   .jump(URI.create("/users"))

  *   .fetch();</pre>

  *

  * <p>Method {@link #jump(URI)} creates a new instance of class

  * {@link Request} with all cookies transferred from the current one.

  *

  * <p>The class is immutable and thread-safe.

  *

  * @author Yegor Bugayenko (yegor@tpc2.com)

  * @version $Id: 8b3634c366e075b7fd59c89cbc3839a1cbc26fb7 $

  * @since 0.8

  */

 @Immutable

 @EqualsAndHashCode(callSuper = true)

 @SuppressWarnings("PMD.TooManyMethods")

 public final class RestResponse extends AbstractResponse {

     /**

      * Public ctor.

      * @param resp Response

      */

     public RestResponse(final Response resp) {

         super(resp);

     }

     /**

      * Assert using custom matcher.

      * @param matcher The matcher to use

      * @return The same object

      */

     public RestResponse assertThat(final Matcher<Response> matcher) {

         MatcherAssert.assertThat(

             String.format("HTTP response is not valid: %s", this),

             this,

             matcher

         );

         return this;

     }

     /**

      * Verifies HTTP response status code against the provided absolute value,

      * and throws {@link AssertionError} in case of mismatch.

      * @param status Expected status code

      * @return The same object

      */

     public RestResponse assertStatus(final int status) {

         final String message = String.format(

             "HTTP response with status %d", status

         );

         MatcherAssert.assertThat(

             String.format(

                 "HTTP response status is not equal to %d:%n%s",

                 status, this

             ),

             this,

             new RestResponse.StatusMatch(message, status)

         );

         return this;

     }

     /**

      * Verifies HTTP response status code against the provided matcher,

      * and throws {@link AssertionError} in case of mismatch.

      * @param matcher Matcher to validate status code

      * @return This object

      */

     public RestResponse assertStatus(final Matcher<Integer> matcher) {

         MatcherAssert.assertThat(

             String.format(

                 "HTTP response status is not the one expected:%n%s",

                 this

             ),

             this.status(), matcher

         );

         return this;

     }

     /**

      * Verifies HTTP response body content against provided matcher,

      * and throws {@link AssertionError} in case of mismatch.

      * @param matcher The matcher to use

      * @return This object

      */

     public RestResponse assertBody(final Matcher<String> matcher) {

         MatcherAssert.assertThat(

             String.format(

                 "HTTP response body content is not valid:%n%s",

                 this

             ),

             this.body(), matcher

         );

         return this;

     }

     /**

      * Verifies HTTP response body content against provided matcher,

      * and throws {@link AssertionError} in case of mismatch.

      * @param matcher The matcher to use

      * @return This object

      */

     public RestResponse assertBinary(final Matcher<byte[]> matcher) {

         MatcherAssert.assertThat(

             String.format(

                 "HTTP response binary content is not valid:%n%s",

                 this

             ), this.binary(),

             matcher

         );

         return this;

     }

     /**

      * Verifies HTTP header against provided matcher, and throws

      * {@link AssertionError} in case of mismatch.

      *

      * <p>The iterator for the matcher will always be a real object an never

      * {@code NULL}, even if such a header is absent in the response. If the

      * header is absent the iterable will be empty.

      *

      * @param name Name of the header to match

      * @param matcher The matcher to use

      * @return This object

      */

     public RestResponse assertHeader(final String name,

         final Matcher<Iterable<String>> matcher) {

         Iterable<String> values = this.headers().get(name);

         if (values == null) {

             values = Collections.emptyList();

         }

         MatcherAssert.assertThat(

             String.format(

                 "HTTP header '%s' is not valid:%n%s",

                 name, this

             ),

             values, matcher

         );

         return this;

     }

     /**

      * Verifies HTTP header against provided matcher, and throws

      * {@link AssertionError} in case of mismatch.

      * @param name Name of the header to match

      * @param value The value to expect in one of the headers

      * @return This object

      * @since 0.9

      */

     public RestResponse assertHeader(final String name, final String value) {

         return this.assertHeader(name, Matchers.hasItems(value));

     }

     /**

      * Jump to a new location.

      * @param uri Destination to jump to

      * @return New request

      */

     @SuppressWarnings("PMD.UseConcurrentHashMap")

     public Request jump(final URI uri) {

         Request req = this.back().uri()

             .set(this.back().uri().get().resolve(uri))

             .back();

         final Map<String, List<String>> headers = this.headers();

         if (headers.containsKey(HttpHeaders.SET_COOKIE)) {

             for (final String header : headers.get(HttpHeaders.SET_COOKIE)) {

                 for (final HttpCookie cookie : HttpCookie.parse(header)) {

                     req = req.header(

                         HttpHeaders.COOKIE,

                         String.format(

                             "%s=%s", cookie.getName(), cookie.getValue()

                         )

                     );

                 }

             }

         }

         return req;

     }

     /**

      * Follow LOCATION header.

      * @return New request

      */

     public Request follow() {

         this.assertHeader(

             HttpHeaders.LOCATION,

             Matchers.not(Matchers.emptyIterableOf(String.class))

         );

         return this.jump(

             URI.create(this.headers().get(HttpHeaders.LOCATION).get(0))

         );

     }

     /**

      * Get one cookie by name.

      * @param name Cookie name

      * @return Cookie found

      */

     @SuppressWarnings("PMD.UseConcurrentHashMap")

     public Cookie cookie(final String name) {

         final Map<String, List<String>> headers = this.headers();

         MatcherAssert.assertThat(

             "cookies should be set in HTTP header",

             headers.containsKey(HttpHeaders.SET_COOKIE)

         );

         final Iterator<String> iterator =

             headers.get(HttpHeaders.SET_COOKIE).iterator();

         final Object first = iterator.next();

         // @checkstyle MagicNumber (1 line)

         final StringBuilder buf = new StringBuilder(256);

         if (first != null) {

             buf.append(first);

         }

         while (iterator.hasNext()) {

             buf.append(',');

             final Object obj = iterator.next();

             if (obj != null) {

                 buf.append(obj);

             }

         }

         final String header = buf.toString();

         Cookie cookie = null;

         for (final HttpCookie candidate : HttpCookie.parse(header)) {

             if (candidate.getName().equals(name)) {

                 cookie = RestResponse.cookie(candidate);

                 break;

             }

         }

         MatcherAssert.assertThat(

             Logger.format(

                 "cookie '%s' not found in Set-Cookie header: '%s'",

                 name, header

             ),

             cookie,

             Matchers.notNullValue()

         );

         assert cookie != null;

         return cookie;

     }

     /**

      * Convert HTTP cookie to a standard one.

      * @param cookie HTTP cookie

      * @return Regular one

      */

     private static Cookie cookie(final HttpCookie cookie) {

         return new Cookie(

             cookie.getName(),

             cookie.getValue(),

             cookie.getPath(),

             cookie.getDomain(),

             cookie.getVersion()

         );

     }

     /**

      * Status matcher.

      */

     private static final class StatusMatch extends CustomMatcher<Response> {

         /**

          * HTTP status to check.

          */

         private final transient int status;

         /**

          * Ctor.

          * @param msg Message to show

          * @param sts HTTP status to check

          */

         StatusMatch(final String msg, final int sts) {

             super(msg);

             this.status = sts;

         }

         @Override

         public boolean matches(final Object resp) {

             return Response.class.cast(resp).status() == this.status;

         }

     }

 }