Merge pull request #70 from Humans-of-Julia/tk/ig-yahoo-provider

Yahoo as real-time quote provider & new perf command

CONTRIBUTING.md

@@ -40,8 +40,7 @@ At this point, you can start running the bot.
 
 1. Locate your discord bot token from the Bot screen
 2. Define `HOJBOT_DISCORD_TOKEN` environment variable in your shell profile.
-3. Define `FINNHUB_TOKEN` environment variable if you are developing for the investment game. You can get your own [API key from finnhub.io](https://finnhub.io/).
-4. Start the bot using `script/run.sh` script
+3. Start the bot using either `script/run.sh` script, or `ENABLE_WARM_UP=0 script/run.sh`. The latter is useful if you want to test features other than the investment game and don't want to wait for the long warm up period needed for setting it up.
 
 Then, you can go to your own Discord server and enter some commands
 to see if it's working properly. For example:

script/run.sh

@@ -6,11 +6,6 @@ if [[ -z "$HOJBOT_DISCORD_TOKEN" ]]; then
     exit 1
 fi
 
-if [[ -z "$FINNHUB_TOKEN" ]]; then
-    echo "Warning: FINNHUB_TOKEN must be set for investment game to function properly."
-    echo "  Get your own token at https://finnhub.io/"
-fi
-
 # Default environment settings
 : ${RUN_ONCE=no}
 : ${RUN_DURATION_MINUTES=2880}

src/command/ig.jl

@@ -1,7 +1,5 @@
 const QUOTE_CACHE = Cache{String,Float64}(Minute(1))
 
-finnhub_token() = get(ENV, "FINNHUB_TOKEN", "")
-
 function commander(c::Client, m::Message, ::Val{:ig})
     @debug "ig_commander called"
 
@@ -11,7 +9,7 @@ function commander(c::Client, m::Message, ::Val{:ig})
 
     if length(args) == 0 ||
             args[1] ∉ ["start-game", "abandon-game", "quote", "chart",
-                "buy", "sell", "rank", "view",
+                "buy", "sell", "perf", "rank", "view",
                 "abandon-game-really"]
         help_commander(c, m, :ig)
         return
@@ -49,6 +47,7 @@ function help_commander(c::Client, m::Message, ::Val{:ig})
         Manage portfolio:
         ```
         ig view                - view holdings and current market values
+        ig perf                - compare with yesterday's EOD prices
         ig buy <n> <symbol>    - buy <n> shares of a stock
         ig sell <n> <symbol>   - sell <n> shares of a stock
         ```
@@ -99,20 +98,23 @@ function ig_execute(c::Client, m::Message, user::User, ::Val{Symbol("start-game"
     pf = ig_start_new_game(user.id)
     discord_reply(c, m, ig_hey(user.username, "you have \$" * format_amount(pf.cash) *
         " in your shiny new portfolio now! Good luck!"))
+    return nothing
 end
 
 function ig_execute(c::Client, m::Message, user::User, ::Val{Symbol("abandon-game")}, args)
     ig_affirm_player(user.id)
     discord_reply(c, m, ig_hey(user.username,
         "do you REALLY want to abandon the game and wipe out all of your data? " *
         "If so, type `ig abandon-game-really`."))
+    return nothing
 end
 
 function ig_execute(c::Client, m::Message, user::User, ::Val{Symbol("abandon-game-really")}, args)
     ig_affirm_player(user.id)
     ig_remove_game(user.id)
     discord_reply(c, m, ig_hey(user.username,
         "your investment game is now over. Play again soon!"))
+    return nothing
 end
 
 function ig_execute(c::Client, m::Message, user::User, ::Val{:buy}, args)
@@ -127,6 +129,7 @@ function ig_execute(c::Client, m::Message, user::User, ::Val{:buy}, args)
     purchase_price = ig_buy(user.id, symbol, shares)
     discord_reply(c, m, ig_hey(user.username, "you have bought $shares shares of $symbol at \$" *
         format_amount(purchase_price)))
+    return nothing
 end
 
 function ig_execute(c::Client, m::Message, user::User, ::Val{:sell}, args)
@@ -141,6 +144,42 @@ function ig_execute(c::Client, m::Message, user::User, ::Val{:sell}, args)
     current_price = ig_sell(user.id, symbol, shares)
     discord_reply(c, m, ig_hey(user.username, "you have sold $shares shares of $symbol at \$" *
         format_amount(current_price)))
+    return nothing
+end
+
+function ig_execute(c::Client, m::Message, user::User, ::Val{:perf}, args)
+    ig_affirm_player(user.id)
+    df = ig_perf(user.id)
+    table = pretty_table(String, df; header = names(df))
+    discord_reply(
+        c, m,
+        ig_hey(user.username, """your stocks' performance today:
+            ```
+            $table
+            ```
+            """
+        )
+    )
+    return nothing
+end
+
+function ig_perf(user_id::UInt64)
+    pf = ig_load_portfolio(user_id)
+    symbols = [h.symbol for h in pf.holdings]
+    prices_yesterday = fetch.(@async(ig_yesterday_price(s)) for s in symbols)
+    prices_today = fetch.(@async(ig_get_quote(s)) for s in symbols)
+    prices_change = prices_today .- prices_yesterday
+    prices_change_pct = prices_change ./ prices_yesterday * 100
+    df = DataFrame(
+        symbol = symbols,
+        px_eod = prices_yesterday,
+        px_now = prices_today, 
+        chg = round.(prices_change; digits = 2), 
+        pct_chg = round.(prices_change_pct; digits = 1),
+    )
+    rename!(df, "pct_chg" => "% chg")
+    sort!(df, :symbol)
+    return df
 end
 
 function ig_execute(c::Client, m::Message, user::User, ::Val{:view}, args)
@@ -153,29 +192,36 @@ function ig_execute(c::Client, m::Message, user::User, ::Val{:view}, args)
     table = ig_view_table(view, df)
     total_str = format_amount(round(Int, sum(df.amount)))
 
-    discord_reply(c, m, ig_hey(user.username,
-        """
-        here is your portfolio:
-        ```
-        $table
-        ```
-        Total portfolio Value: $total_str
-        """))
+    discord_reply(
+        c, m, 
+        ig_hey(user.username,
+            """
+            here is your portfolio:
+            ```
+            $table
+            ```
+            Total portfolio Value: $total_str
+            """
+        )
+    )
+    return nothing
 end
 
 # Shorten colummn headings for better display in Discord
 function ig_reformat_view!(df::AbstractDataFrame)
     select!(df, Not(:purchase_price))
     rename!(df, "current_price" => "price", "market_value" => "amount")
+    return df
 end
 
 function ig_execute(c::Client, m::Message, user::User, ::Val{:quote}, args)
     length(args) == 1 ||
         throw(IgUserError("Invalid command. Try `ig quote aapl` to fetch the current price of Apple Inc."))
 
     symbol = strip(uppercase(args[1]))
-    price = ig_get_real_time_quote(symbol)
+    price = ig_real_time_price(symbol)
     discord_reply(c, m, ig_hey(user.username, "the current price of $symbol is " * format_amount(price)))
+    return nothing
 end
 
 function ig_execute(c::Client, m::Message, user::User, ::Val{:chart}, args)
@@ -192,6 +238,7 @@ function ig_execute(c::Client, m::Message, user::User, ::Val{:chart}, args)
         content = ig_hey(user.username, "here is the chart for $symbol for the past $lookback. " *
             "To plot a chart with different time horizon, " *
             "try something like `ig chart $symbol 90d` or `ig chart $symbol 10y`."))
+    return nothing
 end
 
 function ig_execute(c::Client, m::Message, user::User, ::Val{:rank}, args)
@@ -206,11 +253,16 @@ function ig_execute(c::Client, m::Message, user::User, ::Val{:rank}, args)
     rt = rt[1:min(n, nrow(rt)), :]  # get top N results
     rt_str = ig_view_table(PrettyView(), rt)
 
-    discord_reply(c, m, ig_hey(user.username, """here's the current ranking:
-    ```
-    $rt_str
-    ```
-    """))
+    discord_reply(
+        c, m,
+        ig_hey(user.username, """here's the current ranking:
+            ```
+            $rt_str
+            ```
+            """
+        )
+    )
+    return nothing
 end
 
 function ig_ranking_table(c::Client)
@@ -224,6 +276,7 @@ function ig_ranking_table(c::Client)
             player = [users_dict[v.id].username for v in valuations],
             portfolio_value = [v.total for v in valuations],
         )
+        return df
     else
         return DataFrame(player = String[], portfolio_value = Float64[])
     end
@@ -249,7 +302,7 @@ function ig_value_all_portfolios()
     end
     sort!(valuations; lt = (x,y) -> x.total < y.total, rev = true)
     # @info "ig_value_all_portfolios result" valuations
-    valuations
+    return valuations
 end
 
 "Format money amount"
@@ -335,23 +388,10 @@ function ig_load_all_portfolios()
         for (user_id, file) in zip(user_ids, files))
 end
 
-"Fetch the current quote of a stock"
-@mockable function ig_get_real_time_quote(symbol::AbstractString)
-    @info "$(now()) real time quote: $symbol"
-    token = finnhub_token()
-    length(token) > 0 || throw(IgSystemError("No market price provider. Please report to admin."))
-    symbol = HTTP.escapeuri(symbol)
-    response = HTTP.get("https://finnhub.io/api/v1/quote?symbol=$symbol&token=$token")
-    data = JSON3.read(response.body)
-    current_price = data.c
-    current_price > 0 || throw(IgUserError("there is no price for $symbol. Is it a valid stock symbol?"))
-    return Float64(current_price)
-end
-
 "Fetch quote of a stock, but possibly with a time delay."
 function ig_get_quote(symbol::AbstractString)
     return get!(QUOTE_CACHE, symbol) do
-        ig_get_real_time_quote(symbol)
+        ig_real_time_price(symbol)
     end
 end
 
@@ -360,7 +400,7 @@ function ig_buy(
     user_id::UInt64,
     symbol::AbstractString,
     shares::Real,
-    current_price::Real = ig_get_real_time_quote(symbol)
+    current_price::Real = ig_real_time_price(symbol)
 )
     @debug "Buying stock" user_id symbol shares
     pf = ig_load_portfolio(user_id)
@@ -381,7 +421,7 @@ function ig_sell(
     user_id::UInt64,
     symbol::AbstractString,
     shares::Real,
-    current_price::Real = ig_get_real_time_quote(symbol)
+    current_price::Real = ig_real_time_price(symbol)
 )
     @debug "Selling stock" user_id symbol shares
     pf = ig_load_portfolio(user_id)
@@ -475,7 +515,7 @@ end
 
 "Add columns with current price and market value"
 function ig_mark_to_market!(df::AbstractDataFrame)
-    df.current_price = [ig_get_quote(s) for s in df.symbol]
+    df.current_price = fetch.(@async(ig_get_quote(s)) for s in df.symbol)
     df.market_value = df.shares .* df.current_price
     return df
 end
@@ -532,7 +572,9 @@ function ig_historical_prices(symbol::AbstractString, from_date::Date, to_date::
     url = "https://query1.finance.yahoo.com/v7/finance/download/$symbol?" *
         "period1=$from_sec&period2=$to_sec&interval=1d&events=history&includeAdjustedClose=true"
     try
-        return DataFrame(CSV.File(Downloads.download(url)))
+        elapsed = @elapsed df = DataFrame(CSV.File(Downloads.download(url)))
+        @debug "ig_historical_prices" symbol from_date to_date elapsed
+        return df
     catch ex
         if ex isa Downloads.RequestError && ex.response.status == 404
             throw(IgUserError("there is no historical prices for $symbol. Is it a valid stock symbol?"))
@@ -542,6 +584,26 @@ function ig_historical_prices(symbol::AbstractString, from_date::Date, to_date::
     end
 end
 
+"Return yesterday's EOD pricing data"
+@mockable ig_yesterday_price(symbol::AbstractString) = ig_latest_price(symbol, Day(1))
+
+"Return real-time pricing data"
+@mockable ig_real_time_price(symbol::AbstractString) = ig_latest_price(symbol, Day(0))
+
+# Using Yahoo's historical price query to find the latest price
+# Fortunately, Yahoo also provides real-time prices, so setting offset to Day(0)
+# would return the current price.
+function ig_latest_price(symbol::AbstractString, offset::DatePeriod)
+    to_date = today() - offset
+    from_date = to_date - Day(4)   # account for weekend and holidays
+    df = ig_historical_prices(symbol, from_date, to_date)
+    if nrow(df) >= 1
+        return df[end, "Adj Close"]
+    else
+        return 0.0
+    end
+end
+
 "Plot a simple price chart"
 function ig_chart(symbol::AbstractString, dates::Vector{Date}, values::Vector{<:Real})
     theme(:dark)

test/test_ig.jl

@@ -12,7 +12,7 @@ using HoJBot:
     recent_date_range, retrieve, retrieve_users, upload_file,
     ig_affirm_non_player, ig_affirm_player,
     ig_buy, ig_cash_entry, ig_chart, ig_count_shares, ig_execute,
-    ig_file_path, ig_get_real_time_quote, ig_grouped_holdings, ig_hey,
+    ig_file_path, ig_real_time_price, ig_grouped_holdings, ig_hey,
     ig_historical_prices, ig_holdings_data_frame, ig_is_player,
     ig_load_all_portfolios, ig_load_portfolio, ig_mark_to_market!,
     ig_mark_to_market_portfolio, ig_ranking_table,
@@ -92,7 +92,7 @@ mocked_client() = Client("hey")
     end
 
     test_ig_cases("Buy/sell") do
-        apply(ig_get_real_time_quote => mock_ig_get_quote_100) do
+        apply(ig_real_time_price => mock_ig_get_quote_100) do
             # Buy something, portfolio should be updated
             executed_price = @test_nowarn ig_buy(USER_ID, "AAPL", 50)
             @test executed_price == 100.0
@@ -165,7 +165,7 @@ mocked_client() = Client("hey")
 
         # mark to market
         df2 = copy(df)
-        apply(ig_get_real_time_quote => mock_ig_get_quote_100) do
+        apply(ig_real_time_price => mock_ig_get_quote_100) do
             @test_nowarn ig_mark_to_market!(df2)
             @test hasproperty(df2, :current_price)
             @test hasproperty(df2, :market_value)
@@ -192,7 +192,7 @@ mocked_client() = Client("hey")
         ig_buy(USER_ID2, "AAPL", 100, 120)  # bought at higher price i.e. less cash remaining
         ig_buy(USER_ID2, "IBM", 100, 120)
         apply(
-            ig_get_real_time_quote => mock_ig_get_quote_100,
+            ig_real_time_price => mock_ig_get_quote_100,
             retrieve_users => mock_retrieve_users,
         ) do
             valuations = @test_nowarn ig_value_all_portfolios()
@@ -215,7 +215,7 @@ mocked_client() = Client("hey")
             discord_channel => mock_channel,
             discord_reply => mock_reply,
             discord_upload_file => mock_upload_file,
-            ig_get_real_time_quote => mock_ig_get_quote_100,
+            ig_real_time_price => mock_ig_get_quote_100,
             retrieve_users => mock_retrieve_users,
         ) do
             @test_nowarn ig_execute(c, m, u, Val(Symbol("start-game")), [])