yfinance_wrapper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d85bd7392805b47e38c34a148124b7ecd68822b597001c9051aeacd30791516
-  data.tar.gz: 12e22cf4668680cd6a6a3d10934575a77987459483cbd7aecc5a136a7b963aac
+  metadata.gz: 8325c8f773f83d22f9b8e6523922041dcd37181b953e8ce08f4d36c23366cc68
+  data.tar.gz: 946cd16e59051dd76ae22ab922f697485f528961f07b5e763497ce48988a470f
 SHA512:
-  metadata.gz: be045351689c7bd513a98ec75817812946f447bdb1956ec8a88703c33c12219a86870739b803cb9f10593dd54f3a6b443e5f1f4005d717c3e1f1905644109b3f
-  data.tar.gz: 6595f89d4e915571c134734b32206b7fcbb6aab8bcdd8f946762743647692a22ddc2973c0ee9e489f41edb645132082523fcb296291291fb42eb4feae3d278e7
+  metadata.gz: ea438134ac530c37700708590522387428400b99845b5ea8823f1932aaecac2de65d1a62e1811ae4597149a1e12add54e1852ad2238b4652c689c40e4889d4e4
+  data.tar.gz: 2ea2265b144ab91c8c10ee55fb25ed44b62889ed8bd26344dbc65eef29c60a8012262084a33b96782faae3058ebdac89d40831c72eb654969a1731205a43a8e0

data/README.md

@@ -24,3 +24,20 @@ This library supports the development of financial data applications and analysi
 ```bash
 pip3 install yfinance
 ```
+
+# Example
+
+```ruby
+ticker = YfinanceWrapper::Ticker.new('APPL')
+ticker.info
+# {"quoteType"=>"MUTUALFUND",
+#  "symbol"=>"APPL",
+#  "language"=>"en-US"
+# ...
+# }
+
+ticker.history(period: "max", interval: "1d")
+# {1980-12-12 00:00:00 -0500=>
+# ...
+# }
+```

data/lib/yfinance_wrapper/ticker.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "pycall/import"
+require "date"
+require "time"
 
 module YfinanceWrapper
   class Ticker
@@ -26,9 +28,148 @@ module YfinanceWrapper
       res
     end
 
-    private
+    def news
+      result = @ticker.news
+      result.map { |v| v.to_h }
+    end
+
+    def basic_info
+      result = @ticker.basic_info
+      result.keys.each_with_object({}) do |key, hash|
+        hash[key] = to_ruby_type(result[key])
+      end
+    end
+
+    def calendar
+      result = @ticker.calendar
+      result.each_with_object({}) do |pair, hash|
+        hash[pair[0]] = to_ruby_type(pair[1])
+      end
+    end
+
+    def earnings = nil
+
+    def isin
+      @ticker.isin
+    end
+
+    def options
+      @ticker.options.to_a
+    end
+
+    def fast_info
+      result = @ticker.fast_info
+      result.keys.each_with_object({}) do |key, hash|
+        hash[key] = to_ruby_type(result[key])
+      end
+    end
+
+    DF_METHODS = %i[actions balance_sheet capital_gains cash_flow cashflow dividends earnings_dates earnings_estimate
+                    earnings_history eps_revisions eps_trend financials growth_estimates income_stmt incomestmt
+                    insider_purchases insider_roster_holders insider_transactions institutional_holders major_holders
+                    mutualfund_holders quarterly_balance_sheet quarterly_balancesheet quarterly_cash_flow quarterly_cashflow
+                    quarterly_income_stmt quarterly_income_stmt quarterly_incomestmt recommendations recommendations_summary
+                    splits sustainability ttm_cash_flow ttm_cashflow ttm_financials ttm_income_stmt ttm_incomestmt upgrades_downgrades]
+    DICT_METHODS = %i[analyst_price_targets history_metadata quarterly_financials revenue_estimate]
+    LIST_METHODS = %i[news sec_filings]
+
+    UNIMPLEMENTED_METHODS = %i[funds_data quarterly_earnings]
+
+    DF_METHODS.each do |method|
+      define_method(method) do |*args, **kwargs|
+        result = @ticker.send(method, *args, **kwargs)
+        to_ruby_type(result)
+      end
+    end
+
+    DICT_METHODS.each do |method|
+      define_method(method) do |*args, **kwargs|
+        result = @ticker.send(method, *args, **kwargs)
+        to_ruby_type(result)
+      end
+    end
+
+    UNIMPLEMENTED_METHODS.each do |method|
+      define_method(method) do
+        raise NotImplementedError, "Method #{method} is not implemented"
+      end
+    end
+
+    LIST_METHODS.each do |method|
+      define_method(method) do |*args, **kwargs|
+        result = @ticker.send(method, *args, **kwargs)
+        list_to_ruby_type(result)
+      end
+    end
+
+    # private
+    def list_to_ruby_type(list)
+      list.map { |v| dict_to_ruby_type(v) }
+    end
+
+    def to_ruby_type(value)
+      return dict_to_ruby_type(value) if value.class.to_s == "<class 'dict'>"
+
+      return df_to_ruby_type(value) if value.respond_to?(:index) && value.respond_to?(:keys)
+
+      case value.to_s
+      when /\A-?\d+\.\d+\Z/
+        value.to_f
+      when /\A-?\d+\Z/
+        value.to_i
+      when /\A\[.+?\]\Z/
+        if value.respond_to?(:map)
+          value.map { |v| to_ruby_type(v) }
+        else
+          value.size.times.map { |i| to_ruby_type(value[i]) }
+        end
+      when /\A\d{4}-\d{2}-\d{2}\Z/
+        date = value.to_s.scan(/\d+/).map(&:to_i)
+        Date.new(date[0], date[1], date[2])
+      when /\A\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\Z/
+        Time.strptime(value.to_s, "%Y-%m-%d %H:%M:%S")
+      when /\Anan\Z/, /\ANaN\Z/
+        Float::NAN
+      else
+        value.to_s
+      end
+    end
+
+    def df_to_ruby_type(df)
+      indexes = df.index
+
+      indexes.size.times.each_with_object({}) do |i, hash|
+        index = indexes[i]
+        ruby_index = to_ruby_type(indexes[i])
+        value = df.loc[index]
+        ruby_value = if value.respond_to?(:index) && value.respond_to?(:keys)
+                       df_to_ruby_type(value)
+                     else
+                       to_ruby_type(value)
+                     end
+
+        hash[ruby_index] = ruby_value
+      end
+    end
+
+    def dict_to_ruby_type(dict)
+      if dict.respond_to?(:to_h)
+        hash = dict.to_h
+        hash.each_with_object({}) do |(key, value), hash|
+          hash[key] = to_ruby_type(value)
+        end
+      elsif dict.respond_to?(:each_with_object)
+        dict.each_with_object({}) do |(key, value), hash|
+          hash[key] = to_ruby_type(value)
+        end
+        els
+        dict.keys.each_with_object({}) do |key, hash|
+          value = dict[key]
+          hash[key] = to_ruby_type(value)
+        end
+      end
+    end
 
-    # Add Candle class when candle needs more mothods.
     def candle_to_hash(candle, keys)
       keys.each_with_object({}) do |key, hash|
         hash[key] = candle[key].to_f

data/lib/yfinance_wrapper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yfinance_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ys7i
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-13 00:00:00.000000000 Z
+date: 2025-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pycall