basic_yahoo_finance 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2ec971c4ec5a157fbf72658bd0c49af97c4bb995a1e4fc3042622c0dd160632
-  data.tar.gz: 1e3493618a5d9ffae9b79bdd50d8f74bd03d05b28e9ecfd09b8520c5edfbd291
+  metadata.gz: 3fd2727545a83f4bf87d3dbb4403e8799365f60908ff1228391760840470d223
+  data.tar.gz: 40b03fad16cbe8b296c4df148a1970189c544fe2cfd70e74c11143dc6de9ba06
 SHA512:
-  metadata.gz: 5fe97817de863cc6b1b559064525c26ab6e2aaf2d9a388a35b9725068bfcf19efeb6925aa8bb41e1d5a9fb853186b3ebb184b1dd0fa8d8b5c3c0f32110542cec
-  data.tar.gz: ece6f51f42cb4ce6aef20ba249d34df91e4e0c1fb4f4fcc2fc7edd6d1531c74478038fd75e657d9640615ea805593a0ee5959ec8675c7859c3bb74d1ddc0703e
+  metadata.gz: cd7a5678def3f9507779b624518181b1db91ebce666323da0abe5705e58d760b513c50edf3de735b4cbee8f103359df9f130de6f298ee76b67381de7c6aef844
+  data.tar.gz: a62df3b71f400a88ecfa659a524e977bb9c66969bd8d4044cd29e011b290af3e6bc6564a73fe2d197378076b2eafb2ce26a47a6eddc763f60cd071e40f518292

data/CHANGELOG.md

@@ -5,10 +5,29 @@ 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.5.0] - 2023-05-29
+
+### Added
+
+- Possibility to query multiple stocks at the same time
+
+### Changed
+
+- Implement persistent HTTP by [@daviddigital](https://github.com/daviddigital)
+- generate_currency_symbols() return an array instead of a string
+- Default to "price" module if nothing specificed in quotes()
+- Update to use v10 version endpoint of API by [@daviddigital](https://github.com/daviddigital)
+
+### Fixed
+
+- MiniTest tests for full 100% code coverage
+
 ## [0.4.0] - 2023-05-23
 
 ### Added
 
+- SimpleCov coverage badge
+- Tests for failing quotes method due to HTTPError
 - Test for quotes method raising OpenURI::HTTPError
 - SimpleCov for code coverage
 

data/README.md

@@ -1,13 +1,12 @@
 # BasicYahooFinance
 
 [![Gem Version](https://badge.fury.io/rb/basic_yahoo_finance.svg)](https://badge.fury.io/rb/basic_yahoo_finance)
+[![Coverage](https://github.com/towards/basic_yahoo_finance/raw/main/coverage/coverage.svg)](https://github.com/towards/basic_yahoo_finance)
 
 This is a simple Ruby gem to query the Yahoo! Finance API.
 
 Most of the available gems available on rubygems.org for this purpose are either not maintained anymore or simply do not working due to outdated API code. The goal of this gem is to be as basic as possible, hence the name, and to "simply" work. It would be typcially used to get information such as ask/bid price, close price, volume, for one or more stocks by using its symbol. The data is returned raw directly from the API as JSON output.
 
-Lastly, this gem also has the advantage of having no dependencies to any other third-party gems.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,26 +25,74 @@ Or install it yourself as:
 
 ## Usage
 
-Instantiate the `Query` class and use the quotes method on it with either one single symbol as `String` or by passing an `Array` of symbols such as show in the two examples below.
+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.
 
 ```ruby
-# Query one single stock
+# 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
 
 query = BasicYahooFinance::Query.new
 data = query.quotes(['AVDV', 'AVUV'])
+
 ```
 
-This will return a `Hash` of hashes with each stock information available under its symbol name as key in the `Hash`. For example:
+This will return a `Hash` of the stock information available under its symbol name as key in the `Hash`. For example:
 
 ```ruby
-# Get stock's actual price
+# Get stock's actual price as a formatted string
 
-data['AVEM']['regularMarketPrice']
+data['AVEM']['regularMarketPrice']['fmt']
+# "52.72"
+
+# OR the raw value
+data["AVEM"]["regularMarketPrice"]["raw"]
+# 52.72
+```
+
+## Modules
+
+While `price` is a common module, its not the only one. A list of known modules include:
+
+```
+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
 ```
 
 ## Development
@@ -60,8 +107,8 @@ As linter RuboCop is used and can be run using:
 
     $ rake rubocop
 
-This gem has been developed with Ruby 3.0 but should be downward compatible with at least all supported versions of Ruby.
+This gem is being developed with Ruby 3.2 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 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 a test case using MiniTest covering your changes.

data/lib/basic_yahoo_finance/util.rb

@@ -13,7 +13,7 @@ module BasicYahooFinance
       end
     end
 
-    # Generate currency symbols based on array of currencies and base currency
+    # Generate currency symbols array based on array of currencies and base currency
     def self.generate_currency_symbols(currencies, base_currency)
       currency_symbols = []
       currencies.each do |currency|
@@ -21,7 +21,7 @@ module BasicYahooFinance
 
         currency_symbols.push("#{currency}#{base_currency}=X")
       end
-      currency_symbols.join(",")
+      currency_symbols
     end
 
     # Generate symobol for foreign exchange rate lookup

data/lib/basic_yahoo_finance/version.rb

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

data/lib/basic_yahoo_finance.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "json"
-require "open-uri"
+require "net/http/persistent"
+require "net/http"
+
 # require_relative "basic_yahoo_finance/cache"
 require_relative "basic_yahoo_finance/util"
 require_relative "basic_yahoo_finance/version"
@@ -9,58 +11,48 @@ require_relative "basic_yahoo_finance/version"
 module BasicYahooFinance
   # Class to send queries to Yahoo Finance API
   class Query
-    API_URL = "https://query1.finance.yahoo.com"
+    API_URL = "https://query2.finance.yahoo.com"
 
     def initialize(cache_url = nil)
       @cache_url = cache_url
     end
 
-    def quotes(symbols)
-      symbols_value = generate_symbols_value(symbols)
-      begin
-        url = URI.parse("#{API_URL}/v6/finance/quote?symbols=#{symbols_value}")
-        uri = URI.open(url, "User-Agent" => "BYF/#{BasicYahooFinance::VERSION}")
-        process_output(JSON.parse(uri.read))
-      rescue OpenURI::HTTPError
-        empty_symbols_hash(symbols)
+    def quotes(symbol, mod = "price") # rubocop:disable Metrics/MethodLength
+      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}/v10/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")
       end
+
+      http.shutdown
+
+      hash_result
     end
 
     private
 
-    def generate_symbols_value(symbols, separator = ",")
-      case symbols
-      when String
-        symbols
-      when Array
-        symbols.join(separator)
+    def make_symbols_array(symbol)
+      if symbol.instance_of?(Array)
+        symbol
+      else
+        [symbol]
       end
     end
 
-    def process_output(json)
-      hash = {}
-      if json["quoteResponse"]["result"].count == 1
-        hash[json["quoteResponse"]["result"][0]["symbol"]] = json["quoteResponse"]["result"].pop
-      elsif json["quoteResponse"]["result"].count > 1
-        json["quoteResponse"]["result"].each do |r|
-          hash[r["symbol"]] = r
-        end
-      end
-      # TODO: compare hash keys with symbol(s) requested and add symbols which had no results from API
-      hash
-    end
+    def process_output(json, mod)
+      # Handle error from the API that the code isn't found
+      return json["quoteSummary"]["error"] if json["quoteSummary"] && json["quoteSummary"]["error"]
 
-    def empty_symbols_hash(symbols)
-      hash = {}
-      case symbols
-      when String
-        hash[symbols] = {}
-      when Array
-        symbols.each do |s|
-          hash[s] = {}
-        end
-      end
-      hash
+      result = json["quoteSummary"]&.dig("result", 0)
+      return nil if result.nil?
+
+      result[mod]
     end
   end
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: basic_yahoo_finance
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Marc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-05-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
 - !ruby/object:Gem::Dependency
   name: minitest-emoji
   requirement: !ruby/object:Gem::Requirement
@@ -64,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
 summary: Basic Yahoo Finance API to query stock prices