[feat]: added new provider Mobizon (#8)

* feat: added new provider `Mobizon`

* Update README.md

Author: YozhikM

README.md

@@ -1,4 +1,4 @@
-# sms-sender  :envelope: :rocket:
+# sms-sender :envelope: :rocket:
 
 [![travis build](https://img.shields.io/travis/FrankAst/sms-sender.svg)](https://travis-ci.org/FrankAst/sms-sender)
 [![codecov coverage](https://img.shields.io/codecov/c/github/FrankAst/sms-sender.svg)](https://codecov.io/github/FrankAst/sms-sender)
@@ -8,22 +8,20 @@
 [![Greenkeeper badge](https://badges.greenkeeper.io/FrankAst/sms-sender.svg)](https://greenkeeper.io/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-
 This is a wrapper for [AWS.SNS](https://aws.amazon.com/sns/) and [SMSC API](https://smsc.ru).
 
 ## Installation
 
-
 ```bash
 yarn add @frankast/sms-sender
 ```
 
 ## API
 
-There are two providers `Smsc.js` (default) and `Sns.js`. If you want to use `Sns.js` do not forget to add `aws-sdk` optional dependency.
-
+There are three providers `Smsc.js` (default), `Sns.js`, `Mobizon`. If you want to use `Sns.js` do not forget to add `aws-sdk` optional dependency.
 
 #### Sending SMS
+
 To send an SMS you have to create an instance of provider and call `sendSms()` method:
 
 ```js
@@ -42,6 +40,7 @@ const response = await smsc.sendSms('phone_number', 'message');
 ```
 
 #### Get delivery status of SMS
+
 To check the delivery status of SMS call `getStatus()` method:
 
 ```js
@@ -72,6 +71,7 @@ const response = await smsc.getStatus('40-77718637484'); // takes messageId (id-
 P.S. You can get status codes [here](https://github.com/FrankAst/sms-sender/blob/3946a34f0d68369914e1ac6c180cc2a5948b718d/src/transporters/Smsc.js#L49) or in [SMSC docs](https://smsc.kz/api/http/status_messages/statuses/#menu).
 
 #### Get cost of SMS
+
 To get a cost of SMS call `getCost()` method:
 
 ```js
@@ -81,7 +81,10 @@ const response = await smsc.getCost('phone_number','message');
 // response = { cost: '0', rawResponse: { cnt: 1, cost: '25' } };
 ```
 
+`getCost()` is not available for `Mobizon` provider.
+
 #### Get current balance
+
 To get the current balance on your account call `getBalance()` method:
 
 ```js
@@ -92,12 +95,13 @@ To get the current balance on your account call `getBalance()` method:
 ```
 
 ## Examples
+
 Here is an example of usage with RegExp:
 
 ```js
 // @flow
 
-import { Smsc, Sns } from '@frankast/sms-sender';
+import { Smsc, Sns, Mobizon } from '@frankast/sms-sender';
 
 // don't forget to put your credentials
 const providers = {
@@ -111,6 +115,10 @@ const providers = {
     accessKeyId: '',
     secretAccessKey: '',
   }),
+  
+  mobizon: new Mobizon({
+    apiKey: '',
+  }),
 };
 
 async function send(phone: string, message: string): Promise<Object> {
@@ -128,13 +136,12 @@ async function send(phone: string, message: string): Promise<Object> {
 send('+77081113344', 'hello world').then(res => {
   console.log(res);
 });
-
-
 ```
 
 Other examples are available in [./examples](https://github.com/FrankAst/sms-sender/tree/master/examples).
 
 ## Contribution
+
 Feel free to submit pull request to us. Also, be sure all tests has passed otherwise pull request won't be accepted.
 
 ## License

src/index.js

@@ -2,3 +2,4 @@
 
 export { default as Smsc } from './transporters/Smsc';
 export { default as Sns } from './transporters/Sns';
+export { default as Mobizon } from './transporters/Mobizon';

src/transporters/Mobizon.js

@@ -0,0 +1,127 @@
+// @flow
+
+import 'isomorphic-fetch';
+import { URLSearchParams } from 'url';
+
+import type {
+  SendSmsResponseT,
+  GetStatusResponseT,
+  GetBalanceResponseT,
+  SmsStatusT,
+  ProviderI,
+} from '../definitions';
+
+type CredentialsT = {|
+  apiKey: string,
+|};
+
+export default class Mobizon implements ProviderI {
+  credentials: CredentialsT;
+
+  constructor(credentials: CredentialsT) {
+    this.credentials = credentials;
+  }
+
+  async _send(params: Object): Promise<Object> {
+    const { apiKey } = this.credentials || {};
+    const extendedParams = {
+      apiKey,
+      ...params,
+    };
+    const paramsUrl = new URLSearchParams(extendedParams);
+    const url = `https://api.mobizon.com/service/message/sendsmsmessage?${paramsUrl.toString()}`;
+    const res = await fetch(url);
+    return res.json();
+  }
+
+  async sendSms(phone: string, message: string): Promise<SendSmsResponseT> {
+    const params = {
+      recipient: phone,
+      text: message,
+    };
+    const { data } = await this._send(params);
+    const res = {
+      messageId: data.messageId,
+      rawResponse: data,
+    };
+    return res;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  _prepareStatus(status: string): SmsStatusT {
+    switch (status) {
+      case 'NEW':
+        return 'pending'; // Новое сообщение, еще не было отправлено
+      case 'ENQUEUD':
+        return 'pending'; // Прошло модерацию и поставлено в очередь на отправку
+      case 'ACCEPTED':
+        return 'pending'; // Отправлено из системы и принято оператором
+      case 'UNDELIV':
+        return 'error'; // Не доставлено получателю
+      case 'REJECTD':
+        return 'error'; // Отклонено оператором
+      case 'PDLIVRD':
+        return 'pending'; // Идет кусочками, первый пошел
+      case 'DELIVRD':
+        return 'ok'; // Доставлено получателю полностью
+      case 'EXPIRED':
+        return 'error'; // Доставка не удалась, истек срок жизни сообщения
+      case 'DELETED':
+        return 'error'; // Удалено из-за ограничений и не доставлено
+      default:
+        return 'error';
+    }
+  }
+
+  async getStatus(messageId: string | string[]): Promise<GetStatusResponseT> {
+    const { apiKey } = this.credentials || {};
+    const params = {
+      apiKey,
+      ids: Array.isArray(messageId) ? messageId.join(',') : messageId,
+    };
+
+    const paramsUrl = new URLSearchParams(params);
+
+    const url = `https://api.mobizon.com/service/message/getsmsstatus?${paramsUrl.toString()}`;
+    const response = await fetch(url);
+    const { data } = await response.json();
+
+    const res = {
+      status: data.map(d => this._prepareStatus(d.status)),
+      rawResponse: data,
+    };
+    return res;
+  }
+
+  async getBalance(): Promise<GetBalanceResponseT> {
+    const { apiKey } = this.credentials || {};
+    const params = {
+      apiKey,
+    };
+
+    const paramsUrl = new URLSearchParams(params);
+
+    const url = `https://api.mobizon.com/service/user/getownbalance/?${paramsUrl.toString()}`;
+    const response = await fetch(url);
+    const { data } = await response.json();
+
+    const res = {
+      balance: data.balance,
+      rawResponse: data,
+    };
+    return res;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async getCost() {
+    return {
+      cost: '',
+      rawResponse: {},
+    };
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  getProviderName(): string {
+    return 'mobizon';
+  }
+}

src/transporters/__tests__/Mobizon-test.js

@@ -0,0 +1,67 @@
+/* @flow */
+
+import fetchMock from 'fetch-mock';
+import Mobizon from '../Mobizon';
+
+describe('Mobizon', () => {
+  const apiKey = '38d0a2492a33901f547ef22099e6535589500936';
+  const mobizon = new Mobizon({ apiKey });
+
+  beforeEach(() => {
+    fetchMock.reset();
+  });
+
+  it('sendSms', async () => {
+    const rawResponse = {
+      data: { campaignId: '18633289', messageId: '39335551', status: 1 },
+    };
+    fetchMock.mock({
+      matcher: `https://api.mobizon.com/service/message/sendsmsmessage?apiKey=${apiKey}&recipient=${77478446651}&text=HELLO`,
+      response: rawResponse,
+    });
+
+    const res = await mobizon.sendSms('77478446651', 'HELLO');
+    expect(res).toEqual({
+      messageId: '39335551',
+      rawResponse: rawResponse.data,
+    });
+  });
+
+  it('getStatus', async () => {
+    const rawResponse = {
+      data: [
+        {
+          id: '39335551',
+          status: 'DELIVRD',
+          segNum: '1',
+          startSendTs: '2018-04-09 19:36:09',
+          statusUpdateTs: '2018-04-09 19:36:13',
+        },
+      ],
+    };
+    fetchMock.mock({
+      matcher: `https://api.mobizon.com/service/message/getsmsstatus?apiKey=${apiKey}&ids=39335551`,
+      response: rawResponse,
+    });
+
+    const res = await mobizon.getStatus('39335551');
+    expect(res).toEqual({
+      status: ['ok'],
+      rawResponse: rawResponse.data,
+    });
+  });
+
+  it('getBalance', async () => {
+    const rawResponse = { data: { balance: '83.5300', currency: 'KZT' } };
+    fetchMock.mock({
+      matcher: `https://api.mobizon.com/service/user/getownbalance/?apiKey=${apiKey}`,
+      response: rawResponse,
+    });
+
+    const res = await mobizon.getBalance();
+    expect(res).toEqual({
+      balance: '83.5300',
+      rawResponse: rawResponse.data,
+    });
+  });
+});

yarn.lock

@@ -2349,9 +2349,9 @@ flat-cache@^1.2.1:
     graceful-fs "^4.1.2"
     write "^0.2.1"
 
-flow-bin@^0.68.0:
-  version "0.68.0"
-  resolved "https://registry.yarnpkg.com/flow-bin/-/flow-bin-0.68.0.tgz#86c2d14857d306eb2e85e274f2eebf543564f623"
+flow-bin@^0.69.0:
+  version "0.69.0"
+  resolved "https://registry.yarnpkg.com/flow-bin/-/flow-bin-0.69.0.tgz#053159a684a6051fcbf0b71a2eb19a9679082da6"
 
 for-in@^1.0.1, for-in@^1.0.2:
   version "1.0.2"