yahoo_finanza 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca919f9cbbad25047bd58b4b3cdccdc66a5a0c14
-  data.tar.gz: 6a6822ff52a03843162af5ce09945827b0e3cd67
+  metadata.gz: e9534658e039738eabf39f87c79c65f0d1127121
+  data.tar.gz: fd0890f4ec5e42e23922cd8313659621c57244b5
 SHA512:
-  metadata.gz: aa9c38395cae970a0bbdb1a3eac53ac69ed81c8f3eeff2486787df13c0185c05d52e5ec58c704640e467f0bc9ba8cb0a67884c28d89e5a39821d945f43c0b151
-  data.tar.gz: 4a08070fa5ecb450ef7f6766a31203c0c5d7983b39048d701b673cf4f914e731ccf09b4dbeedbc8dee05eb370f75879a355ce18027b04aa9211e95dd0a0d57cf
+  metadata.gz: dddc1b376348ac563bb403d5d3212b156510d850f601340f3c6d8ee4e538827984f6cf7e8cfb0bd5aff88f618f92d8aa0063e126286671527aef06972ec9d160
+  data.tar.gz: ccaf43d61c76420fdfb0519d2673070f22df9a51073cc3f957be2c50df8be9d602b5b2dc93728917e35d607492605d31d50ac8f2ef63884ef49819b564692fd9

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/lib/.DS_Store
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby_version

