arbor_peakflow_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddba0bf5c2df3bce58c22370c6c300073b9ce406
+  data.tar.gz: 9c9c9ddb0d811675b210e2f99888002e7cd772a7
+SHA512:
+  metadata.gz: 1f2f82a8a2e47eebea695575382216da5e1cd76caf791ffb44638479b6e36c1c7f7c723370b4997859ce17b080c64732f8c8301b52f6991fdbbde7390764e47f
+  data.tar.gz: 6bfd181d47f02216ad1050c95930f185e444ce62f7e6c0a348562fbac5cd7ff09f6fca1f026212ff69cc9d47a34491c61523c3cb4b1415e7584220e8d5eef150

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test/.DS_Store
+.DS_Store

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.1.5
+  - 2.2.0
+
+before_install:
+  - gem update --system
+  - gem --version
+
+gemfile:
+  - Gemfile
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in arbor_peakflow_ruby.gemspec
+gemspec
+gem 'rake', group: :test, require: nil
+gem 'minitest', group: :test, require: nil
+gem 'bundler', group: :test, require: nil
+gem 'faraday'

data/README.md

@@ -0,0 +1,39 @@
+# ArborPeakflowRuby
+
+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/arbor_peakflow_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arbor_peakflow_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arbor_peakflow_ruby
+
+## Usage
+
+Within your application, create a client. With the client, you can access then all available actions (refer to RDocs for info on these). Each response has a `.body`, `.status`, and `.headers` methods. Status returns the HTTP status code, such as 200. Body returns the response body, and Headers returns the response headers.
+
+## 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).
+
+## Contributing
+
+1. Fork it ( https://github.com/kkirsche/arbor_peakflow_ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test/"
+  t.libs << "bin/"
+  t.libs << "lib/"
+  t.pattern = "test/arbor_peakflow_ruby/**/*_spec.rb"
+end
+
+task :default => :test

data/arbor_peakflow_ruby.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arbor_peakflow_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "arbor_peakflow_ruby"
+  spec.version       = Arbor::Peakflow::VERSION
+  spec.authors       = ["Kevin Kirsche"]
+  spec.email         = ["kevin.kirsche@verizon.com"]
+
+  spec.summary       = %q{Arbor Peakflow 6.0 API interaction gem}
+  spec.description   = %q{Provides access to the Arbor Peakflow SP 6.0 HTTPS API}
+  spec.homepage      = "https://github.com/kkirsche/arbor-peakflow-ruby"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "arbor_peakflow_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/arbor_peakflow_ruby/actions/alerts.rb

@@ -0,0 +1,32 @@
+module Arbor
+  module Peakflow
+    module Alerts
+      # The alerts function allows you to search for and retrieve JSON or XML
+      # alert information.
+      #
+      # == Parameters:
+      # - filter: (Optional) Keywords by which you want to filter search
+      # results. You can enter the same search strings that you can enter in
+      # the Search box on the Alerts pages in the Web UI.
+      # - limit: (Optional) The maximum number of alerts to return that match
+      # the filter.
+      # - format: The format in which you want the data returned:
+      # 'json' or 'xml'
+      #
+      # ==== Example
+      #
+      #    response = client.alerts 'host', 100, 'json'
+      def alerts(filter = nil, limit = nil, format = 'json')
+        response = @conn.get do |req|
+          req.url 'arborws/alerts'
+          req.params['api_key'] = @api_key
+          req.params['format'] = format
+          req.params['filter'] = filter unless filter.nil?
+          req.params['limit'] = limit unless limit.nil?
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/arbor_peakflow_ruby/actions/cp5500.rb

@@ -0,0 +1,31 @@
+module Arbor
+  module Peakflow
+    module CP5500
+      # The CP 5500 function allows you to view CP 5500 appliance configurations
+      # in JSON format. *Note:* This function is only available with
+      # appliance-based licensing for Traffic and Analysis Routing appliances
+      # (formally Collector Platform (CP) appliances).
+      #
+      # == Parameters:
+      # - action: One of the following actions that you want to initiate:
+      # list, show_schema, update.
+      # - filter: (Optional) Keywords by which you want to filter search
+      # results. You can enter the same search strings that you can enter in
+      # the Search box on the Configure Routers page in the Web UI.
+      #
+      # ==== Example
+      #
+      #    response = client.cp5500 'show_schema'
+      def cp5500(action, filter = nil)
+        response = @conn.get do |req|
+          req.url 'arborws/admin/cp5500'
+          req.params['api_key'] = @api_key
+          req.params['action'] = action
+          req.params['filter'] = filter unless filter.nil?
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/arbor_peakflow_ruby/actions/managed_object.rb

@@ -0,0 +1,26 @@
+module Arbor
+  module Peakflow
+    module Managed_Object
+      # The managed object function allows you to view managed object
+      # configuration data in JSON format.
+      #
+      # == Parameters:
+      # - filter: (Optional) Keywords by which you want to filter search
+      # results. You can enter the same search strings that you can enter in
+      # the Search box on the Managed Objects pages in the Web UI.
+      #
+      # ==== Example
+      #
+      #    response = client.managed_object 'dorms'
+      def managed_object(filter = nil)
+        response = @conn.get do |req|
+          req.url 'arborws/admin/managed_object'
+          req.params['api_key'] = @api_key
+          req.params['filter'] = filter unless filter.nil?
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/arbor_peakflow_ruby/actions/mitigations.rb

@@ -0,0 +1,32 @@
+module Arbor
+  module Peakflow
+    module Mitigations
+      # The mitigations function allows you to search for and retrieve JSON and
+      # XML mitigation information.
+      #
+      # == Parameters:
+      # - filter: (Optional) Keywords by which you want to filter search
+      # results. You can enter the same search strings that you can enter in
+      # the Search box on the Mitigations pages in the Web UI.
+      # - limit: (Optional) The maximum number of mitigations to return that
+      # match the filter.
+      # - format: The format in which you want the data returned:
+      # 'json' or 'xml'
+      #
+      # ==== Example
+      #
+      #    response = client.mitigations 'auto-mitigation', 10, 'json'
+      def mitigations(filter = nil, limit = nil, format = 'json')
+        response = @conn.get do |req|
+          req.url 'arborws/mitigations/status'
+          req.params['api_key'] = @api_key
+          req.params['format'] = format
+          req.params['filter'] = filter unless filter.nil?
+          req.params['limit'] = limit unless limit.nil?
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/arbor_peakflow_ruby/actions/reports.rb

@@ -0,0 +1,107 @@
+module Arbor
+  module Peakflow
+    module Reports
+      # Allows you to view a list of the configured wizard reports in Peakflow
+      # SP
+      #
+      # == Parameters:
+      # - filter: (Optional) Keywords by which you want to filter search
+      # results. You can enter the same search strings that you can enter in
+      # the Search box on the Alerts pages in the Web UI.
+      # - limit: (Optional) The maximum number of alerts to return that match
+      # the filter.
+      # - format: The format in which you want the data returned:
+      # 'json' or 'xml'
+      #
+      # ==== Example
+      #
+      #    response = client.configured_reports
+      def configured_reports(filter = nil, limit = nil, format = 'json')
+        response = @conn.get do |req|
+          req.url 'arborws/reports/configured'
+          req.params['api_key'] = @api_key
+          req.params['format'] = format
+          req.params['filter'] = filter unless filter.nil?
+          req.params['limit'] = limit unless limit.nil?
+        end
+
+        response
+      end
+
+      # Allows you to queue a wizard report to run
+      #
+      # == Parameters:
+      # - name: The name of the configured wizard report that you want to run.
+      # The returned value is one of the following: an HTTP status code 204,
+      # which indicates success or an error message.
+      #
+      # ==== Example
+      #
+      #    response = client.queue_report 'example_report'
+      def queue_report(name)
+        response = @conn.get do |req|
+          req.url 'arborws/reports/queue'
+          req.params['api_key'] = @api_key
+          req.params['name'] = name
+        end
+
+        response
+      end
+
+      # Allows you to view a list of wizard report results that can be
+      # downloaded from Peakflow SP.
+      #
+      # == Parameters:
+      # - filter: (Optional) Keywords by which you want to filter search
+      # results. You can enter the same search strings that you can enter in
+      # the Search box on the Alerts pages in the Web UI.
+      # - limit: (Optional) The maximum number of alerts to return that match
+      # the filter.
+      # - format: The format in which you want the data returned:
+      # 'json' or 'xml'
+      #
+      # ==== Example
+      #
+      #    response = client.report_results
+      def report_results(filter = nil, limit = nil, format = 'json')
+        response = @conn.get do |req|
+          req.url 'arborws/reports/results'
+          req.params['api_key'] = @api_key
+          req.params['format'] = format
+          req.params['filter'] = filter unless filter.nil?
+          req.params['limit'] = limit unless limit.nil?
+        end
+
+        response
+      end
+
+      # Allows you to download a completed wizard report.
+      #
+      # == Parameters:
+      # - name: The name of the configured wizard report result that you want
+      # to download.
+      # - request_time: The time of the wizard report result that you want to
+      # download, which can be one of the following: last (The "last" parameter
+      # downloads the most recent wizard report result), time (the "time"
+      # parameter is the time at which a wizard report ran, in seconds and
+      # microseconds since the epoch.)
+      # - format: The format in which you want a wizard report returned, which
+      # can be one of the following: "PDF", "XML", "CSV".
+      #
+      # ==== Example
+      #
+      #    response = client.download_report 'myReport', 'last', 'PDF'
+      def download_report(name, request_time, format)
+        response = @conn.get do |req|
+          req.url 'arborws/reports/configured'
+          req.params['api_key'] = @api_key
+          req.params['name'] = name
+          req.params['request_time'] = request_time
+          req.params['format'] = format
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/arbor_peakflow_ruby/actions/routers.rb

@@ -0,0 +1,29 @@
+module Arbor
+  module Peakflow
+    module Routers
+      # The routers function allow syou to view router configuration in JSON
+      # format.
+      #
+      # == Parameters:
+      # - action: One of the following actions that you want to initiate:
+      # list, show_schema, update.
+      # - filter: (Optional) Keywords by which you want to filter search
+      # results. You can enter the same search strings that you can enter in
+      # the Search box on the Configure Routers page in the Web UI.
+      #
+      # ==== Example
+      #
+      #    response = client.routers 'show_schema'
+      def routers(action, filter = nil)
+        response = @conn.get do |req|
+          req.url 'arborws/admin/routers'
+          req.params['api_key'] = @api_key
+          req.params['action'] = action
+          req.params['filter'] = filter unless filter.nil?
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/arbor_peakflow_ruby/actions/tms_appliance.rb

@@ -0,0 +1,29 @@
+module Arbor
+  module Peakflow
+    module TMS_Appliance
+      # The TMS function allows you to view and update TMS appliance
+      # configurations in JSON format.
+      #
+      # == Parameters:
+      # - action: One of the following actions that you want to initiate:
+      # list, show_schema, update.
+      # - filter: (Optional) Keywords by which you want to filter search
+      # results. You can enter the same search strings that you can enter in
+      # the Search box on the Configure Routers page in the Web UI.
+      #
+      # ==== Example
+      #
+      #    response = client.tms_appliance 'show_schema'
+      def tms_appliance(action, filter = nil)
+        response = @conn.get do |req|
+          req.url 'arborws/admin/tms'
+          req.params['api_key'] = @api_key
+          req.params['action'] = action
+          req.params['filter'] = filter unless filter.nil?
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/arbor_peakflow_ruby/actions/tms_ports.rb

@@ -0,0 +1,20 @@
+module Arbor
+  module Peakflow
+    module TMS_Ports
+      # The TMS Ports function allows you to view TMS appliance port data in
+      # JSON format.
+      #
+      # ==== Example
+      #
+      #    response = client.tms_ports
+      def tms_ports
+        response = @conn.get do |req|
+          req.url 'arborws/admin/tms_ports'
+          req.params['api_key'] = @api_key
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/arbor_peakflow_ruby/actions/traffic.rb

@@ -0,0 +1,30 @@
+module Arbor
+  module Peakflow
+    module Traffic
+      # The traffic function allows you to search for and retrieve XML traffic
+      # data.
+      #
+      # == Parameters:
+      # - query: An XML query in standard Peakflow SP XML query format. This
+      # parameter is only the XML query, not an entire XML report. Data is
+      # returned in the XML result format, as specified in the _Peakflow SP and
+      # Threat Management System (TMS) User Guide_. For current report
+      # specifications, see "Using Cusomized Reports" in the _Peakflow SP and
+      # Threat Management System (TMS) User Guide_.
+      # - graph: (Optional) When specified, this parameter indicates that you
+      # want Peakflow SP to return a binary PNG graph file of the queried
+      # traffic data. If you do not specify a graph argument, then Peakflow SP
+      # returns XML.
+      def traffic(query, graph = nil)
+        response = @conn.get do |req|
+          req.url 'arborws/traffic'
+          req.params['api_key'] = @api_key
+          req.params['query'] = query
+          req.params['graph'] = graph unless graph.nil?
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/arbor_peakflow_ruby/client.rb

@@ -0,0 +1,58 @@
+require 'arbor_peakflow_ruby/actions/alerts'
+require 'arbor_peakflow_ruby/actions/cp5500'
+require 'arbor_peakflow_ruby/actions/managed_object'
+require 'arbor_peakflow_ruby/actions/mitigations'
+require 'arbor_peakflow_ruby/actions/reports'
+require 'arbor_peakflow_ruby/actions/routers'
+require 'arbor_peakflow_ruby/actions/tms_appliance'
+require 'arbor_peakflow_ruby/actions/tms_ports'
+require 'arbor_peakflow_ruby/actions/traffic'
+require 'faraday'
+require 'json'
+
+module Arbor
+  module Peakflow
+    # == Client
+    # The Arbor Peakflow client in charge of using Faraday to communicate with
+    # the Arbor devices.
+    #
+    #  == Parameters
+    # - hosts, host, urls, or url: The location of the Arbor Peakflow
+    # device cluster
+    # - api_key: The API key to be used when communicating with the Arbor
+    # Peakflow API.
+    #
+    # ==== Example
+    #
+    #    client = Arbor::Peaklfow::Client.new host: 'http://my.arbor.device/'
+    #                                         api_key: 'myApiKeyHere123'
+    class Client
+      include Arbor::Peakflow::Alerts
+      include Arbor::Peakflow::CP5500
+      include Arbor::Peakflow::Managed_Object
+      include Arbor::Peakflow::Mitigations
+      include Arbor::Peakflow::Reports
+      include Arbor::Peakflow::Routers
+      include Arbor::Peakflow::TMS_Appliance
+      include Arbor::Peakflow::TMS_Ports
+      include Arbor::Peakflow::Traffic
+
+      attr_reader :hosts, :api_key
+      def initialize(arguments = {})
+        @hosts = arguments[:hosts] || \
+                 arguments[:host]  || \
+                 arguments[:url]   || \
+                 arguments[:urls]  || \
+                 ENV.fetch('PEAKFLOW_URL')
+
+        @api_key ||= arguments[:api_key]
+
+        @conn = Faraday.new(@hosts, ssl: { verify: false }) do |faraday|
+          faraday.request :url_encoded
+          # faraday.response :logger
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/arbor_peakflow_ruby/version.rb

@@ -0,0 +1,5 @@
+module Arbor
+  module Peakflow
+    VERSION = '1.0.0'
+  end
+end

data/lib/arbor_peakflow_ruby.rb

@@ -0,0 +1,7 @@
+require 'arbor_peakflow_ruby/version'
+require 'arbor_peakflow_ruby/client'
+
+module Arbor
+  module Peakflow
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: arbor_peakflow_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kevin Kirsche
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-26 00:00:00.000000000 Z
+dependencies: []
+description: Provides access to the Arbor Peakflow SP 6.0 HTTPS API
+email:
+- kevin.kirsche@verizon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- arbor_peakflow_ruby.gemspec
+- bin/console
+- bin/setup
+- lib/arbor_peakflow_ruby.rb
+- lib/arbor_peakflow_ruby/actions/alerts.rb
+- lib/arbor_peakflow_ruby/actions/cp5500.rb
+- lib/arbor_peakflow_ruby/actions/managed_object.rb
+- lib/arbor_peakflow_ruby/actions/mitigations.rb
+- lib/arbor_peakflow_ruby/actions/reports.rb
+- lib/arbor_peakflow_ruby/actions/routers.rb
+- lib/arbor_peakflow_ruby/actions/tms_appliance.rb
+- lib/arbor_peakflow_ruby/actions/tms_ports.rb
+- lib/arbor_peakflow_ruby/actions/traffic.rb
+- lib/arbor_peakflow_ruby/client.rb
+- lib/arbor_peakflow_ruby/version.rb
+homepage: https://github.com/kkirsche/arbor-peakflow-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Arbor Peakflow 6.0 API interaction gem
+test_files: []