sqa 0.0.19 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8dd5577340edd8f74a73428779129e4f97bcfbb4b8eaa23ce02c6b1f290baa4
-  data.tar.gz: fa03b7e2203edbb69da04b9ff022776a6932a481e33a7290e4ff46b573375a89
+  metadata.gz: 90a60fb96ea11073c750a7e0b36d8a2d8283bbfeff8322907617794b7111502e
+  data.tar.gz: dbfa9486131b8b39016b46b9ef6188bdfefc279d8a5adc7a79b6c23f1ad1779b
 SHA512:
-  metadata.gz: ca34483321c0ac6391d322acef9ed2a9ba5d1e87db15201d4c89f760346e1c620b1ce5182cf203c393b118703a743bf535f84e52f099bad12445eacc1b82d39b
-  data.tar.gz: 89cb9767f3febdc9e20970e0d73a679f378f75260b4e6b146bd413dc49d942200a60f03c2ecb7f02ae6e87662ece5744fa45aead39d147fa7aad81d2037128fc
+  metadata.gz: 975de4af9b0c063a66b8a2292b99c18859d30d49ab6b7fab82416916a1cbf3685b4c9e5f56ea5e1cbe635ac5e9fb67aacf2432ec95ef74f541da9a0edf1e6c61
+  data.tar.gz: cf25850a673a96bf60fe40cac0ca488a670c8ba8eb489e7c4502beb3b53bc60d1c716a22c4f5c78ceffd66e6ac92323e13b8278988fa3ffd0e4d26554249b908

data/.config/tocer/configuration.yml

@@ -0,0 +1,4 @@
+label: "## Table of Contents"
+patterns:
+  - "docs/terms_of_use.md"
+root_dir: "."

data/README.md

@@ -6,7 +6,7 @@ The BUY/SELL signals that it generates should not be taken seriously.  **DO NOT
 
 ## This is a Work in Progress
 
-I am experimenting with different gems to support various functionality.  Sometimes they do not work out well.  For example I've gone through two different gems to implement the data frame capability.  Neither did what I wanted so I ended up creating my own data frame class based upon the old tried and true Hashie library.
+I am experimenting with different gems to support various functionality.  Sometimes they do not work out well.  For example I've gone through two different gems to implement the data frame capability.  Neither did what I wanted so I ended up creating my own data frame class based upon the old tried and true [Hashie](https://github.com/intridea/hashie) library.
 
 
 ## Installation
@@ -21,7 +21,14 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ### Semantic Versioning
 
+`sqa` uses the [sem_version](https://github.com/canton7/sem_version) gem to provide a semantic version object.  Sure its old; but, so am I.  Doesn't mean we can't do the job.
+
 ```ruby
+# On the command line:
+sqa --version
+
+# or inside your program:
+
 SQA.version # returns SemVersion object
 exit(1) unless SQA.version >= SemVersion("1.0.0")
 ```
@@ -77,6 +84,9 @@ sqa --data-dir ~/Documents/sqa_data --dump-config ~/.sqa.yml
 
 By default `SQA` looks for a configuration file named `.sqa.yml` in the current directory.  If it does not find one there it looks in the home directory.  You can use the `--config` CLI option to specify a path to your custom config file name.
 
+You can have multiple configurations and multiple data directories.
+
+You can also have one data directory and multiple portfolio and trades files within that single directory.
 
 ### AlphaVantage
 
@@ -84,6 +94,20 @@ By default `SQA` looks for a configuration file named `.sqa.yml` in the current
 
 [https://www.alphavantage.co/](https://www.alphavantage.co/)
 
+Put your API key in the system environment variable `AV_API_KEY`
+
+TODO why is it not part of the configuration?  ought to be.
+
+
+### TradingView
+
+**Not currently implemented** but seriously considering using [TradingView](http://tradingview.com) capabilities.  If I do choose to use these capabilities you will need your own API key or account or something.
+
+Put your API key in the system environment variable `TV_API_KEY`
+
+TODO why is it not part of the configuration?  ought to be.
+
+I kinda like their Terms of Use.  I've started crafting an [SQA Terms of Use](docs/terms_of_use.md) document based on theirs.  I specifically like sections 7 and 8.
 
 ## Playing in IRB
 
@@ -98,11 +122,11 @@ Historical price data is kept in the `SQA.data_dir` in a CSV file whose name is
 
 #### Get Historical Prices
 
-Go to https::/finance.yahoo.com and down some historical price data for your favorite stocks.  Put those CSV files into the `SQA.data_dir`.
+Go to [https::/finance.yahoo.com](https::/finance.yahoo.com) and down some historical price data for your favorite stocks.  Put those CSV files into the `SQA.data_dir`.
 
 You may need to create a `portfolio.csv` file or you may not.  TODO
 
-The CSV files will be named by the stock's ticker symbol.  For example: `aapl.csv`
+The CSV files will be named by the stock's ticker symbol as lower case.  For example: `aapl.csv`
 
 ### Playing in the IRB - Setup
 
@@ -113,6 +137,9 @@ require 'sqa/cli'
 # You can pass a set of CLI options in a String
 SQA.init "-c ~/.sqa.yml"
 
+# If you have an API key for AlphaVantage you can create a new
+# CSV file, or update an existing one.  Your key MUST be
+# in the system environment variable AV_API_KEY
 aapl = SQA::Stock.new(ticker: 'aapl', source: :alpha_vantage)
 #=> aapl with 1207 data points from 2019-01-02 to 2023-10-17
 ```
@@ -229,7 +256,7 @@ ss.add SQA::Strategy::RSI
 
 # This is an Array with each "trade" method
 # that is defined in each strategy added
-ap ss.strategies
+ap ss.strategies #=>∑
 [
     [0] SQA::Strategy::Random#trade(vector),
     [1] SQA::Strategy::RSI#trade(vector)

data/Rakefile

@@ -1,5 +1,17 @@
 # frozen_string_literal: true
 
+
+
+begin
+  require "tocer/rake/register"
+rescue LoadError => error
+  puts error.message
+end
+
+Tocer::Rake::Register.call
+
+
+
 require "bundler/gem_tasks"
 require "minitest/test_task"
 

data/checksums/sqa-0.0.20.gem.sha512

@@ -0,0 +1 @@
+800bf4a6582451931c1d3aa75ca783fc8d9a12cb473d14d9b383b65b59207e44fe9ece2936ecd05d3b72d5a26861e75b8276b2f916fbf4b0532477d0d8262208

data/checksums/sqa-0.0.21.gem.sha512

@@ -0,0 +1 @@
+bd37c208c9c593043ac51fd79e3cf45eac2d432109b13773af13a534b833bbe5277002f03567d2659bc70150593f084db025d8cd08bed3f803db4db7809e7128

data/docs/README.md

@@ -1,33 +1,43 @@
-# Indicators
+# README.md
 
-An indicator is a formula/metric on a stock's historical activity.  It is presumed to be a forecast as to what the stock activity might be in the future.  A single indicator is not necessarily an accurate predictor of future events not is any specific group of indicators.
+"Playing the market" has always felt like "playing roulette" at the casino - "you pays your money and you takes your chances".  Some players are winners.  Some are losers.  But **the House Always Wins.**
 
-In other words the future is uncertain.  Is it a coin flip?  Heads the stock's price goes up.  Tails, the stock's price goes down.  Its one or the other right?  What if the price never changes.  Then its not a coin flip.  Also what is the time frame involved in the forecast?  Is it tomorrow, next week, next month, next year, next decade?  What is the delta change in price that can be expected?
+Before computers, swings in the market were caused by people.  These days I believe that computers have more to do with it than public trader sentiment.  One computer program can start a cascade of other computer programs selling or buying in a digital frenzy of trading chaos.
 
-So indicators are like TV weather forecastors.  Sometimes they are right.  Sometimes they are wrong.
+There are supposed to be tripwires in the system that protect against such things.
 
-We are dealing with uncertainity.  In uncertainity there is chaos. If it is possible to be right more times that you are wrong you can make money.  If you are always wrong then always do the opposite and you will make money.  When you are wrong more times than you are right.... you loose.
+## Recent Computer-caused Chaos
 
-Its a game.  Game theory tells us that there are winners and losers. Bookies at the track make money every day by taking a cut of the losers loses before giving them to the winners.  Bookies always win so long as they keep their books balanced.  Accounts are important.
+I asked my AI assistant "do you know of any times when computer programs caused trading chaos in the stock market?"
 
-Back to indicators.  Here is a list of the current indicators:
+Yes, there have been several instances in history when computer programs have contributed to chaos in the stock market. Here are a few notable examples:
 
+1. **Flash Crash, 2010:** On May 6, 2010, U.S. financial markets experienced a brief, severe, and rapidly-reversed drop in stock prices. The Dow Jones Industrial Average plunged by over 1,000 points in a matter of minutes, only to recover just as quickly. This event is known as the "Flash Crash". The crash was primarily blamed on high-frequency trading algorithms - computer programs that execute trades at incredibly high speeds.
 
+2. **Knight Capital Group Incident, 2012:** On August 1, 2012, the company Knight Capital Group experienced a major malfunction in its automated trading software. The software executed trades worth $7 billion in about half an hour, causing Knight Capital's stock price to collapse and leading to a $440 million loss for the company.
 
-* [Average True Range](average true range.md)
-* [Bollinger Bands](bollinger bands.md)
-* [Vandlestick Pattern Recognizer](candlestick pattern recognizer.md)
-* [Vlassify Market Profile](classify market profile.md)
-* [Donchian Channel](donchian channel.md)
-* [Double Top Bottom Pattern](double top bottom pattern.md)
-* [EMA Analysis](ema analysis.md)
-* [Fibonacci Retracement](fibonacci retracement.md)
-* [Head and Shoulders Pattern](head and shoulders pattern.md)
-* [Identify Wave Condition](identify wave condition.md)
-* [MACD](macd.md)
-* [Mean Reversion](mean reversion.md)
-* [Momentum](momentum.md)
-* [RSI](rsi.md)
-* [Simple Moving Average](simple moving average.md)
-* [Stochastic Oscillator](stochastic oscillator.md)
-* [True Range](true range.md)
+3. **Facebook's IPO, 2012:** During the initial public offering of Facebook on May 18, 2012, the stock exchange NASDAQ experienced significant technical problems. The defective technology running NASDAQ’s trading software resulted in a delay of the start of trading and confusion over individual share orders, leading to a chaotic and disorderly start to Facebook's life as a public company.
+
+4. **Swiss Franc Surge, 2015:** On January 15, 2015, the Swiss franc surged nearly 30% in a matter of minutes after the Swiss National Bank unexpectedly abolished a cap on the franc's value against the euro. Many automated trading systems were not equipped to handle this abrupt change, resulting in massive losses for many traders and companies.
+
+These events highlight the importance of careful design and rigorous testing for trading algorithms and software systems. They also demonstrate the potential for extreme market volatility in the face of unforeseen software failures or unexpected economic events.
+
+## How to be a Winner
+
+**Knowledge is King** at the casino when playing blackjack, if you can count the cards without getting caught and killed, you can gain a very small advantage over the house.  I was once given the advice to never trade a company that I did not know inside and out or in an industry in which I had no expertise.  Basically the more you know about a company the better your chances of making a beneficial trade.  I guess the extreme of that is being an insider; but there are laws against that right?  Or is it like blackjack and you should just not get caught?
+
+Is it possible to "beat the system?"  Lots of people have become wealthy selling books or services that purport to teach you how.  They all contain the same or similar disclaimers:
+
+> Decisions to buy, sell, hold or trade in securities, commodities and other investments involve risk and are best made based on the advice of qualified financial professionals. Any trading in securities or other investments involves a risk of substantial losses.
+>
+> Before undertaking any trading program, you should consult a qualified financial professional. Please consider carefully whether such trading is suitable for you in light of your financial condition and ability to bear financial risks. **Under no circumstances shall we be liable** for any loss or damage you or anyone else incurs as a result of any trading or investment activity that you or anyone else engages in based on any information or material you receive through us or our services.
+
+Here's my favorite:
+
+> Hypothetical performance results have many inherent limitations. No representation is being made that any account will or is likely to achieve profits or losses similar to those shown. In fact, there are frequently sharp differences between hypothetical performance results and actual results subsequently achieved by any particular trading program.
+>
+> One of the limitations of hypothetical performance results is that they are generally prepared with the benefit of hindsight. In addition, hypothetical trading does not involve financial risk and no hypothetical trading record can completely account for the impact of financial risk in actual trading. For example the ability to withstand losses or to adhere to a particular trading program in spite of the trading losses are material points, which can also adversely affect trading results. There are numerous other factors related to the market in general or to the implementation of any specific trading program which cannot be fully accounted for in the preparation of hypothetical performance results and all of which can adversely affect actual trading results.
+
+So it other words "you pays your money and you takes your chances."
+
+**The House Always Wins**

data/docs/indicators.md

@@ -0,0 +1,33 @@
+# Indicators
+
+An indicator is a formula/metric on a stock's historical activity.  It is presumed to be a forecast as to what the stock activity might be in the future.  A single indicator is not necessarily an accurate predictor of future events not is any specific group of indicators.
+
+In other words the future is uncertain.  Is it a coin flip?  Heads the stock's price goes up.  Tails, the stock's price goes down.  Its one or the other right?  What if the price never changes.  Then its not a coin flip.  Also what is the time frame involved in the forecast?  Is it tomorrow, next week, next month, next year, next decade?  What is the delta change in price that can be expected?
+
+So indicators are like TV weather forecastors.  Sometimes they are right.  Sometimes they are wrong.
+
+We are dealing with uncertainity.  In uncertainity there is chaos. If it is possible to be right more times that you are wrong you can make money.  If you are always wrong then always do the opposite and you will make money.  When you are wrong more times than you are right.... you loose.
+
+Its a game.  Game theory tells us that there are winners and losers. Bookies at the track make money every day by taking a cut of the losers loses before giving them to the winners.  Bookies always win so long as they keep their books balanced.  Accounts are important.
+
+Back to indicators.  Here is a list of the current indicators:
+
+
+
+* [Average True Range](average true range.md)
+* [Bollinger Bands](bollinger bands.md)
+* [Vandlestick Pattern Recognizer](candlestick pattern recognizer.md)
+* [Vlassify Market Profile](classify market profile.md)
+* [Donchian Channel](donchian channel.md)
+* [Double Top Bottom Pattern](double top bottom pattern.md)
+* [EMA Analysis](ema analysis.md)
+* [Fibonacci Retracement](fibonacci retracement.md)
+* [Head and Shoulders Pattern](head and shoulders pattern.md)
+* [Identify Wave Condition](identify wave condition.md)
+* [MACD](macd.md)
+* [Mean Reversion](mean reversion.md)
+* [Momentum](momentum.md)
+* [RSI](rsi.md)
+* [Simple Moving Average](simple moving average.md)
+* [Stochastic Oscillator](stochastic oscillator.md)
+* [True Range](true range.md)

data/docs/terms_of_use.md

@@ -0,0 +1,233 @@
+# Terms of Use, Policies and Disclaimers
+
+**Some sections of these Terms of Use are aspirational.  If found to be so, they shall not invalidate any other section which shall remain in full force.**
+
+Your affirmative act of using our Ruby Gem ("library") located at https://github.com/MadBomber/sqa (and all associated sites) or services ("SQA") signifies that you agree to the following terms and conditions of use ("Terms of Use"). If you do not agree, do not use SQA. SQA is the property of its author ("us", "we" or "our").
+
+**SQA may update these Terms of Use at any time**
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+## Table of Contents
+
+  - [1. Changes to the terms of use](#1-changes-to-the-terms-of-use)
+  - [2. Changes to SQA](#2-changes-to-sqa)
+  - [3. Ownership of information; License to use SQA; redistribution of data](#3-ownership-of-information-license-to-use-sqa-redistribution-of-data)
+  - [4. Attribution](#4-attribution)
+  - [5. Third party sites and advertisers](#5-third-party-sites-and-advertisers)
+  - [6. Disclaimer regarding content](#6-disclaimer-regarding-content)
+  - [7. Disclaimer regarding investment decisions and trading](#7-disclaimer-regarding-investment-decisions-and-trading)
+  - [8. Disclaimer regarding hypothetical performance results](#8-disclaimer-regarding-hypothetical-performance-results)
+  - [9. Registered users](#9-registered-users)
+  - [10. Non-Professional subscriber status](#10-non-professional-subscriber-status)
+  - [11. Derived Data](#11-derived-data)
+  - [12. Access and security](#12-access-and-security)
+  - [13. Payment and cancellation of service](#13-payment-and-cancellation-of-service)
+  - [14. Apple App Store subscriptions](#14-apple-app-store-subscriptions)
+  - [15. Android app subscriptions](#15-android-app-subscriptions)
+  - [16. Feedback to SQA](#16-feedback-to-sqa)
+  - [17. Indemnity](#17-indemnity)
+  - [18. Termination](#18-termination)
+  - [19. Emails](#19-emails)
+  - [20. House rules](#20-house-rules)
+  - [21. Third Party Software](#21-third-party-software)
+  - [22. Scripts](#22-scripts)
+  - [23. Publications - No Recommendation or Advice Status](#23-publications---no-recommendation-or-advice-status)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+## 1. Changes to the terms of use
+
+We may change these Terms of Use at any time. If you continue to use SQA after we post changes to these Terms of Use, you are signifying your acceptance of the new terms. You will always have access to our Terms of Use and will be able to check it at any time. By reloading [this page](https://github.com/MadBomber/sqa/blob/main/docs/terms_of_use.md), you will have the most up-to-date version available to SQA users.
+
+## 2. Changes to SQA
+
+We may discontinue or change any service or feature of SQA at any time without notice. We do not guarantee backward compatibility of our services and Application Programming Interface (API) in this case.
+
+## 3. Ownership of information; License to use SQA; redistribution of data
+
+Unless otherwise noted, all rights, titles, and interests in SQA, and all information made available through SQA or our services, in all languages, formats, and media throughout the world, including, but not limited to, all copyrights and trademarks therein, are the exclusive property of SQA, our affiliates or our Data Providers, as defined in section 6 (disclaimer regarding content) below.
+
+The content on the SQA platform, including market data and other information, is made available for display purposes only within the website's or mobile app's user interface. Our licensing arrangements with Data Providers do not permit the downloading, sublicensing, assigning, transferring, selling, loaning, or distribution of SQA content for payment without obtaining prior written consent from SQA. Users are required to respect these terms, as they are designed to protect the interests of SQA, its data providers, and its user community, ensuring a secure and reliable platform for all.
+
+Breaching these requirements may result in serious consequences, including the blocking of the user or visitor, termination of their account, and potential penalties. SQA also reserves the right to take appropriate legal actions against users found to be in violation of these terms, in order to protect the platform's integrity and the interests of its data providers and user community.
+
+Except as otherwise expressly permitted by the preceding paragraphs, you agree not to sell any of the services or materials in any manner or for any purposes, without the prior expressed written consent of SQA and/or our Data Providers. In addition, you shall not, without the prior expressed written consent of SQA and the relevant Data Providers, make copies of any of the software or documentation that may be provided, electronically or otherwise, including, but not limited to, translating, decompiling, disassembling or creating derivative works.
+
+Except as otherwise expressly permitted by additional agreement, we do not permit commercial usage of any of our services or APIs. We make no warranty and assume no obligation or liability for third party services or software. Please see section 21 (third party software) below for further information.
+
+For additional information on commercial and partnership inquiries with us, please see the Contacts page.
+
+## 4. Attribution
+
+SQA grants all users of SQA, and all other available versions of the site, to use snapshots of SQA charts in analysis, press releases, books, articles, blog posts and other publications. In addition, SQA grants the use of all previously mentioned materials in education sessions, the display of SQA charts during video broadcasts, which includes overviews, news, analytics and otherwise use or promote SQA charts or any products from the SQA website on the condition that SQA attribution is clearly visible at all times when such charts and products are used.
+
+Attribution must include a reference to SQA, including, but not limited to, those described herein.
+
+Use of SQA charts during video or other promotions where SQA attribution is not visible, must include a description of the product used therein. For instance: "Charting platform used for this analysis is provided by SQA," or simply "Charts by SQA." Font size should not be less than 10 PT = 13PX = 3.4MM.
+
+You can use the "Snapshot" button in the top toolbar of the chart to instantly create a picture file of your current chart. SQA will automatically take a snapshot with all required attributions and provide a link where you can view your chart, download it or share it. The use of any SQA products outside the SQA website, without a proper attribution of SQA, is not allowed. This extends to any tools (such as widgets) obtained on the SQA website and utilized on the outside resources, where attribution should remain as was originally designed and intended. Users who disobey this attribution rule herein may be banned permanently, and other legal actions may be taken to ensure compliance. This includes, but is not limited to, cease-and-desist warnings, court orders, injunctions, fines, damages relief, and so on.
+
+## 5. Third party sites and advertisers
+
+SQA may include links to third party websites. Some of these sites may contain materials that are objectionable, unlawful, or inaccurate. You agree that SQA shall not be held liable for any trading activities or other activities that occur on any website you access through links on SQA. We provide these links as a convenience, and do not endorse the content or services offered by these other sites. Any dealings that you have with advertisers found on SQA are between you and the advertiser and you acknowledge and agree that we are not liable for any loss or claim you may have against an advertiser.
+
+Unauthorized soliciting on SQA is strictly prohibited and may result in penalties, including, but not limited to, temporary or permanent bans of the account found in violation, and any appropriate and available legal action for monetary and other damages.
+
+## 6. Disclaimer regarding content
+
+SQA cannot and does not represent or guarantee that any of the information available through our services or in SQA is accurate, reliable, current, complete or appropriate for your needs. Various information available through our services or on SQA may be specially obtained by SQA from professional businesses or organizations, such as exchanges, news providers, market data providers and other content providers (e.g. Cboe One and possibly other established financial exchanges such as the New York Stock Exchange, NASDAQ, New York Mercantile Exchange and Dow Jones), who are believed to be sources of reliable information (collectively, the "Data Providers"). Nevertheless, due to various factors — including the inherent possibility of human and mechanical error — the accuracy, completeness, timeliness, results obtained from use, and correct sequencing of information available through our services and website are not and cannot be guaranteed by SQA. We make no warranty and assume no obligation or liability for scripts, indicators, ideas and other content of third parties. Your use of any third-party scripts, indicators, ideas and other content is at your sole risk.
+
+## 7. Disclaimer regarding investment decisions and trading
+
+Decisions to buy, sell, hold or trade in securities, commodities and other investments involve risk and are best made based on the advice of qualified financial professionals. Any trading in securities or other investments involves a risk of substantial losses. The practice of "Day Trading" involves particularly high risks and can cause you to lose substantial sums of money. Before undertaking any trading program, you should consult a qualified financial professional. Please consider carefully whether such trading is suitable for you in light of your financial condition and ability to bear financial risks. Under no circumstances shall we be liable for any loss or damage you or anyone else incurs as a result of any trading or investment activity that you or anyone else engages in based on any information or material you receive through SQA or our services.
+
+## 8. Disclaimer regarding hypothetical performance results
+
+Hypothetical performance results have many inherent limitations, some of which are mentioned below. No representation is being made that any account will or is likely to achieve profits or losses similar to those shown. In fact, there are frequently sharp differences between hypothetical performance results and actual results subsequently achieved by any particular trading program.
+
+One of the limitations of hypothetical performance results is that they are generally prepared with the benefit of hindsight. In addition, hypothetical trading does not involve financial risk and no hypothetical trading record can completely account for the impact of financial risk in actual trading. For example the ability to withstand losses or to adhere to a particular trading program in spite of the trading losses are material points, which can also adversely affect trading results. There are numerous other factors related to the market in general or to the implementation of any specific trading program which cannot be fully accounted for in the preparation of hypothetical performance results and all of which can adversely affect actual trading results.
+
+## 9. Registered users
+
+Certain services, such as saving charts, publishing them or the ability to comment on published charts, are available only to registered users of the SQA website and require you to sign in with a username and password to use them. If you register as a user (a "Subscriber") of any of the features of SQA, during the registration process you may be prompted to click "Register Now", "Submit" or a similar button; your clicking on such button will further confirm your agreement to be legally bound by these Terms of Use.
+
+In consideration of your use of SQA, you represent that you are of legal age to form a binding contract and are not a person barred from receiving SQA services under the laws of the United States or other applicable jurisdiction. You also agree to: (a) provide true, accurate, current and complete information about yourself as prompted by the SQA's registration form (the "Registration Data") and (b) maintain and promptly update the Registration Data to keep it true, accurate, current and complete. If you provide any information that is untrue, inaccurate, not current or incomplete, or SQA has reasonable grounds to suspect that such information is untrue, inaccurate, not current or incomplete, SQA has the right to suspend or terminate your account and refuse any and all current or future use of the SQA services (or any portion thereof).
+
+You represent and warrant that you have all intellectual property rights, including all necessary patent, trademark, trade secret, copyright or other proprietary rights, in and to your content. If you use third-party materials, you represent and warrant that you have the right to distribute third-party material in the content. You agree that you will not submit material that is copyrighted, protected by trade secret or otherwise subject to third party proprietary rights, including patent, privacy and publicity rights, unless you are the owner of such rights or have permission from their rightful owner to submit the material.
+
+We may remove your content without notice if we reasonably believe that you're in violation of our Terms of Use.
+
+## 10. Non-Professional subscriber status
+
+As a vendor of official real-time market data from exchanges (e.g. Nasdaq) for end users, we are required to identify the status of any Subscriber. If you are ordering a subscription for market data on SQA as the 'Non-Professional', you confirm the following:
+
+* You use market data solely for personal use, not for your business or any other entity.
+* You are not registered or qualified with the Securities Exchange Commission (SEC) or the Commodities Futures Trading Commission (CFTC).
+* You are not registered or qualified with any securities agency, any securities exchange, association or regulatory body in any country.
+* You do not perform any functions that are similar to those that require an individual to register or qualify with the SEC, the CFTC, any other securities agency, any securities exchange, or association or regulatory body, or any commodities or futures contract market, or association or regulatory body.
+* You are not engaged as an investment advisor (as that term is defined in Section 202 (a) (11) of the Investment Advisor's Act of 1940) or asset manager and you are not engaged to provide investment advice to any individual or entity.
+* You are not subscribing to the service in your capacity as a principal, officer, partner, employee, or agent of any business or on behalf of any other individual.
+* You use your own capital, not provided by any other individual or entity in the conduct of your trading.
+* You do not conduct trading for the benefit of a corporation, partnership, or other entity.
+* You have not entered into any agreement to share the profit of your trading activities or receive compensation for your trading activities.
+* You are not receiving office space, and equipment or other benefits in exchange for your trading or work as a financial consultant to any person, firm or business entity.
+
+Should we, or our exchange partners, determine — based on the information provided and / or companies websites, email address and domain, LinkedIn, regulatory or company registries, payment method — that you actually meet the criteria for a 'Professional' status at any point during or after subscribing to SQA or to market data from exchanges, you will be liable for the difference between the 'Non-Professional' and 'Professional' subscription rates for both SQA subscription and relevant market data. This applies retroactively from the date you initiated your subscription. Furthermore, we reserve the right to automatically invoice you for this difference and charge the associated amount to your on-file payment method.
+
+## 11. Derived Data
+
+Our proprietary derivation consumes raw market data and executes a 2-factor derivation process to produce the displayed price, later consumed by the price engine. Derived market data is sourced and supplied from various sources and can therefore be blended.
+
+The derivation process involves changing the raw price by a factor determined by the volume of trading on the underlying market, a randomized variable and a maximum offset amount. The derived data price is only ever displayed to our non-professional clients, the derived data price then being the proprietary value of an organization.
+
+At no point is raw data accessible by any client, nor can said data be reverse-engineered in any manner. All markets are passed through the same derivation engine.
+
+## 12. Access and security
+
+You accept responsibility for the confidentiality and use of any username and email address that use to register for your access to and use of our services. You are responsible for maintaining the confidentiality of your password and account and are fully responsible for all activities that occur under your password or account. You agree to (a) immediately notify SQA of any unauthorized use of your password or account or any other breach of security, and (b) ensure that you exit from your account at the end of each session. SQA cannot and will not be liable for any loss or damage arising from your failure to comply.
+
+SQA considers private information on the site (source code of protected or invite-only scripts, etc.) to be confidential to you. SQA protects such private information from unauthorized use, access, or disclosure in the same manner that it protects personal data (please refer to our Privacy Policy for more information).
+
+## 13. Payment and cancellation of service
+
+By ordering any subscription on www.SQA.com (including a free trial period) you confirm that you have read and accepted our Terms of Use and you authorize SQA to automatically charge your bank card or PayPal account according to the billing period manually selected by you.
+
+Each user can try selected paid plans for 30 days free of charge. If the trial is not cancelled before its expiration date, it automatically converts to a monthly or annual paid plan depending on user’s choice. There are no refunds for monthly plans, even if the subscription is canceled on the same day as the autoconversion payment has gone through. Refunds are available only after an automatic deduction for annual payments (i.e. after trial and after renewal) within 14 calendar days after the payment was made. Please note that users who filed a chargeback/dispute request or a claim are not eligible for a refund. Essential, Plus and Premium subscriptions automatically include market data that is available without additional per-user fees only. You can see which markets are available for free and which need to be purchased separately on the SQA GoPro page. A cancelled trial and associated services will stop immediately after cancellation, except for any data packages that were purchased.
+
+The service is billed in advance on a monthly, annual, or 2-year basis. There will be no refunds or credits for partial months of service, or refunds for months unused with an open user account. If auto renewal fails for an annual plan you will automatically be switched to a monthly plan.
+
+All billing is recurring, which means you will continue to get billed until you cancel your subscription. You are solely responsible for properly canceling your SQA subscription. An email request or support ticket asking for your subscription to be cancelled is not considered cancellation. You may cancel your subscription at any time by visiting the billing section of your Profile Settings page.
+
+If you cancel the service before the end of your current paid up period, your subscription will remain active until the next due date. After the due date, if no payment received, your subscription will be stopped.
+We do not offer refunds for initial payments. If you order the service for the first time, please make sure that the order is correct before the payment is made.
+
+We do not offer refunds for recurring monthly payments. If you have been billed for automatic monthly renewal of the Service, you can cancel the subscription to avoid billing for next months.
+
+We do not offer refunds for upgrades to a more expensive plan or a longer billing cycle. Remaining days are converted into an equivalent value of days on the new subscription.
+
+We offer refunds for recurring annual and 2-year payments on demand. If you have been billed for automatic annual and 2-year renewal of the service, you have 14 calendar days (after the payment was made) to contact our support team. If you don't do this, SQA assumes that renewal of the service is expected and the payment will not be refunded.
+
+Refunds are available only after an automatic deduction for annual payments (i.e. after trial and after renewal) within 14 calendar days after the payment was made.
+Our moderators are official SQA representatives, with the authority to warn or ban users (including those with a paid subscription) when they do not abide by the House Rules. We do not offer refunds in case you are banned from publishing content and interacting with others because your paid subscription and all of its data and/or features are still available during any such ban.
+
+SQA is registered for tax purposes in Australia, Canada, Colombia, EU states, Japan, India, Indonesia, Iceland, Liechtenstein, Malaysia, Mexico, New Zealand, Norway, Saudi Arabia, Singapore, South Africa, South Korea, Switzerland, Taiwan, Thailand, Turkey, United Arab Emirates, United Kingdom, Vietnam, certain US states and cities.
+
+SQA may use local subsidiaries or other entities to collect payments in certain geographies. However, all payments will be processed and managed by SQA, and the service will be provided by SQA, Inc., regardless of which entity collects the payment.
+
+## 14. Apple App Store subscriptions
+
+Payments will be charged to the user's Apple ID Account at confirmation of purchase in compliance with Apple's privacy policy. We recommend that you familiarize yourself with the terms of payment and Apple in-app subscriptions. If a purchase is made from our iOS app, the refund is only possible in compliance with the App Store policy.
+
+SQA offers a trial period. It is only possible to use the trial period once. Subscription payment begins after the end of your free trial period.
+
+All subscription types are renewed automatically. You can cancel the renewal option in the App Store within at least 24 hours before the end of your free trial period or the current payment date. The cancellation comes into effect at the end of the current billing period. At the same time, you retain access to the subscription from the cancellation moment until the end of the current billing period.
+
+Accounts may be charged for renewal up to 24 hours before the end of the current period.
+
+Rates offered in mobile stores and on the web-based platform might differ. Mobile stores offer subscriptions based on two billing cycles: annual and monthly.
+
+## 15. Android app subscriptions
+
+Financial transactions for subscriptions made in our Android app processed by a third-party service (Google Play) in compliance with their terms of use, privacy policy and any applicable payment terms, in particular the response on Google Play refunds. SQA is not responsible for the actions or omissions of any third-party payment processor. We recommend that you familiarize yourself with the terms of payment and Google Play in-app subscriptions. If a purchase is made from our Android app, the refund is only possible in compliance with Google Play policy.
+
+SQA offers a trial period. It is only possible to use the trial period once. Subscription payment begins after the end of your free trial period.
+All subscription types are renewed automatically. You can cancel the renewal option in Google Play within at least 24 hours before the end of your free trial period or the current payment date. The cancellation comes into effect at the end of the current billing period. At the same time, you retain access to the subscription from the cancellation moment until the end of the current billing period.
+
+The payment is made according to the payment method that is linked to the user's account in Google Play. The subscription is made according to Google Play Account choice, which does not necessarily conform with the Google Account used to log in to the application.
+
+Rates offered in mobile stores and on the web-based platform might differ. Mobile stores offer subscriptions based on two billing cycles: annual and monthly.
+
+## 16. Feedback to SQA
+
+By submitting ideas, content, suggestions, documents, and/or proposals ("Contributions") to SQA through our contact or feedback processes, you acknowledge and agree that: (a) your Contributions do not contain confidential or proprietary information; (b) SQA is not under any obligation of confidentiality, expressed or implied, with respect to the Contributions; (c) SQA shall be entitled to use or disclose (or choose not to use or disclose) such Contributions for any purpose, in any way, in any media worldwide; (d) SQA may have something similar to the Contributions already under consideration or in development; (e) your Contributions automatically become the property of SQA, without any obligation of SQA to you; and (f) you are not entitled to any compensation or reimbursement of any kind from SQA under any circumstances.
+
+## 17. Indemnity
+
+You agree to indemnify and hold SQA and our subsidiaries, affiliates, officers, agents, employees, partners and licensors harmless from any claim or demand, including reasonable attorneys' fees, made by any third party due to or arising out of content you submit, post, transmit, modify or otherwise make available through the SQA services, your use of the SQA services, your connection to the SQA services, your violation of the Terms of Use, or your violation of any rights of another.
+
+## 18. Termination
+
+Upon your request, your account can be deleted from SQA. You may delete your account at any time by visiting your Profile Settings page. If you requested your account be deleted, we will delete the personal data associated with your account, however certain personal data will be retained if it has been integrated into data that is integral to our systems and site, including data in communications you have sent via our site. This data is necessarily retained for the integrity of the data on the site and our legitimate business purposes, including auditing, security and other legitimate interests (please refer to our Privacy Policy for more information). Your published Contributions will remain on the site in our discretion. Once a Contribution has been published, it becomes part of the communal trading knowledge and should stay that way. This policy prevents users from keeping only their best ideas public, thus keeping everyone honest and maintaining public confidence in the reputation and integrity of the site.
+
+You agree that SQA may, without prior notice, immediately terminate, limit your access to or suspend your SQA account, any associated email address, and access to the SQA services. Cause for such termination, limitation of access or suspension shall include, but not be limited to, (a) breaches or violations of the Terms of Use or other incorporated agreements or guidelines, (b)requests by law enforcement or other government agencies, (c) discontinuance or material modification to the SQA services (or any part thereof), (d) unexpected technical or security issues or problems, (e) extended periods of inactivity, (f) and/or engagement by you in fraudulent or illegal activities. Further, you agree that all terminations, limitations of access and suspensions for cause shall be made in SQA's sole discretion and that SQA shall not be liable to you or any third party for any termination of your account, any associated email address, or access to the SQA services.
+
+## 19. Emails
+
+By creating an account with SQA, you agree that SQA can use your email address to send you marketing materials, service-related notices, important information messages, special offers, etc. You can unsubscribe from this by clicking on the link provided in the emails.
+
+## 20. House rules
+
+By creating and using an account on SQA you confirm you have read and agree to follow our House Rules.
+
+## 21. Third Party Software
+
+Our software, website and/or services may include software components supplied by third parties which are utilized by permission of the respective licensors and/or copyright holders on the terms provided by such parties ("Third Party Software"). SQA expressly disclaims any warranty or other assurance to you regarding Third Party Software. Please note that your use of the Third Party Software will be governed by the terms and conditions of use and privacy policies of the Third Party Software providers and not by these Terms of Use or our Privacy Policy.
+
+## 22. Scripts
+
+You represent and warrant that you have all intellectual property rights, including all necessary patent, trademark, trade secret, copyright or other proprietary rights, in and to your script. If you use third-party materials, you represent and warrant that you have the right to distribute third-party material in the script. You agree that you will not submit material that is copyrighted, protected by trade secret or otherwise subject to third party proprietary rights, including patent, privacy and publicity rights, unless you are the owner of such rights or have permission from their rightful owner to submit the material.
+
+You are solely responsible for any script that you create. SQA is not in any way responsible for the use or misuse of your script by any user. SQA is not in any way responsible for the use or misuse of any user’s script by you.
+
+By using the publish script feature, you grant us a world-wide, irrevocable, perpetual, royalty-free license to:
+
+* publish this script as well as the username of the author;
+* disclose the source code of the script for open scripts;
+* perform, display, use and make available your open or protected script for any user or an invite-only script for any user that received an invite.
+
+We may remove your script without notice if we reasonably believe that you are in violation of these Terms of Use.
+
+You can publish the script under any license. If you do not include the license in the comment section of a script, you agree that your script is licensed under the Mozilla Public License 2.0.
+
+## 23. Publications - No Recommendation or Advice Status
+
+The information and publications are not meant to be, and do not constitute, financial, investment, trading, or other types of advice or recommendations supplied or endorsed by SQA.
+
+Any statement of view (which may be subject to change without notice) is the author's personal opinion, and the author makes no representations or warranties as to the accuracy or completeness of any information or analysis provided.
+
+The authors and SQA are not liable for any losses incurred as a result of any investment made on the basis of any perceived recommendation, forecast, or other information presented here.
+
+The contents of these publications should not be interpreted as an express or implicit promise, guarantee, or indication by SQA that customers will profit or that losses in connection with them can or will be limited if they rely on the information provided.
+
+**SQA may update these Terms of Use at any time**

data/lib/sqa/data_frame.rb

@@ -22,11 +22,51 @@ class SQA::DataFrame
   attr_accessor :data
 
   # Expects a Hash of Arrays (hofa)
-  def initialize(a_hash={})
-    @data = Data.new(a_hash)
+  # mapping: and transformers: are optional
+  # mapping is a Hash { old_key => new_key }
+  # transformers is also a Hash { key => Proc}
+  def initialize(
+      aofh_or_hofa= {}, # Array of Hashes or hash of array or hash
+      mapping:      {}, # { old_key => new_key }
+      transformers: {}  # { key => Proc }
+    )
+
+    if aofh_or_hofa.is_a? Hash
+      initialize_hofa(aofh_or_hofa, mapping: mapping)
+
+    elsif aofh_or_hofa.is_a?(Array)     &&
+          aofh_or_hofa.first.is_a?(Hash)
+      initialize_aofh(aofh_or_hofa, mapping: mapping)
+
+    else
+      raise BadParameterError, "Expecting Hash or Array of Hashes got: #{aofh_or_hofa.class}"
+    end
+
+    coerce_vectors!(transformers) unless transformers.empty?
+  end
+
+
+  def initialize_aofh(aofh, mapping:)
+    hofa  = self.class.aofh_to_hofa(
+                  aofh,
+                  mapping:      mapping
+                )
+
+    initialize_hofa(hofa, mapping: mapping)
+  end
+
+
+  def initialize_hofa(hofa, mapping:)
+    hofa  = self.class.normalize_keys(
+              hofa,
+              adapter_mapping: mapping
+            ) unless mapping.empty?
+
+    @data = Data.new(hofa)
   end
 
 
+
   def to_csv(path_to_file)
     CSV.open(path_to_file, 'w') do |csv|
       csv << keys
@@ -202,11 +242,9 @@ class SQA::DataFrame
 
     def from_aofh(aofh, mapping: {}, transformers: {})
       new(
-        aofh_to_hofa(
-          aofh,
-          mapping: mapping,
-          transformers: transformers
-        )
+        aofh,
+        mapping: mapping,
+        transformers: transformers
       )
     end
 

data/lib/sqa/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SQA
-  VERSION = "0.0.19"
+  VERSION = "0.0.21"
 
   class << self
     def version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqa
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.21
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-21 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alphavantage
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tocer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -215,6 +229,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".config/tocer/configuration.yml"
 - ".envrc"
 - CHANGELOG.md
 - LICENSE
@@ -231,6 +246,8 @@ files:
 - checksums/sqa-0.0.18.gem.sha512
 - checksums/sqa-0.0.19.gem.sha512
 - checksums/sqa-0.0.2.gem.sha512
+- checksums/sqa-0.0.20.gem.sha512
+- checksums/sqa-0.0.21.gem.sha512
 - checksums/sqa-0.0.3.gem.sha512
 - checksums/sqa-0.0.4.gem.sha512
 - checksums/sqa-0.0.5.gem.sha512
@@ -251,6 +268,7 @@ files:
 - docs/fibonacci_retracement.md
 - docs/head_and_shoulders_pattern.md
 - docs/identify_wave_condition.md
+- docs/indicators.md
 - docs/libsvm_file_format.md
 - docs/market_profile.md
 - docs/mean_reversion.md
@@ -263,6 +281,7 @@ files:
 - docs/simple_moving_average.md
 - docs/stochastic_oscillator.md
 - docs/strategy.md
+- docs/terms_of_use.md
 - docs/true_range.md
 - lib/patches/string.rb
 - lib/sqa.rb