hachi 0.3.1 → 2.0.0

data/lib/hachi/clients/base.rb

@@ -7,18 +7,83 @@ require "uri"
 module Hachi
   module Clients
     class Base
+      # @return [String]
       attr_reader :api_endpoint
+
+      # @return [String]
       attr_reader :api_key
 
-      def initialize(api_endpoint:, api_key:)
+      # @return [String, nil]
+      attr_reader :api_version
+
+      include Hachi::Awrence::Methods
+
+      def initialize(api_endpoint:, api_key:, api_version:)
         @api_endpoint = URI(api_endpoint)
         @api_key = api_key
+        @api_version = api_version
+      end
+
+      def get(path, params: {}, &block)
+        url = url_for(path)
+        url.query = URI.encode_www_form(params) unless params.empty?
+
+        get = Net::HTTP::Get.new(url)
+        get.add_field "Authorization", "Bearer #{api_key}"
+        request(get, &block)
+      end
+
+      def post(path, params: {}, json: {}, &block)
+        url = url_for(path)
+        url.query = URI.encode_www_form(params) unless params.empty?
+
+        json = to_camelback_keys(json.compact) if json.is_a?(Hash)
+
+        post = Net::HTTP::Post.new(url)
+        post.body = json.is_a?(Hash) ? json.to_json : json.to_s
+
+        post.add_field "Content-Type", "application/json"
+        post.add_field "Authorization", "Bearer #{api_key}"
+
+        request(post, &block)
+      end
+
+      def delete(path, params: {}, json: {}, &block)
+        url = url_for(path)
+        url.query = URI.encode_www_form(params) unless params.empty?
+
+        json = to_camelback_keys(json.compact) if json.is_a?(Hash)
+
+        delete = Net::HTTP::Delete.new(url)
+        delete.body = json.is_a?(Hash) ? json.to_json : json.to_s
+
+        delete.add_field "Authorization", "Bearer #{api_key}"
+        request(delete, &block)
+      end
+
+      def patch(path, params: {}, json: {}, &block)
+        url = url_for(path)
+        url.query = URI.encode_www_form(params) unless params.empty?
+
+        json = to_camelback_keys(json.compact) if json.is_a?(Hash)
+
+        patch = Net::HTTP::Patch.new(url)
+        patch.body = json.is_a?(Hash) ? json.to_json : json.to_s
+
+        patch.add_field "Content-Type", "application/json"
+        patch.add_field "Authorization", "Bearer #{api_key}"
+
+        request(patch, &block)
       end
 
       private
 
       def base_url
-        "#{api_endpoint.scheme}://#{api_endpoint.hostname}:#{api_endpoint.port}"
+        if api_version.nil? || api_version.to_s.empty?
+          "#{api_endpoint.scheme}://#{api_endpoint.hostname}:#{api_endpoint.port}/api"
+        else
+          "#{api_endpoint.scheme}://#{api_endpoint.hostname}:#{api_endpoint.port}/api/#{api_version}"
+        end
       end
 
       def url_for(path)
@@ -28,13 +93,13 @@ module Hachi
       def https_options
         return nil if api_endpoint.scheme != "https"
 
-        if proxy = ENV["HTTPS_PROXY"] || ENV["https_proxy"]
+        if proxy = ENV.fetch("HTTPS_PROXY") { ENV.fetch("https_proxy", nil) }
           uri = URI(proxy)
           {
             proxy_address: uri.hostname,
             proxy_port: uri.port,
             proxy_from_env: false,
-            use_ssl: true,
+            use_ssl: true
           }
         else
           { use_ssl: true }
@@ -42,12 +107,12 @@ module Hachi
       end
 
       def http_options
-        if proxy = ENV["HTTP_PROXY"] || ENV["http_proxy"]
+        if proxy = ENV.fetch("HTTP_PROXY") { ENV.fetch("http_proxy", nil) }
           uri = URI(proxy)
           {
             proxy_address: uri.hostname,
             proxy_port: uri.port,
-            proxy_from_env: false,
+            proxy_from_env: false
           }
         else
           {}
@@ -74,107 +139,8 @@ module Hachi
         end
       end
 
-      def get(path, params = {}, &block)
-        url = url_for(path)
-        url.query = URI.encode_www_form(params) unless params.empty?
-
-        get = Net::HTTP::Get.new(url)
-        get.add_field "Authorization", "Bearer #{api_key}"
-        request(get, &block)
-      end
-
-      def post(path, params = {}, &block)
-        url = url_for(path)
-
-        post = Net::HTTP::Post.new(url)
-        post.body = params.is_a?(Hash) ? params.to_json : params.to_s
-
-        post.add_field "Content-Type", "application/json"
-        post.add_field "Authorization", "Bearer #{api_key}"
-
-        request(post, &block)
-      end
-
-      def delete(path, params = {}, &block)
-        url = url_for(path)
-        url.query = URI.encode_www_form(params) unless params.empty?
-
-        delete = Net::HTTP::Delete.new(url)
-        delete.add_field "Authorization", "Bearer #{api_key}"
-        request(delete, &block)
-      end
-
-      def patch(path, params = {}, &block)
-        url = url_for(path)
-
-        patch = Net::HTTP::Patch.new(url)
-        patch.body = params.is_a?(Hash) ? params.to_json : params.to_s
-
-        patch.add_field "Content-Type", "application/json"
-        patch.add_field "Authorization", "Bearer #{api_key}"
-
-        request(patch, &block)
-      end
-
-      def validate_range(range)
-        return true if range == "all"
-        raise ArgumentError, "range should be 'all' or `from-to`" unless range.match?(/(\d+)-(\d+)/)
-
-        from, to = range.split("-").map(&:to_i)
-        return true if from < to
-
-        raise ArgumentError, "from should be smaller than to"
-      end
-
-      def _search(path, attributes:, range: "all", sort: nil)
-        validate_range range
-
-        attributes = normalize_attributes(attributes)
-        conditions = attributes.map do |key, value|
-          if key == :data && value.is_a?(Array)
-            { _or: decompose_data(value) }
-          else
-            { _string: "#{key}:\"#{value}\"" }
-          end
-        end
-
-        default_conditions = {
-          _and: [
-            { _not: { status: "Deleted" } },
-            { _not: { _in: { _field: "_type", _values: ["dashboard", "data", "user", "analyzer", "caseTemplate", "reportTemplate", "action"] } } },
-          ],
-        }
-
-        query = {
-          _and: [conditions, default_conditions].flatten,
-        }
-
-        query_string = build_query_string(range: range, sort: sort)
-
-        post("#{path}?#{query_string}", query: query) { |json| json }
-      end
-
-      def decompose_data(data)
-        data.map do |elem|
-          { _field: "data", _value: elem }
-        end
-      end
-
-      def normalize_attributes(attributes)
-        h = {}
-        attributes.each do |key, value|
-          h[camelize(key).to_sym] = value
-        end
-        h
-      end
-
-      def camelize(string)
-        head, *others = string.to_s.split("_")
-        [head, others.map(&:capitalize)].flatten.join
-      end
-
       def build_query_string(params)
-        URI.encode_www_form(params.reject { |_k, v| v.nil? })
+        URI.encode_www_form(params.compact)
       end
     end
   end

data/lib/hachi/clients/case.rb

@@ -3,15 +3,6 @@
 module Hachi
   module Clients
     class Case < Base
-      #
-      # List cases
-      #
-      # @return [Array]
-      #
-      def list
-        get("/api/case") { |json| json }
-      end
-
       #
       # Get a case
       #
@@ -20,7 +11,7 @@ module Hachi
       # @return [Hash]
       #
       def get_by_id(id)
-        get("/api/case/#{id}") { |json| json }
+        get("/case/#{id}") { |json| json }
       end
 
       #
@@ -31,114 +22,30 @@ module Hachi
       # @return [String]
       #
       def delete_by_id(id)
-        delete("/api/case/#{id}") { |json| json }
+        delete("/case/#{id}") { |json| json }
       end
 
       #
       # Create a case
       #
-      # @param [String, nil] title
-      # @param [String, nil] description
-      # @param [Integer, nil] severity
-      # @param [String, nil] start_date
-      # @param [String, nil] owner
-      # @param [Boolean, nil] flag
-      # @param [Intege, nil] tlp
-      # @param [String, nil] tags
-      #
-      # @return [Hash]
-      #
-      def create(title:, description:, severity: nil, start_date: nil, owner: nil, flag: nil, tlp: nil, tags: nil)
-        kase = Models::Case.new(
-          title: title,
-          description: description,
-          severity: severity,
-          start_date: start_date,
-          owner: owner,
-          flag: flag,
-          tlp: tlp,
-          tags: tags,
-        )
-
-        post("/api/case", kase.payload) { |json| json }
-      end
-
-      #
-      # Find cases
-      #
-      # @param [Hash] attributes
-      # @param [String] range
-      #
-      # @return [Hash]
-      #
-      def search(attributes, range: "all")
-        _search("/api/case/_search", attributes: attributes, range: range) { |json| json }
-      end
-
-      #
-      # Get list of cases linked to this case
-      #
-      # @param [String] id Case ID
-      #
-      # @return [Array]
-      #
-      def links(id)
-        get("/api/case/#{id}/links") { |json| json }
-      end
-
-      #
-      # Merge two cases
-      #
-      # @param [String] id1 Case ID
-      # @param [String] id2 Case ID
+      # @param [Hash] payload
       #
       # @return [Hash]
       #
-      def merge(id1, id2)
-        post("/api/case/#{id1}/_merge/#{id2}") { |json| json }
+      def create(**payload)
+        post("/case", json: payload) { |json| json }
       end
 
       #
       # Update a case
       #
-      # @param [String, nil] id
-      # @param [String, nil] title
-      # @param [String, nil] description
-      # @param [String, nil] severity
-      # @param [String, nil] start_date
-      # @param [String, nil] owner
-      # @param [Boolean, nil] flag
-      # @param [Integer, nil] tlp
-      # @param [String, nil] tags
-      # @param [String, nil] status
-      # @param [String, nil] resolution_status
-      # @param [String, nil] impact_status
-      # @param [String, nil] summary
-      # @param [String, nil] end_date
-      # @param [String, nil] metrics
-      # @param [String, nil] custom_fields
+      # @param [String] id
+      # @param [Hash] payload
       #
       # @return [Hash]
       #
-      def update(id, title: nil, description: nil, severity: nil, start_date: nil, owner: nil, flag: nil, tlp: nil, tags: nil, status: nil, resolution_status: nil, impact_status: nil, summary: nil, end_date: nil, metrics: nil, custom_fields: nil )
-        attributes = {
-          title: title,
-          description: description,
-          severity: severity,
-          startDate: start_date,
-          owner: owner,
-          flag: flag,
-          tlp: tlp,
-          tags: tags,
-          status: status,
-          resolutionStatus: resolution_status,
-          impactStatus: impact_status,
-          summary: summary,
-          endDate: end_date,
-          metrics: metrics,
-          customFields: custom_fields
-        }.compact
-        patch("/api/case/#{id}", attributes) { |json| json }
+      def update(id, **payload)
+        patch("/case/#{id}", json: payload) { |json| json }
       end
     end
   end

data/lib/hachi/clients/observable.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Hachi
+  module Clients
+    class Observable < Base
+      #
+      # Create an observable in a case
+      #
+      # @param [String] case_id Observable ID
+      # @param [Hash] payload
+      #
+      # @return [Hash]
+      #
+      def create_in_case(case_id, **payload)
+        post("/case/#{case_id}/observable", json: payload) { |json| json }
+      end
+
+      #
+      # Create an observable in an alert
+      #
+      # @param [String] alert_id Observable ID
+      # @param [Hash] payload
+      #
+      # @return [Hash]
+      #
+      def create_in_alert(alert_id, **payload)
+        post("/alert/#{alert_id}/observable", json: payload) { |json| json }
+      end
+
+      #
+      # Get an observable
+      #
+      # @param [String] id observable ID
+      #
+      # @return [Hash]
+      #
+      def get_by_id(id)
+        get("/observable/#{id}") { |json| json }
+      end
+
+      #
+      # Delete an observable
+      #
+      # @param [String] id observable ID
+      #
+      # @return [String]
+      #
+      def delete_by_id(id)
+        delete("/observable/#{id}") { |json| json }
+      end
+    end
+  end
+end

data/lib/hachi/clients/query.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Hachi
+  module Clients
+    class Query < Base
+      #
+      # Query
+      #
+      # @param [Hash] payload
+      #
+      # @return [Hash]
+      #
+      def query(**payload)
+        post("/query", json: payload) { |json| json }
+      end
+    end
+  end
+end

data/lib/hachi/clients/user.rb

@@ -9,7 +9,7 @@ module Hachi
       # @return [Hash]
       #
       def current
-        get("/api/user/current") { |json| json }
+        get("/user/current") { |json| json }
       end
 
       #
@@ -20,7 +20,7 @@ module Hachi
       # @return [Hash]
       #
       def get_by_id(id)
-        get("/api/user/#{id}") { |json| json }
+        get("/user/#{id}") { |json| json }
       end
 
       #
@@ -31,28 +31,18 @@ module Hachi
       # @return [String]
       #
       def delete_by_id(id)
-        delete("/api/user/#{id}") { |json| json }
+        delete("/user/#{id}") { |json| json }
       end
 
       #
       # Create a user
       #
-      # @param [String] login
-      # @param [String] name
-      # @param [Array<String>] roles
-      # @param [String] password
+      # @param [Hash] payload
       #
       # @return [Hash]
       #
-      def create(login:, name:, roles:, password:)
-        user = Models::User.new(
-          login: login,
-          name: name,
-          roles: roles,
-          password: password
-        )
-
-        post("/api/user", user.payload) { |json| json }
+      def create(**payload)
+        post("/user", json: payload) { |json| json }
       end
     end
   end

data/lib/hachi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hachi
-  VERSION = "0.3.1"
+  VERSION = "2.0.0"
 end

data/lib/hachi.rb

@@ -2,20 +2,29 @@
 
 require "hachi/version"
 
-require "hachi/api"
+require "hachi/awrence/methods"
 
-require "hachi/models/base"
-require "hachi/models/alert"
-require "hachi/models/artifact"
-require "hachi/models/case"
-require "hachi/models/user"
+require "hachi/api"
 
 require "hachi/clients/base"
+
 require "hachi/clients/alert"
 require "hachi/clients/artifact"
 require "hachi/clients/case"
+require "hachi/clients/observable"
+require "hachi/clients/query"
 require "hachi/clients/user"
 
 module Hachi
+  module Awrence
+    class << self
+      attr_writer :acronyms
+
+      def acronyms
+        @acronyms ||= {}
+      end
+    end
+  end
+
   class Error < StandardError; end
 end

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}