controls 1.0.0.beta.2

data/lib/controls/response.rb

@@ -0,0 +1,76 @@
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/hash/keys'
+require 'controls/response/raise_error'
+
+module Controls
+  # A namespace for response related classes
+  module Response
+    # @param [String] response the response body as a JSON String provided by
+    #   the ControlsInsight API
+    # @return [Array,Hash] the response after being parsed into an Array or
+    #   Hash
+    def self.parse(response)
+      response = JSON.parse(response)
+    end
+
+    # @param [Array,Hash] response the Array or Hash to convert into a ruby
+    #  style object
+    def self.generate_ruby(response)
+      if response.is_a? String
+        response = JSON.parse(response)
+      end
+
+      # TODO: Determine the specific format, or create a new, recursive (w/
+      #       array support) deep method
+      # NOTE: If the ControlsInsight API begins returning more complex JSON
+      #       this conditional must be updated.
+      if response.is_a? Hash
+        response.deep_transform_keys! { |key| key.underscore }
+
+        if response.has_key? 'resources'
+          response['resources'].each do |hash|
+            hash.deep_transform_keys! { |key| key.underscore }
+
+            if hash.has_key? 'security_control_findings'
+              hash['security_control_findings'].each do |subhash|
+                subhash.deep_transform_keys! { |key| key.underscore }
+
+                if subhash.has_key? 'configuration_findings'
+                  subhash['configuration_findings'].each do |subhash_two|
+                    subhash_two.deep_transform_keys! { |key| key.underscore }
+                  end
+                end
+              end
+            end
+          end
+        end
+      elsif response.is_a? Array
+        response.each do |element|
+          if element.is_a? Hash
+            element.deep_transform_keys! { |key| key.underscore }
+
+            if element.has_key? 'resources'
+              element['resources'].each do |hash|
+                hash.deep_transform_keys! { |key| key.underscore }
+
+                if hash.has_key? 'security_control_findings'
+                  hash['security_control_findings'].each do |subhash|
+                    subhash.deep_transform_keys! { |key| key.underscore }
+
+                    if subhash.has_key? 'configuration_findings'
+                      subhash['configuration_findings'].each do |subhash_two|
+                        subhash_two.deep_transform_keys! { |key| key.underscore }
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      response
+    end
+  end
+end

data/lib/controls/response/raise_error.rb

@@ -0,0 +1,21 @@
+require 'controls/error'
+
+module Controls
+  module Response
+    # A middleware plugin that hooks into the Faraday client used by this gem
+    class RaiseError < Faraday::Response::Middleware
+      private
+
+      # Implements the {#on_complete} hook used by Faraday's middleware
+      #
+      # @raise [Controls::Error] a subclass of Controls::Error if any errors
+      #   were encountered
+      # @return [nil] if no error was found
+      def on_complete(response)
+        if error = Controls::Error.from_response(response)
+          raise error
+        end
+      end
+    end
+  end
+end

data/lib/controls/version.rb

@@ -0,0 +1,4 @@
+module Controls
+  # The version of the Controls gem
+  VERSION = '1.0.0.beta.2'
+end

data/spec/controls_spec.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+# TODO: Add more tests
+describe Controls do
+  before { Controls.reset! }
+  after  { Controls.reset! }
+
+  it 'is configured with default values from the environment' do
+    Controls::Configurable.keys.each do |key|
+      actual = Controls.instance_variable_get(:"@#{key}")
+      expected = Controls::Default.send(key)
+
+      expect(actual).to eq(expected)
+    end
+  end
+
+  describe 'Controls.client' do
+    it 'is an instance of Controls::Client' do
+      expect(Controls.client).to be_kind_of Controls::Client
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,42 @@
+require 'rspec'
+require 'controls'
+
+require 'vcr'
+VCR.configure do |vcr|
+  vcr.filter_sensitive_data('<CONTROLS_USERNAME>') do
+    ENV['CONTROLS_TEST_USERNAME'] ||= ENV['CONTROLS_TEST_USERNAME']
+  end
+
+  vcr.filter_sensitive_data('<CONTROLS_PASSWORD>') do
+    ENV['CONTROLS_TEST_PASSWORD'] ||= ENV['CONTROLS_TEST_PASSWORD']
+  end
+
+  vcr.filter_sensitive_data('https://nexpose.local:3780') do
+    uri = URI.parse(Controls.client.web_endpoint)
+    "#{uri.scheme}://#{uri.host}:#{uri.port}"
+  end
+
+  vcr.filter_sensitive_data('<CONTROLS_PASSWORD>') do
+    ENV['CONTROLS_TEST_PASSWORD'] ||= ENV['CONTROLS_TEST_PASSWORD']
+  end
+
+  vcr.default_cassette_options = {
+    record: ENV['CI'] ? :none : :once,
+    serialize_with: :json
+  }
+
+  vcr.cassette_library_dir = 'spec/cassettes'
+  vcr.hook_into :faraday
+end
+
+def test_controls_username
+  ENV.fetch 'CONTROLS_TEST_USERNAME'
+end
+
+def test_controls_password
+  ENV.fetch 'CONTROLS_TEST_PASSWORD'
+end
+
+def token_auth_client(user = test_controls_username, pass = test_controls_password)
+  Controls.client.new(username: user, password: pass)
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: controls
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta.2
+platform: ruby
+authors:
+- Erran Carey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: netrc
+  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: 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'''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- controls.gemspec
+- docs/images/controlsinsight+shield.png
+- docs/images/controlsinsight.png
+- lib/controls.rb
+- lib/controls/authentication.rb
+- lib/controls/client.rb
+- lib/controls/client/assessments.rb
+- lib/controls/client/assets.rb
+- lib/controls/client/configurations.rb
+- lib/controls/client/guidance.rb
+- lib/controls/client/prioritized_guidance.rb
+- lib/controls/client/security_controls.rb
+- lib/controls/client/threat_vectors.rb
+- lib/controls/client/threats.rb
+- lib/controls/configurable.rb
+- lib/controls/default.rb
+- lib/controls/error.rb
+- lib/controls/response.rb
+- lib/controls/response/raise_error.rb
+- lib/controls/version.rb
+- spec/controls_spec.rb
+- spec/helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: This gem interfaces to Rapid7's **controls**insight API.
+test_files:
+- spec/controls_spec.rb
+- spec/helper.rb
+has_rdoc: