sqa 0.0.14 → 0.0.17

data/lib/sqa/errors.rb

@@ -1,6 +1,30 @@
 # lib/sqa/errors.rb
 
-module SQA
-	# raised when an API contract is broken
-	class BadParameterError < ArgumentError; end
+# raised when a method is still in TODO state
+class ApiError < RuntimeError
+  def self.raise(why)
+    puts "="*64
+    puts "== API Error"
+    puts why
+    puts
+    puts "Callback trace:"
+    puts caller
+    puts "="*64
+    super
+  end
 end
+
+# raised when a method is still in TODO state
+class NotImplemented < RuntimeError
+  def self.raise
+    puts "="*64
+    puts "== Not Yet Implemented"
+    puts "Callback trace:"
+    puts caller
+    puts "="*64
+    super
+  end
+end
+
+# raised when an API contract is broken
+class BadParameterError < ArgumentError; end

data/lib/sqa/init.rb

@@ -0,0 +1,51 @@
+# sqa/lib/sqa/init.rb
+
+module SQA
+	class << self
+		@@config 	= nil
+		@@av 			= ApiKeyManager::RateLimited.new(
+									api_keys: 		ENV['AV_API_KEYS'],
+									delay: 				true,
+									rate_count: 	ENV['AV_RATE_CNT'] ||  5,
+									rate_period: 	ENV['AV_RATE_PER'] || 60
+								)
+
+		# 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)
+
+			config
+		end
+
+		def av() 								= @@av
+
+		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,91 +1,148 @@
 # lib/sqa/stock.rb
 
-require 'active_support/core_ext/string' # for String#underscore
-require 'hashie' # for Hashie::Mash
-
 
 # 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
+  extend Forwardable
+
   CONNECTION = Faraday.new(url: "https://www.alphavantage.co")
 
-  attr_accessor :company_name
-  attr_accessor :df             # The DataFrane
-  attr_accessor :ticker
-  attr_accessor :type           # type of data store (default is CSV)
-  attr_accessor :indicators
+  attr_accessor :data # General Info      -- SQA::DataFrame::Data
+  attr_accessor :df   # Historical Prices -- SQA::DataFrame::Data
+
+  attr_accessor :klass        # class of historical and current prices
+  attr_accessor :transformers # procs for changing column values from String to Numeric
 
   def initialize(
         ticker:,
-        source: :alpha_vantage,
-        type:   :csv
+        source: :alpha_vantage
       )
+
+    @ticker     = ticker.downcase
+    @source     = source
+
     raise "Invalid Ticker #{ticker}" unless SQA::Ticker.valid?(ticker)
 
-    # TODO: Change API on lookup to return array instead of hash
-    #       Could this also incorporate the validation process to
-    #       save an additiona hash lookup?
+    @data_path  = SQA.data_dir + "#{@ticker}.json"
+    @df_path    = SQA.data_dir + "#{@ticker}.csv"
 
-    entry         = SQA::Ticker.lookup(ticker)
+    @klass         = "SQA::DataFrame::#{@source.to_s.camelize}".constantize
+    @transformers  = "SQA::DataFrame::#{@source.to_s.camelize}::TRANSFORMERS".constantize
 
-    @ticker       = ticker.downcase
-    @company_name = entry[:name]
-    @exchange     = entry[:exchange]
-    @klass        = "SQA::DataFrame::#{source.to_s.camelize}".constantize
-    @type         = type
-    @indicators   = OpenStruct.new
+    if @data_path.exist?
+      load
+    else
+      create
+      update
+      save
+    end
 
     update_the_dataframe
   end
 
 
