portfolio_stocks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80710f31ff25a31a585ce43341f8c465a763db14
+  data.tar.gz: 8d5fd582950fa0c00ae284c55d1f68d4ca4c861a
+SHA512:
+  metadata.gz: 3193ff31d2a3d18af814e536e3dc91d5006eb72510ca1e10a0d19d691575944d7699cb9a02890a76d421126cb406270eed45e96cf3f98c296cfef8e09f4d33f9
+  data.tar.gz: 37e6e2e4af8fc6b087c84c955f964f6cfe0829ceb37296d2ffac48dd55ab5b535b0ad34c1062b5ac2f499d4af98f984deb46eaf94572ec41da1a84fe845e44c9

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    portfolio_stocks (1.0.0)
+      colored (~> 1.2)
+      stock_quote
+      terminal-table
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colored (1.2)
+    diff-lcs (1.2.5)
+    json (1.8.1)
+    mime-types (2.3)
+    rake (10.3.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.0)
+    rspec-expectations (2.99.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.0)
+    stock_quote (1.1.8)
+      json
+      rest-client (~> 1.6)
+    terminal-table (1.4.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  portfolio_stocks!
+  rake (~> 10.3)
+  rspec (~> 2.14)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tim Davies
+
+MIT License
+
+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,32 @@
+## Portfolio 💰
+
+A command-line tool for managing your stocks.
+
+### Installation
+
+    gem install portfolio_stocks
+
+### Usage
+
+Start watching a stock:
+
+    --watch <stock>
+
+Stop watching a stock:
+
+    --ignore <stock>
+
+Add investment to portfolio:
+
+    --invest <stock> <amount bought> <price paid per stock> <total commission paid>
+
+Remove investment from portfolio:
+
+    --sell <stock>
+
+### Small disclaimer
+
+I'm using this to monitor a few stocks and keep track of a few investments -
+nothing heavy by any means. It has none of the features that a more seasoned
+investor would require but if you just want to keep track of a bit of money,
+hopefully you'll find it useful.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/portfolio

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'portfolio')
+
+# Get the subcommand (and if there isn't one, default to 'show', which displays
+# the portfolio):
+if ARGV.length != 0
+  command = ARGV[0].gsub('--', '')
+else
+  command = "show"
+end
+
+# Initialise commands object which stores the methods for each of the
+# subcommands:
+commands = Portfolio::Commands.new
+
+# Check to see if the subcommand is defined:
+if commands.methods.include? command.to_sym
+  # Execute command:
+  commands.send command
+else
+  # Display usage information:
+  commands.help
+end

data/lib/portfolio.rb

@@ -0,0 +1,10 @@
+require "colored"
+
+require "portfolio/version"
+require "portfolio/store"
+require "portfolio/formatter"
+require "portfolio/stockprices"
+require "portfolio/commands"
+
+module Portfolio
+end

data/lib/portfolio/commands.rb

@@ -0,0 +1,113 @@
+module Portfolio
+  class Commands
+    # Show watched stocks and user portfolio
+    def show
+      # Get list of watched stocks:
+      watched_stocks = Store.instance.watched_stocks
+      
+      # Get stock prices:
+      watched_stocks.map! do |stock|
+        {
+          symbol: stock,
+          price: StockPrices.instance.get_price_formatted(stock),
+        }
+      end
+      
+      # Get portfolio:
+      portfolio = Formatter.instance.format_portfolio(Store.instance.portfolio)
+      
+      # Output watched stock table:
+      Formatter.instance.output_table("Watched Stocks", [:symbol, :price], watched_stocks)
+      
+      # Output portfolio:
+      Formatter.instance.output_table("Portfolio",
+        [:symbol, :current_price, :number_owned, :price_paid, :commission, :profit],
+        portfolio,
+        ['Symbol', 'Current Price', 'Number Owned', 'Price Paid', 'Commission', 'Profit'],
+      )
+    end
+    
+    # Start watching a stock
+    def watch
+      if ARGV.length != 2
+        return help()
+      end
+      
+      watched_stocks = Store.instance.watched_stocks
+      watched_stocks << ARGV[1].upcase
+      
+      Store.instance.watched_stocks = watched_stocks
+    end
+    
+    # Stop watching a stock
+    def ignore
+      if ARGV.length != 2
+        return help()
+      end
+      
+      stock_to_remove = ARGV[1].upcase
+      watched_stocks = Store.instance.watched_stocks
+      watched_stocks.delete stock_to_remove
+      
+      Store.instance.watched_stocks = watched_stocks
+    end
+    
+    def invest
+      if ARGV.length != 5
+        return help()
+      end
+      
+      # Get parameters:
+      stock = ARGV[1]
+      amount_bought = ARGV[2]
+      price_paid = ARGV[3]
+      commission_paid = ARGV[4]
+      
+      # Store new investment:
+      portfolio = Store.instance.portfolio
+      portfolio << {
+        stock: stock,
+        amount_bought: amount_bought,
+        price_paid: price_paid,
+        commission_paid: commission_paid,
+      }
+      Store.instance.portfolio = portfolio
+      
+      # Tell the user that the investment has been logged and wish the user
+      # good luck.
+      puts "Investment in #{stock} logged - good luck!"
+    end
+    
+    # Remove stocks from portfolio
+    # 
+    # FEATURE: Would be nice to be able to have multiple stocks from the same
+    #          company, bought at different times, and be able to pick which one
+    #          you're selling - rather than just automatically selling them all.
+    def sell
+      if ARGV.length != 2
+        return help()
+      end
+      
+      stock_to_remove = ARGV[1].upcase
+      portfolio = Store.instance.portfolio
+      portfolio.reject! do |investment|
+        investment['stock'].upcase == stock_to_remove
+      end
+      
+      Store.instance.portfolio = portfolio
+    end
+    
+    # Show usage information
+    def help
+      puts "Portfolio, v#{Portfolio::VERSION}. Commands:\n".bold.underline
+      puts "Start watching a stock:".blue
+      puts "  " + "--watch <stock>\n".underline
+      puts "Stop watching a stock:".blue
+      puts "  " + "--ignore <stock>\n".underline
+      puts "Add investment to portfolio:".blue
+      puts "  " + "--invest <stock> <amount bought> <price paid per stock> <total commission paid>\n".underline
+      puts "Remove investment from portfolio:".blue
+      puts "  " + "--sell <stock>\n".underline
+    end
+  end
+end

data/lib/portfolio/formatter.rb

@@ -0,0 +1,63 @@
+require 'singleton'
+require 'terminal-table'
+
+module Portfolio
+  class Formatter
+    include Singleton
+    
+    def output_table(title, columns, data, headings = nil)
+      # Format data correctly for table:
+      data.map! do |row|
+        new_row = []
+        
+        columns.each do |col|
+          new_row << row[col]
+        end
+        
+        new_row
+      end
+      
+      # Create table with headings if some are passed in (or without if nil):
+      if headings.nil?
+        table = Terminal::Table.new(rows: data, title: title)
+      else
+        table = Terminal::Table.new(rows: data, title: title, headings: headings)
+      end
+      
+      # Output table:
+      puts table
+    end
+    
+    def format_portfolio(portfolio)
+      portfolio.map! do |investment|
+        # Work out price paid, value, current stock price and profit for
+        # this investment:
+        symbol = investment['stock']
+        current_price = StockPrices.instance.get_stock(symbol).ask
+        total_paid = (investment['amount_bought'].to_f * investment['price_paid'].to_f) + investment['commission_paid'].to_f
+        total_value = investment['amount_bought'].to_f * current_price
+        profit = (total_value - total_paid).round(2)
+        
+        # If profit is negative, highlight as red:
+        if profit < 0.00
+          profit = profit.to_s.red
+        # If profit is positive, highlight as green:
+        elsif profit > 0.00
+          profit = profit.to_s.green
+        # Otherwise, don't highlight it - no profit or loss:
+        else
+          profit = profit.to_s
+        end
+        
+        {
+          symbol: symbol,
+          current_price: current_price,
+          number_owned: investment['amount_bought'],
+          price_paid: investment['price_paid'],
+          commission: investment['commission_paid'],
+          profit: profit,
+        }
+      end
+    end
+  end
+end

