mihari 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7944fcbb2ef6b1ff7fccbe5c8158bd21a186b05e8fae70a6700256dce10adbb
-  data.tar.gz: 36605153506952b323be6e3a7646fd4446f280943fc6c587d7885e8eec413c33
+  metadata.gz: 9481229c15756515053bbc91453db90d914e40e5f536d0b5aaad0f2b8fff5868
+  data.tar.gz: 1ea1f9caa3dbb1f945f4a3ba9f9af17c80c786594692de1564ca4f76692fa628
 SHA512:
-  metadata.gz: ba53c1fb987ffd933017ccc64a3a72adc032de81a377e34684c4927304d295d85531ad11e796abd3c17489411fcf15eedd494d7ff7a8b7d0c53fdeb511eb5a8d
-  data.tar.gz: 6dff687f32dfef7f0cc19b76cba77a6233ebbefa9b90f522f37092468370eb5abb0e7f185d86f74077944cb0c76609b01390e7878ca494a82419ac44e59d93e5
+  metadata.gz: f13bb894b69d4c92b03afc30fcce1be95ba1af1b0cb963c553a328fb85f771c852ee5526af751a098dd4f1b69c60592f021a0e3ee7e40004856d1d4eabc53aba
+  data.tar.gz: 751ad7fc17f2db38961e835f8c9b2a325cbf82692df65ef29c638bcf3eec9cbc17905a39bcbcf5a53bcf477adbf6080a23aa40702b3fb5a55727038eefe9b09d

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format Fuubar
 --color
 --require spec_helper

data/docker/Dockerfile

@@ -3,7 +3,7 @@ FROM ruby:3.1.3-alpine3.17
 RUN apk --no-cache add git build-base ruby-dev sqlite-dev postgresql-dev mysql-client mysql-dev && \
   gem install pg mysql2
 
-ARG MIHARI_VERSION=4.11.0
+ARG MIHARI_VERSION=5.1.0
 
 RUN gem install mihari -v ${MIHARI_VERSION}
 

data/lib/mihari/cli/database.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "mihari/commands/database"
+
+module Mihari
+  module CLI
+    class Database < Base
+      include Mihari::Commands::Database
+    end
+  end
+end

data/lib/mihari/cli/main.rb

@@ -3,23 +3,29 @@
 require "thor"
 
 # Commands
-require "mihari/commands/initializer"
 require "mihari/commands/searcher"
-require "mihari/commands/validator"
 require "mihari/commands/version"
 require "mihari/commands/web"
+require "mihari/commands/database"
 
 # CLIs
 require "mihari/cli/base"
 
+require "mihari/cli/database"
+require "mihari/cli/rule"
+
 module Mihari
   module CLI
     class Main < Base
       include Mihari::Commands::Searcher
       include Mihari::Commands::Version
       include Mihari::Commands::Web
-      include Mihari::Commands::Validator
-      include Mihari::Commands::Initializer
+
+      desc "db", "Sub commands for DB"
+      subcommand "db", Database
+
+      desc "rule", "Sub commands for rule"
+      subcommand "rule", Rule
     end
   end
 end

data/lib/mihari/cli/rule.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "mihari/commands/rule"
+
+module Mihari
+  module CLI
+    class Rule < Base
+      include Mihari::Commands::Rule
+    end
+  end
+end

data/lib/mihari/commands/database.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Mihari
+  module Commands
+    module Database
+      include Mixins::Database
+
+      def self.included(thor)
+        thor.class_eval do
+          desc "migrate", "Migrate DB schemas"
+          method_option :verbose, type: :boolean, default: true
+          #
+          # @param [String] direction
+          #
+          #
+          def migrate(direction = "up")
+            verbose = options["verbose"]
+            ActiveRecord::Migration.verbose = verbose
+
+            with_db_connection do
+              Mihari::Database.migrate(direction.to_sym)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mihari/commands/{initializer.rb → rule.rb}

@@ -4,20 +4,41 @@ require "pathname"
 
 module Mihari
   module Commands
-    module Initializer
+    module Rule
       def self.included(thor)
         thor.class_eval do
-          desc "init", "Initialize a new rule"
-          method_option :path, type: :string, default: "./rule.yml"
-          def init
-            path = options["path"]
+          desc "validate [PATH]", "Validate a rule file"
+          #
+          # Validate format of a rule
+          #
+          # @param [String] path
+          #
+          def validate(path)
+            rule = Structs::Rule.from_path_or_id(path)
 
+            begin
+              rule.validate!
+              Mihari.logger.info "Valid format. The input is parsed as the following:"
+              Mihari.logger.info rule.data.to_yaml
+            rescue RuleValidationError
+              nil
+            end
+          end
+
+          desc "init [PATH]", "Initialize a new rule file"
+          #
+          # Initialize a new rule file
+          #
+          # @param [String] path
+          #
+          #
+          def init(path = "./rule.yml")
             warning = "#{path} exists. Do you want to overwrite it? (y/n)"
             return if Pathname(path).exist? && !(yes? warning)
 
             initialize_rule path
 
-            Mihari.logger.info "A new rule is initialized as #{path}."
+            Mihari.logger.info "A new rule is initialized: #{path}."
           end
 
           no_commands do

data/lib/mihari/commands/searcher.rb

@@ -10,6 +10,11 @@ module Mihari
         thor.class_eval do
           desc "search [PATH]", "Search by a rule"
           method_option :force_overwrite, type: :boolean, aliases: "-f", desc: "Force an overwrite the rule"
+          #
+          # Search by a rule
+          #
+          # @param [String] path_or_id
+          #
           def search(path_or_id)
             with_db_connection do
               rule = Structs::Rule.from_path_or_id path_or_id

data/lib/mihari/database.rb

@@ -9,10 +9,6 @@ def env
   ENV["APP_ENV"] || ENV["RACK_ENV"]
 end
 
-def test_env?
-  env == "test"
-end
-
 def development_env?
   env == "development"
 end
@@ -121,22 +117,24 @@ def adapter
   "sqlite3"
 end
 
+#
+# @return [Array<ActiveRecord::Migration>] schemas
+#
+def schemas
+  [V5Schema]
+end
+
 module Mihari
   class Database
     class << self
-      include Memist::Memoizable
-
       #
       # DB migraration
       #
       # @param [Symbol] direction
       #
       def migrate(direction)
-        ActiveRecord::Migration.verbose = false
-
-        [V5Schema].each { |schema| schema.migrate direction }
+        schemas.each { |schema| schema.migrate direction }
       end
-      memoize :migrate unless test_env?
 
       #
       # Establish DB connection
@@ -153,10 +151,7 @@ module Mihari
             database: Mihari.config.database_url.path[1..]
           )
         end
-
         ActiveRecord::Base.logger = Logger.new($stdout) if development_env?
-
-        migrate :up
       rescue StandardError => e
         Mihari.logger.error e
       end
@@ -169,15 +164,6 @@ module Mihari
 
         ActiveRecord::Base.clear_active_connections!
       end
-
-      #
-      # Destory DB
-      #
-      def destroy!
-        return unless ActiveRecord::Base.connected?
-
-        migrate :down
-      end
     end
   end
 end

data/lib/mihari/mixins/database.rb

@@ -6,6 +6,8 @@ module Mihari
       def with_db_connection
         Mihari::Database.connect
         yield
+      rescue ActiveRecord::StatementInvalid
+        Mihari.logger.error("You haven't finished the DB migration! Please run 'mihari db migrate'.")
       ensure
         Mihari::Database.close
       end

data/lib/mihari/version.rb

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

data/mihari.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.4"
   spec.add_development_dependency "coveralls_reborn", "~> 0.27"
   spec.add_development_dependency "fakefs", "~> 2.4"
+  spec.add_development_dependency "fuubar", "~> 2.5"
   spec.add_development_dependency "mysql2", "~> 0.5"
   spec.add_development_dependency "overcommit", "~> 0.60"
   spec.add_development_dependency "pg", "~> 1.4"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mihari
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.1.0
 platform: ruby
 authors:
 - Manabu Niseki
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-19 00:00:00.000000000 Z
+date: 2023-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -1066,10 +1080,12 @@ files:
 - lib/mihari/analyzers/virustotal_intelligence.rb
 - lib/mihari/analyzers/zoomeye.rb
 - lib/mihari/cli/base.rb
+- lib/mihari/cli/database.rb
 - lib/mihari/cli/main.rb
-- lib/mihari/commands/initializer.rb
+- lib/mihari/cli/rule.rb
+- lib/mihari/commands/database.rb
+- lib/mihari/commands/rule.rb
 - lib/mihari/commands/searcher.rb
-- lib/mihari/commands/validator.rb
 - lib/mihari/commands/version.rb
 - lib/mihari/commands/web.rb
 - lib/mihari/constants.rb

data/lib/mihari/commands/validator.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Mihari
-  module Commands
-    module Validator
-      def self.included(thor)
-        thor.class_eval do
-          desc "validate [PATH]", "Validate a rule file"
-          #
-          # Validate format of a rule
-          #
-          # @param [String] path
-          #
-          # @return [nil]
-          #
-          def validate(path)
-            rule = Structs::Rule.from_path_or_id(path)
-
-            begin
-              rule.validate!
-              Mihari.logger.info "Valid format. The input is parsed as the following:"
-              Mihari.logger.info rule.data.to_yaml
-            rescue RuleValidationError
-              nil
-            end
-          end
-        end
-      end
-    end
-  end
-end