-  def update_the_dataframe
-    df1 = @klass.load(@ticker, type)
-    df2 = @klass.recent(@ticker)
+  def load
+    @data = SQA::DataFrame::Data.new(
+              JSON.parse(@data_path.read)
+            )
+  end
+
+
+  def create
+    @data =
+      SQA::DataFrame::Data.new(
+        {
+          ticker:       @ticker,
+          source:       @source,
+          indicators:   { xyzzy: "Magic" },
+        }
+      )
+  end
+
+
+  def update
+    merge_overview
+  end
+
+
+  def save
+    @data_path.write @data.to_json
+  end
+
+
+  def_delegator :@data, :ticker,      :ticker
+  def_delegator :@data, :name,        :name
+  def_delegator :@data, :exchange,    :exchange
+  def_delegator :@data, :source,      :source
+  def_delegator :@data, :indicators,  :indicators
+  def_delegator :@data, :indicators=, :indicators=
+  def_delegator :@data, :overview,    :overview
 
-    df1_nrows = df1.nrows
-    @df       = @klass.append(df1, df2)
 
-    if @df.nrows > df1_nrows
-      @df.send("to_#{@type}", SQA.data_dir + "#{ticker}.csv")
+
+  def update_the_dataframe
+    if @df_path.exist?
+      @df     = SQA::DataFrame.load(
+        source:       @df_path,
+        transformers: @transformers
+      )
+    else
+      @df     = klass.recent(@ticker, full: true)
+      @df.to_csv(@df_path)
+      return
     end
 
-    # Adding a ticker vector in case I want to do
-    # some multi-stock analysis in the same data frame.
-    # For example to see how one stock coorelates with another.
-    @df[:ticker]  = @ticker
+    from_date = Date.parse(@df.timestamp.last) + 1
+    df2       = klass.recent(@ticker, from_date: from_date)
+
+    return if df2.nil?  # CSV file is up to date.
+
+    df_nrows  = @df.nrows
+    @df.append(df2)
+
+    if @df.nrows > df_nrows
+      @df.to_csv(file_path)
+    end
   end
 
+
   def to_s
     "#{ticker} with #{@df.size} data points from #{@df.timestamp.first} to #{@df.timestamp.last}"
   end
+  alias_method :inspect, :to_s
 
-  # TODO: Turn this into a class Stock::Overview
-  #       which is a sub-class of Hashie::Dash
-  def overview
-    return @overview unless @overview.nil?
 
+  def merge_overview
     temp = JSON.parse(
-      CONNECTION.get("/query?function=OVERVIEW&symbol=#{@ticker.upcase}&apikey=#{Nenv.av_api_key}")
+      CONNECTION.get("/query?function=OVERVIEW&symbol=#{ticker.upcase}&apikey=#{SQA.av.key}")
         .to_hash[:body]
     )
 
+    if temp.has_key? "Information"
+      ApiError.raise(temp["Information"])
+    end
+
     # 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 ]
+    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
+    @data.overview = temp2
   end
 
 
@@ -101,13 +158,13 @@ class SQA::Stock
     def top
       return @@top unless @@top.nil?
 
-      mash = Hashie::Mash.new(
-        JSON.parse(
-          CONNECTION.get(
-            "/query?function=TOP_GAINERS_LOSERS&apikey=#{Nenv.av_api_key}"
-          ).to_hash[:body]
-        )
-      )
+      a_hash  = JSON.parse(
+                  CONNECTION.get(
+                    "/query?function=TOP_GAINERS_LOSERS&apikey=#{SQA.av.key}"
+                  ).to_hash[:body]
+                )
+
+      mash = Hashie::Mash.new(a_hash)
 
       keys = mash.top_gainers.first.keys
 

data/lib/sqa/strategy.rb

@@ -8,7 +8,7 @@ class SQA::Strategy
   end
 
   def add(a_strategy)
-    raise SQA::BadParameterError unless [Class, Method].include? a_strategy.class
+    raise BadParameterError unless [Class, Method].include? a_strategy.class
 
     a_proc  = if Class == a_strategy.class
                 a_strategy.method(:trade)

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.14"
+  VERSION = "0.0.17"
 
   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,77 +1,56 @@
 # lib/sqa.rb
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/core_ext/string'
-require 'amazing_print'
-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
-
-		# 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)
+require 'active_support/core_ext/string'
+require 'alphavantage' 	# TODO: add rate limiter to it; ** PR submitted! **
+require 'api_key_manager'
+require 'amazing_print'
+require 'descriptive_statistics'
+require 'faraday'
+require 'hashie'
+require 'nenv'
+require 'sem_version'
+require 'sem_version/core_ext'
+require 'tty-option'
+require 'tty-table'
 
