has_ip_address 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Joshua Nichols
+
+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.rdoc

@@ -0,0 +1,48 @@
+= has_ip_address
+
+An extension to ActiveRecord to store IP Addresses in the database as integers, in part to IPAddr.
+
+    class Visit < ActiveRecord::Base
+      has_ip_address
+    end
+
+Here's an example of using it:
+
+    >> visit = Visit.new
+    => #<Visit id: nil, ip_address: nil, created_at: nil, updated_at: nil>
+    >> visit.ip_address = "127.0.0.1"
+    => "127.0.0.1"
+    >> visit.ip_address
+    => #<IPAddr: IPv4:127.0.0.1/255.255.255.255>
+    >> visit.ip_address.to_i
+    => 2130706433
+    >> visit.ip_address.to_s
+    => "127.0.0.1"
+
+This assumes you are using a column named :ip_address. To change this behavior, pass in a parameter with the column you care to use:
+
+
+    class Visit < ActiveRecord::Base
+      has_ip_address :visit_ip
+    end
+
+== Known issues
+
+ * Setting ip_address to an invalid IP address will fail with an ArgumentError from IPAddr.
+   * Ideally, it should let you pass any value in without error, but invalid IP addresses will add a validation error during validation
+   * In the mean time, you probably want to only this when the IP Address will definitely be correct, ie from a controller's `request.remote_ip`.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Joshua Nichols. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "has_ip_address"
+    gem.summary = %Q{An extension to ActiveRecord to store IP Addresses in the database as integers}
+    gem.description = %Q{An extension to ActiveRecord to store IP Addresses in the database as integers}
+    gem.email = "josh@technicalpickles.com"
+    gem.homepage = "http://github.com/technicalpickles/has_ip_address"
+    gem.authors = ["Joshua Nichols"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "yard"
+    gem.add_development_dependency "acts_as_fu"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/has_ip_address.rb

@@ -0,0 +1,40 @@
+require 'ipaddr'
+require 'has_ip_address/extensions'
+
+module HasIpAddress
+
+  def self.included(other)
+    other.class_eval do
+      extend ClassMethods
+    end
+  end
+
+  module ClassMethods
+    def has_ip_address(column = :ip_address)
+      define_method "#{column}=" do |address|
+        ipaddr = address.to_ipaddr
+        write_attribute column, ipaddr
+
+        ipaddr
+      end
+
+      define_method column do
+        integer = read_attribute column
+        if integer.present?
+          IPAddr.new(i_to_ipaddr(integer))
+        end
+      end
+
+      unless self.instance_methods.include?('i_to_ipaddr')
+        define_method :i_to_ipaddr do |i|
+          [24, 16, 8, 0].collect {|b| (i >> b) & 255}.join('.')
+        end
+      end      
+    end
+  end
+end
+
+require 'active_record'
+ActiveRecord::Base.class_eval do
+  include HasIpAddress
+end

data/lib/has_ip_address/extensions.rb

@@ -0,0 +1,34 @@
+IPAddr.class_eval do
+  # hack so == doesn't blow up when passed false
+  def ==(other)
+    return false if other.kind_of?(TrueClass) || other.kind_of?(FalseClass)
+
+    # copied from original IPAddr#==
+    if other.kind_of?(IPAddr) && @family != other.family
+      return false
+    end
+    return (@addr == other.to_i)
+  end
+    
+  def to_ipaddr
+    self
+  end
+end
+
+class Bignum
+  def to_ipaddr
+   [24, 16, 8, 0].collect {|b| (self >> b) & 255}.join('.').to_ipaddr
+  end
+end
+
+class Fixnum
+  def to_ipaddr
+   [24, 16, 8, 0].collect {|b| (self >> b) & 255}.join('.').to_ipaddr
+  end
+end
+
+class Object
+  def to_ipaddr
+    IPAddr.new(self)
+  end
+end

data/spec/has_ip_address_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "has_ip_address" do
+  describe "with default column" do
+    before do
+      build_model :visits do
+        integer :ip_address
+        has_ip_address
+      end
+    end
+
+    describe "and setting and getting" do
+      before do
+        visit = Visit.new
+
+        visit.ip_address = "127.0.0.1"
+
+        @ip_address = visit.ip_address
+      end
+
+      it "should be a IPAddr" do
+        @ip_address.should be_kind_of(IPAddr)
+      end
+
+      it "should return the set value when got" do
+        @ip_address.should == IPAddr.new("127.0.0.1")
+      end
+
+    end
+  end
+  
+  describe "with default column" do
+    before do
+      build_model :visits do
+        integer :visitor_ip
+        has_ip_address :visitor_ip
+      end
+    end
+
+    describe "and setting and getting" do
+      before do
+        visit = Visit.new
+
+        visit.visitor_ip = "192.168.0.1"
+
+        @ip_address = visit.visitor_ip
+      end
+
+      it "should be a IPAddr" do
+        @ip_address.should be_kind_of(IPAddr)
+      end
+
+      it "should return the set value when got" do
+        @ip_address.should == IPAddr.new("192.168.0.1")
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'has_ip_address'
+require 'acts_as_fu'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.include ActsAsFu
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: has_ip_address
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshua Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: acts_as_fu
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: An extension to ActiveRecord to store IP Addresses in the database as integers
+email: josh@technicalpickles.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/has_ip_address.rb
+- lib/has_ip_address/extensions.rb
+- spec/has_ip_address_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/technicalpickles/has_ip_address
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An extension to ActiveRecord to store IP Addresses in the database as integers
+test_files: 
+- spec/has_ip_address_spec.rb
+- spec/spec_helper.rb