sqa 0.0.15 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fcc7dbda5b62549fa1fb9691bf7ef9af1a0ba5dfcff63494ce2cdf6ca7e578a
-  data.tar.gz: 9527508fa1573a09536ef4bf735671761d722d1611494d3aeb8615ba25385f2c
+  metadata.gz: 911775606b7e0fa046261c5a9bc4d3be21ca9caf38c37011141f1393ac6e5063
+  data.tar.gz: d70ae996a39dbe7c386750286cb4cc437681d584945b31104e91b06c30b1600f
 SHA512:
-  metadata.gz: c5ce2164cd95cf91c62e054dad4fef84ed105d7713207bf5f5e39fbad282785184217ed303fe73b24801b871e9ca0db371c0f514949803aace37b788ebec6140
-  data.tar.gz: f7336d71e365388d571267e87fbdd82a66dbd532da8e386e9670e1a9f7034d2279202e6df16ce30d14410b2ab39923ecf4bb78e0941b554bf11ee3101fdb9a41
+  metadata.gz: '0074688f69947d20d5aae7c81b090a91fb4f06862084b2349b248ecdf2e17376f47d5a1acffbfb7b2700865cf25f5ff5ba054514d00ed88750f46224b4c9360e'
+  data.tar.gz: 38d1ebf511e9dfa2b87084ed77093e2fc03ccf6eeb6a00e42d1060acca82e135d0b4c0d36a25d9f9bc4a2dd9adf91749a6640aab14b304e33f24fee0c3eb7e15

data/README.md

@@ -1,3 +1,7 @@
+**Replacing Daru** with Hashie::Mash
+
+This is branch hashie_df
+
 # SQA - Simple Qualitative Analysis
 
 This is a very simplistic set of tools for running technical analysis on a stock portfolio.  Simplistic means it is not reliable nor intended for any kind of financial use.  Think of it as a training tool.  I do.  Its helping me understand why I need professional help from people who know what they are doing.

data/checksums/sqa-0.0.17.gem.sha512

@@ -0,0 +1 @@
+2ee94a54d6ac3d13685dc9b91a2bae0fe75feab6148e1aa9a9d4096961b9b7b577b7ce9d1264f0cce260640515ddd86d5fd5fd2b66f49175844c903581ff6fd9

data/lib/sqa/data_frame/alpha_vantage.rb

@@ -5,9 +5,8 @@
 #
 
 
-class SQA::DataFrame < Daru::DataFrame
+class SQA::DataFrame
   class AlphaVantage
-    API_KEY     = Nenv.av_api_key
     CONNECTION  = Faraday.new(url: 'https://www.alphavantage.co')
     HEADERS     = YahooFinance::HEADERS
 
@@ -24,47 +23,16 @@ class SQA::DataFrame < Daru::DataFrame
       "volume"          => HEADERS[6]
     }
 
+    TRANSFORMERS  = {
+      HEADERS[1] => -> (v) { v.to_f.round(3) },
+      HEADERS[2] => -> (v) { v.to_f.round(3) },
+      HEADERS[3] => -> (v) { v.to_f.round(3) },
+      HEADERS[4] => -> (v) { v.to_f.round(3) },
+      HEADERS[5] => -> (v) { v.to_f.round(3) },
+      HEADERS[6] => -> (v) { v.to_i }
+    }
 
     ################################################################
-    # Load a Dataframe from a csv file
-    def self.load(ticker, type="csv")
-      filepath = SQA.data_dir + "#{ticker}.#{type}"
-
-      if filepath.exist?
-        df = normalize_vector_names SQA::DataFrame.load(ticker, type)
-      else
-        df = recent(ticker, full: true)
-        df.send("to_#{type}",filepath)
-      end
-
-      df
-    end
-
-
-    # Normalize the vector (aka column) names as
-    # symbols using the standard names set by
-    # Yahoo Finance ... since it was the first one
-    # not because its anything special.
-    #
-    def self.normalize_vector_names(df)
-      headers = df.vectors.to_a
-
-      # convert vector names to symbols
-      # when they are strings.  They become stings
-      # when the data frame is saved to a CSV file
-      # and then loaded back in.
-
-      if headers.first == HEADERS.first.to_s
-        a_hash = {}
-        HEADERS.each {|k| a_hash[k.to_s] = k}
-        df.rename_vectors(a_hash) # renames from String to Symbol
-      else
-        df.rename_vectors(HEADER_MAPPING)
-      end
-
-      df
-    end
-
 
     # Get recent data from JSON API
     #
