yahoo_finance_client 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2e9d16b1b8d40611c624f46e03ad7ca01e98ae8cbf58fe733c4ff72e37ee829
-  data.tar.gz: 1d38747c9ff732268ad4d40121e4cfb058817ecc40df10f78d063949810f0fa4
+  metadata.gz: f3fe95366fd98eec61742aa8884d677461fce3101d9d06705db3138c9eb45209
+  data.tar.gz: e06b233e9d188b66ccb2419b3fcfa915555d79956730cc8b4eadf0cd1648f6e4
 SHA512:
-  metadata.gz: eaf8f4c30384d727e32c4e3fa4e2e2877f16f157f20791cb7b2012e19fd9bbd77f466ea67a31b6887129b833901274ab756e65353fd677e80ee7f834c11a6fed
-  data.tar.gz: 368918db13051ddfcc9297c956fb019bef8340ba2a3faedebf663a8c0667db26efdda55171cbbf31644297237c7782d5b5ec3707d0723527a934243ec5bf084a
+  metadata.gz: b34f6a47bc4288d7f90330ad0353b476ff948d3d00a237cd3a4ceb35cb44012b9b5b75dedef6b6f276632741d734f3d51dcbf0541bb6a3b34efd6d51cb01f3e0
+  data.tar.gz: acc8e07af8fbddd510181e8b78d761a6635022ef347a40909113abda79df62d40b34d0c051f45b73aea52c48c379c91e76291458a91d5d462f539daa7c941d4c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [0.1.6] - 2025-02-18
+
+- Adding a simple cache
+
+## [0.1.5] - 2025-02-18
+
+- Change User Agent so Yahoo requests work
+
 ## [0.1.4] - 2025-02-18
 
 - Fix version & Gemfile.lock issues

data/CLAUDE.md

@@ -0,0 +1,49 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+YahooFinanceClient is a Ruby gem providing a client for the Yahoo! Finance API. It fetches stock quotes with built-in caching (5-minute TTL) and handles Yahoo's authentication flow (cookies + CSRF crumb tokens).
+
+**Note**: Yahoo! may have disabled API access - this project is in a work-in-progress state.
+
+## Commands
+
+| Command | Purpose |
+|---------|---------|
+| `rake` | Run tests and linting (default task) |
+| `rake spec` | Run RSpec tests only |
+| `rake rubocop` | Run RuboCop linter only |
+| `bundle exec rspec spec/yahoo_finance_client/stock_spec.rb` | Run single test file |
+| `bundle exec rake install` | Install gem locally |
+| `bin/console` | Interactive Ruby console for experimentation |
+
+## Architecture
+
+```
+lib/
+├── yahoo_finance_client.rb           # Main module entry point
+└── yahoo_finance_client/
+    ├── stock.rb                      # Core API client (class methods)
+    └── version.rb                    # Version constant
+```
+
+**YahooFinanceClient::Stock** is the main class with a single public interface:
+- `Stock.get_quote(symbol)` - Returns hash with `symbol`, `price`, `change`, `percent_change`, `volume`
+
+The class handles Yahoo's auth flow internally: fetch cookie → get crumb token → make authenticated API request. Results are cached in a class-level hash with 300-second expiration.
+
+## Testing
+
+Uses RSpec with WebMock for HTTP stubbing. Tests clear the cache before each example. Key test patterns:
+- Stub HTTP requests, don't hit real API
+- Test cache behavior via instance variable inspection (`@quotes_cache`)
+- Contexts organize success/failure/cache scenarios
+
+## Code Style
+
+- Ruby 3.4 target
+- Max line length: 120
+- Double quotes for strings
+- Frozen string literals enabled

data/README.md

@@ -2,7 +2,7 @@
 
 A basic client to query Yahoo! Finance API.
 
-Work in process, it might work, or not :)
+Work in process, it might work, or not. It seems that Yahoo! disabled that kind of API access lately.
 
 It was created to support https://github.com/fleveque/dividend-portfolio pet project.
 

data/lib/yahoo_finance_client/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module YahooFinanceClient
+  # Base error class for Yahoo Finance Client
+  class Error < StandardError; end
+
+  # Raised when authentication fails (invalid cookie/crumb)
+  class AuthenticationError < Error; end
+
+  # Raised when Yahoo Finance rate limits requests
+  class RateLimitError < Error; end
+end

