alphavcli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc245e2930580e2948bc37d63f7e64415dccf2b10f7af8b53cbe7081a9f3ec38
+  data.tar.gz: bfb4d2a87f5c7e1d1eeabc50e0ea2a59c396da288aa3832c2d794a762a2ab738
+SHA512:
+  metadata.gz: 9fcfedb1b6f869bb9137e39a6cbb51344d2a3fcb8009e8fc81670ebfa9b043b98fc43af4432f7def3ff1602f6fd1152e15b16dbae684a2977365c4ec0eef65c5
+  data.tar.gz: 11c74a5e656a2c84e9137773de6b540bfc00eb702e9eb9153a294c9a0b16ec00003f977e6ed5d211142e7519cd791e3da31ae6a6d3eb2a266015b6c848759a5a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/userfiles/apikey.json
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in alphavcli.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    alphavcli (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  alphavcli!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,7 @@
+## Project explaination
+This is a CLI for accessing a small ammount of the data avalible from Alpha Vantage
+
+## todo
+* add some error catching in case user inputs an invalid ticker.
+* Some log something if the user inputs a search that returns no results
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/alphavcli.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "alphavcli/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "alphavcli"
+  spec.version       = Alphavcli::VERSION
+  spec.authors       = ["alexandercleasby"]
+  spec.email         = ["cleasby.alex@gmail.com"]
+
+  spec.summary       = %q{pfff.}
+  spec.description   = %q{flk.}
+  spec.homepage      = ""
+
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["alphavcli"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/alphavcli

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+
+
+
+puts ' 
+      ______   __            __                                                          __  __ 
+     /      \ /  |          /  |                                                        /  |/  |
+    /$$$$$$  |$$ |  ______  $$ |____    ______           __     __              _______ $$ |$$/ 
+    $$ |__$$ |$$ | /      \ $$      \  /      \  ______ /  \   /  |            /       |$$ |/  |
+    $$    $$ |$$ |/$$$$$$  |$$$$$$$  | $$$$$$  |/      |$$  \ /$$/            /$$$$$$$/ $$ |$$ |
+    $$$$$$$$ |$$ |$$ |  $$ |$$ |  $$ | /    $$ |$$$$$$/  $$  /$$/             $$ |      $$ |$$ |
+    $$ |  $$ |$$ |$$ |__$$ |$$ |  $$ |/$$$$$$$ |          $$ $$/              $$ \_____ $$ |$$ |
+    $$ |  $$ |$$ |$$    $$/ $$ |  $$ |$$    $$ |           $$$/               $$       |$$ |$$ |
+    $$/   $$/ $$/ $$$$$$$/  $$/   $$/  $$$$$$$/             $/                 $$$$$$$/ $$/ $$/ 
+                  $$ |                                                                          
+                  $$ |                                                                          
+                  $$/                                                                           
+'
+#puts ARGV[1].class
+require_relative "../lib/alphavcli"
+Alphavcli::Cli.new.call
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "alphavcli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/alphavcli.rb

@@ -0,0 +1,21 @@
+require 'open-uri'
+require 'json'
+require 'pry'
+
+require_relative "./alphavcli/version"
+require_relative "./alphavcli/search"
+require_relative "./alphavcli/apicaller"
+#require_relative "./alphavcli/security"
+require_relative "./alphavcli/result"
+require_relative "./alphavcli/cli"
+
+
+
+module Alphavcli
+  
+ 
+
+  
+  
+ 
+end

data/lib/alphavcli/apicaller.rb

@@ -0,0 +1,15 @@
+require 'json'
+
+class Alphavcli::Apicaller
+
+    def initialize
+        @@URL_ROOT="https://www.alphavantage.co/query?pikey=#{Alphavcli::APIKEY}"
+    end
+    def search(qurery)
+        puts @@URL_ROOT+"query?function=SYMBOL_SEARCH&keywords=#{query}"
+        data = open(@@URL_ROOT+"query?function=SYMBOL_SEARCH&keywords=#{query}")
+        #data = open("https://www.alphavantage.co/query?function=SYMBOL_SEARCH&keywords=#{@query}&apikey=#{Alphavcli::APIKEY}").read
+        #data = JSON.parse(data)
+    end
+    
+end

data/lib/alphavcli/cli.rb

@@ -0,0 +1,113 @@
+class Alphavcli::Cli
+    def initialize
+    
+        if File.exist?(File.expand_path('../../userfiles/apikey.json', File.dirname(__FILE__)))
+            @@apikey= JSON.parse(File.read(File.expand_path('../../userfiles/apikey.json', File.dirname(__FILE__))))["apikey"]
+        else
+            puts "No api Key found."
+            getkey
+        end
+        #
+    end
+
+    def getkey
+        puts "Please go to https://www.alphavantage.co/ to claim your free API key and enter it."
+        @@apikey=gets.chomp
+
+        open(File.expand_path('../../userfiles/apikey.json', File.dirname(__FILE__)),'w'){
+            |f| f.puts JSON.generate(:apikey=>@apikey)
+        }
+    end
+
+    def call
+
+        loop {
+            puts '
+Please enter the number cooresponding to the action you would like to take.
+        
+"Search" - Search to find security by keyword.
+"Returns - Get data directly from a ticker you know"
+"exit" quit program'
+
+            select = gets.chomp
+            case select
+            
+            when "Search"
+                searchDisplay
+                #Alphavcli::Search.new
+            when "Returns"
+                returnsFromTicker
+            when "exit"
+                break
+            else
+                puts "#{select} is not a valid action"
+            end
+            }
+    end
+
+    def searchDisplay
+        puts 'Enter a search term'
+        query=gets.chomp
+        if Alphavcli::Search.history.find{|search| search.query==query} != nil
+            new_search = Alphavcli::Search.history.find{|search| search.query==query}
+        else
+            new_search = Alphavcli::Search.new(query)
+        end
+        puts 'Please select a security'
+        new_search.results.each_with_index{|res,i|
+        puts "#{i+1}. #{res.ticker} - #{res.name}"}
+        puts "Select the number that cooresponds to the secutity you are interested in"
+        select = gets.chomp.to_i
+        dataLanding(new_search.results[select-1])
+    end
+
+    def dataLanding(sec)
+        
+        loop {
+            puts "What would you like to know about #{sec.name}?"
+            puts '"Daily" - Display return from the past day
+"Weekly" - Display returns from the past week
+"Back" - Go Back to main menu'
+            select=gets.chomp
+            case select
+            when "Daily"
+                
+                sec.getTimeSeries
+                diplay(sec.daily[0..10])
+                #display(sec.getTimeSeries)
+            when "Weekly"
+                sec.getTimeSeries
+                diplay(sec.daily[0..7*10],7)
+            when "back"
+                break
+            else
+                puts "#{select} is not a valid action!"
+            end
+        }
+    end
+
+    def returnsFromTicker
+        puts "Please enter the ticker you are intersted in."
+        ticker = gets.chomp
+        new_result=Result.new_from_ticker(ticker)
+        dataLanding(new_result)
+    end
+
+    def diplay(data,interval=1)
+        
+        data[0,data.length-2].each_with_index{|day,i|
+        if i % interval == 0
+            puts day[:day]+"  "+ "%.2f" % day[:price] + "  "+ "%.4f" % (((day[:price]-data[i+interval][:price])/data[i+interval][:price])*100) +'%'
+        end
+        }
+    end
+
+    def self.returnKey
+        @@apikey
+    end
+
+    def invalid_key
+        puts "that is an invalid key"
+        getkey
+    end
+end

data/lib/alphavcli/result.rb

@@ -0,0 +1,35 @@
+class Result
+    attr_accessor :ticker, :name, :daily
+    @@all = []
+    def initialize(ticker,name=nil)
+        @ticker=ticker
+        @name=name
+        @@all.push(self)
+    end
+
+    def self.new_from_ticker(ticker)
+        new_result = self.new(ticker)
+        self.new(ticker) 
+    end
+
+    def getTimeSeries
+        data = open("https://www.alphavantage.co/query?function=TIME_SERIES_DAILY&symbol=#{@ticker}&apikey=#{Alphavcli::Cli.returnKey}").read
+        data = JSON.parse(data)
+        
+        #data = data["Time Series (Daily)"]
+        @daily = data = data["Time Series (Daily)"].map{|k,v|
+            {:day=>k, :price=>v["4. close"].to_f}
+        }
+    end
+
+    def week
+        getTimeSeries
+    end
+
+    def self.all
+        @@all
+    end
+
+    
+
+end

data/lib/alphavcli/search.rb

@@ -0,0 +1,41 @@
+require 'json'
+
+
+class Alphavcli::Search
+
+    attr_accessor :query, :results, :ticker, :name
+    @@histroy = []
+    
+    def initialize(query)
+        data = open("https://www.alphavantage.co/query?function=SYMBOL_SEARCH&keywords=#{query}&apikey=#{Alphavcli::Cli.returnKey}").read
+        data = JSON.parse(data)
+        
+        
+        @query=query
+        @results = data["bestMatches"].map{|e|
+            Result.new(e["1. symbol"],e["2. name"])
+            #{:ticker=>e["1. symbol"],:name=>e["2. name"]}
+        }
+        @@histroy.push(self)
+        
+
+        
+    end
+
+    def self.history
+        @@histroy
+    end
+    
+    
+
+    def display
+        max = @results.map{|result| result["1. symbol"].length}.max
+        @results.each{|result|
+        puts result["1. symbol"]+(" "*(30-result["1. symbol"].length)) + result["2. name"]}
+    end
+
+    def spacetimes(n)
+        out = 3
+    end
+
+end

data/lib/alphavcli/version.rb

@@ -0,0 +1,3 @@
+module Alphavcli
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: alphavcli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alexandercleasby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: flk.
+email:
+- cleasby.alex@gmail.com
+executables:
+- alphavcli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- alphavcli.gemspec
+- bin/alphavcli
+- bin/console
+- bin/setup
+- lib/alphavcli.rb
+- lib/alphavcli/apicaller.rb
+- lib/alphavcli/cli.rb
+- lib/alphavcli/result.rb
+- lib/alphavcli/search.rb
+- lib/alphavcli/version.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: pfff.
+test_files: []