refactor(examples): refactor README.md, examples, .travis.yml (#7)

* docs(README): refactor links

* fix(Sns): export Sns.js

* fix(package): fix path to main file

* refactor(examples): rename 'with_db' to 'with_mongoose'

* refactor(examples): add 'try/catch' to 'retry_another'

* refactor(Sns): remove Promises, make stubs for unsupported methods

* test(Sns): move mock of 'Sns.sendSms()' to test

* test(Smsc): remove credentials of test account of SMSC

* refactor: remove git_deploy_key.enc

* refactor(examples): refactor 'by_regexp'

* docs(README): update example, add 'API'

* ci(travis): fix .travis.yml

* refactor: fix Flow issues, refactor examples

Author: borodayev

.travis.yml

@@ -11,11 +11,7 @@ node_js:
   - "8"
 before_install:
   - yarn global add greenkeeper-lockfile@1
-  - openssl aes-256-cbc -K $encrypted_07079be19108_key -iv $encrypted_07079be19108_iv -in git_deploy_key.enc -out /tmp/git_deploy_key -d
-  - chmod 600 /tmp/git_deploy_key
-  - echo 'echo ${SSH_PASSPHRASE}' > /tmp/askpass && chmod +x /tmp/askpass
-  - eval "$(ssh-agent -s)"
-  - DISPLAY=":0.0" SSH_ASKPASS="/tmp/askpass" setsid ssh-add /tmp/git_deploy_key </dev/null
+  
 before_script: greenkeeper-lockfile-update
 after_script: greenkeeper-lockfile-upload
 script:

README.md

@@ -18,10 +18,12 @@ This is a wrapper for [AWS.SNS](https://aws.amazon.com/sns/) and [SMSC API](http
 yarn add @frankast/sms-sender
 ```
 
-## Examples
+## 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.
 
+
+#### Sending SMS
 To send an SMS you have to create an instance of provider and call `sendSms()` method:
 
 ```js
@@ -39,6 +41,7 @@ const response = await smsc.sendSms('phone_number', 'message');
 // response = { messageId: 'id-phone_number', rawResponse: { cnt: 1, id: 50 }}
 ```
 
+#### Get delivery status of SMS
 To check the delivery status of SMS call `getStatus()` method:
 
 ```js
@@ -68,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
@@ -77,6 +81,7 @@ const response = await smsc.getCost('phone_number','message');
 // response = { cost: '0', rawResponse: { cnt: 1, cost: '25' } };
 ```
 
+#### Get current balance
 To get the current balance on your account call `getBalance()` method:
 
 ```js
@@ -86,6 +91,7 @@ To get the current balance on your account call `getBalance()` method:
 // response = { balance: '84.75', currency: 'KZT' };
 ```
 
+## Examples
 Here is an example of usage with RegExp:
 
 ```js
@@ -100,31 +106,29 @@ const providers = {
     password: '',
   }),
 
-// put here or in ~/.aws/credentials
   sns: new Sns({
     region: '',
     accessKeyId: '',
     secretAccessKey: '',
   }),
 };
 