data/lib/portfolio/stockprices.rb

@@ -0,0 +1,36 @@
+require 'singleton'
+require 'stock_quote'
+
+module Portfolio
+  class StockPrices
+    include Singleton
+    
+    def get_stock(symbol)
+      StockQuote::Stock.quote(symbol)
+    end
+    
+    def get_price_formatted(symbol)
+      # Lookup stock price:
+      stock = get_stock(symbol)
+      
+      # If the response code isn't 200, something went wrong:
+      if stock.response_code != 200
+        "ERROR".red
+      else
+        # Get the current stock price:
+        price = stock.ask.to_s
+        
+        # If it's up, show it in green:
+        if stock.change > 0.0
+          price.green
+        # If it's down, show it in red:
+        elsif stock.change < 0.0
+          return price.red
+        # Otherwise, show it normally:
+        else
+          price
+        end
+      end
+    end
+  end
+end

data/lib/portfolio/store.rb

@@ -0,0 +1,72 @@
+require 'singleton'
+require 'json'
+
+module Portfolio
+  class Store
+    include Singleton
+    
+    def watched_stocks
+      datastore = get_datastore
+      datastore['watched_stocks']
+    end
+    
+    def watched_stocks=(watched_stocks)
+      data = get_datastore()
+      data['watched_stocks'] = watched_stocks
+      save_datastore(data)
+    end
+    
+    def portfolio
+      datastore = get_datastore
+      datastore['portfolio']
+    end
+    
+    def portfolio=(portfolio)
+      data = get_datastore()
+      data['portfolio'] = portfolio
+      save_datastore(data)
+    end
+    
+    protected
+    
+    def get_datastore
+      if @datastore
+        @datastore
+      else
+        begin
+          datastore_file_str = File.read(datastore_location)
+          @datastore = JSON.parse(datastore_file_str)
+        rescue
+          create_datastore
+          get_datastore
+        end
+      end
+    end
+    
+    def save_datastore(data)
+      File.open(datastore_location, 'w') do |f|
+        f.write(data.to_json)
+      end
+    end
+    
+    def datastore_location
+      File.expand_path('~/.portfolio/datastore.json')
+    end
+    
+    def create_datastore
+      begin
+        Dir.mkdir File.expand_path('~/.portfolio')
+      rescue
+      end
+      
+      File.open(datastore_location, 'w') do |f|
+        datastore_hash = {
+          watched_stocks: [],
+          portfolio: [],
+        }
+        
+        f.write(datastore_hash.to_json)
+      end
+    end
+  end
+end

data/lib/portfolio/version.rb

@@ -0,0 +1,3 @@
+module Portfolio
+  VERSION = '1.0.0'
+end

data/portfolio.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'portfolio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "portfolio_stocks"
+  spec.version       = Portfolio::VERSION
+  spec.authors       = ["Tim Davies"]
+  spec.email         = ["mail@timdavi.es"]
+  spec.summary       = %q{A simple command-line tool for managing your stock portfolio}
+  spec.description   = <<-DESC
+                       A simple command-line tool for managing your stock portfolio,
+                       tracking your investments and watching stock prices.
+                       DESC
+  spec.homepage      = "https://github.com/timdavies/Portfolio"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f =~ /docs\// }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  
+  spec.add_dependency "colored", "~> 1.2"
+  spec.add_dependency "terminal-table"
+  spec.add_dependency "stock_quote"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: portfolio_stocks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Davies
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stock_quote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+                         A simple command-line tool for managing your stock portfolio,
+                         tracking your investments and watching stock prices.
+email:
+- mail@timdavi.es
+executables:
+- portfolio
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/portfolio
+- lib/portfolio.rb
+- lib/portfolio/commands.rb
+- lib/portfolio/formatter.rb
+- lib/portfolio/stockprices.rb
+- lib/portfolio/store.rb
+- lib/portfolio/version.rb
+- portfolio.gemspec
+homepage: https://github.com/timdavies/Portfolio
+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.1.10
+signing_key: 
+specification_version: 4
+summary: A simple command-line tool for managing your stock portfolio
+test_files: []