misp 0.1.0 → 0.1.4

data/lib/misp/event.rb

@@ -2,68 +2,99 @@
 
 module MISP
   class Event < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_accessor :orgc_id
+    # @return [String]
     attr_accessor :org_id
+    # @return [String]
     attr_accessor :date
+    # @return [String]
     attr_accessor :threat_level_id
+    # @return [String]
     attr_accessor :info
+    # @return [Boolean]
     attr_accessor :published
+    # @return [String]
     attr_reader :uuid
+    # @return [String]
     attr_accessor :attribute_count
+    # @return [String]
     attr_accessor :analysis
+    # @return [String]
     attr_accessor :timestamp
+    # @return [String]
     attr_accessor :distribution
+    # @return [Boolean]
     attr_accessor :proposal_email_lock
+    # @return [Boolean]
     attr_accessor :locked
+    # @return [String]
     attr_accessor :publish_timestamp
+    # @return [String]
     attr_accessor :sharing_group_id
+    # @return [Boolean]
     attr_accessor :disable_correlation
+    # @return [String]
     attr_accessor :event_creator_email
 
+    # @return [MISP::Org, nil]
     attr_accessor :org
+    # @return [MISP::Orgc, nil]
     attr_accessor :orgc
 
+    # @return [Array<MISP::SharingGroup>]
     attr_accessor :sharing_groups
+    # @return [Array<MISP::Attribute>]
     attr_accessor :attributes
+    # @return [Array<MISP::Attribute>]
     attr_accessor :shadow_attributes
+    # @return [Array<MISP::Event>]
     attr_accessor :related_events
+    # @return [Array<<MISP::Galaxy>]
     attr_accessor :galaxies
+    # @return [Array<<MISP::Tag>]
     attr_accessor :tags
 
     def initialize(**attrs)
-      attrs = normalize_attributes(attrs)
-
-      @id = attrs.dig(:id)
-      @orgc_id = attrs.dig(:orgc_id)
-      @org_id = attrs.dig(:org_id)
-      @date = attrs.dig(:date)
-      @threat_level_id = attrs.dig(:threat_level_id)
-      @info = attrs.dig(:info)
-      @published = attrs.dig(:published) || false
-      @uuid = attrs.dig(:uuid)
-      @attribute_count = attrs.dig(:attribute_count)
-      @analysis = attrs.dig(:analysis)
-      @timestamp = attrs.dig(:timestamp)
-      @distribution = attrs.dig(:distribution)
-      @proposal_email_lock = attrs.dig(:proposal_email_lock)
-      @locked = attrs.dig(:locked) || false
-      @publish_timestamp = attrs.dig(:publish_timestamp)
-      @sharing_group_id = attrs.dig(:sharing_group_id)
-      @disable_correlation = attrs.dig(:disable_correlation)
-      @event_creator_email = attrs.dig(:event_creator_email)
-
-      @org = build_attribute(item: attrs.dig(:Org), klass: Org)
-      @orgc = build_attribute(item: attrs.dig(:Orgc), klass: Orgc)
-
-      @sharing_groups = build_plural_attribute(items: attrs.dig(:SharingGroup), klass: SharingGroup)
-      @attributes = build_plural_attribute(items: attrs.dig(:Attribute), klass: Attribute)
-      @shadow_attributes = build_plural_attribute(items: attrs.dig(:ShadowAttribute), klass: Attribute )
-      @related_events = build_plural_attribute(items: attrs.dig(:RelatedEvent), klass: Attribute)
-      @galaxies = build_plural_attribute(items: attrs.dig(:Galaxy), klass: Galaxy)
-      @tags = build_plural_attribute(items: attrs.dig(:Tag), klass: Tag)
-    end
-
+      attrs = normalize_attributes(**attrs)
+
+      @id = attrs[:id]
+      @orgc_id = attrs[:orgc_id]
+      @org_id = attrs[:org_id]
+      @date = attrs[:date]
+      @threat_level_id = attrs[:threat_level_id]
+      @info = attrs[:info]
+      @published = attrs[:published] || false
+      @uuid = attrs[:uuid]
+      @attribute_count = attrs[:attribute_count]
+      @analysis = attrs[:analysis]
+      @timestamp = attrs[:timestamp]
+      @distribution = attrs[:distribution]
+      @proposal_email_lock = attrs[:proposal_email_lock]
+      @locked = attrs[:locked] || false
+      @publish_timestamp = attrs[:publish_timestamp]
+      @sharing_group_id = attrs[:sharing_group_id]
+      @disable_correlation = attrs[:disable_correlation]
+      @event_creator_email = attrs[:event_creator_email]
+
+      @org = build_attribute(item: attrs[:Org], klass: Org)
+      @orgc = build_attribute(item: attrs[:Orgc], klass: Orgc)
+
+      @sharing_groups = build_plural_attribute(items: attrs[:SharingGroup], klass: SharingGroup)
+      @attributes = build_plural_attribute(items: attrs[:Attribute], klass: Attribute)
+      @shadow_attributes = build_plural_attribute(items: attrs[:ShadowAttribute], klass: Attribute )
+      @related_events = build_plural_attribute(items: attrs[:RelatedEvent], klass: Attribute)
+      @galaxies = build_plural_attribute(items: attrs[:Galaxy], klass: Galaxy)
+      @tags = build_plural_attribute(items: attrs[:Tag], klass: Tag)
+    end
+
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       compact(
         id: id,
@@ -95,53 +126,65 @@ module MISP
       )
     end
 
