stock 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f15340a936a764737e0f2dacf4cc51cc8b4f7e68
+  data.tar.gz: cf03a271dbf1c57dd9d21efc333b00cdfa1983f3
+SHA512:
+  metadata.gz: 4f08e176d30e2d9b0c37433c61328ba17b9486065056306f378e03993b97ae1a09f726171b465e2a14204634f5a8161f072e81ec1e2c5d608c7b7cb3fd957429
+  data.tar.gz: 62f8debab4d5618a0afcff9e4f809f56ab72d2ca27b87a03119e19d59782cd96f94ec66fe245ae5b8a7c12258cef3d7e6823a5cdfb5e6f76a07eff0bcfd69f72

data/README.md

@@ -0,0 +1,124 @@
+# Stock.rb
+Grabs information about a stock from Yahoo! Finance.
+
+### Installation
+* Via RubyGems `gem install stock`
+
+### Basic Usage
+You can grab the entire information of a stock like so:
+```ruby
+require 'stock'
+
+facebook = Stock.new('fb')
+puts facebook.d
+```
+
+**OUTPUT**
+
+```json
+{
+   "sourceInterval":15,
+   "regularMarketOpen":{
+      "raw":181.78,
+      "fmt":"181.78"
+   },
+   "exchange":"NMS",
+   "regularMarketTime":{
+      "raw":1520370002,
+      "fmt":"4:00PM EST"
+   },
+   "sharesOutstanding":{
+      "raw":2395919872,
+      "fmt":"2.396B",
+      "longFmt":"2,395,919,872"
+   },
+   "regularMarketDayHigh":{
+      "raw":182.38,
+      "fmt":"182.38"
+   },
+   "shortName":"Facebook, Inc.",
+   "longName":"Facebook, Inc.",
+   "exchangeTimezoneName":"America/New_York",
+   "regularMarketChange":{
+      "raw":-0.6199951,
+      "fmt":"-0.62"
+   },
+   "regularMarketPreviousClose":{
+      "raw":180.4,
+      "fmt":"180.40"
+   },
+   "fiftyTwoWeekHighChange":{
+      "raw":-15.540009,
+      "fmt":"-15.54"
+   },
+   "exchangeTimezoneShortName":"EST",
+   "fiftyTwoWeekLowChange":{
+      "raw":42.789993,
+      "fmt":"42.79"
+   },
+   "exchangeDataDelayedBy":0,
+   "regularMarketDayLow":{
+      "raw":179.11,
+      "fmt":"179.11"
+   },
+   "priceHint":2,
+   "currency":"USD",
+   "regularMarketPrice":{
+      "raw":179.78,
+      "fmt":"179.78"
+   },
+   "regularMarketVolume":{
+      "raw":15086784,
+      "fmt":"15.087M",
+      "longFmt":"15,086,784"
+   },
+   "isLoading":false,
+   "gmtOffSetMilliseconds":-18000000,
+   "marketState":"POSTPOST",
+   "marketCap":{
+      "raw":522260873216,
+      "fmt":"522.261B",
+      "longFmt":"522,260,873,216"
+   },
+   "quoteType":"EQUITY",
+   "invalid":false,
+   "symbol":"FB",
+   "language":"en-US",
+   "fiftyTwoWeekLowChangePercent":{
+      "raw":0.3123585,
+      "fmt":"31.24%"
+   },
+   "messageBoardId":"finmb_20765463",
+   "fiftyTwoWeekHigh":{
+      "raw":195.32,
+      "fmt":"195.32"
+   },
+   "fiftyTwoWeekHighChangePercent":{
+      "raw":-0.079561785,
+      "fmt":"-7.96%"
+   },
+   "uuid":"30781f1f-c2f9-342c-ab1a-d2f6f35a51db",
+   "market":"us_market",
+   "fiftyTwoWeekLow":{
+      "raw":136.99,
+      "fmt":"136.99"
+   },
+   "regularMarketChangePercent":{
+      "raw":-0.343678,
+      "fmt":"-0.34%"
+   },
+   "fullExchangeName":"NasdaqGS",
+   "tradeable":true
+}
+```
+
+You can also grab singular pieces of information about a stock like so:
+```ruby
+require 'stock'
+
+facebook = Stock.new('fb')
+p facebook.d['shortName'] #=> 'Facebook, Inc.'
+```
+
+# License
+Copyright © 2018 Marcello Sabino (marchsabino@gmail.com) and released under the MIT License.

data/lib/stock.rb

@@ -0,0 +1,50 @@
+require 'open-uri'
+require 'json'
+
+##
+# Represents a singular stock on Yahoo! Finance.
+#
+# @author Marcello Sabino <marchsabino@gmail.com>
+# @version 1.0.0
+# @since 1.0.0
+class Stock
+  # @return [String] The Stock's symbol
+  attr_reader :symbol
+
+  ##
+  # Creates a new Stock object with the given symbol
+  # 
+  # @param symbol [String] the stocks symbol
+  def initialize(symbol)
+    @symbol = symbol
+  end
+
+  ##
+  # Gets the stock's data from Yahoo!
+  #
+  # @since 1.0.0
+  # @raise RuntimeError if the Stock symbol can't be found on Yahoo! Finance.
+  # @return JSON of the Symbol's data from Yahoo! Finance.
+  def d
+    html = open("https://finance.yahoo.com/quote/#{@symbol}", &:read).freeze
+    json = JSON.parse(between(html, 'root.App.main = ', ";\n}(this));"))
+    json = json['context']['dispatcher']['stores']
+    symbol = json['PageStore']['pageData']['symbol']
+
+    return json['StreamDataStore']['quoteData'][symbol].to_json if symbol != nil
+    raise RuntimeError, "Stock #{@symbol} doesn't exist."
+  end
+
+  private
+
+  ##
+  # A private helper method to grab text in-between
+  # 2 strings.
+  #
+  # @param str [String] string to search from
+  # @param start [String] where to start looking in-between
+  # @param ends [String] the end of the string to look in-between
+  def between(str, start, ends)
+    str[/#{Regexp.escape(start)}(.*?)#{Regexp.escape(ends)}/m, 1]
+  end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: stock
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marcello A. Sabino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-07 00:00:00.000000000 Z
+dependencies: []
+description: Grabs stock information from Yahoo! Finance
+email: marchsabino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/stock.rb
+homepage: http://rubygems.org/gems/stock
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Grabs stock information from Yahoo! Finance
+test_files: []