@@ -82,7 +50,8 @@ class SQA::DataFrame < Daru::DataFrame
     #       and adding that to the data frame as if it were
     #       adjusted.
     #
-    def self.recent(ticker, full: false)
+    def self.recent(ticker, full: false, from_date: nil)
+
       # NOTE: Using the CSV format because the JSON format has
       #       really silly key values.  The column names for the
       #       CSV format are much better.
@@ -90,7 +59,7 @@ class SQA::DataFrame < Daru::DataFrame
         "/query?" +
         "function=TIME_SERIES_DAILY&" +
         "symbol=#{ticker.upcase}&" +
-        "apikey=#{API_KEY}&" +
+        "apikey=#{SQA.av.key}&" +
         "datatype=csv&" +
         "outputsize=#{full ? 'full' : 'compact'}"
       ).to_hash
@@ -100,18 +69,19 @@ class SQA::DataFrame < Daru::DataFrame
       end
 
       raw           = response[:body].split
-
       headers       = raw.shift.split(',')
+
       headers[0]    = 'date'  # website returns "timestamp" but that
                               # has an unintended side-effect when
                               # the names are normalized.
+                              # SMELL: IS THIS STILL TRUE?
 
       close_inx     = headers.size - 2
       adj_close_inx = close_inx + 1
 
       headers.insert(adj_close_inx, 'adjusted_close')
 
-      data    = raw.map do |e|
+      aofh    = raw.map do |e|
                   e2 = e.split(',')
                   e2[1..-2] = e2[1..-2].map(&:to_f) # converting open, high, low, close
                   e2[-1]    = e2[-1].to_i           # converting volumn
@@ -119,35 +89,20 @@ class SQA::DataFrame < Daru::DataFrame
                   headers.zip(e2).to_h
                 end
 
-      # What oldest data first in the data frame
-      normalize_vector_names Daru::DataFrame.new(data.reverse)
-    end
-
+      if from_date
+        aofh.reject!{|e| Date.parse(e['date']) < from_date}
+      end
 
-    # Append update_df rows to the base_df
-    #
-    # base_df is ascending on timestamp
-    # update_df is descending on timestamp
-    #
-    # base_df content came from CSV file downloaded
-    # from Yahoo Finance.
-    #
-    # update_df came from scraping the webpage
-    # at Yahoo Finance for the recent history.
-    #
-    # Returns a combined DataFrame.
-    #
-    def self.append(base_df, updates_df)
-      last_timestamp  = Date.parse base_df.timestamp.last
-      filtered_df     = updates_df.filter_rows { |row| Date.parse(row[:timestamp]) > last_timestamp }
+      return nil if aofh.empty?
 
-      last_inx = filtered_df.size - 1
+      # ensure tha the data frame is
+      # always sorted oldest to newest.
 
-      (0..last_inx).each do |x|
-        base_df.add_row filtered_df.row[last_inx-x]
+      if aofh.first['date'] > aofh.last['date']
+        aofh.reverse!
       end
 
-      base_df
+      SQA::DataFrame.from_aofh(aofh, mapping: HEADER_MAPPING, transformers: TRANSFORMERS)
     end
   end
 end

data/lib/sqa/data_frame/yahoo_finance.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 
-class SQA::DataFrame < Daru::DataFrame
+class SQA::DataFrame
   class YahooFinance
     CONNECTION  = Faraday.new(url: 'https://finance.yahoo.com')
     HEADERS     = [
@@ -30,21 +30,6 @@ class SQA::DataFrame < Daru::DataFrame
       }
 
     ################################################################
-    def self.load(filename, options={}, &block)
-      df = SQA::DataFrame.load(filename, options={}, &block)
-
-      headers = df.vectors
-
-      if headers.first == HEADERS.first.to_s
-        a_hash = {}
-        HEADERS.each {|k| a_hash[k.to_s] = k}
-        df.rename_vectors(a_hash)
-      else
-        df.rename_vectors(HEADER_MAPPING)
-      end
-
-      df
-    end
 
 
     # Scrape the Yahoo Finance website to get recent
@@ -62,7 +47,7 @@ class SQA::DataFrame < Daru::DataFrame
 
       rows      = table.css('tbody tr')
 
-      data = []
+      aofh = []
 
       rows.each do |row|
         cols = row.css('td').map{|c| c.children[0].text}
@@ -80,37 +65,10 @@ class SQA::DataFrame < Daru::DataFrame
         cols[0] = Date.parse(cols[0]).to_s
         cols[6] = cols[6].tr(',','').to_i
         (1..5).each {|x| cols[x] = cols[x].to_f}
-        data << HEADERS.zip(cols).to_h
-      end
-
-      Daru::DataFrame.new(data)
-    end
-
-
-    # Append update_df rows to the base_df
-    #
-    # base_df is ascending on timestamp
-    # update_df is descending on timestamp
-    #
-    # base_df content came from CSV file downloaded
-    # from Yahoo Finance.
-    #
-    # update_df came from scraping the webpage
-    # at Yahoo Finance for the recent history.
-    #
-    # Returns a combined DataFrame.
-    #
-    def self.append(base_df, updates_df)
-      last_timestamp  = Date.parse base_df.timestamp.last
-      filtered_df     = updates_df.filter_rows { |row| Date.parse(row[:timestamp]) > last_timestamp }
-
-      last_inx = filtered_df.size - 1
-
-      (0..last_inx).each do |x|
-        base_df.add_row filtered_df.row[last_inx-x]
+        aofh << HEADERS.zip(cols).to_h
       end
 
-      base_df
+      aofh
     end
   end
 end

data/lib/sqa/data_frame.rb

@@ -1,52 +1,302 @@
 # lib/sqa/data_frame.rb
 # frozen_string_literal: true
 
-require_relative  'data_frame/yahoo_finance'
-require_relative  'data_frame/alpha_vantage'
+require 'forwardable'
 
-class Daru::DataFrame
+require_relative 'data_frame/yahoo_finance'
+require_relative 'data_frame/alpha_vantage'
 
-  def to_csv(path_to_file, opts={})
-    options = {
-      headers:    true,
-      converters: :numeric
-    }.merge(opts)
+class SQA::DataFrame
+  class Data < Hashie::Mash
+    # SNELL: Are all of these needed?
+    include Hashie::Extensions::Mash::KeepOriginalKeys
+    # include Hashie::Extensions::Mash::PermissiveRespondTo
+    include Hashie::Extensions::Mash::SafeAssignment
+    include Hashie::Extensions::Mash::SymbolizeKeys
+    # include Hashie::Extensions::Mash::DefineAccessors
+  end
+
+  extend Forwardable
 
-    writer = ::CSV.open(path_to_file, 'wb')
+  # @data is of class Data
+  attr_accessor :data
+
+  # Expects a Hash of Arrays (hofa)
+  def initialize(a_hash={})
+    @data = Data.new(a_hash)
+  end
 
-    writer << vectors.to_a if options[:headers]
 
-    each_row do |row|
-      writer << if options[:convert_comma]
-                  row.map { |v| v.to_s.tr('.', ',') }
-                else
-                  row.to_a
-                end
+  def to_csv(path_to_file)
+    CSV.open(path_to_file, 'w') do |csv|
+      csv << keys
+      size.times do |x|
+        csv << row(x)
+      end
     end
+  end
+
 
-    writer.close
+  def to_json(path_to_file)
+    NotImplemented.raise
   end
-end
 
 
+  def to_aofh
+    NotImplemented.raise
+  end
 
 
-class SQA::DataFrame < Daru::DataFrame
+  def_delegator :@data, :to_h, :to_hofa
+  alias_method :to_h, :to_hofa
+
+
+  # The number of data rows
+  def size
+    data[@data.keys[0]].size
+  end
+  alias_method :nrows,  :size
+  alias_method :length, :size
+
+
+  def_delegator :@data,  :keys
+  alias_method :vectors, :keys
+  alias_method :columns, :keys
+
+
+  def ncols
+    keys.size
+  end
+
+
+  def_delegator :@data, :values, :values
+  def_delegator :@data, :[], :[]
+  def_delegator :@data, :[]=, :[]=
+
+
+  def rows
+    result = []
+    (0..size - 1).each do |x|
+      entry = row(x)
+      result << entry
+    end
+    result
+  end
+  alias_method :to_a, :rows
+
+
+  def row(x)
+    if x.is_a?(Integer)
+      raise BadParameterError if x < 0 || x >= size
+
+    elsif x.is_a?(Hash)
+      raise BadParameterError, "x is #{x}" if x.size > 1
+      key = x.keys[0]
+      x   = @data[key].index(x[key])
+      raise BadParameterError, 'Not Found #{x}' if x.nil?
+      return keys.zip(row(x)).to_h
 
-  #################################################
-  def self.load(ticker, type="csv", options={}, &block)
-    source  = SQA.data_dir + "#{ticker}.#{type}"
-
-    if :csv == type
-     from_csv(source, options={}, &block)
-    elsif :json == type
-      from_json(source, options={}, &block)
-    elsif %i[txt dat].include?(type)
-      from_plaintext(source, options={}, &block)
-    elsif :xls == type
-      from_excel(source, options={}, &block)
     else
-      raise SQA::BadParameterError, "un-supported file type: #{type}"
+      raise BadParameterError, "Unknown x.class: #{x.class}"
+    end
+
+    entry = []
+
+    keys.each do |key|
+      entry << @data[key][x]
+    end
+
+    entry
+  end
+
+
+  def append(new_df)
+    raise(BadParameterError, "Key mismatch") if keys != new_df.keys
+
+    keys.each do |key|
+      @data[key] += new_df[key]
+    end
+  end
+  alias_method :concat, :append
+
+
+  # Creates a new instance with new keys
+  # based on the mapping hash where
+  #   { old_key => new_key }
+  #
+  def rename(mapping)
+    SQA::DataFrame.new(
+      self.class.rename(
+        mapping,
+        @data.to_h
+      )
+    )
+  end
+  alias_method :rename_vectors, :rename
+
+
+  # Map the values of the vectors into different objects
+  # types is a Hash where the key is the vector name and
+  #   the value is a proc
+  #
+  # For Example:
+  # {
+  #   price: -> (v) {v.to_f.round(3)}
+  # }
+  #
+  def coerce_vectors(transformers)
+    transformers.each_pair do |key, transformer|
+      @data[key].map!{|v| transformer.call(v)}
+    end
+  end
+
+
+  def method_missing(method_name, *args, &block)
+    if @data.respond_to?(method_name)
+      self.class.send(:define_method, method_name) do |*method_args, &method_block|
+        @data.send(method_name, *method_args, &method_block)
+      end
+      send(method_name, *args, &block)
+    else
+      super
+    end
+  end
+
+
+  def respond_to_missing?(method_name, include_private = false)
+    @data.respond_to?(method_name) || super
+  end
+
+  #################################################
+  class << self
+
+    def append(base_df, other_df)
+      base_df.append(other_df)
+    end
+
+
+    # TODO: The Data class has its own load which also supports
+    #       YAML by default.  Maybe this method should
+    #       make use of @data = Data.load(source)
+    #
+    def load(source:, mapping: {}, transformers:{})
+      file_type = source.extname[1..].downcase.to_sym
+
+      df  = if :csv == file_type
+              from_csv_file(source, mapping: mapping, transformers: transformers)
+            elsif :json == file_type
+              from_json_file(source, mapping: mapping, transformers: transformers)
+            else
+              raise BadParameterError, "unsupported file type: #{file_type}"
+            end
+
+      unless transformers.empty?
+        df.coerce_vectors(transformers)
+      end
+
+      df
+    end
+
+
+    def from_aofh(aofh, mapping: {}, transformers: {})
+      new(
+        aofh_to_hofa(
+          aofh,
+          mapping: mapping,
+          transformers: transformers
+        )
+      )
+    end
+
+
+    def from_csv_file(source, mapping: {}, transformers: {})
+      aofh = []
+
+      CSV.foreach(source, headers: true) do |row|
+        aofh << row.to_h
+      end
+
+      from_aofh(aofh, mapping: mapping, transformers: transformers)
+    end
+
+
+    def from_json_file(source, mapping: {}, transformers: {})
+      aofh = JSON.parse(source.read)
+
+      from_aofh(aofh, mapping: mapping, transformers: transformers)
+    end
+
+
+    # aofh -- Array of Hashes
+    # hofa -- Hash of Arrays
+    def aofh_to_hofa(aofh, mapping: {}, transformers: {})
+      hofa = {}
+      keys = aofh.first.keys
+
+      keys.each do |key|
+        hofa[key] = []
+      end
+
+      aofh.each do |entry|
+        keys.each do |key|
+          hofa[key] << entry[key]
+        end
+      end
+
+      # SMELL: This might be necessary
+      normalize_keys(hofa, adapter_mapping: mapping)
+    end
+
+
+    def normalize_keys(hofa, adapter_mapping: {})
+      hofa    = rename(adapter_mapping, hofa)
+      mapping = generate_mapping(hofa.keys)
+      rename(mapping, hofa)
+    end
+
+
+    def rename(mapping, hofa)
+      mapping.each_pair do |old_key, new_key|
+        hofa[new_key] = hofa.delete(old_key)
+      end
+
+      hofa
+    end
+
+
+    def generate_mapping(keys)
+      mapping = {}
+
+      keys.each do |key|
+        mapping[key] = underscore_key(sanitize_key(key)) unless key.is_a?(Symbol)
+      end
+
+      mapping
+    end
+
+
+    # returns a snake_case Symbol
+    def underscore_key(key)
+      key.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase.to_sym
+    end
+
+
+    # removes punctuation and specal characters,
+    # replaces space with underscore.
+    def sanitize_key(key)
+      key.tr('.():/','').gsub(/^\d+.?\s/, "").tr(' ','_')
+    end
+
+
+    # returns true if key is in a date format
+    # like 2023-06-03
+    def is_date?(key)
+      !/(\d{4}-\d{2}-\d{2})/.match(key.to_s).nil?
     end
   end
 end
+

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

@@ -2,7 +2,13 @@
 
 module SQA
 	class << self
-		@@config = nil
+		@@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
@@ -26,12 +32,11 @@ module SQA
 
 			config.data_dir = homify(config.data_dir)
 
-			Daru.lazy_update 			= config.lazy_update
-			Daru.plotting_library = config.plotting_library
-
 			config
 		end
 
+		def av() 								= @@av
+
 		def debug?() 						= @@config.debug?
 		def verbose?() 					= @@config.verbose?
 

data/lib/sqa/stock.rb

@@ -6,83 +6,143 @@
 #         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
 
-    df1_nrows = df1.nrows
-    @df       = @klass.append(df1, df2)
 
-    if @df.nrows > df1_nrows
-      @df.send("to_#{@type}", SQA.data_dir + "#{ticker}.csv")
+  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
+
+
+
+  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
 
 
@@ -100,7 +160,7 @@ class SQA::Stock
 
       a_hash  = JSON.parse(
                   CONNECTION.get(
-                    "/query?function=TOP_GAINERS_LOSERS&apikey=#{Nenv.av_api_key}"
+                    "/query?function=TOP_GAINERS_LOSERS&apikey=#{SQA.av.key}"
                   ).to_hash[:body]
                 )
 

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,7 +1,7 @@
 # frozen_string_literal: true
 
 module SQA
-  VERSION = "0.0.15"
+  VERSION = "0.0.17"
 
   class << self
     def version

data/lib/sqa.rb

@@ -17,9 +17,9 @@ end
 ## Additional Libraries
 
 require 'active_support/core_ext/string'
-require 'alphavantage' 	# TODO: add rate limiter to it
+require 'alphavantage' 	# TODO: add rate limiter to it; ** PR submitted! **
+require 'api_key_manager'
 require 'amazing_print'
-require 'daru' 					# TODO: Replace this gem with something better
 require 'descriptive_statistics'
 require 'faraday'
 require 'hashie'
@@ -38,7 +38,6 @@ require_relative "sqa/errors"
 
 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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sqa
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.17
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-25 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'
+        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: alphavantage
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: daru
+  name: api_key_manager
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -240,8 +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
@@ -276,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
@@ -340,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:
@@ -356,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 @@
-ae291d1c8a3a80fc6f24a6a1194c6db1b6e1fbdbee586546ae34db6ee304a3e431ea59a154ea976af0f25f3b0d6519f2e0a1aad4ddf3c3cdf77b7d37aabf425f

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

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

@@ -1,55 +0,0 @@
-# lib/patches/daru/plotting/svg-graph/category.rb
-
-# NOTE: Code originally from Gruff
-# TODO: Tailor the code to SvgGraph
-
-module Daru
-  module Plotting
-    module Category
-      module SvgGraphLibrary
-        def plot opts={}
-          type = opts[:type] || :bar
-          size = opts[:size] || 500
-          case type
-          when :bar, :pie, :sidebar
-            plot = send("category_#{type}_plot".to_sym, size, opts[:method])
-          else
-            raise ArgumentError, 'This type of plot is not supported.'
-          end
-          yield plot if block_given?
-          plot
-        end
-
-        private
-
-        def category_bar_plot size, method
-          plot = SvgGraph::Bar.new size
-          method ||= :count
-          dv = frequencies(method)
-          plot.labels = size.times.to_a.zip(dv.index.to_a).to_h
-          plot.data name || :vector, dv.to_a
-          plot
-        end
-
-        def category_pie_plot size, method
-          plot = SvgGraph::Pie.new size
-          method ||= :count
-          frequencies(method).each_with_index do |data, index|
-            plot.data index, data
-          end
-          plot
-        end
-
-        def category_sidebar_plot size, method
-          plot = SvgGraph::SideBar.new size
-          plot.labels = {0 => (name.to_s || 'vector')}
-          method ||= :count
-          frequencies(method).each_with_index do |data, index|
-            plot.data index, data
-          end
-          plot
-        end
-      end
-    end
-  end
-end

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

@@ -1,105 +0,0 @@
-# lib/patches/daru/plotting/svg-graph/dataframe.rb
-
-# NOTE: Code originally from Gruff
-# TODO: Tailor the code to SvgGraph
-
-module Daru
-  module Plotting
-    module DataFrame
-      module SvgGraphLibrary
-        def plot opts={}
-          opts[:type] ||= :line
-          opts[:size] ||= 500
-
-          x     = extract_x_vector  opts[:x]
-          y     = extract_y_vectors opts[:y]
-
-          opts[:type]  = process_type opts[:type], opts[:categorized]
-
-          type = opts[:type]
-
-          if %o[line bar scatter].include? type
-            graph = send("#{type}_plot", size, x, y)
-
-          elsif :scatter_categorized == type
-            graph = scatter_with_category(size, x, y, opts[:categorized])
-
-          else
-            raise ArgumentError, 'This type of plot is not supported.'
-          end
-
-          yield graph if block_given?
-          graph
-        end
-
-        private
-
-        def process_type type, categorized
-          type == :scatter && categorized ? :scatter_categorized : type
-        end
-
-        ##########################################################
-        def line_plot size, x, y
-          plot = SvgGraph::Line.new size
-          plot.labels = size.times.to_a.zip(x).to_h
-          y.each do |vec|
-            plot.data vec.name || :vector, vec.to_a
-          end
-          plot
-        end
-
-        ##########################################################
-        def bar_plot size, x, y
-          plot = SvgGraph::Bar.new size
-          plot.labels = size.times.to_a.zip(x).to_h
-          y.each do |vec|
-            plot.data vec.name || :vector, vec.to_a
-          end
-          plot
-        end
-
-        ##########################################################
-        def scatter_plot size, x, y
-          plot = SvgGraph::Scatter.new size
-          y.each do |vec|
-            plot.data vec.name || :vector, x, vec.to_a
-          end
-          plot
-        end
-
-        ##########################################################
-        def scatter_with_category size, x, y, opts
-          x       = Daru::Vector.new x
-          y       = y.first
-          plot    = SvgGraph::Scatter.new size
-          cat_dv  = self[opts[:by]]
-
-          cat_dv.categories.each do |cat|
-            bools = cat_dv.eq cat
-            plot.data cat, x.where(bools).to_a, y.where(bools).to_a
-          end
-
-          plot
-        end
-
-        def extract_x_vector x_name
-          x_name && self[x_name].to_a || index.to_a
-        end
-
-        def extract_y_vectors y_names
-          y_names =
-            case y_names
-            when nil
-              vectors.to_a
-            when Array
-              y_names
-            else
-              [y_names]
-            end
-
-          y_names.map { |y| self[y] }.select(&:numeric?)
-        end
-      end
-    end
-  end
-end

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

@@ -1,102 +0,0 @@
-# lib/patches/daru/plotting/svg-graph/vector.rb
-
-# NOTE: Code originally from Gruff
-# TODO: Tailor the code to SvgGraph
-
-module Daru
-  module Plotting
-    module Vector
-      module SvgGraphLibrary
-        def plot opts={}
-          opts[:type]   ||= :line
-          opts[:size]   ||= 500   # SMELL: What is this?
-          opts[:height] ||= 720
-          opts[:width]  ||= 720
-          opts[:title]  ||= name || :vector
-
-          debug_me{[
-            :opts,
-            :self
-          ]}
-
-          if %i[line bar pie scatter sidebar].include? type
-            graph = send("#{type}_plot", opts)
-          else
-            raise ArgumentError, 'This type of plot is not supported.'
-          end
-
-          yield graph if block_given?
-
-          graph
-        end
-
-        private
-
-        ####################################################
-        def line_plot opts={}
-          graph  = SVG::Graph::Line.new opts
-
-          graph.add_data(
-            data:   to_a,
-            title:  opts[:title]
-          )
-
-          graph
-        end
-
-
-        ####################################################
-        def bar_plot opts
-          graph  = SVG::Graph::Bar.new opts
-
-          graph.add_data(
-            data:   to_a,
-            title:  opts[:title]
-          )
-
-          graph
-        end
-
-
-        ####################################################
-        def pie_plot opts
-          graph  = SVG::Graph::Pie.new opts
-
-          graph.add_data(
-            data:   to_a,
-            title:  opts[:title]
-          )
-
-          graph
-        end
-
-
-        ####################################################
-        def scatter_plot size
-          graph  = SVG::Graph::Plot.new opts
-
-
-          graph.add_data(
-            data:   to_a.zip(index.to_a)
-            title:  opts[:title]
-          )
-
-          graph
-        end
-
-
-        ####################################################
-        def sidebar_plot size
-          graph  = SVG::Graph::BarHorizontal.new opts
-
-          graph.add_data(
-            data:   to_a,
-            title:  opts[:title]
-          )
-
-          graph
-        end
-      end
-    end
-  end
-end

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

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

data/lib/patches/daru/vector.rb

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

data/lib/patches/daru.rb

@@ -1,19 +0,0 @@
-# lib/patches/daru.rb
-
-require_relative 'daru/category'
-require_relative 'daru/data_frame'
-require_relative 'daru/vector'
-
-module Daru
-	create_has_library :svg_graph
-
-  class << self
-		def plotting_library lib
-			if :svg_graph = lib
-				@plotting_library = lib
-			else
-				super
-			end
-		end
-	end
-end