activemodel-ipaddr_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be71e5c90ac86d95518c142d9243969badeca1bd
+  data.tar.gz: b8e2b5727b7405ae66420a0c9db5d19c17b38823
+SHA512:
+  metadata.gz: 7b29d674a86724069d6500a7538f51627df082444e62ffc69fb921cfe7737a284bfc702bb570c87ca499b6d495c0bcd6980b56300de579ffa61d09392f32063b
+  data.tar.gz: 0fca558ff8310aff7dd62a9ec395ad10b4d1775f672f3a87bb8b91b9bd2cb4568c3073d4a967014806eaefa2713e9072d95db082ede5092f9897da6a6a750e3e

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+- 2.0.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,42 @@
+# activemodel-ipaddr_validator [![Build Status](https://travis-ci.org/increments/activemodel-ipaddr_validator.svg?branch=master)](https://travis-ci.org/increments/activemodel-ipaddr_validator)
+
+## Usage
+
+Add to your Gemfile:
+
+```rb
+gem 'activemodel-ipaddr_validator'
+```
+
+Run:
+
+```
+bundle install
+```
+
+Then add the following to your model:
+
+```rb
+validates :my_ipaddr_attribute, ipaddr: true
+```
+
+### Custom options
+
+Name    | Value   | Default | Description
+--------|---------|---------|-------------------------------------
+`ipv4`  | Boolean | true    | Accept IPv4.
+`ipv6`  | Boolean | false   | Accept IPv6.
+`array` | Boolean | false   | Expect an array of strings.
+
+```rb
+validates :ipv6s_attribute, ipaddr: { array: true, ipv4: false, ipv6: true }
+serialize :ipv6s_attribute, Array
+```
+
+## Validation outside a model
+
+If you need to validate an IP outside a model, you can do that:
+
+```rb
+IpaddrValidator.valid?(value, options)
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task default: :spec

data/activemodel-ipaddr_validator.gemspec

@@ -0,0 +1,22 @@
+file = File.open(File.expand_path('../lib/ipaddr_validator/version.rb', __FILE__))
+version = file.read.scan(/\d+\.\d+\.\d+/).first
+file.close
+
+Gem::Specification.new do |spec|
+  spec.name            = 'activemodel-ipaddr_validator'
+  spec.version         = version
+  spec.authors         = ['Yuku Takahashi']
+  spec.email           = ['yuku@qiita.com']
+  spec.summary         = 'A IPv4 and IPv6 validator for Rails 3 and 4.'
+  spec.homepage        = 'https://github.com/increments/activemodel-ipaddr_validator'
+  spec.license         = 'MIT'
+
+  spec.files           = `git ls-files -z`.split("\x0")
+  spec.require_paths   = ['lib']
+
+  spec.add_dependency 'activemodel'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  errors:
+    messages:
+      invalid_ipaddr: is invalid format.

data/config/locales/ja.yml

@@ -0,0 +1,4 @@
+ja:
+  errors:
+    messages:
+      invalid_ipaddr: の形式が正しくありません。

data/lib/activemodel-ipaddr_validator.rb

@@ -0,0 +1,3 @@
+require 'ipaddr_validator'
+require 'ipaddr_validator/version'
+require 'ipaddr_validator/engine'

data/lib/ipaddr_validator.rb

@@ -0,0 +1,45 @@
+require 'ipaddr'
+
+class IpaddrValidator < ActiveModel::EachValidator
+  class << self
+    def valid?(value, options = {})
+      options = default_options.merge(options)
+      array =
+        if options[:array]
+          return false unless value.is_a?(Array)
+          value
+        else
+          [value]
+        end
+      array.all? do |string|
+        validate_single_ipaddr(string, options)
+      end
+    end
+
+    def default_options
+      { ipv4: true, ipv6: false, array: false }
+    end
+
+    private
+
+    def validate_single_ipaddr(string, options)
+      ip = IPAddr.new(string)
+      case
+      when options[:ipv4] && ip.ipv4?
+        true
+      when options[:ipv6] && ip.ipv6?
+        true
+      else
+        false
+      end
+    rescue IPAddr::Error
+      false
+    end
+  end
+
+  def validate_each(record, attribute, value)
+    unless self.class.valid?(value, options)
+      record.errors.add(attribute, options[:message] || :invalid_ipaddr)
+    end
+  end
+end

data/lib/ipaddr_validator/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+class IpaddrValidator
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/ipaddr_validator/version.rb

@@ -0,0 +1,3 @@
+class IpaddrValidator
+  VERSION = '0.0.1'
+end

data/spec/ipaddr_validator_spec.rb

@@ -0,0 +1,244 @@
+require 'spec_helper'
+
+# Shared examples for value.
+
+shared_examples_for 'valid IPv4 string is given', given: :ipv4 do
+  let(:value) do
+    '192.168.2.0/24'
+  end
+end
+
+shared_examples_for 'valid IPv6 string is given', given: :ipv6 do
+  let(:value) do
+    '3ffe:505:2::1'
+  end
+end
+
+shared_examples_for 'valid IPv4 array is given', given: :ipv4_array do
+  let(:value) do
+    ['192.168.2.0/24', '192.168.3.0/24']
+  end
+end
+
+shared_examples_for 'valid IPv6 array is given', given: :ipv6_array do
+  let(:value) do
+    ['3ffe:505:2::1', '3ffe:505:2::2']
+  end
+end
+
+shared_examples_for 'invalid string is given', given: :invalid do
+  let(:value) do
+    'invalid ipaddr'
+  end
+end
+
+shared_examples_for 'invalid array is given', given: :invalid_array do
+  let(:value) do
+    ['invalid ipaddr']
+  end
+end
+
+# Shared examples for options.
+
+IpaddrValidator.default_options.keys.product([true, false]).each do |option, value|
+  shared_examples_for "#{option} is #{value}", option => value do
+    let(option) do
+      value
+    end
+  end
+end
+
+describe IpaddrValidator do
+  let(:options) do
+    options = {}
+    described_class.default_options.keys.each do |option_name|
+      options[option_name] = send(option_name) if respond_to? option_name
+    end
+    options
+  end
+
+  describe '.valid?' do
+    subject do
+      described_class.valid?(value, options)
+    end
+
+    context 'when a valid IPv4 string is given', given: :ipv4 do
+      context 'and ipv4 option is true', ipv4: true do
+        context 'and array option is true', array: true do
+          it { should be_falsey }
+        end
+
+        context 'and array option is false', array: false do
+          it { should be_truthy }
+        end
+      end
+
+      context 'and ipv4 option is false', ipv4: false do
+        it { should be_falsey }
+      end
+    end
+
+    context 'when a valid IPv6 string is given', given: :ipv6 do
+      context 'and ipv6 option is true', ipv6: true do
+        context 'and array option is true', array: true do
+          it { should be_falsey }
+        end
+
+        context 'and array option is false', array: false do
+          it { should be_truthy }
+        end
+      end
+
+      context 'and ipv6 option is false', ipv6: false do
+        it { should be_falsey }
+      end
+    end
+
+    context 'when a valid IPv4 array is given', given: :ipv4_array do
+      context 'and ipv4 option is true', ipv4: true do
+        context 'and array option is true', array: true do
+          it { should be_truthy }
+        end
+
+        context 'and array option is false', array: false do
+          it { should be_falsey }
+        end
+      end
+
+      context 'and ipv4 option is false', ipv4: false do
+        it { should be_falsey }
+      end
+    end
+
+    context 'when a valid IPv6 array is given', given: :ipv6_array do
+      context 'and ipv6 option is true', ipv6: true do
+        context 'and array option is true', array: true do
+          it { should be_truthy }
+        end
+
+        context 'and array option is false', array: false do
+          it { should be_falsey }
+        end
+      end
+
+      context 'and ipv6 option is false', ipv6: false do
+        it { should be_falsey }
+      end
+    end
+
+    context 'when an invalid string is given', given: :invalid do
+      context 'and array option is true', array: true do
+        it { should be_falsey }
+      end
+
+      context 'and array option is false', array: false do
+        it { should be_falsey }
+      end
+    end
+
+    context 'when an invalid array is given', given: :invalid_array do
+      context 'and array option is true', array: true do
+        it { should be_falsey }
+      end
+
+      context 'and array option is false', array: false do
+        it { should be_falsey }
+      end
+    end
+  end
+
+  describe 'validation' do
+    subject do
+      model_class.new(attr: value)
+    end
+
+    let(:model_class) do
+      opts = options
+      Class.new(TestModel) do
+        validates :attr, ipaddr: opts
+      end
+    end
+
+    context 'when invalid value is given', given: :invalid do
+      it { should be_invalid }
+    end
+
+    context 'when invalid array is given', given: :invalid_array do
+      it { should be_invalid }
+    end
+
+    context 'when default option is used' do
+      let(:options) do
+        true
+      end
+
+      context 'and IPv4 string is given', given: :ipv4 do
+        it { should be_valid }
+      end
+
+      [:ipv4_array, :ipv6, :ipv6_array].each do |given|
+        context "and #{given} is given", given: given do
+          it { should be_invalid }
+        end
+      end
+    end
+
+    context(
+      'when ipv4 and ipv6 options are true and false respectively',
+      ipv4: true, ipv6: false
+    ) do
+      context 'and array option is true', array: true do
+        context 'and IPv4 array is given', given: :ipv4_array do
+          it { should be_valid }
+        end
+
+        [:ipv4, :ipv6, :ipv6_array].each do |given|
+          context "and #{given} is given", given: given do
+            it { should be_invalid }
+          end
+        end
+      end
+
+      context 'and array option is false', array: false do
+        context 'and IPv4 string is given', given: :ipv4 do
+          it { should be_valid }
+        end
+
+        [:ipv4_array, :ipv6, :ipv6_array].each do |given|
+          context "and #{given} is given", given: given do
+            it { should be_invalid }
+          end
+        end
+      end
+    end
+
+    context(
+      'when ipv4 and ipv6 options are false and true respectively',
+      ipv4: false, ipv6: true
+    ) do
+      context 'and array option is true', array: true do
+        context 'and IPv6 array is given', given: :ipv6_array do
+          it { should be_valid }
+        end
+
+        [:ipv4, :ipv4_array, :ipv6].each do |given|
+          context "and #{given} is given", given: given do
+            it { should be_invalid }
+          end
+        end
+      end
+
+      context 'and array option is false', array: false do
+        context 'and IPv6 string is given', given: :ipv6 do
+          it { should be_valid }
+        end
+
+        [:ipv4, :ipv4_array, :ipv6_array].each do |given|
+          context "and #{given} is given", given: given do
+            it { should be_invalid }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'active_model'
+require 'ipaddr_validator'
+
+RSpec.configure do |config|
+  config.color = true
+  config.run_all_when_everything_filtered = true
+end
+
+class TestModel
+  include ActiveModel::Validations
+
+  def self.name
+    'TestModel'
+  end
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: activemodel-ipaddr_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuku Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- yuku@qiita.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- activemodel-ipaddr_validator.gemspec
+- config/locales/en.yml
+- config/locales/ja.yml
+- lib/activemodel-ipaddr_validator.rb
+- lib/ipaddr_validator.rb
+- lib/ipaddr_validator/engine.rb
+- lib/ipaddr_validator/version.rb
+- spec/ipaddr_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/increments/activemodel-ipaddr_validator
+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: A IPv4 and IPv6 validator for Rails 3 and 4.
+test_files: []