brm_finance 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15a4372351dd4190d42d0cad2c8f9818329630b8
-  data.tar.gz: 1a141cd7f63b0e31269ac21b5fb30492627b78b1
+  metadata.gz: 4c62e2bb9375c13be790efcc0bc5c1b9195c5050
+  data.tar.gz: 53ba9ca7ca4d234366111a5081fed99070c262f6
 SHA512:
-  metadata.gz: 3f5f44b12c69d3f162ae1ab95d37b3c655581f3326f0aa78338736d96b39109796736bfd9e7fa257228e5b2505085f7a00a82627cdfd3ddd60e93651ebfe9a81
-  data.tar.gz: d268ae7b9023627ebc5cbe98c4f31072839c8347c8dda63c7d2003fd564006240f912eca7b142ed43047699a30b2d1e8cb8cbb0de23f2f2b21162e19cc35b015
+  metadata.gz: 13923f0054942dfe1479d44c16124bedf26a6624ce083e622cef9dd126ea68303aa9bd8e3ecafdded831f9d08623211493ee8aedbd57b75620ab5b5393f367a6
+  data.tar.gz: 774b119e2f3a1502966cba9830b177cd09677daff44256388894f7651a66ddaf31c8054c728722945719ae995d4dcdd01d99797c986c1cf4880a489cf83bfa92

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in stock_check.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Ty Rauber
+
+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/Rakefile

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

