Class: Mihari::Analyzers::Onyphe

Inherits:
Base show all
Defined in:
lib/mihari/analyzers/onyphe.rb

Overview

Onyphe analyzer

Constant Summary

Constants included from Concerns::Retriable

Concerns::Retriable::DEFAULT_CONDITION, Concerns::Retriable::RETRIABLE_ERRORS

Instance Attribute Summary collapse

Attributes inherited from Base

#query

Attributes inherited from Mihari::Actor

#options

Instance Method Summary collapse

Methods inherited from Base

#call, from_params, #ignore_error?, inherited, #normalized_artifacts, #pagination_interval, #pagination_limit, #parallel?, #result, #truncated_query

Methods inherited from Mihari::Actor

#call, configuration_keys, key, key_aliases, keys, #result, #retry_exponential_backoff, #retry_interval, #retry_times, #timeout, type, #validate_configuration!

Methods included from Concerns::Retriable

#retry_on_error

Methods included from Concerns::Configurable

#configuration_keys?, #configured?

Constructor Details

#initialize(query, options: nil, api_key: nil) ⇒ Onyphe

Returns a new instance of Onyphe.

Parameters:

  • query (String)
  • options (Hash, nil) (defaults to: nil)
  • api_key (String, nil) (defaults to: nil) 


19
20
21
22
23
 
# File 'lib/mihari/analyzers/onyphe.rb', line 19

def initialize(query, options: nil, api_key: nil)
  super(query, options:)

  @api_key = api_key || Mihari.config.onyphe_api_key
end

Instance Attribute Details

#api_key ⇒ String? (readonly)

Returns:

  • (String, nil) 


12
13
14
 
# File 'lib/mihari/analyzers/onyphe.rb', line 12

def api_key
  @api_key
end

Instance Method Details

#artifacts ⇒ Object 



25
26
27
28
29
30
 
# File 'lib/mihari/analyzers/onyphe.rb', line 25

def artifacts
  client.datascan_with_pagination(
    query,
    pagination_limit:
  ).map(&:artifacts).flatten
end