Initial commit

Author: Daniel Schischkin

.gitignore

@@ -0,0 +1,2 @@
+/vendor
+/.idea

README.md

@@ -1,2 +1,16 @@
-# repository-template
-Repository Template
+# <a id="title" href="#">Surplex API Mock</a>
+---  
+
+API for "the software to mock third-party responses" to include in your application's API tests.
+&nbsp;
+&nbsp;
+## <a id="Troubleshooting" href="#Troubleshooting">Troubleshooting</a>
+---  
+#### I used a requestKey, but the `ApiMock::getClientRequest()` gets a 404/null
+**A)** The request in question has never been called by your application, therefore a request with the requestKey has never
+been recorded. Make sure to `ApiMock::addResponse()` in the correct order. Maybe one of the earlier responses does not
+match your application's excpectations and causes it to fail?  
+**B)** Your requests to API Mock use different session keys (or none at all). For example, this can happen if parts of
+your application run asyncronously (e.g. in queues). Use the $sessionCacheFile feature to retrieve the correct session
+key. (provide a file path where API Mock can dump the currently used session key into and then retrieve it in your
+application).

codeception.yml

@@ -0,0 +1,10 @@
+paths:
+    tests: tests
+    output: tests/_output
+    data: tests/_data
+    support: tests/_support
+    envs: tests/_envs
+actor_suffix: Tester
+extensions:
+    enabled:
+        - Codeception\Extension\RunFailed

composer.json

@@ -0,0 +1,25 @@
+{
+  "name": "surplex/api-mock-api",
+  "license": "Apache-2.0",
+  "description": "Interface for the communication between software and api-mock",
+  "type": "library",
+  "authors": [
+    {
+      "name": "Daniel Schischkin",
+      "email": "daniel.schischkin@surplex.com"
+    }
+  ],
+  "require": {
+    "php": ">=7.1",
+    "guzzlehttp/guzzle": "^6.3",
+    "ext-json": "*"
+  },
+  "require-dev": {
+    "codeception/codeception": "^2.5"
+  },
+  "autoload": {
+    "psr-4": {
+      "ApiMock\\": "src/"
+    }
+  }
+}