Merge branch 'sms' into main

Author: Prince25

README.md

@@ -1,5 +1,7 @@
 
-### New in v2.0: :email: E-mail notification support and an user interface :iphone: !! (see [screenshots](#Screenshots))
+### New in v3.0: SMS / Text notification support :iphone: !! (see [SMS](#SMS))
+
+#### New in v2.0: :email: E-mail notification support and an user interface :computer: (see [screenshots](#Screenshots))
 
 # StockAlertBot
 Faced with the scenario of scalpers using bots to hog up all the inventory of popular holiday toys and sell them at ridiculously high markup prices, I decided to put up a fight so we can get our hands on things we ~~want~~ need to survive the #Coronavirus quarantine(s).
@@ -16,7 +18,7 @@ Donate, buy me a <a href="https://buymeacoff.ee/PrinceSingh" target="_blank">Piz
 
 ### How does it work?
 
-Enter links of the products you want tracked and how often you want the program to check if those products are in stock. When an item becomes available, you may configure it to  notify you through variety of alerts including sound, email, discord and slack notifications, text on console, automatically opening the URL in your browser, and more to come.
+Enter links of the products you want tracked and how often you want the program to check if those products are in stock. When an item becomes available, you may configure it to  notify you through variety of alerts including sound, email, discord and slack notifications, SMS / Text, console, automatically opening the URL in your browser, and more to come.
 <br><br>
 
 ### What stores/websites are supported?
