open311-infobip
sms transport for open311 messages using infobip
Note!:It highly adviced to process start infobip transport
in separate process for optiomal performance
Requirements
Installation
$ npm install --save open311-infobip
Usage
const mongoose = ;const Message = <options>;const infobip = ;infobipoptions = from:<your_infobip_account_sender_id> username:<your_infobip_account_username> password:<your_infobip_account_password>; //queue message for sendingconst message = <message_details>;infobip; //start infobip sms worker(s) in background process(s)//to process and send queued message(s) as sms(s)infobipstart;
Options
from:String
valid infobip account sms sender idusername:String
valid infobip account usernamepassword:String
valid infobip account passwordfake:Boolean
whether to fake sms sending. Default to false. See- All kue supported configuration options
Testing
-
Clone this repository
-
Install all development dependencies
$ npm install
- Then run unit test
$ npm test
- To run integration test ensure your exported below environment variables
export INFOBIP_FROM="my value"export INFOBIP_USERNAME="my value"export INFOBIP_PASSWORD="my value"export INFOBIP_TEST_RECEIVER="my value"
Then run integration test
$ npm run integration
Contribute
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
Licence
The MIT License (MIT)
Copyright (c) 2017 lykmapipo, CodeTanzania & Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.