security_guard 0.0.2 → 0.0.3

data/README.md

@@ -24,6 +24,23 @@ There is an `sguard` command if you intend to use security_guard as a command li
 
     sguard -h
 
+### Tips
+
+You can pass in setters during initialisation, for example:
+
+```ruby
+country_ips = SecurityGuard::CountryIps.new
+country_ips.countries = ['Australia', 'United Kingdom']
+country_ips.ips = ['4.4.4.4', '8.8.8.8', '203.206.0.1']
+
+# the above is equivalent to:
+
+country_ips = SecurityGuard::CountryIps.new(
+  :countries => ['Australia', 'United Kingdom']
+  :ips       => ['4.4.4.4', '8.8.8.8', '203.206.0.1']
+)
+```
+
 ### Country IPs
 
 Returns a list of the IPs from given country and IP dictionaries. Useful for auditing IPs from higher risk nations.
@@ -44,6 +61,10 @@ country_ips.ips_from_file = '/path/to/the/file'
 
 ## Changelog
 
+### v0.0.3 [2012-01-20]
+
+- Added Concerns::Initializable
+
 ### v0.0.2 [2012-01-19]
 
 - Added IP address sanity check

data/lib/security_guard/{utils → concerns}/accepts_from_file.rb

@@ -1,5 +1,5 @@
 module SecurityGuard
-  module Utils
+  module Concerns
     module AcceptsFromFile
       def self.included(klass)
         klass.extend ClassMethods

data/lib/security_guard/concerns/initializable.rb

@@ -0,0 +1,29 @@
+module SecurityGuard
+  module Concerns
+    module Initializable
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      def initializable_attrs(attributes)
+        attributes.each do |name, value|
+          self.send "#{name}=", value
+        end
+      end
+
+      module ClassMethods
+        def initializable(*attributes)
+          attributes.each do |name|
+            self.send :attr_accessor, name
+          end
+
+          unless self.method_defined?(:initialize)
+            self.send :define_method, :initialize, lambda { |args|
+              initializable_attrs args
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/security_guard/country_ips.rb

@@ -1,6 +1,6 @@
 module SecurityGuard
   class CountryIps
-    include Utils::AcceptsFromFile
+    include Concerns::AcceptsFromFile
 
     accepts_from_file :countries, :ips
 

data/lib/security_guard/version.rb

@@ -1,3 +1,3 @@
 module SecurityGuard
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/security_guard.rb

@@ -1,5 +1,6 @@
 require 'security_guard/version'
 require 'security_guard/utils/files'
-require 'security_guard/utils/accepts_from_file'
 require 'security_guard/utils/geo_ips'
+require 'security_guard/concerns/accepts_from_file'
+require 'security_guard/concerns/initializable'
 require 'security_guard/country_ips'

data/specs/concerns/accepts_from_file_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class TestAcceptsFromFile
+  include SecurityGuard::Concerns::AcceptsFromFile
+  accepts_from_file :attr1, :attr2
+end
+
+describe SecurityGuard::Concerns::AcceptsFromFile do
+  before do
+    @test = TestAcceptsFromFile.new
+  end
+
+  it 'has #attr1 as an accessor' do
+    @test.attr1 = 'test1'
+    @test.attr2 = 'test2'
+    @test.attr1.must_equal 'test1'
+    @test.attr2.must_equal 'test2'
+  end
+
+  it 'converts data from a file into an array' do
+    @test.attr1_from_file = fixture_file('countries.txt')
+    @test.attr1.must_equal ['Australia', 'United States', 'United Kingdom']
+  end
+end

data/specs/concerns/initializable_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class TestInitializableWithInitializer
+  include SecurityGuard::Concerns::Initializable
+  initializable :attr1, :attr2
+  def initialize(args)
+    initializable_attrs args
+  end
+end
+
+class TestInitializableWithoutInitializer
+  include SecurityGuard::Concerns::Initializable
+  initializable :attr1, :attr2
+end
+
+describe SecurityGuard::Concerns::Initializable do
+  [TestInitializableWithInitializer, TestInitializableWithoutInitializer].each do |klass|
+    it "#{klass}: initialises with some attributes" do
+      test = klass.new :attr1 => 'test1', :attr2 => 'test2'
+      test.attr1.must_equal 'test1'
+      test.attr2.must_equal 'test2'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: security_guard
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-18 00:00:00.000000000 Z
+date: 2012-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
-  requirement: &70244890970620 !ruby/object:Gem::Requirement
+  requirement: &70250519727080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244890970620
+  version_requirements: *70250519727080
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70244890967900 !ruby/object:Gem::Requirement
+  requirement: &70250519724280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244890967900
+  version_requirements: *70250519724280
 - !ruby/object:Gem::Dependency
   name: geoip
-  requirement: &70244890966500 !ruby/object:Gem::Requirement
+  requirement: &70250519722640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244890966500
+  version_requirements: *70250519722640
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70244890962180 !ruby/object:Gem::Requirement
+  requirement: &70250519721680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244890962180
+  version_requirements: *70250519721680
 - !ruby/object:Gem::Dependency
   name: minitest-colorize
-  requirement: &70244890958840 !ruby/object:Gem::Requirement
+  requirement: &70250519715500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244890958840
+  version_requirements: *70250519715500
 description: A collection of useful tools for auditing data and performing security
   checks.
 email:
@@ -83,17 +83,19 @@ files:
 - bin/sguard
 - data/GeoIP.dat
 - lib/security_guard.rb
+- lib/security_guard/concerns/accepts_from_file.rb
+- lib/security_guard/concerns/initializable.rb
 - lib/security_guard/country_ips.rb
-- lib/security_guard/utils/accepts_from_file.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/country_ips_spec.rb
 - specs/fixtures/countries.txt
 - specs/fixtures/ip_addresses.txt
 - specs/spec_helper.rb
-- specs/utils/accepts_from_file_spec.rb
 - specs/utils/files_spec.rb
 - specs/utils/geo_ips_spec.rb
 homepage: https://github.com/sitepoint/security_guard

data/specs/utils/accepts_from_file_spec.rb

@@ -1,22 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-class TestA
-  include SecurityGuard::Utils::AcceptsFromFile
-  accepts_from_file :test_attribute
-end
-
-describe SecurityGuard::Utils::AcceptsFromFile do
-  before do
-    @test = TestA.new
-  end
-
-  it 'has #test_attribute as an accessor' do
-    @test.test_attribute = 'test'
-    @test.test_attribute.must_equal 'test'
-  end
-
-  it 'converts data from a file into an array' do
-    @test.test_attribute_from_file = fixture_file('countries.txt')
-    @test.test_attribute.must_equal ['Australia', 'United States', 'United Kingdom']
-  end
-end