View Javadoc
1   /**
2    * Copyright (c) 2013-2022, jcabi.com
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met: 1) Redistributions of source code must retain the above
8    * copyright notice, this list of conditions and the following
9    * disclaimer. 2) Redistributions in binary form must reproduce the above
10   * copyright notice, this list of conditions and the following
11   * disclaimer in the documentation and/or other materials provided
12   * with the distribution. 3) Neither the name of the jcabi.com nor
13   * the names of its contributors may be used to endorse or promote
14   * products derived from this software without specific prior written
15   * permission.
16   *
17   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21   * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28   * OF THE POSSIBILITY OF SUCH DAMAGE.
29   */
30  package com.jcabi.github;
31  
32  import com.jcabi.aspects.Tv;
33  import com.jcabi.http.request.FakeRequest;
34  import org.hamcrest.MatcherAssert;
35  import org.hamcrest.Matchers;
36  import org.junit.Test;
37  import org.mockito.Mockito;
38  
39  /**
40   * Test case for {@link RtLimit}.
41   *
42   * @author Giang Le (giang@vn-smartsolutions.com)
43   * @version $Id: 5e00dd8047f35e701c544a2567b03bd06784d737 $
44   */
45  public final class RtLimitTest {
46  
47      /**
48       * RtLimit can describe as a JSON object.
49       *
50       * @throws Exception if there is any problem
51       */
52      @Test
53      public void describeAsJson() throws Exception {
54          final JsonReadable limit = new RtLimit(
55              Mockito.mock(Github.class),
56              new FakeRequest().withBody(this.body()),
57              "core"
58          );
59          MatcherAssert.assertThat(
60              limit.json().toString(),
61              Matchers.equalTo(
62                  "{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873}"
63              )
64          );
65      }
66  
67      /**
68       * RtLimit can throw exception when resource is absent.
69       *
70       * @throws Exception if some problem inside
71       */
72      @Test(expected = IllegalStateException.class)
73      public void throwsWhenResourceIsAbsent() throws Exception {
74          final JsonReadable limit = new RtLimit(
75              Mockito.mock(Github.class),
76              new FakeRequest().withBody(this.body()),
77              "absent"
78          );
79          MatcherAssert.assertThat(
80              limit.json().toString(),
81              Matchers.equalTo("{}")
82          );
83      }
84  
85      /**
86       * Example response from rate API.
87       * @return Body string.
88       */
89      private String body() {
90          return new StringBuilder(Tv.HUNDRED)
91              .append("{\"resources\":{\"core\":{\"limit\":5000,")
92              .append("\"remaining\":4999,\"reset\":1372700873},")
93              .append("\"search\":{\"limit\":20,\"remaining\":18,")
94              .append("\"reset\":1372697452}},\"rate\":{\"limit\":5000,")
95              .append("\"remaining\":4999,\"reset\":1372700873}}")
96              .toString();
97      }
98  }