Merge pull request #1129 from ninoseki/rename-get

refactor: rename #result to #get_result

lib/mihari/actor.rb

@@ -63,7 +63,7 @@ def call(*args, **kwargs)
       raise NotImplementedError, "You must implement #{self.class}##{__method__}"
     end
 
-    def result(...)
+    def get_result(...)
       Try[StandardError] do
         retry_on_error(times: retry_times, interval: retry_interval, exponential_backoff: retry_exponential_backoff) do
           call(...)

lib/mihari/analyzers/base.rb

@@ -77,7 +77,7 @@ def call
         normalized_artifacts
       end
 
-      def result(...)
+      def get_result(...)
         result = Try[StandardError] do
           retry_on_error(
             times: retry_times,

lib/mihari/commands/alert.rb

@@ -91,7 +91,7 @@ def list_transform(q = "")
             # @param [Integer] id
             #
             def get(id)
-              value = Services::AlertGetter.result(id).value!
+              value = Services::AlertGetter.get_result(id).value!
               data = Entities::Alert.represent(value)
               puts JSON.pretty_generate(data.as_json)
             end

lib/mihari/commands/artifact.rb

@@ -71,7 +71,7 @@ def list_transform(q = "")
             # @param [Integer] id
             #
             def get(id)
-              value = Services::ArtifactGetter.result(id).value!
+              value = Services::ArtifactGetter.get_result(id).value!
               data = Entities::Artifact.represent(value)
               puts JSON.pretty_generate(data.as_json)
             end

lib/mihari/commands/rule.rb

@@ -116,7 +116,7 @@ def list_transform(q = "")
             desc "get ID", "Get a rule"
             around :with_db_connection
             def get(id)
-              value = Services::RuleGetter.result(id).value!
+              value = Services::RuleGetter.get_result(id).value!
               data = Entities::Rule.represent(value)
               puts JSON.pretty_generate(data.as_json)
             end

lib/mihari/emitters/base.rb

@@ -44,7 +44,7 @@ def call(artifacts)
       #
       # @return [Dry::Monads::Result::Success<Object>, Dry::Monads::Result::Failure]
       #
-      def result(artifacts)
+      def get_result(artifacts)
         result = Try[StandardError] do
           retry_on_error(
             times: retry_times,

lib/mihari/enrichers/base.rb

@@ -29,7 +29,7 @@ def call(artifact)
       #
       # @return [Dry::Monads::Result::Success<Object>, Dry::Monads::Result::Failure]
       #
-      def result(artifact)
+      def get_result(artifact)
         return unless callable?(artifact)
 
         result = Try[StandardError] do

lib/mihari/models/artifact.rb

@@ -191,7 +191,7 @@ def enrich_by_enrichers(enrichers)
         # NOTE: doing parallel with ActiveRecord objects is troublesome (e.g. connection issue, etc.)
         #       so converting the object to an OpenStruct object
         s = struct
-        results = Parallel.map(enrichers) { |enricher| enricher.result s }
+        results = Parallel.map(enrichers) { |enricher| enricher.get_result s }
         enriched = results.compact.map { |result| result.value_or(nil) }.compact
 
         self.dns_records = enriched.map(&:dns_records).flatten.compact

lib/mihari/models/port.rb

@@ -18,7 +18,7 @@ class << self
         # @return [Array<Mihari::Port>]
         #
         def build_by_ip(ip, enricher: Enrichers::Shodan.new)
-          enricher.result(ip).fmap do |res|
+          enricher.get_result(ip).fmap do |res|
             (res&.ports || []).map { |port| new(port:) }
           end.value_or []
         end

lib/mihari/rule.rb

@@ -191,8 +191,8 @@ def bulk_emit
       return [] if enriched_artifacts.empty?
 
       [].tap do |out|
-        out << serial_emitters.map { |emitter| emitter.result(enriched_artifacts).value_or(nil) }
-        out << Parallel.map(parallel_emitters) { |emitter| emitter.result(enriched_artifacts).value_or(nil) }
+        out << serial_emitters.map { |emitter| emitter.get_result(enriched_artifacts).value_or(nil) }
+        out << Parallel.map(parallel_emitters) { |emitter| emitter.get_result(enriched_artifacts).value_or(nil) }
       end.flatten.compact
     end
 
@@ -349,8 +349,8 @@ def serial_analyzers
     # @return [Array<Dry::Monads::Result::Success<Array<Mihari::Models::Artifact>>, Dry::Monads::Result::Failure>]
     def analyzer_results
       [].tap do |out|
-        out << Parallel.map(parallel_analyzers, &:result)
-        out << serial_analyzers.map(&:result)
+        out << Parallel.map(parallel_analyzers, &:get_result)
+        out << serial_analyzers.map(&:get_result)
       end.flatten
     end
 

lib/mihari/service.rb

@@ -11,7 +11,7 @@ def call(*args, **kwargs)
       raise NotImplementedError, "You must implement #{self.class}##{__method__}"
     end
 
-    def result(...)
+    def get_result(...)
       Try[StandardError] { call(...) }.to_result
     end
 
@@ -20,8 +20,8 @@ def call(...)
         new.call(...)
       end
 
-      def result(...)
-        new.result(...)
+      def get_result(...)
+        new.get_result(...)
       end
     end
   end

lib/mihari/web/endpoints/alerts.rb

@@ -41,7 +41,7 @@ class Alerts < Grape::API
           end
           get "/:id" do
             id = params[:id].to_i
-            result = Services::AlertGetter.result(id)
+            result = Services::AlertGetter.get_result(id)
             return present(result.value!, with: Entities::Alert) if result.success?
 
             case result.failure
@@ -61,7 +61,7 @@ class Alerts < Grape::API
           end
           delete "/:id" do
             id = params["id"].to_i
-            result = Services::AlertDestroyer.result(id)
+            result = Services::AlertDestroyer.get_result(id)
             return if result.success?
 
             case result.failure
@@ -86,7 +86,7 @@ class Alerts < Grape::API
           post "/" do
             status 201
 
-            result = Services::AlertCreator.result(params)
+            result = Services::AlertCreator.get_result(params)
             return present(result.value!, with: Entities::Alert) if result.success?
 
             case result.failure

lib/mihari/web/endpoints/artifacts.rb

@@ -41,7 +41,7 @@ class Artifacts < Grape::API
           end
           get "/:id" do
             id = params[:id].to_i
-            result = Services::ArtifactGetter.result(id)
+            result = Services::ArtifactGetter.get_result(id)
             return present(result.value!, with: Entities::Artifact) if result.success?
 
             case result.failure
@@ -98,7 +98,7 @@ class Artifacts < Grape::API
             status 204
 
             id = params["id"].to_i
-            result = Services::ArtifactDestroyer.result(id)
+            result = Services::ArtifactDestroyer.get_result(id)
             return if result.success?
 
             case result.failure

lib/mihari/web/endpoints/ip_addresses.rb

@@ -21,7 +21,7 @@ class IPAddresses < Grape::API
           end
           get "/:ip", requirements: {ip: %r{[^/]+}} do
             ip = params[:ip].to_s
-            result = Services::IPGetter.result(ip)
+            result = Services::IPGetter.get_result(ip)
             if result.success?
               value = result.value!
               return present(

lib/mihari/web/endpoints/rules.rb

@@ -59,7 +59,7 @@ def call(yaml, overwrite: true)
           end
           get "/:id" do
             id = params[:id].to_s
-            result = Services::RuleGetter.result(params[:id].to_s)
+            result = Services::RuleGetter.get_result(params[:id].to_s)
             return present(result.value!, with: Entities::Rule) if result.success?
 
             case result.failure
@@ -120,7 +120,7 @@ def call(yaml, overwrite: true)
 
             yaml = params[:yaml].to_s
 
-            result = RuleCreateUpdater.result(yaml, overwrite: false)
+            result = RuleCreateUpdater.get_result(yaml, overwrite: false)
             return present(result.value!.model, with: Entities::Rule) if result.success?
 
             failure = result.failure
@@ -151,7 +151,7 @@ def call(yaml, overwrite: true)
 
             yaml = params[:yaml].to_s
 
-            result = RuleCreateUpdater.result(yaml, overwrite: true)
+            result = RuleCreateUpdater.get_result(yaml, overwrite: true)
             return present(result.value!.model, with: Entities::Rule) if result.success?
 
             failure = result.failure
@@ -178,7 +178,7 @@ def call(yaml, overwrite: true)
             status 204
 
             id = params[:id].to_s
-            result = Services::RuleDestroyer.result(id)
+            result = Services::RuleDestroyer.get_result(id)
             return if result.success?
 
             case result.failure

lib/mihari/web/endpoints/tags.rb

@@ -43,7 +43,7 @@ class Tags < Grape::API
             status 204
 
             id = params[:id].to_i
-            result = Services::TagDestroyer.result(id)
+            result = Services::TagDestroyer.get_result(id)
             return if result.success?
 
             case result.failure

spec/actor_spec.rb

@@ -17,7 +17,7 @@ def call
 
   describe "#result" do
     it do
-      expect(actor.result.failure).to be_a(ZeroDivisionError)
+      expect(actor.get_result.failure).to be_a(ZeroDivisionError)
     end
   end
 end