controls 1.5.1 → 1.6.0

data/spec/matchers.rb

@@ -0,0 +1,46 @@
+require 'rspec/expectations'
+
+# Assessment Matchers
+RSpec::Matchers.define :match_assessment_format do
+  match do |resource|
+    # Reverses the coercion
+    resource.timestamp = resource.timestamp.to_i
+    [
+      resource.high_risk_asset_count,
+      resource.id,
+      resource.low_risk_asset_count,
+      resource.medium_risk_asset_count,
+      resource.timestamp,
+      resource.total_asset_count
+    ].each do |attribute|
+      expect(attribute.class).to eq(Fixnum)
+    end
+
+    expect(resource.assessing.class).to include([TrueClass, FalseClass])
+    expect(resource.overall_risk_score.class).to  include([Float])
+  end
+end
+
+#RSpec::Matchers.define :match_event_format do
+#  [Fixnum].include? resource.createdAt
+#  [Hash].include? resource.payload
+#  [String].include? resource.type
+#  [String].include? resource.user
+#end
+#
+#RSpec::Matchers.define :match_site_change_event_payload_format do
+#  [TrueClass,FalseClass].include? resource.impactsGrade.class
+#  [String].include? resource.notes.class
+#  [String].include? resource.productVersion.class
+#end
+#
+#RSpec::Matchers.define :match_security_control_change_event_payload_format do
+#  [String,NilClass].include?resource.reason
+#  [String]}]].include?resource.changes:[Array,[Hash,{securityControlName:[String],action
+#end
+#
+#RSpec::Matchers.define :match__change_event_payload_format do
+#  [String,NilClass].include?resource.reason
+#  [Fixnum]}]].include?resource.enabledSites:[Array,[Hash,{name:[String],id
+#  [TrueClass.include?resource.importAllFalseClass]
+#end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'controls'
+require_relative './matchers.rb'
+
+module SpecHelpers
+  def login_to_environment
+    # Allow self-signed certs in continuous integration
+    Controls.verify_ssl = false
+    Controls.login(ENV['CONTROLS_USERNAME'], ENV['CONTROLS_PASSWORD'])
+  end
+end
+
+RSpec.configure do |rspec|
+ rspec.include SpecHelpers
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: controls
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Erran Carey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dish
@@ -80,48 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: This gem interfaces to Rapid7's **controls**insight API.
 email:
 - "'me@errancarey.com'"
@@ -131,35 +89,14 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
+- ".travis.yml"
 - ".yardopts"
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
+- apiary.apib
 - controls.gemspec
-- docs/Gemfile
-- docs/Rules
-- docs/content/index.md
-- docs/content/v1.md
-- docs/content/v1/authentication.md
-- docs/content/v1/search.md
-- docs/content/v1/troubleshooting.md
-- docs/layouts/default.html
-- docs/layouts/home.html
-- docs/lib/default.rb
-- docs/nanoc.yaml
-- docs/static/css/bootstrap-theme.css
-- docs/static/css/bootstrap-theme.min.css
-- docs/static/css/bootstrap.css
-- docs/static/css/bootstrap.min.css
-- docs/static/fonts/glyphicons-halflings-regular.eot
-- docs/static/fonts/glyphicons-halflings-regular.svg
-- docs/static/fonts/glyphicons-halflings-regular.ttf
-- docs/static/fonts/glyphicons-halflings-regular.woff
-- docs/static/images/controlsinsight-shield.png
-- docs/static/images/controlsinsight.png
-- docs/static/js/bootstrap.js
-- docs/static/js/bootstrap.min.js
 - lib/controls.rb
 - lib/controls/authentication.rb
 - lib/controls/client.rb
@@ -167,6 +104,7 @@ files:
 - lib/controls/client/assets.rb
 - lib/controls/client/configurations.rb
 - lib/controls/client/coverage.rb
+- lib/controls/client/events.rb
 - lib/controls/client/guidance.rb
 - lib/controls/client/prioritized_guidance.rb
 - lib/controls/client/security_controls.rb
@@ -182,17 +120,23 @@ files:
 - lib/controls/objects/configuration.rb
 - lib/controls/objects/configuration_finding.rb
 - lib/controls/objects/coverage_information.rb
