First stage renames, rpc-{core,provider,rx} (#220)

* Docs renames (& removal for re-gen)

* Rename api, api-provider & api-rx

* Apoi -> Rpc, RxApi -> RpcRx (classes)

* Add .nodoc

* Bump version

* Link updates (summary)

* Cleanup deleted (master version)

* Deleted re-instated

* More... ;)

* Types...

* Revert .nodoc

packages/rpc-provider/src/http/index.spec.js

@@ -0,0 +1,43 @@
+// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors
+// This software may be modified and distributed under the terms
+// of the ISC license. See the LICENSE file for details.
+
+import { TEST_HTTP_URL } from '../../test/mockHttp';
+
+import Http from './index';
+
+describe('Http', () => {
+  let http;
+
+  beforeEach(() => {
+    http = new Http(TEST_HTTP_URL);
+  });
+
+  it('requires an http:// prefixed endpoint', () => {
+    expect(
+      () => new Http('ws://')
+    ).toThrow(/with 'http/);
+  });
+
+  it('allows https:// endpoints', () => {
+    expect(
+      () => new Http('https://')
+    ).not.toThrow();
+  });
+
+  it('always returns isConnected true', () => {
+    expect(http.isConnected()).toEqual(true);
+  });
+
+  it('does not (yet) support subscribe', () => {
+    return http.subscribe().catch((error) => {
+      expect(error.message).toMatch(/does not have subscriptions/);
+    });
+  });
+
+  it('does not (yet) support unsubscribe', () => {
+    return http.unsubscribe().catch((error) => {
+      expect(error.message).toMatch(/does not have subscriptions/);
+    });
+  });
+});

packages/rpc-provider/src/http/index.ts

@@ -0,0 +1,108 @@
+// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors
+// This software may be modified and distributed under the terms
+// of the ISC license. See the LICENSE file for details.
+
+import { Logger } from '@polkadot/util/types';
+import { RpcCoder } from '../coder/json/types';
+import { ProviderInterface, ProviderInterface$Callback, ProviderInterface$Emitted, ProviderInterface$EmitCb } from '../types';
+
+import './polyfill';
+
+import assert from '@polkadot/util/assert';
+import logger from '@polkadot/util/logger';
+
+import coder from '../coder/json';
+
+const ERROR_SUBSCRIBE = 'HTTP Provider does not have subscriptions, use WebSockets instead';
+
+/**
+ * @name HttpProvider
+ * @summary The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port.
+ * @description It does not support subscriptions so you won't be able to listen to events
+ * such as new blocks or balance changes. It is usually preferrable using the [[WsProvider]].
+ *
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import Api from '@polkadot/rpc-core';
+ * import HttpProvider from '@polkadot/rpc-provider/http';
+ *
+ * const provider = new HttpProvider('http://127.0.0.1:9933');
+ * const api = new Api(provider);
+ * ```
+ *
+ * @see [[WsProvider]]
+ */
+export default class HttpProvider implements ProviderInterface {
+  private coder: RpcCoder;
+  private endpoint: string;
+  private l: Logger;
+
+  /**
+   * @param {string} endpoint The endpoint url starting with http://
+   */
+  constructor (endpoint: string) {
+    assert(/^(https|http):\/\//.test(endpoint), `Endpoint should start with 'http://', received '${endpoint}'`);
+
+    this.coder = coder();
+    this.endpoint = endpoint;
+    this.l = logger('api-http');
+  }
+
+  /**
+   * @summary Whether the node is connected or not.
+   * @return {boolean} true if connected
+   */
+  isConnected (): boolean {
+    return true;
+  }
+
+  /**
+   * @summary Events are not supported with the HttpProvider, see [[WsProvider]].
+   * @description HTTP Provider does not have 'on' emitters. WebSockets should be used instead.
+   */
+  on (type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void {
+    this.l.error(`HTTP Provider does not have 'on' emitters, use WebSockets instead`);
+  }
+
+  /**
+   * @summary Send HTTP POST Request with Body to configured HTTP Endpoint.
+   */
+  async send (method: string, params: Array<any>): Promise<any> {
+    const body = this.coder.encodeJson(method, params);
+    const response = await fetch(this.endpoint, {
+      body,
+      headers: {
+        'Accept': 'application/json',
+        'Content-Length': `${body.length}`,
+        'Content-Type': 'application/json'
+      },
+      method: 'POST'
+    });
+
+    assert(response.ok, `[${response.status}]: ${response.statusText}`);
+
+    const result = await response.json();
+
+    return this.coder.decodeResponse(result);
+  }
+
+  /**
+   * @summary Subscriptions are not supported with the HttpProvider, see [[WsProvider]].
+   */
+  async subscribe (types: string, method: string, params: Array<any>, cb: ProviderInterface$Callback): Promise<number> {
+    this.l.error(ERROR_SUBSCRIBE);
+
+    throw new Error(ERROR_SUBSCRIBE);
+  }
+
+  /**
+   * @summary Subscriptions are not supported with the HttpProvider, see [[WsProvider]].
+   */
+  async unsubscribe (type: string, method: string, id: number): Promise<boolean> {
+    this.l.error(ERROR_SUBSCRIBE);
+
+    throw new Error(ERROR_SUBSCRIBE);
+  }
+}

packages/rpc-provider/src/http/polyfill.spec.js

@@ -0,0 +1,26 @@
+// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors
+// This software may be modified and distributed under the terms
+// of the ISC license. See the LICENSE file for details.
+
+describe('http/polyfill', () => {
+  let origFetch;
+
+  beforeEach(() => {
+    origFetch = global.fetch;
+    global.fetch = null;
+  });
+
+  afterEach(() => {
+    global.fetch = origFetch;
+  });
+
+  it('polyfills with no exceptions (without fetch)', () => {
+    expect(require('./polyfill')).toBeDefined();
+  });
+
+  it('polyfills with no exceptions (with fetch)', () => {
+    global.fetch = () => true;
+
+    expect(require('./polyfill')).toBeDefined();
+  });
+});

packages/rpc-provider/src/http/polyfill.ts

@@ -0,0 +1,8 @@
+// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors
+// This software may be modified and distributed under the terms
+// of the ISC license. See the LICENSE file for details.
+
+// tslint:disable-next-line
+if (typeof fetch === 'undefined') {
+  require('isomorphic-fetch');
+}

packages/rpc-provider/src/http/send.spec.js

@@ -0,0 +1,56 @@
+// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors
+// This software may be modified and distributed under the terms
+// of the ISC license. See the LICENSE file for details.
+
+import { mockHttp, TEST_HTTP_URL } from '../../test/mockHttp';
+
+import Http from './index';
+
+describe('send', () => {
+  let http;
+  let mock;
+
+  beforeEach(() => {
+    http = new Http(TEST_HTTP_URL);
+  });
+
+  afterEach(() => {
+    if (mock) {
+      mock.done();
+      mock = null;
+    }
+  });
+
+  it('passes the body through correctly', () => {
+    mock = mockHttp([{
+      method: 'test_body',
+      reply: {
+        result: 'ok'
+      }
+    }]);
+
+    return http
+      .send('test_body', ['param'])
+      .then((result) => {
+        expect(mock.body['test_body']).toEqual({
+          id: 1,
+          jsonrpc: '2.0',
+          method: 'test_body',
+          params: ['param']
+        });
+      });
+  });
+
+  it('throws error when !response.ok', () => {
+    mock = mockHttp([{
+      code: 500,
+      method: 'test_error'
+    }]);
+
+    return http
+      .send('test_error', [])
+      .catch((error) => {
+        expect(error.message).toMatch(/\[500\]: Internal Server/);
+      });
+  });
+});

packages/rpc-provider/src/http/types.d.ts

@@ -0,0 +1,12 @@
+// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors
+// This software may be modified and distributed under the terms
+// of the ISC license. See the LICENSE file for details.
+
+import { Logger } from '@polkadot/util/types';
+import { RpcCoder } from '../coder/json/types';
+
+export type HttpState = {
+  coder: RpcCoder,
+  endpoint: string,
+  l: Logger
+};