hubot-stock-checker - npm Package Compare versions

Comparing version 1.4.0 to 1.5.0

package.json

 {
   "name": "hubot-stock-checker",
-  "version": "1.4.0",
-  "description": "Hubot script to interact with IEX stock exchange apis. Allows you to quickly check the status of any stock by the symbol.",
-  "main": "index.coffee",
+  "version": "1.5.0",
+  "description": "Hubot script to interact with IEX stock exchange apis. Provides stock quotes, company stats, company info and dividend history. Allows users and channels to manage watchlists of favorite stocks. And provides quick access to IEX top movers, losers, and winners collections.",
+  "main": "index.js",
   "repository": {
@@ -7,0 +7,0 @@ "type": "git",

README.md

@@ -5,5 +5,5 @@ Get quick stats on any stock by asking your hubot!
 
-This integration utilizes hubot to interact with stock stats provided for free by [IEX Trading](https://iextrading.com/developer). Some friends and I wanted to be able to quickly ask our bot in slack for stock updates and realized that the several existing hubot-scripts were old and broken, many relying on the deprecated Yahoo! Finance APIs. Many thanks to IEX Trading for providing a reliable, free, and easy to use API. It made this entire process way to easy. Hats off to you.
+This integration utilizes hubot to interact with stock stats provided for free by [IEX Trading](https://iextrading.com/developer). I wanted quick access via my bot to stock updates and realized that the existing hubot options were old and broken; most relying on the deprecated Yahoo! Finance APIs. Many thanks to IEX Trading for providing a reliable, free, and easy to use API. It made this process super easy. 
 
-If you have a use case that you would like implemented reach out to me via twitter (@kwandrews7) or get your hands dirty and create a pull request. I'd like to keep this package focused on the IEX API just for consistency, but the APIs available are quite extensive and can do much more than I have currently integrated. Check out their API docs linked above to see what all is available. As I have time, and as they are useful to me :), I will continue integrating with more of their available endpoints.
+Since the start of this script, I've been adding features at a pretty good clip to fulfill the of those in our Slack team. However, if you have a feature you want, catch me on twitter (@kwandrews7) or create a pull request. Their API docs are linked above, check it out to see  everything available. 
 
@@ -19,2 +19,4 @@ Example Interaction:
 
+### Data on Individual Stocks
+
 * `hubot get stock (symbol)` - Returns basic stock stats. 'get' is optional. Name, symbol, price, daily price change, day, month, and year price range, and market cap.
@@ -25,2 +27,12 @@ * `hubot get stock (symbol) dividends` - Returns dividend history for the past year. 'dividends' can be replaced with div, divs, or dividends to achieve the same response. 'get' is still optional. Dividends as reported by IEX Trading for the past year. This API is currently missing the the two latest dividends on occasion, an active issue is open on GitHub.
 * `hubot get stock (symbol) news` - Returns related news articles as replies in a thread.
+
+### Saved Watchlists
+
+* Watchlists are saved by channel. This means each channel and direct message will have it's own watchlist.
+* `hubot save stock (symbol)` - Saves the symbol to the current channel's watchlist.
+* `hubot delete stock (symbol)` - Saves the symbol to the current channel's watchlist.
+* `hubot list (our/my) favorites` - Lists basic stock stats for each of the saved symbols.
+
+### IEX Collections 
+
 * `hubot get stock top losers` - Returns stocks with the most downward movement. (max 5).
@@ -43,2 +55,10 @@ * `hubot get stock top movers` - Returns stocks with the most movement, absolute value. (max 5).
 
+### 1.5.0
+
+* Added new watchlist to each channel using save, delete, and list favorites commands.
+* Watchlist are saved to the hubot brain, if you aren't persisting the brain to redis, you'll lose watchlists on restarts.
+* Added message for failed requests.
+* Converted project from coffeescript to javascript.
+* Refactored project into smaller, easier to manage files.
+
 ### 1.4.0
@@ -45,0 +65,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17874

increased by44.09%

Number of package files

9

increased by80%

Lines of code

247

increased byInfinity%

Number of lines in readme file

113

increased by21.51%

Worsened metrics

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes