stock_quote_cli 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac4ef8b3d44d215e90402941e4c6c337c395bc91
-  data.tar.gz: 7bc9fcc4834be7becea81c19e7bcf9f46a039e2d
+  metadata.gz: c2f026e810d56e1c1a4569ae66aeb3c7f213b4ad
+  data.tar.gz: 3d9e0f96f63cce57cdb204bf777a7aa876ce6da6
 SHA512:
-  metadata.gz: 5e0387c82dafb2a3a9de3750e6db88f7febc155038520e2e4f2bcce905b181af93cb9a24987cd4be8342582a938cad821b2fbad418d7075d1ff049b4ca80e29c
-  data.tar.gz: 91d75279c38572fa1d8b2c68929bb5a30137c539a2143878a5da5a9fc51be7410d724f609bcacb1c5496841fa65c7cd1e054358a42a73f417fd13e7b5c33fad7
+  metadata.gz: 9c066ddaf42915093992312c1e195e40d909747b439603e09b01330cde76659f6938e91ee5550542e24733657098864e5aced7d32345c0b7609cb403c30483a4
+  data.tar.gz: 354bf7d6f24d5cf8362c888c0ab56a5c207ac0d693a18b7e91c0f4958aa6e55159b158dea7b30754cd4a57bf60215a8f496613e95f1eb8c25248f9bd66e61826

data/.rspec

@@ -1 +1 @@
---color
+--color --format documentation

data/README.md

