kirillshevch/news_api

An API wrapper for News API v2

NewsApi

An API wrapper for News API v2

Installation

Add this line to your application's Gemfile:

gem 'news_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install news_api

Configuration

Add setting with your API key.

NewsApi::Settings.configure do |config|
  config.api_key = 'your_api_key'
end

Usage

News API has 2 main endpoints and 1 minor endpoint.

Read more about required and available params.

Each request below returns instance of ApiStruct::Entity

Top headlines

NewsApi::TopHeadliners.search(country: :us, pageSize: 2)

Everything

NewsApi::Everything.search(q: 'bitcoin', pageSize: 2)

Sources

NewsApi::Sources.search

Errors handling

Each result respond on methods .failure? and .success?.

For example you have invalid API key:

NewsApi::Settings.configure do |config|
  config.api_key = 'fail_key'
end

NewsApi::Sources.search
=> #<Hashie::Mash body=#<Hashie::Mash code="apiKeyInvalid" message="Your API key is invalid or incorrect. Check your key, or go to https://newsapi.org to create a free API key." status="error"> error=true status=#<HTTP::Response::Status 401 Unauthorized>>

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kirillshevch/news_api.

License

The gem is available as open source under the terms of the MIT License.

news_api's Issues

Question about implementation

@kirillshevch I am a volunteer at a not-for-profit (breakdiving.io).

Am I correct in understanding that this gem will allow us to display news from around the world in a news feed on our site?

If so, from which sources? Where does it get the news headlines?

And how would we actually display the items? Via a .each do loop?

Thanks!
-Monroe