stockcruncher 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +4 -0
- data/.gitlab-ci.yml +58 -0
- data/.rspec +2 -0
- data/.rubocop.yml +6 -0
- data/CHANGELOG +7 -0
- data/CONTRIBUTING.md +38 -0
- data/Gemfile +5 -0
- data/LICENSE +202 -0
- data/README.md +63 -0
- data/Rakefile +8 -0
- data/bin/stockcruncher +10 -0
- data/lib/stockcruncher.rb +18 -0
- data/lib/stockcruncher/alphavantage.rb +41 -0
- data/lib/stockcruncher/cli.rb +45 -0
- data/lib/stockcruncher/cruncher.rb +30 -0
- data/lib/stockcruncher/version.rb +6 -0
- data/spec/files/stockcruncher.yml +2 -0
- data/spec/spec_helper.rb +35 -0
- data/spec/stockcruncher/alphavantage_spec.rb +16 -0
- data/spec/stockcruncher/cli_spec.rb +25 -0
- data/spec/stockcruncher/stubs/servers_stubs.rb +16 -0
- data/spec/stockcruncher_spec.rb +9 -0
- data/stockcruncher.gemspec +47 -0
- metadata +164 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 58f00f855043839b976fb6bd52a7d6044187fa24dd97c5d50cfb90b637bfd26a
|
4
|
+
data.tar.gz: d2f59a0979b3f1da3c1ba8b491efe6b6588b5af26d1b17f69a3ab6455f3aebbb
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 3eaeeb37d7f845ae3c163053d455650f519c29549c5750c70a443efe3e993d4ebc002595f7d3e5b5b093aee1d790ac026a6037c86717319d5170cf60bcf42e6a
|
7
|
+
data.tar.gz: d0cd2ee27442ccb1f814958759e7c826eef5bbef468b060ba39674d5d8560d010f82b843e75b79f4401f5e45cea66f72b09a8a0dd446c0fca49f5b73621c6e5b
|
data/.gitignore
ADDED
data/.gitlab-ci.yml
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
image: ruby:2.4
|
2
|
+
|
3
|
+
rubocop:
|
4
|
+
stage: test
|
5
|
+
before_script:
|
6
|
+
- gem install --silent rubocop
|
7
|
+
script:
|
8
|
+
- rubocop
|
9
|
+
|
10
|
+
lines_length:
|
11
|
+
stage: test
|
12
|
+
script:
|
13
|
+
- >
|
14
|
+
bash <(curl -s
|
15
|
+
https://gitlab.com/yue-script/checks/raw/master/check_lines_length.sh)
|
16
|
+
80 README.md
|
17
|
+
|
18
|
+
git_history:
|
19
|
+
stage: test
|
20
|
+
script:
|
21
|
+
- >
|
22
|
+
bash <(curl -s
|
23
|
+
https://gitlab.com/yue-script/checks/raw/master/check_git_history.sh)
|
24
|
+
|
25
|
+
rspec:
|
26
|
+
stage: test
|
27
|
+
script:
|
28
|
+
- bundle install
|
29
|
+
- rspec
|
30
|
+
artifacts:
|
31
|
+
paths:
|
32
|
+
- coverage/
|
33
|
+
|
34
|
+
pages:
|
35
|
+
stage: deploy
|
36
|
+
dependencies:
|
37
|
+
- rspec
|
38
|
+
script:
|
39
|
+
- mv coverage/ public/
|
40
|
+
artifacts:
|
41
|
+
paths:
|
42
|
+
- public
|
43
|
+
expire_in: 30 days
|
44
|
+
only:
|
45
|
+
- devel
|
46
|
+
|
47
|
+
gem_push:
|
48
|
+
stage: deploy
|
49
|
+
script:
|
50
|
+
- mkdir ~/.gem
|
51
|
+
- >
|
52
|
+
echo -e "---\n:rubygems_api_key: ${RUBYGEM_API_KEY}" > ~/.gem/credentials
|
53
|
+
- chmod 0600 ~/.gem/credentials
|
54
|
+
- gem build stockcruncher.gemspec
|
55
|
+
- gem push stockcruncher-*.gem
|
56
|
+
only:
|
57
|
+
- master
|
58
|
+
when: manual
|
data/.rspec
ADDED
data/.rubocop.yml
ADDED
data/CHANGELOG
ADDED
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
Contributing
|
2
|
+
------------
|
3
|
+
|
4
|
+
You are more than welcome to submit issues and merge requests to this project.
|
5
|
+
|
6
|
+
### Tests
|
7
|
+
|
8
|
+
Your commits must not break any tests.
|
9
|
+
|
10
|
+
### Commits format
|
11
|
+
|
12
|
+
Your commits must pass `git log --check` and messages should be formated
|
13
|
+
like this (based on this excellent
|
14
|
+
[post](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)):
|
15
|
+
|
16
|
+
```
|
17
|
+
Summarize change in 50 characters or less
|
18
|
+
|
19
|
+
Provide more detail after the first line. Leave one blank line below the
|
20
|
+
summary and wrap all lines at 72 characters or less.
|
21
|
+
|
22
|
+
If the change fixes an issue, leave another blank line after the final
|
23
|
+
paragraph and indicate which issue is fixed in the specific format
|
24
|
+
below.
|
25
|
+
|
26
|
+
Fix #42
|
27
|
+
```
|
28
|
+
|
29
|
+
Also do your best to factor commits appropriately, ie not too large with
|
30
|
+
unrelated things in the same commit, and not too small with the same small
|
31
|
+
change applied N times in N different commits. If there was some accidental
|
32
|
+
reformatting or whitespace changes during the course of your commits, please
|
33
|
+
rebase them away before submitting the MR.
|
34
|
+
|
35
|
+
### Files
|
36
|
+
|
37
|
+
All files must be 80 columns width formatted (actually 79), exception only
|
38
|
+
when it is really not possible.
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright (c) 2020 Richard Delaplace
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,63 @@
|
|
1
|
+
# StockCruncher
|
2
|
+
[![License][license-img]](LICENSE)
|
3
|
+
[![build status][status-img]][master-commit]
|
4
|
+
[![coverage report][cov-img]][pages]
|
5
|
+
[![Gem Version][gem-img]][gem]
|
6
|
+
|
7
|
+
1. [Overview](#overview)
|
8
|
+
2. [Description](#role-description)
|
9
|
+
3. [Setup](#setup)
|
10
|
+
4. [Usage](#usage)
|
11
|
+
5. [Limitations](#limitations)
|
12
|
+
6. [Development](#development)
|
13
|
+
7. [Miscellaneous](#miscellaneous)
|
14
|
+
|
15
|
+
## Overview
|
16
|
+
|
17
|
+
`StockCruncher` is a stock market data cruncher.
|
18
|
+
|
19
|
+
## Description
|
20
|
+
|
21
|
+
This tool requests a stock market data API and parse the incoming data in order
|
22
|
+
to write the data in a database for later calculation and use.
|
23
|
+
|
24
|
+
## Setup
|
25
|
+
|
26
|
+
$ gem install stockcruncher
|
27
|
+
$ mkdir /etc/stockcruncher && cd /etc/stockcruncher
|
28
|
+
$ echo $'AlphaVantage:\n apikey: CHANGEME' > stockcruncher.yml
|
29
|
+
|
30
|
+
## Usage
|
31
|
+
|
32
|
+
An interactive help is available with:
|
33
|
+
|
34
|
+
$ stockcruncher help
|
35
|
+
|
36
|
+
## Examples
|
37
|
+
|
38
|
+
To get daily time serie data of a symbol:
|
39
|
+
|
40
|
+
$ stockcruncher crunch AAPL daily
|
41
|
+
|
42
|
+
To get last day endpoint data of a symbol:
|
43
|
+
|
44
|
+
$ stockcruncher crunch AAPL quote_endpoint
|
45
|
+
|
46
|
+
## Limitations
|
47
|
+
|
48
|
+
Data are currently scraped from AlphaVantage API.
|
49
|
+
More source could be great especially because AlphaVantage doesn't provide EU
|
50
|
+
intraday data.
|
51
|
+
|
52
|
+
## Development
|
53
|
+
|
54
|
+
Please read carefully [CONTRIBUTING.md](CONTRIBUTING.md) before making a merge
|
55
|
+
request.
|
56
|
+
|
57
|
+
[license-img]: https://img.shields.io/badge/license-Apache-blue.svg
|
58
|
+
[status-img]: https://gitlab.com/yue-ruby/stockcruncher/badges/devel/pipeline.svg
|
59
|
+
[master-commit]: https://gitlab.com/yue-ruby/stockcruncher/commits/master
|
60
|
+
[cov-img]: https://gitlab.com/yue-ruby/stockcruncher/badges/devel/coverage.svg
|
61
|
+
[pages]: https://yue-ruby.gitlab.io/stockcruncher/
|
62
|
+
[gem-img]: https://badge.fury.io/rb/stockcruncher.svg
|
63
|
+
[gem]: https://badge.fury.io/rb/stockcruncher
|
data/Rakefile
ADDED
data/bin/stockcruncher
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
# StockCruncher class
|
5
|
+
module StockCruncher
|
6
|
+
class << self
|
7
|
+
Dir[File.join(File.dirname(__FILE__), '*', '*.rb')].sort.each do |file|
|
8
|
+
require file
|
9
|
+
end
|
10
|
+
|
11
|
+
def start(args = ARGV)
|
12
|
+
StockCruncher::CLI.start(args)
|
13
|
+
rescue NotImplementedError => e
|
14
|
+
warn e.message
|
15
|
+
exit(3)
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require './lib/stockcruncher/cruncher.rb'
|
5
|
+
|
6
|
+
module StockCruncher
|
7
|
+
# This is an data cruncher class for AlphaVantage API.
|
8
|
+
class AlphaVantage < Cruncher
|
9
|
+
API_URL = 'https://www.alphavantage.co/query?'
|
10
|
+
SERIE = {
|
11
|
+
'daily' => 'TIME_SERIES_DAILY',
|
12
|
+
'quote_endpoint' => 'GLOBAL_QUOTE'
|
13
|
+
}.freeze
|
14
|
+
|
15
|
+
# Main method to crunch data.
|
16
|
+
def crunch(symbol, serie, opts)
|
17
|
+
err_msg = "#{serie} does not exist."
|
18
|
+
raise NotImplementedError, err_msg unless SERIE.key?(serie)
|
19
|
+
|
20
|
+
url = API_URL + parameters(symbol, serie) + options(serie, opts)
|
21
|
+
res = request(url)
|
22
|
+
puts res.body
|
23
|
+
end
|
24
|
+
|
25
|
+
def options(serie, opts)
|
26
|
+
o = '&datatype=' + (opts['json'] ? 'json' : 'csv')
|
27
|
+
if serie == 'daily'
|
28
|
+
o += '&outputsize='
|
29
|
+
o += opts['full'] ? 'full' : 'compact'
|
30
|
+
end
|
31
|
+
o
|
32
|
+
end
|
33
|
+
|
34
|
+
def parameters(symbol, serie)
|
35
|
+
p = 'function=' + SERIE[serie]
|
36
|
+
p += '&symbol=' + symbol
|
37
|
+
p += '&apikey=' + @config[self.class.name.split('::').last]['apikey']
|
38
|
+
p
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,45 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require 'thor'
|
5
|
+
|
6
|
+
module StockCruncher
|
7
|
+
# Simple CLI for StockCruncher
|
8
|
+
class CLI < Thor
|
9
|
+
desc 'version', 'Print stockcruncher current version'
|
10
|
+
def version
|
11
|
+
puts "StockCruncher version #{StockCruncher::VERSION}"
|
12
|
+
end
|
13
|
+
|
14
|
+
desc('crunch SYMBOL TIMESERIES [options]',
|
15
|
+
'Crunch SYMBOL stock market data for time series.' \
|
16
|
+
'Possible timeseries: daily, quote_endpoint.')
|
17
|
+
option(
|
18
|
+
:config,
|
19
|
+
aliases: ['-c'],
|
20
|
+
type: :string,
|
21
|
+
default: '/etc/stockcruncher/stockcruncher.yml',
|
22
|
+
desc: 'Yaml formatted config file to load ' \
|
23
|
+
'(default to /etc/stockcruncher/stockcruncher.yml).'
|
24
|
+
)
|
25
|
+
option(
|
26
|
+
:json,
|
27
|
+
aliases: ['-j'],
|
28
|
+
type: :boolean,
|
29
|
+
default: false,
|
30
|
+
desc: 'Json format data (default to csv).'
|
31
|
+
)
|
32
|
+
option(
|
33
|
+
:full,
|
34
|
+
aliases: ['-f'],
|
35
|
+
type: :boolean,
|
36
|
+
default: false,
|
37
|
+
desc: 'Full data size.'
|
38
|
+
)
|
39
|
+
def crunch(symbol, timeserie)
|
40
|
+
opts = options.dup
|
41
|
+
cruncher = StockCruncher::AlphaVantage.new(opts['config'])
|
42
|
+
cruncher.crunch(symbol, timeserie, opts)
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -0,0 +1,30 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require 'net/http'
|
5
|
+
require 'yaml'
|
6
|
+
|
7
|
+
module StockCruncher
|
8
|
+
# This is an data cruncher abstract class.
|
9
|
+
class Cruncher
|
10
|
+
# Class abstract constructor method
|
11
|
+
def initialize(file)
|
12
|
+
@config = load_conf(file)
|
13
|
+
end
|
14
|
+
|
15
|
+
# Method to load configurations described in config_file.
|
16
|
+
def load_conf(file)
|
17
|
+
YAML.load_file(file)
|
18
|
+
end
|
19
|
+
|
20
|
+
# Method to send http get request
|
21
|
+
def request(url, insecure = false)
|
22
|
+
uri = URI.parse(url)
|
23
|
+
http = Net::HTTP.new(uri.host, uri.port)
|
24
|
+
http.use_ssl = uri.scheme.eql?('https')
|
25
|
+
http.verify_mode = OpenSSL::SSL::VERIFY_NONE if insecure
|
26
|
+
req = Net::HTTP::Get.new(uri.request_uri)
|
27
|
+
http.request(req)
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require 'simplecov'
|
5
|
+
SimpleCov.start
|
6
|
+
|
7
|
+
$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
|
8
|
+
require 'stockcruncher'
|
9
|
+
require 'webmock/rspec'
|
10
|
+
|
11
|
+
# Force expect syntax over should
|
12
|
+
RSpec.configure do |config|
|
13
|
+
config.expect_with :rspec do |c|
|
14
|
+
c.syntax = :expect
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
dir = File.dirname(__FILE__)
|
19
|
+
# Load helpers
|
20
|
+
Dir[File.join(dir, 'helpers', '*.rb')].sort.each { |file| require file }
|
21
|
+
|
22
|
+
def now
|
23
|
+
Time.new.strftime('%Y-%m-%dT%H:%M:%S%z').insert(-3, ':')
|
24
|
+
end
|
25
|
+
|
26
|
+
# Load stubs
|
27
|
+
files = File.join(dir, 'stockcruncher', 'stubs', '*.rb')
|
28
|
+
Dir[files].sort.each { |file| require file }
|
29
|
+
|
30
|
+
# To test the cli
|
31
|
+
def start(caller_object, subcommand = nil)
|
32
|
+
cmd = caller_object.class.description.split(' ')
|
33
|
+
args = [subcommand, *cmd].compact
|
34
|
+
StockCruncher.start(args)
|
35
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'spec_helper'
|
4
|
+
|
5
|
+
describe StockCruncher::AlphaVantage do
|
6
|
+
context 'crunch SYM daily -c spec/files/stockcruncher.yml' do
|
7
|
+
it 'requests a source and get the result.' do
|
8
|
+
expect { start(self) }.to output("{}\n").to_stdout
|
9
|
+
end
|
10
|
+
end
|
11
|
+
context 'crunch SYM weekly -c spec/files/stockcruncher.yml' do
|
12
|
+
it 'requests a not implemented time serie.' do
|
13
|
+
expect { start(self) }.to raise_error(SystemExit)
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'spec_helper'
|
4
|
+
|
5
|
+
describe StockCruncher::CLI do
|
6
|
+
context 'version' do
|
7
|
+
it 'prints the version.' do
|
8
|
+
out = "StockCruncher version #{StockCruncher::VERSION}\n"
|
9
|
+
expect { start(self) }.to output(out).to_stdout
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
context 'crunch SYM quote_endpoint -c spec/files/stockcruncher.yml' do
|
14
|
+
it 'Get the quote for SYM.' do
|
15
|
+
expect { start(self) }.to output("{}\n").to_stdout
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
context 'notexistingcmd' do
|
20
|
+
it 'is an unknown command and does nothing.' do
|
21
|
+
out = "Could not find command \"notexistingcmd\".\n"
|
22
|
+
expect { start(self) }.to output(out).to_stderr
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'spec_helper'
|
4
|
+
|
5
|
+
RSpec.configure do |config|
|
6
|
+
config.before(:each) do
|
7
|
+
# requests an API without extra arguments
|
8
|
+
stub_request(:get, 'https://www.alphavantage.co/query?' \
|
9
|
+
'function=GLOBAL_QUOTE&symbol=SYM&apikey=demo&datatype=csv')
|
10
|
+
.to_return('status' => 200, 'body' => '{}', 'headers' => {})
|
11
|
+
stub_request(:get, 'https://www.alphavantage.co/query?' \
|
12
|
+
'function=TIME_SERIES_DAILY&symbol=SYM&apikey=demo' \
|
13
|
+
'&datatype=csv&outputsize=compact')
|
14
|
+
.to_return('status' => 200, 'body' => '{}', 'headers' => {})
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
lib = File.expand_path('lib', __dir__)
|
4
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
5
|
+
require 'stockcruncher/version'
|
6
|
+
|
7
|
+
dev_deps = {
|
8
|
+
'bundler' => '~> 1.17',
|
9
|
+
'rspec' => '~> 3.9',
|
10
|
+
'rake' => '~> 11.3',
|
11
|
+
'rubocop' => '0.88',
|
12
|
+
'webmock' => '~> 2.0.3',
|
13
|
+
'simplecov' => '~> 0.18'
|
14
|
+
}
|
15
|
+
|
16
|
+
deps = {
|
17
|
+
'thor' => '~> 0.20'
|
18
|
+
}
|
19
|
+
|
20
|
+
Gem::Specification.new do |s|
|
21
|
+
s.name = 'stockcruncher'
|
22
|
+
s.version = StockCruncher::VERSION
|
23
|
+
s.authors = ['Richard Delaplace']
|
24
|
+
s.email = 'r.delaplace@free.fr'
|
25
|
+
s.license = 'Apache-2.0'
|
26
|
+
|
27
|
+
s.summary = 'Stock market data cruncher.'
|
28
|
+
s.description = 'StockCruncher is a simple tool to crunch stock market data.'
|
29
|
+
s.homepage = 'https://gitlab.com/yue-ruby/stockcruncher'
|
30
|
+
|
31
|
+
s.files = `git ls-files`.lines.map(&:chomp)
|
32
|
+
s.bindir = 'bin'
|
33
|
+
s.executables = `git ls-files bin/*`.lines.map do |exe|
|
34
|
+
File.basename(exe.chomp)
|
35
|
+
end
|
36
|
+
s.require_paths = ['lib']
|
37
|
+
|
38
|
+
s.required_ruby_version = '>= 2.4.0'
|
39
|
+
|
40
|
+
dev_deps.each_pair do |deps_gem, deps_version|
|
41
|
+
s.add_development_dependency deps_gem, deps_version
|
42
|
+
end
|
43
|
+
|
44
|
+
deps.each_pair do |deps_gem, deps_version|
|
45
|
+
s.add_dependency deps_gem, deps_version
|
46
|
+
end
|
47
|
+
end
|
metadata
ADDED
@@ -0,0 +1,164 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: stockcruncher
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Richard Delaplace
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-07-24 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.17'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.17'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rspec
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '3.9'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '3.9'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '11.3'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '11.3'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rubocop
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - '='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0.88'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - '='
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0.88'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: webmock
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: 2.0.3
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: 2.0.3
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: simplecov
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0.18'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0.18'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: thor
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - "~>"
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0.20'
|
104
|
+
type: :runtime
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - "~>"
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0.20'
|
111
|
+
description: StockCruncher is a simple tool to crunch stock market data.
|
112
|
+
email: r.delaplace@free.fr
|
113
|
+
executables:
|
114
|
+
- stockcruncher
|
115
|
+
extensions: []
|
116
|
+
extra_rdoc_files: []
|
117
|
+
files:
|
118
|
+
- ".gitignore"
|
119
|
+
- ".gitlab-ci.yml"
|
120
|
+
- ".rspec"
|
121
|
+
- ".rubocop.yml"
|
122
|
+
- CHANGELOG
|
123
|
+
- CONTRIBUTING.md
|
124
|
+
- Gemfile
|
125
|
+
- LICENSE
|
126
|
+
- README.md
|
127
|
+
- Rakefile
|
128
|
+
- bin/stockcruncher
|
129
|
+
- lib/stockcruncher.rb
|
130
|
+
- lib/stockcruncher/alphavantage.rb
|
131
|
+
- lib/stockcruncher/cli.rb
|
132
|
+
- lib/stockcruncher/cruncher.rb
|
133
|
+
- lib/stockcruncher/version.rb
|
134
|
+
- spec/files/stockcruncher.yml
|
135
|
+
- spec/spec_helper.rb
|
136
|
+
- spec/stockcruncher/alphavantage_spec.rb
|
137
|
+
- spec/stockcruncher/cli_spec.rb
|
138
|
+
- spec/stockcruncher/stubs/servers_stubs.rb
|
139
|
+
- spec/stockcruncher_spec.rb
|
140
|
+
- stockcruncher.gemspec
|
141
|
+
homepage: https://gitlab.com/yue-ruby/stockcruncher
|
142
|
+
licenses:
|
143
|
+
- Apache-2.0
|
144
|
+
metadata: {}
|
145
|
+
post_install_message:
|
146
|
+
rdoc_options: []
|
147
|
+
require_paths:
|
148
|
+
- lib
|
149
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
150
|
+
requirements:
|
151
|
+
- - ">="
|
152
|
+
- !ruby/object:Gem::Version
|
153
|
+
version: 2.4.0
|
154
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
155
|
+
requirements:
|
156
|
+
- - ">="
|
157
|
+
- !ruby/object:Gem::Version
|
158
|
+
version: '0'
|
159
|
+
requirements: []
|
160
|
+
rubygems_version: 3.0.3
|
161
|
+
signing_key:
|
162
|
+
specification_version: 4
|
163
|
+
summary: Stock market data cruncher.
|
164
|
+
test_files: []
|