stock-gains 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f87b34aaaa2e3acf9123c235b5aff0559fdad122
+  data.tar.gz: 92517ef6a7503405f28ec2dae76fd3a0a812e611
+SHA512:
+  metadata.gz: 25099e9b827fff901b32019a22cb38d20003e45f21c83910b90496bd08e2afff14539d3111d20d88cb17492c5171869c5dfd47b51f2db6c0f8b70f45bba37418
+  data.tar.gz: 58f84499f3832b0faf158b72d54ea0a7c08de3c613559f6c2c49c8f12d301a0e9a2ae9df0144108f017883c270b597014b02ac8d8f5759083af123fa2ec593f1

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in now-playing-cli-gem.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    stock-gains-gem (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    hashdiff (0.2.3)
+    method_source (0.8.2)
+    mini_portile2 (2.0.0)
+    nokogiri (1.6.7)
+      mini_portile2 (~> 2.0.0.rc2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    vcr (2.9.3)
+    webmock (1.22.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  nokogiri
+  pry
+  rake (~> 10.0)
+  rspec
+  stock-gains-gem!
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2015 Frank Nowinski
+
+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,50 @@
+## Stock-Gains-Gem
+
+This Ruby gem uses the Yahoo Finance API to provide three valuable stock market functions for the user. First, it imports the users portoflio from a `CSV` file, calculates each stocks earnings/losses for the day, then returns the total balance your portfolio has earned/lost. Next, it gives the user the option to display generic stock information of any or all of the stocks in their portfolio. Lastly, it allows the user to lookup stock data of any stock(s) of their choosing.  
+
+## Installation
+
+You can install this gem via `gem install stock-gains-gem`. Before you run this app you'll need to set up a `CSV` file containing all of the stocks in your portfolio so they can be imported into the app. Start by cloning the respository to your local computer. Then, on the top-level of the directory, create a file called `portfolio.csv` and insert the stock ticker followed by the quantity of shares you hold for each stock in your portfolio. Be sure to input each stock on a new line and separate the two values by a comma (see the diagram below). Now run `stock-gains` in the CLI to view your gains! 
+
+![](screenshots/portfolio_csv.png)
+
+## Usage
+
+### Today's Gain/Loss
+
+What makes Stock Gains useful is that not only does it compute what each individual stock in your portfolio has earned/lost for that day, it computes the total balance your *portfolio* has earned/lost for that day. These calculations are displayed for the user in the following table:
+
+![](screenshots/portfolio_table.png)
+
+### Stock Information
+
+The user then has the option to view additional stock information regarding any stock in their portfolio. There are four possible entries:
+
+  * Enter `all` to display stock data on all of the stocks in your portfolio
+  * Enter the digit, or digits, corresponding to the stocks you want to look up, separated by a space
+  * Enter `e` to exit the program
+  * Press enter to move onto the next stage 
+
+![](screenshots/portfolio_data.png)
+
+### Stock Lookup
+
+Finally, look up any stock on the market by entering the stock ticker. To view multiple stocks, separate the stock tickers with a space.
+
+![](screenshots/stock_lookup.png)
+
+## Contributing 
+
+1. Fork it!
+2. Create your feature branch: git checkout -b my-new-feature
+3. Commit your changes: git commit -am 'Add some feature'
+4. Push to the branch: git push origin my-new-feature
+5. Submit a pull request :D
+
+## Development 
+
+After checking out the repo, run `bundle exec bin/setup` to install dependencies.
+
+## License 
+
+The gem is available as open source under the terms of the MIT License.

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stock-gains"
+
+# 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.
+
+require "irb"
+IRB.start

data/bin/setup

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

data/bin/stock-gains

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+# require 'stock-gains'
+require_relative '../lib/stock_gains'
+
+StockGains::CLI.new.call

data/lib/stock-gains/cli.rb

@@ -0,0 +1,56 @@
+module StockGains 
+  class StockGains::CLI
+
+    def call
+      StockGains::Portfolio.new.call
+      start
+    end
+
+    def start
+      input = ""
+      begin
+        puts "\nTo view more stock information, enter the number associated with"
+        puts "the stock or enter 'all' to view all of the stocks in your portfolio."
+        puts "Separate digits with a space to view multiple stocks."
+        puts "(Enter 'e' at anytime throughout the program to exit)\n\n"
+        input = gets.strip.scan(/\w+/)
+      end until valid_input?(input) || input.first == "e"
+      
+      if input.first != "e"   
+        input.first == "all" ? find_all : find(input)
+        stock_lookup
+      end
+      puts "\nGoodbye!"
+    end
+
+    def valid_input?(input)
+      input.first == "all" || input.map(&:to_i).all?{ |n| n.between?(1, StockGains::Stock.all.count)}
+    end
+
+    def find_all
+      print_stock_info(StockGains::Stock.all)
+    end
+
+    def find(stock)
+      print_stock_info(stock.map(&:to_i).collect{ |s| StockGains::Stock.all[s-1] })
+    end
+
+    def print_stock_info(stocks)
+      puts "\n"
+      stocks.each do |s|
+        puts "#{s.name}".center(67)
+        puts " " + "-" * 68
+        puts " Asking Price:     $#{s.cur_price}".ljust(37, " ") + "Day's Range:    $#{s.d_range}"
+        puts " Previous Close:   $#{s.prev_close}".ljust(37, " ") + "52 Week Range:  $#{s.y_range}"
+        puts " Open:             $#{s.open}".ljust(37, " ") + "1 Year Target:  $#{s.year_trgt}"
+        puts " P/E Ratio:        $#{s.pe}".ljust(37, " ") + "EPS:            $#{s.eps}"
+        puts " Day's +/-:        $#{s.days_value}".ljust(37, " ") + "Shares:        #{s.shares}"
+        puts "\n\n"
+      end
+    end
+
+    def stock_lookup
+      StockGains::StockLookup.new.call
+    end
+  end
+end

data/lib/stock-gains/portfolio.rb

@@ -0,0 +1,43 @@
+class StockGains::Portfolio
+  attr_accessor :total 
+
+  def initialize
+    @total = 0
+  end
+  
+  def call 
+    list
+    calculate_gains
+    print_gains
+  end
+
+   def list
+    puts "\n"
+    puts "Stocks in Your Portfolio".center(68)
+    puts "\n"
+    puts " Stock Name" + " " * 46 + "Today's +/-"
+    puts " " + "-" * 67
+    StockGains::Stock.all.each.with_index(1) do |stock, i|
+      name = stock.name.ljust(55, " ") 
+      puts " #{i}. #{name} $#{stock.days_value}"
+    end
+    puts 
+  end
+
+  def calculate_gains
+    StockGains::Stock.all.each{ |stock|  @total += stock.days_value } 
+    @total = @total.round(2).to_f
+  end
+
+  def print_gains
+    puts "\n"
+    puts " " * 20 + ":" + "-" * 29 + ":"  
+    puts " " * 20 + "|    TODAY'S #{total > 0 ? "GAIN:" : "LOSS:"} $#{total} #{extra_spaces}|"
+    puts " " * 20 + ":" + "-" * 29 + ":"
+    puts "\n"
+  end
+
+  def extra_spaces
+    " " * (9 - total.to_s.each_char.count)
+  end
+end

data/lib/stock-gains/stock.rb

@@ -0,0 +1,40 @@
+class StockGains::Stock
+  attr_accessor :name, :cur_price, :prev_close, :open, :year_trgt
+  attr_accessor :d_range, :y_range,:days_value, :pe, :eps, :shares
+
+  def initialize(name, cur_price, prev_close, open, year_trgt, d_range, y_range, pe, eps, shares)
+    @name = name
+    @cur_price = cur_price
+    @prev_close = prev_close
+    @open = open
+    @year_trgt = year_trgt
+    @d_range = d_range
+    @y_range = y_range
+    @pe = pe
+    @eps = eps
+    @shares = shares
+    calculate_days_value
+  end
+
+  def self.all 
+    @@all ||= create_stock_from_portfolio
+  end
+
+  def calculate_days_value
+    @days_value = ((cur_price.to_f * shares.to_f) - (prev_close.to_f * shares.to_f)).round(2).to_f 
+  end
+
+  def self.create_stock_from_portfolio
+    CSV.foreach("portfolio.csv").collect do |stock|
+      s = (retrieve_stock(stock) << stock[1]).flatten
+      new(s[0], s[1], s[2], s[3], s[4], s[5], s[6], s[7], s[8], s[9])
+    end
+  end
+
+  def self.retrieve_stock(stock)
+    url = "http://finance.yahoo.com/d/quotes.csv?s=#{stock.first}&f=napot8mwre"
+    open(url) do |csv|
+      CSV.parse(csv).collect{ |row| row }
+    end
+  end
+end

data/lib/stock-gains/stock_lookup.rb

@@ -0,0 +1,26 @@
+class StockGains::StockLookup
+  attr_accessor :tickers
+
+  def initialize
+    @tickers = []
+  end
+
+  def call
+    input = "" 
+    loop do
+      puts "Enter the stock ticker(s) of any stock you'll like to view."
+      puts "Separated stock tickers with a space.\n\n"
+      input = gets.strip.downcase
+      break if input == "e" || input == "exit" || input == ""
+      tickers << input.strip.scan(/\S[a-zA-Z]+/).join("+").upcase
+      StockGains::CLI.new.print_stock_info(retrieve_stock_info(tickers))
+      tickers.clear
+    end
+  end
+
+  def retrieve_stock_info(tickers)
+    StockGains::Stock.retrieve_stock(tickers).collect do |s|
+      StockGains::Stock.new(s[0], s[1], s[2], s[3], s[4], s[5], s[6], s[7], s[8], s[9])
+    end
+  end
+end 

data/lib/stock-gains/version.rb

@@ -0,0 +1,3 @@
+module StockGains
+  VERSION = "0.1.3"
+end

data/lib/stock_gains.rb

@@ -0,0 +1,11 @@
+require 'pry'
+require 'open-uri'
+require 'csv'
+
+require_relative 'stock-gains/cli'
+require_relative 'stock-gains/stock'
+require_relative 'stock-gains/portfolio'
+require_relative 'stock-gains/stock_lookup'
+
+module StockGains
+end

data/portfolio.csv

@@ -0,0 +1,3 @@
+AAPL, 30
+GOOG, 20
+MSFT, 15

data/spec/01_cli_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'StockGains::CLI' do 
+  cli = StockGains::CLI.new
+
+  describe 'instance' do 
+    it 'creates an instance' do 
+      expect(cli).to be_an_instance_of(StockGains::CLI)  
+    end 
+  end
+
+  describe '#valid_input?' do
+    it 'is true when the input is "all"' do
+      expect(cli.valid_input?(["all"])).to be_truthy
+    end 
+
+    it 'is true when the input values are valid' do
+      expect(cli.valid_input?(["1, 2, 3"])).to be_truthy
+    end
+
+    it 'is false when the input is invalid' do 
+      expect(cli.valid_input?(["0"])).to be_falsey
+      expect(cli.valid_input?(["none"])).to be_falsey
+    end
+  end
+end

data/spec/02_portfolio_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'StockGains::Portfolio' do 
+  portfolio = StockGains::Portfolio.new
+
+  describe '#initialize' do 
+    it 'instantiates @total to 0' do
+      expect(portfolio).to respond_to(:total)  
+    end 
+
+    it '@total is set to 0 ' do
+      expect(portfolio.total).to eq(0)  
+    end 
+  end
+end

data/spec/03_stock_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe 'StockGains::Stock' do 
+  apple = StockGains::Stock.new("Apple Inc.", "113.07", "116.17", "114.94", "148.64", "112.85 - 115.39", "92.00 - 134.54", "12.28", "9.22", "30")
+
+  describe '#initialize' do 
+    it 'correctly formats a new stock instance' do 
+      expect(apple.name).to eq("Apple Inc.")
+      expect(apple.cur_price).to eq("113.07")
+      expect(apple.prev_close).to eq("116.17")
+      expect(apple.open).to eq("114.94")
+      expect(apple.year_trgt).to eq("148.64")
+      expect(apple.d_range).to eq("112.85 - 115.39")
+      expect(apple.y_range).to eq("92.00 - 134.54")
+      expect(apple.pe).to eq("12.28")
+      expect(apple.eps).to eq("9.22")
+      expect(apple.shares).to eq("30")
+    end
+  end
+
+  describe '#calculate_days_value' do 
+    it '@days_value is correctly calculated' do 
+      expect(apple.days_value).to eq(-93.0) 
+    end
+  end
+
+  describe '.retrieve_stock' do 
+    it 'retrieves stock values from the Yahoo! Finance API' do 
+      expect(StockGains::Stock.retrieve_stock(["AAPL"])).to match_array([["Apple Inc.", "113.07", "116.17", "114.94", "148.64", "112.85 - 115.39", "92.00 - 134.54", "12.28", "9.22"]])
+    end
+  end
+end

data/spec/04_stock_lookup_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'StockGains::StockLookup' do 
+  stock_lookup = StockGains::StockLookup.new
+
+  describe '#initialize' do 
+    it 'has an attribute to store stock tickers' do
+      expect(stock_lookup.tickers).to match_array([])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require_relative '../lib/stock_gains'
+require 'pry'

data/stock-gains-gem.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stock-gains/version'
+
+Gem::Specification.new do |spec|
+  spec.authors       = ["Frank Nowinski"]
+  spec.email         = ["nowinski.frank@gmail.com"]
+  spec.description   = %q{This Ruby gem uses the Yahoo Finance API to provide three valuable stock market functions for the user. First, it imports the users portoflio from a CSV file, calculates each stocks earnings/losses for the day, then returns the total balance your portfolio has earned/lost. Next, it gives the user the option to display generic stock information of any or all of the stocks in their portfolio. Lastly, it allows the user to lookup stock data of any stock(s) of their choosing (see https://github.com/frankNowinski/stock-gains-gem).}
+  spec.summary       = %q{https://github.com/frankNowinski/stock-gains-gem}
+  spec.homepage      = "https://learn.co"
+
+  spec.files         = `git ls-files`.split($\)
+  spec.executables   = ["stock-gains"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.name          = "stock-gains"
+  spec.require_paths = ["lib", "lib/stock-gains"]
+  spec.version       = StockGains::VERSION
+  spec.license       = "MIT"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: stock-gains
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Frank Nowinski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This Ruby gem uses the Yahoo Finance API to provide three valuable stock
+  market functions for the user. First, it imports the users portoflio from a CSV
+  file, calculates each stocks earnings/losses for the day, then returns the total
+  balance your portfolio has earned/lost. Next, it gives the user the option to display
+  generic stock information of any or all of the stocks in their portfolio. Lastly,
+  it allows the user to lookup stock data of any stock(s) of their choosing (see https://github.com/frankNowinski/stock-gains-gem).
+email:
+- nowinski.frank@gmail.com
+executables:
+- stock-gains
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/stock-gains
+- lib/stock-gains/cli.rb
+- lib/stock-gains/portfolio.rb
+- lib/stock-gains/stock.rb
+- lib/stock-gains/stock_lookup.rb
+- lib/stock-gains/version.rb
+- lib/stock_gains.rb
+- portfolio.csv
+- screenshots/portfolio_csv.png
+- screenshots/portfolio_data.png
+- screenshots/portfolio_table.png
+- screenshots/stock_lookup.png
+- spec/01_cli_spec.rb
+- spec/02_portfolio_spec.rb
+- spec/03_stock_spec.rb
+- spec/04_stock_lookup_spec.rb
+- spec/spec_helper.rb
+- stock-gains-gem-0.1.0.gem
+- stock-gains-gem.gemspec
+homepage: https://learn.co
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/stock-gains
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: https://github.com/frankNowinski/stock-gains-gem
+test_files:
+- spec/01_cli_spec.rb
+- spec/02_portfolio_spec.rb
+- spec/03_stock_spec.rb
+- spec/04_stock_lookup_spec.rb
+- spec/spec_helper.rb
+has_rdoc: