Nessus6 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67207fc36dd073bd4d9dcca0e5e006da3d978565
-  data.tar.gz: a8e5ef92f78f4a92c3ae3d69df70a423bcef441c
+  metadata.gz: 1d5f74268631e12a7f57ba4a136bd591da5b1a37
+  data.tar.gz: f6eb5f515119e9b788c4ada09eefad0169d282d8
 SHA512:
-  metadata.gz: ad144c667cc670901f42f9a021de9877d088300966ab57967ecc3736f81f7f81d342c0fd1e04bd5cab2c1f1ec60607ac45312bd2dfc7531de0c699eabadbdb0e
-  data.tar.gz: 0b9ed6e0c6193cc023bd8bfef559348de1842ca4cc0daec36cfbc64b667c9c217722aba207e68bb9d45849fa2d16ec33588b6f9547f98ac493aa28e708e018e1
+  metadata.gz: 14fc6d68c0e61e0076f90e35de06ffe5ff4a7972a6960dec149b3686fa2c5e18db81d1f01e2f2e48a3e25c8ff0ef13f210b9b57e4d85fadf78b6dc0a1444b805
+  data.tar.gz: 2448df2fefbbc269f1ca485cc63fa120da2b624175ce3faea7cf65b8d8e32da36b2d52d0be6a844abf83f6de08da8269a4e2a48eafb22ee0c09fa549cdbef5da

data/.codeclimate.yml

@@ -0,0 +1,49 @@
+# This is a sample .codeclimate.yml configured for Engine analysis on Code
+# Climate Platform. For an overview of the Code Climate Platform, see here:
+# http://docs.codeclimate.com/article/300-the-codeclimate-platform
+
+# Under the engines key, you can configure which engines will analyze your repo.
+# Each key is an engine name. For each value, you need to specify enabled: true
+# to enable the engine as well as any other engines-specific configuration.
+
+# For more details, see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+# For a list of all available engines, see here:
+# http://docs.codeclimate.com/article/296-engines-available-engines
+
+# languages:
+#    Ruby: true
+
+engines:
+  rubocop:
+    enabled: true
+  flay:
+    enabled: true
+  bundler-audit:
+    enabled: true
+
+# Engines can analyze files and report issues on them, but you can separately
+# decide which files will receive ratings based on those issues. This is
+# specified by path patterns under the ratings key.
+
+# For more details see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+ratings:
+  paths:
+  - bin/**
+  - lib/**
+  - test/**
+  - Rakefile
+  - Nessus6.gemspec
+  - Gemfile
+#   - "**.rb"
+#   - "**.go"
+
+# You can globally exclude files from being analyzed by any engine using the
+# exclude_paths key.
+
+#exclude_paths:
+#- spec/**/*
+#- vendor/**/*

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
   - 2.2.0
   - 2.2.1
   - 2.2.2
+  - 2.2.3
   - rbx-2
   - ruby-head
   - jruby-head

data/Nessus6.gemspec

@@ -10,13 +10,15 @@ Gem::Specification.new do |spec|
   spec.email         = ['kev.kirsche@gmail.com']
   spec.license       = 'Apache-2.0'
 
-  spec.summary       = %q{[Under Construction] Nessus 6 API Gem}
-  spec.description   = %q{Gem for interacting with the Tenable Nessus 6 REST API.}
+  spec.summary       = '[Under Construction] Nessus 6 API Gem'
+  spec.description   = 'Gem for interacting with the Tenable Nessus 6 REST API.'
   spec.homepage      = 'https://github.com/kkirsche/Nessus6'
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject do |files|
+    files.match(%r{^(test|spec|features)/})
+  end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
@@ -26,5 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.8'
   spec.add_development_dependency 'yard', '~> 0.8'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
-  spec.add_runtime_dependency 'hurley', '~> 0.1'
+  spec.add_runtime_dependency 'hurley', '~> 0.2'
 end

data/README.md

