spysex 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 349d1252d038b09b7042965cc022bb33dbaf841699d76b4403a8ede215b667fd
-  data.tar.gz: b98c60bde0e6dc5272e1d5e6a52fa1d96292c5fc42c6c0e6763c3db803de4a9a
+  metadata.gz: 635106e499dc0d83bc33a25797da7d4842fad74a7c814d265511bf42a8539fd1
+  data.tar.gz: 688abe7c89b9fa57d5085e59f85fee972b1380cd9a052ff71e4e32e60f817592
 SHA512:
-  metadata.gz: 993f76ca091a2d04ea35614100c25bd0fcfc94c74ee92a8cea874d81669705f2c1b6551e7e38ae086290af98e21650d9f5e48673638e1e20eece617830452cbf
-  data.tar.gz: 0b96be9c75d50bb6f68fca1473b14b6c7727b911b3045d206149454ba8edf7641071afda4b972bb0f55f59b0bb717466e195968ebe7f2687b503229d01b12b2a
+  metadata.gz: 15842f9a0de44b85cda75f795b85814f1428e7fe810411bbe5799efe10ad5a9689740a2f9ecde9cd98b4ae9cc38a860695e2f3e81c9ddef39bca751aae676096
+  data.tar.gz: 54e9c5fb0d408848845af326dc30f31ee322baa3284550fdaff84be68eb28e3d485f8126e087d299400fe5715cf9bd6e22b613732a99a6c56c67b74f44b2d5f5

data/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.7, "3.0"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run the default task
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+        run: |
+          gem install bundler -v 2.2.23
+          bundle install
+          bundle exec rake

data/README.md

@@ -1,12 +1,14 @@
 # spysex
 
-[![Build Status](https://travis-ci.com/ninoseki/spysex.svg?branch=master)](https://travis-ci.com/ninoseki/spysex)
+[![Ruby](https://github.com/ninoseki/spysex/actions/workflows/test.yml/badge.svg)](https://github.com/ninoseki/spysex/actions/workflows/test.yml)
 [![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.
+- Notes:
+  - API v4 is supported.
+  - This wrapper does not support all the API endpoints.
 
 ## Installation
 
@@ -19,7 +21,7 @@ gem install spysex
 ```ruby
 require "spysex"
 
-# when given nothing, it tries to load your usernamem & API key via ENV["SPYSE_API_KEY"]
+# when given nothing, it tries to load your API key via ENV["SPYSE_API_KEY"]
 api = Spyse::API.new
 # or you can set them manually
 api = Spyse::API.new("foo bar")

data/lib/spyse/api.rb

@@ -26,5 +26,19 @@ module Spyse
     def ip
       @ip ||= Client::IP.new(@api_key)
     end
+
+    def get(path, params = {})
+      base._get(path, params) { |json| json }
+    end
+
+    def post(path, params = {})
+      base._post(path, params) { |json| json }
+    end
+
+    private
+
+    def base
+      @base ||= Client::Base.new(@api_key)
+    end
   end
 end

data/lib/spyse/clients/as.rb

@@ -10,11 +10,8 @@ module Spyse
       #
       # @return [Hash]
       #
-      def get(asn, limit: nil, offset: nil)
-        params = {
-          asn: asn, limit: limit, offset: offset,
-        }.compact
-        _get("/as", params) { |json| json }
+      def get(asn)
+        _get("/as/#{asn}") { |json| json }
       end
 
       #

data/lib/spyse/clients/base.rb

@@ -8,13 +8,29 @@ module Spyse
   module Client
     class Base
       HOST = "api.spyse.com"
-      VERSION = "v3"
+      VERSION = "v4"
       BASE_URL = "https://#{HOST}/#{VERSION}/data"
 
       def initialize(api_key)
         @api_key = api_key
       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
+
       private
 
       def url_for(path)
@@ -54,22 +70,6 @@ module Spyse
           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

@@ -4,21 +4,18 @@ module Spyse
   module Client
     class Cert < Base
       #
-      # Lists Certificate
+      # Returns the current data about the given certificate.
       #
-      # @see https://spyse.com/api#/certificate/certificate
+      # @param [String] hash The SHA256 fingerprint of the certificate.
       #
       # @return [Hash]
       #
-      def get(hash, limit: nil, offset: nil)
-        params = {
-          hash: hash, limit: limit, offset: offset,
-        }.compact
-        _get("/cert", params) { |json| json }
+      def get(hash)
+        _get("/certificate/#{hash}") { |json| json }
       end
 
       #
-      # Lists certificates
+      # Returns a list of certificates that matched the search query.
       #
       # @see https://spyse.com/api#/certificate/cert_search
       #
@@ -28,7 +25,7 @@ module Spyse
         params = {
           search_params: search_params, limit: limit, offset: offset,
         }.compact
-        _post("/cert/search", params) { |json| json }
+        _post("/certificate/search", params) { |json| json }
       end
     end
   end

data/lib/spyse/clients/cve.rb

@@ -8,27 +8,12 @@ module Spyse
       #
       # @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
+      # @param [String] cve_id MITRE CVE unique identifier.
       #
       # @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 }
+      def get(cve_id)
+        _get("/cve/#{cve_id}") { |json| json }
       end
 
       #

data/lib/spyse/clients/domain.rb

@@ -8,61 +8,12 @@ module Spyse
       #
       # @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
+      # @param [String] name The domain name.
       #
       # @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 }
+      def get(name)
+        _get("/domain/#{name}") { |json| json }
       end
 
       #

data/lib/spyse/clients/ip.rb

@@ -4,22 +4,16 @@ module Spyse
   module Client
     class IP < Base
       #
-      # Lists ips
+      # Returns the current data about the given IP address.
       #
       # @see https://spyse.com/api#/ip/ip
       #
+      # @param [String] ip A valid IPv4 address.
+      #
       # @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 }
+      def get(ip)
+        _get("/ip/#{ip}") { |json| json }
       end
 
       #

data/lib/spyse/version.rb

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

data/spysex.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
 
   # 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.
@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   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 "bundler", "~> 2.2"
+  spec.add_development_dependency "coveralls_reborn", "~> 0.22"
   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"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spysex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Manabu Niseki
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-15 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.13'
 description: Spyse API wrapper for Ruby
 email:
 - manabu.niseki@gmail.com
@@ -101,9 +101,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -133,14 +133,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Spyse API wrapper for Ruby

data/.travis.yml

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