data/lib/yahoo_finance_client/session.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "httparty"
+require "singleton"
+
+module YahooFinanceClient
+  # Handles Yahoo Finance authentication with multiple fallback strategies
+  class Session
+    include Singleton
+
+    SESSION_TTL = 60
+    USER_AGENT = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0"
+    COOKIE_URL = "https://fc.yahoo.com"
+    CRUMB_URL_QUERY1 = "https://query1.finance.yahoo.com/v1/test/getcrumb"
+    CRUMB_URL_QUERY2 = "https://query2.finance.yahoo.com/v1/test/getcrumb"
+    HOMEPAGE_URL = "https://finance.yahoo.com"
+    CRUMB_PATTERNS = [/"crumb"\s*:\s*"([^"]+)"/, /"CrsrfToken"\s*:\s*"([^"]+)"/, /crumb=([a-zA-Z0-9_.~-]+)/].freeze
+
+    attr_reader :cookie, :crumb, :base_url
+
+    def initialize
+      reset!
+    end
+
+    def ensure_authenticated
+      return if valid_session?
+
+      authenticate!
+    end
+
+    def invalidate!
+      reset!
+    end
+
+    def valid_session?
+      return false unless @cookie && @crumb && @authenticated_at
+
+      Time.now - @authenticated_at < SESSION_TTL
+    end
+
+    private
+
+    def reset!
+      @cookie = nil
+      @crumb = nil
+      @authenticated_at = nil
+      @base_url = "https://query1.finance.yahoo.com"
+    end
+
+    def authenticate!
+      strategies = %i[strategy_fc_cookie_query1 strategy_homepage_scrape strategy_fc_cookie_query2]
+      strategies.each { |s| return @authenticated_at = Time.now if send(s) rescue nil } # rubocop:disable Style/RescueModifier
+      raise AuthenticationError, "All authentication strategies failed"
+    end
+
+    def strategy_fc_cookie_query1
+      apply_crumb_strategy(fetch_cookie_from_fc, CRUMB_URL_QUERY1, "https://query1.finance.yahoo.com")
+    end
+
+    def strategy_fc_cookie_query2
+      apply_crumb_strategy(fetch_cookie_from_fc, CRUMB_URL_QUERY2, "https://query2.finance.yahoo.com")
+    end
+
+    def apply_crumb_strategy(cookie, crumb_url, base)
+      return false unless cookie
+
+      crumb = fetch_crumb(cookie, crumb_url)
+      return false unless valid_crumb?(crumb)
+
+      @cookie = cookie
+      @crumb = crumb
+      @base_url = base
+      true
+    end
+
+    def strategy_homepage_scrape
+      response = HTTParty.get(HOMEPAGE_URL, headers: request_headers, follow_redirects: true)
+      return false unless response.success?
+
+      cookie = extract_cookie(response)
+      crumb = extract_crumb_from_html(response.body)
+      return false unless cookie && crumb
+
+      @cookie = cookie
+      @crumb = crumb
+      @base_url = "https://query1.finance.yahoo.com"
+      true
+    end
+
+    def fetch_cookie_from_fc
+      extract_cookie(HTTParty.get(COOKIE_URL, headers: request_headers))
+    end
+
+    def fetch_crumb(cookie, crumb_url)
+      response = HTTParty.get(crumb_url, headers: request_headers.merge("Cookie" => cookie))
+      response.success? ? response.body.strip : nil
+    end
+
+    def extract_cookie(response)
+      response.headers["set-cookie"]&.to_s
+    end
+
+    def extract_crumb_from_html(html)
+      CRUMB_PATTERNS.each { |p| (m = html.match(p)) && (return unescape_crumb(m[1])) }
+      nil
+    end
+
+    def unescape_crumb(crumb)
+      crumb.gsub(/\\u([0-9a-fA-F]{4})/) { [::Regexp.last_match(1).to_i(16)].pack("U") }
+    end
+
+    def valid_crumb?(crumb)
+      crumb && !crumb.empty? && !crumb.include?("<") && !crumb.include?("Unauthorized")
+    end
+
+    def request_headers
+      { "User-Agent" => USER_AGENT, "Accept" => "text/html,*/*;q=0.8", "Accept-Language" => "en-US,en;q=0.5" }
+    end
+  end
+end

data/lib/yahoo_finance_client/stock.rb

@@ -6,58 +6,79 @@ require "json"
 module YahooFinanceClient
   # This class provides methods to interact with Yahoo Finance API for stock data.
   class Stock
-    BASE_URL = "https://query1.finance.yahoo.com/v7/finance/quote"
-    COOKIE_URL = "https://fc.yahoo.com"
-    CRUMB_URL = "https://query1.finance.yahoo.com/v1/test/getcrumb"
+    QUOTE_PATH = "/v7/finance/quote"
+    CACHE_TTL = 300
+    MAX_RETRIES = 2
+    AUTH_ERROR_PATTERNS = [/invalid cookie/i, /invalid crumb/i, /unauthorized/i].freeze
 
-    USER_AGENT = "YahooFinanceClient/#{YahooFinanceClient::VERSION}".freeze
+    @cache = {}
 
-    def self.get_quote(symbol)
-      cookie = fetch_cookie
-      crumb = fetch_crumb(cookie)
-      url = build_url(symbol, crumb)
-      response = HTTParty.get(url, headers: { "User-Agent" => USER_AGENT })
+    class << self
+      def get_quote(symbol)
+        cache_key = "quote_#{symbol}"
+        fetch_from_cache(cache_key) || fetch_and_cache(cache_key, symbol)
+      end
+
+      private
 
-      if response.success?
-        parse_response(response.body, symbol)
-      else
-        { error: "Yahoo Finance connection failed" }
+      def fetch_and_cache(cache_key, symbol)
+        data = fetch_quote_data(symbol)
+        store_in_cache(cache_key, data) if data[:error].nil?
+        data
       end
-    end
 
-    def self.build_url(symbol, crumb)
-      "#{BASE_URL}?symbols=#{symbol}&crumb=#{crumb}"
-    end
+      def fetch_quote_data(symbol)
+        retries = 0
+        begin
+          response = make_authenticated_request(symbol)
+          handle_response(response, symbol)
+        rescue AuthenticationError
+          retries += 1
+          retry if retries <= MAX_RETRIES
+          { error: "Authentication failed after #{MAX_RETRIES} retries" }
+        end
+      end
 
-    def self.fetch_cookie
-      response = HTTParty.get(COOKIE_URL, headers: { "User-Agent" => USER_AGENT })
-      response.headers["set-cookie"]
-    end
+      def make_authenticated_request(symbol)
+        session = Session.instance
+        session.ensure_authenticated
+        url = "#{session.base_url}#{QUOTE_PATH}?symbols=#{symbol}&crumb=#{session.crumb}"
+        HTTParty.get(url, headers: { "User-Agent" => Session::USER_AGENT, "Cookie" => session.cookie })
+      end
 
-    def self.fetch_crumb(cookie)
-      response = HTTParty.get(CRUMB_URL, headers: { "User-Agent" => USER_AGENT, "Cookie" => cookie })
-      response.body
-    end
+      def handle_response(response, symbol)
+        if auth_error?(response)
+          Session.instance.invalidate!
+          raise AuthenticationError, "Authentication failed"
+        end
+        response.success? ? parse_response(response.body, symbol) : { error: "Yahoo Finance connection failed" }
+      end
 
-    def self.parse_response(body, symbol)
-      data = JSON.parse(body)
-      quote = data.dig("quoteResponse", "result", 0)
+      def auth_error?(response)
+        response.code == 401 || AUTH_ERROR_PATTERNS.any? { |p| response.body.to_s.match?(p) }
+      end
 
-      if quote
-        format_quote(quote)
-      else
-        { error: "No data was found for #{symbol}" }
+      def parse_response(body, symbol)
+        quote = JSON.parse(body).dig("quoteResponse", "result", 0)
+        quote ? format_quote(quote) : { error: "No data was found for #{symbol}" }
+      end
+
+      def format_quote(quote)
+        { symbol: quote["symbol"], price: quote["regularMarketPrice"], change: quote["regularMarketChange"],
+          percent_change: quote["regularMarketChangePercent"], volume: quote["regularMarketVolume"] }
       end
-    end
 
-    def self.format_quote(quote)
-      {
-        symbol: quote["symbol"],
-        price: quote["regularMarketPrice"],
-        change: quote["regularMarketChange"],
-        percent_change: quote["regularMarketChangePercent"],
-        volume: quote["regularMarketVolume"]
-      }
+      def fetch_from_cache(key)
+        cached_entry = @cache[key]
+        return unless cached_entry && Time.now - cached_entry[:timestamp] < CACHE_TTL
+
+        cached_entry[:data]
+      end
+
+      def store_in_cache(key, data)
+        @cache.delete_if { |_, v| Time.now - v[:timestamp] >= CACHE_TTL } if @cache.size > 100
+        @cache[key] = { data: data, timestamp: Time.now }
+      end
     end
   end
 end

data/lib/yahoo_finance_client/version.rb

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

data/lib/yahoo_finance_client.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require "httparty"
 require "yahoo_finance_client/version"
+require "yahoo_finance_client/errors"
+require "yahoo_finance_client/session"
 require "yahoo_finance_client/stock"
-require "httparty"
 
 # Basic Yahoo! Finance client
 module YahooFinanceClient

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yahoo_finance_client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Francesc Leveque
 bindir: exe
 cert_chain: []
-date: 2025-02-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv
@@ -48,10 +48,13 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CLAUDE.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/yahoo_finance_client.rb
+- lib/yahoo_finance_client/errors.rb
+- lib/yahoo_finance_client/session.rb
 - lib/yahoo_finance_client/stock.rb
 - lib/yahoo_finance_client/version.rb
 - sig/yahoo_finance_client.rbs
@@ -78,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Basic Yahoo! Finance API client
 test_files: []