-function getProvider(providerName: string, defaultName?: string = 'smsc'): any {
-  const regexp = RegExp(providerName, 'g');
+async function send(phone: string, message: string): Promise<Object> {
+  const regexp = RegExp('7708', 'g');
   let provider;
-  Object.keys(providers).forEach(name => {
-    if (regexp.test(name)) {
-      provider = providers[name];
-    } else {
-      provider = providers[defaultName];
-    }
-  });
-
-  return provider;
+  if (regexp.test(phone)) {
+    provider = providers.smsc;
+  } else {
+    provider = providers.sns;
+  }
+  const res = await provider.sendSms(phone, message);
+  return res;
 }
 
-const provider = getProvider('sm');
+send('+77081113344', 'hello world').then(res => {
+  console.log(res);
+});
 
-provider.sendSms('77718637484', 'test').then(res => console.log(res));
 
 ```
 

examples/by_regexp/index.js

@@ -18,22 +18,18 @@ const providers = {
   }),
 };
 
-function getProvider(providerName: string, defaultName?: string = 'smsc'): any {
-  const regexp = RegExp(providerName, 'g');
+async function send(phone: string, message: string): Promise<Object> {
+  const regexp = RegExp('7708', 'g');
   let provider;
-  Object.keys(providers).forEach(name => {
-    if (regexp.test(name)) {
-      provider = providers[name];
-    } else {
-      provider = providers[defaultName];
-    }
-  });
-
-  return provider;
+  if (regexp.test(phone)) {
+    provider = providers.smsc;
+  } else {
+    provider = providers.sns;
+  }
+  const res = await provider.sendSms(phone, message);
+  return res;
 }
 
-const provider = getProvider('sm');
-
-provider.sendSms('77718637484', 'test').then(res => {
+send('+77081113344', 'hello world').then(res => {
   console.log(res);
 });

examples/retry_another/index.js

@@ -1,5 +1,4 @@
 // @flow
-
 /* eslint-disable no-console */
 
 import Smsc from '../../src/transporters/Smsc';
@@ -19,31 +18,24 @@ const providers = {
   }),
 };
 
-async function retryAnother(phone: string, message: string, providerName: string): Promise<any> {
-  let provider = providers.smsc;
-  Object.keys(providers).forEach(name => {
-    if (name !== providerName) {
-      provider = providers[name];
-    }
-  });
-
-  const res = await provider.sendSms(phone, message);
-  return res;
-}
-
 async function send(phone: string, message: string, providerName: string): Promise<any> {
-  const provider = providers[providerName];
-
-  const res = await provider.sendSms('77718637484', 'test');
-  const { messageId } = res;
-  const status = await provider.getStatus(messageId);
-  if (status === 'ok') {
+  let provider;
+  try {
+    provider = providers[providerName];
+    const res = await provider.sendSms('77718637484', 'test');
+    return res;
+  } catch (e) {
+    Object.keys(providers).forEach(key => {
+      if (providerName !== key) {
+        provider = providers[key];
+      }
+    });
+    if (!provider) throw new Error(e);
+    const res = await provider.sendSms('77718637484', 'test');
     return res;
   }
-  const res2 = await retryAnother(phone, message, providerName);
-  return res2;
 }
 
-send('77718637484', 'with_db', 'smsc').then(res => {
+send('77718637484', 'with_mongoose', 'smsc').then(res => {
   console.log(res);
 });

examples/with_db/index.js examples/with_mongoose/index.js

@@ -7,10 +7,10 @@ import { Sms } from './schema/Sms';
 
 import DB from './schema/db';
 
-// put here your mongo connection
+// don't forget to put your mongo connection string here
 DB.init('MONGO_CONNECTION_STRING');
 
-// don't forget to put your credentials
+// don't forget to put your credentials here
 const providers = {
   smsc: new Smsc({
     login: '',

examples/with_db/schema/Sms.js examples/with_mongoose/schema/Sms.js

@@ -57,10 +57,13 @@ export class SmsDoc /* :: extends Mongoose$Document */ {
   rawResponse: mixed;
 
   static _providers: ProvidersT;
-  static _providerDefault: string = 'smsc';
+  static _providerDefault: string = '';
 
-  static setProviders(providers: ProvidersT, providerDefault: string) {
+  static setProviders(providers: ProvidersT) {
     this._providers = providers;
+  }
+
+  static setDefaultProvider(providerDefault: string) {
     this._providerDefault = providerDefault;
   }
 
@@ -69,12 +72,14 @@ export class SmsDoc /* :: extends Mongoose$Document */ {
     let provider;
 
     if (!providerName) {
-      provider = _providers[_providerDefault];
-      if (!provider)
-        throw new Error(
-          `Cannot find provider: ${_providerDefault} in providers!\n
-           Please specify correct default provider.`
-        );
+      if (_providerDefault) {
+        provider = _providers[_providerDefault];
+      } else {
+        // $FlowFixMe
+        provider = _providers[0];
+      }
+
+      if (!provider) throw new Error(`You shold specify at least one: provider or providerDefault`);
     } else {
       provider = _providers[providerName];
       if (!provider) throw new Error(`Cannot find provider: ${providerName} in providers!`);

examples/with_db/schema/db.js examples/with_mongoose/schema/db.js

@@ -2,7 +2,7 @@
   "name": "@frankast/sms-sender",
   "main": "lib/index.js",
   "version": "0.0.0-semantically-released",
-  "description": "This is a wrapper for SMSC API & AWS in Node.js",
+  "description": "This is a wrapper for AWS.SNS & SMSC API in Node.js",
   "files": [
     "lib"
   ],
@@ -70,8 +70,8 @@
     ]
   },
   "scripts": {
-    "demo-db": "./node_modules/.bin/babel-node ./examples/with_db/index.js",
-    "demo-regexp": "./node_modules/.bin/babel-node ./examples/by_regexp/index.js",
+    "demo-with-mongoose": "./node_modules/.bin/babel-node ./examples/with_mongoose/index.js",
+    "demo-by-regexp": "./node_modules/.bin/babel-node ./examples/by_regexp/index.js",
     "demo-retry-another": "./node_modules/.bin/babel-node ./examples/retry_another/index.js",
     "build": "npm run build-cjs && npm run build-flow",
     "build-cjs": "rimraf lib && babel src --ignore __tests__,__mocks__,__fixtures__ -d lib",

git_deploy_key.enc

@@ -62,44 +62,18 @@ export default class Sns implements ProviderI {
     return 'sns';
   }
 
-  // AWS.SDK DOES NOT PROVIDE THE WAYS TO IMPLEMENTS THESE METHODS
-
   // eslint-disable-next-line
-   async getCost(phone: string, message: string): Promise<GetCostResponseT> {
-    return new Promise(resolve => {
-      resolve({ cost: '0', rawResponse: { cnt: 1, cost: '0' } });
-    });
+  async getCost(phone: string, message: string): Promise<GetCostResponseT> {
+    throw new Error(`AWS.SNS does not support getting cost via 'aws-sdk'`);
   }
 
   // eslint-disable-next-line
   async getStatus(messageId: string): Promise<GetStatusResponseT> {
-    return new Promise(resolve => {
-      resolve({
-        rawResponse: {
-          cost: '0.00',
-          country: 'Казахстан',
-          last_date: '13.03.2018 15:50:50',
-          last_timestamp: 1520934650,
-          message: 'hello',
-          operator: 'Beeline',
-          phone: '77718637484',
-          region: '',
-          send_date: '13.03.2018 15:50:46',
-          send_timestamp: 1520934646,
-          sender_id: 'SMS-CENTRE',
-          status: 1,
-          status_name: 'Доставлено',
-          type: 0,
-        },
-        status: 'ok',
-      });
-    });
+    throw new Error(`AWS.SNS does not support getting status via 'aws-sdk'`);
   }
 
   // eslint-disable-next-line
   async getBalance(): Promise<GetBalanceResponseT> {
-    return new Promise(resolve => {
-      resolve({ balance: '84.75', rawResponse: { balance: '84.75', currency: 'KZT' } });
-    });
+    throw new Error(`AWS.SNS does not support getting balance via 'aws-sdk'`);
   }
 }

package.json

@@ -4,8 +4,8 @@ import fetchMock from 'fetch-mock';
 import Smsc from '../Smsc';
 
 describe('Smsc', () => {
-  const login = 'test_dev_kz';
-  const password = 'test_dev_kz123';
+  const login = 'SMSC_LOGIN';
+  const password = 'SMSC_PASSWORD';
   const smsc = new Smsc({ login, password });
 
   beforeEach(() => {
@@ -15,7 +15,7 @@ describe('Smsc', () => {
   // send message
   it('sendSms', async () => {
     fetchMock.mock({
-      matcher: `http://smsc.ru/sys/send.php?login=test_dev_kz&psw=test_dev_kz123&phones=77718637484&mes=%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BB%D0%B8%D1%82&tinyurl=1&charset=utf-8&translit=1&fmt=3`,
+      matcher: `http://smsc.ru/sys/send.php?login=SMSC_LOGIN&psw=SMSC_PASSWORD&phones=77718637484&mes=%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BB%D0%B8%D1%82&tinyurl=1&charset=utf-8&translit=1&fmt=3`,
       response: { cnt: 1, id: 50 },
     });
 
@@ -26,7 +26,7 @@ describe('Smsc', () => {
   // get cost of message sending
   it('getCost', async () => {
     fetchMock.mock({
-      matcher: `http://smsc.ru/sys/send.php?login=test_dev_kz&psw=test_dev_kz123&cost=1&phones=77718637484&mes=hello&tinyurl=1&charset=utf-8&translit=1&fmt=3`,
+      matcher: `http://smsc.ru/sys/send.php?login=SMSC_LOGIN&psw=SMSC_PASSWORD&cost=1&phones=77718637484&mes=hello&tinyurl=1&charset=utf-8&translit=1&fmt=3`,
       response: { cnt: 1, cost: '0' },
     });
 
@@ -37,7 +37,7 @@ describe('Smsc', () => {
   // get status of message with full information
   it('getStatus', async () => {
     fetchMock.mock({
-      matcher: `http://smsc.ru/sys/status.php?login=test_dev_kz&psw=test_dev_kz123&id=40&phone=77718637484&all=2&tinyurl=1&charset=utf-8&translit=1&fmt=3`,
+      matcher: `http://smsc.ru/sys/status.php?login=SMSC_LOGIN&psw=SMSC_PASSWORD&id=40&phone=77718637484&all=2&tinyurl=1&charset=utf-8&translit=1&fmt=3`,
       response: {
         cost: '0.00',
         country: 'Казахстан',
@@ -82,7 +82,7 @@ describe('Smsc', () => {
   // get current balance
   it('getBalance', async () => {
     fetchMock.mock({
-      matcher: `http://smsc.ru/sys/balance.php?login=test_dev_kz&psw=test_dev_kz123&cur=1&tinyurl=1&charset=utf-8&translit=1&fmt=3`,
+      matcher: `http://smsc.ru/sys/balance.php?login=SMSC_LOGIN&psw=SMSC_PASSWORD&cur=1&tinyurl=1&charset=utf-8&translit=1&fmt=3`,
       response: { balance: '84.75', currency: 'KZT' },
     });
 

src/transporters/Sns.js

@@ -2,11 +2,19 @@
 
 import Sns from '../Sns';
 
-jest.mock('../Sns');
+const sns = new Sns({ region: 'eu-west-1' });
+// $FlowFixMe
+sns.sendSms = jest.fn().mockImplementation(() => {
+  return {
+    messageId: '8e1e071f-a27d-55db-8ba9-542c4f9c8a73',
+    rawResponse: {
+      MessageId: '8e1e071f-a27d-55db-8ba9-542c4f9c8a73',
+      ResponseMetadata: { RequestId: '919bdf65-2969-5a03-ae88-8c56c48825ab' },
+    },
+  };
+});
 
 describe('Sns', () => {
-  const sns = new Sns({ region: 'eu-west-1' });
-
   // send message
   it('sendSms', async () => {
     const res = await sns.sendSms('+77081949582', 'Hi');