openvas 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb71da56ded8ee0e5088b370c2e91e678b08f9b5
-  data.tar.gz: e2e8f389b26fd9ec3bb338a4cde7145afc604d0e
+  metadata.gz: 6094b62731b5348bd12957817944e7cefa4f1374
+  data.tar.gz: e3f959afb305df9725ea3dada3dd123e4831dcf3
 SHA512:
-  metadata.gz: e735cf653b828edbfdbb41627bf93b9a31d78b5c15949d7d048cbeb936063aee4ad77b7ff4e777dbe7e3f9462d0ded58a82eb7038c5b76a5b55b01d87df83e13
-  data.tar.gz: 72cf0814aaca8fed228ce66a9a27460b312d4c8e8e0aec7dc364f1c8de393cc5481440fac3bc4e57ff5147a8bcac8e2aa3d2f860d217e9f48094b769b490c91e
+  metadata.gz: 94c12bb0387ca5ed328b63ec98a006264ccdee4c999b7d53314d4f07071f11d02d2f4795ab755183454ef7635f877011f3d6a472e0667c0a4eeb5ae413addfcf
+  data.tar.gz: 1268415590f0b935765e500605458b3bd878f18c851e6db4ca37d47119309585a0377dea851c9f7191f8bc9dc42c8971d8dd15aa07c95982c49e6f3ecde1fa62

data/.rubocop.yml

@@ -6,8 +6,12 @@ AllCops:
 Metrics/LineLength:
   Max: 120
 
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
 Metrics/MethodLength:
   Max: 30
 
 Metrics/AbcSize:
-  Max: 30
+  Max: 30

data/.rubocop_todo.yml

@@ -21,8 +21,6 @@ Style/Documentation:
     - 'lib/openvas/client.rb'
     - 'lib/openvas/config.rb'
     - 'lib/openvas/reports.rb'
-    - 'lib/openvas/results.rb'
-    - 'lib/openvas/scans.rb'
 
 # Offense count: 2
 # Cop supports --auto-correct.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openvas (0.2.0)
+    openvas (0.3.0)
       nokogiri (~> 1.8)
 
 GEM

data/README.md

@@ -46,7 +46,7 @@ Openvas::Auth.login
 - Retrive all scans and list the results
 
 ```ruby
-Openvas::Scans.all.each do |scan|
+Openvas::Scan.all.each do |scan|
   puts 'Scan Name : ' + scan.name
   puts '-'*40
   scan.last_results.each do |result|

data/lib/openvas/reports.rb

@@ -31,7 +31,7 @@ module Openvas
     end
 
     def results
-      Openvas::Results.find_by_report_id(@id)
+      Openvas::Result.find_by_report_id(@id)
     end
   end
 end

data/lib/openvas/result.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Openvas
+  # Class used to interact with OpenVAS' scans results
+  class Result
+    attr_accessor :id, :name, :comment, :description, :host, :user, :port, :severity, :created_at, :updated_at
+
+    def initialize(result)
+      @id = result.at_xpath('@id').value
+      @name = result.at_xpath('name').text
+      @comment = result.at_xpath('comment').text
+      @user = result.at_xpath('owner/name').text
+      @host = result.at_xpath('host').text
+      @port = result.at_xpath('port').text
+      @severity = result.at_xpath('severity').text
+      @description = result.at_xpath('description').text
+
+      @created_at = Time.parse(result.at_xpath('creation_time').text)
+      @updated_at = Time.parse(result.at_xpath('modification_time').text)
+    end
+
+    def results
+      Openvas::Result.find_by_report_id(@id)
+    end
+
+    class << self
+      MAX_RESULTS = 1000
+
+      def all
+        # TODO: implement pagination
+        query = Nokogiri::XML::Builder.new { get_results(filter: "first=1 rows=#{MAX_RESULTS}") }
+
+        query(query).xpath('//get_results_response/result').map do |result|
+          new(result)
+        end
+      end
+
+      def find_by_id(id)
+        query = Nokogiri::XML::Builder.new { get_results(result_id: id) }
+        new(query(query).at_xpath('//get_results_response/result'))
+      end
+
+      def find_by_report_id(id)
+        # TODO: implement pagination
+        query = Nokogiri::XML::Builder.new { get_results(filter: "report_id=#{id} first=1 rows=#{MAX_RESULTS}") }
+
+        query(query).xpath('//get_results_response/result').map do |result|
+          new(result)
+        end
+      end
+    end
+  end
+end

data/lib/openvas/{scans.rb → scan.rb}

@@ -3,21 +3,8 @@
 require 'time'
 
 module Openvas
-  class Scans < Client
-    def self.all
-      query = Nokogiri::XML::Builder.new { get_tasks }
-      query(query).xpath('//get_tasks_response/task').map do |scan|
-        Openvas::Scan.new(scan)
-      end
-    end
-
-    def self.find_by_id(id)
-      query = Nokogiri::XML::Builder.new { get_tasks(task_id: id) }
-      Openvas::Scan.new(query(query).at_xpath('//get_tasks_response/task'))
-    end
-  end
-
-  class Scan
+  # Class used to interact with OpenVAS' scans
+  class Scan < Client
     attr_accessor :id, :name, :comment, :status, :target, :user, :created_at, :updated_at
 
     def initialize(scan)
@@ -40,13 +27,26 @@ module Openvas
     end
 
     def last_results
-      Openvas::Results.find_by_report_id(@last_report_id)
+      Openvas::Result.find_by_report_id(@last_report_id)
     end
 
     def finished?
-      return true if @status.eql? 'Done'
+      @status == 'Done'
+    end
+
+    class << self
+      def all
+        data = Nokogiri::XML::Builder.new { get_tasks }
 
-      false
+        query(data).xpath('//get_tasks_response/task').map do |scan|
+          new(scan)
+        end
+      end
+
+      def find_by_id(id)
+        data = Nokogiri::XML::Builder.new { get_tasks(task_id: id) }
+        new(query(data).at_xpath('//get_tasks_response/task'))
+      end
     end
   end
 end

data/lib/openvas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openvas
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/openvas.rb

@@ -6,9 +6,9 @@ require 'openvas/config'
 require 'openvas/client'
 require 'openvas/auth'
 
-require 'openvas/scans'
+require 'openvas/scan'
 require 'openvas/reports'
-require 'openvas/results'
+require 'openvas/result'
 
 module Openvas
   extend self

data/spec/openvas/scan_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Openvas::Scan do
+  let(:scan) { Openvas::Scan.find_by_id('96625625-8e22-4b1c-9c65-4ddf80f78d20') }
+
+  describe '.all' do
+    before { allow(Openvas::Scan).to receive(:query).and_return(fixture_xml('openvas/scans/all.xml')) }
+
+    it 'list scans' do
+      expect(Openvas::Scan.all.count).to eq 2
+    end
+  end
+
+  describe '.find_by_id' do
+    before { allow(Openvas::Scan).to receive(:query).and_return(fixture_xml('openvas/scans/find_by_id.xml')) }
+
+    it 'returns an Openvas::Scan object' do
+      expect(scan).to be_a(Openvas::Scan)
+    end
+
+    it 'retrieves the scan\'s id' do
+      expect(scan.id).to eq '96625625-8e22-4b1c-9c65-4ddf80f78d20'
+    end
+
+    it 'retrieves the scan\'s name' do
+      expect(scan.name).to eq 'shellshock_01'
+    end
+
+    it 'retrieves the scan\'s comment' do
+      expect(scan.comment).to be_empty
+    end
+
+    it 'retrieves the scan\'s user' do
+      expect(scan.user).to eq 'admin'
+    end
+
+    it 'retrieves the scan\'s status' do
+      expect(scan.status).to eq 'Done'
+    end
+
+    it 'retrieves the scan\'s creation date' do
+      expect(scan.created_at.to_s).to eq '2017-12-11 16:40:16 UTC'
+    end
+
+    it 'retrieves the scan\'s modification date' do
+      expect(scan.updated_at.to_s).to eq '2017-12-12 08:13:44 UTC'
+    end
+  end
+
+  describe '#finished?' do
+    before { allow(Openvas::Scan).to receive(:query).and_return(fixture_xml('openvas/scans/find_by_id.xml')) }
+
+    context 'when the status is Done' do
+      before { scan.status = 'Done' }
+
+      it 'returns true' do
+        expect(scan.finished?).to be_truthy
+      end
+    end
+
+    context 'when the status is not Done' do
+      before { scan.status = 'Running' }
+
+      it 'returns false' do
+        expect(scan.finished?).to be_falsey
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openvas
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Florian Wininger
@@ -101,8 +101,8 @@ files:
 - lib/openvas/client.rb
 - lib/openvas/config.rb
 - lib/openvas/reports.rb
-- lib/openvas/results.rb
-- lib/openvas/scans.rb
+- lib/openvas/result.rb
+- lib/openvas/scan.rb
 - lib/openvas/version.rb
 - openvas.gemspec
 - spec/fixtures/openvas/client/version.xml
@@ -110,7 +110,7 @@ files:
 - spec/fixtures/openvas/scans/find_by_id.xml
 - spec/openvas/auth_spec.rb
 - spec/openvas/client_spec.rb
-- spec/openvas/scans_spec.rb
+- spec/openvas/scan_spec.rb
 - spec/openvas_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Cyberwatch/ruby-openvas
@@ -143,6 +143,6 @@ test_files:
 - spec/fixtures/openvas/scans/find_by_id.xml
 - spec/openvas/auth_spec.rb
 - spec/openvas/client_spec.rb
-- spec/openvas/scans_spec.rb
+- spec/openvas/scan_spec.rb
 - spec/openvas_spec.rb
 - spec/spec_helper.rb

data/lib/openvas/results.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require 'time'
-
-module Openvas
-  class Results < Client
-    MAX_RESULTS = 1000
-
-    def self.all
-      # TODO: implement pagination
-      query = Nokogiri::XML::Builder.new { get_results(filter: "first=1 rows=#{MAX_RESULTS}") }
-      query(query).xpath('//get_results_response/result').map do |result|
-        Openvas::Result.new(result)
-      end
-    end
-
-    def self.find_by_id(id)
-      query = Nokogiri::XML::Builder.new { get_results(result_id: id) }
-      Openvas::Result.new(query(query).at_xpath('//get_results_response/result'))
-    end
-
-    def self.find_by_report_id(id)
-      # TODO: implement pagination
-      query = Nokogiri::XML::Builder.new { get_results(filter: "report_id=#{id} first=1 rows=#{MAX_RESULTS}") }
-
-      query(query).xpath('//get_results_response/result').map do |result|
-        Openvas::Result.new(result)
-      end
-    end
-  end
-
-  class Result
-    attr_accessor :id, :name, :comment, :description, :host, :user, :port, :severity, :created_at, :updated_at
-
-    def initialize(result)
-      @id = result.at_xpath('@id').value
-      @name = result.at_xpath('name').text
-      @comment = result.at_xpath('comment').text
-      @user = result.at_xpath('owner/name').text
-      @host = result.at_xpath('host').text
-      @port = result.at_xpath('port').text
-      @severity = result.at_xpath('severity').text
-      @description = result.at_xpath('description').text
-
-      @created_at = Time.parse(result.at_xpath('creation_time').text)
-      @updated_at = Time.parse(result.at_xpath('modification_time').text)
-    end
-
-    def results
-      Openvas::Results.find_by_report_id(@id)
-    end
-  end
-end

data/spec/openvas/scans_spec.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Openvas::Scans do
-  describe '#all' do
-    before(:each) do
-      allow(Openvas::Scans).to receive(:query).and_return(fixture_xml('openvas/scans/all.xml'))
-    end
-
-    it 'list scans' do
-      expect(Openvas::Scans.all.count).to eq 2
-    end
-  end
-
-  describe '#find_by_id' do
-    before(:each) do
-      allow(Openvas::Scans).to receive(:query).and_return(fixture_xml('openvas/scans/find_by_id.xml'))
-    end
-
-    it 'get the version' do
-      expect(Openvas::Scans.find_by_id('96625625-8e22-4b1c-9c65-4ddf80f78d20')).to be_a(Openvas::Scan)
-    end
-
-    context 'scan' do
-      let(:scan) { Openvas::Scans.find_by_id('96625625-8e22-4b1c-9c65-4ddf80f78d20') }
-
-      it '#id' do
-        expect(scan.id).to eq '96625625-8e22-4b1c-9c65-4ddf80f78d20'
-      end
-
-      it '#name' do
-        expect(scan.name).to eq 'shellshock_01'
-      end
-
-      it '#comment' do
-        expect(scan.comment).to eq ''
-      end
-
-      it '#user' do
-        expect(scan.user).to eq 'admin'
-      end
-
-      it '#status' do
-        expect(scan.status).to eq 'Done'
-      end
-
-      it '#finished' do
-        expect(scan.finished?).to be_truthy
-      end
-
-      it '#created_at' do
-        expect(scan.created_at.to_s).to eq '2017-12-11 16:40:16 UTC'
-      end
-
-      it '#updated_at' do
-        expect(scan.updated_at.to_s).to eq '2017-12-12 08:13:44 UTC'
-      end
-    end
-  end
-end