bluecoat 0.0.4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bluecoat.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Lothar Handl
+
+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,67 @@
+# Bluecoat
+
+This gem provides an interface from ruby to Blue Coat Boxes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bluecoat'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bluecoat
+
+## Usage
+
+    require 'bluecoat'
+
+### connect to ProxySG Box
+    sg = BlueCoat::SG.new({
+      :host => "bluecoatsg.local",
+      :user => "admin",
+      :pass => "password"
+    })
+
+### fetch whole policy
+    policy = sg.fetch_policy
+
+### fetch a defined subnet
+    subnet = sg.fetch_subnet "subnet1"
+
+
+### connect to Reporter
+    bc = BlueCoat::Reporter.new({
+      :host => "bluecatreporter.local",
+      :user => "admin",
+      :pass => "password",
+      :role => "admin"    # choose existant role on reporter
+    })
+
+### fetch a report from reporter through WEB API
+
+Give parameters as specified by the Blue Coat Reporter WEB API. The result
+is a two dimensional array rows/columns.
+
+    result = bc.fetch_report({
+      :database => "databasename",
+      :columns => "total_bytes",
+      :sort => "total_bytes",
+      :summarizeBy => "c_ip",
+      :rows => 100,
+      :dateRelativeUnit => :month,
+      :dateStart => -1,
+      :dateEnd => 0
+    })
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bluecoat.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bluecoat/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Lothar Handl"]
+  gem.email         = ["lothar.handl@3beg.at"]
+  gem.description   = %q{A bundle of functions for accessing Blue Coat Appliances. I.e. Reporter, ProxySG, etc.}
+  gem.summary       = %q{A bundle of functions for accessing Blue Coat Appliances.}
+  gem.homepage      = "https://github.com/terracor/bluecoat"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "bluecoat"
+  gem.require_paths = ["lib"]
+  gem.version       = Bluecoat::VERSION
+  gem.add_dependency(%q{mechanize})
+  gem.add_dependency(%q{ipaddress})
+end

