# Censu

[![Build Status](https://travis-ci.org/ninoseki/censu.svg?branch=master)](https://travis-ci.org/ninoseki/censu)
[![Maintainability](https://api.codeclimate.com/v1/badges/39e77d63ce6a7d89b4dc/maintainability)](https://codeclimate.com/github/ninoseki/censu/maintainability)

* [Homepage](https://github.com/ninoseki/censu)
* [Issues](https://github.com/ninoseki/censu/issues)

## Description

Ruby API client to the [Censys] internet search engine.

## Features

## Examples

Initialize the API:

    require 'censys'
    api = Censys::API.new(uid,secret)

Initialize the API using `$CENSYS_ID` and `$CENSYS_SECRET` environment
variables:

    api = Censys::API.new

Search for IPv4 addresses:

    response = api.ipv4.search(query: 'dropbox.com')

Search for Websites:

    response = api.websites.search(query: 'dropbox.com')

Search for Certificates:

    response = api.certificates.search(query: 'dropbox.com')

Enumerate through search results:

    response.each_page do |page|
      puts ">>> Page ##{page.metadata.page} / #{page.metadata.pages} ..."

      page.each do |result|
        puts result
      end
    end

Generate aggregate reports:

    response = api.websites.report(
      query: '80.http.get.headers.server: Apache',
      field: 'location.country_code',
      buckets: 100
    )

    response.each do |country,count|
      puts "#{country}: #{count}"
    end

## Requirements

* [ruby] >= 2.0

## Install

    $ gem install censu

## License

See {file:LICENSE.txt} for details.

Note:: This gem is forked from [trailofbits/censys-ruby](https://github.com/trailofbits/censys-ruby).

[ruby]: http://www.ruby-lang.org/
[Cens:qys]: https://censys.io/