refactor: rename methods

lib/mihari/analyzers/base.rb

@@ -4,7 +4,9 @@
 
 module Mihari
   module Analyzers
-    class Base < Configurable
+    class Base
+      include Configurable
+
       # @return [Array<String>, Array<Mihari::Artifact>]
       def artifacts
         raise NotImplementedError, "You must implement #{self.class}##{__method__}"

lib/mihari/analyzers/censys.rb

@@ -31,12 +31,12 @@ def artifacts
 
       private
 
-      def keys
+      def config_keys
         %w(CENSYS_ID CENSYS_SECRET)
       end
 
       def api
-        raise ArgumentError, configuration_status unless valid?
+        raise ArgumentError, configuration_status unless configured?
 
         @api ||= ::Censys::API.new
       end

lib/mihari/analyzers/circl.rb

@@ -26,7 +26,7 @@ def artifacts
 
       private
 
-      def keys
+      def config_keys
         %w(CIRCL_PASSIVE_USERNAME CIRCL_PASSIVE_PASSWORD)
       end
 

lib/mihari/analyzers/onyphe.rb

@@ -29,7 +29,7 @@ def artifacts
 
       private
 
-      def keys
+      def config_keys
         %w(ONYPHE_API_KEY)
       end
 

lib/mihari/analyzers/securitytrails.rb

@@ -29,7 +29,7 @@ def artifacts
 
       private
 
-      def keys
+      def config_keys
         %w(SECURITYTRAILS_API_KEY)
       end
 

lib/mihari/analyzers/securitytrails_domain_feed.rb

@@ -31,7 +31,7 @@ def artifacts
 
       private
 
-      def keys
+      def config_keys
         %w(SECURITYTRAILS_API_KEY)
       end
 

lib/mihari/analyzers/shodan.rb

@@ -31,7 +31,7 @@ def artifacts
 
       private
 
-      def keys
+      def config_keys
         %w(SHODAN_API_KEY)
       end
 

lib/mihari/analyzers/virustotal.rb

@@ -29,7 +29,7 @@ def artifacts
 
       private
 
-      def keys
+      def config_keys
         %w(VIRUSTOTAL_API_KEY)
       end
 

lib/mihari/configurable.rb

@@ -1,23 +1,21 @@
 # frozen_string_literal: true
 
 module Mihari
-  class Configurable
-    def valid?
-      keys.all? { |key| ENV.key? key }
+  module Configurable
+    def configured?
+      config_keys.all? { |key| ENV.key? key }
     end
 
     def configuration_status
-      return nil if keys.empty?
+      return nil if config_keys.empty?
 
-      names = keys.join(" and ")
-      be_verb = keys.length == 1 ? "is" : "are"
-      status = valid? ? "found" : "missing"
+      names = config_keys.join(" and ")
+      be_verb = config_keys.length == 1 ? "is" : "are"
+      status = configured? ? "found" : "missing"
       "#{names} #{be_verb} #{status}"
     end
 
-    private
-
-    def keys
+    def config_keys
       []
     end
   end

lib/mihari/emitters/base.rb

@@ -2,7 +2,9 @@
 
 module Mihari
   module Emitters
-    class Base < Configurable
+    class Base
+      include Configurable
+
       def self.inherited(child)
         Mihari.emitters << child
       end

lib/mihari/emitters/misp.rb

@@ -27,7 +27,7 @@ def emit(title:, artifacts:, tags: [], **_options)
 
       private
 
-      def keys
+      def config_keys
         %w(MISP_API_ENDPOINT MISP_API_KEY)
       end
 

lib/mihari/emitters/slack.rb

@@ -125,7 +125,7 @@ def emit(title:, description:, artifacts:, tags: [])
 
       private
 
-      def keys
+      def config_keys
         %w(SLACK_WEBHOOK_URL)
       end
     end

lib/mihari/emitters/the_hive.rb

@@ -23,7 +23,7 @@ def emit(title:, description:, artifacts:, tags: [])
 
       private
 
-      def keys
+      def config_keys
         %w(THEHIVE_API_ENDPOINT THEHIVE_API_KEY)
       end
 

lib/mihari/status.rb

@@ -27,7 +27,7 @@ def statuses
         name = full_name.split("::").last.to_s
 
         instance = full_name.include?("analyzers") ? klass.new("dummy") : klass.new
-        status = instance.valid?
+        status = instance.configured?
         message = instance.configuration_status
 
         message ? [name, { status: status, message: message }] : nil