hachi 1.0.0 → 2.0.0

data/lib/hachi/clients/base.rb

@@ -7,11 +7,21 @@ require "uri"
 module Hachi
   module Clients
     class Base
-      attr_reader :api_endpoint, :api_key
+      # @return [String]
+      attr_reader :api_endpoint
 
-      def initialize(api_endpoint:, api_key:)
+      # @return [String]
+      attr_reader :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)
@@ -27,6 +37,8 @@ module Hachi
         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
 
@@ -40,6 +52,8 @@ module Hachi
         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
 
@@ -51,6 +65,8 @@ module Hachi
         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
 
@@ -63,7 +79,11 @@ module Hachi
       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)
@@ -73,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 }
@@ -87,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
           {}
@@ -119,26 +139,8 @@ module Hachi
         end
       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, query:, range: "all", sort: nil)
-        validate_range range
-
-        query_string = build_query_string(range: range, sort: sort)
-
-        post("#{path}?#{query_string}", json: { query: query }) { |json| json }
-      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", json: kase.payload) { |json| json }
-      end
-
-      #
-      # Find cases
-      #
-      # @param [Hash] query
-      # @param [String] range
-      #
-      # @return [Hash]
-      #
-      def search(query, range: "all")
-        _search("/api/case/_search", query: query, 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}", json: 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", json: 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 = "1.0.0"
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hachi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Manabu Niseki
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2022-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +72,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.14'
 description: A dead simple TheHive API wrapper.
 email:
 - manabu.niseki@gmail.com
@@ -113,22 +141,16 @@ files:
 - hachi.gemspec
 - lib/hachi.rb
 - lib/hachi/api.rb
+- lib/hachi/awrence/methods.rb
 - lib/hachi/clients/alert.rb
 - lib/hachi/clients/artifact.rb
 - lib/hachi/clients/base.rb
 - lib/hachi/clients/case.rb
+- lib/hachi/clients/observable.rb
+- lib/hachi/clients/query.rb
 - lib/hachi/clients/user.rb
-- lib/hachi/models/alert.rb
-- lib/hachi/models/artifact.rb
-- lib/hachi/models/base.rb
-- lib/hachi/models/case.rb
-- lib/hachi/models/user.rb
 - lib/hachi/version.rb
 - renovate.json
-- samples/01_create_an_alert.rb
-- samples/02_search_artifacts.rb
-- samples/03_list_cases.rb
-- samples/04_merge_alerts.rb
 homepage: https://github.com/ninoseki/hachi
 licenses:
 - MIT
@@ -148,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.14
 signing_key:
 specification_version: 4
 summary: A dead simple TheHive API wrapper.

data/lib/hachi/models/alert.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require "date"
-require "securerandom"
-
-module Hachi
-  module Models
-    class Alert < Base
-      attr_reader :title, :description, :severity, :date, :tags, :tlp, :status, :type, :source, :source_ref, :artifacts, :follow
-
-      def initialize(title:, description:, type:, source:, severity: nil, date: nil, tags: nil, tlp: nil, status: nil, source_ref: nil, artifacts: nil, follow: nil)
-        @title = title
-        @description = description
-        @severity = severity
-        @date = date
-        @tags = tags
-        @tlp = tlp
-        @status = status
-        @type = type
-        @source = source
-        @source_ref = source_ref || SecureRandom.hex(10)
-        @artifacts = artifacts.nil? ? nil : artifacts.map { |a| Artifact.new(**a) }
-        @follow = follow
-
-        validate_date if date
-        validate_severity if severity
-        validate_status if status
-        validate_tlp if tlp
-        validate_artifacts if artifacts
-      end
-
-      def payload
-        {
-          title: title,
-          description: description,
-          severity: severity,
-          date: date,
-          tags: tags,
-          tlp: tlp,
-          status: status,
-          type: type,
-          source: source,
-          sourceRef: source_ref,
-          artifacts: artifacts&.map(&:payload),
-          follow: follow
-        }.compact
-      end
-
-      private
-
-      def validate_date
-        DateTime.parse(date)
-        true
-      rescue ArgumentError => _e
-        raise ArgumentError, "date should be Date format"
-      end
-
-      def validate_artifacts
-        artifacts.each(&:validate_for_creation)
-      end
-    end
-  end
-end

data/lib/hachi/models/artifact.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Hachi
-  module Models
-    class Artifact < Base
-      DATA_TYPES = %w(filename file fqdn hash uri_path ip domain mail autonomous-system registry mail_subject regexp user-agent other url).freeze
-
-      attr_reader :data, :data_type, :message, :tlp, :tags
-
-      def initialize(data:, data_type:, message: nil, tlp: nil, tags: nil)
-        @data = data
-        @data_type = data_type
-        @message = message
-        @tlp = tlp
-        @tags = tags
-
-        raise(ArgumentError, "data is required") unless data
-        raise(ArgumentError, "data_type is required") unless data_type
-        raise(ArgumentError, "invalid data type") unless DATA_TYPES.include?(data_type)
-
-        validate_tags if tags
-        validate_tlp if tlp
-      end
-
-      def payload
-        {
-          data: data,
-          dataType: data_type,
-          message: message,
-          tlp: tlp,
-          tags: tags
-        }.compact
-      end
-
-      def validate_for_creation
-        raise(ArgumentError, "message or tags is requried for artifact creation") unless message || tags
-      end
-    end
-  end
-end