censysx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1a928dc3e503eb26fc40f8e9db02a8a10ca738e41a74f1b766c570997502200
+  data.tar.gz: 13faa72dc9fa10cb1983a91dd16e6a729828fec6c3dec40cf21d1d084c7b60dd
+SHA512:
+  metadata.gz: 8c44202221979f299bf1ccfffa45ebf5a36ee1e4cc03ab93bb0fc9d7bf90f8e0d60b3e834d921b52f4436ed11703588dbab392a6c666f7a2ddf4b77adfee0a3f
+  data.tar.gz: 24ab4f8fa09bbfe4af64c0f553bc0638ffb995bbfad77cecaeb025b67ae992354e22b10d9e96b2a2dbc2dfadbdabd5c7631f3b1574dea587443d090bbba9eb7c

data/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+          bundler-cache: true
+
+      - name: Run the default task
+        run: |
+          gem install bundler -v 2.2.15
+          bundle install
+          bundle exec rake

data/.gitignore

@@ -0,0 +1,59 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in censysx.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Manabu Niseki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# Censysx
+
+A Censys Search v2 API wrapper for Ruby. 💎
+
+- [Official API Docs](https://search.censys.io/api)
+
+## Installation
+
+```bash
+gem install censysx
+```
+
+## Usage
+
+Initialize the API:
+
+```ruby
+require "censys"
+
+api = Censys::API.new(id, secret)
+```
+
+You can initialize the API by using `$CENSYS_ID` and `$CENSYS_SECRET` environment variables:
+
+```ruby
+# in this case, it tries to load ID and secret from ENV
+# - ENV["CENSYS_ID"] for the ID
+# - ENV["CENSYS_SECRET"] for the secret
+api = Censys::API.new
+```
+
+View:
+
+```ruby
+response = api.view("1.1.1.1")
+response = api.view("1.1.1.1", at_time: "2021-03-01T00:00:00.000000Z")
+```
+
+Search:
+
+```ruby
+response = api.search(query, cursor: cursor)
+```
+
+Search with cursor:
+
+```ruby
+cursor = nil
+
+loop do
+  response = api.search(query, cursor: cursor)
+
+  links = response.dig("result", "links")
+  cursor = links["next"]
+  break if cursor == ""
+end
+```
+
+Aggregate:
+
+```ruby
+response = api.aggregate(query, field)
+response = api.aggregate(query, field, num_buckets: num_buckets)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "censysx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/censysx.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/censys/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "censysx"
+  spec.version       = Censys::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = "Censys Search v2 API wrapper for Ruby"
+  spec.homepage      = "https://github.com/ninoseki/censysx"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ninoseki/censysx"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "coveralls_reborn", "~> 0.22"
+  spec.add_development_dependency "dotenv", "~> 2.7"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "rubocop", "~> 1.16"
+  spec.add_development_dependency "rubocop-performance", "~> 1.11"
+  spec.add_development_dependency "rubocop-rake", "~> 0.5"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.3"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.13"
+end

data/lib/censys.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "censys/version"
+
+require_relative "censys/exceptions"
+
+require_relative "censys/api"

data/lib/censys/api.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require "censys/exceptions"
+
+require "net/https"
+require "json"
+require "time"
+
+module Censys
+  #
+  # Censys Search v2 API wrapper
+  #
+  class API
+    VERSION = 2
+    HOST = "search.censys.io"
+    URL = "https://#{HOST}/api/v#{VERSION}/hosts"
+
+    #
+    # Initializes the API.
+    #
+    # @param [String] id the API UID used for authentication.
+    #
+    # @param [String] secret the API secret used for authentication.
+    #
+    # @raise [ArgumentError] either `id` or `secret` was `nil` or empty.
+    #
+    # @see https://censys.io/account
+    #   Censys - My Account
+    #
+    def initialize(id = ENV["CENSYS_ID"], secret = ENV["CENSYS_SECRET"])
+      raise(ArgumentError, "'id' argument is required") if id.nil? || id.empty?
+      raise(ArgumentError, "'secret' argument is required") if secret.nil? || secret.empty?
+
+      @id = id
+      @secret = secret
+    end
+
+    #
+    # View document from current index.
+    #
+    # View the current structured data we have on a specific document.
+    # For more details, see our documentation: https://search.censys.io/api/v2/docs
+    #
+    # @param [String] document_id the ID of the document you are requesting.
+    # @param [String, Time, nil] at_time Fetches a document at a given point in time.
+    #
+    # @return [Hash]
+    #
+    def view(document_id, at_time: nil)
+      at_time = at_time.strftime("%Y-%m-%dT%H:%M:%S.%6NZ") if at_time.is_a?(Time)
+      params = { at_time: at_time }.compact
+
+      get("/#{document_id}", params) do |json|
+        json
+      end
+    end
+
+    #
+    # Search current index.
+    #
+    # Searches the given index for all records that match the given query.
+    # For more details, see our documentation: https://search.censys.io/api/v2/docs
+    #
+    # @param [String] query the query to be executed.
+    # @params [Integer, nil] per_page the number of results to be returned for each page.
+    # @params [Integer, nil] cursor the cursor of the desired result set.
+    #
+    # @return [Hash]
+    #
+    def search(query, per_page: nil, cursor: nil)
+      params = { q: query, per_page: per_page, cursor: cursor }.compact
+      get("/search", params) do |json|
+        json
+      end
+    end
+
+    #
+    # Aggregate current index.
+    #
+    # Creates a report on the breakdown of the values of a field in a result set.
+    # For more details, see our documentation: https://search.censys.io/api/v2/docs
+    #
+    # @param [String] query the query to be executed.
+    # @param [String] field the field you are running a breakdown on.
+    # @param [Integer, nil] num_buckets the maximum number of values. Defaults to 50.
+    #
+    # @return [Hash]
+    #
+    def aggregate(query, field, num_buckets: nil)
+      params = { q: query, field: field, num_buckets: num_buckets }.compact
+      get("/aggregate", params) do |json|
+        json
+      end
+    end
+
+    private
+
+    #
+    # Returns a URL for the API sub-path.
+    #
+    # @param [String] path the path relative to `/api/v2`.
+    #
+    # @return [URI::HTTPS] fully qualified URI.
+    #
+    def url_for(path)
+      URI(URL + path)
+    end
+
+    #
+    # Return HTTPS options
+    #
+    # @return [Hash]
+    #
+    def https_options
+      proxy = ENV["HTTPS_PROXY"]
+
+      return { use_ssl: true } unless proxy
+
+      uri = URI(proxy)
+      {
+        proxy_address: uri.hostname,
+        proxy_port: uri.port,
+        proxy_from_env: false,
+        use_ssl: true
+      }
+    end
+
+    #
+    # Sends the HTTP request and handles the response.
+    #
+    # @param [Net::HTTP::Get, Net::HTTP::Post] req the prepared request to send.
+    #
+    # @yield [json] the given block will be passed the parsed JSON.
+    #
+    # @yieldparam [Hash{String => Object}] json the parsed JSON.
+    #
+    # @raise [NotFound, RateLimited, InternalServerError, ResponseError]
+    #   If an error response is returned, the appropriate exception will be
+    #   raised.
+    #
+    def request(req)
+      Net::HTTP.start(HOST, 443, https_options) do |http|
+        response = http.request(req)
+
+        json = JSON.parse(response.body)
+        error = json["error"]
+
+        case response.code
+        when "200" then yield JSON.parse(response.body)
+        when "302" then raise AuthenticationError, error
+        when "403" then raise Forbidden, error
+        when "404" then raise NotFound, error
+        when "429" then raise RateLimited, error
+        when "500" then raise InternalServerError, error
+        else
+          raise Error, error
+        end
+      end
+    end
+
+    #
+    # Creates a new HTTP GET request.
+    #
+    # @param [String] path
+    # @param [Hash] query parameters
+    #
+    # @see #request
+    #
+    def get(path, params, &block)
+      url = url_for(path)
+      url.query = URI.encode_www_form(params)
+
+      get = Net::HTTP::Get.new(url)
+      get.basic_auth @id, @secret
+
+      request(get, &block)
+    end
+  end
+end

data/lib/censys/exceptions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Censys
+  class Error < StandardError; end
+
+  class AuthenticationError < Error; end
+
+  class NotFound < Error; end
+
+  class Forbidden < Error; end
+
+  class RateLimited < Error; end
+
+  class InternalServerError < Error; end
+end

data/lib/censys/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Censys
+  VERSION = "0.1.0"
+end

data/lib/censysx.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "censys/version"
+
+require_relative "censys/exceptions"
+
+require_relative "censys/api"

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: censysx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manabu Niseki
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls_reborn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description:
+email:
+- manabu.niseki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- censysx.gemspec
+- lib/censys.rb
+- lib/censys/api.rb
+- lib/censys/exceptions.rb
+- lib/censys/version.rb
+- lib/censysx.rb
+homepage: https://github.com/ninoseki/censysx
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ninoseki/censysx
+  source_code_uri: https://github.com/ninoseki/censysx
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Censys Search v2 API wrapper for Ruby
+test_files: []