hachi 0.3.1 → 2.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hachi
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Manabu Niseki
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-30 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.0'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        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.9'
+        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.9'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.14'
 description: A dead simple TheHive API wrapper.
 email:
 - manabu.niseki@gmail.com
@@ -101,9 +129,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,26 +141,21 @@ 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
-- samples/01_create_an_alert.rb
-- samples/02_search_artifacts.rb
-- samples/03_list_cases.rb
-- samples/04_merge_alerts.rb
+- renovate.json
 homepage: https://github.com/ninoseki/hachi
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.14
+signing_key:
 specification_version: 4
 summary: A dead simple TheHive API wrapper.
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6
-before_install: gem install bundler -v 2.0.1

data/lib/hachi/models/alert.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require "date"
-require "securerandom"
-
-module Hachi
-  module Models
-    class Alert < Base
-      attr_reader :title
-      attr_reader :description
-      attr_reader :severity
-      attr_reader :date
-      attr_reader :tags
-      attr_reader :tlp
-      attr_reader :status
-      attr_reader :type
-      attr_reader :source
-      attr_reader :source_ref
-      attr_reader :artifacts
-      attr_reader :follow
-
-      def initialize(title:, description:, severity: nil, date: nil, tags: nil, tlp: nil, status: nil, type:, source:, 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,44 +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
-      attr_reader :data_type
-      attr_reader :message
-      attr_reader :tlp
-      attr_reader :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

data/lib/hachi/models/base.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Hachi
-  module Models
-    class Base
-      private
-
-      def validate_severity
-        return true if severity >= 1 && severity <= 3
-
-        raise ArgumentError, "severity should be 1 - 3 (1: low; 2: medium; 3: high)"
-      end
-
-      def validate_tlp
-        return true if tlp >= 0 && tlp <= 3
-
-        raise ArgumentError, "tlp should be 0 - 3 (0: white; 1: green; 2: amber; 3: red)"
-      end
-
-      def validate_status
-        return true if %w(New Updated Ignored Imported).include?(status)
-
-        raise ArgumentError, "status should be New, Updated, Ignored or Imported"
-      end
-
-      def validate_tags
-        raise ArgumentError, "tags should be an array" unless tags.is_a?(Array)
-      end
-    end
-  end
-end

data/lib/hachi/models/case.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module Hachi
-  module Models
-    class Case < Base
-      attr_reader :title
-      attr_reader :description
-      attr_reader :severity
-      attr_reader :start_date
-      attr_reader :owner
-      attr_reader :flag
-      attr_reader :tlp
-      attr_reader :tags
-
-      def initialize(title:, description:, severity: nil, start_date: nil, owner: nil, flag: nil, tlp: nil, tags: nil)
-        @title = title
-        @description = description
-        @severity = severity
-        @start_date = start_date
-        @owner = owner
-        @flag = flag
-        @tlp = tlp
-        @tags = tags
-
-        validate_flag if flag
-        validate_severity if severity
-        validate_start_date if start_date
-        validate_tags if tags
-        validate_tlp if tlp
-      end
-
-      def payload
-        {
-          title: title,
-          description: description,
-          severity: severity,
-          startDate: start_date,
-          owner: owner,
-          flag: flag,
-          tlp: tlp,
-          tags: tags
-        }.compact
-      end
-
-      private
-
-      def validate_start_date
-        DateTime.parse(start_date)
-        true
-      rescue ArgumentError => _e
-        raise ArgumentError, "date should be Date format"
-      end
-
-      def validate_flag
-        return true if [true, false].include?(flag)
-
-        raise ArgumentError, "flag should be true or false"
-      end
-    end
-  end
-end

data/lib/hachi/models/user.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Hachi
-  module Models
-    class User < Base
-      attr_reader :login
-      attr_reader :name
-      attr_reader :roles
-      attr_reader :password
-
-      ROLES = %w(read write admin).freeze
-
-      def initialize(login:, name:, roles:, password:)
-        @login = login
-        @name = name
-        @roles = roles
-        @password = password
-
-        validate_roles
-      end
-
-      def payload
-        {
-          login: login,
-          name: name,
-          roles: roles,
-          password: password
-        }.compact
-      end
-
-      private
-
-      def validate_roles
-        raise ArgumentError, "roles should be an array" unless roles.is_a?(Array)
-        raise ArgumentError, "role should be one of #{ROLES.join('.')}" unless roles.all? { |role| ROLES.include? role }
-      end
-    end
-  end
-end

data/samples/01_create_an_alert.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift("#{__dir__}/../lib")
-
-require "hachi"
-
-api = Hachi::API.new
-
-# create a simple alert
-api.alert.create(title: "test", description: "test", type: "test", source: "test")
-
-# create an alert with artifacts
-artifacts = [
-  { data: "1.1.1.1", data_type: "ip", message: "test" },
-  { data: "github.com", data_type: "domain", tags: ["test"] }
-]
-api.alert.create(title: "test", description: "test", type: "test", source: "test", artifacts: artifacts)

data/samples/02_search_artifacts.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift("#{__dir__}/../lib")
-
-require "hachi"
-
-api = Hachi::API.new
-
-# search artifacts
-results = api.artifact.search(data: "1.1.1.1", data_type: "ip")
-ids = results.map { |result| result.dig("id") }
-
-ids.each do |id|
-  artifact = api.artifact.get_by_id(id)
-  p artifact
-end

data/samples/03_list_cases.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift("#{__dir__}/../lib")
-
-require "hachi"
-
-api = Hachi::API.new
-
-# list up cases
-results = api.case.list
-ids = results.map { |result| result.dig("id") }
-
-ids.each do |id|
-  kase = api.case.get_by_id(id)
-  p kase
-end

data/samples/04_merge_alerts.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift("#{__dir__}/../lib")
-
-require "hachi"
-
-def api
-  @api ||= Hachi::API.new
-end
-
-description = ARGV[0].to_s
-case_id = ARGV[1].to_s
-
-alerts = api.alert.search(description: description)
-alert_ids = alerts.map { |alert| alert.dig "id" }
-
-api.alert.merge_into_case(alert_ids, case_id)