+- lib/controls/objects/event.rb
 - lib/controls/objects/guidance.rb
+- lib/controls/objects/product_change_event_payload.rb
 - lib/controls/objects/security_control.rb
+- lib/controls/objects/security_control_change_event_payload.rb
 - lib/controls/objects/security_control_coverage.rb
 - lib/controls/objects/security_control_finding.rb
+- lib/controls/objects/site_change_event_payload.rb
 - lib/controls/objects/threat.rb
 - lib/controls/objects/threat_vector.rb
 - lib/controls/objects/trend.rb
 - lib/controls/response.rb
 - lib/controls/version.rb
-- spec/controls_spec.rb
-- spec/helper.rb
+- spec/controls/client/assessments_spec.rb
+- spec/controls/client/events_spec.rb
+- spec/matchers.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -218,6 +162,8 @@ signing_key:
 specification_version: 4
 summary: This gem interfaces to Rapid7's **controls**insight API.
 test_files:
-- spec/controls_spec.rb
-- spec/helper.rb
+- spec/controls/client/assessments_spec.rb
+- spec/controls/client/events_spec.rb
+- spec/matchers.rb
+- spec/spec_helper.rb
 has_rdoc: 

data/docs/Gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'maruku'
-gem 'nanoc'
-gem 'pygments.rb'
-
-group :development do
-  gem 'adsf'
-end
-gem 'nokogiri'

data/docs/Rules

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-
-compile '/static/*' do
-end
-
-compile '/stylesheet/' do
-end
-
-compile '*' do
-  unless item.binary?
-    filter :erb
-    filter :maruku
-    filter :colorize_syntax,
-           :colorizers => { :ruby => :pygmentsrb, :json => :pygmentsrb }
-    layout item[:layout] || 'default'
-  end
-end
-
-route '/static/*' do
-    item.identifier[7..-2]
-end
-
-route '*' do
-  if item.binary?
-    item.identifier.chop + '.' + item[:extension]
-  else
-    item.identifier + 'index.html'
-  end
-end
-
-layout '*', :erb

data/docs/content/index.md

@@ -1,8 +0,0 @@
----
-title: Overview
-layout: home
----
-## Using the ControlsInsight API {: #using-the-controlsinsight-api}
-Jump right in and use the ControlsInsight API.
-
-[Browse the documentation](v1/){: .btn .btn-primary}

data/docs/content/v1.md

@@ -1,8 +0,0 @@
----
-title: ControlsInsight API v1
----
-## Overview
-The ControlsInsight API v1 is described here. If you have any questions
-or requests please [contact Rapid7 support][support].
-
-[support]: http://www.rapid7.com/contact/ "Rapid7 Support"

data/docs/content/v1/authentication.md

@@ -1,3 +0,0 @@
----
-title: Authentication
----

data/docs/content/v1/search.md

@@ -1,11 +0,0 @@
----
-title: Search
----
-## Asset Search {: #asset-search}
-Find assets by multiple criteria including, but not limited to the
-asset's:
-- name
-- hostname
-- IP address
-
-<pre><code>GET /assets/search?query={query}{&amp;page,per_page,sort}</code></pre>

data/docs/content/v1/troubleshooting.md

@@ -1,3 +0,0 @@
----
-title: Troubleshooting
----

data/docs/layouts/default.html

@@ -1,46 +0,0 @@
-<!DOCTYPE HTML>
-<html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <base href="http://rapid7.github.io/controlsinsight.rb/">
-    <title><%= @item[:title] %> | ControlsInsight API</title>
-    <link rel="stylesheet" href="css/bootstrap.css">
-
-    <meta name="generator" content="nanoc <%= Nanoc::VERSION %>">
-  </head>
-  <body>
-    <nav class="navbar navbar-inverse navbar-static-top" role="navigation">
-      <a href="#" class="navbar-brand">ControlsInsight</a>
-      <ul class="nav navbar-nav pull-right">
-        <li><a href="#">Overview</a></li>
-        <li><a href="v1/">API</a></li>
-        <li><a href="https://community.rapid7.com/community/controls-insight/blog">Blog</a></li>
-        <li><a href="http://www.rapid7.com/contact/">Support</a></li>
-      </ul>
-    </nav>
-
-    <div class="container">
-      <div class="page-header">
-        <h1><%= @item[:title] %></h1>
-      </div>
-
-      <div class="row">
-        <div class="col-xs-8"><%= yield %></div>
-
-        <div class="col-xs-2"></div>
-        <div class="col-xs-2">
-          <ul class="nav nav-pills nav-stacked">
-            <!-- Overview items -->
-            <li><h4><a href="v1/">Overview</a></h4></li>
-            <li><a href="v1/authentication/">Authentication</a></li>
-            <li><a href="v1/troubleshooting/">Troubleshooting</a></li>
-            <!-- Search items -->
-            <li><h4><a href="v1/search/">Search</a></h4></li>
-            <li><a href="v1/search/#asset-search">Asset Search</a></li>
-          </ul>
-        </div>
-      </div>
-    </div>
-  </body>
-</html>

data/docs/layouts/home.html

@@ -1,51 +0,0 @@
-<!DOCTYPE HTML>
-<html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <base href="http://rapid7.github.io/controlsinsight.rb/">
-    <title><%= @item[:title] %></title>
-    <link rel="stylesheet" href="css/bootstrap.css">
-
-    <!-- you don't need to keep this, but it's cool for stats! -->
-    <meta name="generator" content="nanoc <%= Nanoc::VERSION %>">
-  </head>
-  <body>
-    <nav class="navbar navbar-inverse navbar-static-top" role="navigation">
-      <a href="#" class="navbar-brand">ControlsInsight</a>
-      <ul class="nav navbar-nav pull-right">
-        <li><a href="#">Overview</a></li>
-        <li><a href="v1/">API</a></li>
-        <li><a href="https://community.rapid7.com/community/controls-insight/blog">Blog</a></li>
-        <li><a href="http://www.rapid7.com/contact/">Support</a></li>
-      </ul>
-    </nav>
-
-    <div class="container">
-      <div class="page-header"><h1><%= @item[:title] %></h1></div>
-<%= yield %>
-    </div>
-
-    <div class="row well">
-      <div class="container">
-        <div class="col-lg-4">
-          <h1 class="text-center"><span class="glyphicon glyphicon-book"></span></h1>
-          <p class="text-center lead"><a href="guides/">API Usage</a></h2>
-          <p class="text-center">Just getting started? Make sure to read the guides.</p>
-        </div>
-
-        <div class="col-lg-4">
-          <h1 class="text-center"><span class="glyphicon glyphicon-list"></span></h1>
-          <p class="text-center lead"><a href="libraries/">Client Libraries</a></h2>
-          <p class="text-center">Check out some client libraries written for the ControlsInsight API.</p>
-        </div>
-
-        <div class="col-lg-4">
-          <h1 class="text-center"><span class="glyphicon glyphicon-info-sign"></span></h1>
-          <p class="text-center lead"><a href="http://www.rapid7.com/contact/">Support</a></h2>
-          <p class="text-center">If the <a href="v1/troubleshooting/">troubleshooting/FAQs</a> didn't help you please contact Rapid7 Support.</p>
-        </div>
-      </div>
-    </div>
-  </body>
-</html>

data/docs/lib/default.rb

@@ -1,2 +0,0 @@
-# All files in the 'lib' directory will be loaded
-# before nanoc starts compiling.

data/docs/nanoc.yaml

@@ -1,43 +0,0 @@
-output_dir: output
-index_filenames:
-  - index.html
-enable_output_diff: false
-data_sources:
-  -
-    type: filesystem_unified
-    items_root: /
-    layouts_root: /
-    allow_periods_in_identifiers: false
-  -
-    type: static
-    items_root: /static
-    allow_periods_in_identifiers: true
-prune:
-  auto_prune: false
-  exclude:
-  - .git
-  - .hg
-  - .svn
-  - CVS
-text_extensions:
-  - coffee
-  - css
-  - erb
-  - haml
-  - handlebars
-  - hb
-  - htm
-  - html
-  - js
-  - less
-  - markdown
-  - md
-  - ms
-  - mustache
-  - php
-  - rb
-  - sass
-  - scss
-  - txt
-  - xhtml
-  - xml