yahoo_finance_client 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0ac5c76c098d2bed0c2960381c799e4669a5e6bfac74d223c1f7dceadc650af
-  data.tar.gz: a3738e2f466198761b923b4f3293e887a6de856e9cdcaca30fd6c473d55fd606
+  metadata.gz: 30839cb8e628ac9ed9d0f2b62b84c070deec2c0e34b2ebfa847e1f96ead57b66
+  data.tar.gz: edf5c2cfd5da659d3d133970209beab1520172609ba5ef3e62103f8632b94580
 SHA512:
-  metadata.gz: 195bcd6094858a5df15ca67424aeddc8564c11ac2f3871608d1e6fdd6275e0622d1570158960befa9260f5d187ff6c83c7f36af3ab6144f3692d3e641bebc547
-  data.tar.gz: 1e910b49a4b0147b87d464c34b5e9d525b48e9ec1150b56eefcf929cca3957b965fce221ac7b2c57c6f3e4fbdf5f4dae66fc133b3f0fec4a0e21f8b4f83f16ce
+  metadata.gz: 2a1b56270a9f16516c23aeeb68726e44597696f6decd6099feea133be43f812d2512955ad314de75423460ae45ff99ead67b649868037ec99c02c2bec9ad7f77
+  data.tar.gz: 45f41b601b87201eb3dfe5af834826268806ece7b4ac572e095f6489168c3e8579134a030ebad89570317922e96a5b52cd526ce87d7b644f07fa0233ce100676

data/.rubocop.yml

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

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)
@@ -169,6 +175,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.0"
 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.0
 platform: ruby
 authors:
 - Francesc Leveque