vectra 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3273ced24955e5aaa0d94d1e97ea5f7c7224b9a
-  data.tar.gz: 648bbec3463d73afa3d4cd1f122a6b4b96483d0a
+  metadata.gz: bebaf2ac4a12c7917a69dc288cdca7c3869593e5
+  data.tar.gz: ad4df58d56b6a7f0f74276f40d195691e2f3537f
 SHA512:
-  metadata.gz: 65f2b2badfea35b8f66541f5ebbe9792098273b0c1ee6779094e4a4326210d509a4863402ac76aa67bb10064287e390afb471b3f8a4b02466d44184dfdc4dd2d
-  data.tar.gz: 507c2762a74cdd5c816b6e2404c9c13b19c580f1144c0067406dfec5d677d26d4e361e0f00082430375b9c60335e24e851a524635a7217e4ac15a1b53b2d12a8
+  metadata.gz: 56d09edeae08914b221242a215d45055714148d92157296cee2facb81f80d9bccdfdfc01a4da97ff6274723719b050dbe7bd83beab05ce5cfbb35c78e8012720
+  data.tar.gz: 0e1cb875c6538be00e85ac4abd533c289900839cdacbf4d1fccec8c69e03af5cbd80c1da2b6392711cd76e99397a4fd9267740921142ecbbb4e893c156f2233e

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+/vendor/
+Gemfile.lock
+*.gem

data/.rock.yml

