misp 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db847f1e32b2e0a1064180b310b087ade5c9d608282bcbeebc5403f02b0cb71d
-  data.tar.gz: e1090389330d2de0bfd8b0c58cd0768f1a9bc58bb220d80c9d74aea6cb9ec738
+  metadata.gz: 3be99f0060b369edec33cbfd1f8451ecfdd1d3c4942091087473abdc96579fc8
+  data.tar.gz: eb6d2f9fe09fd030f6cf0f4e9f73e4b19d650809c3f0121c29b9de2b421fb97c
 SHA512:
-  metadata.gz: a4b3e71c139193309e919b6dc344f4fb200521b07a90fd3e45384d272549632af96eec9852416fdc8ddbfda31c9675f5ab107ae4cb1b2ff61b98dbeba0979457
-  data.tar.gz: 16b98a9dae45d273b70600565f8130d43d592e4097b517f49a69177c367a8c88a5841e4eb238a9629f9a45d1ca12ce7addfb5118c27f52d45a9c4a0ae3e56f61
+  metadata.gz: b0659e4345163616f8ad38fd43a391ab3f9921c0cf4d5e926ac74bda7b13762cbaca7f5518041e67795b9518c63a81945f503e54e25d4c8e37e14801e41a3335
+  data.tar.gz: 2e85ada078b9b82eb9221cec0d0b012d731c0dd082b147306f7c0b69a473aa583ac98153c882ba51e6a072fce26d348f607a1178515cca38395624d5db59d7e3

data/README.md

@@ -1,5 +1,6 @@
 # misp-rb
 
