sqa 0.0.13 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dd371b757bcc5da8e913681a06666715cbe88ca11f582df64d68ef305391d28
-  data.tar.gz: 8b1851af5e7875266acbd3fb35a7ba108fdb267d7490eb19984819bba5f15538
+  metadata.gz: 0fcc7dbda5b62549fa1fb9691bf7ef9af1a0ba5dfcff63494ce2cdf6ca7e578a
+  data.tar.gz: 9527508fa1573a09536ef4bf735671761d722d1611494d3aeb8615ba25385f2c
 SHA512:
-  metadata.gz: ab803635e2f85e71bebacab6be10cc345f6050a890c730a658741d4a3ae4530490be33fc692a3ced0e843e473cc5613644dc5a0c0d0bfd3a43d5c0d2b4d41510
-  data.tar.gz: 7ee788d760d4020efb41baa3f5bc894cc4824d0308144b68f8c352bed03a01ce2049547bace95636264fab1c7b58ab12f97c99209433e2b32719db575017d25c
+  metadata.gz: c5ce2164cd95cf91c62e054dad4fef84ed105d7713207bf5f5e39fbad282785184217ed303fe73b24801b871e9ca0db371c0f514949803aace37b788ebec6140
+  data.tar.gz: f7336d71e365388d571267e87fbdd82a66dbd532da8e386e9670e1a9f7034d2279202e6df16ce30d14410b2ab39923ecf4bb78e0941b554bf11ee3101fdb9a41

data/checksums/sqa-0.0.13.gem.sha512

@@ -0,0 +1 @@
+524fd82ea9501f1b1b1a3bf3e0f1a500e675d3f4664d342b8b377995f310c1e40a597f61d8e0bf8d2fa8dd83202f7a415b517df371dbf370c25f59fb0fb42d96

data/checksums/sqa-0.0.14.gem.sha512

@@ -0,0 +1 @@
+ae291d1c8a3a80fc6f24a6a1194c6db1b6e1fbdbee586546ae34db6ee304a3e431ea59a154ea976af0f25f3b0d6519f2e0a1aad4ddf3c3cdf77b7d37aabf425f

data/checksums/sqa-0.0.15.gem.sha512

@@ -0,0 +1 @@
+d4f3ab1bf26de034f0f044a5cab9d86e61221fc2d160056c1c24c166586e7ce72d90095ebea01965f5cabf989c4116e7409f8fc6749cabe7d5a13e34f87f4b96

data/docs/alpha_vantage_technical_indicators.md

@@ -0,0 +1,62 @@
+# Alpha Vantage
+## Technical Indicators
+
+The following technical indicators are available from Alpha Vantage
+using a free API key.
+
+| Acronym   | Indicator Description                                    |
+|-----------|----------------------------------------------------------|
+| AD        | Accumulation/Distribution                               |
+| ADOSC     | Accumulation/Distribution Oscillator                    |
+| ADX       | Average Directional Index                               |
+| ADXR      | Average Directional Movement Rating                     |
+| APO       | Absolute Price Oscillator                              |
+| AROON     | Aroon Indicator                                        |
+| AROONOSC  | Aroon Oscillator                                       |
+| ATR       | Average True Range                                     |
+| BBANDS    | Bollinger Bands                                        |
+| BOP       | Balance of Power                                       |
+| CCI       | Commodity Channel Index                                |
+| CMO       | Chande Momentum Oscillator                             |
+| DEMA      | Double Exponential Moving Average                      |
+| DX        | Directional Movement Index                             |
+| EMA       | Exponential Moving Average                             |
+| HT_DCPERIOD | Hilbert Transform - Dominant Cycle Period             |
+| HT_DCPHASE | Hilbert Transform - Dominant Cycle Phase              |
+| HT_PHASOR  | Hilbert Transform - Phasor Components                  |
+| HT_SINE    | Hilbert Transform - SineWave                           |
+| HT_TRENDLINE | Hilbert Transform - Instantaneous Trendline           |
+| HT_TRENDMODE | Hilbert Transform - Trend vs Cycle Mode               |
+| KAMA       | Kaufman Adaptive Moving Average                        |
+| MACD       | Moving Average Convergence Divergence                  |
+| MACDEXT    | MACD with controllable MA type                         |
+| MAMA       | MESA Adaptive Moving Average                           |
+| MFI        | Money Flow Index                                      |
+| MIDPOINT   | MidPoint over period                                   |
+| MIDPRICE   | Midpoint Price over period                             |
+| MINUS_DI   | Minus Directional Indicator                            |
+| MINUS_DM   | Minus Directional Movement                             |
+| MOM        | Momentum                                              |
+| NATR       | Normalized Average True Range                          |
+| OBV        | On Balance Volume                                     |
+| PLUS_DI    | Plus Directional Indicator                             |
+| PLUS_DM    | Plus Directional Movement                              |
+| PPO        | Percentage Price Oscillator                            |
+| ROC        | Rate of Change                                        |
+| ROCR       | Rate of Change Ratio                                  |
+| RSI        | Relative Strength Index                               |
+| SAR        | Parabolic SAR                                         |
+| SMA        | Simple Moving Average                                  |
+| STOCH      | Stochastic Oscillator                                 |
+| STOCHF     | Stochastic Fast                                       |
+| STOCHRSI   | Stochastic Relative Strength Index                     |
+| T3         | Triple Exponential Moving Average (T3)                |
+| TEMA       | Triple Exponential Moving Average                      |
+| TRANGE     | True Range                                            |
+| TRIMA      | Triangular Moving Average                              |
+| TRIX       | 1-day Rate of Change of a Triple Smooth EMA            |
+| ULTOSC     | Ultimate Oscillator                                   |
+| VWAP       | Volume Weighted Average Price                          |
+| WILLR      | Williams' %R                                          |
+| WMA        | Weighted Moving Average                                |
+

