basic_yahoo_finance 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d234393bfb2f323b2dec6d4b6b743e13033c2fd583c0f91025456eb4cdafa4d
-  data.tar.gz: d8a058f85a0cbbc8a3f06e12d35eb331d388c20a71d15130fd1ccf50c269aa4b
+  metadata.gz: 4e7e80847cd866e0bbf3de8dc8be42079bd72b8c771d03e2ef581b0d6929c2bc
+  data.tar.gz: 8fe353c9b4a494e55f157bfc3807432eaabe345a54963028b78330bda8f0a17e
 SHA512:
-  metadata.gz: 33df5faf5eb649bad19503d59fb414e193bca49bfb1beb84caf2b8f31a5bc57d010c801e03cd7c4333aa2a704f48816b4cda6435f326234af602da98dea09f43
-  data.tar.gz: 2904cf1af64fc4ff92a910c9614b5b826ecf29d65e73c073465d811a2a0452fcf00ce5f5d2c27f6909730c122e64cba1a0b62e71e2fee14a9f7a43870dcd5261
+  metadata.gz: 55f5dbfb66c2afa4175671e770310dbe41ef2c48fdd5e53761019b6367bf92aad4b62281c811776a9e6314adafa17fec5838e4771c186c0b5ecf4833d57acca2
+  data.tar.gz: c3fa55322e6155b1c0caaf39844170c3547482f8eda9fade825f16ccd2e54d064672eecff1551e0b1899226f813a3592da1165214dd522e897112294b4b48002

