ip_address_serializer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 605708a4418dbd7a80a9d66f45a598e7913c551f
+  data.tar.gz: ae2393ba7f8fe90eec550d6ae8fba67da91cc964
+SHA512:
+  metadata.gz: 3c72468518c64efafc8eb20afaece20991be4979a05fdc34ade897dd575ac1abd8f211d9c180c3ff9c4d2d0be52a00d114e3a8b11a1be2ce6c22f34cecfbb519
+  data.tar.gz: b67165c8919bb6eb1577c5cafe955f9a5442fd3a758dcd1c2b348725b7cea767e70e1e960ea35c96e6d7f5a6a98b9fa7f85a05fea314c2d50898a4dff78b4a53

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ip_address_serializer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Mike Simkins
+
+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,36 @@
+# IpAddressSerializer
+
+This gem providers a custom Serializer for ActiveRecord to allow the storage and retrieval of an
+IPv4 or IPv6 Address in a String Field
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ip_address_serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ip_address_serializer
+
+## Usage
+
+Once the Gem has been added to your Gemfile, in any model that is required to hold an IP Address, add the
+following line to your model
+
+```ruby
+serialize <field name symbol>, IPAddressSerializer
+```
+## Contributing
+
+1. Fork it ( https://github.com/msimkins/ip_address_serializer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+	t.pattern = "test/*_test.rb"
+end

data/ip_address_serializer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ip_address_serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ip_address_serializer"
+  spec.version       = IpAddressSerializer::VERSION
+  spec.authors       = ["Mike Simkins"]
+  spec.email         = ["software@g7obs.com"]
+  spec.summary       = %q{Gem to enable serialized storage of an IP Address in a string}
+  spec.description   = %q{ActiveRecord Serializer to be allow the storage of a CIDR IP Address in a String Field}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4"
+  
+  spec.add_dependency "ruby-ip", "~> 0.9"
+end

data/lib/ip_address_serializer.rb

@@ -0,0 +1,34 @@
+require 'ip'
+require "ip_address_serializer/version"
+
+DELIMITER = '^'
+
+module IPAddressSerializer
+	
+	# Load the value and return the IP Object.
+	# @param [String] value String representation of the IP Object
+	# @return [IP] The IP Object (from ruby-ip)
+	def self.load(value)
+		if value.nil?
+			return nil
+		end
+		if value.is_a?(String) && value.index(DELIMITER) > 0
+			return IP.new(value.split(DELIMITER))
+		end
+	end
+
+	# Save the value, which converts either a String, or an IP Object to the String representation for storage
+	# @param [String, IP, IP::V4, IP::V6] String representation, or internal IP representation of an IP Address
+	# @return [String] The encoded string value representing the IP address object
+	def self.dump(value)
+		if value.nil?
+			return nil
+		end
+		if value.is_a?(String)
+			ip = IP.new(value)
+		elsif (value.is_a?(IP) || value.is_a?(IP::V4) || value.is_a?(IP::V6))
+			ip = value
+		end
+		return [ip.proto, ip.to_hex, ip.pfxlen].join(DELIMITER)
+	end
+end

data/lib/ip_address_serializer/version.rb

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

data/test/ipv4_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class IPV4_dump < MiniTest::Test
+	
+	def setup
+		@ip4 = IP.new("192.168.1.1")
+		@ip4s = "192.168.1.1"
+	end
+	
+	def test_ipv4_dump_from_ip
+		assert_equal "v4^c0a80101^32", IPAddressSerializer.dump(@ip4)
+	end
+	
+	def test_ipv4_load_to_ip
+		assert_equal IP.new("192.168.1.1"), IPAddressSerializer.load("v4^c0a80101^32")
+	end
+	
+	def test_ipv4_dump_from_string
+		assert_equal "v4^c0a80101^32", IPAddressSerializer.dump(@ip4s)
+	end
+		
+end
+

data/test/ipv6_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class IPV6_dump < MiniTest::Test
+
+	def setup
+		@ip6 = IP.new("2001:db8:102::10/120")
+		@ip6s = "2001:db8:102::10/120"
+	end
+
+	def test_ipv6_dump_from_ip
+		assert_equal "v6^20010db8010200000000000000000010^120", IPAddressSerializer.dump(@ip6)
+	end
+
+	def test_ipv6_load_to_ip
+		assert_equal IP.new("2001:db8:102::10/120"), IPAddressSerializer.load("v6^20010db8010200000000000000000010^120")
+	end
+	
+	def test_ipv6_dump_from_string
+		assert_equal "v6^20010db8010200000000000000000010^120", IPAddressSerializer.dump(@ip6)
+	end
+		
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'ip_address_serializer'
+require 'minitest'
+require 'minitest/unit'
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ip_address_serializer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Simkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: ruby-ip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: ActiveRecord Serializer to be allow the storage of a CIDR IP Address
+  in a String Field
+email:
+- software@g7obs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ip_address_serializer.gemspec
+- lib/ip_address_serializer.rb
+- lib/ip_address_serializer/version.rb
+- test/ipv4_test.rb
+- test/ipv6_test.rb
+- test/test_helper.rb
+homepage: ''
+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: Gem to enable serialized storage of an IP Address in a string
+test_files:
+- test/ipv4_test.rb
+- test/ipv6_test.rb
+- test/test_helper.rb