Introduce behat testing ! =)

Author: stloyd

.travis.yml

@@ -5,7 +5,9 @@ php:
   - 5.4
 
 before_script:
-  - curl -s http://getcomposer.org/installer | php
-  - php composer.phar update
+  - curl -s http://getcomposer.org/installer | php -- --quiet
+  - php composer.phar install --dev
 
-script: phpunit
+script:
+  - phpunit
+  - bin/behat

behat.yml.dist

@@ -0,0 +1,10 @@
+default:
+  paths:
+    features: features
+    bootstrap: features/bootstrap
+  formatter:
+    name: progress
+
+  context:
+    parameters:
+      base_url: "http://api.github.com"

composer.json

@@ -17,11 +17,17 @@
         }
     ],
     "require": {
-        "php": ">=5.3.2",
-        "ext-curl": "*",
+        "php":                ">=5.3.2",
+        "ext-curl":           "*",
         "kriswallsmith/buzz": "0.7"
     },
+    "require-dev": {
+        "behat/behat": "2.4.*"
+    },
     "autoload": {
         "psr-0": { "Github": "lib/" }
+    },
+    "config": {
+        "bin-dir": "bin/"
     }
 }

features/bootstrap/FeatureContext.php

@@ -0,0 +1,99 @@
+<?php
+
+use Behat\Behat\Event\SuiteEvent,
+    Behat\Behat\Event\FeatureEvent;
+use Behat\Behat\Context\Step\Given,
+    Behat\Behat\Context\Step\When,
+Behat\Behat\Context\Step\Then;
+use Behat\Behat\Context\ClosuredContextInterface,
+    Behat\Behat\Context\TranslatedContextInterface,
+    Behat\Behat\Context\BehatContext,
+    Behat\Behat\Exception\PendingException;
+use Behat\Gherkin\Node\PyStringNode,
+    Behat\Gherkin\Node\TableNode;
+
+use Github\Client;
+
+require_once 'PHPUnit/Autoload.php';
+require_once 'PHPUnit/Framework/Assert/Functions.php';
+
+class FeatureContext extends BehatContext
+{
+    private $client;
+    private $lastResponse;
+
+    public function __construct()
+    {
+        $this->client = new Client();
+    }
+
+    /**
+     * @AfterScenario
+     */
+    public function clearLastResponse()
+    {
+        $this->lastResponse = null;
+    }
+
+    /**
+     * @When /^(?:|I )send a request for rate limit information$/
+     */
+    public function iSendRequestForRateLimitInformation()
+    {
+        $this->lastResponse = $this->client->getRateLimit();
+    }
+
+    /**
+     * @Then /^(?:|I )should not reach my rate limit$/
+     */
+    public function iShouldNotReachMyRateLimit()
+    {
+        $remainingCalls = $this->client->getHttpClient()->remainingCalls;
+
+        assertNotNull($remainingCalls);
+        assertTrue(5000 > $remainingCalls);
+        assertTrue(0 < $remainingCalls);
+    }
+
+    /**
+     * @When /^(?:|I )send a markdown data:$/
+     */
+    public function iSendMarkdownData(PyStringNode $jsonString)
+    {
+        $data = json_decode($jsonString->getRaw(), true);
+
+        $this->lastResponse = $this->client->getMarkdownApi()->render(
+            $data['text'],
+            isset($data['mode']) ? $data['mode'] : null,
+            isset($data['context']) ? $data['context'] : null
+        );
+    }
+
+    /**
+     * @Then /^(?:the )?response should equal to html:$/
+     */
+    public function theResponseShouldEqualToHtml(PyStringNode $htmlString)
+    {
+        $expected = $htmlString->getRaw();
+        $actual   = $this->lastResponse;
+
+        assertEquals($expected, $actual, "Failed asserting that equals to \n".print_r($actual, true));
+    }
+
+    /**
+     * @Then /^(?:the )?response should equal to json:$/
+     */
+    public function theResponseShouldEqualToJson(PyStringNode $jsonString)
+    {
+        $expected = json_decode($jsonString->getRaw(), true);
+        $actual   = $this->lastResponse;
+
+        if (null === $expected) {
+            throw new \RuntimeException(
+                "Can not convert etalon to json:\n".$jsonString->getRaw()
+            );
+        }
+
+        assertEquals($expected, $actual, "Failed asserting that equals to \n".print_r($actual, true));
+    }
+}

features/markdown.feature

@@ -0,0 +1,30 @@
+Feature: Markdown rendering
+  In order to get rendered markdown file
+  As an anonymous user
+  I need to be able to post data to /markdown resource
+
+  Scenario: Get rendered markdown file
+    When I send a markdown data:
+    """
+    {
+      "text": "Hello world github/linguist#1 **cool**, and #1!"
+    }
+    """
+    Then the response should equal to html:
+    """
+    <p>Hello world github/linguist#1 <strong>cool</strong>, and #1!</p>
+    """
+
+  Scenario: Get rendered markdown file with context
+    When I send a markdown data:
+    """
+    {
+      "text": "Hello world KnpLabs/KnpBundles#1 **cool**, and #1!",
+      "mode": "gfm",
+      "context": "KnpLabs/KnpMenu"
+    }
+    """
+    Then the response should equal to html:
+    """
+    <p>Hello world <a href="https://github.com/KnpLabs/KnpBundles/issues/1" class="issue-link" title="Display docs">KnpLabs/KnpBundles#1</a> <strong>cool</strong>, and <a href="https://github.com/KnpLabs/KnpMenu/issues/1" class="issue-link" title="Limitation when using the TwigRenderer from elsewhere than a Twig template">#1</a>!</p>
+    """

features/rate_limit.feature

@@ -0,0 +1,18 @@
+Feature: Rate Limit
+  In order to get rate limit information
+  As an anonymous user
+  I need to be able to make calls to /rate_limit resource
+
+  Scenario: Get rate limit
+    When I send a request for rate limit information
+    Then I should not reach my rate limit
+# Commented because GH limit is reset once per hour
+#    Then the response should equal to json:
+#    """
+#    {
+#      "rate": {
+#        "remaining": 4999,
+#        "limit": 5000
+#      }
+#    }
+#    """

lib/Github/Api/Commit.php

@@ -23,9 +23,14 @@ class Commit extends Api
      */
     public function getBranchCommits($username, $repo, $branch)
     {
-        $branchSha = $this->getBranchSha($username, $repo, $branch);
+        $url = 'repos/'.urlencode($username).'/'.urlencode($repo).'/commits';
+
+        $sha = $this->getBranchSha($username, $repo, $branch);
+        if (null !== $sha) {
+            $url .= '?sha='.urlencode($sha);
+        }
 
-        return $this->get('repos/'.urlencode($username).'/'.urlencode($repo).'/commits?sha='.urlencode($branchSha));
+        return $this->get($url);
     }
 
     /**

lib/Github/Api/Markdown.php

@@ -13,19 +13,25 @@ class Markdown extends Api
     /**
      * @param string $text
      * @param string $mode
+     * @param string $context
      *
      * @return string
      */
-    public function render($text, $mode = 'markdown')
+    public function render($text, $mode = 'markdown', $context = null)
     {
-        if (!in_array($mode, array())) {
+        if (!in_array($mode, array('gfm', 'markdown'))) {
             $mode = 'markdown';
         }
 
-        return $this->post('markdown', array(
+        $params = array(
             'text' => $text,
             'mode' => $mode
-        ));
+        );
+        if (null !== $context && 'gfm' === $mode) {
+            $params['context'] = $context;
+        }
+
+        return $this->post('markdown', $params);
     }
 
     /**

lib/Github/Client.php

@@ -42,18 +42,18 @@ class Client
     protected $httpClient = null;
 
     /**
-     * HTTP Headers
+     * The list of loaded API instances
      *
      * @var array
      */
-    private $headers = array();
+    protected $apis = array();
 
     /**
-     * The list of loaded API instances
+     * HTTP Headers
      *
      * @var array
      */
-    protected $apis = array();
+    private $headers = array();
 
     /**
      * Instantiate a new GitHub client
@@ -113,7 +113,7 @@ public function get($path, array $parameters = array(), $requestOptions = array(
      * Call any path, POST method
      * Ex: $api->post('repos/show/my-username', array('email' => '[email protected]'))
      *
-     * @param   string  $path            the GitHub path
+     * @param   string  $path             the GitHub path
      * @param   array   $parameters       POST parameters
      * @param   array   $requestOptions   reconfigure the request
      * @return  array                     data returned
@@ -295,6 +295,14 @@ public function getMarkdownApi()
         return $this->apis['markdown'];
     }
 
+    /**
+     * @return mixed
+     */
+    public function getRateLimit()
+    {
+        return $this->get('rate_limit');
+    }
+
     /**
      * Inject an API instance
      *

lib/Github/HttpClient/HttpClient.php

@@ -17,6 +17,11 @@
  */
 class HttpClient implements HttpClientInterface
 {
+    /**
+     * @var integer
+     */
+    public $remainingCalls;
+
     /**
      * The http client options
      * @var array
@@ -205,9 +210,9 @@ protected function decodeResponse($response)
      */
     protected function checkApiLimit(MessageInterface $response)
     {
-        $limit = $response->getHeader('X-RateLimit-Remaining');
+        $this->remainingCalls = $response->getHeader('X-RateLimit-Remaining');
 
-        if (null !== $limit && 1 > $limit) {
+        if (null !== $this->remainingCalls && 1 > $this->remainingCalls) {
             throw new ApiLimitExceedException($this->options['api_limit']);
         }
     }