data/CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.0] - 2026-02-21
+
+### Added
+
+- Historical data query method (`history`) with support for single/multiple stocks and custom intervals by [@lucienLopez](https://github.com/lucienLopez)
+- Include minitest and minitest-mock gems required by newer Ruby 3.4.x versions
+
+### Changed
+
+- Update gem dependencies and Ruby version
+
+### Fixed
+
+- Broken API query generating HTTP 404 Not Found error
+
+### Removed
+
+- Possibility to use modules in query
+
 ## [0.5.1] - 2023-07-14
 
 ### Changed

data/README.md

@@ -27,13 +27,12 @@ Or install it yourself as:
 
 Instantiate the `Query` class and use the quotes method on it with either a single stock as a `String` and a single module as a `String` or by passing an `Array` of stocks such as show in the two examples below.
 
+### Quotes
+
 ```ruby
 # Query a stock, with the price module
 
 query = BasicYahooFinance::Query.new
-data = query.quotes('AVEM', 'price')
-
-# OR the module argument can be left empty as the price module is the default
 data = query.quotes('AVEM')
 
 # Query multiple stocks
@@ -56,43 +55,21 @@ data["AVEM"]["regularMarketPrice"]["raw"]
 # 52.72
 ```
 
-## Modules
+### Historical Data
 
-While `price` is a common module, its not the only one. A list of known modules include:
+Use the `history` method to retrieve historical price data for one or more stocks. It requires a symbol, a start date (`period1`) and an end date (`period2`) as Unix timestamps. An optional `interval` parameter defaults to `"1d"`.
 
-```
-assetProfile
-balanceSheetHistory
-balanceSheetHistoryQuarterly
-calendarEvents
-cashflowStatementHistory
-cashflowStatementHistoryQuarterly
-defaultKeyStatistics
-earnings
-earningsHistory
-earningsTrend
-esgScores
-financialData
-fundOwnership
-incomeStatementHistory
-incomeStatementHistoryQuarterly
-indexTrend
-industryTrend
-insiderHolders
-insiderTransactions
-institutionOwnership
-majorDirectHolders
-majorHoldersBreakdown
-netSharePurchaseActivity
-price
-recommendationTrend
-secFilings
-sectorTrend
-summaryDetail
-summaryProfile
-upgradeDowngradeHistory
-pageviews
-quotetype
+```ruby
+query = BasicYahooFinance::Query.new
+
+# Daily history for a single stock
+data = query.history('AAPL', 1_700_000_000, 1_710_000_000)
+
+# Weekly history
+data = query.history('AAPL', 1_700_000_000, 1_710_000_000, '1wk')
+
+# Multiple stocks
+data = query.history(['AAPL', 'GOOG'], 1_700_000_000, 1_710_000_000)
 ```
 
 ## Development
@@ -101,14 +78,14 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 
 MiniTest is used as test framework and can be run using:
 
-    $ rake test
+    $ bundle exec rake test
 
 As linter RuboCop is used and can be run using:
 
-    $ rake rubocop
+    $ bundle exec rake rubocop
 
-This gem is being developed with Ruby 3.2 but should be downward compatible with at least all supported versions of Ruby.
+This gem is being developed with Ruby 3.4 but should be downward compatible with at least all supported versions of Ruby.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/towards/basic_yahoo_finance. If you submit a pull request please make sure to write a test case using MiniTest covering your changes.
+Bug reports and pull requests are welcome on GitHub at https://github.com/towards/basic_yahoo_finance. If you submit a pull request please make sure to write test cases using MiniTest covering your changes and that there are no RuboCop offenses.

data/lib/basic_yahoo_finance/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BasicYahooFinance
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/lib/basic_yahoo_finance.rb

@@ -11,32 +11,71 @@ require_relative "basic_yahoo_finance/version"
 module BasicYahooFinance
   # Class to send queries to Yahoo Finance API
   class Query
-    API_URL = "https://query2.finance.yahoo.com"
+    API_URL = "https://query1.finance.yahoo.com"
+    COOKIE_URL = "https://fc.yahoo.com"
+    CRUMB_URL = "https://query1.finance.yahoo.com/v1/test/getcrumb"
+    USER_AGENT = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) " \
+                 "Chrome/90.0.4421.0 Safari/537.36 Edg/90.0.810.1"
 
     def initialize(cache_url = nil)
       @cache_url = cache_url
+      @cookie = fetch_cookie
+      @crumb = fetch_crumb(@cookie)
     end
 
-    def quotes(symbol, mod = "price") # rubocop:disable Metrics/MethodLength
+    def quotes(symbol)
       hash_result = {}
-      symbols = make_symbols_array(symbol)
-      http = Net::HTTP::Persistent.new
-      http.override_headers["User-Agent"] = "BYF/#{BasicYahooFinance::VERSION}"
-      symbols.each do |sym|
-        uri = URI("#{API_URL}/v6/finance/quoteSummary/#{sym}?modules=#{mod}")
-        response = http.request(uri)
-        hash_result.store(sym, process_output(JSON.parse(response.body), mod))
-      rescue Net::HTTPBadResponse, Net::HTTPNotFound, Net::HTTPError, Net::HTTPServerError, JSON::ParserError
-        hash_result.store(sym, "HTTP Error")
+
+      with_http do |http|
+        make_symbols_array(symbol).each do |sym|
+          uri = URI("#{API_URL}/v7/finance/quote?symbols=#{sym}&crumb=#{@crumb}")
+          response = http.request(uri)
+          hash_result.store(sym, process_output(JSON.parse(response.body)))
+        rescue Net::HTTPBadResponse, Net::HTTPNotFound, Net::HTTPError, Net::HTTPServerError, JSON::ParserError
+          hash_result.store(sym, "HTTP Error")
+        end
       end
 
-      http.shutdown
+      hash_result
+    end
+
+    def history(symbol, period1, period2, interval = "1d")
+      hash_result = {}
+
+      with_http do |http|
+        make_symbols_array(symbol).each do |sym|
+          uri = URI("#{API_URL}/v8/finance/chart/#{sym}?period1=#{period1}&period2=#{period2}&interval=#{interval}&crumb=#{@crumb}")
+          response = http.request(uri)
+          hash_result.store(sym, process_history_output(JSON.parse(response.body)))
+        rescue Net::HTTPBadResponse, Net::HTTPNotFound, Net::HTTPError, Net::HTTPServerError, JSON::ParserError
+          hash_result.store(sym, "HTTP Error")
+        end
+      end
 
       hash_result
     end
 
     private
 
+    def with_http
+      http = Net::HTTP::Persistent.new
+      http.override_headers["User-Agent"] = USER_AGENT
+      http.override_headers["Cookie"] = @cookie
+      yield(http)
+      http.shutdown
+    end
+
+    def fetch_cookie
+      http = Net::HTTP.get_response(URI(COOKIE_URL), { "Keep-Session-Cookies" => "true" })
+      cookies = http.get_fields("set-cookie")
+      cookies[0].split(";")[0]
+    end
+
+    def fetch_crumb(cookie)
+      http = Net::HTTP.get_response(URI(CRUMB_URL), { "User-Agent" => USER_AGENT, "Cookie" => cookie })
+      http.read_body
+    end
+
     def make_symbols_array(symbol)
       if symbol.instance_of?(Array)
         symbol
@@ -45,14 +84,22 @@ module BasicYahooFinance
       end
     end
 
-    def process_output(json, mod)
+    def process_output(json)
       # Handle error from the API that the code isn't found
-      return json["quoteSummary"]["error"] if json["quoteSummary"] && json["quoteSummary"]["error"]
+      return json["error"] unless json["error"].nil?
 
-      result = json["quoteSummary"]&.dig("result", 0)
+      result = json["quoteResponse"]&.dig("result", 0)
       return nil if result.nil?
 
-      result[mod]
+      result
+    end
+
+    def process_history_output(json)
+      # Handle error from the API that the code isn't found
+      error = json.dig("chart", "error")
+      return error unless error.nil?
+
+      json
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: basic_yahoo_finance
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Marc
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
@@ -30,20 +29,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.2
-- !ruby/object:Gem::Dependency
-  name: minitest-emoji
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 description: Very simple Ruby API for Yahoo Finance in order to query the stock market
 email:
 - hello@towards.ch
@@ -69,7 +54,6 @@ metadata:
   homepage_uri: https://towards.ch
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/towards/basic_yahoo_finance
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -77,15 +61,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Basic Yahoo Finance API to query stock prices
 test_files: []