yahoo_finance_2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b52929bca6aeb2d0f0584573088d698676f494ba
+  data.tar.gz: 9ee94fbf1c5e7db78320dddf6ab9b1e22dffdef7
+SHA512:
+  metadata.gz: a84d5802639e1df00858c5e07258f657710de0e02fa48215a184e2261e1777ac68cdd6934474270818d7fe1ebde8d9cfcc10a05697a395c68d2ad9c68516ad68
+  data.tar.gz: 18ea881e5827986723ef13c9d2bb129fd81379e087fe76a9cce183f7bd39ea737999be2a748c1d0909dbf4bfdd860e107ed063573e5ccc1d294c44dbe54db472

data/README.md

@@ -0,0 +1,218 @@
+# yahoo_finance
+
+A ruby gem that retrieves real-time stock quotes and historical pricing from ~~google~~ yahoo.
+
+# Update
+
+On November 1, 2013, Google discontinued iGoogle, which contained the api endpoint yahoo_finance utilized, rendering the gem inoperable.
+
+As of November 2nd, 2013, the yahoo_finance gem has been rebuilt to use the Yahoo finance api, starting with version 1.1.0.  All applications leveraging this gem should update to 1.1.0 to resume operation. The gem methods are the same, but responses have been modified to leverage the new api.  Documentation has been updated to reflect these changes.
+
+## Installation
+
+To install the 'yahoo_finance' ruby gem:
+
+`gem install yahoo_finance`
+
+## Gem Configuration
+
+To use the gem in your Rails Application, include it:
+
+### Rails 2+
+
+Include the gem in config/environments.rb:
+
+`config.gem "yahoo_finance"`
+
+### Rails 3+
+
+Include the gem in your Gemfile:
+
+`gem "yahoo_finance"`
+
+## Usage
+
+### YahooFinance::Stock.quote("symbol")
+
+You can get a current quote with the following syntax:
+
+`stock = YahooFinance::Stock.quote("symbol")`
+
+Where symbol equals the company stock symbol you want a quote for. For example, "aapl" for Apple, Inc.
+
+You may search for multiple stocks by separating symbols with a comma. For example:
+
+`stocks = YahooFinance::Stock.quote("aapl,tsla")`
+
+Or as an array.
+
+`stocks = YahooFinance::Stock.quote(["aapl", "tsla"])`
+
+These queries will return a Stock object or an array of Stock objects which you may iterate through. Each stock object has the following values:
+
+* symbol
+* ask
+* average_daily_volume
+* bid
+* ask_realtime
+* bid_realtime
+* book_value
+* change_percent_change
+* change
+* commission
+* change_realtime
+* after_hours_change_realtime
+* dividend_share
+* last_trade_date
+* trade_date
+* earnings_share
+* 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
+* symbol
+* 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",
+
+### YahooFinance::Stock.history(symbol, start_date, end_date)
+
+YahooFinance::Stock.history(symbol, start_date, end_date) is as alias to YahooFinance::Stock.quote(symbol, start_date, end_date).
+
+If you pass quote a start_date and end_date it will do a historical query within the date range as opposed to a realtime quote.  Only one stock symbol should be used for historical quotes.
+
+Historical queries provide an array of Price objects with the following values:
+
+* symbol
+* date
+* open
+* high
+* low
+* close
+* volume
+
+## Values
+
+Values may be accessed off the Stock or Price object like so:
+
+`YahooFinance::Stock.quote("SYMBOL").last`
+
+Or:
+
+`stock = YahooFinance::Stock.quote("SYMBOL")`
+
+`stock.last`
+
+You can always convert the queries results to json with the following commands:
+
+`YahooFinance::Stock.quote("SYMBOL").to_json`
+
+Or:
+
+`YahooFinance::Stock.history("SYMBOL").to_json`
+
+
+## Response Codes
+
+Stock instances now include a response_code: 200 and 404.
+
+    > @stock = YahooFinance::Stock.quote('aapl')
+    > @stock.response_code
+      => 200
+
+Additionally, stock instances now have a success? and failure? method.
+
+    > @stock.success?
+      => true
+
+In the event that a stock symbol is incorrect, the returned instance will provide a response code of 404 and respond in the affirmative to a failure? method call.
+
+    > @stock = YahooFinance::Stock.quote('asdf')
+    > @stock.response_code
+      => 404
+    > @stock.failure?
+      => true
+
+## Special thanks to
+
+...~~Google~~ Yahoo for making this api publicly available.
+
+## License
+
+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.
+

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: yahoo_finance_2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Adamson, Ty Rauber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rest-client
+  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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  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: vcr
+  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'
+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.
+email:
+- aadamson@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+homepage: https://github.com/aadamson/yahoo_finance
+licenses: []
+metadata: {}
+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.0.6
+signing_key: 
+specification_version: 4
+summary: A ruby gem that retrieves real-time stock quotes from google.
+test_files: []