data/lib/patches/daru/plotting/svg-graph.rb

@@ -1,6 +1,5 @@
 # lib/patches/daru/plotting/svg-graph.rb
 
-require 'svg-graph'
 
 require_relative 'SvgGraph/category.rb'
 require_relative 'SvgGraph/vector.rb'

data/lib/sqa/cli.rb

@@ -1,6 +1,5 @@
 # lib/sqa/cli.rb
 
-require 'tty-option'
 
 require_relative '../sqa'
 

data/lib/sqa/config.rb

@@ -6,17 +6,18 @@
 #   config file ..... overrides envar
 #   command line parameters ...... overrides config file
 
-require 'hashie'
-require 'yaml'
-require 'json'
-require 'toml-rb'
-
 
 module SQA
 	class Config < Hashie::Dash
     include Hashie::Extensions::Dash::PropertyTranslation
     include Hashie::Extensions::Coercion
-    include Hashie::Extensions::Dash::PredefinedValues
+
+    # FIXME:  Getting undefined error PredefinedValues
+    #         I'm thinking that Ruby is dropping it from the ObjectSpace
+    #         Looks like it is only used for the log level.  Should
+    #         able to work around that.
+    #
+    # include Hashie::Extensions::Dash::PredefinedValues
 
     property :config_file   #,a String filepath for the current config overriden by cli options
     property :dump_config   # a String filepath into which to dump the current config

data/lib/sqa/data_frame/alpha_vantage.rb

@@ -4,8 +4,6 @@
 # Using the Alpha Vantage JSON interface
 #
 
-require 'faraday'
-require 'json'
 
 class SQA::DataFrame < Daru::DataFrame
   class AlphaVantage

data/lib/sqa/data_frame/yahoo_finance.rb

@@ -1,8 +1,6 @@
 # lib/sqa/data_frame/yahoo_finance.rb
 # frozen_string_literal: true
 
-require 'faraday'
-require 'nokogiri'
 
 class SQA::DataFrame < Daru::DataFrame
   class YahooFinance

data/lib/sqa/init.rb

@@ -0,0 +1,46 @@
+# sqa/lib/sqa/init.rb
+
+module SQA
+	class << self
+		@@config = nil
+
+		# Initializes the SQA modules
+		# returns the configuration
+		#
+		def init(argv=ARGV)
+			if argv.is_a? String
+				argv = argv.split()
+			end
+
+
+			# Ran at SQA::Config elaboration time
+			# @@config = Config.new
+
+			if defined? CLI
+				CLI.run(argv)
+			else
+				# There are no real command line parameters
+				# because the sqa gem is being required within
+				# the context of a larger program.
+			end
+
+			config.data_dir = homify(config.data_dir)
+
+			Daru.lazy_update 			= config.lazy_update
+			Daru.plotting_library = config.plotting_library
+
+			config
+		end
+
+		def debug?() 						= @@config.debug?
+		def verbose?() 					= @@config.verbose?
+
+		def homify(filepath) 		= filepath.gsub(/^~/, Nenv.home)
+		def data_dir() 					= Pathname.new(config.data_dir)
+		def config()            = @@config
+
+		def config=(an_object)
+			@@config = an_object
+		end
+	end
+end

data/lib/sqa/stock.rb

@@ -1,6 +1,13 @@
 # lib/sqa/stock.rb
 
+
+# SMELL:  SQA::Stock is now pretty coupled to the Alpha Vantage
+#         API service.  Should that stuff be extracted into a
+#         separate class and injected by the requiring program?
+
 class SQA::Stock
+  CONNECTION = Faraday.new(url: "https://www.alphavantage.co")
+
   attr_accessor :company_name
   attr_accessor :df             # The DataFrane
   attr_accessor :ticker
@@ -51,4 +58,72 @@ class SQA::Stock
   def to_s
     "#{ticker} with #{@df.size} data points from #{@df.timestamp.first} to #{@df.timestamp.last}"
   end
+
+  # TODO: Turn this into a class Stock::Overview
+  #       which is a sub-class of Hashie::Dash
+  def overview
+    return @overview unless @overview.nil?
+
+    temp = JSON.parse(
+      CONNECTION.get("/query?function=OVERVIEW&symbol=#{@ticker.upcase}&apikey=#{Nenv.av_api_key}")
+        .to_hash[:body]
+    )
+
+    # TODO: CamelCase hash keys look common in Alpha Vantage
+    #       JSON; look at making a special Hashie-based class
+    #       to convert the keys to normal Ruby standards.
+
+    temp2 = {}
+
+    string_values = %w[ address asset_type cik country currency description dividend_date ex_dividend_date exchange fiscal_year_end industry latest_quarter name sector symbol ]
+
+    temp.keys.each do |k|
+      new_k         = k.underscore
+      temp2[new_k]  = string_values.include?(new_k) ? temp[k] : temp[k].to_f
+    end
+
+    @overview = Hashie::Mash.new temp2
+  end
+
+
+  #############################################
+  ## Class Methods
+
+  class << self
+    @@top = nil
+
+    # Top Gainers, Losers and Most Active for most
+    # recent closed trading day.
+    #
+    def top
+      return @@top unless @@top.nil?
+
+      a_hash  = JSON.parse(
+                  CONNECTION.get(
+                    "/query?function=TOP_GAINERS_LOSERS&apikey=#{Nenv.av_api_key}"
+                  ).to_hash[:body]
+                )
+
+      mash = Hashie::Mash.new(a_hash)
+
+      keys = mash.top_gainers.first.keys
+
+      %w[top_gainers top_losers most_actively_traded].each do |collection|
+        mash.send(collection).each do |e|
+          keys.each do |k|
+            case k
+            when 'ticker'
+              # Leave it as a String
+            when 'volume'
+              e[k] = e[k].to_i
+            else
+              e[k] = e[k].to_f
+            end
+          end
+        end
+      end
+
+      @@top = mash
+    end
+  end
 end

data/lib/sqa/version.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require 'sem_version'
-require 'sem_version/core_ext'
-
 module SQA
-  VERSION = "0.0.13"
+  VERSION = "0.0.15"
 
   class << self
     def version

data/lib/sqa/web.rb

@@ -1,6 +1,6 @@
 # lib/sqa/command/web.rb
 
-require 'tty-option'
+# require 'tty-option'
 
 
 module SQA

data/lib/sqa.rb

@@ -1,79 +1,57 @@
 # lib/sqa.rb
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/core_ext/string'
-require 'daru'
-require 'date'
-require 'descriptive_statistics'
-require 'nenv'
-require 'pathname'
+# TODO: Create a new gem for the dumbstockapi website
 
-require_relative "sqa/version"
-require_relative "sqa/errors"
+#############################################
+## Standard Libraries
 
+require 'date'
+require 'pathname'
 
 unless defined?(HOME)
