mihari 5.6.1 → 5.7.0

data/lib/mihari/structs/onyphe.rb

@@ -6,44 +6,28 @@ module Mihari
       class Result < Dry::Struct
         include Mixins::AutonomousSystem
 
+        # @!attribute [r] asn
+        #   @return [String]
         attribute :asn, Types::String
+
+        # @!attribute [r] country_code
+        #   @return [String, nll]
         attribute :country_code, Types::String.optional
-        attribute :ip, Types::String
-        attribute :metadata, Types::Hash
 
-        #
-        # @return [String]
-        #
-        def asn
-          attributes[:asn]
-        end
+        # @!attribute [r] ip
+        #   @return [String]
 
-        #
-        # @return [String, nil]
-        #
-        def country_code
-          attributes[:country_code]
-        end
-
-        #
-        # @return [String]
-        #
-        def ip
-          attributes[:ip]
-        end
+        attribute :ip, Types::String
 
-        #
-        # @return [Hash]
-        #
-        def metadata
-          attributes[:metadata]
-        end
+        # @!attribute [r] metadata
+        #   @return [Hash]
+        attribute :metadata, Types::Hash
 
         #
-        # @return [Mihari::Artifact]
+        # @return [Mihari::Models::Artifact]
         #
         def artifact
-          Mihari::Artifact.new(
+          Mihari::Models::Artifact.new(
             data: ip,
             metadata: metadata,
             autonomous_system: as,
@@ -57,7 +41,7 @@ module Mihari
         def geolocation
           return nil if country_code.nil?
 
-          Mihari::Geolocation.new(
+          Mihari::Models::Geolocation.new(
             country: NormalizeCountry(country_code, to: :short),
             country_code: country_code
           )
@@ -67,7 +51,7 @@ module Mihari
         # @return [Mihari::AutonomousSystem]
         #
         def as
-          Mihari::AutonomousSystem.new(asn: normalize_asn(asn))
+          Mihari::Models::AutonomousSystem.new(asn: normalize_asn(asn))
         end
 
         class << self
@@ -90,65 +74,36 @@ module Mihari
       end
 
       class Response < Dry::Struct
+        # @!attribute [r] count
+        #   @return [Integer]
         attribute :count, Types::Int
-        attribute :error, Types::Int
-        attribute :max_page, Types::Int
-        attribute :page, Types::Int
-        attribute :results, Types.Array(Result)
-        attribute :status, Types::String
-        attribute :total, Types::Int
-
-        #
-        # @return [Integer]
-        #
-        def count
-          attributes[:count]
-        end
 
-        #
-        # @return [Integer]
-        #
-        def error
-          attributes[:error]
-        end
+        # @!attribute [r] error
+        #   @return [Integer]
+        attribute :error, Types::Int
 
-        #
-        # @return [Integer]
-        #
-        def max_page
-          attributes[:max_page]
-        end
+        # @!attribute [r] max_page
+        #   @return [Integer]
+        attribute :max_page, Types::Int
 
-        #
-        # @return [Integer]
-        #
-        def page
-          attributes[:page]
-        end
+        # @!attribute [r] page
+        #   @return [Integer]
+        attribute :page, Types::Int
 
-        #
-        # @return [Array<Result>]
-        #
-        def results
-          attributes[:results]
-        end
+        # @!attribute [r] results
+        #   @return [Array<Result>]
+        attribute :results, Types.Array(Result)
 
-        #
-        # @return [String]
-        #
-        def status
-          attributes[:status]
-        end
+        # @!attribute [r] status
+        #   @return [String]
+        attribute :status, Types::String
 
-        #
-        # @return [Integer]
-        #
-        def total
-          attributes[:total]
-        end
+        # @!attribute [r] total
+        #   @return [Integer]
+        attribute :total, Types::Int
 
         #
-        # @return [Array<Mihari::Artifact>]
+        # @return [Array<Mihari::Models::Artifact>]
         #
         def artifacts
           results.map(&:artifact)

data/lib/mihari/structs/shodan.rb

@@ -4,22 +4,13 @@ module Mihari
   module Structs
     module Shodan
       class Location < Dry::Struct
+        # @!attribute [r] country_code
+        #   @return [String, nil]
         attribute :country_code, Types::String.optional
-        attribute :country_name, Types::String.optional
-
-        #
-        # @return [String, nil]
-        #
-        def country_code
-          attributes[:country_code]
-        end
 
-        #
-        # @return [String, nil]
-        #
-        def country_name
-          attributes[:country_name]
-        end
+        # @!attribute [r] country_name
+        #   @return [String, nil]
+        attribute :country_name, Types::String.optional
 
         #
         # @return [Mihari::Geolocation, nil]
@@ -27,7 +18,7 @@ module Mihari
         def geolocation
           return nil if country_name.nil? && country_code.nil?
 
-          Mihari::Geolocation.new(
+          Mihari::Models::Geolocation.new(
             country: country_name,
             country_code: country_code
           )
@@ -52,55 +43,33 @@ module Mihari
       class Match < Dry::Struct
         include Mixins::AutonomousSystem
 
+        # @!attribute [r] asn
+        #   @return [String, nil]
         attribute :asn, Types::String.optional
-        attribute :hostnames, Types.Array(Types::String)
-        attribute :location, Location
-        attribute :domains, Types.Array(Types::String)
-        attribute :ip_str, Types::String
-        attribute :port, Types::Integer
-        attribute :metadata, Types::Hash
 
-        #
-        # @return [String, nil]
-        #
-        def asn
-          attributes[:asn]
-        end
+        # @!attribute [r] hostname
+        #   @return [Array<String>]
+        attribute :hostnames, Types.Array(Types::String)
 
-        #
-        # @return [Array<String>]
-        #
-        def hostnames
-          attributes[:hostnames]
-        end
+        # @!attribute [r] location
+        #   @return [Location]
+        attribute :location, Location
 
-        #
-        # @return [Location]
-        #
-        def location
-          attributes[:location]
-        end
+        # @!attribute [r] domains
+        #   @return [Array<String>]
+        attribute :domains, Types.Array(Types::String)
 
-        #
-        # @return [String]
-        #
-        def ip_str
-          attributes[:ip_str]
-        end
+        # @!attribute [r] ip_str
+        #   @return [String]
+        attribute :ip_str, Types::String
 
-        #
-        # @return [Integer]
-        #
-        def port
-          attributes[:port]
-        end
+        # @!attribute [r] port
+        #   @return [Integer]
+        attribute :port, Types::Int
 
-        #
-        # @return [Hash]
-        #
-        def metadata
-          attributes[:metadata]
-        end
+        # @!attribute [r] metadata
+        #   @return [Hash]
+        attribute :metadata, Types::Hash
 
         #
         # @return [Mihari::AutonomousSystem, nil]
@@ -108,7 +77,7 @@ module Mihari
         def _asn
           return nil if asn.nil?
 
-          Mihari::AutonomousSystem.new(asn: normalize_asn(asn))
+          Mihari::Models::AutonomousSystem.new(asn: normalize_asn(asn))
         end
 
         class << self
@@ -141,22 +110,13 @@ module Mihari
       end
 
       class Response < Dry::Struct
+        # @!attribute [r] matches
+        #   @return [Array<Match>]
         attribute :matches, Types.Array(Match)
-        attribute :total, Types::Int
-
-        #
-        # @return [Array<Match>]
-        #
-        def matches
-          attributes[:matches]
-        end
 
-        #
-        # @return [Integer]
-        #
-        def total
-          attributes[:total]
-        end
+        # @!attribute [r] total
+        #   @return [Integer]
+        attribute :total, Types::Int
 
         #
         # Collect metadata from matches
@@ -192,20 +152,20 @@ module Mihari
         end
 
         #
-        # @return [Array<Mihari::Artifact>]
+        # @return [Array<Mihari::Models::Artifact>]
         #
         def artifacts
           matches.map do |match|
             metadata = collect_metadata_by_ip(match.ip_str)
 
             ports = collect_ports_by_ip(match.ip_str).map do |port|
-              Mihari::Port.new(port: port)
+              Mihari::Models::Port.new(port: port)
             end
             reverse_dns_names = collect_hostnames_by_ip(match.ip_str).map do |name|
-              Mihari::ReverseDnsName.new(name: name)
+              Mihari::Models::ReverseDnsName.new(name: name)
             end
 
-            Mihari::Artifact.new(
+            Mihari::Models::Artifact.new(
               data: match.ip_str,
               metadata: metadata,
               autonomous_system: match._asn,
@@ -233,54 +193,29 @@ module Mihari
       end
 
       class InternetDBResponse < Dry::Struct
+        # @!attribute [r] ip
+        #   @return [String]
         attribute :ip, Types::String
-        attribute :ports, Types.Array(Types::Int)
-        attribute :cpes, Types.Array(Types::String)
-        attribute :hostnames, Types.Array(Types::String)
-        attribute :tags, Types.Array(Types::String)
-        attribute :vulns, Types.Array(Types::String)
-
-        #
-        # @return [String]
-        #
-        def ip
-          attributes[:ip]
-        end
 
-        #
-        # @return [Array<Integer>]
-        #
-        def ports
-          attributes[:ports]
-        end
+        # @!attribute [r] ports
+        #   @return [Array<Integer>]
+        attribute :ports, Types.Array(Types::Int)
 
-        #
-        # @return [Array<String>]
-        #
-        def cpes
-          attributes[:cpes]
-        end
+        # @!attribute [r] cpes
+        #   @return [Array<String>]
+        attribute :cpes, Types.Array(Types::String)
 
-        #
-        # @return [Array<String>]
-        #
-        def hostnames
-          attributes[:hostnames]
-        end
+        # @!attribute [r] hostnames
+        #   @return [Array<String>]
+        attribute :hostnames, Types.Array(Types::String)
 
-        #
-        # @return [Array<String>]
-        #
-        def tags
-          attributes[:tags]
-        end
+        # @!attribute [r] tags
+        #   @return [Array<String>]
+        attribute :tags, Types.Array(Types::String)
 
-        #
-        # @return [Array<String>]
-        #
-        def vulns
-          attributes[:vulns]
-        end
+        # @!attribute [r] vulns
+        #   @return [Array<String>]
+        attribute :vulns, Types.Array(Types::String)
 
         class << self
           #

data/lib/mihari/structs/urlscan.rb

@@ -4,30 +4,17 @@ module Mihari
   module Structs
     module Urlscan
       class Page < Dry::Struct
+        # @!attribute [r] domain
+        #   @return [String]
         attribute :domain, Types::String.optional
-        attribute :ip, Types::String.optional
-        attribute :url, Types::String
-
-        #
-        # @return [String, nil]
-        #
-        def domain
-          attributes[:domain]
-        end
 
-        #
-        # @return [String, nil]
-        #
-        def ip
-          attributes[:ip]
-        end
+        # @!attribute [r] ip
+        #   @return [String, nil]
+        attribute :ip, Types::String.optional
 
-        #
-        # @return [String]
-        #
-        def url
-          attributes[:url]
-        end
+        # @!attribute [r] url
+        #   @return [String]
+        attribute :url, Types::String
 
         class << self
           #
@@ -47,45 +34,28 @@ module Mihari
       end
 
       class Result < Dry::Struct
+        # @!attribute [r] page
+        #   @return [Page]
         attribute :page, Page
-        attribute :id, Types::String
-        attribute :sort, Types.Array(Types::String | Types::Integer)
-        attribute :metadata, Types::Hash
-
-        #
-        # @return [Page]
-        #
-        def page
-          attributes[:page]
-        end
 
-        #
-        # @return [String]
-        #
-        def id
-          attributes[:id]
-        end
+        # @!attribute [r] pid
+        #   @return [String]
+        attribute :id, Types::String
 
-        #
-        # @return [Array<String, Integer>]
-        #
-        def sort
-          attributes[:sort]
-        end
+        # @!attribute [r] sort
+        #   @return [Array<String, Integer>]
+        attribute :sort, Types.Array(Types::String | Types::Int)
 
-        #
-        # @return [Array<String, Integer>]
-        #
-        def metadata
-          attributes[:metadata]
-        end
+        # @!attribute [r] metadata
+        #   @return [Hash]
+        attribute :metadata, Types::Hash
 
         #
-        # @return [Array<Mihari::Artifact>]
+        # @return [Array<Mihari::Models::Artifact>]
         #
         def artifacts
           values = [page.url, page.domain, page.ip].compact
-          values.map { |value| Mihari::Artifact.new(data: value, metadata: metadata) }
+          values.map { |value| Mihari::Models::Artifact.new(data: value, metadata: metadata) }
         end
 
         class << self
@@ -107,25 +77,16 @@ module Mihari
       end
 
       class Response < Dry::Struct
+        # @!attribute [r] results
+        #   @return [Array<Result>]
         attribute :results, Types.Array(Result)
-        attribute :has_more, Types::Bool
-
-        #
-        # @return [Array<Result>]
-        #
-        def results
-          attributes[:results]
-        end
 
-        #
-        # @return [Boolean]
-        #
-        def has_more
-          attributes[:has_more]
-        end
+        # @!attribute [r] has_more
+        #   @return [Boolean]
+        attribute :has_more, Types::Bool
 
         #
-        # @return [Array<Mihari::Artifact>]
+        # @return [Array<Mihari::Models::Artifact>]
         #
         def artifacts
           results.map(&:artifacts).flatten

data/lib/mihari/structs/virustotal_intelligence.rb

@@ -4,15 +4,10 @@ module Mihari
   module Structs
     module VirusTotalIntelligence
       class ContextAttributes < Dry::Struct
+        # @!attribute [r] url
+        #   @return [String, nil]
         attribute :url, Types::String.optional
 
-        #
-        # @return [String, nil]
-        #
-        def url
-          attributes[:url]
-        end
-
         class << self
           #
           # @param [Hash] d
@@ -27,38 +22,21 @@ module Mihari
       end
 
       class Datum < Dry::Struct
+        # @!attribute [r] type
+        #   @return [String]
         attribute :type, Types::String
-        attribute :id, Types::String
-        attribute :context_attributes, ContextAttributes.optional
-        attribute :metadata, Types::Hash
 
-        #
-        # @return [String]
-        #
-        def type
-          attributes[:type]
-        end
-
-        #
-        # @return [String]
-        #
-        def id
-          attributes[:id]
-        end
+        # @!attribute [r] id
+        #   @return [String]
+        attribute :id, Types::String
 
-        #
-        # @return [ContextAttributes, nil]
-        #
-        def context_attributes
-          attributes[:context_attributes]
-        end
+        # @!attribute [r] context_attributes
+        #   @return [ContextAttributes, nil]
+        attribute :context_attributes, ContextAttributes.optional
 
-        #
-        # @return [Hash, nil]
-        #
-        def metadata
-          attributes[:metadata]
-        end
+        # @!attribute [r] metadata
+        #   @return [Hash]
+        attribute :metadata, Types::Hash
 
         #
         # @return [String, nil]
@@ -77,10 +55,10 @@ module Mihari
         end
 
         #
-        # @return [Mihari::Artifact]
+        # @return [Mihari::Models::Artifact]
         #
         def artifact
-          Artifact.new(data: value, metadata: metadata)
+          Models::Artifact.new(data: value, metadata: metadata)
         end
 
         class << self
@@ -108,15 +86,10 @@ module Mihari
       end
 
       class Meta < Dry::Struct
+        # @!attribute [r] cursor
+        #   @return [String, nil]
         attribute :cursor, Types::String.optional
 
-        #
-        # @return [String, nil]
-        #
-        def cursor
-          attributes[:cursor]
-        end
-
         class << self
           #
           # @param [Hash] d
@@ -133,25 +106,16 @@ module Mihari
       end
 
       class Response < Dry::Struct
+        # @!attribute [r] meta
+        #   @return [Meta]
         attribute :meta, Meta
-        attribute :data, Types.Array(Datum)
-
-        #
-        # @return [Meta]
-        #
-        def meta
-          attributes[:meta]
-        end
 
-        #
-        # @return [Array<Datum>]
-        #
-        def data
-          attributes[:data]
-        end
+        # @!attribute [r] data
+        #   @return [Array<Datum>]
+        attribute :data, Types.Array(Datum)
 
         #
-        # @return [Array<Mihari::Artifact>]
+        # @return [Array<Mihari::Models::Artifact>]
         #
         def artifacts
           data.map(&:artifact)

data/lib/mihari/type_checker.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module Mihari
+  #
+  # Artifact type checker
+  #
   class TypeChecker
     # @return [String]
     attr_reader :data
@@ -54,6 +57,7 @@ module Mihari
       return "ip" if ip?
       return "domain" if domain?
       return "url" if url?
+
       "mail" if mail?
     end
 

data/lib/mihari/types.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module Mihari
+  #
+  # dry-type based types
+  #
   module Types
     include Dry.Types()
 

data/lib/mihari/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mihari
-  VERSION = "5.6.1"
+  VERSION = "5.7.0"
 end