Module: Mihari::Commands::Rule

Included in:
Mihari::CLI::Rule
Defined in:
lib/mihari/commands/rule.rb

Overview

Rule sub-commands

Class Method Summary collapse

Class Method Details

.included(thor) ⇒ Object

rubocop:disable Metrics/AbcSize



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/mihari/commands/rule.rb', line 11

def included(thor)
  thor.class_eval do
    include Concerns::DatabaseConnectable

    no_commands do
      #
      # @param [String] q
      # @param [Integer] page
      # @param [Integer] limit
      #
      # @return [Mihari::Services::ResultValue]
      #
      def _search(q, page: 1, limit: 10)
        filter = Structs::Filters::Search.new(q:, page:, limit:)
        Services::RuleSearcher.call filter
      end
    end

    desc "validate PATH", "Validate rule(s)"
    #
    # Validate rule(s)
    #
    # @param [Array<String>] paths
    #
    def validate(*paths)
      # @type [Array<Mihari::ValidationError>]
      errors = paths.flat_map { |path| Dir.glob(path) }.map do |path|
        Dry::Monads::Try[ValidationError] { Mihari::Rule.from_file(path) }
      end.filter_map do |result|
        result.exception if result.error?
      end
      return if errors.empty?

      errors.each do |error|
        data = Entities::ErrorMessage.represent(message: error.message, detail: error.detail)
        warn JSON.pretty_generate(data.as_json)
      end

      exit 1
    end

    desc "format PATH", "format a rule"
    #
    # Format a rule file
    #
    # @param [String] path
    #
    def format(path)
      rule = Dry::Monads::Try[ValidationError] { Mihari::Rule.from_file(path) }.value!
      puts rule.data.to_yaml
    end

    desc "init PATH", "Initialize a new rule"
    #
    # Initialize a new rule file
    #
    # @param [String] path
    #
    def init(path = "./rule.yml")
      warning = "Do you want to overwrite it? (y/n)"
      return if Pathname(path).exist? && !(yes? warning)

      Services::RuleInitializer.call path
    end

    desc "list QUERY", "List/search rules"
    around :with_db_connection
    method_option :page, type: :numeric, default: 1
    method_option :limit, type: :numeric, default: 10
    #
    # @param [String] q
    #
    def list(q = "")
      value = _search(q, page: options["page"], limit: options["limit"])
      data = Entities::RulesWithPagination.represent(
        results: value.results,
        total: value.total,
        current_page: value.filter[:page].to_i,
        page_size: value.filter[:limit].to_i
      )
      puts JSON.pretty_generate(data.as_json)
    end

    desc "list-transform QUERY", "List/search rules with transformation"
    around :with_db_connection
    method_option :template, type: :string, required: true, aliases: "-t",
      desc: "Jbuilder template stringor a path to a template"
    method_option :page, type: :numeric, default: 1
    method_option :limit, type: :numeric, default: 10
    #
    # @param [String] q
    #
    def list_transform(q = "")
      value = _search(q, page: options["page"], limit: options["limit"])
      puts Services::JbuilderRenderer.call(
        options["template"],
        {
          results: value.results,
          total: value.total,
          current_page: value.filter[:page].to_i,
          page_size: value.filter[:limit].to_i
        }
      )
    end

    desc "get ID", "Get a rule"
    around :with_db_connection
    def get(id)
      value = Services::RuleGetter.result(id).value!
      data = Entities::Rule.represent(value)
      puts JSON.pretty_generate(data.as_json)
    end

    desc "delete ID", "Delete a rule"
    around :with_db_connection
    #
    # @param [String] id
    #
    def delete(id)
      Services::RuleDestroyer.call id
    end
  end
end