stockcli_app 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 152df1358345531febb0c71478003ff787b1ba04ac1f950e045481125b0c15fc
+  data.tar.gz: baf18f424f1911c19f4e94eae29956cb448e7c8d2ae71ed7c9474f91181c2918
+SHA512:
+  metadata.gz: b36022c6d6c000506146444587692204e7f62882e38cfa7319fb45653d73fa68130b06c8e451531c2ae3e0fed6bd1ace4a3c74a01066cf27a736e1c1f3e56625
+  data.tar.gz: bf9c28381216a5295870a822d27ec25bea1d8edb52ce4596ca1f000a35dfe56a6d341dcdb886c7de4a513450977858583cf6e98e6e7242401663a1825efdcf4c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 stockcli_app.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 'Anu Khambete'
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# StockcliApp
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stockcli_app`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+The Stock CLI application provides the user a menu with 4 options :
+(a) View a list of stocks
+  This provides the user with a list of companies and their stock price with the option
+  of learning more about a particular stock by entering the correct company symbol.
+
+(b) View a list of companies in descending order of market cap
+(c) View a list of stocks in descending order of volatility
+(d) Quit the program
+
+sample text
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stockcli_app'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stockcli_app
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/'anukhambete'/stockcli_app.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stockcli_app"
+
+# 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/bin/stockcli_app

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require './lib/stockcli_app'
+
+StockcliApp::CLI.new.call

data/lib/stockcli_app.rb

@@ -0,0 +1,6 @@
+require_relative './stockcli_app/version'
+require_relative './stockcli_app/cli'
+
+module StockcliApp
+  # Your code goes here...
+end

data/lib/stockcli_app/cli.rb

@@ -0,0 +1,119 @@
+#require_relative "../stockcli_app/scraper.rb"
+require_relative "../stockcli_app/stock.rb"
+require_relative "../stockcli_app/scraper.rb"
+require 'nokogiri'
+require 'pry'
+
+
+class StockcliApp::CLI
+
+# The cli should display 2 options List and quit and accept a valid input
+# if list then display the list of stocks and symbols --> create method called display_list
+# the display_list method should display the stocks and ask the user to enter a valid symbol
+# the display_list method should use the @@all array from the Stock class to display the list of stocks
+# the create_stocks method should us the scraper and stock classes to create instances of stocks
+# The display_additional_info method adds information about the stock that is available through the stock url
+# like index, PE ratio and eps and the output should include basic information about the stock (from)
+# the main web page as well as the information scraped from the stock url
+#
+
+  def create_stocks
+      outer_array = StockcliApp::Scraper.scrape_screener
+      StockcliApp::Stock.create_from_scraper_array(outer_array)
+  end
+
+
+  def display_list
+    puts "   "
+    #binding.pry
+    StockcliApp::Stock.all.each do |stock|
+    puts stock.srno.ljust(5) + stock.symbol.ljust(10) + stock.name.ljust(25) + stock.price.rjust(5)
+    end
+    puts "   "
+  end
+
+  def display_additional_info(stock_symbol)
+    stock = StockcliApp::Stock.all.find {|stock| stock.symbol == stock_symbol}
+    info = StockcliApp::Scraper.scrape_stock_info("https://finviz.com/" + stock.url)    #Scraper.scrape_stock_info(url)
+    stock.add_stock_info(info)
+    puts "#{stock.name} belongs to the #{stock.sector} sector and has a marketcap of #{stock.mktcap.gsub("B"," Billion")}"
+    puts "  "
+    puts "The major index/indices that include(s) it is/are #{stock.index.gsub("DJIA ","DJIA and ")}"
+    puts "  "
+    puts "The Earnings per share is #{stock.eps}"
+    puts "   "
+  end
+
+  def input_for_additional_info
+    puts "Enter a valid symbol for more information or enter 'quit' to return to the main menu"
+    puts "   "
+    valid_symbols = StockcliApp::Stock.all.collect {|stock| stock.symbol}
+    input_symbol = gets.strip
+    if valid_symbols.include? input_symbol.upcase
+    display_additional_info(input_symbol.upcase)
+    elsif input_symbol == "quit"
+    puts "You are returning to the main menu"
+    puts "   "
+    else
+    input_for_additional_info
+    end
+  end
+
+  def display_by_market_cap
+    array = []
+    array = StockcliApp::Stock.all.sort_by {|stock| stock.mktcap}.reverse
+    array.each {|stock| puts stock.name.ljust(25) + stock.mktcap.gsub("B", " Billion").rjust(1)}
+    puts "  "
+  end
+
+  def display_by_vol
+    array = []
+    array = StockcliApp::Stock.all.sort_by {|stock| stock.change.gsub("%","").gsub("-","").to_f}.reverse
+    array.each {|stock| puts stock.name.ljust(25) + stock.change.rjust(2)}
+    puts "  "
+  end
+
+# The call method should
+# (1) Main menu list options : (a) List of stocks (b) Top companies by mkt cap (c) Most volatile stock (d) quit
+  # (a) If the user picks a stock from the list a method to display additional information
+  # about the stock should be called and then go back to the main menu
+  # The symbol entered should be valid?
+# (2) Call the appropriate method after the user makes their choice
+# (3) Print an error message if the option is invalid and list the options again
+
+
+
+  def call
+    create_stocks unless !StockcliApp::Stock.all.empty?
+
+    puts "(a) To view the list of stocks enter --- list"
+    puts "(b) To view the list of companies in desc order of Market cap enter --- mkt"
+    puts "(c) To view the list of stocks in desc order of volatility enter --- vol"
+    puts "(b) To exit the program enter --- 'quit'"
+
+    input_1 = gets.strip
+    if["list", "mkt", "vol", "quit"].include? input_1.downcase
+      if input_1.downcase == "list"
+        display_list
+        input_for_additional_info
+        call
+
+      elsif input_1.downcase == "mkt"
+        display_by_market_cap
+        call
+
+      elsif input_1.downcase == "vol"
+        display_by_vol
+        call
+
+      elsif input_1.downcase == "quit"
+        puts "You have chosen to exit the app"
+      end
+
+    else
+      puts "Please enter a valid option"
+      call
+    end
+  end
+
+end

data/lib/stockcli_app/scraper.rb

@@ -0,0 +1,53 @@
+require 'open-uri'
+require 'pry'
+require 'nokogiri'
+
+# The Scraper class should have two methods
+# The first method should be used to scrape the name, symbol, market cap
+# The first method should return an array with arrays for each stock within it :
+# This should be information collected from the main webpage about the 8 large companies
+# url etc. from the main page for all the stocks
+# The second method should scrape information about the individual stock
+# The second method should scrape the EPS P/E ratio and the Index
+
+class StockcliApp::Scraper
+
+finviz = Nokogiri::HTML(open("https://finviz.com/screener.ashx?v=111&f=cap_mega,exch_nasd"))
+
+  def self.scrape_screener
+    array_main = []
+    finviz = Nokogiri::HTML(open("https://finviz.com/screener.ashx?v=111&f=cap_mega,exch_nasd"))
+    fin = finviz.css("div#screener-content").css("td").css("tr[valign=top]")
+
+    fin.each do |f|
+         temp = []
+
+         num = f.css("td")[0].text
+         symbol = f.css("td")[1].text
+         name = f.css("td")[2].text
+         url = f.css("td")[1].css("a").attribute("href").value
+
+         price = f.css("td")[8].text
+         mktcap = f.css("td")[6].text
+         sector = f.css("td")[3].text
+         change = f.css("td")[9].text
+
+         temp = [num, symbol, name, url, price, mktcap, sector, change]
+         array_main << temp
+       end
+    array_main
+  end
+
+  def self.scrape_stock_info(url)
+    stock_webpage = Nokogiri::HTML(open(url))
+    stock_addinfo_array = []
+    stock = stock_webpage.css("table.snapshot-table2 tr")
+      index = stock.css("td")[1].text
+      peratio = stock.css("td")[3].text
+      eps = stock.css("td")[5].text
+    stock_addinfo_array = [index, peratio, eps]
+  end
+
+
+
+end

data/lib/stockcli_app/stock.rb

@@ -0,0 +1,43 @@
+class StockcliApp::Stock
+
+  attr_accessor :srno, :name, :symbol, :url, :price, :mktcap, :sector, :index, :peratio, :eps, :change
+
+  @@all = []
+
+  # The instances of stocks should be initialized with an array that includes information that was scraped
+  # using the scraper class
+  # The initialized stock should contain information about the Sr no, name, symbol, url and marketcap
+
+  def initialize(array)
+    stock_array = array
+    @srno = stock_array[0]
+    @symbol = stock_array[1]
+    @name = stock_array[2]
+    @url = stock_array[3]
+    @price = stock_array[4]
+    @mktcap = stock_array[5]
+    @sector = stock_array[6]
+    @change = stock_array[7]
+    @@all << self
+  end
+
+  def self.create_from_scraper_array(outer_array)
+    outer_array.each do |inner_array|
+      stock = StockcliApp::Stock.new(inner_array)
+    end
+  end
+
+
+  def self.all
+    @@all
+  end
+
+  def add_stock_info(info)
+    array = info
+    @index = array[0]
+    @peratio = array[1]
+    @eps = array[2]
+  end
+
+
+end

data/lib/stockcli_app/version.rb

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

data/stockcli_app.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "stockcli_app/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "stockcli_app"
+  spec.version       = StockcliApp::VERSION
+  spec.authors       = ["'Anu Khambete'"]
+  spec.email         = ["'anukhambete@gmail.com'"]
+
+  spec.summary       = %q{Stock screener CLI application.}
+  spec.description   = %q{Refer to README.md.}
+  spec.homepage      = "https://finviz.com/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against " \
+  #    "public gem pushes."
+  #end
+
+  # 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        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: stockcli_app
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Anu Khambete'"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-12 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'
+description: Refer to README.md.
+email:
+- "'anukhambete@gmail.com'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/stockcli_app
+- lib/stockcli_app.rb
+- lib/stockcli_app/cli.rb
+- lib/stockcli_app/scraper.rb
+- lib/stockcli_app/stock.rb
+- lib/stockcli_app/version.rb
+- stockcli_app.gemspec
+homepage: https://finviz.com/
+licenses:
+- MIT
+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: Stock screener CLI application.
+test_files: []