qticker 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 494c931926f1f8c3f6192e66db4a075a35a56198
-  data.tar.gz: b2f124d4e050d554f5681108b28e0f62ce82424f
+  metadata.gz: 0745f12aa2f16c3d7ea823422960cfe8ba8890dd
+  data.tar.gz: 8c708da85dab21449ba719530a3b1588ff9cf60a
 SHA512:
-  metadata.gz: 67182ffe4f96c7427ac6822a603e2884786859dcd8c27074d35d2a2b0acbe13a78647cce4d052a48f1ad8458a795aae55dc06ab864ce336601b01831c783ba93
-  data.tar.gz: 2e0286a1c602d99806552cad09ead288e5d4387fc9f0c1722b4d94de2f2f677e514fea9532d4a3cf84425344f0679b553603071f9b0edffafc9cbfd2e9d930aa
+  metadata.gz: 7ac5910a40bd4729b4348a5b1fcb01f73265eaddf64720a61fe9c5377d1d251eb0183fc72493f2f58e7c82f2744a5904c2d6f3d02694804aba8a6454ecc4b56d
+  data.tar.gz: a4693099fd176c612cb0a67185ea8806cc251fd0472595db88d967d10c44fa6f1f873f66bf0daa3a80ace63b9cdd8ad393302dfcbe472cc804c63ccde04933af

data/bin/qticker

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
-require_relative '../config/environment.rb'
+require_relative '../lib/qticker.rb'
 
-cli = MainCli.new
-
-cli.welcome("Quick Ticker", -> {cli.ticker_symbol_prompt})
+cli = QuickTicker::MainCli.new
+cli.welcome("Quick Ticker", -> {cli.ticker_symbol_prompt})

data/lib/cli.rb

@@ -1,51 +1,108 @@
-class Cli
+module QuickTicker
 
-	attr_accessor :stock, :scraper
+	class Cli
 
-	def initialize(cli = nil)
-		self.scraper = Scraper.new(self)
-	end
+		attr_accessor :stock, :scraper, :last_option_lambda, :exit_message
 
-	def welcome(mode_name, mode_lambda)
-		print "\nWelcome to " + mode_name + "!\n"
-		mode_lambda.()
-	end
+		def initialize(cli = nil)
+			self.scraper = QuickTicker::Scraper.new(self)
+		end
 
-	def display_quote
-		self.stock.display
-		self.stock.quote.display
-		self.stock_option_menu("Display a company description", -> { self.display_desc })
-	end
+		def welcome(mode_name, mode_lambda)
+			print "\nWelcome to " + mode_name + "!\n"
+			mode_lambda.()
+		end
 
-	def display_desc
-		self.stock.display
-		self.stock.desc.display
-		self.stock_option_menu("Redisplay your quote", -> { self.display_quote })
-	end
+		def display_stock_header
+			print "\n#{self.stock.name} (#{self.stock.exchange}:#{self.stock.symbol})\n\n"
+		end
 
-	def stock_option_menu(opt_1_string, opt_1_lambda = nil)
-		gets
-		puts "1. #{opt_1_string} for #{self.stock.symbol}."
-		puts "2. Enter another ticker symbol."
-		puts "Enter any other key to exit."
-		gets.strip.gsub('.', '')
-	end
+		def display_stock_quote
+			puts "Current:  #{self.stock.quote.price} #{stock.quote.change}(#{stock.quote.change_pct}%)"
+			puts "Open:     #{self.stock.quote.open}"
+			puts "Volume:   #{self.stock.quote.volume}"
+			puts "Avg Vol:  #{self.stock.quote.volume_avg}"
+			puts "Mkt Cap:  #{self.stock.quote.mkt_cap}"
+			puts "P/E(ttm): #{self.stock.quote.pe_ttm}"
+			puts "Yield:    #{self.stock.quote.div_yld}%"
+		end
 
-	def symbol_validation(symbol, valid, fixture_url = nil)
-		# stock_array[0] is a stock if one was succesfully created and nil otherwise.
-		# stock_array[1] indicates whether the symbol cooresponds to a mutual fund.
-		stock_array = self.scraper.load_gfs(symbol, fixture_url)
-		self.stock = stock_array[0]
-		valid = self.stock.nil? ? false : true
-		puts "Invalid ticker symbol." if !valid
-		puts "Mutual funds are not currently not supported." if stock_array[1]
-		self.display_quote if valid
-		# returns an array.
-		# array[0] - whether the entered symbol was valid
-		# array[1] = stock_array[1] - whether the entered
-		# symbol was a mutal fund.
-		[valid, stock_array[1]]
-	end
+		def display_stock_description
+			print "#{self.stock.description.sector} : #{self.stock.description.industry}\n\n"
+			puts "#{self.stock.description.summary}".fit
+		end
+
+		def display_stock_related_companies
+			output = "Symbol  Price                   Mkt Cap\n"
+			self.stock.related_companies.each do |stock_related_company|
+				output += (stock_related_company.symbol + ' ' * 8)[0,8]
+				output += (stock_related_company.price + ' ' * 8)[0,8]
+				output += ("#{stock_related_company.change}(#{stock_related_company.change_pct}%)" + ' ' * 16)[0,16]
+				output += stock_related_company.mkt_cap + "\n"
+			end
+			puts output
+		end
+
+		def fetch_stock_quote
+			self.display_stock_header
+			self.display_stock_quote
+			self.call_stock_option_menu({ option_1_string: "Display a company description", option_2_string: "Display related companies", option_1_lambda: -> { self.fetch_stock_description }, option_2_lambda: -> { self.fetch_stock_related_companies }, last_option_lambda: -> {self.last_option_lambda.()} })
+		end
 
+		def fetch_stock_description
+			self.display_stock_header
+			self.display_stock_description
+			self.call_stock_option_menu({ option_1_string: "Display a quote", option_2_string: "Display related companies", option_1_lambda: -> { self.fetch_stock_quote }, option_2_lambda: -> { self.fetch_stock_related_companies }, last_option_lambda: -> {self.last_option_lambda.()} })
+		end
+
+		def fetch_stock_related_companies
+			self.display_stock_header
+			self.display_stock_related_companies
+			self.call_stock_option_menu({ option_1_string: "Display a quote", option_2_string: "Display a company description", option_1_lambda: -> { self.fetch_stock_quote }, option_2_lambda: -> { self.fetch_stock_description }, last_option_lambda: -> {self.last_option_lambda.()} })
+		end
+
+		def call_stock_option_menu(option_hash)
+			process_stock_option_menu_input(display_stock_option_menu(option_hash[:option_1_string], option_hash[:option_2_string]), option_hash[:option_1_lambda], option_hash[:option_2_lambda], option_hash[:last_option_lambda])
+		end
+
+		def display_stock_option_menu(option_1_string, option_2_string)
+			gets
+			puts "1. #{option_1_string} for #{self.stock.symbol}."
+			puts "2. #{option_2_string} for #{self.stock.symbol}."
+			puts "3. Enter another ticker symbol."
+			puts "Enter any other key to exit."
+			gets.strip.gsub('.', '')
+		end
+
+		def process_stock_option_menu_input(input, option_1_lambda, option_2_lambda, option_3_lambda)
+			if input == "1"
+				option_1_lambda.()
+			elsif input == "2"
+				option_2_lambda.()
+			elsif input == "3"
+				option_3_lambda.()
+			else
+				puts self.exit_message
+				return nil
+			end
+		end
+
+		def symbol_validation(symbol, fixture_url = nil)
+			# stock_array[0] is a stock if one was succesfully created and nil otherwise.
+			# stock_array[1] indicates whether the symbol cooresponds to a mutual fund.
+			stock_array = self.scraper.load_gfs(symbol, fixture_url)
+			self.stock = stock_array[0]
+			valid = self.stock.nil? ? false : true
+			puts "Invalid ticker symbol." if !valid
+			puts "Mutual funds are not currently not supported." if stock_array[1]
+			self.fetch_stock_quote if valid
+			# returns an array.
+			# array[0] - whether the entered symbol was valid
+			# array[1] = stock_array[1] - whether the entered
+			# symbol was a mutal fund.
+			[valid, stock_array[1]]
+		end
+
+	end
 
 end

data/lib/dev_cli.rb

@@ -1,58 +1,54 @@
-class DevCli < Cli
+module QuickTicker
 
-	attr_accessor :main
+	class DevCli < QuickTicker::Cli
 
-	def initialize(main_cli)
-		super(main_cli)
-		self.main = main_cli
-	end
+		attr_accessor :main
 
-	def option_menu
-		puts "\nPlease select a fixture to load:"
-		puts "1. Load MSFT.html"
-		puts "2. Load IBM.html"
-		puts "3. Load QQQ.html"
-		puts "4. Load FBIOX.html"
-		puts "Or enter any other key to return to"
-		puts "your regularly scheduled program."
-		input = gets.strip.gsub('.', '')
-		path = File.expand_path(File.dirname(__FILE__)).chomp('bin') + '/fixtures/'
-		if input == "1"
-			valid = self.symbol_validation("MSFT", false, path + "MSFT.html")
-		elsif input == "2"
-			valid = self.symbol_validation("IBM", false, path + "IBM.html")
-		elsif input == "3"
-			valid = self.symbol_validation("QQQ", false, path + "QQQ.html")
-		elsif input == "4"
-			valid = self.symbol_validation("FBIOX", false, path + "FBIOX.html")
-		else
-			puts "Leaving Developer Mode and resuming program."
+		def initialize(main_cli)
+			super(main_cli)
+			self.main = main_cli
+			self.last_option_lambda = -> { self.call_dev_option_menu }
+			self.exit_message = "Leaving Developer Mode and resuming program."
 		end
-		return nil
-	end
 
-	def stock_option_menu(opt_1_string, opt_1_lambda)
-		input = super(opt_1_string, opt_1_lambda)
-		if input == "1"
-			opt_1_lambda.()
-		elsif input == "2"
-			self.option_menu
-		else
-			puts "Leaving Developer Mode and resuming program."
-			return nil
+		def call_dev_option_menu 
+			process_dev_option_menu_input(display_dev_option_menu)
 		end
-	end
 
-	def symbol_validation(symbol, valid, fixture_url = nil)
-		valid_array = super(symbol, valid, fixture_url)
-		if valid_array[1] # whether entered symbol was a mutual fund
-			puts ""
-			option_menu
+		def display_dev_option_menu
+			puts "\nPlease select a fixture to load:"
+			puts "1. Load MSFT.html"
+			puts "2. Load IBM.html"
+			puts "3. Load QQQ.html"
+			puts "4. Load FBIOX.html"
+			puts "Or enter any other key to return to"
+			puts "your regularly scheduled program."
+			gets.strip.gsub('.', '')
 		end
-		valid_array[0] # returns whether entered symbol was valid
-	end
 
+		def process_dev_option_menu_input(input)
+			if input == "1"
+				valid = self.symbol_validation("MSFT", "http://lair001.github.io/fixtures/qticker/MSFT.html")
+			elsif input == "2"
+				valid = self.symbol_validation("IBM", "http://lair001.github.io/fixtures/qticker/IBM.html")
+			elsif input == "3"
+				valid = self.symbol_validation("QQQ", "http://lair001.github.io/fixtures/qticker/QQQ.html")
+			elsif input == "4"
+				valid = self.symbol_validation("FBIOX", "http://lair001.github.io/fixtures/qticker/FBIOX.html")
+			else
+				puts self.exit_message
+			end
+			return nil
+		end
 
+		def symbol_validation(symbol, fixture_url = nil)
+			valid_array = super(symbol, fixture_url)
+			if valid_array[1] # whether entered symbol was a mutual fund
+				call_dev_option_menu
+			end
+			valid_array[0] # returns whether entered symbol was valid
+		end
 
+	end
 
 end

data/lib/main_cli.rb

@@ -1,39 +1,34 @@
-class MainCli < Cli
+module QuickTicker
 
-	attr_accessor :scraper, :dev
+	class MainCli < QuickTicker::Cli
 
-	def initialize(cli = nil)
-		super(cli)
-		self.dev = DevCli.new(self)
-	end
+		attr_accessor :dev
+
+		def initialize(cli = nil)
+			super(cli)
+			self.dev = QuickTicker::DevCli.new(self)
+			self.last_option_lambda = -> { self.ticker_symbol_prompt }
+			self.exit_message = "Thank you for using Quick Ticker!"
+		end
 
 
-	def ticker_symbol_prompt
-		valid = false
-		while !valid do
-			print "\nPlease enter a ticker symbol: "
-			symbol = gets.strip.upcase
-			if symbol == "DEV"
-				self.welcome("Developer Mode", -> {self.dev.option_menu}) if symbol == "DEV"
-			else
-				valid = self.symbol_validation(symbol, valid)
+		def ticker_symbol_prompt
+			valid = false
+			while !valid do
+				print "\nPlease enter a ticker symbol: "
+				symbol = gets.strip.upcase
+				if symbol == "DEV"
+					self.dev.welcome("Developer Mode", -> {self.dev.call_dev_option_menu}) if symbol == "DEV"
+				else
+					valid = self.symbol_validation(symbol)
+				end
 			end
 		end
-	end
 
-	def stock_option_menu(opt_1_string, opt_1_lambda)
-		input = super(opt_1_string, opt_1_lambda)
-		if input == "1"
-			opt_1_lambda.()
-		elsif input == "2"
-			self.ticker_symbol_prompt
-		else
-			return nil
+		def symbol_validation(symbol, fixture_url = nil)
+			super(symbol)[0] # returns whether entered symbol was valid
 		end
-	end
 
-	def symbol_validation(symbol, valid, fixture_url = nil)
-		super(symbol, valid)[0] # returns whether entered symbol was valid
 	end
 
-end
+end

data/lib/qticker.rb

@@ -1 +1,16 @@
-require_relative '../config/environment.rb'
+require 'nokogiri'
+require 'word_wrap'
+require 'word_wrap/core_ext'
+require 'watir'
+require 'phantomjs'
+
+require_relative '../lib/cli.rb'
+require_relative '../lib/table.rb'
+require_relative '../lib/stock_attribute.rb'
+require_relative '../lib/stock_description.rb'
+require_relative '../lib/dev_cli.rb'
+require_relative '../lib/main_cli.rb'
+require_relative '../lib/stock_quote.rb'
+require_relative '../lib/stock_related_company.rb'
+require_relative '../lib/scraper.rb'
+require_relative '../lib/stock.rb'

data/lib/scraper.rb

@@ -1,82 +1,114 @@
-class Scraper
+module QuickTicker
 
-	attr_accessor :cli, :gfs_noko_html, :stock
+	class Scraper
 
-	def initialize(cli)
-		self.cli = cli
-	end
+		attr_accessor :browser, :cli, :gfs_noko_html, :stock
 
-	def gfs_url(symbol)
-		"https://www.google.com/finance?q=" + symbol
-	end
+		def initialize(cli)
+			self.cli = cli
+			self.browser = Watir::Browser.new(:phantomjs)
+		end
 
-	def load_gfs_noko_html(url)
-		self.gfs_noko_html = Nokogiri::HTML(open(url))
-	end
+		def gfs_url(symbol)
+			"https://www.google.com/finance?q=" + symbol
+		end
 
-	# Returns an array. Array[0] is a stock if one was succesfully created and nil otherwise.
-	# Array[1] indicates whether the symbol cooresponds to a mutual fund.
-	def load_gfs(symbol, fixture_url = nil)
-		fixture_url.nil? ? load_gfs_noko_html(self.gfs_url(symbol)) : load_gfs_noko_html(fixture_url)
-		return [nil, true] unless self.gfs_noko_html.text.match('\(MUTF:').nil?
-		return [nil, false] if self.gfs_noko_html.css("span.pr").text.strip == "" # checks whether the page lists a price
-	#	return [nil, false] if self.gfs_noko_html.css("div.fjfe-content").text.include?("- produced no matches.")
-		[self.create_stock(symbol), false]
-	end
+		def load_gfs_noko_html(url)
+			browser.goto(url)
+			self.gfs_noko_html = Nokogiri::HTML(browser.html)
+		end
 
-	def create_stock(symbol)
-		data = scrape_stock(symbol)
-		Stock.new(data)
-	end
+		# Returns an array. Array[0] is a stock if one was succesfully created and nil otherwise.
+		# Array[1] indicates whether the symbol cooresponds to a mutual fund.
+		def load_gfs(symbol, fixture_url = nil)
+			fixture_url.nil? ? load_gfs_noko_html(self.gfs_url(symbol)) : load_gfs_noko_html(fixture_url)
+			return [nil, true] unless self.gfs_noko_html.text.match('\(MUTF:').nil?
+			return [nil, false] if self.gfs_noko_html.css("span.pr").text.strip == "" # checks whether the page lists a price
+		#	return [nil, false] if self.gfs_noko_html.css("div.fjfe-content").text.include?("- produced no matches.")
+			[self.create_stock(symbol), false]
+		end
 
-	def scrape_stock(symbol)
-		data = { stock: {} }
-		data[:stock][:symbol] = symbol
-		begin
-			data[:stock][:name] = self.gfs_noko_html.css("div.g-first a").text.match('(?<=All news for )[\w,.)() ]*(?= »)')[0]
-		rescue NoMethodError
-			data[:stock][:name] = ""
+		def create_stock(symbol)
+			data = package_stock(symbol)
+			QuickTicker::Stock.new(data)
 		end
-		data[:stock][:exchange] = self.gfs_noko_html.css("span.dis-large").text.split("\n")[0]
-		data[:stock] = self.nil_to_empty_str(data[:stock])
-		data[:quote] = self.scrape_quote
-		data[:desc] = self.scrape_desc
-		data
-	end
 
-	def scrape_quote
-		data = {}
-		data[:price] = self.gfs_noko_html.css("span.pr").text.strip
-		data[:change] = self.gfs_noko_html.css("div.nwp span.bld").text.split("\n")[0]
-		begin
-			data[:change_pct] = self.gfs_noko_html.css("div.nwp span.bld").text.split("\n")[1].gsub(/[)(]/, '')
-		rescue NoMethodError
-			data[:change_pct] = ""
+		def package_stock(symbol)
+			data = {}
+			data[:stock] = self.scrape_stock(symbol)
+			data[:quote] = self.scrape_stock_quote
+			data[:description] = self.scrape_stock_description
+			data[:related_companies] = self.scrape_stock_related_companies
+			data
 		end
-		data[:range] = self.gfs_noko_html.css("td[data-snapfield='range']+td").text.strip
-		data[:range_yr] = self.gfs_noko_html.css("td[data-snapfield='range_52week']+td").text.strip
-		data[:open] = self.gfs_noko_html.css("td[data-snapfield='open']+td").text.strip
-		data[:volume] = self.gfs_noko_html.css("td[data-snapfield='vol_and_avg']+td").text.strip.split("/")[0]
-		data[:volume_avg] = self.gfs_noko_html.css("td[data-snapfield='vol_and_avg']+td").text.strip.split("/")[1]
-		data[:mkt_cap] = self.gfs_noko_html.css("td[data-snapfield='market_cap']+td").text.strip
-		data[:pe_ttm] = self.gfs_noko_html.css("td[data-snapfield='pe_ratio']+td").text.strip
-		data[:div_yld] = self.gfs_noko_html.css("td[data-snapfield='latest_dividend-dividend_yield']+td").text.strip.split("/")[1]
-		nil_to_empty_str(data)
-	end
 