@@ -63,7 +65,8 @@ There are only two steps to use this program: 1) enter information and 2) launch
         - If you have Target link(s), you will see additional options to put zip code and API Key. Only change the key if you get API key errors. Refer to the instructions in the following [section](#Via-Text-Editor).
     4. Configure notification options in Optional tab.
         - If you want notifications sent to Discord or Slack, expand WEBHOOKS and enter the URL(s) there.
-        - If you want notifications sent to Email, turn on email and enter your service provider information. Some providers (Yahoo, AOL, AT&T) cause problems. Refer to following [section](#Via-Text-Editor).
+        - If you want notification sent via SMS/Text, expand SMS and choose a method: Amazon Web Services, Email, or Twilio. See [SMS](#SMS).
+        - If you want notifications sent to Email, turn on email and enter your service provider information. Some providers (Yahoo, AOL, AT&T) cause problems. Refer to this [section](#Email).
     5. Once you're happy with the settings, click `Save Settings`.\
     `config.json` and `.env` files should now reflect your settings.\
     You can use `CTRL + C` or `CMD + C` to stop the program.<br><br>
@@ -87,22 +90,62 @@ There are only two steps to use this program: 1) enter information and 2) launch
             4. Paste it to `TARGET_KEY`
         3. **If** you want to send alerts to webhook URL(s) like [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) or [Slack](https://api.slack.com/messaging/webhooks), add them to `WEBHOOK_URLS` array.
         4. **If** you want to use Proxies, change `PROXIES` to `true` and create a file called `proxies.txt` in the root directory and fill it with one proxy per line. See [proxies](#Proxies).
-        5. **If** you want to send alerts to email, change `EMAIL` in `config.json` to `true`. Make a copy of `example.env` and rename it to `.env`. Inside `.env`, type out one of the following service providers (`EMAIL_SERVICE`), your email (`EMAIL_FROM`) and password (`EMAIL_PASS`) and the email you want alerts sent to (`EMAIL_TO`). All without quotes.
-        ```
-        Gmail, Yahoo, iCloud, Hotmail, Outlook365, QQ, 126, 163, 1und1, AOL, DebugMail, DynectEmail, 
-        FastMail, GandiMail, Godaddy, GodaddyAsia, GodaddyEurope, hot.ee, mail.ee, Mail.ru, Maildev, Mailgun, Mailjet, 
-        Mailosaur, Mandrill, Naver, OpenMailBox, Postmark, QQex, SendCloud, SendGrid, SendinBlue, SendPulse, SES, 
-        SES-US-EAST-1, SES-US-WEST-2, SES-EU-WEST-1, Sparkpost, Yandex, Zoho, qiye.aliyun
-        ```
-        **NOTE:** If you receive the error: `535 5.7.0 (#AUTH005) Too many bad auth attempts`, most likely you are using Yahoo for the email server or an email server managed by Yahoo, such as AOL or AT&T. Yahoo has implemented an option that by default, does not let 3rd party products access the email servers. To resolve, go to https://login.yahoo.com/account/security and then enable the option to allow apps that use less secure sign in. Use the password generated by "Generate app password". If you are using AOL, do the same thing, from https://login.aol.com/account/security.
-
+        5. **If** you want to send alerts to SMS, change `SMS_METHOD` to either "Email", "Amazon Web Services", or "Twilio". Then change the associated values in `.env`. See [SMS](#SMS).
+        6. **If** you want to send alerts to email, change `EMAIL` in `config.json` to `true`. Make a copy of `example.env` and rename it to `.env`. Inside `.env`, type out one of the service providers (`EMAIL_SERVICE`) listed in [Email](#Email), your email (`EMAIL_FROM`) and password (`EMAIL_PASS`) and the email you want alerts sent to (`EMAIL_TO`). All without quotes.
+        
 2. Execute and continue about your day: 
     `npm start` OR `node --experimental-modules main.js`\
     You can use `CTRL + C` or `CMD + C` to stop the program.
 
 3. Consider [donating](https://www.paypal.com/donate?business=3Y9NEYR4TURT8&item_name=Making+software+and+hacking+the+world%21+%E2%99%A5&currency_code=USD) or buying me a [Pizza](https://buymeacoff.ee/PrinceSingh) or [PayPal](https://paypal.me/PrinceSingh25) me :smile:
+<br><br>
+
+
+### Email
+Supported email providers:
+```
+    Gmail, Yahoo, iCloud, Hotmail, Outlook365, QQ, 126, 163, 1und1, AOL, DebugMail, DynectEmail, 
+    FastMail, GandiMail, Godaddy, GodaddyAsia, GodaddyEurope, hot.ee, mail.ee, Mail.ru, Maildev, Mailgun, Mailjet, 
+    Mailosaur, Mandrill, Naver, OpenMailBox, Postmark, QQex, SendCloud, SendGrid, SendinBlue, SendPulse, SES, 
+    SES-US-EAST-1, SES-US-WEST-2, SES-EU-WEST-1, Sparkpost, Yandex, Zoho, qiye.aliyun
+```
+
+**NOTE:**  If you receive the error: `535 5.7.0 (#AUTH005) Too many bad auth attempts`, most likely you are using Yahoo for the email server or an email server managed by Yahoo, such as AOL or AT&T. Yahoo has implemented an option that by default, does not let 3rd party products access the email servers. To resolve, go to https://login.yahoo.com/account/security and then enable the option to allow apps that use less secure sign in. Use the password generated by "Generate app password". If you are using AOL, do the same thing, from https://login.aol.com/account/security.
+<br><br>
+
+
+### SMS
+SMS / Text support is now available via Amazon Web Services, Email, or Twilio. This, however, requires some setup on your part. Read below regarding setup for each method:
+
+- **[Amazon Web Services](https://aws.amazon.com/sns)**\
+First, read pricing information [here](https://aws.amazon.com/sns/faqs/#SMS_pricing). First 100 SMS are free for each month as long as you send them to a United States destination. For this method, you will need:
+    - Region
+    - Access Key
+    - Secret Access Key
+    - Phone Number
+
+    Region is Amazon server you want to send from. It's probably best to choose one closest to you. More information [here](https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html).\
+    Access Key and Secret Access Key can be obtained following instructions in this [tutorial](https://medium.com/codephilics/how-to-send-a-sms-using-amazon-simple-notification-service-sns-46208d82abcc).\
+    Phone number is the number to send SMS to. You will need to include country code and area code. Country code information can be found [here](https://countrycode.org/).
+
+- **Email**\
+**FREE** but limited. Uses email to send text via phone carrier's [SMS gateway](https://en.wikipedia.org/wiki/SMS_gateway). Mostly the same setup as [Email](#Email).\
+Currently supported carriers: Alltel, AT&T, Boost Mobil, Cricket Wireless, FirstNet, Google Project Fi, MetroPCS, Republic Wireless, Sprint, Straight Talk, T-Mobile, Ting, U.S. Cellular, Verizon Wireless, Virgin Mobile.\
+If you'd like to request a carrier, please refer to [Feedback and Support](#Feedback-and-Support) and provide your carrier's SMS gateway if possible.
+
+- **[Twilio](https://www.twilio.com/sms)**\
+First, read pricing information [here](https://www.twilio.com/sms/pricing). You get some free starting balance with which you can buy a Twilio phone number. For this method, you will need:
+    - Twilio Account SID
+    - Twilio Auth Token
+    - Twilio Phone Number
+    - Phone Number
+
+    The first three can easily be obtained from the [Twilio console](https://www.twilio.com/console) after you make a Twilio account.\
+    Phone number is the number to send SMS to. You will need to include country code and area code. Country code information can be found [here](https://countrycode.org/).
+<br><br>
+
 
-#### Proxies
+### Proxies
 If you plan to use low interval rates OR track several items from one store, it is highly recommended that you use proxies such as ones from [Webshare](https://www.webshare.io/) in the format `ip:port` for IP-based authentication or `username:password@ip:port`.<br>\
 **NOTE:** The following stores do not currently with proxies due to them blocking some connections/headers which results in inconsistent connection: Argos, Best Buy, Costco, and Tesco. Thus we thought it'd be best if we take off proxy support for now until we can do some further research or find an alternative way.
 
@@ -135,10 +178,11 @@ To provide monetary support, [donate](https://www.paypal.com/donate?business=3Y9
     * ~~Tesco~~
     * ~~Argos~~
 * Add delay between items from the same store
-* Add ~~Email and Maybe~~ SMS Notifications
 * More OOP!!
     * Add way to track notification status independent of items in a store
 * ~~Fix~~ Find Bugs
+    * Fix notifications relying on `OPEN_URL`
+* ~~Add Email and SMS Notifications~~ 
 * ~~Add Proxies~~
 * ~~Add GUI - Make it easier to use~~ 
 * ~~Initially create seperation between intervals for Amazon items~~

config.json

@@ -29,5 +29,6 @@
         "slack"
     ],
     "PROXIES": false,
-    "EMAIL": false
+    "EMAIL": false,
+    "SMS_METHOD": "None"
 }

example.env

@@ -1,7 +1,20 @@
-# ** Configuration for email alerts ** #
-########################################
+# ** Configuration for alerts ** #
+##################################
 
 EMAIL_SERVICE = 
 EMAIL_FROM = 
 EMAIL_PASS = 
-EMAIL_TO = 
+EMAIL_TO = 
+SMS_AWS_REGION = 
+SMS_AWS_ACCESS_KEY = 
+SMS_AWS_SECRET_ACCESS = 
+SMS_AWS_PHONE_NUMBER = 
+SMS_EMAIL_SERVICE = 
+SMS_EMAIL_FROM = 
+SMS_EMAIL_PASS = 
+SMS_EMAIL_PHONE_CARRIER = 
+SMS_EMAIL_PHONE_NUMBER = 
+SMS_TWILIO_ACCOUNT_SID = 
+SMS_TWILIO_AUTH_TOKEN = 
+SMS_TWILIO_FROM_NUMBER = 
+SMS_TWILIO_TO_NUMBER = 

main.js

@@ -24,12 +24,13 @@ export var {
     INTERVAL,
     OPEN_URL,
     ALARM,
-    PROXIES,
     AMAZON_DELAY,
     TARGET_ZIP_CODE,
     TARGET_KEY,
+    WEBHOOK_URLS,
+    PROXIES,
     EMAIL,
-    WEBHOOK_URLS
+    SMS_METHOD, // "None", "Amazon Web Services", "Email", "Twilio"
 } = require('./config.json')
 
 // For Testing