@@ -0,0 +1 @@
+ruby-2.2.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+    - 2.2.1
+script:
+  bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+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,356 @@
+# YahooFinanza
+[![Build Status](https://travis-ci.org/cometaworks/yahoo_finanza.svg?branch=master)](https://travis-ci.org/cometaworks/yahoo_finanza)
+
+This is a simple Yahoo Finance client. The client is capable of getting current data for several symbols in bulk as well as individually. It also has an historical data method which fetches historical data about a symbol. Additional features include getting stock symbols filtered by country and stock market.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yahoo_finanza'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yahoo_finanza
+
+## General Usage
+
+All that is needed to use the gem is to require yahoo_finanza:
+
+```ruby
+require 'yahoo_finanza'
+```
+
+## Client
+
+To use the client class create an instance of it:
+
+```ruby
+yahoo_finanza_client = YahooFinanza::Client.new
+```
+
+To get the quotes of a list of symbols simply do:
+
+```ruby
+quotes = yahoo_finanza_client.quotes(['JPM', 'YHOO', 'AAPL', 'GOOG', 'MSFT'])
+```
+
+To access the quotes of a symbol, for example yahoo, do:
+
+```ruby
+quote = quotes.select { |stock_quote| stock_quote == 'YHOO'}.first
+
+# => returns an OpenStruct with the quotes for each symbol
+
+quote.symbol
+
+# => returns the symbol, in this case JPM
+```
+
+To get the quote of a single of symbol do:
+
+```ruby
+quote = yahoo_finanza_client.quote('JPM')
+
+# => returns an OpenStruct with data
+
+quote.symbol
+
+# => returns the symbol, in this case JPM
+```
+
+Use quote to access all the data available.
+
+To get the historical quotes for a symbol, for example apple from 2009-03-10 to 2010-03-10, do:
+
+```ruby
+historical_quotes = yahoo_finanza_client.quotes_history(
+    'AAPL', '2009-03-10', '2010-03-10')
+
+# => returns an array of OpenStructs with data about the symbol
+```
+
+To access the first data entry of the historical quotes do:
+
+```ruby
+historical_quotes.first
+
+# => returns an OpenStruct with the data for the first entry
+
+historical_quotes.first.symbol
+
+# => returns the symbol. In this case APPL
+```
+To search for symbols call the search_symbols method
+
+```ruby
+yahoo_finanza_client.search_symbols('apple') => ["AAPL", "APLE", "AGPL", "GAPJ", "APRU", "APC.DE", "AGPLX", "APPLX", "APPIX", "ALE.V"]
+```
+
+To get most active stocks quotes call popular_stock_quotes method
+
+```ruby
+yahoo_finanza_client.popular_stock_quotes
+
+# => returns an array of quotes (OpenStructs) of the 100 most active stocks
+```
+
+This method returns an array of quotes (OpenStructs) of the 100 most active stocks in the market
+
+## Workers
+
+You can access multiple workers to use as you like so:
+
+```ruby
+YahooFinanza::WorkerName
+```
+Where WorkerName could be any of the following:
+
+   - ActiveStockWorker
+   - SingleQuoteWorker
+   - MultiQuoteWorker
+   - HistoricQuoteWorker
+   - SymbolSearchWorker
+
+### Active Stock Worker
+
+To use the active stock worker, create a new instance of the worker
+
+```ruby
+worker = YahooFinanza::ActiveStockWorker.new()
+```
+
+Then whenever it needs to fetch the most active stocks do:
+
+```ruby
+worker.run
+#=> returns an array of quotes(OpenStructs)
+```
+
+### Single Stock Worker
+
+To use the single stock worker, create a new instance of the worker
+
+```ruby
+worker = YahooFinanza::SingleQuoteWorker.new(symbol)
+# symbol is any symbol from any stock you want
+
+# Example:
+worker = YahooFinanza::SingleQuoteWorker.new('AAPL')
+```
+Then whenever it needs to fetch the quote for that symbol do:
+
+```ruby
+worker.run
+#=> returns a quote(OpenStruct) for the initialized symbol
+```
+
+#### Multi Stock Worker
+
+To use the single stock worker, create a new instance of the worker
+
+```ruby
+worker = YahooFinanza::MultiQuoteWorker.new(symbols)
+# symbols is a list of any symbols from any stocks you want
+
+# Example:
+worker = YahooFinanza::SingleQuoteWorker.new(['AAPL', 'FB', 'NFLX'])
+```
+Then whenever it needs to fetch the quote for that symbol do:
+
+```ruby
+worker.run
+#=> returns an array of quotes(OpenStructs) for the initialized symbol list
+```
+
+#### Historic Stock Worker
+
+To use the single stock worker, create a new instance of the worker
+
+```ruby
+worker = YahooFinanza::HistoricQuoteWorker.new(symbol, options)
+# symbol is any symbol from any stock you want
+# options is a hash like so: { start_date: 'YYYY-mm-dd', end_date: 'YYYY-mm-dd' }
+
+# Example:
+worker = YahooFinanza::HistoricQuoteWorker.new('AAPL', { start_date: '2009-01-10', end_date: '2009-01-15' })
+```
+Then whenever it needs to fetch the quote for that symbol do:
+
+```ruby
+worker.run
+#=> returns an array of historic data (OpenStruct) for the initialized symbol and dates
+```
+
+### Symbol Search Worker
+
+To use the active stock worker, create a new instance of the worker
+
+```ruby
+worker = YahooFinanza::SymbolSearchWorker.new(key)
+# Where key is the key you want to search for
+
+# Example:
+worker = YahooFinanza::SymbolSearchWorker.new('apple')
+```
+
+Then whenever it needs to fetch the most active stocks do:
+
+```ruby
+worker.run
+#=> returns an array of symbols
+```
+
+## Constants
+
+Constants can be used to get lists of symbols. The list of symbols include:
+
+- NYSE Market Symbols
+- NASDAQ Market Symbols
+- AMEX Market Symbols
+- S&P 500 Symbols
+
+### NYSE Market Symbol List:
+
+To get the list of the NYSE Market use:
+
+```ruby
+YahooFinanza::Constants.nyse
+# => returns a list of nyse market symbols
+```
+
+### NASDAQ Market Symbol List:
+
+To get the list of the NYSE Market use:
+
+```ruby
+YahooFinanza::Constants.nasdaq
+# => returns a list of nasdaq market symbols
+```
+
+### AMEX Market Symbol List:
+
+To get the list of the AMEX Market use:
+
+```ruby
+YahooFinanza::Constants.amex
+# => returns a list of amex market symbols
+```
+
+### S&P 500 Symbol List:
+
+To get the list of the S&P 500 Symbols use:
+
+```ruby
+YahooFinanza::Constants.sp_500
+# => returns a list of s&p 500 symbols
+```
+
+All of these lists can be sent to the client method quotes or be used in the Multi Quote Worker
+
+## Available Properties for OpenStructs
+
+- :symbol
+- :ask
+- :average_daily_volume
+- :bid
+- :ask_realtime
+- :bid_realtime
+- :book_value
+- :change_percent_change
+- :change
+- :commission
+- :currency
+- :change_realtime
+- :after_hours_change_realtime
+- :dividend_share
+- :last_trade_date
+- :trade_date
+- :earnings_share
+- :error_indicationreturnedforsymbolchangedinvalid
+- :eps_estimate_current_year
+- :eps_estimate_next_year
+- :eps_estimate_next_quarter
+- :days_low
+- :days_high
+- :year_low
+- :year_high
+- :holdings_gain_percent
+- :annualized_gain
+- :holdings_gain
+- :holdings_gain_percent_realtime
+- :holdings_gain_realtime
+- :more_info
+- :order_book_realtime
+- :market_capitalization
+- :market_cap_realtime
+- :ebitda
+- :change_from_year_low
+- :percent_change_from_year_low
+- :last_trade_realtime_with_time
+- :change_percent_realtime
+- :change_from_year_high
+- :percebt_change_from_year_high
+- :last_trade_with_time
+- :last_trade_price_only
+- :high_limit
+- :low_limit
+- :days_range
+- :days_range_realtime
+- :fiftyday_moving_average
+- :two_hundredday_moving_average
+- :change_from_two_hundredday_moving_average
+- :percent_change_from_two_hundredday_moving_average
+- :change_from_fiftyday_moving_average
+- :percent_change_from_fiftyday_moving_average
+- :name
+- :notes
+- :open
+- :previous_close
+- :price_paid
+- :changein_percent
+- :price_sales
+- :price_book
+- :ex_dividend_date
+- :pe_ratio
+- :dividend_pay_date
+- :pe_ratio_realtime
+- :peg_ratio
+- :price_eps_estimate_current_year
+- :price_eps_estimate_next_year
+- :shares_owned
+- :short_ratio
+- :last_trade_time
+- :ticker_trend
+- :oneyr_target_price
+- :volume
+- :holdings_value
+- :holdings_value_realtime
+- :year_range
+- :days_value_change
+- :days_value_change_realtime
+- :stock_exchange
+- :dividend_yield
+- :percent_change
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/yahoo_finanza/fork )
+2. Create your feature branch (`git checkout -b feature/my_new_feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Special Thanks To:
+
+1. Jonah Ruiz (jonahoffline)
+2. Robert Grayson (ybur-yug)
+3. Herval Freire (Who inspired me to implement this gem)
+4. Nasir Jamal (Thanks for the YQL gem)

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task default: :spec