pcaprub_helper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24f0791508cb1079b631f67eba8609ed7a82a2b1
+  data.tar.gz: eea6ae08badb9663907dba96ff021b4e56f8d5de
+SHA512:
+  metadata.gz: 46d133364eaa869be71446d2e0bb8be4dba5e34d72aef304c910e38d89603f01db2a414528c10992415e68bf2cc5f26022f40cce371b420d9d885c175f31c9a0
+  data.tar.gz: 9f3f985cb2c72e5ea3e8323c022608efbf9afdd19e32179880993919daadde63509df24d6cc2573fe397374de6741ab75eea0719573b69ba3e452df3340cea14

data/History.md

@@ -0,0 +1,21 @@
+# History
+## Released Versions
+### Version 0.0.1
+#### Patch: Inital code
+##### Added
+ - Travis Yml
+ - History(this file)
+ - Rakefile
+ - Gemspec
+ - Gemfile
+ - Inital code
+   - PcaprubHelper module
+   - PcaprubHelper::DSL module
+   - PcaprubHelper version constants
+ - Inital tests
+   - Helper
+   - PcaprubHelper spec
+
+##### Updated
+ - Readme
+ - Git ignore

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Ben Slaughter
+
+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,17 @@
+pcaprub_helper
+==============
+
+[![Code Climate](https://codeclimate.com/github/benSlaughter/pcaprub_helper/badges/gpa.svg)](https://codeclimate.com/github/benSlaughter/pcaprub_helper)
+[![Build Status](https://travis-ci.org/benSlaughter/pcaprub_helper.svg?branch=master)](https://travis-ci.org/benSlaughter/pcaprub_helper)
+[![Dependency Status](https://gemnasium.com/benSlaughter/pcaprub_helper.svg)](https://gemnasium.com/benSlaughter/pcaprub_helper)
+[![Test Coverage](https://codeclimate.com/github/benSlaughter/pcaprub_helper/badges/coverage.svg)](https://codeclimate.com/github/benSlaughter/pcaprub_helper)
+[![Coverage Status](https://img.shields.io/coveralls/benSlaughter/pcaprub_helper.svg)](https://coveralls.io/r/benSlaughter/pcaprub_helper)
+
+Helper methods built on top of pcaprub
+
+## Installation
+
+    Gem install pcaprub_helper
+
+## Helpful docs
+[Help with creating filters](http://www.tcpdump.org/manpages/pcap-filter.7.html)

data/lib/pcaprub_helper.rb

@@ -0,0 +1,95 @@
+require 'pcaprub'
+require 'uri'
+
+# helper module for pcaprub
+module PcaprubHelper
+  class << self
+    attr_reader :cap, :last_cap
+    attr_accessor :interface, :snaplen, :promisc, :timeout
+    attr_accessor :filter, :url_filter
+
+    def configure
+      yield self
+    end
+
+    def capture_this
+      build_capture
+      yield
+      @last_cap = parse_capture
+      destroy_capture
+    end
+
+    def verify_query_string(**kwargs)
+      return false unless @last_cap
+
+      @last_cap.each do |packet|
+        kwargs.each do |key, value|
+          return false unless packet =~ query_string_validator(key, value)
+        end
+      end
+
+      true
+    end
+
+    def verify_path_string(*args)
+      return false unless @last_cap
+
+      @last_cap.each do |packet|
+        args.each do |value|
+          return false unless packet =~ path_string_validator(value)
+        end
+      end
+
+      true
+    end
+
+    def look_up_device
+      PCAPRUB::Pcap.lookupdev
+    rescue PCAPRUB::BindingError
+      puts "lookupdev : no suitable device found, defaulting to 'en0'"
+      'en0'
+    end
+
+    private
+
+    def query_string_validator(key, value)
+      /(\&|\?)#{key}[\[\]]{0,2}=#{value}(\&|\s)/i
+    end
+
+    def path_string_validator(value)
+      %r{\/#{value}\/i}
+    end
+
+    def build_capture
+      @cap = PCAPRUB::Pcap.open_live(@interface, @snaplen, @promisc, @timeout)
+      @cap.setfilter(@filter || '')
+    end
+
+    def destroy_capture
+      @cap.close
+      @cap = nil
+    end
+
+    def parse_capture
+      packets = []
+      loop do
+        packet = @cap.next
+        break unless packet
+        next unless filter(packet)
+        packets << URI.decode(packet)
+      end
+      packets
+    end
+
+    def filter(packet)
+      @url_filter ? packet =~ @url_filter : true
+    end
+  end
+end
+
+PcaprubHelper.configure do |config|
+  config.interface = config.look_up_device
+  config.snaplen   = 65_535
+  config.promisc   = true
+  config.timeout   = 0
+end

data/lib/pcaprub_helper/dsl.rb

@@ -0,0 +1,19 @@
+require 'pcaprub_helper'
+
+# helper module for pcaprub
+module PcaprubHelper
+  # DSL module can be included for Pcaprub helper
+  module DSL
+    def capture_this(&block)
+      PcaprubHelper.capture_this(&block)
+    end
+
+    def verify_query_string(**kwargs)
+      PcaprubHelper.verify_query_string(kwargs)
+    end
+
+    def verify_path_string(*args)
+      PcaprubHelper.verify_path_string(args)
+    end
+  end
+end

data/lib/pcaprub_helper/version.rb

@@ -0,0 +1,5 @@
+# helper module for pcaprub
+module PcaprubHelper
+  VERSION = '0.0.1'
+  DATE    = '2014-10-21'
+end

data/spec/helper.rb

@@ -0,0 +1,11 @@
+require 'codeclimate-test-reporter'
+require 'coveralls'
+Coveralls.wear!
+CodeClimate::TestReporter.start
+
+require 'pcaprub_helper/dsl'
+
+RSpec.configure do |config|
+  config.color     = true
+  config.formatter = :documentation
+end

data/spec/pcaprub_helper_spec.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+describe PcaprubHelper do
+  it 'is a module' do
+    expect(PcaprubHelper).to be_a Module
+  end
+
+  describe PcaprubHelper::DSL do
+    it 'is a module' do
+      expect(PcaprubHelper::DSL).to be_a Module
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: pcaprub_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Slaughter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pcaprub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Helper methods for pcaprub making life easy.
+email: b.p.slaughter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- History.md
+- LICENSE
+- README.md
+- lib/pcaprub_helper.rb
+- lib/pcaprub_helper/dsl.rb
+- lib/pcaprub_helper/version.rb
+- spec/helper.rb
+- spec/pcaprub_helper_spec.rb
+homepage: http://benslaughter.github.io/pcaprub_helper/
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A group of helper methods for pcaprub
+test_files:
+- spec/helper.rb
+- spec/pcaprub_helper_spec.rb
+has_rdoc: