-
-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bump to v0.4.0 and add UPGRADING docs
- Loading branch information
1 parent
7fb1f1c
commit 93e0372
Showing
4 changed files
with
29 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
Upgrading iex-ruby-client | ||
=========================== | ||
|
||
### Upgrading to >= 0.4.0 | ||
|
||
#### All errors that return HTTP codes 400-600 result in a IEX::Errors::ClientError exception | ||
|
||
On previous versions, calling `IEX::Resources::Chart.get` with an invalid option results on a | ||
`Faraday::ClientError`. On versions >= 0.4.0, it will return an `IEX::Errors::ClientError`. | ||
|
||
Before: | ||
|
||
```ruby | ||
IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10, invalid_option: 'foo') | ||
> Faraday::ClientError: the server responded with status 400 | ||
``` | ||
|
||
After: | ||
|
||
```ruby | ||
IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10, invalid_option: 'foo') | ||
> IEX::Errors::ClientError: "invalidOption" is not allowed | ||
``` | ||
|
||
See [#9](https://github.com/dblock/iex-ruby-client/pull/9) for more information. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
module IEX | ||
VERSION = '0.3.4'.freeze | ||
VERSION = '0.4.0'.freeze | ||
end |