Skip to content

Commit

Permalink
Bump to v0.4.0 and add UPGRADING docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rodolfobandeira committed Jul 29, 2018
1 parent 7fb1f1c commit 93e0372
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 6 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
### 0.3.4 (Next)
### 0.4.0 (next)

* Your contribution here.

* [#9](https://github.com/dblock/iex-ruby-client/pull/9): Added `IEX::Errors::ClientError` - [@rodolfobandeira](https://github.com/rodolfobandeira).
* [#10](https://github.com/dblock/iex-ruby-client/pull/10): Added `IEX::Resources::Logo#get` - [@rodolfobandeira](https://github.com/rodolfobandeira).

Expand Down
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,10 +162,6 @@ If a symbol cannot be found an [IEX::Errors::SymbolNotFound](lib/iex/errors/symb

All errors that return HTTP codes 400-600 result in a [IEX::Errors::ClientError](lib/iex/errors/client_error.rb) exception.

```ruby
IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10, invalid_option: 'foo')
```

## Contributing

See [CONTRIBUTING](CONTRIBUTING.md).
Expand Down
26 changes: 26 additions & 0 deletions UPGRADING.md
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.

2 changes: 1 addition & 1 deletion lib/iex/version.rb
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

0 comments on commit 93e0372

Please sign in to comment.