-	def scrape_desc
-		data = {}
-		data[:sector] = self.gfs_noko_html.css("a#sector").text
-		data[:industry] = self.gfs_noko_html.css("a#sector+a").text
-		data[:summary] = self.gfs_noko_html.css("div.companySummary").text.gsub("More from Reuters »", "").strip
-		nil_to_empty_str(data)
-	end
+		def scrape_stock(symbol)
+			data = {}
+			data[:symbol] = symbol
+			begin
+				data[:name] = self.gfs_noko_html.css("div.g-first a").text.match('(?<=All news for )[\w,.)() ]*(?= »)')[0]
+			rescue NoMethodError
+				data[:name] = ""
+			end
+			data[:exchange] = self.gfs_noko_html.css("span.dis-large").text.split("\n")[0]
+			nil_to_empty_str(data)
+		end
+
+		def scrape_stock_quote
+			data = {}
+			data[:price] = self.gfs_noko_html.css("span.pr").text.strip
+			data[:change] = self.gfs_noko_html.css("div.nwp span.bld").text.split("\n")[0]
+			begin
+				data[:change_pct] = self.gfs_noko_html.css("div.nwp span.bld").text.split("\n")[1].gsub(/[)(]/, '').chomp("%")
+			rescue NoMethodError
+				data[:change_pct] = ""
+			end
+			data[:range] = self.gfs_noko_html.css("td[data-snapfield='range']+td").text.strip
+			data[:range_yr] = self.gfs_noko_html.css("td[data-snapfield='range_52week']+td").text.strip
+			data[:open] = self.gfs_noko_html.css("td[data-snapfield='open']+td").text.strip
+			data[:volume] = self.gfs_noko_html.css("td[data-snapfield='vol_and_avg']+td").text.strip.split("/")[0]
+			data[:volume_avg] = self.gfs_noko_html.css("td[data-snapfield='vol_and_avg']+td").text.strip.split("/")[1]
+			data[:mkt_cap] = self.gfs_noko_html.css("td[data-snapfield='market_cap']+td").text.strip
+			data[:pe_ttm] = self.gfs_noko_html.css("td[data-snapfield='pe_ratio']+td").text.strip
+			data[:div_yld] = self.gfs_noko_html.css("td[data-snapfield='latest_dividend-dividend_yield']+td").text.strip.split("/")[1]
+			nil_to_empty_str(data)
+		end
 
-	# convert any nil values to empty strings to avoid exceptions
-	def nil_to_empty_str(data_hash)
-		data_hash.each do |key, value|
-			data_hash[key] = "" if data_hash[key].nil?
+		def scrape_stock_description
+			data = {}
+			data[:sector] = self.gfs_noko_html.css("a#sector").text
+			data[:industry] = self.gfs_noko_html.css("a#sector+a").text
+			data[:summary] = self.gfs_noko_html.css("div.companySummary").text.gsub("More from Reuters »", "").strip
+			nil_to_empty_str(data)
 		end
+
+		def scrape_stock_related_companies 
+			data = []
+			for i in (0..10) do
+				begin
+					data << {
+						symbol: self.gfs_noko_html.css("table#cc-table td.ctsymbol")[i].text,
+						price: self.gfs_noko_html.css("table#cc-table td.ctsymbol+td+td")[i].text,
+						change: self.gfs_noko_html.css("table#cc-table td.ctsymbol+td+td+td")[i].text,
+						change_pct: self.gfs_noko_html.css("table#cc-table td.ctsymbol+td+td+td+td")[i].text.chomp("%"),
+						mkt_cap: self.gfs_noko_html.css("table#cc-table td.ctsymbol+td+td+td+td+td+td")[i].text
+					}
+				rescue NoMethodError
+					i = 11
+				end
+			end
+			data.collect do |related_company_hash|
+				nil_to_empty_str(related_company_hash)
+			end
+		end
+
+		# convert any nil values to empty strings to avoid exceptions
+		def nil_to_empty_str(data_hash)
+			data_hash.each do |key, value|
+				data_hash[key] = "" if data_hash[key].nil?
+			end
+		end
+
 	end
 
 end