-			Daru.lazy_update 			= config.lazy_update
-			Daru.plotting_library = config.plotting_library
 
-			config
-		end
+#############################################
+## SQA soecufuc code
 
-		def debug?() 						= @@config.debug?
-		def verbose?() 					= @@config.verbose?
+require_relative "sqa/version"
+require_relative "sqa/errors"
 
-		def homify(filepath) 		= filepath.gsub(/^~/, Nenv.home)
-		def data_dir() 					= Pathname.new(config.data_dir)
-		def config()            = @@config
+require_relative 'sqa/init.rb'
 
-		def config=(an_object)
-			@@config = an_object
-		end
-	end
-end
 
-# 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,45 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: sqa
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.17
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-23 00:00:00.000000000 Z
+date: 2023-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   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: daru
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.0.6
 - !ruby/object:Gem::Dependency
-  name: descriptive_statistics
+  name: alphavantage
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: api_key_manager
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,35 +53,7 @@ dependencies:
       - !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
-  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-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:
     - - ">="
@@ -282,7 +240,8 @@ files:
 - 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.17.gem.sha512
 - checksums/sqa-0.0.2.gem.sha512
 - checksums/sqa-0.0.3.gem.sha512
 - checksums/sqa-0.0.4.gem.sha512
@@ -293,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
@@ -316,14 +276,6 @@ files:
 - docs/stochastic_oscillator.md
 - docs/strategy.md
 - docs/true_range.md
-- lib/patches/daru.rb
-- lib/patches/daru/category.rb
-- lib/patches/daru/data_frame.rb
-- lib/patches/daru/plotting/svg-graph.rb
-- lib/patches/daru/plotting/svg-graph/category.rb
-- lib/patches/daru/plotting/svg-graph/dataframe.rb
-- lib/patches/daru/plotting/svg-graph/vector.rb
-- lib/patches/daru/vector.rb
 - lib/sqa.rb
 - lib/sqa/activity.rb
 - lib/sqa/analysis.rb
@@ -356,6 +308,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
@@ -379,7 +332,8 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/MadBomber/sqa
-  source_code_uri: https://github.com/MadBomber/sta
+  source_code_uri: https://github.com/MadBomber/sqa
+  changelog_uri: https://github.com/MadBomber/sqa
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -395,7 +349,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: sqa - Stock Qualitative Analysis

data/checksums/sqa-0.0.14.gem.sha512

@@ -1 +0,0 @@
-c5eea4fb74e6ab7b7b1715a81598585ec540a3eb1e9b902ca339ff0a2ba9cc7624ae3f43e00b5fbbad1d3d510ed938e8f91154c0bee2e14d6503564b1b0ccfb1

data/lib/patches/daru/category.rb

@@ -1,19 +0,0 @@
-# lib/patches/daru/category.rb
-
-module Daru
-	module Category
-
-		def plotting_lig lib
-			if :svg_graph = lib
-        @plotting_library = lib
-        if Daru.send("has_#{lib}?".to_sym)
-          extend Module.const_get(
-            "Daru::Plotting::Category::#{lib.to_s.capitalize}Library"
-          )
-        end
-			else
-				super
-			end
-		end
-	end
-end

data/lib/patches/daru/data_frame.rb

@@ -1,19 +0,0 @@
-# lib/patches/daru/data_frame.rb
-
-module Daru
-	module DataFrame
-
-		def plotting_lig lib
-			if :svg_graph = lib
-        @plotting_library = lib
-        if Daru.send("has_#{lib}?".to_sym)
-          extend Module.const_get(
-            "Daru::Plotting::DataFrame::#{lib.to_s.capitalize}Library"
-          )
-        end
-			else
-				super
-			end
-		end
-	end
-end