No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
.editorconfig
.gitignore
License.txt
readme.md
webhoseio.gemspec

readme.md

webhose.io client for Ruby

Gem

A simple way to access the Webhose.io API from your Ruby code

require 'webhoseio'

webhoseio = Webhoseio::Client.new('YOUR_API_KEY')
output = webhoseio.query('filterWebContent', {'q': 'github'})
puts output['posts'][0]['text'] # Print the text of the first post
puts output['posts'][0]['published'] # Print the text of the first post publication date

# Get the next batch of posts
output = webhoseio.get_next()
puts output['posts'][0]['thread']['site'] # Print the site of the first post

API Key

To make use of the webhose.io API, you need to obtain a token that would be used on every request. To obtain an API key, create an account at https://webhose.io/auth/signup, and then go into https://webhose.io/dashboard to see your token.

Installing

You can install this SDK by simply downloading webhoseio.rb and including it to your project.

Or using gem

$ gem install webhoseio-ruby

Use the API

To get started, you need to import the library, and set your access token. (Replace YOUR_API_KEY with your actual API key).

require 'webhoseio'
webhoseio = Webhoseio.new('YOUR_API_KEY')

API Endpoints

The first parameter the query() function accepts is the API endpoint string. Available endpoints:

  • filterWebContent - access to the news/blogs/forums/reviews API
  • productFilter - access to data about eCommerce products/services
  • darkFilter - access to the dark web (coming soon)

Now you can make a request and inspect the results:

output = webhoseio.query('filterWebContent', {'q': 'github'})
puts output['totalResults']
# 15565094
puts output['posts'].size
# 100
puts output['posts'][0]['language']
# english
puts output['posts'][0]['title']
# Putting quotes around dictionary keys in JS

For your convenience, the output object is iterable, so you can loop over it and get all the results of this batch (up to 100).

total_words = 0
output['posts'].each do |post|
  total_words += post['text'].split(' ').size
end
puts total_words

Full documentation

  • config(token)

    • token - your API key
  • query(end_point_str, params)

    • end_point_str:
      • filterWebContent - access to the news/blogs/forums/reviews API
      • productFilter - access to data about eCommerce products/services
      • darkFilter - access to the dark web (coming soon)
    • params: A key value dictionary. The most common key is the "q" parameter that hold the filters Boolean query. Read about the available filters.
  • get_next() - a method to fetch the next page of results.

Polling

If you want to make repeated searches, performing an action whenever there are new results, use code like this:

r = webhoseio.query('filterWebContent', {'q': 'skyrim'})
while true do
  r['posts'].each do |post|
    perform_action(post)
    sleep(0.3)
    r = webhoseio.get_next()
  end
end