censu 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc032c148fcfd0d25166894346ef57abb771edba
-  data.tar.gz: 7bc3d93c58883260e0eb274f9104b505ea99156a
+  metadata.gz: 1a65cae212177db3ce66c6b68aae16e212427e21
+  data.tar.gz: 967f33e9e61180fddb1b8b16b35d6454f29c17e6
 SHA512:
-  metadata.gz: a7283ce3bb2407fd4e85874432139a2742d4d052b2d2db8674cbd23ad208cd43f67ff883d3c4339caccba23787aa721c59e2cb007622707db568916fc84879f7
-  data.tar.gz: 5c8011da8618be9bd7cc7e5f7ababd13f811c00fe896de01b2ba34924431ea42e07a3f80c4827e3e8becb0a930b35a853ce931ac7f164f66b7250eab4b66f3f4
+  metadata.gz: 8b762c4f2e09e700e130515cbe32edbb7ace961de5031a291100f3d64977933977accd8507e8ca2f1958b7ad31c41c91df05dd103d8e7e1604e95d973c1344ae
+  data.tar.gz: 3b69de965819865490e59189792b74d1ef31480a9e8fba781112f3731bdec2629191cb99f84bb997d95c1ee24fdde13623767120481bd1b4e421d5aacfc71bb7

data/.codeclimate.yml

@@ -9,5 +9,4 @@ plugins:
     config:
       file: "alternate-rubocop-path.yml"
 exclude_patterns:
-  - "spec/"
-  - "!spec/support/helpers"
+  - "spec/**/*"

data/README.md

@@ -10,61 +10,109 @@
 
 Ruby API client to the [Censys] internet search engine.
 
-## Features
 
 ## Examples
 
 Initialize the API:
 
-    require 'censys'
-    api = Censys::API.new(uid,secret)
+```ruby
+require 'censys'
+api = Censys::API.new(uid, secret)
+```
 
 Initialize the API using `$CENSYS_ID` and `$CENSYS_SECRET` environment
 variables:
 
-    api = Censys::API.new
+```ruby
+api = Censys::API.new
+```
 
 Search for IPv4 addresses:
 
-    response = api.ipv4.search(query: 'dropbox.com')
+```ruby
+response = api.ipv4.search(query: 'dropbox.com')
+```
 
 Search for Websites:
 
-    response = api.websites.search(query: 'dropbox.com')
+```ruby
+response = api.websites.search(query: 'dropbox.com')
+```
 
 Search for Certificates:
 
-    response = api.certificates.search(query: 'dropbox.com')
+```ruby
+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|
+```ruby
+response.each_page do |page|
+    puts ">>> Page ##{page.metadata.page} / #{page.metadata.pages} ..."
+    page.each do |result|
         puts result
-      end
     end
+end
+```
 
-Generate aggregate reports:
+View for IPv4 addresses:
 
-    response = api.websites.report(
-      query: '80.http.get.headers.server: Apache',
-      field: 'location.country_code',
-      buckets: 100
-    )
+```ruby
+view = api.ipv4["8.8.8.8"]
+```
 
-    response.each do |country,count|
-      puts "#{country}: #{count}"
-    end
+View for Websites:
+
+```ruby
+view = api.websites["google.com"]
+```
+
+View for Certificates:
+
+```ruby
+view = api.certificates["821a712a29d8e25915f66a9771519746c5aa73a45321fd4ca7ef644e1cadda59"]
+```
+
+Generate aggregate reports:
+
+```ruby
+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
+```
+
+Combine Search and View API.
+
+```ruby
+api = Censys::API.new
+response = api.websites.search(query: "hoge")
+response.each_page do |page|
+  page.each do |result|
+    view = api.websites[result.domain]
+    p view.domain                 # => e.g. "nrc.nl"
+    p view.autonomous_system.name # => e.g. "NL-INTERMAX"
+    p view.location.country       # => e.g. "Netherlands"
+    p view.protocols              # => e.g. ["80/http", "0/lookup", "25/smtp", "443/https_www", "443/https", "80/http_www"]
+  end
+end
+```
 
 ## Requirements
 
-* [ruby] >= 2.0
+* [ruby] >= 2.4
 
 ## Install
 
-    $ gem install censu
+```bash
+% gem install censu
+```
 
 ## License
 
@@ -73,4 +121,4 @@ 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/
+[Censys]: https://censys.io/

data/lib/censu.rb

@@ -0,0 +1,2 @@
+require 'censys/api'
+require 'censys/version'

data/lib/censys/document/has_http_response.rb

@@ -0,0 +1,16 @@
+require 'censys/http_response'
+
+module Censys
+  class Document
+    module HasHTTPResponse
+      #
+      # HTTP reponse information.
+      #
+      # @return [HTTPResponse]
+      #
+      def http_response
+        @http_reponse ||= HTTPResponse.new(@attributes.dig("80", "http"))
+      end
+    end
+  end
+end

data/lib/censys/http_response.rb

@@ -0,0 +1,48 @@
+module Censys
+  class HTTPResponse
+    #
+    # Initializes the HTTP Response infromation
+    #
+    # @param [Hash{String => Object}] attributes
+    #
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    #
+    # HTTP body
+    #
+    # @return [String] body
+    #
+    def body
+      @attributes.dig("get", "body")
+    end
+
+    #
+    # HTTP header
+    #
+    # @return [Hash] header
+    #
+    def header
+      @attributes.dig("get", "headers")
+    end
+
+    #
+    # HTTP status code
+    #
+    # @return [Integer] status code
+    #
+    def status_code
+      @attributes.dig("get", "status_code")
+    end
+
+    #
+    # HTTP title
+    #
+    # @return [String] title
+    #
+    def title
+      @attributes.dig("get", "title")
+    end
+  end
+end

data/lib/censys/version.rb

@@ -1,4 +1,4 @@
 module Censys
   # censys version
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.2".freeze
 end

data/lib/censys/website.rb

@@ -2,12 +2,14 @@ require 'censys/document'
 require 'censys/document/has_services'
 require 'censys/document/has_location'
 require 'censys/document/has_asn'
+require 'censys/document/has_http_response'
 
 module Censys
   class Website < Document
     include HasServices
     include HasLocation
     include HasASN
+    include HasHTTPResponse
 
     #
     # @return [String]

data/spec/view_spec.rb

@@ -31,6 +31,12 @@ describe Censys::API do
         expect(view.domain).to eq("google.com")
         expect(view.to_s).to eq("google.com")
         expect(view.alexa_rank).to be_a(Integer)
+
+        expect(view.http_response).to be_a(Censys::HTTPResponse)
+        expect(view.http_response.body).to be_a(String)
+        expect(view.http_response.header).to be_a(Hash)
+        expect(view.http_response.status_code).to eq(200)
+        expect(view.http_response.title).to eq("Google")
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: censu
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Manabu Niseki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-16 00:00:00.000000000 Z
+date: 2017-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,15 +141,18 @@ files:
 - README.md
 - Rakefile
 - censys.gemspec
+- lib/censu.rb
 - lib/censys.rb
 - lib/censys/api.rb
 - lib/censys/autonomous_system.rb
 - lib/censys/certificate.rb
 - lib/censys/document.rb
 - lib/censys/document/has_asn.rb
+- lib/censys/document/has_http_response.rb
 - lib/censys/document/has_location.rb
 - lib/censys/document/has_services.rb
 - lib/censys/exceptions.rb
+- lib/censys/http_response.rb
 - lib/censys/ipv4.rb
 - lib/censys/location.rb
 - lib/censys/report.rb