@@ -0,0 +1,5 @@
+runtime: ruby21
+build_gem: |
+  rm -rf *.gem
+  gem build vectra.gemspec
+push_gem: exec gem push *.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mike Mackintosh
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,12 @@
+# Ruby Vectra
+A Ruby extension for interfacing with Vectra API.
+
+[![TravisCI](https://travis-ci.org/mikemackintosh/ruby-vectra.svg)](https://travis-ci.org/mikemackintosh/ruby-vectra)
+
+# Installation
+
+Like any other gem:
+
+```shell
+gem install vectra
+```

data/Rakefile

@@ -0,0 +1,17 @@
+#encoding: utf-8 
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task default: :test
+
+RSpec::Core::RakeTask.new do |spec|
+  spec.verbose = false
+  spec.pattern = './spec/{*/**/}*_spec.rb'
+end
+
+task :test do
+  ENV['RACK_ENV'] = 'test'
+
+  require './spec/spec_helper'
+  Rake::Task['spec'].invoke
+end

data/lib/vectra.rb

@@ -0,0 +1,27 @@
+require 'httparty'
+require 'json'
+require 'fattr'
+require 'cgi'
+
+require 'vectra/config'
+require 'vectra/api'
+require 'vectra/hosts'
+require 'vectra/detections'
+
+module Vectra
+
+  extend self
+
+  def configure
+    block_given? ? yield(Config) : Config
+    %w(username password endpoint).each do |key|
+      if Vectra::Config.instance_variable_get("@#{key}").nil?
+        raise Vectra::Config::RequiredOptionMissing,
+          "Configuration parameter missing: '#{key}'. " +
+          "Please add it to the Vectra.configure block"
+      end
+    end
+  end
+  alias_method :config, :configure
+
+end

data/lib/vectra/api.rb

@@ -0,0 +1,49 @@
+module Vectra
+  class Api
+    class InvalidResponse < RuntimeError ; end
+
+    include HTTParty
+
+    def self.send(url, args="", decode)
+      results = []
+
+      # Send the request
+      response = HTTParty.get( 
+        "#{url}#{args}",
+        :verify => false, # Vectra doesnt accept real certs yet
+        :basic_auth => { 
+          :username => Vectra::Config.username, 
+          :password => Vectra::Config.password
+      })
+
+      if !response.code.eql?(200)
+        raise Vectra::Api::InvalidResponse, "Invalid Response Received"
+      end
+
+      # Decode the response
+      response = JSON.parse response.body
+
+      # Check if we should decode this response
+      if decode
+        # Map responses
+        response['results'].map{|r| results.push(r)}
+      else
+        results = response
+      end
+
+      # If there is a next, respect it
+      #unless response['next'].nil?
+      #  puts self.send(response['next']).inspect
+      #end
+
+      results
+
+    end
+
+    def self.request(args="", decode=true)
+      r = self.send("#{Vectra::Config.endpoint}#{self.target}", args, decode)
+      r
+    end
+
+  end
+end

data/lib/vectra/config.rb

@@ -0,0 +1,35 @@
+module Vectra
+  module Config
+    class RequiredOptionMissing < RuntimeError ; end
+    extend self
+
+    attr_accessor :endpoint, :username, :password
+
+    # Configure vectra from a hash. This is usually called after parsing a
+    # yaml config file such as vectra.yaml.
+    #
+    # @example Configure Vectra.
+    #   config.from_hash({})
+    #
+    # @param [ Hash ] options The settings to use.
+    def from_hash(options = {})
+      options.each_pair do |name, value|
+        send("#{name}=", value) if respond_to?("#{name}=")
+      end
+    end
+
+    # Load the settings from a compliant vectra.yml file. This can be used for
+    # easy setup with frameworks other than Rails.
+    #
+    # @example Configure Vectra.
+    #   Vectra.load!("/path/to/vectra.yml")
+    #
+    # @param [ String ] path The path to the file.
+    def load!(path)
+      settings = YAML.load(ERB.new(File.new(path).read).result)
+      if settings.present?
+        from_hash(settings)
+      end
+    end
+  end
+end

data/lib/vectra/detections.rb

@@ -0,0 +1,20 @@
+module Vectra
+  class Detections < Api
+
+    attr_reader :id
+
+    def self.target
+      "detections"
+    end
+
+    def self.all
+      request
+    end
+
+    def self.get(id)
+      request("/#{id}", false)
+    end
+
+  end
+
+end

data/lib/vectra/hosts.rb

@@ -0,0 +1,20 @@
+module Vectra
+  class Hosts < Api
+
+    attr_reader :name
+
+    def self.target
+      "hosts"
+    end
+
+    def self.all
+      request
+    end
+
+    def self.get(id)
+      request("/#{id}", false)
+    end
+
+  end
+
+end

data/lib/vectra/version.rb

@@ -0,0 +1,3 @@
+module Vectra
+  VERSION = '0.0.2'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'rspec/core'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'vectra')
+
+# Create the share API context
+# so we can pass stuff between
+# the different tests
+RSpec.shared_context "shared environment", :a => :b do
+
+  before(:all) do
+
+    # Set endpoint details
+    @endpoint_url = 'https://10.200.10.88/api/'
+    @username = "api"
+    @password = "AbpdWjFFKuu3XVdKKXjMZbard3H"
+
+  end
+
+end
+
+# Seems to run tests more than once if we do RSpec.configure more than once
+#unless RSpec.configuration.color_enabled == true
+  RSpec.configure do |config|
+    config.color = true
+    config.formatter = :documentation
+  end
+#end

data/spec/vectra/vectra_spec.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Vectra::Api, 'Configure' do
+  include_context "shared environment"
+
+  it 'configures correctly' do
+    Vectra.configure do |config|
+      config.endpoint = @endpoint_url
+      config.username = @username
+      config.password = @password
+    end
+  end
+
+  it 'gets all hosts' do
+    puts Vectra::Hosts.all
+  end
+
+  it 'gets host by id' do
+    puts Vectra::Hosts.get(1)
+  end
+
+  it 'gets all detections' do
+    puts Vectra::Detections.all
+  end
+
+  it 'gets detection by id' do
+    puts Vectra::Detections.get(95)
+  end
+
+end

data/vectra.gemspec

@@ -0,0 +1,34 @@
+# Created by hand, like a real man
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vectra/version'
+
+Gem::Specification.new do |s|
+
+  s.name        = 'vectra'
+  s.version     = Vectra::VERSION
+  s.date        = '2015-02-23'
+  s.summary     = "Vectra API Client"
+  s.description = "Easily interface with the Vectra API for consuming detections, threats and events"
+  s.authors     = ["Mike Mackintosh"]
+  s.email       = 'm@zyp.io'
+  s.homepage    =
+    'http://github.com/mikemackintosh/ruby-vectra'
+
+  s.license       = 'MIT'
+  
+  s.require_paths = ["lib"]
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_dependency 'httparty'
+  s.add_dependency 'fattr'
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "webmock"
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vectra
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mike Mackintosh
@@ -94,13 +94,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Vectra API Client
+description: Easily interface with the Vectra API for consuming detections, threats
+  and events
 email: m@zyp.io
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: http://github.com/mikemackintosh/vectra
+files:
+- ".gitignore"
+- ".rock.yml"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vectra.rb
+- lib/vectra/api.rb
+- lib/vectra/config.rb
+- lib/vectra/detections.rb
+- lib/vectra/hosts.rb
+- lib/vectra/version.rb
+- spec/spec_helper.rb
+- spec/vectra/vectra_spec.rb
+- vectra.gemspec
+homepage: http://github.com/mikemackintosh/ruby-vectra
 licenses:
 - MIT
 metadata: {}
@@ -124,4 +142,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Vectra API Client
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/vectra/vectra_spec.rb