yahoo_finance_client 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2e9d16b1b8d40611c624f46e03ad7ca01e98ae8cbf58fe733c4ff72e37ee829
-  data.tar.gz: 1d38747c9ff732268ad4d40121e4cfb058817ecc40df10f78d063949810f0fa4
+  metadata.gz: 88b5aae44ab5936bfba0fec79d7497662637c55bf54965dfe11a20eb1facc762
+  data.tar.gz: 77e5908ab205b355680db2eb81d290284ef98b629bf01b4eff3a27204d657682
 SHA512:
-  metadata.gz: eaf8f4c30384d727e32c4e3fa4e2e2877f16f157f20791cb7b2012e19fd9bbd77f466ea67a31b6887129b833901274ab756e65353fd677e80ee7f834c11a6fed
-  data.tar.gz: 368918db13051ddfcc9297c956fb019bef8340ba2a3faedebf663a8c0667db26efdda55171cbbf31644297237c7782d5b5ec3707d0723527a934243ec5bf084a
+  metadata.gz: d43ddf2d142468824d65b967b992621d956fc2e3dde5cc109821b1068ab73ebc3201ec5f53973fdcb0a459d941c38df47e2cbab4b002a06a78f4af082bf36456
+  data.tar.gz: 2628a14bc00d61a618d87a929d198749cb0661d69aa6e95ea18e1751b394003c306b68d855ea7ba3b4c6344db33af210eed74bbc4eabe6e673a480aca10874c3

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/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/stock.rb

@@ -9,55 +9,89 @@ module YahooFinanceClient
     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"
+    USER_AGENT = "Mozilla/5.0 (X11; Linux x86_64)"
+    CACHE_TTL = 300 # Cache time-to-live in seconds (e.g., 5 minutes)
 
-    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}"
+        cached_data = fetch_from_cache(cache_key)
 
-      if response.success?
-        parse_response(response.body, symbol)
-      else
-        { error: "Yahoo Finance connection failed" }
+        return cached_data if cached_data
+
+        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
+      private
 
-    def self.fetch_cookie
-      response = HTTParty.get(COOKIE_URL, headers: { "User-Agent" => USER_AGENT })
-      response.headers["set-cookie"]
-    end
+      def fetch_quote_data(symbol)
+        cookie = fetch_cookie
+        crumb = fetch_crumb(cookie)
+        url = build_url(symbol, crumb)
+        pp url
+        response = HTTParty.get(url, headers: { "User-Agent" => USER_AGENT })
 
-    def self.fetch_crumb(cookie)
-      response = HTTParty.get(CRUMB_URL, headers: { "User-Agent" => USER_AGENT, "Cookie" => cookie })
-      response.body
-    end
+        if response.success?
+          parse_response(response.body, symbol)
+        else
+          { error: "Yahoo Finance connection failed" }
+        end
+      end
 
-    def self.parse_response(body, symbol)
-      data = JSON.parse(body)
-      quote = data.dig("quoteResponse", "result", 0)
+      def build_url(symbol, crumb)
+        "#{BASE_URL}?symbols=#{symbol}&crumb=#{crumb}"
+      end
 
-      if quote
-        format_quote(quote)
-      else
-        { error: "No data was found for #{symbol}" }
+      def fetch_cookie
+        response = HTTParty.get(COOKIE_URL, headers: { "User-Agent" => USER_AGENT })
+        response.headers["set-cookie"]
+      end
+
+      def fetch_crumb(cookie)
+        response = HTTParty.get(CRUMB_URL, headers: { "User-Agent" => USER_AGENT, "Cookie" => cookie })
+        response.body
       end
-    end
 
-    def self.format_quote(quote)
-      {
-        symbol: quote["symbol"],
-        price: quote["regularMarketPrice"],
-        change: quote["regularMarketChange"],
-        percent_change: quote["regularMarketChangePercent"],
-        volume: quote["regularMarketVolume"]
-      }
+      def parse_response(body, symbol)
+        data = JSON.parse(body)
+        quote = data.dig("quoteResponse", "result", 0)
+
+        if quote
+          format_quote(quote)
+        else
+          { error: "No data was found for #{symbol}" }
+        end
+      end
+
+      def format_quote(quote)
+        {
+          symbol: quote["symbol"],
+          price: quote["regularMarketPrice"],
+          change: quote["regularMarketChange"],
+          percent_change: quote["regularMarketChangePercent"],
+          volume: quote["regularMarketVolume"]
+        }
+      end
+
+      def fetch_from_cache(key)
+        cached_entry = @cache[key]
+        return unless cached_entry
+
+        if Time.now - cached_entry[:timestamp] < CACHE_TTL
+          cached_entry[:data]
+        else
+          @cache.delete(key)
+          nil
+        end
+      end
+
+      def store_in_cache(key, data)
+        @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.1.6"
 end

metadata

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