@@ -1,10 +1,12 @@
-[![Code Climate](https://codeclimate.com/github/kkirsche/Nessus6/badges/gpa.svg)](https://codeclimate.com/github/kkirsche/Nessus6) [![Test Coverage](https://codeclimate.com/github/kkirsche/Nessus6/badges/coverage.svg)](https://codeclimate.com/github/kkirsche/Nessus6/coverage) [![Gem Version](https://badge.fury.io/rb/Nessus6.svg)](http://badge.fury.io/rb/Nessus6)
+[![Build Status](https://travis-ci.org/kkirsche/Nessus6.svg)](https://travis-ci.org/kkirsche/Nessus6) [![Code Climate](https://codeclimate.com/github/kkirsche/Nessus6/badges/gpa.svg)](https://codeclimate.com/github/kkirsche/Nessus6) [![Test Coverage](https://codeclimate.com/github/kkirsche/Nessus6/badges/coverage.svg)](https://codeclimate.com/github/kkirsche/Nessus6/coverage) [![Gem Version](https://badge.fury.io/rb/Nessus6.svg)](http://badge.fury.io/rb/Nessus6)
 
 # Nessus6
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/Nessus6`. To experiment with that code, run `bin/console` for an interactive prompt.
+Welcome to the Nessus6 gem. This gem focuses on allowing you to programmatically interact with the Nessus version 6 REST API. 
 
-TODO: Delete this and the text above, and describe your gem
+## Requires
+* Nessus 6
+* Ruby >= 2.0
 
 ## Installation
 
@@ -24,13 +26,13 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To learn how to use this, please go to https://rubygems.org/gems/Nessus6 and then click on Documentation in the right hand menu or use Yard to generate documentation for this library locally.
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. 
 
 ## Contributing
 

data/Rakefile

@@ -8,4 +8,4 @@ Rake::TestTask.new(:test) do |t|
   t.pattern = 'test/spec/**/*_spec.rb'
 end
 
-task :default => :test
+task default: :test

data/lib/Nessus6.rb

@@ -29,7 +29,7 @@ module Nessus6
       nessus[:port] = '8834' unless nessus.key?(:port)
 
       # Create our client
-      @client = Hurley::Client.new 'https://' + nessus[:ip] + ':' + nessus[:port]
+      @client = Hurley::Client.new "https://#{nessus[:ip]}:#{nessus[:port]}"
       @client.ssl_options.skip_verification = true
 
       authenticate credentials

data/lib/Nessus6/editor.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The Editor class is for interacting with Nessus6 templates. Templates are
   # used to create scans or policies with predefined parameters.
@@ -58,6 +59,8 @@ module Nessus6
     def list(type)
       response = @client.get("editor/#{type}/templates")
       verify response,
+             bad_request: 'Request could not be completed. Please use either '\
+                          'type "scan" or type "policy".',
              forbidden: 'You do not have permission to view the list',
              internal_server_error: 'Internal server error occurred.'
     end
@@ -72,7 +75,8 @@ module Nessus6
     #   the family.
     # @return [Hash] The plugin output
     def plugin_description(policy_id, family_id, plugin_id)
-      response = @client.get("editor/policy/#{policy_id}/families/#{family_id}/plugins/#{plugin_id}")
+      response = @client.get("editor/policy/#{policy_id}/families/#{family_id}"\
+        "/plugins/#{plugin_id}")
       verify response,
              internal_server_error: 'Internal server error occurred.'
     end

data/lib/Nessus6/file.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The File class is for uploading files to Nessus.
   # https://localhost:8834/api#/resources/file

data/lib/Nessus6/folder.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The Folders class is for interacting with Nessus6 folders. Folders are used
   # to sort and organize a user's scan results.

data/lib/Nessus6/group.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The Groups class is for interacting with Nessus6 user groups. Groups are
   # utilized to make sharing easier.

data/lib/Nessus6/permission.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The Permissions class is for interacting with Nessus6 user permissions.
   # Permissions are used to provide access rights to a given object.

data/lib/Nessus6/plugin.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The Plugin class is for interacting with Nessus6 plugins.
   # https://localhost:8834/api#/resources/plugins

data/lib/Nessus6/plugin_rule.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The Plugin class is for interacting with Nessus6 plugins.
   # https://localhost:8834/api#/resources/plugins

data/lib/Nessus6/scan.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The Scans class is for interacting with Nessus6 scans.
   # https://localhost:8834/api#/resources/scans
@@ -124,5 +125,15 @@ module Nessus6
              not_found: 'Scan does not exist.',
              conflict: 'Scan is not active.'
     end
+
+    # Returns the timezone list for creating a scan.
+    #
+    # @return [Hash] The timezone resource
+    def timezones
+      response = @client.get 'scans/timezones'
+      verify response,
+             unauthorized: 'You do not have permission to view timezones',
+             internal_server_error: 'Internal server error occurred'
+    end
   end
 end

data/lib/Nessus6/scanner.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The Scanner class provides details about the available scanners
   # https://localhost:8834/api#/resources/server

data/lib/Nessus6/server.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The Server class returns information about the Nessus Server itself
   # https://localhost:8834/api#/resources/server

data/lib/Nessus6/session.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The Session class is used to create a session with Nessus6. User sessions
   # allow us to interact throughout our applications.
@@ -22,7 +23,7 @@ module Nessus6
     # @return [String] The session token
     def create(username, password)
       response = @client.post('session',
-                          username: username, password: password)
+                              username: username, password: password)
       verified = verify response,
                         bad_request: 'Username format is not valid',
                         unauthorized: 'Username or password is invalid',

data/lib/Nessus6/user.rb

@@ -1,3 +1,4 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The Users class allows us to interact with Nessus 6 users.
   # Users can utilize Nessus based on their given role.

data/lib/Nessus6/verification.rb

@@ -7,6 +7,7 @@ require 'Nessus6/error/not_found'
 require 'Nessus6/error/unauthorized'
 require 'Nessus6/error/unknown'
 
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # The verification class allows methods to verify responses from Nessus
   module Verification

data/lib/Nessus6/version.rb

@@ -1,4 +1,5 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # VERSION is the current version of the Nessus6 gem
-  VERSION = "0.1.5"
+  VERSION = '0.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Nessus6
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Kevin Kirsche
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-24 00:00:00.000000000 Z
+date: 2015-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 description: Gem for interacting with the Tenable Nessus 6 REST API.
 email:
 - kev.kirsche@gmail.com
@@ -101,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile