alphavcli 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: dc245e2930580e2948bc37d63f7e64415dccf2b10f7af8b53cbe7081a9f3ec38
4
+ data.tar.gz: bfb4d2a87f5c7e1d1eeabc50e0ea2a59c396da288aa3832c2d794a762a2ab738
5
+ SHA512:
6
+ metadata.gz: 9fcfedb1b6f869bb9137e39a6cbb51344d2a3fcb8009e8fc81670ebfa9b043b98fc43af4432f7def3ff1602f6fd1152e15b16dbae684a2977365c4ec0eef65c5
7
+ data.tar.gz: 11c74a5e656a2c84e9137773de6b540bfc00eb702e9eb9153a294c9a0b16ec00003f977e6ed5d211142e7519cd791e3da31ae6a6d3eb2a266015b6c848759a5a
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ /userfiles/apikey.json
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.5.1
5
+ before_install: gem install bundler -v 1.16.2
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in alphavcli.gemspec
6
+ gemspec
@@ -0,0 +1,35 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ alphavcli (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ diff-lcs (1.3)
10
+ rake (10.5.0)
11
+ rspec (3.8.0)
12
+ rspec-core (~> 3.8.0)
13
+ rspec-expectations (~> 3.8.0)
14
+ rspec-mocks (~> 3.8.0)
15
+ rspec-core (3.8.0)
16
+ rspec-support (~> 3.8.0)
17
+ rspec-expectations (3.8.2)
18
+ diff-lcs (>= 1.2.0, < 2.0)
19
+ rspec-support (~> 3.8.0)
20
+ rspec-mocks (3.8.0)
21
+ diff-lcs (>= 1.2.0, < 2.0)
22
+ rspec-support (~> 3.8.0)
23
+ rspec-support (3.8.0)
24
+
25
+ PLATFORMS
26
+ ruby
27
+
28
+ DEPENDENCIES
29
+ alphavcli!
30
+ bundler (~> 1.16)
31
+ rake (~> 10.0)
32
+ rspec (~> 3.0)
33
+
34
+ BUNDLED WITH
35
+ 1.16.2
@@ -0,0 +1,7 @@
1
+ ## Project explaination
2
+ This is a CLI for accessing a small ammount of the data avalible from Alpha Vantage
3
+
4
+ ## todo
5
+ * add some error catching in case user inputs an invalid ticker.
6
+ * Some log something if the user inputs a search that returns no results
7
+
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,30 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "alphavcli/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "alphavcli"
8
+ spec.version = Alphavcli::VERSION
9
+ spec.authors = ["alexandercleasby"]
10
+ spec.email = ["cleasby.alex@gmail.com"]
11
+
12
+ spec.summary = %q{pfff.}
13
+ spec.description = %q{flk.}
14
+ spec.homepage = ""
15
+
16
+
17
+
18
+ # Specify which files should be added to the gem when it is released.
19
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
20
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
21
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
22
+ end
23
+ spec.bindir = "bin"
24
+ spec.executables = ["alphavcli"]
25
+ spec.require_paths = ["lib"]
26
+
27
+ spec.add_development_dependency "bundler", "~> 1.16"
28
+ spec.add_development_dependency "rake", "~> 10.0"
29
+ spec.add_development_dependency "rspec", "~> 3.0"
30
+ end
@@ -0,0 +1,23 @@
1
+ #!/usr/bin/env ruby
2
+
3
+
4
+
5
+
6
+ puts '
7
+ ______ __ __ __ __
8
+ / \ / | / | / |/ |
9
+ /$$$$$$ |$$ | ______ $$ |____ ______ __ __ _______ $$ |$$/
10
+ $$ |__$$ |$$ | / \ $$ \ / \ ______ / \ / | / |$$ |/ |
11
+ $$ $$ |$$ |/$$$$$$ |$$$$$$$ | $$$$$$ |/ |$$ \ /$$/ /$$$$$$$/ $$ |$$ |
12
+ $$$$$$$$ |$$ |$$ | $$ |$$ | $$ | / $$ |$$$$$$/ $$ /$$/ $$ | $$ |$$ |
13
+ $$ | $$ |$$ |$$ |__$$ |$$ | $$ |/$$$$$$$ | $$ $$/ $$ \_____ $$ |$$ |
14
+ $$ | $$ |$$ |$$ $$/ $$ | $$ |$$ $$ | $$$/ $$ |$$ |$$ |
15
+ $$/ $$/ $$/ $$$$$$$/ $$/ $$/ $$$$$$$/ $/ $$$$$$$/ $$/ $$/
16
+ $$ |
17
+ $$ |
18
+ $$/
19
+ '
20
+ #puts ARGV[1].class
21
+ require_relative "../lib/alphavcli"
22
+ Alphavcli::Cli.new.call
23
+
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "alphavcli"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ # IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,21 @@
1
+ require 'open-uri'
2
+ require 'json'
3
+ require 'pry'
4
+
5
+ require_relative "./alphavcli/version"
6
+ require_relative "./alphavcli/search"
7
+ require_relative "./alphavcli/apicaller"
8
+ #require_relative "./alphavcli/security"
9
+ require_relative "./alphavcli/result"
10
+ require_relative "./alphavcli/cli"
11
+
12
+
13
+
14
+ module Alphavcli
15
+
16
+
17
+
18
+
19
+
20
+
21
+ end
@@ -0,0 +1,15 @@
1
+ require 'json'
2
+
3
+ class Alphavcli::Apicaller
4
+
5
+ def initialize
6
+ @@URL_ROOT="https://www.alphavantage.co/query?pikey=#{Alphavcli::APIKEY}"
7
+ end
8
+ def search(qurery)
9
+ puts @@URL_ROOT+"query?function=SYMBOL_SEARCH&keywords=#{query}"
10
+ data = open(@@URL_ROOT+"query?function=SYMBOL_SEARCH&keywords=#{query}")
11
+ #data = open("https://www.alphavantage.co/query?function=SYMBOL_SEARCH&keywords=#{@query}&apikey=#{Alphavcli::APIKEY}").read
12
+ #data = JSON.parse(data)
13
+ end
14
+
15
+ end
@@ -0,0 +1,113 @@
1
+ class Alphavcli::Cli
2
+ def initialize
3
+
4
+ if File.exist?(File.expand_path('../../userfiles/apikey.json', File.dirname(__FILE__)))
5
+ @@apikey= JSON.parse(File.read(File.expand_path('../../userfiles/apikey.json', File.dirname(__FILE__))))["apikey"]
6
+ else
7
+ puts "No api Key found."
8
+ getkey
9
+ end
10
+ #
11
+ end
12
+
13
+ def getkey
14
+ puts "Please go to https://www.alphavantage.co/ to claim your free API key and enter it."
15
+ @@apikey=gets.chomp
16
+
17
+ open(File.expand_path('../../userfiles/apikey.json', File.dirname(__FILE__)),'w'){
18
+ |f| f.puts JSON.generate(:apikey=>@apikey)
19
+ }
20
+ end
21
+
22
+ def call
23
+
24
+ loop {
25
+ puts '
26
+ Please enter the number cooresponding to the action you would like to take.
27
+
28
+ "Search" - Search to find security by keyword.
29
+ "Returns - Get data directly from a ticker you know"
30
+ "exit" quit program'
31
+
32
+ select = gets.chomp
33
+ case select
34
+
35
+ when "Search"
36
+ searchDisplay
37
+ #Alphavcli::Search.new
38
+ when "Returns"
39
+ returnsFromTicker
40
+ when "exit"
41
+ break
42
+ else
43
+ puts "#{select} is not a valid action"
44
+ end
45
+ }
46
+ end
47
+
48
+ def searchDisplay
49
+ puts 'Enter a search term'
50
+ query=gets.chomp
51
+ if Alphavcli::Search.history.find{|search| search.query==query} != nil
52
+ new_search = Alphavcli::Search.history.find{|search| search.query==query}
53
+ else
54
+ new_search = Alphavcli::Search.new(query)
55
+ end
56
+ puts 'Please select a security'
57
+ new_search.results.each_with_index{|res,i|
58
+ puts "#{i+1}. #{res.ticker} - #{res.name}"}
59
+ puts "Select the number that cooresponds to the secutity you are interested in"
60
+ select = gets.chomp.to_i
61
+ dataLanding(new_search.results[select-1])
62
+ end
63
+
64
+ def dataLanding(sec)
65
+
66
+ loop {
67
+ puts "What would you like to know about #{sec.name}?"
68
+ puts '"Daily" - Display return from the past day
69
+ "Weekly" - Display returns from the past week
70
+ "Back" - Go Back to main menu'
71
+ select=gets.chomp
72
+ case select
73
+ when "Daily"
74
+
75
+ sec.getTimeSeries
76
+ diplay(sec.daily[0..10])
77
+ #display(sec.getTimeSeries)
78
+ when "Weekly"
79
+ sec.getTimeSeries
80
+ diplay(sec.daily[0..7*10],7)
81
+ when "back"
82
+ break
83
+ else
84
+ puts "#{select} is not a valid action!"
85
+ end
86
+ }
87
+ end
88
+
89
+ def returnsFromTicker
90
+ puts "Please enter the ticker you are intersted in."
91
+ ticker = gets.chomp
92
+ new_result=Result.new_from_ticker(ticker)
93
+ dataLanding(new_result)
94
+ end
95
+
96
+ def diplay(data,interval=1)
97
+
98
+ data[0,data.length-2].each_with_index{|day,i|
99
+ if i % interval == 0
100
+ puts day[:day]+" "+ "%.2f" % day[:price] + " "+ "%.4f" % (((day[:price]-data[i+interval][:price])/data[i+interval][:price])*100) +'%'
101
+ end
102
+ }
103
+ end
104
+
105
+ def self.returnKey
106
+ @@apikey
107
+ end
108
+
109
+ def invalid_key
110
+ puts "that is an invalid key"
111
+ getkey
112
+ end
113
+ end
@@ -0,0 +1,35 @@
1
+ class Result
2
+ attr_accessor :ticker, :name, :daily
3
+ @@all = []
4
+ def initialize(ticker,name=nil)
5
+ @ticker=ticker
6
+ @name=name
7
+ @@all.push(self)
8
+ end
9
+
10
+ def self.new_from_ticker(ticker)
11
+ new_result = self.new(ticker)
12
+ self.new(ticker)
13
+ end
14
+
15
+ def getTimeSeries
16
+ data = open("https://www.alphavantage.co/query?function=TIME_SERIES_DAILY&symbol=#{@ticker}&apikey=#{Alphavcli::Cli.returnKey}").read
17
+ data = JSON.parse(data)
18
+
19
+ #data = data["Time Series (Daily)"]
20
+ @daily = data = data["Time Series (Daily)"].map{|k,v|
21
+ {:day=>k, :price=>v["4. close"].to_f}
22
+ }
23
+ end
24
+
25
+ def week
26
+ getTimeSeries
27
+ end
28
+
29
+ def self.all
30
+ @@all
31
+ end
32
+
33
+
34
+
35
+ end
@@ -0,0 +1,41 @@
1
+ require 'json'
2
+
3
+
4
+ class Alphavcli::Search
5
+
6
+ attr_accessor :query, :results, :ticker, :name
7
+ @@histroy = []
8
+
9
+ def initialize(query)
10
+ data = open("https://www.alphavantage.co/query?function=SYMBOL_SEARCH&keywords=#{query}&apikey=#{Alphavcli::Cli.returnKey}").read
11
+ data = JSON.parse(data)
12
+
13
+
14
+ @query=query
15
+ @results = data["bestMatches"].map{|e|
16
+ Result.new(e["1. symbol"],e["2. name"])
17
+ #{:ticker=>e["1. symbol"],:name=>e["2. name"]}
18
+ }
19
+ @@histroy.push(self)
20
+
21
+
22
+
23
+ end
24
+
25
+ def self.history
26
+ @@histroy
27
+ end
28
+
29
+
30
+
31
+ def display
32
+ max = @results.map{|result| result["1. symbol"].length}.max
33
+ @results.each{|result|
34
+ puts result["1. symbol"]+(" "*(30-result["1. symbol"].length)) + result["2. name"]}
35
+ end
36
+
37
+ def spacetimes(n)
38
+ out = 3
39
+ end
40
+
41
+ end
@@ -0,0 +1,3 @@
1
+ module Alphavcli
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,103 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: alphavcli
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - alexandercleasby
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2019-01-05 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.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: flk.
56
+ email:
57
+ - cleasby.alex@gmail.com
58
+ executables:
59
+ - alphavcli
60
+ extensions: []
61
+ extra_rdoc_files: []
62
+ files:
63
+ - ".gitignore"
64
+ - ".rspec"
65
+ - ".travis.yml"
66
+ - Gemfile
67
+ - Gemfile.lock
68
+ - README.md
69
+ - Rakefile
70
+ - alphavcli.gemspec
71
+ - bin/alphavcli
72
+ - bin/console
73
+ - bin/setup
74
+ - lib/alphavcli.rb
75
+ - lib/alphavcli/apicaller.rb
76
+ - lib/alphavcli/cli.rb
77
+ - lib/alphavcli/result.rb
78
+ - lib/alphavcli/search.rb
79
+ - lib/alphavcli/version.rb
80
+ homepage: ''
81
+ licenses: []
82
+ metadata: {}
83
+ post_install_message:
84
+ rdoc_options: []
85
+ require_paths:
86
+ - lib
87
+ required_ruby_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ required_rubygems_version: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ requirements: []
98
+ rubyforge_project:
99
+ rubygems_version: 2.7.7
100
+ signing_key:
101
+ specification_version: 4
102
+ summary: pfff.
103
+ test_files: []