data/brm_finance.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "brm_finance/version"
+
+Gem::Specification.new do |s|
+  s.name        = "brm_finance"
+  s.version     = BrmFinance::VERSION
+  s.authors     = ["Alex Adamson, Ty Rauber"]
+  s.email       = ["aadamson@stanford.edu"]
+  s.homepage    = "https://github.com/aadamson/brm_finance"
+  s.summary     = "A ruby gem that retrieves real-time stock quotes from google."
+  s.description = "Retrieve up to 100 stock quotes per query with the following variables - symbol, pretty_symbol, symbol_lookup_url, company, exchange, exchange_timezone, exchange_utc_offset, exchange_closing, divisor, currency, last, high, low, volume, avg_volume, market_cap, open, y_close, change, perc_change, delay, trade_timestamp, trade_date_utc, trade_time_utc, current_date_utc, current_time_utc, symbol_url, chart_url, disclaimer_url, ecn_url, isld_last, isld_trade_date_utc, isld_trade_time_utc, brut_last, brut_trade_date_utc, brut_trade_time_utc and daylight_savings - per stock. Extended for use with keystats and stocks Yahoo tables. Will upgrade it for use with Yahoo options tables soon."
+  #s.rubyforge_project = "brm_finance"
+
+  s.files         = Dir["README.md","Gemfile","Rakefile", "spec/*", "lib/**/*"]
+  s.files         += `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "rest-client"
+  s.add_runtime_dependency "json"
+  s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'vcr'
+end

data/lib/brm_finance.rb

@@ -0,0 +1,4 @@
+require "rubygems"
+require "brm_finance/utility"
+require "brm_finance/version"
+require "brm_finance/stock"

data/lib/brm_finance/stock.rb

@@ -0,0 +1,145 @@
+require "rubygems"
+require "rest-client"
+require "json"
+require "date"
+require 'csv'
+
+module BrmFinance
+  class Stock
+    @@fields = ["symbol", "Ask","AverageDailyVolume", "Bid", "AskRealtime", "BidRealtime", 
+                "BookValue", "Change_PercentChange","Change", "Commission", "ChangeRealtime", 
+                "AfterHoursChangeRealtime", "DividendShare","LastTradeDate","TradeDate", 
+                "EarningsShare", "ErrorIndicationreturnedforsymbolchangedinvalid", 
+                "EPSEstimateCurrentYear", "EPSEstimateNextYear", "EPSEstimateNextQuarter", 
+                "DaysLow","DaysHigh","YearLow", "YearHigh", "HoldingsGainPercent", 
+                "AnnualizedGain","HoldingsGain", "HoldingsGainPercentRealtime", 
+                "HoldingsGainRealtime", "MoreInfo", "OrderBookRealtime", "MarketCapitalization", 
+                "MarketCapRealtime", "EBITDA", "ChangeFromYearLow", "PercentChangeFromYearLow", 
+                "LastTradeRealtimeWithTime", "ChangePercentRealtime","ChangeFromYearHigh", 
+                "PercebtChangeFromYearHigh", "LastTradeWithTime", "LastTradePriceOnly",
+                "HighLimit", "LowLimit", "DaysRange", "DaysRangeRealtime", 
+                "FiftydayMovingAverage", "TwoHundreddayMovingAverage", 
+                "ChangeFromTwoHundreddayMovingAverage", 
+                "PercentChangeFromTwoHundreddayMovingAverage", 
+                "ChangeFromFiftydayMovingAverage", "PercentChangeFromFiftydayMovingAverage", 
+                "Name", "Notes", "Open", "PreviousClose", "PricePaid", "ChangeinPercent",
+                "PriceSales","PriceBook", "ExDividendDate", "PERatio", "DividendPayDate", 
+                "PERatioRealtime", "PEGRatio", "PriceEPSEstimateCurrentYear", 
+                "PriceEPSEstimateNextYear", "Symbol", "SharesOwned", "ShortRatio", 
+                "LastTradeTime", "TickerTrend", "OneyrTargetPrice", "Volume", "HoldingsValue", 
+                "HoldingsValueRealtime", "YearRange","DaysValueChange",
+                "DaysValueChangeRealtime", "StockExchange","DividendYield","PercentChange", 
+                "ErrorIndicationreturnedforsymbolchangedinvalid"]
+    attr_accessor :response_code, :no_data_message
+
+    @@fields.each do | field|
+      self.__send__(:attr_accessor, field.underscore.to_sym)
+    end
+
+    def self.fields
+      @@fields
+    end
+
+    def initialize(data)
+      if data['ErrorIndicationreturnedforsymbolchangedinvalid']
+        @no_data_message = data['ErrorIndicationreturnedforsymbolchangedinvalid']
+        @response_code = 404
+      elsif data['count'] && data['count'] == 0
+        @no_data_message = "Query returns no valid data"
+        @response_code = 404
+      else
+        @response_code = 200
+        data.map do |k,v|
+          instance_variable_set("@#{k.underscore}", (v.nil? ? nil : v.to_fs))
+        end
+      end
+    end
+
+    def success?
+      response_code==200
+    end
+
+    def failure?
+      response_code==404
+    end
+
+    def self.quote(symbol, start_date=nil, end_date=nil)
+      'http://query.yahooapis.com/v1/public/yql?q=select%20*%20from%20yahoo.finance.historicaldata%20where%20symbol%20%3D%20%22YHOO%22%20and%20startDate%20%3D%20%222009-09-11%22%20and%20endDate%20%3D%20%222010-03-10%22&format=json&diagnostics=true&env=store%3A%2F%2Fdatatables.org%2Falltableswithkeys&callback='
+      url = 'http://query.yahooapis.com/v1/public/yql?q=';
+      if start_date && end_date
+        url = url+URI::encode("select * from yahoo.finance.historicaldata where symbol in (#{symbol.to_p}) and startDate = '#{start_date}' and endDate = '#{end_date}'")
+
+      else
+        url = url+URI::encode("select * from yahoo.finance.quotes where symbol in (#{symbol.to_p})")
+      end
+      url = url+"&env=http%3A%2F%2Fdatatables.org%2Falltables.env&format=json"
+      response = RestClient.get(url)
+      self.parse(response, symbol)
+    end
+
+    def self.dividends_splits(symbol, start_date='01-01-2000', end_date=Date.today.strftime('%m-%d-%Y'))
+      symbol = [symbol] unless symbol.is_a?(Array)
+
+      start_date = start_date.split('-')
+      start_date = "a=#{start_date[0]}&b=#{start_date[1]}&c=#{start_date[2]}"
+      end_date = end_date.split('-')
+      end_date = "d=#{end_date[0]}&e=#{end_date[1]}&f=#{end_date[2]}"
+
+      results = []
+      symbol.each do |s|
+        url = "http://ichart.finance.yahoo.com/x?s=#{s}&#{start_date}&#{end_date}&g=v&y=0&z=30000"
+        response = RestClient.get(url)
+        results.push({'Symbol' => s, 'Series' => CSV.parse(response)})
+      end
+
+      results
+    end
+
+    def self.company_info(symbol)
+      url = 'http://query.yahooapis.com/v1/public/yql?q='
+
+      url += URI::encode("select * from yahoo.finance.stocks where symbol in (#{symbol.to_p})")
+      url += "&env=http%3A%2F%2Fdatatables.org%2Falltables.env&format=json"
+      response = RestClient.get(url)
+      self.parse(response, symbol)
+    end
+
+    def self.key_stats(symbol)
+      url = 'http://query.yahooapis.com/v1/public/yql?q='
+
+      url += URI::encode("SELECT * FROM yahoo.finance.keystats WHERE symbol in (#{symbol.to_p})")
+      url += "&env=http%3A%2F%2Fdatatables.org%2Falltables.env&format=json"
+      response = RestClient.get(url)
+      self.parse(response, symbol)
+    end
+
+    def self.parse(json, symbol)
+      results = []
+      json = JSON.parse(json)
+      count = json["query"]["count"]
+      return Stock.new(json["query"]) if count == 0
+      results = json["query"]["results"]
+      #data = count == 1 ? [data] : data
+
+      results.each do |k, v|
+        results = results[k].is_a?(Array) ? results[k] : [results[k]]
+        return results
+
+        #d["symbol"] = symbol.to_p unless d["symbol"]
+        #stock = Stock.new(d)
+        #results += stock
+      end
+      #return results
+    end
+
+    def self.history(symbol, start_date='2012-01-01', end_date=Date.today.strftime('%Y-%m-%d'))
+      results = []
+      (start_date.to_date..end_date.to_date+1.year).step(365) do |date|
+        break if date + 1.day > Date.today
+        results += self.quote(symbol, (date + 1.day).strftime('%Y-%m-%d'), (date + 1.year).strftime('%Y-%m-%d'))
+      end
+
+      results
+    end
+  end
+end

data/lib/brm_finance/utility.rb

@@ -0,0 +1,23 @@
+class String
+
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+
+  def to_fs
+    (!!Float(self) rescue false) ? Float(self) : self
+  end
+
+  def to_p
+    self.split(',').to_p
+  end
+end
+class Array
+  def to_p
+    "'#{self.join("','").gsub(" ", "").upcase}'"
+  end
+end

data/lib/brm_finance/version.rb

@@ -0,0 +1,3 @@
+module BrmFinance
+  VERSION = "1.0.1"
+end

data/spec/brm_finance_spec.rb

@@ -0,0 +1,81 @@
+require "brm_finance"
+require "spec_helper"
+
+describe BrmFinance::Stock do
+  describe "quote" do
+    context "success" do
+      describe "single symbol" do
+
+        @fields = BrmFinance::Stock.class_variable_get(:@@fields)
+
+        use_vcr_cassette "aapl"
+
+        @fields.each do | field |
+          it ".#{field}" do
+            @stock = BrmFinance::Stock.quote('aapl')
+            @stock.should respond_to(field.underscore.to_sym)
+          end
+        end
+
+        it "should result in a successful query with " do
+          @stock = BrmFinance::Stock.quote('aapl')
+          @stock.should be_success
+          @stock.response_code.should be_eql(200)
+          @stock.should respond_to(:no_data_message)
+          @stock.no_data_message.should be_nil
+        end
+      end
+    end
+
+    describe "comma seperated symbols" do
+
+      use_vcr_cassette "aapl,tsla"
+
+      it "should result in a successful query" do
+        @stocks = BrmFinance::Stock.quote('aapl,tsla')
+        @stocks.each do |stock|
+          stock.should be_success
+          stock.response_code.should be_eql(200)
+          stock.should respond_to(:no_data_message)
+          stock.no_data_message.should be_nil
+        end
+      end
+    end
+
+    context "failure" do
+
+      @fields = BrmFinance::Stock.class_variable_get(:@@fields)
+
+      use_vcr_cassette "asdf"
+
+      it "should fail... gracefully" do
+        @stock = BrmFinance::Stock.quote('asdf')
+        @stock.should be_failure
+        @stock.response_code.should be_eql(404)
+        @stock.should respond_to(:no_data_message)
+        @stock.no_data_message.should_not be_nil
+      end
+    end
+  end
+
+  describe "history" do
+    context "success" do
+      use_vcr_cassette "aapl_history"
+
+      it "should result in a successful query" do
+        @stock = BrmFinance::Stock.history('aapl')
+        @stock.count.should >=1
+      end
+    end
+    context "failure" do
+      use_vcr_cassette "asdf_history"
+
+      it "should result in a successful query" do
+        @stock = BrmFinance::Stock.history('asdf')
+        @stock.response_code.should be_eql(404)
+        @stock.should respond_to(:no_data_message)
+        @stock.no_data_message.should_not be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'brm_finance'
+require 'rubygems'
+require 'bundler/setup'
+require 'vcr_setup'
+
+RSpec.configure do |config|
+  config.extend VCR::RSpec::Macros
+end

data/spec/vcr_setup.rb

@@ -0,0 +1,8 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir     = 'spec/vcr_cassettes'
+  c.hook_into                :fakeweb
+  c.ignore_localhost         = true
+  c.default_cassette_options = { :record => :new_episodes }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brm_finance
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Alex Adamson, Ty Rauber
@@ -96,6 +96,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- Gemfile
+- Rakefile
+- spec/brm_finance_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_setup.rb
+- lib/brm_finance/stock.rb
+- lib/brm_finance/utility.rb
+- lib/brm_finance/version.rb
+- lib/brm_finance.rb
+- .DS_Store
+- LICENSE
+- brm_finance-1.0.0.gem
+- brm_finance.gemspec
+- lib/.DS_Store
 homepage: https://github.com/aadamson/brm_finance
 licenses: []
 metadata: {}
@@ -119,4 +133,7 @@ rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: A ruby gem that retrieves real-time stock quotes from google.
-test_files: []
+test_files:
+- spec/brm_finance_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_setup.rb