Issue 28 implement ipo calendar #33
Conversation
latest (10/6/2018) master from dblock/iex-ruby-client
…pec to include last update date
…roken link and minor spelling error
|
@rodolfobandeira, @dblock: Please review and let me know what additional modifications/refactors are needed. |
CHANGELOG.md
Outdated
| @@ -1,6 +1,7 @@ | |||
| ### 0.4.4 (next) | |||
|
|
|||
| * [#32](https://github.com/dblock/iex-ruby-client/pull/32): Add `IEX::Resource::Sectors` - [@gil27](https://github.com/gil27). | |||
| * [#33](https://github.com/dblock/iex-ruby-client/pull/33): Add `IEX::Resource::Sectors` - [@marchyoung](https://github.com/marchyoung). | |||
There was a problem hiding this comment.
Please fix the typo. I guess it should be something like: IEX::Resources::IPOCalendar.today/upcoming ?
|
|
||
| ### Get IPO Calendar | ||
|
|
||
| Fetches a list of IPOs scheduled for the current and next month. Use `today` to get a list of today's IPOs and `upcoming` to get a list of upcoming IPOs. Each scheduled IPO listing is schematically split into separate lists of comprehensive IPO information in `raw_data` with a corresponding abridged summary in `view_data`. |
There was a problem hiding this comment.
You did a great job on this PR @marchyoung !
I understand your point adding these two options. Although when I first read raw_data, I was expecting to see indeed the raw data coming from the API, but the data is being changed using the lambdas on the IPO class. That said, in favor for backwards compatibility, I would move the view_data/raw_data from the response in a different way into one additional method only that returns the data you want.
IEX::Resources::IPOCalendar.today
IEX::Resources::IPOCalendar.today_summary
IEX::Resources::IPOCalendar.upcoming
IEX::Resources::IPOCalendar.upcoming_summarySo, this way, we assume that calling .today would return raw_data by default. If a light version of the returned data is requested, then calling .today_summary would do what the view_data is currently returning.
ipos_today = IEX::Resources::IPOCalendar.today
ipos_today.first.market # => 'NASDAQ Global Select'
ipos_today.first.ceo # => 'Stephane Kasriel'@dblock Any thoughts?
There was a problem hiding this comment.
@rodolfobandeira , @dblock : Thanks for the feedback! I'd be more than happy to make view_data/raw_data return the "JSON-to-Hashie" conversion values only and move the lambda-based conversion logic to new today/upcoming and today_summary/upcoming_summary methods.
There was a problem hiding this comment.
Right on @rodolfobandeira, we want a collection of first class objects here.
….4 changes in CHANGELOG.md
|
Hey @marchyoung, Any update on this? if you're busy, I can try helping out by making a PR to your fork. Please let us know, thanks! |
PR to Implement IPO Calendar #28