Added rate limit endpoint and tests

Author: quickliketurtle

lib/Github/Api/RateLimit.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Github\Api;
+
+/**
+ * Get rate limits
+ *
+ * @link   https://developer.github.com/v3/rate_limit/
+ * @author Jeff Finley <[email protected]>
+ */
+class RateLimit extends AbstractApi
+{
+
+    /**
+     * Get rate limits
+     *
+     * @return \Guzzle\Http\EntityBodyInterface|mixed|string
+     */
+    public function getRateLimits()
+    {
+        return $this->get('rate_limit');
+    }
+
+    /**
+     * Get core rate limit
+     *
+     * @return integer
+     */
+    public function getCoreLimit()
+    {
+        $response = $this->getRateLimits();
+        return $response['resources']['core']['limit'];
+    }
+
+    /**
+     * Get search rate limit
+     *
+     * @return integer
+     */
+    public function getSearchLimit()
+    {
+        $response = $this->getRateLimits();
+        return $response['resources']['search']['limit'];
+    }
+
+}

lib/Github/Client.php

@@ -29,6 +29,7 @@
  * @method Api\PullRequest pr()
  * @method Api\PullRequest pullRequest()
  * @method Api\PullRequest pullRequests()
+ * @method Api\RateLimit ratelimit()
  * @method Api\Repo repo()
  * @method Api\Repo repos()
  * @method Api\Repo repository()
@@ -168,6 +169,11 @@ public function api($name)
                 $api = new Api\PullRequest($this);
                 break;
 
+            case 'rateLimit':
+            case 'rate_limit':
+                $api = new Api\RateLimit($this);
+                break;
+
             case 'repo':
             case 'repos':
             case 'repository':

test/Github/Tests/Api/RateLimitTest.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Github\Tests\Api;
+
+class RateLimitTest extends TestCase
+{
+
+    /**
+     * @test
+     */
+    public function shouldReturnRateLimitArray()
+    {
+        $expectedArray = [
+            'resources' => [
+                'core' => [
+                    'limit' => 5000,
+                    'remaining' => 4999,
+                    'reset' => 1372700873
+                ],
+                'search' => [
+                    'limit' => 30,
+                    'remaining' => 18,
+                    'reset' => 1372697452
+                ]
+            ]
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('rate_limit')
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->getRateLimits());
+    }
+
+    protected function getApiClass()
+    {
+        return 'Github\Api\RateLimit';
+    }
+}

test/Github/Tests/Functional/RateLimitTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Github\Tests\Functional;
+
+/**
+ * @group functional
+ */
+class RateLimitTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function shouldRetrievedRateLimits()
+    {
+        $response = $this->client->api('rate_limit')->getRateLimits();
+
+        $this->assertArrayHasKey('resources', $response);
+        $this->assertArraySubset(['resources' => ['core' => ['limit' => 60]]], $response);
+
+    }
+
+}