ip_as_int 0.0.1

data/.env

@@ -0,0 +1,9 @@
+MAGICK_HOME="/usr/local/ImageMagick" && export
+PATH=$MAGICK_HOME/bin:$PATH && export
+DYLD_LIBRARY_PATH=$MAGICK_HOME/lib:$DYLD_LIBRARY_PATH && export
+
+MYSQL_HOME="/usr/local/mysql" && export
+PATH=$MYSQL_HOME/bin:$PATH && export
+DYLD_LIBRARY_PATH=$MYSQL_HOME/lib:$DYLD_LIBRARY_PATH && export
+
+PATH=/usr/local/git/bin/:$PATH && export

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,2 @@
+. .env
+rvm ruby-1.9.3-p362@ip_as_int --create

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ip_as_int.gemspec
+gemspec
+
+gem 'rspec'
+gem 'rake'
+gem 'activemodel'
+# one-liner to install these properly: bash < <(curl -L https://raw.github.com/gist/1333785)
+# gem 'linecache19', '0.5.13'
+# gem 'ruby-debug-base19', '0.11.26'
+gem 'debugger'
+gem 'activerecord'
+gem 'sqlite3'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 zelig
+
+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,102 @@
+# IpAsInt
+
+IP address - integer conversion and activerecord support for ip attribute as integer column.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ip_as_int'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ip_as_int
+
+## Usage
+
+### IP address - integer conversion
+
+    >> require 'ip_as_int'
+    => true
+    >> ip_string = '192.168.0.1'
+    => "192.168.0.1"
+    >> ip_int = IpAsInt.ip2int(ip_string)
+    => 3232235521
+    >> ip_string = IpAsInt.int2ip(ip_int)
+    => "192.168.0.1"
+
+Exceptions on invalid IP address
+
+    >> IpAsInt.ip2int('192.168.0')
+    ArgumentError: Invalid IP: need 4 parts
+    >> IpAsInt.ip2int('192.168.0.s')
+    ArgumentError: Invalid IP: illegal format
+    >> IpAsInt.ip2int('192.168.0.256')
+    ArgumentError: Invalid IP: integer out of range
+
+### ActiveRecord IP address attribute as integer column
+
+    class Model < ActiveRecord::Base
+      include IpAsInt::IpAddressAttribute
+      ip_address :ip # :ip as integer column
+      search_methods :ip # to allow squeel to do Model.search(:ip => '192.168.0.1')
+    end
+
+Attribute methods are defined to let the ip attribute assigned a string, conversion to integer column is done automatically.
+
+    >> m = Model.create(:ip => '192.168.0.1')
+    => #<Model id: 1, ip: 3232235521>
+    >> m.valid?
+    => true
+    >> m.reload.ip
+    => "192.168.0.1"
+
+a scope to retrieve IP by string is also provided unless `scope: false` option is given.
+
+    >> Model.create(
+    ?>   [{ :ip => '192.168.0.1' },
+    ?>    { :ip => '192.168.0.2' },
+    ?>    { :ip => '192.168.0.3' }
+    >>    ])
+    => [#<Model id: 3, ip: 3232235521>, #<Model id: 4, ip: 3232235522>, #<Model id: 5, ip: 3232235523>]
+    >> Model.ip('192.168.0.1', '192.168.0.2')
+    => [#<Model id: 3, ip: 3232235521>, #<Model id: 4, ip: 3232235522>]
+
+a validation of the ip address is set up unless `validation: false` option is given
+
+    >> Model.create!(:ip => '192.168.0')
+    ActiveRecord::RecordInvalid: Validation failed: Ip has to be a valid IP address
+
+## Further use 
+
+In fact, you can also use the `IpAsInt::IpAddressAttribute` module with active model only. 
+
+    class Model
+      include ActiveModel::Validations
+      include ::IpAsInt::IpAddressAttribute
+      ip_address :ip
+    end
+
+The validator can also be used by itself on an IP attribute irrespective of underlying storage (i.e., even if you use a string column)
+
+    class Model
+      # :ip string column
+      validates :ip, :ip_address => { :allow_blank => true }
+    end
+
+## 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
+
+## Credits
+
+- http://basic70tech.wordpress.com/2007/04/13/32-bit-ip-address-to-dotted-notation-in-ruby/
+- http://norbauer.com/notebooks/code/notes/storing-ip-addresses-as-integers

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/TODO.md

@@ -0,0 +1 @@
+nothing?

data/ip_as_int.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ip_as_int/version', __FILE__)
+
+DESC = %q{IP address - integer conversion and activerecord support for ip attribute as integer column}
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["zelig"]
+  gem.email         = ["viktor.tron@gmail.com"]
+  gem.description   = DESC
+  gem.summary       = DESC
+  gem.homepage      = ""
+
+  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          = "ip_as_int"
+  gem.require_paths = ["lib"]
+  gem.version       = IpAsInt::VERSION
+
+  gem.add_development_dependency 'rspec'
+end

data/lib/ip_as_int/ip2int.rb

@@ -0,0 +1,27 @@
+module IpAsInt::Ip2int
+
+  def ip2int(ip_string)
+    ip2a(ip_string).pack('C*').unpack('N').first
+    #ip_string.split('.').inject(0) { |total,value| (total << 8 ) + value.to_i }
+  end
+
+  def int2ip(ip_int)
+    if ip_int
+      [ip_int].pack('N').unpack('C*').join('.')
+      #[24, 16, 8, 0].collect {|b| (address >> b) & 255}.join('.')IpAsInt::
+    else
+      ""
+    end
+  end
+
+  def ip2a(ip_string)
+    ip_a = ip_string.split('.')
+    raise(ArgumentError, "Invalid IP: need 4 parts") unless ip_a.length == 4
+    rexp = /^\d+$/
+    raise(ArgumentError, "Invalid IP: illegal format") unless ip_a.all? { |x| rexp.match(x) }
+    ip_a = ip_a.map(&:to_i)
+    raise(ArgumentError, "Invalid IP: integer out of range") unless ip_a.all? { |x| (0..255).include? x }
+    ip_a
+  end
+
+end

data/lib/ip_as_int/ip_address_attribute.rb

@@ -0,0 +1,68 @@
+#require 'activemodel/validations'
+module IpAsInt
+  module IpAddressAttribute
+
+    def self.included(base)
+      base.extend IpAddressAttributeClassMethods
+    end
+
+    module IpAddressAttributeClassMethods
+
+      def ip_address(*attrs)
+
+        options = attrs.extract_options!
+        options = { :scope => true, :validation => true }.merge(options)
+
+        unless new.respond_to?(:read_attribute)
+          define_method :read_attribute do |attr|
+            instance_variable_get("@#{attr}_raw")
+          end
+          define_method :write_attribute do |attr,val|
+            instance_variable_set("@#{attr}_raw", val)
+          end
+        end
+
+        attrs.each do |attr|
+
+          define_method "#{attr}=" do |ip_string|
+            instance_variable_set("@#{attr}", ip_string)
+            ip_int = begin
+              if ip_string
+                instance_variable_set("@#{attr}_invalid",false)
+                ::IpAsInt.ip2int(ip_string)
+              end
+            rescue ArgumentError
+              instance_variable_set("@#{attr}_invalid",true)
+              nil
+            end
+            write_attribute attr, ip_int
+          end
+
+          define_method attr do
+            if ip_string = instance_variable_get("@#{attr}")
+              ip_string
+            else
+              ip_int =  read_attribute(attr)
+              instance_variable_set("@#{attr}",::IpAsInt.int2ip(ip_int)) if ip_int
+            end
+          end
+
+        end
+
+        if options[:scope] && respond_to?(:where)
+          attrs.each do |attr|
+            scope attr, (lambda { |*ip_strings|
+                           ip_int = ip_strings.map { |ip_string| ::IpAsInt.ip2int(ip_string)  }
+                           where(attr => ip_int)
+            })
+          end
+        end
+
+        if options[:validation]
+          validates(*(attrs << { :ip_address => options[:validation] }))
+        end
+      end
+
+    end
+  end
+end

data/lib/ip_as_int/ip_address_validator.rb

@@ -0,0 +1,13 @@
+require 'active_model/validator'
+class IpAddressValidator < ActiveModel::EachValidator
+  def validate_each(record, attr, value)
+    invalid = instance_variable_get("@#{attr}_invalid")
+    invalid = begin
+      ::IpAsInt.ip2a(value)
+      false
+    rescue
+      true
+    end if invalid.nil?
+    record.errors.add(attr,"has to be a valid IP address") if invalid
+  end
+end

data/lib/ip_as_int/version.rb

@@ -0,0 +1,3 @@
+module IpAsInt
+  VERSION = "0.0.1"
+end

data/lib/ip_as_int.rb

@@ -0,0 +1,9 @@
+require "ip_as_int/version"
+require "ip_as_int/ip2int"
+require "ip_as_int/ip_address_attribute"
+require "ip_as_int/ip_address_validator"
+
+
+module IpAsInt
+  extend Ip2int
+end

data/spec/ip2int_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'ip_as_int'
+
+describe ::IpAsInt do
+
+  it "converts ip to int correctly" do
+    IpAsInt.ip2int('192.168.0.1').should == 3232235521
+  end
+
+  it "converts ip to int correctly" do
+    IpAsInt.int2ip(3232235521).should == '192.168.0.1'
+  end
+
+  it "throws ArgumentError if ip address is invalid" do
+    lambda { IpAsInt.ip2int('192.168.0.OI') }.should raise_error(ArgumentError, "Invalid IP: illegal format")
+  end
+
+it "throws ArgumentError if ip address is invalid" do
+    lambda { IpAsInt.ip2int('192.168.0.') }.should raise_error(ArgumentError, "Invalid IP: need 4 parts")
+  end
+
+  it "throws ArgumentError if ip address is invalid" do
+    lambda { IpAsInt.ip2int('192.168.0.257') }.should raise_error(ArgumentError, "Invalid IP: integer out of range")
+  end
+
+end

data/spec/ip_address_attribute_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+require 'ip_as_int'
+require 'active_model'
+require 'active_record'
+require 'logger'
+
+describe ::IpAsInt::IpAddressAttribute do
+
+  def model
+    @model
+  end
+
+  shared_examples_for "accessors and validation" do
+
+    context "with validation" do
+      before :each do
+        @model = model_class(:ip).new
+      end
+
+      it "defines attribute writer for ip_address, stores value as integer" do
+        model.ip = '192.168.0.1'
+        model.read_attribute(:ip).should == 3232235521
+      end
+
+      it "defines attribute reader for ip_address, converts value from integer" do
+        model.write_attribute(:ip, 3232235521)
+        model.ip.should == '192.168.0.1'
+        model.should be_valid
+      end
+
+      it "nil preserved" do
+        model.ip = nil
+        model.read_attribute(:ip).should == nil
+      end
+
+      it "invalid input preserved" do
+        model.ip = "invalid"
+        model.read_attribute(:ip).should == nil
+        model.ip.should == "invalid"
+      end
+
+      it "validates correctly" do
+        model.ip = "invalid"
+        model.should_not be_valid
+      end
+
+      it "validates correctly even if underlying change" do
+        model.ip = "invalid"
+        model.write_attribute(:ip, 3232235521)
+        model.should_not be_valid
+      end
+
+      it "invalid on nil IP" do
+        model.ip = nil
+        model.should_not be_valid
+      end
+
+    end
+
+    context "without validation" do
+      before :each do
+        @model = model_class(:ip, :validation => false).new
+      end
+
+      it "valid on invalid IP" do
+        model.ip = "invalid"
+        model.should be_valid
+      end
+
+      it "valid on valid IP" do
+        model.ip = '192.168.0.1'
+        model.should be_valid
+      end
+
+    end
+    context "with validation with arguments" do
+
+      before :each do
+        @model = model_class(:ip, :validation => { :allow_nil => true }).new
+      end
+
+      it "invalid on invalid IP" do
+        model.ip = "invalid"
+        model.should_not be_valid
+      end
+
+      it "valid on valid IP" do
+        model.ip = '192.168.0.1'
+        model.should be_valid
+      end
+
+      it "valid on nil IP" do
+        model.ip = nil
+        model.should be_valid
+      end
+
+    end
+  end
+
+  context "activemodel integration" do
+
+    def model_class(*attrs)
+      Class.new do
+        include ActiveModel::Validations
+        include ::IpAsInt::IpAddressAttribute
+        ip_address(*attrs)
+      end
+    end
+
+    include_examples "accessors and validation"
+
+  end
+
+  context "activerecord integration" do
+
+    ActiveRecord::Base.establish_connection({'adapter' => 'sqlite3', 'database' => ":memory:" })
+    ActiveRecord::Base.logger = Logger.new("#{File.dirname(__FILE__)}/../../active_record.log")
+
+    def model_class(*attrs)
+      ActiveRecord::Base.connection.create_table(:testmodels, :force=>true) do |t|
+        attrs.each do |attr|
+          t.integer attr unless attr.is_a?(Hash)
+        end
+      end
+      Class.new(ActiveRecord::Base) do
+        self.table_name = 'testmodels'
+        include ::IpAsInt::IpAddressAttribute
+        ip_address(*attrs)
+        def write_attribute(*)
+          super
+        end
+        def read_attribute(*)
+          super
+        end
+      end
+    end
+
+    include_examples "accessors and validation"
+
+    context "persistence and scoping" do
+
+      before :each do
+        @model_class = model_class(:ip, :validation => { :allow_nil => true })
+        @model = @model_class.new
+      end
+
+      it "survives persistence in db" do
+        model.ip = '192.168.0.1'
+        model.save.should be_true
+        model.reload.ip.should == '192.168.0.1'
+      end
+
+      it "supports scope for retrieval from db by ip strings" do
+        models = @model_class.create(
+          [{ :ip => '192.168.0.1' },
+           { :ip => '192.168.0.2' },
+           { :ip => '192.168.0.3' }
+           ])
+        @model_class.ip('192.168.0.1', '192.168.0.2').should == models[0..1]
+      end
+
+    end
+
+  end
+
+
+end

data/spec/ip_address_attribute_spec.rb~

@@ -0,0 +1,112 @@
+require 'spec_helper'
+require 'ip_as_int'
+require 'active_model'
+
+describe ::IpAsInt::IpAddressAttribute do
+
+  def model
+    @model
+  end
+
+  shared_examples_for "accessors and validation" do
+
+       context "with validation" do
+      before :each do
+        @model = model_class(:ip).new
+      end
+
+      it "defines attribute writer for ip_address, stores value as integer" do
+        model.ip = '192.168.0.1'
+        model.read_attribute(:ip).should == 3232235521
+      end
+
+      it "defines attribute reader for ip_address, converts value from integer" do
+        model.write_attribute(:ip, 3232235521)
+        model.ip.should == '192.168.0.1'
+        model.should be_valid
+      end
+
+      it "nil preserved" do
+        model.ip = nil
+        model.read_attribute(:ip).should == nil
+      end
+
+      it "invalid input preserved" do
+        model.ip = "invalid"
+        model.read_attribute(:ip).should == nil
+        model.ip.should == "invalid"
+      end
+
+      it "validates correctly" do
+        model.ip = "invalid"
+        model.should_not be_valid
+      end
+
+      it "validates correctly even if underlying change" do
+        model.ip = "invalid"
+        model.write_attribute(:ip, 3232235521)
+        model.should_not be_valid
+      end
+
+      it "invalid on nil IP" do
+        model.ip = nil
+        model.should_not be_valid
+      end
+
+    end
+
+    context "without validation" do
+      before :each do
+        @model = model_class(:ip, :validation => false).new
+      end
+
+      it "valid on invalid IP" do
+        model.ip = "invalid"
+        model.should be_valid
+      end
+
+      it "valid on valid IP" do
+        model.ip = '192.168.0.1'
+        model.should be_valid
+      end
+
+    end
+    context "with validation with arguments" do
+
+      before :each do
+        @model = model_class(:ip, :validation => { :allow_nil => true }).new
+      end
+
+      it "invalid on invalid IP" do
+        model.ip = "invalid"
+        model.should_not be_valid
+      end
+
+      it "valid on valid IP" do
+        model.ip = '192.168.0.1'
+        model.should be_valid
+      end
+
+      it "valid on nil IP" do
+        model.ip = nil
+        model.should be_valid
+      end
+
+    end
+  end
+
+  context "activemodel integration" do
+
+    def model_class(*attrs)
+      Class.new do
+        include ActiveModel::Validations
+        include ::IpAsInt::IpAddressAttribute
+        ip_address(*attrs)
+      end
+    end
+
+    include_examples "accessors and validations"
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: ip_as_int
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- zelig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: IP address - integer conversion and activerecord support for ip attribute
+  as integer column
+email:
+- viktor.tron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .env
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- ip_as_int.gemspec
+- lib/ip_as_int.rb
+- lib/ip_as_int/ip2int.rb
+- lib/ip_as_int/ip_address_attribute.rb
+- lib/ip_as_int/ip_address_validator.rb
+- lib/ip_as_int/version.rb
+- spec/ip2int_spec.rb
+- spec/ip_address_attribute_spec.rb
+- spec/ip_address_attribute_spec.rb~
+- spec/spec_helper.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: 2770053615365876423
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2770053615365876423
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: IP address - integer conversion and activerecord support for ip attribute
+  as integer column
+test_files:
+- spec/ip2int_spec.rb
+- spec/ip_address_attribute_spec.rb
+- spec/ip_address_attribute_spec.rb~
+- spec/spec_helper.rb