data/lib/bluecoat/reporter.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+require 'open-uri'
+require 'cgi'
+require 'uri'
+require 'csv'
+require 'mechanize'
+
+
+# the class is extended by a function to_query which converts the hash to an URI-String
+class Hash
+  # converts hash to URI parameter string
+  def to_query
+    elements = []
+    keys.size.times do |i|
+      elements << "#{keys[i]}=#{values[i]}"
+    end
+    elements.join('&')
+  end
+end
+
+
+module BlueCoat
+  # this class provides methods to query blue coat reporter
+  class Reporter
+    # constructor
+    def initialize(options = {})
+      # concat URL-string
+      @connect = "https://#{options[:host]}:8082/api/"
+      @credentials = "?username=#{options[:user]}&password=#{options[:pass]}&role=#{options[:role]}"
+    end
+
+
+    # triggers the Blue Coat Reporter to send a PDF report by email.
+    def mail_report(params)
+      # default Parameter fuers Hash
+      params[:label] ||= "unspecified report"
+      file = open "#{@connect}create#{@credentials}&action=email&format=pdf&#{URI.escape(params.to_query, "| ")}", :proxy => nil
+      report_id = file.gets.split(":")[1]
+      file.close
+
+      # wait for report
+      status = ""
+      begin
+        sleep 1
+        file = open "#{@connect}status#{@credentials}&reportId=#{report_id}", :proxy => nil
+        file.gets
+        file.gets
+        status = file.gets.split(":")[1]
+        file.close
+      end while status == "Running\n"
+
+      # clear open report request from reporter
+      file = open "#{@connect}cancel#{@credentials}&reportId=#{report_id}", :proxy => nil
+      file.close
+    end
+
+
+    # fetches a report from the Blue Coat Reporter. The report is returned in a two-dimensional array.
+    # params are as by Blue Coat Reporter WEB API
+    def fetch_report(params)
+      # default Parameter fuers Hash
+      params[:label] ||= "unspecified report"
+
+      # start report
+      file = open "#{@connect}create#{@credentials}&action=download&format=csv&#{URI.escape(params.to_query, "| ")}", :proxy => nil
+      report_id = file.gets.split(":")[1]
+      file.close
+
+      # wait for report
+      status = ""
+      begin
+        sleep 1
+        file = open "#{@connect}status#{@credentials}&reportId=#{report_id}", :proxy => nil
+        file.gets
+        file.gets
+        status = file.gets.split(":")[1]
+        file.close
+      end while status == "Running\n"
+
+      # fetch ready report
+      file = open "#{@connect}download#{@credentials}&reportId=#{report_id}", :proxy => nil
+      rc = file.readlines.join("")
+      file.close
+
+      # parse csv and convert to array
+      rc = CSV.parse(rc).to_a
+
+      # clear open report request from reporter
+      file = open "#{@connect}cancel#{@credentials}&reportId=#{report_id}", :proxy => nil
+      file.close
+
+      # remove headline from array
+      rc.slice!(0)
+
+      # convert all found integer-strings to intergers
+      rc.map do |row|
+        row.map do |col|
+          begin
+            oldcol = col
+            col = Integer(col)
+          rescue
+            col = oldcol
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bluecoat/sg.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+require 'open-uri'
+require 'cgi'
+require 'uri'
+require 'mechanize'
+require 'ipaddress'
+
+
+# the class is extended by a function to_query which converts the hash to an URI-String
+class Hash
+  # converts hash to URI parameter string
+  def to_query
+    elements = []
+    keys.size.times do |i|
+      elements << "#{keys[i]}=#{values[i]}"
+    end
+    elements.join('&')
+  end
+end
+
+
+module BlueCoat
+  # this class provides methods to query blue coat sg
+  class SG
+    # constructor connects to bluecoat sg
+    # options are: :host, :port, :username and :password
+    def initialize(options = {})
+      @host = options[:host]
+      @port = options[:port].nil? ? "8082" : options[:port]
+      @user = options[:user]
+      @pass = options[:pass]
+    end
+
+    # fetches the whole policy from blue coat sg
+    def fetch_policy(options = {})
+      if @policy.nil? || options[:no_caching] then
+        mech = Mechanize.new
+        mech.auth(@user, @pass)
+        page = mech.get("https://#{@host}:#{@port}/Policy/Current")
+        @policy = page.parser.xpath('/html/body/pre').inner_text
+      end
+      @policy
+    end
+
+    # fetches a subnet definition from the policy, an array of ip addresses and subnets is returned
+    def fetch_subnet(name, options = {})
+       rc = []
+       policy = fetch_policy(options)
+       policy.scan(/define subnet "#{name}"(.+?)end/m)
+       rc += $1.delete("\r\n").split(" ").map{|s| IPAddress s} if !$1.nil?
+       policy.scan(/define subnet #{name}(.+?)end/m)
+       rc += $1.delete("\r\n").split(" ").map{|s| IPAddress s} if !$1.nil?
+       rc
+    end
+  end
+end
+

data/lib/bluecoat/version.rb

@@ -0,0 +1,3 @@
+module Bluecoat
+  VERSION = "0.0.4"
+end

data/lib/bluecoat.rb

@@ -0,0 +1,14 @@
+require 'bluecoat/version'
+require 'bluecoat/sg'
+require 'bluecoat/reporter'
+require 'openssl'
+
+# disable SSL certificate validation
+module OpenSSL
+  # disable SSL certificate validation
+  module SSL
+    remove_const :VERIFY_PEER
+    VERIFY_PEER = VERIFY_NONE
+  end
+end
+

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: bluecoat
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Lothar Handl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A bundle of functions for accessing Blue Coat Appliances. I.e. Reporter,
+  ProxySG, etc.
+email:
+- lothar.handl@3beg.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bluecoat.gemspec
+- lib/bluecoat.rb
+- lib/bluecoat/reporter.rb
+- lib/bluecoat/sg.rb
+- lib/bluecoat/version.rb
+homepage: https://github.com/terracor/bluecoat
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A bundle of functions for accessing Blue Coat Appliances.
+test_files: []