security_guard 0.0.6 → 0.0.7

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+  - ree

data/README.md

@@ -1,4 +1,4 @@
-# SecurityGuard
+# SecurityGuard [![Build Status](https://secure.travis-ci.org/fredwu/security_guard.png?branch=master)](http://travis-ci.org/fredwu/security_guard) [![Dependency Status](https://gemnasium.com/fredwu/security_guard.png)](https://gemnasium.com/fredwu/security_guard)
 
 This gem is a collection of useful tools for auditing data and performing security checks.
 
@@ -48,11 +48,10 @@ country_ips = SecurityGuard::CountryIps.new(
 Returns a list of the IPs from given country and IP dictionaries. Useful for auditing IPs from higher risk nations.
 
 ```ruby
-country_ips = SecurityGuard::CountryIps.new(
+SecurityGuard::CountryIps.new(
   :countries => ['Australia'],
   :ips       => ['4.4.4.4', '8.8.8.8', '203.206.0.1']
-)
-country_ips.result # => ['203.206.0.1']
+).result # => ['203.206.0.1']
 ```
 
 You may also pass country and IP data as a line-delimited file by appending `_from_file` at the end of the attributes:
@@ -73,6 +72,17 @@ SecurityGuard::Deduplication.new(
 ).process
 ```
 
+### Sequences
+
+Prepends line-delimited content with a comma-delimited sequence column (1, 2, 3...) for counting.
+
+```ruby
+SecurityGuard::Sequences.new(
+  :input_folder  => '/path/to/the/input/folder',
+  :output_folder => '/path/to/the/output/folder'
+).process
+```
+
 ## Changelog
 
 ### v0.0.6 [2012-03-07]

data/bin/sguard

@@ -39,6 +39,20 @@ module SecurityGuard
     end
   end
 
+  class SequencesCommand < Clamp::Command
+    parameter 'input_folder', 'folder containing the input files'
+    parameter 'output_folder', 'folder for outputing deduped files'
+
+    def execute
+      SecurityGuard::Sequences.new(
+        :input_folder  => input_folder,
+        :output_folder => output_folder
+      ).process
+
+      ap "Sequences results published to '#{output_folder}'."
+    end
+  end
+
   class MainCommand < Clamp::Command
     def self.output_result(result, output_path)
       `echo #{result} > #{output_path}`
@@ -52,6 +66,10 @@ module SecurityGuard
     subcommand 'deduplication',
                'Deduplicates content contained within a list of files.',
                SecurityGuard::DeduplicationCommand
+
+    subcommand 'sequences',
+               'Prepends line-delimited content with a sequence column (1, 2, 3...) for counting.',
+               SecurityGuard::SequencesCommand
   end
 end
 

data/lib/security_guard.rb

@@ -3,5 +3,7 @@ require 'security_guard/utils/files'
 require 'security_guard/utils/geo_ips'
 require 'security_guard/concerns/accepts_from_file'
 require 'security_guard/concerns/initializable'
+require 'security_guard/concerns/input_to_output'
 require 'security_guard/country_ips'
 require 'security_guard/deduplication'
+require 'security_guard/sequences'

data/lib/security_guard/concerns/input_to_output.rb

@@ -0,0 +1,41 @@
+module SecurityGuard
+  module Concerns
+    module InputToOutput
+      def input_to_output(args)
+        input_data, filenames = read_data_from(args[:input])
+
+        output_data = send(args[:process], input_data)
+
+        write_data_to args[:output],
+                      :output_data => output_data,
+                      :filenames   => filenames
+      end
+
+      private
+
+      def read_data_from(folder)
+        files = Dir["#{folder}/*"].sort
+
+        raise Exception.new('Input folder is invalid or is empty.') if files.empty?
+
+        input_data = []
+        filenames  = []
+
+        files.each do |file|
+          input_data << File.readlines(file).map{ |line| line.downcase.strip }
+          filenames  << File.basename(file)
+        end
+
+        [input_data, filenames]
+      end
+
+      def write_data_to(folder, opts)
+        opts[:output_data].each_with_index do |array, index|
+          File.open("#{folder}/#{opts[:filenames][index]}", 'w') do |f|
+            f.puts array
+          end
+        end
+      end
+    end
+  end
+end

data/lib/security_guard/deduplication.rb

@@ -1,45 +1,21 @@
 module SecurityGuard
   class Deduplication
     include Concerns::Initializable
+    include Concerns::InputToOutput
 
     initializable :input_folder, :output_folder
-    attr_accessor :source_data, :deduped_data, :filenames
-
-    def initialize(args = nil)
-      @source_data  ||= []
-      @deduped_data ||= []
-      @filenames    ||= []
-      initializable_attrs args
-    end
 
     def process
-      read_data_from input_folder
-      dedupe source_data
-      write_data_to output_folder
+      input_to_output :input   => input_folder,
+                      :output  => output_folder,
+                      :process => :dedupe
     end
 
     private
 
-    def read_data_from(folder)
-      files = Dir["#{folder}/*"].sort
-
-      raise Exception.new('Input folder is invalid or is empty.') if files.empty?
-
-      files.each do |file|
-        filenames   << File.basename(file)
-        source_data << File.readlines(file).map{ |line| line.downcase.strip }
-      end
-    end
-
-    def write_data_to(folder)
-      deduped_data.each_with_index do |array, index|
-        File.open("#{folder}/#{filenames[index]}", 'w') do |f|
-          f.puts array
-        end
-      end
-    end
-
     def dedupe(data)
+      deduped_data = []
+
       # start from the lowest array (in terms of dedupe priority)
       data.reverse!
       data_original = data.clone
@@ -47,9 +23,10 @@ module SecurityGuard
         data.shift
         deduped_data << _deduped_multi(array, data)
       end
+
       # the top array doesn't need to be compared, just needs to be unique
       deduped_data.last.uniq!
-      deduped_data.reverse!
+      deduped_data.reverse
     end
 
     def _deduped_multi(target, others)

data/lib/security_guard/sequences.rb

@@ -0,0 +1,27 @@
+module SecurityGuard
+  class Sequences
+    include Concerns::Initializable
+    include Concerns::InputToOutput
+
+    initializable :input_folder, :output_folder
+
+    def process
+      input_to_output :input   => input_folder,
+                      :output  => output_folder,
+                      :process => :prepend_sequencial_numbers
+    end
+
+    private
+
+    def prepend_sequencial_numbers(data)
+      data_with_sequences = []
+      data.each_with_index do |array, index|
+        data_with_sequences[index] = []
+        array.each_with_index do |entry, i|
+          data_with_sequences[index] << "#{i}, #{entry}"
+        end
+      end
+      data_with_sequences
+    end
+  end
+end

data/lib/security_guard/version.rb

@@ -1,3 +1,3 @@
 module SecurityGuard
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/security_guard.gemspec

@@ -3,10 +3,10 @@ require File.expand_path('../lib/security_guard/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ['Fred Wu']
-  gem.email         = ['fred.wu@sitepoint.com']
+  gem.email         = ['ifredwu@gmail.com']
   gem.summary       = %q{A collection of useful tools for auditing data and performing security checks.}
   gem.description   = gem.summary
-  gem.homepage      = 'https://github.com/sitepoint/security_guard'
+  gem.homepage      = 'https://github.com/fredwu/security_guard'
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")

data/specs/concerns/input_to_output_spec.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class TestInputToOutput
+  include SecurityGuard::Concerns::Initializable
+  include SecurityGuard::Concerns::InputToOutput
+
+  initializable :input_folder, :output_folder
+
+  def process
+    input_to_output :input   => input_folder,
+                    :output  => output_folder,
+                    :process => :reverse
+  end
+
+  def reverse(data)
+    data.each do |lines|
+      lines.reverse!
+    end
+    data
+  end
+end
+
+describe SecurityGuard::Concerns::InputToOutput do
+  let :test_io do
+    TestInputToOutput.new(
+      :input_folder  => fixture_file('dedupe_lists/'),
+      :output_folder => fixture_file('../tmp/')
+    )
+  end
+
+  let :input_data do
+    [
+      [1, 2, 3],
+      [4, 5],
+      [6, 7],
+    ]
+  end
+
+  before do
+    `rm -rf #{fixture_file('../tmp/*')}`
+  end
+
+  it 'reads data from the input folder' do
+    input_data, filenames = test_io.send :read_data_from, fixture_file('dedupe_lists/')
+    input_data.must_equal input_data
+  end
+
+  it 'records filenames' do
+    input_data, filenames = test_io.send :read_data_from, fixture_file('dedupe_lists/')
+    filenames.must_equal ['a.txt', 'b.txt', 'c.txt']
+  end
+
+  it 'writes data to the output folder' do
+    test_io.send(:write_data_to,
+      fixture_file('../tmp/'),
+      :filenames   => ['a.txt', 'b.txt'],
+      :output_data => [
+        [1, 2, 3],
+        [4, 5, 6],
+      ]
+    )
+
+    File.read(fixture_file('../tmp/a.txt')).must_equal "1\n2\n3\n"
+    File.read(fixture_file('../tmp/b.txt')).must_equal "4\n5\n6\n"
+  end
+
+  it 'reads input and writes output' do
+    test_io.process
+
+    File.read(fixture_file('../tmp/a.txt')).must_equal "c@example.com\nc@example.com\nb@example.com\na@example.com\n"
+    File.read(fixture_file('../tmp/b.txt')).must_equal "d@example.com\nb@example.com\n"
+    File.read(fixture_file('../tmp/c.txt')).must_equal "e@example.com\nd@example.com\nc@example.com\n"
+  end
+end

data/specs/deduplication_spec.rb

@@ -20,28 +20,6 @@ describe SecurityGuard::Deduplication do
     `rm -rf #{fixture_file('../tmp/*')}`
   end
 
-  it 'reads data from the input folder' do
-    dedupe.send :read_data_from, fixture_file('dedupe_lists/')
-    dedupe.source_data.must_equal source_data
-  end
-
-  it 'records filenames' do
-    dedupe.send :read_data_from, fixture_file('dedupe_lists/')
-    dedupe.send(:filenames).must_equal ['a.txt', 'b.txt', 'c.txt']
-  end
-
-  it 'writes data to the output folder' do
-    dedupe.send :filenames=, ['a.txt', 'b.txt']
-    dedupe.deduped_data = [
-      [1, 2, 3],
-      [4, 5, 6],
-    ]
-    dedupe.send :write_data_to, fixture_file('../tmp/')
-
-    File.read(fixture_file('../tmp/a.txt')).must_equal "1\n2\n3\n"
-    File.read(fixture_file('../tmp/b.txt')).must_equal "4\n5\n6\n"
-  end
-
   it 'reads input and writes output' do
     dedupe.process
 
@@ -53,7 +31,7 @@ describe SecurityGuard::Deduplication do
   it 'dedupes an array with another array' do
     dedupe.send(:_deduped,
       ['a@example.com', 'b@example.com', 'c@example.com', 'c@example.com'],
-      ['b@example.com', 'd@example.com'],
+      ['b@example.com', 'd@example.com']
     ).must_equal ['a@example.com', 'c@example.com']
   end
 
@@ -68,8 +46,7 @@ describe SecurityGuard::Deduplication do
   end
 
   it 'dedupes the source data' do
-    dedupe.send :dedupe, source_data
-    dedupe.deduped_data.must_equal [
+    dedupe.send(:dedupe, source_data).must_equal [
       ['a@example.com', 'b@example.com', 'c@example.com'],
       ['d@example.com'],
       ['e@example.com'],

data/specs/sequences_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe SecurityGuard::Sequences do
+  let :sequences do
+    SecurityGuard::Sequences.new(
+      :input_folder  => fixture_file('dedupe_lists/'),
+      :output_folder => fixture_file('../tmp/')
+    )
+  end
+
+  let :source_data do
+    [
+      ['a@example.com', 'b@example.com', 'c@example.com', 'c@example.com'],
+      ['b@example.com', 'd@example.com'],
+      ['c@example.com', 'd@example.com', 'e@example.com'],
+    ]
+  end
+
+  before do
+    `rm -rf #{fixture_file('../tmp/*')}`
+  end
+
+  it 'reads input and writes output' do
+    sequences.process
+
+    File.read(fixture_file('../tmp/a.txt')).must_equal "0, a@example.com\n1, b@example.com\n2, c@example.com\n3, c@example.com\n"
+    File.read(fixture_file('../tmp/b.txt')).must_equal "0, b@example.com\n1, d@example.com\n"
+    File.read(fixture_file('../tmp/c.txt')).must_equal "0, c@example.com\n1, d@example.com\n2, e@example.com\n"
+  end
+
+  it 'prepends sequencial numbers to each item' do
+    sequences.send(:prepend_sequencial_numbers, source_data).must_equal [
+      ['0, a@example.com', '1, b@example.com', '2, c@example.com', '3, c@example.com'],
+      ['0, b@example.com', '1, d@example.com'],
+      ['0, c@example.com', '1, d@example.com', '2, e@example.com'],
+    ]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: security_guard
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-07 00:00:00.000000000 Z
+date: 2012-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
-  requirement: &70344773855680 !ruby/object:Gem::Requirement
+  requirement: &70245692555440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70344773855680
+  version_requirements: *70245692555440
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70344773855260 !ruby/object:Gem::Requirement
+  requirement: &70245692554980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70344773855260
+  version_requirements: *70245692554980
 - !ruby/object:Gem::Dependency
   name: geoip
-  requirement: &70344773854840 !ruby/object:Gem::Requirement
+  requirement: &70245692554480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70344773854840
+  version_requirements: *70245692554480
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70344773854420 !ruby/object:Gem::Requirement
+  requirement: &70245692553840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70344773854420
+  version_requirements: *70245692553840
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70344773854000 !ruby/object:Gem::Requirement
+  requirement: &70245692553160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70344773854000
+  version_requirements: *70245692553160
 - !ruby/object:Gem::Dependency
   name: minitest-colorize
-  requirement: &70344773853580 !ruby/object:Gem::Requirement
+  requirement: &70245692551760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,17 +76,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70344773853580
+  version_requirements: *70245692551760
 description: A collection of useful tools for auditing data and performing security
   checks.
 email:
-- fred.wu@sitepoint.com
+- ifredwu@gmail.com
 executables:
 - sguard
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -96,14 +97,17 @@ files:
 - lib/security_guard.rb
 - lib/security_guard/concerns/accepts_from_file.rb
 - lib/security_guard/concerns/initializable.rb
+- lib/security_guard/concerns/input_to_output.rb
 - lib/security_guard/country_ips.rb
 - lib/security_guard/deduplication.rb
+- lib/security_guard/sequences.rb
 - lib/security_guard/utils/files.rb
 - lib/security_guard/utils/geo_ips.rb
 - lib/security_guard/version.rb
 - security_guard.gemspec
 - specs/concerns/accepts_from_file_spec.rb
 - specs/concerns/initializable_spec.rb
+- specs/concerns/input_to_output_spec.rb
 - specs/country_ips_spec.rb
 - specs/deduplication_spec.rb
 - specs/fixtures/countries.txt
@@ -111,11 +115,12 @@ files:
 - specs/fixtures/dedupe_lists/b.txt
 - specs/fixtures/dedupe_lists/c.txt
 - specs/fixtures/ip_addresses.txt
+- specs/sequences_spec.rb
 - specs/spec_helper.rb
 - specs/tmp/.gitkeep
 - specs/utils/files_spec.rb
 - specs/utils/geo_ips_spec.rb
-homepage: https://github.com/sitepoint/security_guard
+homepage: https://github.com/fredwu/security_guard
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -129,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2907249137378969452
+      hash: -3598287692275573134
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -138,10 +143,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2907249137378969452
+      hash: -3598287692275573134
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: A collection of useful tools for auditing data and performing security checks.