spysex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 349d1252d038b09b7042965cc022bb33dbaf841699d76b4403a8ede215b667fd
+  data.tar.gz: b98c60bde0e6dc5272e1d5e6a52fa1d96292c5fc42c6c0e6763c3db803de4a9a
+SHA512:
+  metadata.gz: 993f76ca091a2d04ea35614100c25bd0fcfc94c74ee92a8cea874d81669705f2c1b6551e7e38ae086290af98e21650d9f5e48673638e1e20eece617830452cbf
+  data.tar.gz: 0b96be9c75d50bb6f68fca1473b14b6c7727b911b3045d206149454ba8edf7641071afda4b972bb0f55f59b0bb717466e195968ebe7f2687b503229d01b12b2a

data/.gitignore

@@ -0,0 +1,58 @@
+*.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_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7
+before_install: gem install bundler -v 2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in spysex.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 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,36 @@
+# spysex
+
+[![Build Status](https://travis-ci.com/ninoseki/spysex.svg?branch=master)](https://travis-ci.com/ninoseki/spysex)
+[![Coverage Status](https://coveralls.io/repos/github/ninoseki/spysex/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/spysex?branch=master)
+[![CodeFactor](https://www.codefactor.io/repository/github/ninoseki/spysex/badge)](https://www.codefactor.io/repository/github/ninoseki/spysex)
+
+A dead simple [Spyse](https://spyse.com) API wrapper for Ruby.
+
+Note: this wrapper does not support all the API endpoints.
+
+## Installation
+
+```bash
+gem install spysex
+```
+
+## Usage
+
+```ruby
+require "spysex"
+
+# when given nothing, it tries to load your usernamem & API key via ENV["SPYSE_API_KEY"]
+api = Spyse::API.new
+# or you can set them manually
+api = Spyse::API.new("foo bar")
+
+api.domain.get("example.com")
+api.domain.search(search_params)
+
+api.ip.get("1.1.1.1")
+api.ip.search(search_params)
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spysex"
+
+# 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/lib/spyse.rb

@@ -0,0 +1,15 @@
+require "spyse/version"
+
+require "spyse/clients/base"
+
+require "spyse/clients/as"
+require "spyse/clients/cert"
+require "spyse/clients/cve"
+require "spyse/clients/domain"
+require "spyse/clients/ip"
+
+require "spyse/api"
+
+module Spyse
+  class Error < StandardError; end
+end

data/lib/spyse/api.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Spyse
+  class API
+    def initialize(api_key = ENV["SPYSE_API_KEY"])
+      @api_key = api_key
+      raise ArgumentError, "No api key has been found or provided!" unless @api_key
+    end
+
+    def as
+      @as ||= Client::AS.new(@api_key)
+    end
+
+    def cert
+      @cert ||= Client::Cert.new(@api_key)
+    end
+
+    def cve
+      @cve ||= Client::CVE.new(@api_key)
+    end
+
+    def domain
+      @domain ||= Client::Domain.new(@api_key)
+    end
+
+    def ip
+      @ip ||= Client::IP.new(@api_key)
+    end
+  end
+end

data/lib/spyse/clients/as.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Spyse
+  module Client
+    class AS < Base
+      #
+      # Lists AS
+      #
+      # @see https://spyse.com/api#/as/as
+      #
+      # @return [Hash]
+      #
+      def get(asn, limit: nil, offset: nil)
+        params = {
+          asn: asn, limit: limit, offset: offset,
+        }.compact
+        _get("/as", params) { |json| json }
+      end
+
+      #
+      # Lists ASs
+      #
+      # @see https://spyse.com/api#/as/as_search
+      #
+      # @return [Hash]
+      #
+      def search(search_params, limit: nil, offset: nil)
+        params = {
+          search_params: search_params, limit: limit, offset: offset,
+        }.compact
+        _post("/as/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/spyse/clients/base.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/https"
+require "uri"
+
+module Spyse
+  module Client
+    class Base
+      HOST = "api.spyse.com"
+      VERSION = "v3"
+      BASE_URL = "https://#{HOST}/#{VERSION}/data"
+
+      def initialize(api_key)
+        @api_key = api_key
+      end
+
+      private
+
+      def url_for(path)
+        URI(BASE_URL + path)
+      end
+
+      def https_options
+        if proxy = ENV["HTTPS_PROXY"] || ENV["https_proxy"]
+          uri = URI(proxy)
+          {
+            proxy_address: uri.hostname,
+            proxy_port: uri.port,
+            proxy_from_env: false,
+            use_ssl: true
+          }
+        else
+          { use_ssl: true }
+        end
+      end
+
+      def request(req)
+        Net::HTTP.start(HOST, 443, https_options) do |http|
+          req["Authorization"] = "Bearer #{@api_key}"
+
+          response = http.request(req)
+
+          code = response.code.to_i
+          body = response.body
+          json = JSON.parse(body)
+
+          case code
+          when 200
+            yield json
+          else
+            error = json.dig("error", "message") || body
+            raise Error, "Unsupported response code returned: #{code} - #{error}"
+          end
+        end
+      end
+
+      def _get(path, params = {}, &block)
+        uri = url_for(path)
+        uri.query = URI.encode_www_form(params)
+        get = Net::HTTP::Get.new(uri)
+
+        request(get, &block)
+      end
+
+      def _post(path, params = {}, &block)
+        post = Net::HTTP::Post.new(url_for(path))
+        post.body = JSON.generate(params)
+        post["Content-Type"] = "application/json"
+
+        request(post, &block)
+      end
+    end
+  end
+end

data/lib/spyse/clients/cert.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Spyse
+  module Client
+    class Cert < Base
+      #
+      # Lists Certificate
+      #
+      # @see https://spyse.com/api#/certificate/certificate
+      #
+      # @return [Hash]
+      #
+      def get(hash, limit: nil, offset: nil)
+        params = {
+          hash: hash, limit: limit, offset: offset,
+        }.compact
+        _get("/cert", params) { |json| json }
+      end
+
+      #
+      # Lists certificates
+      #
+      # @see https://spyse.com/api#/certificate/cert_search
+      #
+      # @return [Hash]
+      #
+      def search(search_params, limit: nil, offset: nil)
+        params = {
+          search_params: search_params, limit: limit, offset: offset,
+        }.compact
+        _post("/cert/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/spyse/clients/cve.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Spyse
+  module Client
+    class CVE < Base
+      #
+      # Lists CVE
+      #
+      # @see https://spyse.com/api#/cve/cve
+      #
+      # @return [Hash]
+      #
+      def get(cve_id, limit: nil, offset: nil)
+        params = {
+          cve_id: cve_id, limit: limit, offset: offset,
+        }.compact
+        _get("/cve", params) { |json| json }
+      end
+
+      #
+      # Lists IPs, that vulnerable by provided CVE
+      #
+      # @see https://spyse.com/api#/cve/vulnerable_ip_by_cve
+      #
+      # @return [Hash]
+      #
+      def vulnerable_ip(cve, limit: nil, offset: nil)
+        params = {
+          cve: cve, limit: limit, offset: offset,
+        }.compact
+        _get("/cve/vulnerable-ip", params) { |json| json }
+      end
+
+      #
+      # Lists CVEs
+      #
+      # @see https://spyse.com/api#/cve/cve_search
+      #
+      # @return [Hash]
+      #
+      def search(search_params, limit: nil, offset: nil)
+        params = {
+          search_params: search_params, limit: limit, offset: offset,
+        }.compact
+        _post("/cve/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/spyse/clients/domain.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Spyse
+  module Client
+    class Domain < Base
+      #
+      # Lists domains
+      #
+      # @see https://spyse.com/api#/domain/domain
+      #
+      # @return [Hash]
+      #
+      def get(name, limit: nil, offset: nil, cert: nil, using_as_mx: nil, using_as_ns: nil, is_mx: nil, is_ns: nil, ip: nil )
+        params = {
+          limit: limit, offset: offset, name: name, cert: cert, using_as_mx: using_as_mx, using_as_ns: using_as_ns, is_mx: is_mx, is_ns: is_ns, ip: ip
+        }.compact
+        _get("/domain", params) { |json| json }
+      end
+
+      #
+      # Lists subdomains of a domain
+      #
+      # @see https://spyse.com/api#/domain/subdomain
+      #
+      # @return [Hash]
+      #
+      def subdomain(domain, limit: nil, offset: nil)
+        params = {
+          domain: domain,
+          limit: limit,
+          offset: offset
+        }.compact
+        _get("/domain/subdomain", params) { |json| json }
+      end
+
+      #
+      # Lists of related domains
+      #
+      # @see https://spyse.com/api#/related/domain_related_domain
+      #
+      # @return [Hash]
+      #
+      def related_domains(domain, limit: nil, offset: nil)
+        params = {
+          domain: domain,
+          limit: limit,
+          offset: offset
+        }.compact
+        _get("/domain/related/domain", params) { |json| json }
+      end
+
+      #
+      # Lists of related IPs by domain
+      #
+      # @see https://spyse.com/api#/related/domain_related_ip
+      #
+      # @return [Hash]
+      #
+      def related_ips(domain, limit: nil, offset: nil)
+        params = {
+          domain: domain,
+          limit: limit,
+          offset: offset
+        }.compact
+        _get("/domain/related/ip", params) { |json| json }
+      end
+
+      #
+      # Lists domains
+      #
+      # @see https://spyse.com/api#/domain/domain_search
+      #
+      # @return [Hash]
+      #
+      def search(search_params, limit: nil, offset: nil)
+        params = {
+          search_params: search_params, limit: limit, offset: offset,
+        }.compact
+        _post("/domain/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/spyse/clients/ip.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Spyse
+  module Client
+    class IP < Base
+      #
+      # Lists ips
+      #
+      # @see https://spyse.com/api#/ip/ip
+      #
+      # @return [Hash]
+      #
+      def get(ip, limit: nil, offset: nil, as_org: nil, country: nil, as_num: nil)
+        params = {
+          limit: limit,
+          offset: offset,
+          ip: ip,
+          as_org: as_org,
+          country: country,
+          as_num: as_num
+        }.compact
+        _get("/ip", params) { |json| json }
+      end
+
+      #
+      # Lists IPs
+      #
+      # @see https://spyse.com/api#/ip/ip_search
+      #
+      # @return [Hash]
+      #
+      def search(search_params, limit: nil, offset: nil)
+        params = {
+          search_params: search_params, limit: limit, offset: offset,
+        }.compact
+        _post("/ip/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/spyse/version.rb

@@ -0,0 +1,3 @@
+module Spyse
+  VERSION = "0.1.0".freeze
+end

data/lib/spysex.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spyse"

data/spysex.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/spyse/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spysex"
+  spec.version       = Spyse::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = 'Spyse API wrapper for Ruby'
+  spec.description   = 'Spyse API wrapper for Ruby'
+  spec.homepage      = "https://github.com/ninoseki/spysex"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # 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{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "vcr", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.7"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: spysex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manabu Niseki
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !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.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Spyse API wrapper for Ruby
+email:
+- manabu.niseki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/spyse.rb
+- lib/spyse/api.rb
+- lib/spyse/clients/as.rb
+- lib/spyse/clients/base.rb
+- lib/spyse/clients/cert.rb
+- lib/spyse/clients/cve.rb
+- lib/spyse/clients/domain.rb
+- lib/spyse/clients/ip.rb
+- lib/spyse/version.rb
+- lib/spysex.rb
+- spysex.gemspec
+homepage: https://github.com/ninoseki/spysex
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Spyse API wrapper for Ruby
+test_files: []