yahoo_finance_client 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0ac5c76c098d2bed0c2960381c799e4669a5e6bfac74d223c1f7dceadc650af
-  data.tar.gz: a3738e2f466198761b923b4f3293e887a6de856e9cdcaca30fd6c473d55fd606
+  metadata.gz: ec1a70f9b1a9927d6b36ea559dbaf4204f8c82ad37d70b2c2feab47864cd01ac
+  data.tar.gz: 3a91d7848dffe1d5ca1532e31c513f4465ad9147f93c8a6984dfabf320c65337
 SHA512:
-  metadata.gz: 195bcd6094858a5df15ca67424aeddc8564c11ac2f3871608d1e6fdd6275e0622d1570158960befa9260f5d187ff6c83c7f36af3ab6144f3692d3e641bebc547
-  data.tar.gz: 1e910b49a4b0147b87d464c34b5e9d525b48e9ec1150b56eefcf929cca3957b965fce221ac7b2c57c6f3e4fbdf5f4dae66fc133b3f0fec4a0e21f8b4f83f16ce
+  metadata.gz: b489b0a5689876b9f13e8876263ce54c2878a7aea9e4ad421114d9ee4434c50764c89d9cb6a19a0605bc0e4bc777f14ff641edbef314e57bdf4ddc365c9428ac
+  data.tar.gz: daffd51bf44af895b9741b94278ef5d81729f7bdc0b3250b91b0897009cfe30b069beedcd14c3d02a7f22bc40e01907eb8fab80655a5ea02c14e90e002d1a87c

data/.rubocop.yml

@@ -11,7 +11,7 @@ Metrics/AbcSize:
   Max: 25
 
 Metrics/ClassLength:
-  Max: 150
+  Max: 200
 
 Metrics/MethodLength:
   Max: 11

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Change Log
 
+## [0.4.1] - 2026-02-13
+
+- Add `fifty_two_week_high` and `fifty_two_week_low` fields to quote data
+
+## [0.4.0] - 2026-02-12
+
+- Add dividend history fetching via chart API (`get_dividend_history`)
+- Update README with bulk quotes, dividend history, and caching docs
+
+## [0.3.1] - 2026-02-12
+
+- Add `ex_dividend_date` and `dividend_date` fields to quote data
+
+## [0.3.0] - 2026-02-10
+
+- Add bulk quotes support with `get_quotes` method
+
+## [0.2.1] - 2026-01-29
+
+- Add extended stock information fields (EPS, PE ratio, dividend data, moving averages)
+
+## [0.2.0] - 2026-01-27
+
+- Add multi-strategy authentication with retry logic
+- Add CLAUDE.md with project instructions
+
 ## [0.1.6] - 2025-02-18
 
 - Adding a simple cache

data/README.md

@@ -32,11 +32,46 @@ gem install yahoo_finance_client
 
 ## Usage
 
-You should be able to get stock data by calling this method and passing a string with the stock ticker:
+### Single Quote
+
+Fetch stock data by passing a ticker symbol:
 ```ruby
 YahooFinanceClient::Stock.get_quote("AAPL")
+# => {
+#   symbol: "AAPL", name: "Apple Inc.", price: 182.52,
+#   change: 1.25, percent_change: 0.69, volume: 48123456,
+#   pe_ratio: 28.5, eps: 6.40,
+#   dividend: 0.96, dividend_yield: 0.53, payout_ratio: 15.0,
+#   ma50: 178.30, ma200: 172.15,
+#   ex_dividend_date: #<Date: 2025-02-07>, dividend_date: #<Date: 2025-02-15>
+# }
+```
+
+### Bulk Quotes
+
+Fetch multiple quotes at once (batched in groups of 50):
+```ruby
+YahooFinanceClient::Stock.get_quotes(["AAPL", "MSFT", "GOOG"])
+# => { "AAPL" => { symbol: "AAPL", ... }, "MSFT" => { ... }, "GOOG" => { ... } }
+```
+
+### Dividend History
+
+Fetch historical dividend payments via the chart API:
+```ruby
+YahooFinanceClient::Stock.get_dividend_history("AAPL")
+# => [{ date: #<Date: 2024-02-09>, amount: 0.24 }, ...]
 ```
 
+The default range is `"2y"`. You can pass a different range:
+```ruby
+YahooFinanceClient::Stock.get_dividend_history("AAPL", range: "5y")
+```
+
+### Caching
+
+All responses are cached for 5 minutes (300 seconds). The cache is shared across `get_quote`, `get_quotes`, and `get_dividend_history`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/yahoo_finance_client/stock.rb

@@ -7,6 +7,7 @@ module YahooFinanceClient
   # This class provides methods to interact with Yahoo Finance API for stock data.
   class Stock
     QUOTE_PATH = "/v7/finance/quote"
+    CHART_PATH = "/v8/finance/chart"
     CACHE_TTL = 300
     MAX_RETRIES = 2
     BATCH_SIZE = 50
@@ -28,6 +29,11 @@ module YahooFinanceClient
         results
       end
 
+      def get_dividend_history(symbol, range: "2y")
+        cache_key = "div_history_#{symbol}_#{range}"
+        fetch_from_cache(cache_key) || fetch_and_cache_dividend_history(cache_key, symbol, range)
+      end
+
       private
 
       def partition_cached(symbols)
@@ -146,6 +152,7 @@ module YahooFinanceClient
           dividend: dividend, dividend_yield: calculate_yield(dividend, price),
           payout_ratio: calculate_payout(dividend, eps),
           ma50: quote["fiftyDayAverage"], ma200: quote["twoHundredDayAverage"],
+          fifty_two_week_high: quote["fiftyTwoWeekHigh"], fifty_two_week_low: quote["fiftyTwoWeekLow"],
           ex_dividend_date: parse_unix_date(quote["exDividendDate"]),
           dividend_date: parse_unix_date(quote["dividendDate"])
         }
@@ -169,6 +176,61 @@ module YahooFinanceClient
         Time.at(value).utc.to_date
       end
 
+      def fetch_and_cache_dividend_history(cache_key, symbol, range)
+        data = fetch_dividend_history_data(symbol, range)
+        store_in_cache(cache_key, data) unless data.empty?
+        data
+      end
+
+      def fetch_dividend_history_data(symbol, range)
+        retries = 0
+        begin
+          response = make_chart_request(symbol, range)
+          parse_dividend_history(response)
+        rescue AuthenticationError
+          retries += 1
+          retry if retries <= MAX_RETRIES
+          []
+        end
+      end
+
+      def make_chart_request(symbol, range)
+        session = Session.instance
+        session.ensure_authenticated
+        url = "#{session.base_url}#{CHART_PATH}/#{symbol}?range=#{range}&interval=1mo&events=div&crumb=#{session.crumb}"
+        HTTParty.get(url, headers: { "User-Agent" => Session::USER_AGENT, "Cookie" => session.cookie })
+      end
+
+      def parse_dividend_history(response)
+        raise_if_auth_error(response)
+        return [] unless response.success?
+
+        dividends = JSON.parse(response.body).dig("chart", "result", 0, "events", "dividends")
+        return [] unless dividends
+
+        build_dividend_entries(dividends)
+      end
+
+      def raise_if_auth_error(response)
+        return unless auth_error?(response)
+
+        Session.instance.invalidate!
+        raise AuthenticationError, "Authentication failed"
+      end
+
+      def build_dividend_entries(dividends)
+        entries = dividends.values.filter_map { |entry| parse_dividend_entry(entry) }
+        entries.sort_by { |d| d[:date] }
+      end
+
+      def parse_dividend_entry(entry)
+        date = parse_unix_date(entry["date"])
+        amount = entry["amount"]
+        return unless date && amount&.positive?
+
+        { date: date, amount: amount.round(4) }
+      end
+
       def fetch_from_cache(key)
         cached_entry = @cache[key]
         return unless cached_entry && Time.now - cached_entry[:timestamp] < CACHE_TTL

data/lib/yahoo_finance_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YahooFinanceClient
-  VERSION = "0.3.1"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yahoo_finance_client
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Francesc Leveque