Merge pull request #2 from sharathkumaranbu/Issue_1

Wrapper with postError function

Author: BadalZ

.swagger-codegen-ignore

@@ -1,181 +1,46 @@
-# topcoder_meta_services_rest_api
-
-TopcoderMetaServicesRestApi - JavaScript client for topcoder_meta_services_rest_api
-REST API for Topcoder Meta Services.  This describes a service that can give information on other services existing on Topcoder.  Available service links can be listed by sending GET request. Also, each service can return links to further services in their responses.  ### Pagination   Requests that return multiple items will be paginated to 20 items by default. You can specify   further pages with the ```page``` parameter. You can also set a custom page   size up to 100 with the ```perPage``` parameter.    Pagination response data is included in http headers. By Default, the response header contains links with ```next```, ```last```, ```first```, ```prev``` resource links. 
-This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
-
-- API version: 5.0.0
-- Package version: 5.0.0
-- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
-For more information, please visit [http://www.topcoder.com/support](http://www.topcoder.com/support)
-
-## Installation
-
-### For [Node.js](https://nodejs.org/)
-
-#### npm
-
-To publish the library as a [npm](https://www.npmjs.com/),
-please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
-
-Then install it via:
-
-```shell
-npm install topcoder_meta_services_rest_api --save
-```
-
-##### Local development
-
-To use the library locally without publishing to a remote npm registry, first install the dependencies by changing 
-into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
-
-```shell
-npm install
-```
-
-Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
-
-```shell
-npm link
-```
-
-Finally, switch to the directory you want to use your topcoder_meta_services_rest_api from, and run:
-
-```shell
-npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
-```
-
-You should now be able to `require('topcoder_meta_services_rest_api')` in javascript files from the directory you ran the last 
-command above from.
-
-#### git
-#
-If the library is hosted at a git repository, e.g.
-https://github.com/GIT_USER_ID/GIT_REPO_ID
-then install it via:
-
-```shell
-    npm install GIT_USER_ID/GIT_REPO_ID --save
-```
-
-### For browser
-
-The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
-the above steps with Node.js and installing browserify with `npm install -g browserify`,
-perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually 
-use this library):
-
-```shell
-browserify main.js > bundle.js
-```
-
-Then include *bundle.js* in the HTML pages.
-
-### Webpack Configuration
-
-Using Webpack you may encounter the following error: "Module not found: Error:
-Cannot resolve module", most certainly you should disable AMD loader. Add/merge
-the following section to your webpack config:
-
-```javascript
-module: {
-  rules: [
-    {
-      parser: {
-        amd: false
-      }
-    }
-  ]
-}
-```
-
-## Getting Started
-
-Please follow the [installation](#installation) instruction and execute the following JS code:
-
-```javascript
-var TopcoderMetaServicesRestApi = require('topcoder_meta_services_rest_api');
-
-var defaultClient = TopcoderMetaServicesRestApi.ApiClient.instance;
-
-// Configure API key authorization: Bearer
-var Bearer = defaultClient.authentications['Bearer'];
-Bearer.apiKey = "YOUR API KEY"
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//Bearer.apiKeyPrefix['Authorization'] = "Token"
-
-var api = new TopcoderMetaServicesRestApi.EventsApi()
-
-var body = new TopcoderMetaServicesRestApi.EventPayload(); // {EventPayload} 
-
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.postEvent(body, callback);
-
-```
-
-## Documentation for API Endpoints
-
-All URIs are relative to *https://api.topcoder.com/v5*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*TopcoderMetaServicesRestApi.EventsApi* | [**postEvent**](docs/EventsApi.md#postEvent) | **POST** /bus/events | Post event to the message bus.
-*TopcoderMetaServicesRestApi.HealthchecksApi* | [**getHealth**](docs/HealthchecksApi.md#getHealth) | **GET** /bus/health | Check API is healthy.
-*TopcoderMetaServicesRestApi.HealthchecksApi* | [**headHealth**](docs/HealthchecksApi.md#headHealth) | **HEAD** /bus/health | Get only response status and headers information but no response body for the endpoint. 
-*TopcoderMetaServicesRestApi.PlaceholdersApi* | [**clearPlaceholdersCache**](docs/PlaceholdersApi.md#clearPlaceholdersCache) | **DELETE** /bus/placeholders | Clear placeholders cache.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**createService**](docs/ServiceApi.md#createService) | **POST** /bus/services | Create a service.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**createServicePayload**](docs/ServiceApi.md#createServicePayload) | **POST** /bus/services/{serviceName}/payloads | Create the service payload.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**deleteService**](docs/ServiceApi.md#deleteService) | **DELETE** /bus/services/{serviceName} | Delete the service.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**deleteServicePayload**](docs/ServiceApi.md#deleteServicePayload) | **DELETE** /bus/services/{serviceName}/payloads/{payloadName} | Delete the service payload.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**getService**](docs/ServiceApi.md#getService) | **GET** /bus/services/{serviceName} | Get the service.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**getServicePayload**](docs/ServiceApi.md#getServicePayload) | **GET** /bus/services/{serviceName}/payloads/{payloadName} | Get the service payload.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**getServicePayloads**](docs/ServiceApi.md#getServicePayloads) | **GET** /bus/services/{serviceName}/payloads | Search the service payloads.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**getServices**](docs/ServiceApi.md#getServices) | **GET** /bus/services | Get all services.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**headService**](docs/ServiceApi.md#headService) | **HEAD** /bus/services/{serviceName} | Get only response status and headers information but no response body for the endpoint.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**headServicePayload**](docs/ServiceApi.md#headServicePayload) | **HEAD** /bus/services/{serviceName}/payloads/{payloadName} | Get only response status and headers information but no response body for the endpoint.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**headServicePayloads**](docs/ServiceApi.md#headServicePayloads) | **HEAD** /bus/services/{serviceName}/payloads | Get only response status and headers information but no response body for the endpoint.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**headServices**](docs/ServiceApi.md#headServices) | **HEAD** /bus/services | Get only response status and headers information but no response body for the endpoint.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**patchService**](docs/ServiceApi.md#patchService) | **PATCH** /bus/services/{serviceName} | Partially update the service.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**patchServicePayload**](docs/ServiceApi.md#patchServicePayload) | **PATCH** /bus/services/{serviceName}/payloads/{payloadName} | Partially update the payload.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**updateService**](docs/ServiceApi.md#updateService) | **PUT** /bus/services/{serviceName} | Update the service.
-*TopcoderMetaServicesRestApi.ServiceApi* | [**updateServicePayload**](docs/ServiceApi.md#updateServicePayload) | **PUT** /bus/services/{serviceName}/payloads/{payloadName} | Update the service payload.
-*TopcoderMetaServicesRestApi.TopicsApi* | [**getTopics**](docs/TopicsApi.md#getTopics) | **GET** /bus/topics | Get topics.
-*TopcoderMetaServicesRestApi.TopicsApi* | [**headTopics**](docs/TopicsApi.md#headTopics) | **HEAD** /bus/topics | Get only response status and headers information but no response body for the endpoint.
-
-
-## Documentation for Models
-
- - [TopcoderMetaServicesRestApi.Accepted](docs/Accepted.md)
- - [TopcoderMetaServicesRestApi.BadRequest](docs/BadRequest.md)
- - [TopcoderMetaServicesRestApi.Body](docs/Body.md)
- - [TopcoderMetaServicesRestApi.Body1](docs/Body1.md)
- - [TopcoderMetaServicesRestApi.Conflict](docs/Conflict.md)
- - [TopcoderMetaServicesRestApi.EventPayload](docs/EventPayload.md)
- - [TopcoderMetaServicesRestApi.Forbidden](docs/Forbidden.md)
- - [TopcoderMetaServicesRestApi.HealthCheckStatus](docs/HealthCheckStatus.md)
- - [TopcoderMetaServicesRestApi.NoContent](docs/NoContent.md)
- - [TopcoderMetaServicesRestApi.NotFound](docs/NotFound.md)
- - [TopcoderMetaServicesRestApi.NotModified](docs/NotModified.md)
- - [TopcoderMetaServicesRestApi.Payload](docs/Payload.md)
- - [TopcoderMetaServicesRestApi.ServerError](docs/ServerError.md)
- - [TopcoderMetaServicesRestApi.Service](docs/Service.md)
- - [TopcoderMetaServicesRestApi.Unauthorized](docs/Unauthorized.md)
- - [TopcoderMetaServicesRestApi.ExtendedService](docs/ExtendedService.md)
-
-
-## Documentation for Authorization
-
-
-### Bearer
-
-- **Type**: API key
-- **API key parameter name**: Authorization
-- **Location**: HTTP header
-
+# tc-bus-api-wrapper
+
+Wrapper library for Topcoder Bus API
+
+## How to use this Wrapper
+
+1. Include the wrapper in package.json as follows
+
+```
+"tc-bus-api-wrapper": "topcoder-platform/tc-bus-api-wrapper.git"
+```
+
+2. Create an instance of this wrapper with the configuration variables listed below
+
+
+```
+const busApi = require('tc-bus-api-wrapper')
+busApi(_.pick(config,
+      ['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
+        'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'BUSAPI_URL',
+        'KAFKA_ERROR_TOPIC']))
+```
+
+**Configuration / Environment variables:**
+
+*Auth0 related variables:*
+	- AUTH0_URL
+	- AUTH0_AUDIENCE
+	- TOKEN_CACHE_TIME (optional)
+	- AUTH0_CLIENT_ID
+
+- BUSAPI_URL - Bus API URL. E.g. `https://api.topcoder-dev.com/v5`
+
+- KAFKA_ERROR_TOPIC - Error topic in Kafka to which error message need to be posted
+
+3. Every function in this wrapper will return a promise, Handling promises is at the caller end. Call the functions with appropriate arguments
+
+E.g.
+
+```
+const result = yield busApiClient.getTopics()
+
+yield busApiClient.postEvent(reqBody)
+```
+
+Refer `index.js` for the list of available wrapper functions