misp 0.1.0 → 0.1.4

data/lib/misp/server.rb

@@ -2,18 +2,26 @@
 
 module MISP
   class Server < Base
+    # @return [String]
     attr_reader :id
+    # @return [String]
     attr_reader :url
+    # @return [String]
     attr_reader :name
 
     def initialize(**attributes)
-      attributes = normalize_attributes(attributes)
+      attributes = normalize_attributes(**attributes)
 
-      @id = attributes.dig(:id)
-      @url = attributes.dig(:url)
-      @name = attributes.dig(:name)
+      @id = attributes[:id]
+      @url = attributes[:url]
+      @name = attributes[: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,44 +1,70 @@
 # 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)
+      attributes = normalize_attributes(**attributes)
 
-      @id = attributes.dig(:id)
-      @name = attributes.dig(:name) || "default name"
-      @releasability = attributes.dig(:releasability) || "default sharability"
-      @description = attributes.dig(:description)
-      @uuid = attributes.dig(:uuid)
-      @organisation_uuid = attributes.dig(:organisation_uuid)
-      @org_id = attributes.dig(:org_id)
-      @sync_user_id = attributes.dig(:sync_user_id)
-      @active = attributes.dig(:active)
-      @created = attributes.dig(:created)
-      @modified = attributes.dig(:modified)
-      @local = attributes.dig(:local)
-      @roaming = attributes.dig(:roaming)
+      @id = attributes[:id]
+      @name = attributes[:name] || "default name"
+      @releasability = attributes[:releasability] || "default sharability"
+      @description = attributes[:description]
+      @uuid = attributes[:uuid]
+      @organisation_uuid = attributes[:organisation_uuid]
+      @org_id = attributes[:org_id]
+      @sync_user_id = attributes[:sync_user_id]
+      @active = attributes[:active]
+      @created = attributes[:created]
+      @modified = attributes[:modified]
+      @local = attributes[:local]
+      @roaming = attributes[:roaming]
 
-      @_organisation = attributes.dig(:Organisation)
+      @organisation = build_attribute(item: attributes[: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)
+      @sharing_group_orgs = build_plural_attribute(items: attributes[:SharingGroupOrg], klass: SharingGroupOrg)
+      @sharing_group_servers = build_plural_attribute(items: attributes[: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[: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,25 +1,35 @@
 # 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)
-      attributes = normalize_attributes(attributes)
+      attributes = normalize_attributes(**attributes)
 
-      @id = attributes.dig(:id)
-      @sharing_group_id = attributes.dig(:sharing_group_id)
-      @org_id = attributes.dig(:org_id)
-      @extend = attributes.dig(:extend)
+      @id = attributes[:id]
+      @sharing_group_id = attributes[:sharing_group_id]
+      @org_id = attributes[:org_id]
+      @extend = attributes[:extend]
 
-      @organization = build_attribute(item: attributes.dig(:Organization), klass: Org)
+      @organization = build_attribute(item: attributes[: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,25 +1,35 @@
 # 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)
-      attributes = normalize_attributes(attributes)
+      attributes = normalize_attributes(**attributes)
 
-      @id = attributes.dig(:id)
-      @sharing_group_id = attributes.dig(:sharing_group_id)
-      @server_id = attributes.dig(:server_id)
-      @all_orgs = attributes.dig(:all_orgs)
+      @id = attributes[:id]
+      @sharing_group_id = attributes[:sharing_group_id]
+      @server_id = attributes[:server_id]
+      @all_orgs = attributes[:all_orgs]
 
-      @servers = build_plural_attribute(items: attributes.dig(:Server), klass: Server)
+      @servers = build_plural_attribute(items: attributes[: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,22 +2,32 @@
 
 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)
-      attributes = normalize_attributes(attributes)
+      attributes = normalize_attributes(**attributes)
 
-      @id = attributes.dig(:id)
-      @name = attributes.dig(:name)
-      @colour = attributes.dig(:colour)
-      @exportable = attributes.dig(:exportable)
-      @hide_tag = attributes.dig(:hide_tag)
+      @id = attributes[:id]
+      @name = attributes[:name]
+      @colour = attributes[:colour]
+      @exportable = attributes[:exportable]
+      @hide_tag = attributes[: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.4"
 end

data/misp.gemspec

@@ -24,10 +24,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  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 "rspec", "~> 3.8"
-  spec.add_development_dependency "vcr", "~> 5.0"
-  spec.add_development_dependency "webmock", "~> 3.6"
+  spec.add_development_dependency "bundler", "~> 2.3"
+  spec.add_development_dependency "coveralls_reborn", "~> 0.23"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.14"
 end

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: misp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Manabu Niseki
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-22 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,84 +16,84 @@ 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.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.14'
 description: A dead simple MISP API wrapper for Ruby
 email:
 - manabu.niseki@gmail.com
@@ -101,9 +101,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yaml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -125,11 +125,12 @@ files:
 - lib/misp/tag.rb
 - lib/misp/version.rb
 - misp.gemspec
+- renovate.json
 homepage: https://github.com/ninoseki/misp-rb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,8 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.14
+signing_key:
 specification_version: 4
 summary: A dead simple MISP API wrapper for Ruby
 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.2