+    #
+    # Get an event
+    #
+    # @return [MISP::Event]
+    #
     def get(id)
-      _get("/events/#{id}") { |event| Event.new symbolize_keys(event) }
-    end
-
-    def self.get(id)
-      new.get id
+      _get("/events/#{id}") { |event| Event.new(**event) }
     end
 
+    #
+    # Create an event
+    #
+    # @param [Hash] **attrs attributes
+    #
+    # @return [MISP::Event]
+    #
     def create(**attrs)
       payload = to_h.merge(attrs)
-      _post("/events/add", wrap(payload)) { |event| Event.new symbolize_keys(event) }
-    end
-
-    def self.create(**attrs)
-      new.create attrs
+      _post("/events/add", wrap(payload)) { |event| Event.new(**event) }
     end
 
+    #
+    # Delete an event
+    #
+    # @return [Hash]
+    #
     def delete
       _delete("/events/#{id}") { |json| json }
     end
 
-    def self.delete(id)
-      new(id: id).delete
-    end
-
+    #
+    # List events
+    #
+    # @return [Array<MISP::Event>]
+    #
     def list
       _get("/events/index") do |events|
         events.map do |event|
-          Event.new symbolize_keys(event)
+          Event.new(**event)
         end
       end
     end
 
-    def self.list
-      new.list
-    end
-
+    #
+    # Update an event
+    #
+    # @return [MISP::Event]
+    #
     def update(**attrs)
-      payload = to_h.merge(attrs)
+      payload = to_h.merge(**attrs)
       payload[:timestamp] = nil
-      _post("/events/#{id}", wrap(payload)) { |event| Event.new symbolize_keys(event) }
-    end
-
-    def self.update(id, **attrs)
-      new(id: id).update attrs
+      _post("/events/#{id}", wrap(payload)) { |event| Event.new(**event) }
     end
 
+    #
+    # Search for events
+    #
+    # @return [Array<MISP::Event>]
+    #
     def search(**params)
       base = {
         returnFormat: "json",
@@ -150,27 +193,59 @@ module MISP
       }
 
       _post("/events/restSearch", base.merge(params)) do |json|
-        events = json.dig("response") || []
-        events.map { |event| Event.new symbolize_keys(event) }
+        events = json[:response] || []
+        events.map { |event| Event.new(**event) }
       end
     end
 
-    def self.search(**params)
-      new.search params
-    end
-
+    #
+    # Add an attribute to an event. Requires an update or create call afterwards.
+    #
+    # @return [MISP::Event]
+    #
     def add_attribute(attribute)
-      attribute = Attribute.new(symbolize_keys(attribute)) unless attribute.is_a?(Attribute)
+      attribute = Attribute.new(**attribute) unless attribute.is_a?(Attribute)
       attributes << attribute
       self
     end
 
+    #
+    # Add a tag to an event. Requires an update or create call afterwards.
+    #
+    # @return [MISP::Event]
+    #
     def add_tag(tag)
-      tag = Tag.new(symbolize_keys(tag)) unless tag.is_a?(MISP::Tag)
+      tag = Tag.new(**tag) unless tag.is_a?(MISP::Tag)
       tags << tag
       self
     end
 
+    class << self
+      def get(id)
+        new.get id
+      end
+
+      def create(**attrs)
+        new.create(**attrs)
+      end
+
+      def delete(id)
+        new(id: id).delete
+      end
+
+      def list
+        new.list
+      end
+
+      def update(id, **attrs)
+        new(id: id).update(**attrs)
+      end
+
+      def search(**params)
+        new.search(**params)
+      end
+    end
+
     private
 
     def compact(hash)

data/lib/misp/feed.rb

@@ -2,56 +2,83 @@
 
 module MISP
   class Feed < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_reader :name
+    # @return [String]
     attr_reader :provider
+    # @return [String]
     attr_reader :url
+    # @return [String]
     attr_reader :rules
+    # @return [Boolean]
     attr_reader :enabled
+    # @return [String]
     attr_reader :distribution
+    # @return [String]
     attr_reader :sharing_group_id
+    # @return [String]
     attr_reader :tag_id
+    # @return [String]
     attr_reader :default
+    # @return [String]
     attr_reader :source_format
+    # @return [Boolean]
     attr_reader :fixed_event
+    # @return [Boolean]
     attr_reader :delta_merge
+    # @return [String]
     attr_reader :event_id
+    # @return [String]
     attr_reader :publish
+    # @return [String]
     attr_reader :override_ids
+    # @return [String]
     attr_reader :settings
+    # @return [String]
     attr_reader :input_source
+    # @return [Boolean]
     attr_reader :delete_local_file
+    # @return [Boolean]
     attr_reader :lookup_visible
+    # @return [String]
     attr_reader :headers
+    # @return [Boolean]
     attr_reader :caching_enabled
 
     def initialize(**attributes)
-      attributes = normalize_attributes(attributes)
+      attributes = normalize_attributes(**attributes)
 
