GoogleFinance 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82b593dbe5d0a90f4ba0e21df89c9a90e8a1f75a
+  data.tar.gz: cc590ad4618180bf14d709f53db68764b08213b5
+SHA512:
+  metadata.gz: d189b973babb39dd879ee5e589f4bb46210643ad9c012e64a92de1518cf01a4b6643eb961d73e73c78dc9042bf2186f8c4f3cdb6791096195bbfc363153f34bb
+  data.tar.gz: 4683e4cb4e6ec04384ea8b959e3b061fd355ba633642a8d61609dc8138aef2cc33838e8044904e7f21caef1ef162017449f8888d3e5bd944275f6845ea97eeec

data/.byebug_history

@@ -0,0 +1,7 @@
+exit
+page
+exit
+@years['2015-01-31'].sg_and_a.class
+@years['2015-01-31'].sg_and_a
+@years['2015-01-31'].net_income
+@years['2015-01-31']

data/.gitignore

@@ -0,0 +1,10 @@
+/.byebug_history/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/Gemfile

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

data/GoogleFinance.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'GoogleFinance/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "GoogleFinance"
+  spec.version       = GoogleFinance::VERSION
+  spec.authors       = ["Max Brunet"]
+  spec.email         = ["maxime.brunet@gmail.com"]
+
+  spec.summary       = %q{Simple GEM to Query Google Finance information - draft}
+  spec.description   = %q{}
+  spec.homepage      = "http://www.google.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+
+  spec.add_dependency 'nokogiri'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,41 @@
+# GoogleFinance
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/GoogleFinance`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'GoogleFinance'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install GoogleFinance
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/GoogleFinance.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "GoogleFinance"
+
+# 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.
+
+@c = GoogleFinance::Company.new "NYSE:ORCL"
+@c.get_historical_prices("2012-01-01", "2013-01-01")
+
+require "irb"
+IRB.start

data/bin/setup

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

data/lib/GoogleFinance.rb

@@ -0,0 +1,7 @@
+require 'GoogleFinance/version'
+require 'GoogleFinance/Company'
+require 'GoogleFinance/HistoricalPrices'
+require 'GoogleFinance/Financials'
+
+module GoogleFinance
+end

data/lib/GoogleFinance/Company.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'nokogiri'
+require 'open-uri'
+require 'GoogleFinance/HistoricalPrices'
+
+module GoogleFinance
+
+  #
+  # Google Company class 
+  class Company
+
+    attr_accessor :ticker, :name, :employees, :prices
+  
+    #
+    # get the ticker with the initialize
+    def initialize(ticker)
+      @ticker = ticker
+    end
+    
+    #
+    # Get company name as in Google Finance
+    def name
+      name_url = "https://google.com/finance?q=" + @ticker
+      page = Nokogiri::HTML(open(name_url))
+
+      # use xpath to get the string, remove the end newline
+      @name = page.xpath("//meta[@itemprop='name']/@content").to_s.gsub("\n", "")
+      @name
+    end
+
+    #
+    # Parse the number of employees
+    def employees
+      return @employees unless @employees.nil?
+
+      name_url   = "https://google.com/finance?q=" + @ticker
+      page       = Nokogiri::HTML(open(name_url))
+      @employees = page.xpath("//div[@class='sfe-section']/table/tr[6]/td[@class='period']").inner_html.gsub(/\n|,|-/, "").to_i
+      @employees
+    
+    end # employees
+
+    #
+    # load the historical prices iwth the current ticker
+    def get_historical_prices(date_start, date_end)
+
+      @prices = GoogleFinance::HistoricalPrices.new(@ticker, date_start, date_end)
+
+    end # get_historical_prices
+
+    
+  end # class Company
+
+end #module

data/lib/GoogleFinance/Financials.rb

@@ -0,0 +1,109 @@
+require 'date'
+require 'nokogiri'
+require 'open-uri'
+require 'byebug'
+
+module GoogleFinance
+
+  # 
+  #
+  class Statement
+
+    attr_accessor :revenue, :cost_of_rev, :sg_and_a, :r_and_d
+    attr_accessor :d_and_a, :interest, :unusual, :others, :net_income, :fiscal_year
+    
+  end # Statement
+
+  #
+  #
+  class Financials
+
+    # year positions in the HTML grid
+    YEAR_1 = 2
+    YEAR_2 = 3
+    YEAR_3 = 4
+    YEAR_4 = 5
+    
+    # Row positions in the HTML grid
+    REV_ROW = 3
+    COR_ROW = 4
+    SGA_ROW = 6
+    RND_ROW = 7
+    DNA_ROW = 8
+    INT_ROW = 9
+    UNU_ROW = 10
+    OTH_ROW = 11
+    NET_ROW = 25
+
+
+    attr_accessor :years
+    
+    #
+    #
+    def initialize(ticker)
+  
+      @years = {}
+
+      # build URL in the right format, in pages of 100 day quotes
+      @financial_url = "https://www.google.com/finance?q=#{ticker}&fstype=ii"
+      @page          = Nokogiri::HTML(open(@financial_url))
+    
+      # 
+      yr1 = Statement.new
+      yr2 = Statement.new
+      yr3 = Statement.new
+      yr4 = Statement.new
+
+      # map the value to the correct areas in the financial statement objects
+      yr1.revenue, yr2.revenue, yr3.revenue, yr4.revenue                 = get_figures(REV_ROW, @page)
+      yr1.cost_of_rev, yr2.cost_of_rev, yr3.cost_of_rev, yr4.cost_of_rev = get_figures(COR_ROW, @page)
+      yr1.sg_and_a, yr2.sg_and_a, yr3.sg_and_a, yr4.sg_and_a             = get_figures(SGA_ROW, @page)
+      yr1.r_and_d, yr2.r_and_d, yr3.r_and_d, yr4.r_and_d                 = get_figures(RND_ROW, @page)
+      yr1.d_and_a, yr2.d_and_a, yr3.d_and_a, yr4.d_and_a                 = get_figures(DNA_ROW, @page)
+      yr1.interest, yr2.interest, yr3.interest, yr4.interest             = get_figures(INT_ROW, @page)
+      yr1.unusual, yr2.unusual, yr3.unusual, yr4.unusual                 = get_figures(UNU_ROW, @page)
+      yr1.others, yr2.others, yr3.others, yr4.others                     = get_figures(OTH_ROW, @page)
+      yr1.net_income, yr2.net_income, yr3.net_income, yr4.net_income     = get_figures(NET_ROW, @page)
+
+
+      # get the fiscal years as in the statements
+      @years[get_fiscal_date(YEAR_1, @page)] = yr1
+      @years[get_fiscal_date(YEAR_2, @page)] = yr2
+      @years[get_fiscal_date(YEAR_3, @page)] = yr3
+      @years[get_fiscal_date(YEAR_4, @page)] = yr4
+
+    end
+    
+    # 
+    # Based on reequest row (class constant) will get the figures for the 4 years
+    def get_figures(row, page)
+      
+      # get the requested figure for the 4 years that are shown
+      element = page.xpath("//div[@id='incannualdiv']/table[1]/tbody/tr[#{row}]/td[#{YEAR_1}]")
+      figure_yr1 = element.inner_html.gsub(",", "").to_f
+      
+      element = page.xpath("//div[@id='incannualdiv']/table[1]/tbody/tr[#{row}]/td[#{YEAR_2}]")
+      figure_yr2 = element.inner_html.gsub(",", "").to_f
+      
+      element = page.xpath("//div[@id='incannualdiv']/table[1]/tbody/tr[#{row}]/td[#{YEAR_3}]")
+      figure_yr3 = element.inner_html.gsub(",", "").to_f
+      
+      element = page.xpath("//div[@id='incannualdiv']/table[1]/tbody/tr[#{row}]/td[#{YEAR_4}]")
+      figure_yr4 = element.inner_html.gsub(",", "").to_f
+    
+      return [figure_yr1, figure_yr2, figure_yr3, figure_yr4]
+    
+    end # get_figures
+    
+    #
+    # get the end date of the fiscale period associated with the years [1..4]
+    def get_fiscal_date(year, page)
+      
+      element = page.xpath("//div[@id='incannualdiv']/table/thead/tr/th[#{year}]")
+      return element.inner_html.gsub(/^.*ending /, "").gsub("\n", "")
+    
+    end # get_fiscal_date
+
+  end # class Financials
+
+end # module GoogleFinance

data/lib/GoogleFinance/HistoricalPrices.rb

@@ -0,0 +1,143 @@
+require 'date'
+require 'byebug'
+
+module GoogleFinance
+  
+  class HistoricalPrices
+
+    # xpath positions on which Google Finance returns the prices
+    STOCK_OPEN  = 0 
+    STOCK_HIGH  = 1
+    STOCK_LOW   = 2
+    STOCK_CLOSE = 3
+    NUM_COLS    = STOCK_CLOSE + 1
+    NUM_ROWS    = 100
+
+    attr_reader :stock_perf
+
+    #
+    # 
+    def initialize(ticker, date_start, date_end)
+      
+      @ticker     = ticker
+      @date_start = Date.strptime(date_start, "%Y-%m-%d")
+      @date_end   = Date.strptime(date_end,   "%Y-%m-%d")
+      @stock_perf = {}
+    
+      load_share_prices()
+
+    end # def initialize
+
+    #
+    # Load the historical prices in the internal hash
+    def load_share_prices()
+      
+      # build URL in the right format, in pages of 100 day quotes
+      historical_url = @@URL_HIS + @ticker + "&startdate=" + HistoricalPrices.fix_date(@date_start) + 
+                       "&enddate=" + HistoricalPrices.fix_date(@date_end) + "&num=#{NUM_ROWS}&start=0"
+      page = Nokogiri::HTML(open(historical_url))
+
+      # pagination element is in javascript, 9th script element in the page
+      element   = page.search("script")[9]
+      @rows     = element.text.scan(/applyPagination\(\n[0-9]+,\n[0-9]*,\n([0-9]+)/)[0].first.to_i
+      num_calls = @rows / NUM_ROWS # we are going to make this many page calls to get all the data
+
+      # first page is already acquired, don't make another call
+      extract_prices_from_page(page)
+      for i in 1..num_calls
+        
+        historical_url = @@URL_HIS + @ticker + "&startdate=" + HistoricalPrices.fix_date(@date_start) + 
+                         "&enddate=" + HistoricalPrices.fix_date(@date_end) + "&num=#{NUM_ROWS}&start=#{i * NUM_ROWS}"
+        page = Nokogiri::HTML(open(historical_url))
+        extract_prices_from_page(page)
+      end
+      
+      
+    end # load_share_prices
+      
+    #
+    # 
+    def extract_prices_from_page(page)
+
+      quote_dates  = []
+      quote_close  = []
+      quote_open   = []
+      quote_high   = []
+      quote_low    = []
+      quote_volume = []
+  
+      # extract the dates
+      dates = page.xpath("//td[@class='lm']")
+      dates.each do |date|
+        quote_dates.push(HistoricalPrices.google_date_to_ruby(date.content.gsub("\n","")))
+      end 
+
+       # get the stock prices
+       counter = 0
+       figures = page.xpath("//td[@class='rgt']")
+       figures.each do |figure|
+        val = figure.content.gsub("\n", "")
+        if    counter.modulo(GoogleFinance::HistoricalPrices::NUM_COLS)  == GoogleFinance::HistoricalPrices::STOCK_OPEN  then
+          quote_open.push(val)
+        elsif counter.modulo(GoogleFinance::HistoricalPrices::NUM_COLS) == GoogleFinance::HistoricalPrices::STOCK_HIGH  then
+          quote_high.push(val)
+        elsif counter.modulo(GoogleFinance::HistoricalPrices::NUM_COLS) == GoogleFinance::HistoricalPrices::STOCK_LOW   then
+          quote_low.push(val)
+        elsif counter.modulo(GoogleFinance::HistoricalPrices::NUM_COLS) == GoogleFinance::HistoricalPrices::STOCK_CLOSE then
+          quote_close.push(val)
+        end
+        counter = counter + 1 
+      end
+    
+      # get the volumnes
+      volumes = page.xpath("//td[@class='rgt rm']")
+      volumes.each do |volume|
+        quote_volume.push(volume.content.gsub("\n",""))
+      end
+
+      # we've extracted everything - build the share price hash
+      for i in 0..(quote_dates.length - 1) 
+        @stock_perf[quote_dates[i]] = [quote_open[i], quote_high[i], quote_low[i], quote_close[i], quote_volume[i]]
+      end
+
+    end # extract_prices_from_page
+
+
+    #
+    # Input date should be in dd-mm-yyyy format
+    def self.fix_date(input_date)
+    
+      months = %w{Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec}
+      d = Date.strptime(input_date.to_s, "%Y-%m-%d") unless input_date.class == "Date"
+  
+      # add '+' between all paramters, and for some reason, the ',' is equal to %2C but won't 
+      #   escape to it using addresable, whatever, it works this way
+      "#{months[d.mon - 1]}+#{d.day}%2C+#{d.year}"
+
+    end # fix_date
+
+    #
+    # Take the Gooel date format, bring it in to YYYY-mm-dd
+    def self.google_date_to_ruby(input_date)
+      
+      dump, mon, day, year = input_date.split(/(...) ([0-9]*), (....)/) 
+    
+      # change month to numerical stuff
+      months = { "Jan" => 1, "Feb" => 2, "Mar" => 3, "Apr" => 4,
+                 "May" => 5, "Jun" => 6, "Jul" => 7, "Aug" => 8,
+                 "Sep" => 9, "Oct" => 10,"Nov" => 11, "Dec" => 12}
+      mon = months[mon]
+      mon = "0" + mon.to_s unless mon > 10
+      day = "0" + day.to_s unless day.to_i > 10
+
+      return  "#{year}-#{mon}-#{day}" 
+
+    end # google_date_to_ruby
+    
+    @@URL_HIS = "https://www.google.com/finance/historical?q="
+
+  end # class
+
+end # module
+
+

data/lib/GoogleFinance/version.rb

@@ -0,0 +1,3 @@
+module GoogleFinance
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: GoogleFinance
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Max Brunet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- maxime.brunet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- GoogleFinance.gemspec
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/GoogleFinance.rb
+- lib/GoogleFinance/Company.rb
+- lib/GoogleFinance/Financials.rb
+- lib/GoogleFinance/HistoricalPrices.rb
+- lib/GoogleFinance/version.rb
+homepage: http://www.google.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple GEM to Query Google Finance information - draft
+test_files: []