add readme

Author: Andrey Pshenkin

index.js

@@ -1,4 +1,3 @@
-
 const request = require('then-request');
 const urljoin = require('url-join');
 const { cropLongData } = require('@kronoslive/codeceptjs-utils');
@@ -131,7 +130,8 @@ class HTTP extends Helper {
   /**
    * Validate that latest https response has specified JSON schema.
    * @param {string} schema - path to JSON schema file. is relative to schemas folder
-   * @param {*} params
+   * @param {*} params - (optional) if schema file is js file, that export function, then you can specify here params in array,
+   *      that will be applied to this function. Function should return JSON schema.
    * @param {*} data - (optional) - specify data that should be validated (by default first response message for latest
    *     request)
    * @returns {*}
@@ -141,6 +141,9 @@ class HTTP extends Helper {
    * ```
    */
   seeHttpResponseHasValidJsonSchema(schema, params, data) {
+    if (utils === undefined) {
+      throw new Error('To use JSON schema validation please add codeceptjs-utils-helper https://www.npmjs.com/package/@kronoslive/codeceptjs-utils-helper');
+    }
     data = data || this.currentResponse.body;
     return utils.seeDataHasValidJsonSchema(schema, params, data);
   }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs-http",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "CodeceptJS helper for HTTP request with Mochawesome logging",
   "dependencies": {
     "@kronoslive/codeceptjs-utils": "^0.0.1",
@@ -19,7 +19,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:APshenkin/codeceptjs-http.git"
+    "url": "git@github.com:testphony/codeceptjs-http.git"
   },
   "author": "Andrey Pshenkin <andrey.pshenkin@gmail.com>",
   "license": "MIT"

package.json

@@ -0,0 +1,64 @@
+# codeceptjs-http
+
+codeceptjs-http is [CodeceptJS](https://codecept.io/) helper which wraps [then-request](https://www.npmjs.com/package/then-request) library to
+process HTTP requests. It's alternative helper that provides more flexible request management.
+
+NPM package: https://www.npmjs.com/package/codeceptjs-http
+
+### Configuration
+
+This helper should be configured in codecept.json/codecept.conf.js
+
+-   `endpoint`: base HTTP url.
+
+Example:
+
+```json
+{
+   "helpers": {
+     "HTTP" : {
+       "require": "codeceptjs-http",
+       "endpoint": "http://localhost:8080"
+     }
+   }
+}
+```
+
+## sendRequest
+
+Send HTTP request, response will be availible as return value and in this.currentResponse.
+
+```js
+I.sendRequest(('/callback', 'POST', {
+                    headers: {
+                      'Content-Type': 'application/json',
+                    },
+                    json: {
+                      myParam: 123
+                    },
+                  })); // will use base endpoint
+I.sendRequest('https://logalhost:8080/getOrders', 'GET'); // will use url from 1st argument
+```
+
+**Parameters**
+
+-   `requestPath` - endpoint path. Can be relative or absolute
+-   `method` - (optional) request method. Default 'GET'
+-   `options` - (optional) headers, body, etc. see https://www.npmjs.com/package/then-request
+-   `domain` - (optional) change domain for request
+
+## seeHttpResponseHasValidJsonSchema
+
+Validate that latest https response has specified JSON schema.
+
+```js
+I.seeHttpResponseHasValidJsonSchema('api/getOrders.json');
+I.seeHttpResponseHasValidJsonSchema('filters/values.js', ['param1', 'param2']);
+```
+
+**Parameters**
+
+-   `schema` - path to JSON schema file. is relative to schemas folder. schemas folder will be in codeceptJS root folder (path.join(global.codecept_dir, './schemas/'))
+-   `params` - (optional) if schema file is js file, that export function, then you can specify here params in array, that will be applied to this function. Function should return JSON schema.
+-   `data` - (optional) specify data that should be validated. By default first response message for latest request
+