-      @id = attributes.dig(:id)
-      @name = attributes.dig(:name) || "feed name"
-      @provider = attributes.dig(:provider) || "my provider"
-      @url = attributes.dig(:url) || "http://example.com"
-      @rules = attributes.dig(:rules) || ""
-      @enabled = attributes.dig(:enabled)
-      @distribution = attributes.dig(:distribution)
-      @sharing_group_id = attributes.dig(:sharing_group_id)
-      @tag_id = attributes.dig(:tag_id) || "0"
-      @default = attributes.dig(:default) || true
-      @source_format = attributes.dig(:source_format) || "misp"
-      @fixed_event = attributes.dig(:fixed_event) || true
-      @delta_merge = attributes.dig(:delta_merge) || false
-      @event_id = attributes.dig(:event_id) || "0"
-      @publish = attributes.dig(:publish) || true
-      @override_ids = attributes.dig(:override_ids) || false
-      @settings = attributes.dig(:settings) || ""
-      @input_source = attributes.dig(:input_source) || "network"
-      @delete_local_file = attributes.dig(:delete_local_file) || false
-      @lookup_visible = attributes.dig(:lookup_visible) || true
-      @headers = attributes.dig(:headers) || ""
-      @caching_enabled = attributes.dig(:caching_enabled) || true
+      @id = attributes[:id]
+      @name = attributes[:name] || "feed name"
+      @provider = attributes[:provider] || "my provider"
+      @url = attributes[:url] || "http://example.com"
+      @rules = attributes[:rules] || ""
+      @enabled = attributes[:enabled]
+      @distribution = attributes[:distribution]
+      @sharing_group_id = attributes[:sharing_group_id]
+      @tag_id = attributes[:tag_id] || "0"
+      @default = attributes[:default] || true
+      @source_format = attributes[:source_format] || "misp"
+      @fixed_event = attributes[:fixed_event] || true
+      @delta_merge = attributes[:delta_merge] || false
+      @event_id = attributes[:event_id] || "0"
+      @publish = attributes[:publish] || true
+      @override_ids = attributes[:override_ids] || false
+      @settings = attributes[:settings] || ""
+      @input_source = attributes[:input_source] || "network"
+      @delete_local_file = attributes[:delete_local_file] || false
+      @lookup_visible = attributes[:lookup_visible] || true
+      @headers = attributes[:headers] || ""
+      @caching_enabled = attributes[:caching_enabled] || true
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         id: id,
@@ -79,32 +106,51 @@ module MISP
       }.compact
     end
 
+    #
+    # List feeds
+    #
+    # @return [Array<MISP::Feed>]
+    #
     def list
       _get("/feeds/index") do |feeds|
         feeds.map do |feed|
-          Feed.new symbolize_keys(feed)
+          Feed.new(**feed)
         end
       end
     end
 
-    def self.list
-      new.list
-    end
-
+    #
+    # Create a feed
+    #
+    # @return [MISP::Feed]
+    #
     def get
-      _get("/feeds/view/#{id}") { |feed| Feed.new symbolize_keys(feed) }
-    end
-
-    def self.get(id)
-      new(id: id).get
+      _get("/feeds/view/#{id}") { |feed| Feed.new feed }
     end
 
+    #
+    # Create a feed
+    #
+    # @param [Hash] **attributes attributes
+    #
+    # @return [MIPS::Feed]
+    #
     def create(**attributes)
-      _post("/feeds/add", wrap(attributes)) { |feed| Feed.new symbolize_keys(feed) }
+      _post("/feeds/add", wrap(attributes)) { |feed| Feed.new feed }
     end
 
-    def self.create(attributes)
-      new.create attributes
+    class << self
+      def list
+        new.list
+      end
+
+      def get(id)
+        new(id: id).get
+      end
+
+      def create(**attributes)
+        new.create attributes
+      end
     end
   end
 end

data/lib/misp/galaxy.rb

@@ -2,28 +2,40 @@
 
 module MISP
   class Galaxy < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_reader :uuid
+    # @return [String]
     attr_reader :name
+    # @return [String]
     attr_reader :type
+    # @return [String]
     attr_reader :description
+    # @return [String]
     attr_reader :version
 
+    # @return [Array<MISP::GalaxyCluster>]
     attr_reader :galaxy_clusters
 
     def initialize(**attributes)
-      attributes = normalize_attributes(attributes)
+      attributes = normalize_attributes(**attributes)
 
-      @id = attributes.dig(:id)
-      @uuid = attributes.dig(:uuid)
-      @name = attributes.dig(:name)
-      @type = attributes.dig(:type)
-      @description = attributes.dig(:description)
-      @version = attributes.dig(:version)
+      @id = attributes[:id]
+      @uuid = attributes[:uuid]
+      @name = attributes[:name]
+      @type = attributes[:type]
+      @description = attributes[:description]
+      @version = attributes[:version]
 
-      @galaxy_clusters = build_plural_attribute(items: attributes.dig(:GalaxyCluster), klass: GalaxyCluster)
+      @galaxy_clusters = build_plural_attribute(items: attributes[:GalaxyCluster], klass: GalaxyCluster)
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         id: id,
@@ -36,24 +48,36 @@ module MISP
       }.compact
     end
 
+    #
+    # List galaxies
+    #
+    # @return [Array<Galaxy>]
+    #
     def list
       _get("/galaxies/") do |galaxies|
         galaxies.map do |galaxy|
-          Galaxy.new symbolize_keys(galaxy)
+          Galaxy.new(**galaxy)
         end
       end
     end
 
-    def self.list
-      new.list
-    end
-
+    #
+    # Get a galaxy
+    #
+    # @return [MISP::Galaxy]
+    #
     def get
-      _get("/galaxies/view/#{id}") { |galaxy| Galaxy.new symbolize_keys(galaxy) }
+      _get("/galaxies/view/#{id}") { |galaxy| Galaxy.new(**galaxy) }
     end
 
-    def self.get(id)
-      new(id: id).get
+    class << self
+      def list
+        new.list
+      end
+
+      def get(id)
+        new(id: id).get
+      end
     end
   end
 end

data/lib/misp/galaxy_cluster.rb

@@ -2,34 +2,50 @@
 
 module MISP
   class GalaxyCluster < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_reader :uuid
+    # @return [String]
     attr_reader :type
+    # @return [String]
     attr_reader :value
+    # @return [String]
     attr_reader :tag_name
+    # @return [String]
     attr_reader :description
+    # @return [String]
     attr_reader :galaxy_id
+    # @return [String]
     attr_reader :source
+    # @return [Array<String>]
     attr_reader :authors
+    # @return [String]
     attr_reader :tag_id
+    # @return [Hash]
     attr_reader :meta
 
     def initialize(**attributes)
-      attributes = normalize_attributes(attributes)
+      attributes = normalize_attributes(**attributes)
 
-      @id = attributes.dig(:id)
-      @uuid = attributes.dig(:uuid)
-      @type = attributes.dig(:type)
-      @value = attributes.dig(:value)
-      @tag_name = attributes.dig(:tag_name)
-      @description = attributes.dig(:description)
-      @galaxy_id = attributes.dig(:galaxy_id)
-      @source = attributes.dig(:source)
-      @authors = attributes.dig(:authors)
-      @tag_id = attributes.dig(:tag_id)
-      @meta = attributes.dig(:meta)
+      @id = attributes[:id]
+      @uuid = attributes[:uuid]
+      @type = attributes[:type]
+      @value = attributes[:value]
+      @tag_name = attributes[:tag_name]
+      @description = attributes[:description]
+      @galaxy_id = attributes[:galaxy_id]
+      @source = attributes[:source]
+      @authors = attributes[:authors]
+      @tag_id = attributes[:tag_id]
+      @meta = attributes[:meta]
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         id: id,

data/lib/misp/org.rb

@@ -2,18 +2,26 @@
 
 module MISP
   class Org < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_reader :name
+    # @return [String]
     attr_reader :uuid
 
     def initialize(**attributes)
-      attributes = normalize_attributes(attributes)
+      attributes = normalize_attributes(**attributes)
 
-      @id = attributes.dig(:id)
-      @name = attributes.dig(:name)
-      @uuid = attributes.dig(:uuid)
+      @id = attributes[:id]
+      @name = attributes[:name]
+      @uuid = attributes[:uuid]
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         id: id,

data/lib/misp/orgc.rb

@@ -2,18 +2,26 @@
 
 module MISP
   class Orgc < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_reader :name
+    # @return [String]
     attr_reader :uuid
 
     def initialize(**attributes)
-      attributes = normalize_attributes(attributes)
+      attributes = normalize_attributes(**attributes)
 
-      @id = attributes.dig(:id)
-      @name = attributes.dig(:name)
-      @uuid = attributes.dig(:uuid)
+      @id = attributes[:id]
+      @name = attributes[:name]
+      @uuid = attributes[:uuid]
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         id: id,