hachi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a94e022e1b2936129782ed6b1fbe367da78f1b6438473f9f0caa0491eb717dcc
-  data.tar.gz: 5d676f455886a20254fdb8763be410dcd3dd66c618688a2b9c68d20840b67a1f
+  metadata.gz: 87cd25193f5c029ffe10e1c1dffcd423c7fb33ee7b6de160774435e27addf39e
+  data.tar.gz: 517b92aa1ad86f6fe91256aa2c1f7ca17aa963c68d39cd0bc0801348e8df6c28
 SHA512:
-  metadata.gz: 872f23c2706dab7b0cd866ac36e7f6fd9fe6d9fbcaa2cb773c8c2391aeb354d09fb515056dc81aae47be0461dcc78832e4bf36efb704df0322753c63e4bda6e8
-  data.tar.gz: 00636aae8a8b8a1eb080bc804a85ffb5ee6584a0932e8508d696a5c46e8644a4193ce2b20bcad6bf1248f4cb1a891af13acf0ef69234ebaa81155d45c6f00fc5
+  metadata.gz: 571b2bfe288550645f5158a43a63170a4067c3ef66e2d0e1170d597548548b57fa91b5028476e453008cab0f4083fcf3b1688cacb6c0a570258df9bbd8ae0bcd
+  data.tar.gz: 5b55a9c1a62ec128b7ef5b73af436e77331c8bdb44ee40e21fbf228bc1216b63e36407938ba14973445b6f8f6fdc28ffa4404246490b62ca04c91fad3231ba6e

data/README.md

@@ -28,6 +28,8 @@ api.alert.list
 api.artifact.search(data: "1.1.1.1", data_type: "ip")
 ```
 
+See `samples` for more.
+
 ## Implemented methods
 
 ### Alert

data/lib/hachi.rb

@@ -4,6 +4,7 @@ require "hachi/version"
 
 require "hachi/api"
 
+require "hachi/models/base"
 require "hachi/models/alert"
 require "hachi/models/artifact"
 require "hachi/models/case"

data/lib/hachi/models/alert.rb

@@ -5,7 +5,7 @@ require "securerandom"
 
 module Hachi
   module Models
-    class Alert
+    class Alert < Base
       attr_reader :title
       attr_reader :description
       attr_reader :severity
@@ -30,13 +30,14 @@ module Hachi
         @type = type
         @source = source
         @source_ref = source_ref || SecureRandom.hex(10)
-        @artifacts = artifacts
+        @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
@@ -51,36 +52,22 @@ module Hachi
           type: type,
           source: source,
           sourceRef: source_ref,
-          artifacts: artifacts,
+          artifacts: artifacts&.map(&:payload),
           follow: follow
         }.compact
       end
 
       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_date
         DateTime.parse(date)
         true
       rescue ArgumentError => _
-        raise ArgumentError, "date should be Date format."
+        raise ArgumentError, "date should be Date format"
       end
 
-      def validate_tlp
-        return true if tlp >= 0 && severity <= 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"
+      def validate_artifacts
+        artifacts.each(&:validate_for_creation)
       end
     end
   end

data/lib/hachi/models/artifact.rb

@@ -2,7 +2,7 @@
 
 module Hachi
   module Models
-    class Artifact
+    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
@@ -21,7 +21,9 @@ module Hachi
         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)
-        raise(ArgumentError, "tags should be an array") unless tags.nil? || tags.is_a?(Array)
+
+        validate_tags if tags
+        validate_tlp if tlp
       end
 
       def payload
@@ -33,6 +35,10 @@ module Hachi
           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

@@ -0,0 +1,32 @@
+# 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

@@ -2,7 +2,7 @@
 
 module Hachi
   module Models
-    class Case
+    class Case < Base
       attr_reader :title
       attr_reader :description
       attr_reader :severity
@@ -25,6 +25,7 @@ module Hachi
         validate_flag if flag
         validate_severity if severity
         validate_start_date if start_date
+        validate_tags if tags
         validate_tlp if tlp
       end
 
@@ -43,29 +44,17 @@ module Hachi
 
       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_start_date
         DateTime.parse(start_date)
         true
       rescue ArgumentError => _
-        raise ArgumentError, "date should be Date format."
-      end
-
-      def validate_tlp
-        return true if tlp >= 0 && severity <= 3
-
-        raise ArgumentError, "tlp should be 0 - 3 (0: white; 1: green; 2: amber; 3: red)."
+        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."
+        raise ArgumentError, "flag should be true or false"
       end
     end
   end

data/lib/hachi/version.rb

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

data/samples/01_create_an_alert.rb

@@ -0,0 +1,17 @@
+# 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

@@ -0,0 +1,16 @@
+# 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

@@ -0,0 +1,16 @@
+# 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hachi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Manabu Niseki
@@ -119,8 +119,12 @@ files:
 - lib/hachi/clients/case.rb
 - lib/hachi/models/alert.rb
 - lib/hachi/models/artifact.rb
+- lib/hachi/models/base.rb
 - lib/hachi/models/case.rb
 - lib/hachi/version.rb
+- samples/01_create_an_alert.rb
+- samples/02_search_artifacts.rb
+- samples/03_list_cases.rb
 homepage: https://github.com/ninoseki/hachi
 licenses:
 - MIT