yahoo_finance_client 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e33ae43499746470889d5ce981772a200757674872046a1e8c29eb69541ede39
-  data.tar.gz: 25b281f7b93cba1e738f3c2f97f2b6470931b9ed94dda8739332d958d5408b23
+  metadata.gz: 396333c73bb2a3098fb03607b6c9f4ac31d6ad2fee6abc425ebacae6a3329ec2
+  data.tar.gz: 852fe8f267af779dd3d4beda42f8bc488b09aca401c98fa784351846dad7cb19
 SHA512:
-  metadata.gz: 270aa2c3f57c379c36f81190768bad8059480d5dba852d51d25a2e3d5b22c7a21cbf5bf57de6f4509737c0288665b5a20c30d0689bc17d190983d08f10f03fd1
-  data.tar.gz: 5e60fba40d2520447b488fe658f28d2e9630d4f96690e79e63470a47d5baa83da7f49cf51c31ff2610713da32258c404d974a9162a54c8624be41da1ef2371e5
+  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,9 @@
 # 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

data/README.md

@@ -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)
@@ -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.6.0"
+  VERSION = "0.7.0"
 end

metadata

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