+[![Gem Version](https://badge.fury.io/rb/misp.svg)](https://badge.fury.io/rb/misp)
 [![Build Status](https://travis-ci.com/ninoseki/misp-rb.svg?branch=master)](https://travis-ci.com/ninoseki/misp-rb)
 [![Coverage Status](https://coveralls.io/repos/github/ninoseki/misp-rb/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/misp-rb?branch=master)
 [![CodeFactor](https://www.codefactor.io/repository/github/ninoseki/misp-rb/badge)](https://www.codefactor.io/repository/github/ninoseki/misp-rb)
@@ -20,8 +21,8 @@ gem install misp
 
 By default, it tries to load configurations from environmental variables:
 
-- MISP API endpoint from ENV["MISP_API_ENDPOINT"]
-- MISP API key from ENV["MISP_API_KEY"]
+- `MISP_API_ENDPOINT`: MISP API endpoint (e.g. https://misppriv.circl.lu)
+- `MISP_API_KEY`: MISP API key
 
 Also, you can configure them manually.
 
@@ -60,7 +61,7 @@ event.update
 event = MISP::Event.get(17)
 event.add_attribute(value: "8.8.8.8", type: "ip-dst")
 # or
-attribute = MISP::Attribute(value: "1.1.1.1", type: "ip-dst")
+attribute = MISP::Attribute.new(value: "1.1.1.1", type: "ip-dst")
 event.add_attribute attribute
 event.update
 ```
@@ -109,6 +110,14 @@ event.tags << MISP::Tag.new(name: "my event-level tag")
 event.create
 ```
 
+### Search for events / attributes
+
+```ruby
+events = MISP::Event.search(info: "test")
+
+attributes = MISP::Attribute.search(type: "ip-dst")
+```
+
 ## Acknowledgement
 
 The implementation design of this gem is highly influenced by [FloatingGhost/mispex](https://github.com/FloatingGhost/mispex).

data/lib/misp/attribute.rb

@@ -2,23 +2,40 @@
 
 module MISP
   class Attribute < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_accessor :type
+    # @return [String]
     attr_accessor :category
+    # @return [Boolean]
     attr_accessor :to_ids
+    # @return [String]
     attr_reader :uuid
+    # @return [String]
     attr_reader :event_id
+    # @return [String]
     attr_accessor :distribution
+    # @return [String]
     attr_accessor :timestamp
+    # @return [String]
     attr_accessor :comment
+    # @return [String]
     attr_accessor :sharing_group_id
+    # @return [Boolean]
     attr_accessor :deleted
+    # @return [Boolean]
     attr_accessor :disable_correlation
+    # @return [String]
     attr_accessor :value
+    # @return [String]
     attr_accessor :data
 
+    # @return [Array<MISP::SharingGroup>]
     attr_accessor :sharing_groups
+    # @return [Array<MISP::Attribute>]
     attr_accessor :shadow_attributes
+    # @return [Array<MISP::Tag>]
     attr_accessor :tags
 
     def initialize(**attributes)
@@ -44,6 +61,11 @@ module MISP
       @tags = build_plural_attribute(items: attributes.dig(:Tag), klass: Tag)
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         id: id,
@@ -66,36 +88,53 @@ module MISP
       }.compact
     end
 
+    #
+    # Get an attribute
+    #
+    # @return [MISP::Attribute]
+    #
     def get
-      _get("/attributes/#{id}") { |attribute| Attribute.new symbolize_keys(attribute) }
-    end
-
-    def self.get(id)
-      new(id: id).get
+      _get("/attributes/#{id}") { |attribute| Attribute.new attribute }
     end
 
+    #
+    # Delete an attribute
+    #
+    # @return [Hash]
+    #
     def delete
       _post("/attributes/delete/#{id}") { |json| json }
     end
 
-    def self.delete(id)
-      new(id: id).delete
-    end
-
+    #
+    # Create an attribute
+    #
+    # @return [MISP::Attribute]
+    #
     def create(event_id)
-      _post("/attributes/add/#{event_id}", wrap(to_h)) { |attribute| Attribute.new symbolize_keys(attribute) }
-    end
-
-    def self.create(event_id, **attributes)
-      new(attributes).create(event_id)
+      _post("/attributes/add/#{event_id}", wrap(to_h)) { |attribute| Attribute.new attribute }
     end
 
+    #
+    # Update an attribute
+    #
+    # @param [Hash] **attrs attributes
+    #
+    # @return [MISP::Attribute]
+    #
     def update(**attrs)
       payload = to_h.merge(attrs)
       payload[:timestamp] = nil
-      _post("/attributes/edit/#{id}", wrap(payload)) { |json| Attribute.new symbolize_keys(json.dig("response", "Attribute")) }
+      _post("/attributes/edit/#{id}", wrap(payload)) { |json| Attribute.new json.dig(:response, :Attribute) }
     end
 
+    #
+    # Search for attributes
+    #
+    # @param [Hash] **params parameters
+    #
+    # @return [Array<MISP::Attributes>]
+    #
     def search(**params)
       base = {
         returnFormat: "json",
@@ -104,25 +143,53 @@ module MISP
       }
 
       _post("/attributes/restSearch", base.merge(params)) do |json|
-        attributes = json.dig("response", "Attribute") || []
-        attributes.map { |attribute| Attribute.new symbolize_keys(attribute) }
+        attributes = json.dig(:response, :Attribute) || []
+        attributes.map { |attribute| Attribute.new attribute }
       end
     end
 
-    def self.search(**params)
-      new.search params
-    end
-
+    #
+    # Add a tag to an attribute
+    #
+    # @param [MISP::Tag, Hash] tag
+    #
+    # @return [MISP::Tag]
+    #
     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)
       payload = { uuid: uuid, tag: tag.name }
-      _post("/tags/attachTagToObject", payload) { |json| Tag.new symbolize_keys(json) }
+      _post("/tags/attachTagToObject", payload) { |json| Tag.new json }
     end
 
+    #
+    # Remove a tag from an attribute
+    #
+    # @param [MISP::Tag, Hash] tag
+    #
+    # @return [Hash]
+    #
     def remove_tag(tag)
-      tag = Tag.new(symbolize_keys(tag)) unless tag.is_a?(MISP::Tag)
+      tag = Tag.new(tag) unless tag.is_a?(MISP::Tag)
       payload = { uuid: uuid, tag: tag.name }
       _post("/tags/removeTagFromObject", payload) { |json| json }
     end
+
+    class << self
+      def get(id)
+        new(id: id).get
+      end
+
+      def delete(id)
+        new(id: id).delete
+      end
+
+      def create(event_id, **attributes)
+        new(attributes).create(event_id)
+      end
+
+      def search(**params)
+        new.search params
+      end
+    end
   end
 end

data/lib/misp/base.rb

@@ -6,32 +6,59 @@ require "uri"
 
 module MISP
   class Base
+    private
+
+    #
+    # API endpoint
+    #
+    # @return [URI]
+    #
     def api_endpoint
       @api_endpoint ||= URI(MISP.configuration.api_endpoint)
     end
 
+    #
+    # API key
+    #
+    # @return [String]
+    #
     def api_key
       @api_key ||= MISP.configuration.api_key
     end
 
-    private
-
+    #
+    # Build an instance of a class
+    #
+    # @param [Hash] item
+    # @param [Class] klass
+    #
+    # @return [Class]
+    #
     def build_attribute(item:, klass:)
       return nil unless item
 
-      klass.new symbolize_keys(item)
+      klass.new item
     end
 
+    #
+    # Build an array of an instance of a class
+    #
+    # @param [Array<Hash>] items
+    # @param [Class] klass
+    #
+    # @return [Arra<Class>]
+    #
     def build_plural_attribute(items:, klass:)
       (items || []).map do |item|
-        klass.new symbolize_keys(item)
+        klass.new item
       end
     end
 
-    def symbolize_keys(hash)
-      hash.map { |k, v| [k.to_sym, v] }.to_h
-    end
-
+    #
+    # a name of the class
+    #
+    # @return [String]
+    #
     def class_name
       self.class.to_s.split("::").last.to_s
     end
@@ -39,7 +66,7 @@ module MISP
     def normalize_attributes(attributes)
       klass = class_name.to_sym
 
-      attributes.key?(klass) ? symbolize_keys(attributes.dig(klass)) : attributes
+      attributes.key?(klass) ? attributes.dig(klass) : attributes
     end
 
     def wrap(params)
@@ -99,7 +126,7 @@ module MISP
     end
 
     def parse_body(body)
-      JSON.parse body.to_s
+      JSON.parse body.to_s, symbolize_names: true
     rescue JSON::ParserError => _e
       body.to_s
     end

data/lib/misp/configuration.rb

@@ -14,15 +14,15 @@ module MISP
     end
   end
 
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
 
-  def self.configuration=(config)
-    @configuration = config
-  end
+    attr_writer :configuration
 
-  def self.configure
-    yield configuration
+    def configure
+      yield configuration
+    end
   end
 end

data/lib/misp/event.rb

@@ -2,33 +2,59 @@
 
 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)
@@ -64,6 +90,11 @@ module MISP
       @tags = build_plural_attribute(items: attrs.dig(: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[: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.dig(: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,27 +2,49 @@
 
 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)
@@ -52,6 +74,11 @@ module MISP
       @caching_enabled = attributes.dig(: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,13 +2,20 @@
 
 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)
@@ -24,6 +31,11 @@ module MISP
       @galaxy_clusters = build_plural_attribute(items: attributes.dig(: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,16 +2,27 @@
 
 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)
@@ -30,6 +41,11 @@ module MISP
       @meta = attributes.dig(:meta)
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         id: id,

data/lib/misp/org.rb

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

data/lib/misp/orgc.rb

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

data/lib/misp/server.rb

@@ -2,8 +2,11 @@
 
 module MISP
   class Server < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_reader :url
+    # @return [String]
     attr_reader :name
 
     def initialize(**attributes)
@@ -14,6 +17,11 @@ module MISP
       @name = attributes.dig(:name)
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         id: id,
@@ -22,16 +30,23 @@ module MISP
       }.compact
     end
 
+    #
+    # List servers
+    #
+    # @return [Array<MISP::Server>]
+    #
     def list
       _get("/servers/") do |servers|
         servers.map do |server|
-          Server.new symbolize_keys(server)
+          Server.new server
         end
       end
     end
 
-    def self.list
-      new.list
+    class << self
+      def list
+        new.list
+      end
     end
   end
 end

data/lib/misp/sharing_group.rb

@@ -1,21 +1,42 @@
 # frozen_string_literal: true
 
 module MISP
-  class SharingGroup < Server
+  class SharingGroup < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_reader :name
+    # @return [String]
     attr_reader :releasability
+    # @return [String]
     attr_reader :description
+    # @return [String]
     attr_reader :uuid
+    # @return [String]
     attr_reader :organisation_uuid
+    # @return [String]
     attr_reader :org_id
+    # @return [String]
     attr_reader :sync_user_id
+    # @return [Boolean]
     attr_reader :active
+    # @return [String]
     attr_reader :created
+    # @return [String]
     attr_reader :modified
+    # @return [Boolean]
     attr_reader :local
+    # @return [Boolean]
     attr_reader :roaming
 
+    # @return [MISP::Org, nil]
+    attr_reader :organization
+
+    # @return [Array<MISP::SharingGroupOrg>]
+    attr_reader :sharing_group_orgs
+    # @return [Array<MISP::SharingGroupServer>]
+    attr_reader :sharing_group_servers
+
     def initialize(**attributes)
       attributes = normalize_attributes(attributes)
 
@@ -33,12 +54,17 @@ module MISP
       @local = attributes.dig(:local)
       @roaming = attributes.dig(:roaming)
 
-      @_organisation = attributes.dig(:Organisation)
+      @organisation = build_attribute(item: attributes.dig(:Organization), klass: Org)
 
       @sharing_group_orgs = build_plural_attribute(items: attributes.dig(:SharingGroupOrg), klass: SharingGroupOrg)
       @sharing_group_servers = build_plural_attribute(items: attributes.dig(:SharingGroupServer), klass: SharingGroupServer)
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         id: id,
@@ -60,25 +86,39 @@ module MISP
       }.compact
     end
 
+    #
+    # List sharing groups
+    #
+    # @return [Array<MISP::SharingGroup>]
+    #
     def list
       _get("/sharing_groups/") do |res|
-        sharing_groups = res.dig("response") || []
+        sharing_groups = res.dig(:response) || []
         sharing_groups.map do |sharing_group|
-          SharingGroup.new symbolize_keys(sharing_group)
+          SharingGroup.new sharing_group
         end
       end
     end
 
-    def self.list
-      new.list
-    end
-
+    #
+    # Create a sharing group
+    #
+    # @param [Hash] **attributes attributes
+    #
+    # @return [MISP::SharingGroup]
+    #
     def create(**attributes)
-      _post("/sharing_groups/add", wrap(attributes)) { |sharing_group| SharingGroup.new symbolize_keys(sharing_group) }
+      _post("/sharing_groups/add", wrap(attributes)) { |sharing_group| SharingGroup.new sharing_group }
     end
 
-    def self.create(attributes)
-      new.create attributes
+    class << self
+      def list
+        new.list
+      end
+
+      def create(**attributes)
+        new.create attributes
+      end
     end
   end
 end

data/lib/misp/sharing_group_org.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
 module MISP
-  class SharingGroupOrg < Server
+  class SharingGroupOrg < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_reader :sharing_group_id
+    # @return [String]
     attr_reader :org_id
+    # @return [String]
     attr_reader :extend
 
+    # @return [MISP::Organization, nil]
     attr_reader :organization
 
     def initialize(**attributes)
@@ -20,6 +25,11 @@ module MISP
       @organization = build_attribute(item: attributes.dig(:Organization), klass: Org)
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         erver: erver,

data/lib/misp/sharing_group_server.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
 module MISP
-  class SharingGroupServer < Server
+  class SharingGroupServer < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_reader :sharing_group_id
+    # @return [String]
     attr_reader :server_id
+    # @return [Boolean]
     attr_reader :all_orgs
 
+    # @return [Array<MISP::Server>]
     attr_reader :servers
 
     def initialize(**attributes)
@@ -20,6 +25,11 @@ module MISP
       @servers = build_plural_attribute(items: attributes.dig(:Server), klass: Server)
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         id: id,

data/lib/misp/tag.rb

@@ -2,10 +2,15 @@
 
 module MISP
   class Tag < Base
+    # @return [String]
     attr_accessor :id
+    # @return [String]
     attr_accessor :name
+    # @return [String]
     attr_accessor :colour
+    # @return [Boolean]
     attr_accessor :exportable
+    # @return [Boolean]
     attr_accessor :hide_tag
 
     def initialize(**attributes)
@@ -18,6 +23,11 @@ module MISP
       @hide_tag = attributes.dig(:hide_tag)
     end
 
+    #
+    # Returns a hash representation of the attribute data.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         id: id,
@@ -28,42 +38,75 @@ module MISP
       }.compact
     end
 
-    def get(id)
-      _get("/tags/view/#{id}") { |json| Tag.new symbolize_keys(json) }
+    #
+    # Get a tag
+    #
+    # @return [MISP::Tag]
+    #
+    def get
+      _get("/tags/view/#{id}") { |json| Tag.new json }
     end
 
-    def self.get(id)
-      new.get id
-    end
-
-    def create(attributes)
-      _post("/tags/add", wrap(attributes)) { |json| Tag.new symbolize_keys(json) }
-    end
-
-    def self.create(attributes)
-      new.create attributes
+    #
+    # Create a tag
+    #
+    # @param [Hash] **attributes attributes
+    #
+    # @return [MISP::Tag]
+    #
+    def create(**attributes)
+      _post("/tags/add", wrap(attributes)) { |json| Tag.new json }
     end
 
+    #
+    # Delete a tag
+    #
+    # @return [Hash]
+    #
     def delete
       _post("/tags/delete/#{id}") { |json| json }
     end
 
-    def self.delete(id)
-      Tag.new(id: id).delete
-    end
-
+    #
+    # Update a tag
+    #
+    # @param [Hash] **attributes attributes
+    #
+    # @return [MISP::Tag]
+    #
     def update(**attributes)
       payload = to_h.merge(attributes)
-      _post("/tags/edit/#{id}", wrap(payload)) { |json| Tag.new symbolize_keys(json) }
-    end
-
-    def self.update(id, **attributes)
-      Tag.new(id: id).update attributes
+      _post("/tags/edit/#{id}", wrap(payload)) { |json| Tag.new json }
     end
 
+    #
+    # Search for tags
+    #
+    # @param [Hash] **params parameters
+    #
+    # @return [MISP::Tag]
+    #
     def search(**params)
       _post("/tags/search", params) do |tags|
-        tags.map { |tag| Tag.new symbolize_keys(tag) }
+        tags.map { |tag| Tag.new tag }
+      end
+    end
+
+    class << self
+      def get(id)
+        new(id: id).get
+      end
+
+      def create(**attributes)
+        new.create attributes
+      end
+
+      def delete(id)
+        Tag.new(id: id).delete
+      end
+
+      def update(id, **attributes)
+        Tag.new(id: id).update attributes
       end
     end
   end

data/lib/misp/version.rb

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

data/misp.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "coveralls", "~> 0.8"
-  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.8"
   spec.add_development_dependency "vcr", "~> 5.0"
-  spec.add_development_dependency "webmock", "~> 3.6"
+  spec.add_development_dependency "webmock", "~> 3.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: misp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Manabu Niseki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-22 00:00:00.000000000 Z
+date: 2019-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
 description: A dead simple MISP API wrapper for Ruby
 email:
 - manabu.niseki@gmail.com