README.md in stock_index-0.8.3 vs README.md in stock_index-0.8.4
- old
+ new
@@ -21,28 +21,28 @@
There is no a standard for indices symbols, so this gem uses Yahoo Finance symbols.
| Symbol | Index Name | Reference pages |
| ------ | ---------- | -------------- |
-| ^DJI | DOW JONES INDUSTRIAL AVERAGE | http://en.wikipedia.org/wiki/Dow_Jones_Industrial_Average |
-| ^GSPC | S&P 500 | http://en.wikipedia.org/wiki/List_of_S%26P_500_companies |
-| ^NDX | NASDAQ 100 | https://indexes.nasdaqomx.com/Index/Weighting/NDX<br/>http://en.wikipedia.org/wiki/NASDAQ-100 |
-| ^N225 | NIKKEI 225 | http://indexes.nikkei.co.jp/en/nkave/index/component?idx=nk225<br/>http://en.wikipedia.org/wiki/Nikkei_225 |
-| ^FTSE | FTSE 100 | http://www.londonstockexchange.com/exchange/prices-and-markets/stocks/indices/summary/summary-indices-constituents.html?index=UKX<br/>http://en.wikipedia.org/wiki/FTSE_100_Index#Current_constituents |
+| ^DJI | DOW JONES INDUSTRIAL AVERAGE | https://en.wikipedia.org/wiki/Dow_Jones_Industrial_Average |
+| ^GSPC | S&P 500 | https://en.wikipedia.org/wiki/List_of_S%26P_500_companies |
+| ^NDX | NASDAQ 100 | https://indexes.nasdaqomx.com/Index/Weighting/NDX<br/>https://en.wikipedia.org/wiki/NASDAQ-100 |
+| ^N225 | NIKKEI 225 | http://indexes.nikkei.co.jp/en/nkave/index/component?idx=nk225<br/>https://en.wikipedia.org/wiki/Nikkei_225 |
+| ^FTSE | FTSE 100 | http://www.londonstockexchange.com/exchange/prices-and-markets/stocks/indices/summary/summary-indices-constituents.html?index=UKX<br/>https://en.wikipedia.org/wiki/FTSE_100_Index#Current_constituents |
## Roadmap
These indices will be supported in the future:
| Symbol | Index Name | Reference pages |
| ------ | ---------- | -------------- |
-| ^STOXX50E | EURO STOXX 50 | http://www.stoxx.com/indices/index_information.html?symbol=SX5E |
-| ^GDAXI | DAX | http://en.wikipedia.org/wiki/DAX |
-| ^FCHI | CAC 40 | http://en.wikipedia.org/wiki/CAC_40 |
-| FTSEMIB.MI | FTSE MIB | http://en.wikipedia.org/wiki/FTSE_MIB |
-| ^IBEX | IBEX 35 | http://en.wikipedia.org/wiki/IBEX_35 |
-| ^AEX | AEX | http://en.wikipedia.org/wiki/AEX_index |
+| ^STOXX50E | EURO STOXX 50 | https://www.stoxx.com/indices/index_information.html?symbol=SX5E |
+| ^GDAXI | DAX | https://en.wikipedia.org/wiki/DAX |
+| ^FCHI | CAC 40 | https://en.wikipedia.org/wiki/CAC_40 |
+| FTSEMIB.MI | FTSE MIB | https://en.wikipedia.org/wiki/FTSE_MIB |
+| ^IBEX | IBEX 35 | https://en.wikipedia.org/wiki/IBEX_35 |
+| ^AEX | AEX | https://en.wikipedia.org/wiki/AEX_index |
## Usage
```ruby
components = StockIndex.new('^DJI').components
@@ -50,31 +50,37 @@
This method returns an array of components. Each component is a Hash with this format:
```ruby
{
:market => 'XNYS',
- :symbol => 'MMM',
- :name => '3M CO',
- :wikipedia => 'http://en.wikipedia.org/wiki/3M',
- :cik => '0000066740',
- :bbgid => 'BBG000BP52R2'
+ :share => {
+ :symbol => 'MMM',
+ :name => '3M CO',
+ :bbgid => 'BBG000BP52R2'
+ },
+ :company => {
+ :name => '',
+ :wikipedia => 'http://en.wikipedia.org/wiki/3M',
+ :cik => '0000066740',
+ }
}
```
-| Key | Description |
-| ----------| ----------- |
-| market | Market symbol according to [ISO 10383](https://github.com/javiervidal/mic) |
-| symbol | Component symbol |
-| name | Component name according to [Bloomberg Open Symbology](http://bsym.bloomberg.com/sym/) |
-| wikipedia | Link to the wikipedia page of the component, when possible. |
-| cik | Component CIK (Central Index Key) assigned to the company by the SEC. Only for US components. |
-| bbgid | BBGID (Bloomberg Security Identifier) according to [Bloomberg Open Symbology](http://bsym.bloomberg.com/sym/)|
+| Key | Description |
+| ---------------------| ----------- |
+| market | Market symbol according to [ISO 10383](https://github.com/javiervidal/mic) |
+| share => symbol | Component symbol |
+| share => name | Component name according to [Bloomberg Open Symbology](http://bsym.bloomberg.com/sym/) |
+| share => bbgid | BBGID (Bloomberg Security Identifier) according to [Bloomberg Open Symbology](http://bsym.bloomberg.com/sym/)|
+| company => name | Company name according to |
+| company => wikipedia | Link to the wikipedia page of the component, when possible. |
+| company => cik | Component CIK (Central Index Key) assigned to the company by the SEC. Only for US components. |
-The name and cik are obtained querying the [EDGAR database](http://www.sec.gov/edgar/searchedgar/companysearch.html).
+Share's bbgid is obtained from [Bloomberg Open Symbology predefined files](http://bsym.bloomberg.com/sym/).
-The bbgid is obtained from [Bloomberg Open Symbology predefined files](http://bsym.bloomberg.com/sym/).
+Company's name, cik, and sic are obtained querying the [EDGAR database](http://www.sec.gov/edgar/searchedgar/companysearch.html). These data is available only for US indices.
-The name, cik, and bbgid are cached using [PStore](http://ruby-doc.org/stdlib-1.9.2/libdoc/pstore/rdoc/PStore.html).
+Share's name, and bbgid are cached using [PStore](http://ruby-doc.org/stdlib-1.9.2/libdoc/pstore/rdoc/PStore.html).
## How to Launch the Console
$ rake console
\ No newline at end of file