added some documentation. Renamed module methods

Author: mcustiel

README.md

@@ -1,8 +1,159 @@
 # codeception-wiremock-extension
-An extension that allows to use WireMock when running codeception tests.
 
-## See
+This Codeception Extension allows developers and testers to use WireMock to mock external services when running codeception tests.
+
+codeception-wiremock-extension connects to an already running instance of WireMock or can also run automatically a local standalone one. And, it is able to download the version of wiremock you preffer and run it too.
+After the tests are finished it will close the connection and turn wiremock service off (when it started it).
+
+## See also
 
 * WireMock PHP library: https://github.com/rowanhill/wiremock-php
 * Stubbing using WireMock: http://wiremock.org/stubbing.html
 * Verifying using WireMock: http://wiremock.org/verifying.html
+
+## Installation
+
+### Composer:
+
+This project is published in packagist, so you just need to add it as a dependency in your composer.json:
+
+```javascript
+    "require": {
+        // ...
+        "mcustiel/php-simple-request": "*"
+    }
+```
+
+If you want to access directly to this repo, adding this to your composer.json should be enough:
+
+```javascript  
+{
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/mcustiel/php-simple-request"
+        }
+    ],
+    "require": {
+        "mcustiel/php-simple-request": "dev-master"
+    }
+}
+```
+
+Or just download the release and include it in your path.
+
+## Configuration Examples
+
+### Module
+
+```yaml
+# acceptance.suite.yml
+modules:
+    enabled:
+        - WireMock
+```
+
+### Extension
+
+#### Default configuration 
+
+This configuration will download WireMock version 1.57 and run it on port 8080, writing logs to `/tmp/codeceptionWireMock/logs`
+
+```yaml
+# codeception.yml
+extensions:
+    enabled:
+        - Codeception\Extension\WireMock    
+```
+
+
+#### Connect to a running WireMock instance
+
+```yaml
+# codeception.yml
+extensions:
+    enabled:
+        - Codeception\Extension\WireMock
+    config:     
+        Codeception\Extension\WireMock:
+            host: my.wiremock.server
+            port: 8080
+```
+
+#### Start a local WireMock instance and run it with given command line arguments
+
+```yaml
+# codeception.yml
+extensions:
+    enabled:
+        - Codeception\Extension\WireMock
+    config:     
+        Codeception\Extension\WireMock:
+            jar-path: /opt/wiremock/bin/wiremock-standalone.jar
+            port: 18080
+            https-port: 18443
+            verbose: true
+            root-dir: /opt/wiremock/root
+            
+```
+
+#### Download a WireMock instance and run it with given command line arguments
+
+```yaml
+# codeception.yml
+extensions:
+    enabled:
+        - Codeception\Extension\WireMock
+    config:     
+        Codeception\Extension\WireMock:
+            download-version: 1.57
+            port: 18080
+            https-port: 18443
+            verbose: true
+            root-dir: /opt/wiremock/root
+            logs-path: /var/log/wiremock 
+```
+
+## How to use
+
+### Prepare your application
+
+First of all, configure your application so when it is being tested it will replace its external services with WireMock.
+For instance, if you make some requests to a REST service located under http://your.rest.interface, replace that url in configuration with the url where WireMock runs, for instance: http://localhost:8080/rest_interface.
+
+### Write your tests
+
+```php
+// YourCest.php
+class YourCest extends \Codeception\TestCase\Test
+{
+    public function _after(\AcceptanceTester $I)
+    {
+        $I->cleanAllPreviousRequestsToWireMock();
+    }
+
+    // tests
+    public function tryToTest(\AcceptanceTester $I)
+    {
+        $I->expectRequestToWireMock(
+            WireMock::get(WireMock::urlEqualTo('/some/url'))
+                ->willReturn(WireMock::aResponse()
+                ->withHeader('Content-Type', 'text/plain')
+                ->withBody('Hello world!'))
+        );
+        // Here you should execute your application in a way it requests wiremock. I do this directly to show it. 
+        $response = file_get_contents('http://localhost:18080/some/url');
+        
+        $I->assertEquals('Hello world!', $response);
+        $I->receivedRequestInWireMock(
+            WireMock::getRequestedFor(WireMock::urlEqualTo('/some/url'))
+        );
+    }
+    
+    // Also, you can access wiremock-php library directly
+    public function moreComplexTest()
+    {
+        
+    }
+}
+```

src/Extension/WireMock.php

@@ -49,7 +49,7 @@ public function __construct(
 
         $this->config = $this->argumentsManager->sanitize($this->config);
 
-        if (! empty($this->config['host'])) {
+        if (!empty($this->config['host'])) {
             echo "Connecting to wiremock host {$this->config['host']}" . PHP_EOL;
             $host = $this->config['host'];
         } else {

src/Extension/WireMockProcess.php

@@ -95,7 +95,7 @@ private function checkProcessIsRunning()
     public function stop()
     {
         if (is_resource($this->process)) {
-            foreach ($this->pipes AS $pipe) {
+            foreach ($this->pipes as $pipe) {
                 if (is_resource($pipe)) {
                     fflush($pipe);
                     fclose($pipe);

src/Module/WireMock.php

@@ -24,15 +24,15 @@ public function _before(TestCase $testCase)
         $this->wireMock = WireMockConnection::get();
     }
 
-    public function cleanAllPreviousRequests()
+    public function cleanAllPreviousRequestsToWireMock()
     {
         $this->wireMock->reset();
     }
 
     /**
      * @param \WireMock\Client\MappingBuilder $builder
      */
-    public function expectRequest(MappingBuilder $builder)
+    public function expectRequestToWireMock(MappingBuilder $builder)
     {
         $this->wireMock->stubFor($builder);
     }
@@ -41,7 +41,7 @@ public function expectRequest(MappingBuilder $builder)
      * @param \WireMock\Client\RequestPatternBuilder|integer $builderOrCount
      * @param \WireMock\Client\RequestPatternBuilder         $builder
      */
-    public function receivedRequest($builderOrCount, RequestPatternBuilder $builder = null)
+    public function receivedRequestToWireMock($builderOrCount, RequestPatternBuilder $builder = null)
     {
         $this->wireMock->verify($builderOrCount, $builder);
     }

tests/tests/acceptance/WelcomeCest.php

@@ -31,9 +31,9 @@ public function tryToTest(\AcceptanceTester $I)
             ->withHeader('Content-Type', 'text/plain')
             ->withBody('Hello world!'))
         );
+
         $response = file_get_contents('http://localhost:18080/some/url');
-        //Debug::debug(var_export($this->wiremock, true));
-        Debug::debug(var_export($response, true));
+
         $I->receivedRequest(
             WireMock::getRequestedFor(WireMock::urlEqualTo('/some/url'))
         );