yahoo_finance_client 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e0827edebfc4f170f5a750a27e04cac4fb5dd158fcc85ab47d684a777d6dac8
-  data.tar.gz: 3922682a35baff70fb5492f6f21a8feca3ceb24cf549c7678caca26f922814bb
+  metadata.gz: 396333c73bb2a3098fb03607b6c9f4ac31d6ad2fee6abc425ebacae6a3329ec2
+  data.tar.gz: 852fe8f267af779dd3d4beda42f8bc488b09aca401c98fa784351846dad7cb19
 SHA512:
-  metadata.gz: 6b699a914a9e2b929b14180e0251ff4ab77ab41e53ec5cf7becff1abf0210fbd477d0f7a4b92f4a77015cf1b659f622d26eb3828e74fc8957edcf6d1f03449f8
-  data.tar.gz: 177c5c3577a4a7b31e480b9c85c097def09cdb1aa546da8dc82626239afd6b97b138bc5707f2a7df07c342015be3ad5cd3160f28df27e25ef55633afc1f11957
+  metadata.gz: 14e2e611856c718242e81eab276c2a988f5ea98e26ca57b3a951104785b96787e023a38c786b88dd198482a97901220a93e3070c783a1ffc71e1a3bcd82cc8c6
+  data.tar.gz: cd126e9ac493657f40ecd7429706d40ee954db197be71bdb37f5f93083d766763db7aa2bb24971aa2fcfa352df60a2e13b87421094f9208949bbeb3a36b43f79

data/.rubocop.yml

@@ -11,7 +11,7 @@ Metrics/AbcSize:
   Max: 25
 
 Metrics/ClassLength:
-  Max: 280
+  Max: 310
 
 Metrics/MethodLength:
   Max: 11

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [0.7.0] - 2026-05-16
+
+- Add `Stock.get_fx_rate(from, to)` returning the current FX rate between two ISO 4217 currency codes via Yahoo's `<FROM><TO>=X` quote symbol. Returns `1.0` for identity pairs without hitting the API; returns `nil` on error.
+
+## [0.6.0] - 2026-05-16
+
+- Expose Yahoo's `currency` field in `get_quote` / `get_quotes` results so callers can support multi-currency portfolios
+
 ## [0.5.0] - 2026-05-15
 
 - Add `Stock.search(query, count:)` returning matching tickers from Yahoo's `v1/finance/search` autocomplete endpoint

data/README.md

@@ -38,7 +38,7 @@ Fetch stock data by passing a ticker symbol:
 ```ruby
 YahooFinanceClient::Stock.get_quote("AAPL")
 # => {
-#   symbol: "AAPL", name: "Apple Inc.", price: 182.52,
+#   symbol: "AAPL", name: "Apple Inc.", price: 182.52, currency: "USD",
 #   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,
@@ -74,6 +74,16 @@ YahooFinanceClient::Stock.search("apple", count: 5)
 
 Search returns `[]` if the query is empty or the upstream request fails.
 
+### FX Rates
+
+Fetch a current FX rate between two ISO 4217 currency codes via Yahoo's `<FROM><TO>=X` quote symbol:
+```ruby
+YahooFinanceClient::Stock.get_fx_rate("EUR", "USD")
+# => 1.0823
+```
+
+Identity pairs short-circuit to `1.0` without hitting the API. Returns `nil` on any upstream error.
+
 ### Dividend History
 
 Fetch historical dividend payments via the chart API:

data/lib/yahoo_finance_client/stock.rb

@@ -37,6 +37,19 @@ module YahooFinanceClient
         fetch_from_cache(cache_key) || fetch_and_cache_dividend_history(cache_key, symbol, range)
       end
 
+      # Fetch the current FX rate between two ISO 4217 currency codes via Yahoo's
+      # `<FROM><TO>=X` quote symbol. Returns 1.0 for identity pairs without hitting the API.
+      #
+      # @param from [String] source currency code (e.g. "EUR")
+      # @param to [String] target currency code (e.g. "USD")
+      # @return [Float, nil] one unit of `from` expressed in `to`, or nil on error
+      def get_fx_rate(from, to)
+        return 1.0 if from == to
+
+        cache_key = "fx_#{from}_#{to}"
+        fetch_from_cache(cache_key) || fetch_and_cache_fx_rate(cache_key, from, to)
+      end
+
       # Search the Yahoo Finance autocomplete index for matching symbols.
       #
       # @param query [String] free-text query (ticker or company name)
@@ -162,7 +175,7 @@ module YahooFinanceClient
 
       def build_quote_hash(quote, price, dividend, eps)
         {
-          symbol: quote["symbol"], name: quote["shortName"], price: price,
+          symbol: quote["symbol"], name: quote["shortName"], price: price, currency: quote["currency"],
           change: quote["regularMarketChange"], percent_change: quote["regularMarketChangePercent"],
           volume: quote["regularMarketVolume"], pe_ratio: quote["trailingPE"], eps: eps,
           dividend: dividend, dividend_yield: calculate_yield(dividend, price),
@@ -192,6 +205,36 @@ module YahooFinanceClient
         Time.at(value).utc.to_date
       end
 
+      def fetch_and_cache_fx_rate(cache_key, from, to)
+        rate = fetch_fx_rate_data("#{from}#{to}=X")
+        store_in_cache(cache_key, rate) if rate
+        rate
+      end
+
+      def fetch_fx_rate_data(symbol)
+        retries = 0
+        begin
+          parse_fx_response(make_authenticated_request(symbol))
+        rescue AuthenticationError
+          retries += 1
+          retry if retries <= MAX_RETRIES
+          nil
+        end
+      end
+
+      def parse_fx_response(response)
+        if auth_error?(response)
+          Session.instance.invalidate!
+          raise AuthenticationError, "Authentication failed"
+        end
+        return nil unless response.success?
+
+        rate = JSON.parse(response.body).dig("quoteResponse", "result", 0, "regularMarketPrice")
+        rate&.to_f
+      rescue JSON::ParserError
+        nil
+      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/lib/yahoo_finance_client/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yahoo_finance_client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Francesc Leveque
 bindir: exe
 cert_chain: []
-date: 2026-05-15 00:00:00.000000000 Z
+date: 2026-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv