basic_yahoo_finance 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 814a795de1eab60580b58d3e297d75495cd1b2b253e0282d031be4415304717b
-  data.tar.gz: 3b6262e836778a3400063c03789258506a4d298f54a81bd7c45234b6a430f397
+  metadata.gz: ac312bb23f04ce23b3bdf59b54edd1a089176e8da0e9eeb5a70279f78ffefbd9
+  data.tar.gz: 7922787606b7eebf744419dfbdc6f014c2cecb5b9d94909b3e2741a0f58b0970
 SHA512:
-  metadata.gz: 0c51ebf8d46280e517e6525a66be84ef83a8378defcff07de647a1e3dc6fbfd188dbf95412eac2a731bd3273f8aa92482a30ea366e6f20d2fd70fb73f57a1010
-  data.tar.gz: e69d09f901a017af01221054cf2cfa5f374bf2c4d2b35b6232995778b75bafe87c81fe566547e7a40ec1c7b149bb5007c8b8456191b57133c5cb6b3f37d1ea33
+  metadata.gz: 9db7de6026fce85ca08de9f9ddfdebc8022deb1f10141df12181c857196532b8b83c68523edc97e729048cc1c601743b29addf1fd2238a8ea9f6c4299aa31733
+  data.tar.gz: 2dc8dc4c07184cf22de1678d1edbe08aa4b7b6214ed092f1e5504180f1a4f467e33567f17e9673efd89f35586ab21b584978b91c53c92e88ae5fe54fe153130d

data/CHANGELOG.md

@@ -5,14 +5,36 @@ 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.2.0 - 2021-02-05
+## [0.3.1] - 2023-02-12
+
+### Changed
+
+- Comment out not yet implemented use of redis dependency by [@svoop](https://github.com/svoop)
+- Update gem dependencies and Ruby version
+
+## [0.3.0] - 2022-05-06
+
+### Added
+
+- Initial setup for redis caching
+- Utility class with symbols generator used in currency queries
+- Foreign exchange symbol generator and finder
+- Rubygems MFA requirement
+
+### Changed
+
+- Fix format of returned symbol for FX symbol finder
+- Update gems
+- Parse URI before opening request to API
+
+## [0.2.0] - 2021-02-05
 
 ### Changed
 
 - User-Agent header in API requests to announce as "BYF" instead of default "Ruby"
 - Invalid ticker test to new behaviour of the API when the ticker does not exist
 
-## 0.1.0 - 2021-01-29
+## [0.1.0] - 2021-01-29
 
 ### Added
 

data/lib/basic_yahoo_finance/cache.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "redis"
+
+module BasicYahooFinance
+  class Cache
+    # TODO: implement later
+  end
+end

data/lib/basic_yahoo_finance/util.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module BasicYahooFinance
+  # Small useful utility methods
+  class Util
+    # Find correct FX symbol in quotes as the symbol format can vary
+    def self.find_fx_symbol(quotes, currency1, currency2)
+      # Exception for USDCHF=X symbol as it is sometimes returned as CHF=X
+      if currency1 == "USD" && currency2 == "CHF"
+        quotes["USDCHF=X"].nil? ? "CHF=X" : "#{currency1}CHF=X"
+      else
+        "#{currency1}#{currency2}=X"
+      end
+    end
+
+    # Generate currency symbols based on array of currencies and base currency
+    def self.generate_currency_symbols(currencies, base_currency)
+      currency_symbols = []
+      currencies.each do |currency|
+        next if currency == base_currency
+
+        currency_symbols.push("#{currency}#{base_currency}=X")
+      end
+      currency_symbols.join(",")
+    end
+
+    # Generate symobol for foreign exchange rate lookup
+    def self.generate_fx_symbol(currency1, currency2)
+      # Exception for USD against CHF which is formatted as 'CHF=X'
+      if currency1 == "USD" && currency2 == "CHF"
+        "#{currency2}=X"
+      else
+        "#{currency1}/#{currency2}"
+      end
+    end
+  end
+end

data/lib/basic_yahoo_finance/version.rb

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

data/lib/basic_yahoo_finance.rb

@@ -2,6 +2,8 @@
 
 require "json"
 require "open-uri"
+# require_relative "basic_yahoo_finance/cache"
+require_relative "basic_yahoo_finance/util"
 require_relative "basic_yahoo_finance/version"
 
 module BasicYahooFinance
@@ -9,11 +11,15 @@ module BasicYahooFinance
   class Query
     API_URL = "https://query1.finance.yahoo.com"
 
+    def initialize(cache_url = nil)
+      @cache_url = cache_url
+    end
+
     def quotes(symbols)
       symbols_value = generate_symbols_value(symbols)
       begin
-        uri = URI.open("#{API_URL}/v7/finance/quote?symbols=#{symbols_value}",
-                       "User-Agent" => "BYF/#{BasicYahooFinance::VERSION}")
+        url = URI.parse("#{API_URL}/v7/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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: basic_yahoo_finance
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Marc
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-emoji
@@ -35,6 +35,8 @@ files:
 - LICENSE
 - README.md
 - lib/basic_yahoo_finance.rb
+- lib/basic_yahoo_finance/cache.rb
+- lib/basic_yahoo_finance/util.rb
 - lib/basic_yahoo_finance/version.rb
 homepage: https://towards.ch
 licenses:
@@ -45,8 +47,9 @@ metadata:
   changelog_uri: https://github.com/towards/basic_yahoo_finance/blob/master/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/basic_yahoo_finance
   homepage_uri: https://towards.ch
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/towards/basic_yahoo_finance
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -54,15 +57,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.4.6
+signing_key: 
 specification_version: 4
 summary: Basic Yahoo Finance API to query stock prices
 test_files: []