-	HOME = Pathname.new(Nenv.home)
+	HOME = Pathname.new(ENV['HOME'])
 end
 
+#############################################
+## Additional Libraries
 
-module SQA
-	class << self
-		@@config = nil
-
-		def init(argv=ARGV)
-			if argv.is_a? String
-				argv = argv.split()
-			end
-
-
-			# Ran at SQA::Config elaboration time
-			# @@config = Config.new
-
-			if defined? CLI
-				CLI.run(argv)
-			else
-				# There are no real command line parameters
-				# because the sqa gem is being required within
-				# the context of a larger program.
-			end
-
-			config.data_dir = homify(config.data_dir)
-
-			Daru.lazy_update 			= config.lazy_update
-			Daru.plotting_library = config.plotting_library
-
-			if config.debug? || config.verbose?
-				debug_me{[
-					:config
-				]}
-			end
+require 'active_support/core_ext/string'
+require 'alphavantage' 	# TODO: add rate limiter to it
+require 'amazing_print'
+require 'daru' 					# TODO: Replace this gem with something better
+require 'descriptive_statistics'
+require 'faraday'
+require 'hashie'
+require 'nenv'
+require 'sem_version'
+require 'sem_version/core_ext'
+require 'tty-option'
+require 'tty-table'
 
-			nil
-		end
 
-		def debug?() 						= @@config.debug?
-		def verbose?() 					= @@config.verbose?
+#############################################
+## SQA soecufuc code
 
-		def homify(filepath) 		= filepath.gsub(/^~/, Nenv.home)
-		def data_dir() 					= Pathname.new(config.data_dir)
-		def config()            = @@config
+require_relative "sqa/version"
+require_relative "sqa/errors"
 
-		def config=(an_object)
-			@@config = an_object
-		end
-	end
-end
+require_relative 'sqa/init.rb'
 
 # require_relative "patches/daru" # TODO: extract Daru::DataFrame in new gem sqa-data_frame
 
+# TODO: Some of these components make direct calls to the
+# 			Alpha Vantage API.  Convert them to use the
+# 			alphavantage gem.
+
 require_relative "sqa/config"
-require_relative "sqa/constants"
-require_relative "sqa/data_frame"
+require_relative "sqa/constants" 	# SMELL: more app than gem
+require_relative "sqa/data_frame" # TODO: drop the daru gem
 require_relative "sqa/indicator"
 require_relative "sqa/portfolio"
 require_relative "sqa/strategy"
 require_relative "sqa/stock"
 require_relative "sqa/ticker"
-require_relative "sqa/trade"
+require_relative "sqa/trade" # SMELL: Not really a core gem; more of an application thing
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqa
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-22 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: daru
+  name: alphavantage
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,49 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: descriptive_statistics
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: nenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: tty-logger
+  name: daru
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tty-markdown
+  name: descriptive_statistics
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tty-option
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,21 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tty-progressbar
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
-  name: tty-prompt
+  name: nenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tty-reader
+  name: sem_version
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tty-spinner
+  name: tty-option
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -281,6 +239,9 @@ files:
 - checksums/sqa-0.0.10.gem.sha512
 - checksums/sqa-0.0.11.gem.sha512
 - checksums/sqa-0.0.12.gem.sha512
+- checksums/sqa-0.0.13.gem.sha512
+- checksums/sqa-0.0.14.gem.sha512
+- checksums/sqa-0.0.15.gem.sha512
 - checksums/sqa-0.0.2.gem.sha512
 - checksums/sqa-0.0.3.gem.sha512
 - checksums/sqa-0.0.4.gem.sha512
@@ -291,6 +252,7 @@ files:
 - checksums/sqa-0.0.9.gem.sha512
 - docs/.gitignore
 - docs/README.md
+- docs/alpha_vantage_technical_indicators.md
 - docs/average_true_range.md
 - docs/bollinger_bands.md
 - docs/candlestick_pattern_recognizer.md
@@ -354,6 +316,7 @@ files:
 - lib/sqa/indicator/simple_moving_average_trend.rb
 - lib/sqa/indicator/stochastic_oscillator.rb
 - lib/sqa/indicator/true_range.rb
+- lib/sqa/init.rb
 - lib/sqa/portfolio.rb
 - lib/sqa/stock.rb
 - lib/sqa/strategy.rb