@@ -1,13 +1,10 @@
-Stock Quote CLI
-===============
+## Stock Quote CLI
 
 [![Build Status](https://travis-ci.org/tbloncar/stock_quote_cli.png?branch=master)](https://travis-ci.org/tbloncar/stock_quote_cli)
 
-### Description
-
 Stock Quote CLI is a Ruby gem that provides a command-line interface for fetching stock information from Yahoo!. It relies on the [stock_quote gem](https://github.com/tyrauber/stock_quote) for fetching real-time and historical data.
 
-![Example](https://raw.githubusercontent.com/tbloncar/stock_quote_cli/master/example.png)
+![Demo](https://raw.githubusercontent.com/tbloncar/stock_quote_cli/master/demo.gif)
 
 Update: Due to Google's sunsetting of iGoogle (and the associated endpoint from
 which the stock_quote gem once fetched its data), the stock_quote gem has moved
@@ -16,11 +13,13 @@ the awesomely quick changes.
 
 ### Installation
 
-Build passes with `ruby-2.0.0-p247`. With Ruby installed, run the following:
+With Ruby installed, run the following:
 
-	gem install stock_quote_cli
+```
+gem install stock_quote_cli
+```
 
-### Usage Details
+### Usage
 
 You can use Stock Quote CLI to fetch real-time attributes of multiple stocks. Use the `stock` command in tandem with any of the available subcommands and stock symbols to fetch the relevant attribute(s).
 
@@ -28,41 +27,55 @@ You can use Stock Quote CLI to fetch real-time attributes of multiple stocks. Us
 
 Get the latest price for the specified stock(s).
 
-	stock last goog yhoo aapl
+```
+stock last goog yhoo aapl
+```
 
 #### Open Price
 
 Get the opening price for the specified stock(s) on the current day (or last trading day).
 
-	stock open znga
+```
+stock open znga
+```
 
 #### Previous Closing Price
 
 Get the closing price for the specified stock(s) on the previous trading day.
 
-	stock yclose amzn nflx
+```
+stock yclose amzn nflx
+```
 
 #### High Price
 
 Get the high price for the specified stock(s) on the current day (or last trading day).
 
-	stock high lnkd
+```
+stock high lnkd
+```
 
 #### Low Price
 
 Get the low price for the specified stock(s) on the current day (or last trading day).
 
-	stock low msft dell
+```
+stock low msft dell
+```
 
 #### Historical Data
 
 Get historical data for a single stock. The default range is 14 days. The default value is the closing price. These can be specified using the `range` (aliased to `-r`) and `value` (aliased to `-v`) options, respectively.
 
-	stock history fb
+```
+stock history fb
+```
 
 The `range` (`-r`) option takes an integer. Use this to specify the number of trading days for which you'd like data.
 
-	stock history -r 15 fb
+```
+stock history -r 15 fb
+```
 
 The `value` (`-v`) option takes a string. Use this to specify the price value that you'd like to see in the output. You can choose from the following:
 
@@ -74,11 +87,13 @@ The `value` (`-v`) option takes a string. Use this to specify the price value th
 
 Below, we fetch the high price for the Facebook stock for the past 15 days.
 
-	stock history -r 15 -v high fb
+```
+stock history -r 15 -v high fb
+```
 
 ### License
 
-Copyright (c) 2015 Travis Loncar
+Copyright (c) 2016 Travis Loncar
 
 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:

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/lib/stock_quote_cli.rb

@@ -1,18 +1,4 @@
-require "stock_quote_cli/cli"
-
-module StockQuoteCLI
-  class TextHelpers
-    class << self
-      # color methods from https://github.com/pierot/stockery/blob/master/lib/stockery.rb
-      def red(str); color(str, "\e[31m"); end
-      def green(str); color(str, "\e[1m\e[32m"); end
-      def yellow(str); color(str, "\e[0;33m"); end
-
-      private
-
-      def color(text, color_code)  
-        "#{color_code}#{text}\e[0m" 
-      end
-    end
-  end
-end
+require "stock_quote_cli/version"
+require "stock_quote_cli/api"
+require "stock_quote_cli/text"
+require "stock_quote_cli/cli"

data/lib/stock_quote_cli/api.rb

@@ -0,0 +1,23 @@
+require "stock_quote"
+
+module StockQuoteCLI
+  class API
+    def self.stock_history(symbol, range)
+      end_date = Date.today
+      start_date = end_date - range
+      StockQuote::Stock.history(symbol, start_date, end_date)
+    end
+
+    def self.stocks_info(symbols)
+      [] + StockQuote::Stock.quote(symbols.join(", "))
+    end
+
+    class StockQuote::Stock
+      private
+
+      def to_ary
+        [] << self
+      end
+    end
+  end
+end

data/lib/stock_quote_cli/cli.rb

@@ -1,164 +1,124 @@
 require "thor"
 require "stock_quote"
-require "stock_quote_cli/quote"
-require "stock_quote_cli/history"
 
 module StockQuoteCLI
-	class CLI < Thor
-		include StockQuoteCLI::Quote
-		include StockQuoteCLI::History
-
-		DEFAULT_RANGE = 14 # days
-		DEFAULT_VALUE = "close"
-		VALUE_OPTIONS = ["open", "high", "low", "close", "volume"]
-
-		desc "last SYMBOL [SYMBOL...]", "get day's LAST stock price for SYMBOL"
-		def last(symbol, *symbols)
-			stocks = stocks(symbol, symbols)
-			output_quote_messages(stocks, :last_trade_price_only)
-		end
-
-		desc "high SYMBOL [SYMBOL...]", "get day's HIGH stock price for SYMBOL"
-		def high(symbol, *symbols)
-			stocks = stocks(symbol, symbols)
-			output_quote_messages(stocks, :days_high)
-		end
-
-		desc "low SYMBOL [SYMBOL...]", "get day's LOW stock price for SYMBOL"
-		def low(symbol, *symbols)
-			stocks = stocks(symbol, symbols)
-			output_quote_messages(stocks, :days_low)
-		end
-
-		desc "change SYMBOL [SYMBOL...]", "get day's CHANGE in stock price for SYMBOL"
-		def change(symbol, *symbols)
-			stocks = stocks(symbol, symbols)
-			output_quote_messages(stocks, :change)
-		end
-
-		desc "open SYMBOL [SYMBOL...]", "get day's OPEN stock price for SYMBOL"
-		def open(symbol, *symbols)
-			stocks = stocks(symbol, symbols)
-			output_quote_messages(stocks, :open)
-		end
-
-		desc "pclose SYMBOL [SYMBOL...]", "get previous closing (PCLOSE) stock price for SYMBOL"
-		def pclose(symbol, *symbols)
-			stocks = stocks(symbol, symbols)
-			output_quote_messages(stocks, :previous_close)
-		end
-
-		desc "volume SYMBOL [SYMBOL...]", "get share VOLUME for SYMBOL"
-		def volume(symbol, *symbols)
-			stocks = stocks(symbol, symbols)
-			output_quote_messages(stocks, :volume)
-		end
-
-		desc "history SYMBOL", "get HISTORY of stock price for SYMBOL"
-		method_option "range", aliases: "-r", type: :numeric, default: DEFAULT_RANGE, desc: "Specify the number of trading days for which to return stock price information."
-		method_option "value", aliases: "-v", type: :string, default: DEFAULT_VALUE, desc: "Specify the stock price value to retrieve for each date."
-		def history(symbol)
-			stock_history = get_stock_history(symbol, options['range'])
-			value = options['value']
-			output_history_messages(stock_history, value, VALUE_OPTIONS, symbol)
-		end
-
-		private
-
-		def output_quote_messages(stocks, method_name)
-			puts
-			stocks.each do |stock|
-				if stock.response_code == 200
-					company = format_company(stock.name)
-					unless method_name == :volume
-						price = format_price(stock.send(method_name))
-						puts "#{company}: #{price}"
-					else
-						volume = format_volume(stock.volume)
-						puts "#{company}: #{volume}"
-					end
-				else
-					puts bad_symbol_message
-				end
-			end
-			puts
-		end
-
-		def output_history_messages(stock_history, method_name, method_options, symbol)
-			puts 
-			if stock_history.is_a?(StockQuote::NoDataForStockError)
-				puts bad_symbol_message
-			else
-				if method_options.include?(method_name)
-					puts format_title(method_name, symbol)
-					puts
-					stock_history.each do |day|
-						date = format_date(day.date.to_s)
-						unless method_name == "volume"
-							price = format_price(day.send(method_name))
-							puts "#{date}: #{price}"
-						else
-							volume = format_volume(day.send(method_name))
-							puts "#{date}: #{volume}"
-						end
-					end
-				else
-					puts bad_value_message(method_name)
-				end
-			end
-			puts
-		end
-
-		def bad_symbol_message
-			TextHelpers.red('No data available for symbol...'.rjust(28))
-		end
-
-		def bad_value_message(value_name)
-			TextHelpers.red("#{'Invalid value:'.rjust(28)} #{value_name}")
-		end
-
-		def format_company(company)
-			TextHelpers.green(company).rjust(40)
-		end
-
-		def format_date(date)
-			TextHelpers.green(date).rjust(40)
-		end
-
-		def format_price(price)
-			"$#{price.number_with_commas}"
-		end
-
-		def format_volume(volume)
-			"#{volume.number_with_commas} shares"
-		end
-
-		def format_title(method_name, symbol)
-			"#{TextHelpers.yellow(method_name.upcase)} data for".rjust(38) + ": #{TextHelpers.yellow(symbol.upcase)}"
-		end
-	end
-end
-
-class Numeric
-	def number_with_commas
-		split_on_dot = to_s.split("\.")
-		whole = split_on_dot[0]
-		decimal = split_on_dot[1] || ""
-		char_array = whole.reverse.split(//)
-		whole_with_commas = char_array.each_with_index.map do |char, i|
-			if char_array.size > 3 && i % 3 == 0 && i > 0
-				"#{char},"
-			else
-				char
-			end
-		end.reverse.join("")
-		if decimal.size == 1
-			decimal = "#{decimal}0"
-		end
-		unless decimal == "" || decimal == "00"
-			"#{whole_with_commas}.#{decimal}"
-		else
-			"#{whole_with_commas}"
-		end
-	end
+  class CLI < Thor
+    desc "last SYMBOL [SYMBOL...]", "get day's LAST stock price for SYMBOL"
+    def last(*symbols)
+      output_info(symbols, :last_trade_price_only)
+    end
+
+    desc "high SYMBOL [SYMBOL...]", "get day's HIGH stock price for SYMBOL"
+    def high(*symbols)
+      output_info(symbols, :days_high)
+    end
+
+    desc "low SYMBOL [SYMBOL...]", "get day's LOW stock price for SYMBOL"
+    def low(*symbols)
+      output_info(symbols, :days_low)
+    end
+
+    desc "change SYMBOL [SYMBOL...]", "get day's CHANGE in stock price for SYMBOL"
+    def change(*symbols)
+      output_info(symbols, :change)
+    end
+
+    desc "open SYMBOL [SYMBOL...]", "get day's OPEN stock price for SYMBOL"
+    def open(*symbols)
+      output_info(symbols, :open)
+    end
+
+    desc "pclose SYMBOL [SYMBOL...]", "get previous closing (PCLOSE) stock price for SYMBOL"
+    def pclose(*symbols)
+      output_info(symbols, :previous_close)
+    end
+
+    desc "volume SYMBOL [SYMBOL...]", "get share VOLUME for SYMBOL"
+    def volume(*symbols)
+      output_info(symbols, :volume)
+    end
+
+    desc "history SYMBOL", "get HISTORY of stock price for SYMBOL"
+    method_option "range", aliases: "-r", type: :numeric, default: 14, desc: "Specify the number of trading days for which to return stock price information."
+    method_option "value", aliases: "-v", type: :string, default: "close", desc: "Specify the stock price value to retrieve for each date."
+    def history(symbol)
+      history = API.stock_history(symbol, options['range'])
+      output_stock_history(history, options['value'], symbol)
+    end
+
+    private
+
+    def output_info(symbols, vname)
+      stocks = API.stocks_info(symbols)
+      output_stocks_info(stocks, vname)
+    end
+
+    def output_stocks_info(stocks, vname)
+      puts
+      stocks.each do |quote|
+        # Ensure that quote object has data. If not,
+        # it probably represents an invalid symbol.
+        if quote.open
+          company = format_company(quote.name)
+          if vname == :volume
+            puts "#{company}: #{format_volume(quote.volume)}"
+          else
+            puts "#{company}: #{format_price(quote.send(vname))}"
+          end
+        else
+          output_bad_symbol_message(quote.symbol)
+        end
+      end
+      puts
+    end
+
+    def output_stock_history(history, vname, symbol)
+      return output_bad_symbol_message(symbol) if history.is_a?(StockQuote::NoDataForStockError)
+
+      voptions = %w[open high low close volume]
+      if voptions.include?(vname)
+        puts "\n#{format_title(vname, symbol)}\n"
+        history.each do |quote|
+          date = format_date(quote.date.to_s)
+          if vname == "volume"
+            puts "#{date}: #{format_volume(quote.send(vname))}"
+          else
+            puts "#{date}: #{format_price(quote.send(vname))}"
+          end
+        end
+      else
+        output_bad_vname_message(vname)
+      end
+      puts
+    end
+
+    def output_bad_symbol_message(symbol)
+      puts Text.red("No data available for symbol: #{symbol.upcase}".rjust(28))
+    end
+
+    def output_bad_vname_message(vname)
+      puts Text.red("#{'Invalid value:'.rjust(28)} #{vname}")
+    end
+
+    def format_company(company)
+      Text.green(company).rjust(40)
+    end
+
+    def format_date(date)
+      Text.green(date).rjust(40)
+    end
+
+    def format_price(price)
+      "$#{Text.number_with_commas(price)}"
+    end
+
+    def format_volume(volume)
+      "#{Text.number_with_commas(volume.to_i)} shares"
+    end
+
+    def format_title(vname, symbol)
+      "#{Text.yellow(vname.upcase)} data for:".rjust(39) +
+        " #{Text.yellow(symbol.upcase)}\n"
+    end
+  end
 end

data/lib/stock_quote_cli/text.rb

@@ -0,0 +1,23 @@
+module StockQuoteCLI
+  class Text
+    class << self
+      # color methods from https://github.com/pierot/stockery/blob/master/lib/stockery.rb
+      def red(str); color(str, "\e[31m"); end
+      def green(str); color(str, "\e[1m\e[32m"); end
+      def yellow(str); color(str, "\e[0;33m"); end
+
+      def number_with_commas(n)
+        int, dec = n.to_s.split(".")
+        int.chars.reverse.each_slice(3).reduce("") { |m, s|
+          m + s.join + (s.size == 3 ? "," : "")
+        }.reverse.gsub(/^,/, '') + (dec ? ".#{dec}" : "")
+      end
+
+      private
+
+      def color(text, color_code)
+        "#{color_code}#{text}\e[0m"
+      end
+    end
+  end
+end

data/lib/stock_quote_cli/version.rb

@@ -0,0 +1,3 @@
+module StockQuoteCLI
+  VERSION = "1.1.0"
+end

data/spec/spec_helper.rb

@@ -8,5 +8,4 @@ require 'stock_quote_cli'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  
 end

data/spec/stock_quote_cli_spec.rb

@@ -1,13 +1,9 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 module StockQuoteCLI
-	describe CLI do
+  describe CLI do
     let(:cli) { CLI }
 
-		it 'should exist' do
-			subject.should be_true
-		end
-
     context 'history' do
       it 'should accept a history method' do
         $stdout.should_receive(:puts).at_least(10).times
@@ -19,11 +15,5 @@ module StockQuoteCLI
         cli.start(["history", "-r", "20", "fb"])
       end
     end
-
-		context 'last' do
-			it 'should accept one argument' do
-				subject.stub(:last) { nil }
-			end
-		end
-	end
+  end
 end

data/stock_quote_cli.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Travis Loncar"]
-  s.date = "2015-01-01"
+  s.date = "2016-01-01"
   s.description = "A Ruby gem that provides a command-line interface for fetching stock information."
   s.email = "loncar.travis@gmail.com"
   s.executables = ["stock"]
@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    ".document",
     ".rspec",
     ".travis.yml",
     "Gemfile",
@@ -30,18 +29,19 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "bin/stock",
-    "example.png",
+    "demo.gif",
     "lib/stock_quote_cli.rb",
+    "lib/stock_quote_cli/api.rb",
     "lib/stock_quote_cli/cli.rb",
-    "lib/stock_quote_cli/history.rb",
-    "lib/stock_quote_cli/quote.rb",
+    "lib/stock_quote_cli/text.rb",
+    "lib/stock_quote_cli/version.rb",
     "spec/spec_helper.rb",
     "spec/stock_quote_cli_spec.rb",
     "stock_quote_cli.gemspec"
   ]
   s.homepage = "http://github.com/tbloncar/stock_quote_cli"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.5"
+  s.rubygems_version = "2.4.8"
   s.summary = "A Ruby gem that provides a command-line interface for fetching stock information."
 
   if s.respond_to? :specification_version then

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stock_quote_cli
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Travis Loncar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-01 00:00:00.000000000 Z
+date: 2016-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -129,24 +129,22 @@ executables:
 - stock
 extensions: []
 extra_rdoc_files:
-- LICENSE.txt
 - README.md
 files:
-- ".document"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
 - README.md
 - Rakefile
 - VERSION
 - bin/stock
-- example.png
+- demo.gif
 - lib/stock_quote_cli.rb
+- lib/stock_quote_cli/api.rb
 - lib/stock_quote_cli/cli.rb
-- lib/stock_quote_cli/history.rb
-- lib/stock_quote_cli/quote.rb
+- lib/stock_quote_cli/text.rb
+- lib/stock_quote_cli/version.rb
 - spec/spec_helper.rb
 - spec/stock_quote_cli_spec.rb
 - stock_quote_cli.gemspec
@@ -170,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A Ruby gem that provides a command-line interface for fetching stock information.

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/LICENSE.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2013 Travis Loncar
-
-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/lib/stock_quote_cli/history.rb

@@ -1,11 +0,0 @@
-module StockQuoteCLI
-	module History
-		private
-
-    def get_stock_history(symbol, range)
-      end_date = Date.today
-      start_date = end_date - range
-      StockQuote::Stock.history(symbol, start_date, end_date)
-    end
-	end
-end

data/lib/stock_quote_cli/quote.rb

@@ -1,26 +0,0 @@
-module StockQuoteCLI
-	module Quote
-		private
-
-		def stocks(symbol, symbols)
-			symbol_string = symbol_string(symbol, symbols)
-			get_stocks(symbol_string)
-		end
-
-		def symbol_string(symbol, symbols)
-			symbols.unshift(symbol).join(", ")
-		end
-
-		def get_stocks(symbol_string)
-			[] + StockQuote::Stock.quote(symbol_string)
-		end
-
-		class StockQuote::Stock
-			private
-
-			def to_ary
-				[] << self
-			end
-		end
-	end
-end