ipconverter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b01a9e80032c6c523fe70643f565243dfa4e29f
+  data.tar.gz: 25c4af9335552cd0a58dc8bdbc1c8b50251057de
+SHA512:
+  metadata.gz: 1360cf3d1f26031a4148b60ced541a31dbbb2d9d4714bde838025a8ce55963aae5cbdb4c24f5d538b2f568b08b3c2a50641e646f1ee1381284bf74581167811a
+  data.tar.gz: d6b6fe8f449d19aa9538b173b01d46d4fd30957b28418d608db74152a8300a748d0565514e35538073e9ebb3502f8fd67537f987c2cf7ad8773dbddd301b6587

data/.gitignore

@@ -0,0 +1,23 @@
+*.swp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joshua Scott
+
+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,40 @@
+# IpConverter
+
+Library to deal with IP Address conversions/manipulation, such as converting
+a string representation like "192.168.2.1" to its integer representation
+(3232236033)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ipconverter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ipconverter
+
+## Usage
+
+```
+require 'ipconverter'
+IpConverter.str_to_int "192.168.2.1"
+ => 3232236033
+```
+str_to_int raises an error if the address is not valid:
+```
+IpConverter.str_to_int "192.168.2"
+ => raises ArgumentError
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/joshuawscott/ipconverter/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,13 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require "rake/extensiontask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test_*.rb'
+end
+
+Rake::ExtensionTask.new "ipconverter" do |ext|
+    ext.lib_dir = "lib/ipconverter"
+end
+

data/bench.rb

@@ -0,0 +1,41 @@
+require 'benchmark'
+require 'ipaddr'
+require 'ipconverter'
+
+def ip_to_i(ip)
+  ip.split('.').collect(&:to_i).pack('C*').unpack('N').first
+end
+
+def ip_to_i2(ip)
+  octets = ip.split('.').map(&:to_i)
+  octets[3] +
+    octets[2] * 256 +
+    octets[1] * 256*256 +
+    octets[0] * 256*256*256 
+end
+
+def ipaddr_to_i(ip)
+  IPAddr.new(ip).to_i
+end
+
+ips = []
+(50..59).each do |o1|
+  (155..254).each do |o2|
+    (100..199).each do |o3|
+      (1..10).each do |o4|
+        ips << "#{o1}.#{o2}.#{o3}.#{o4}"
+      end
+    end
+  end
+end
+
+puts "iterations: " + ips.length
+
+Benchmark.bmbm do |x|
+  x.report('IPAddr#to_i') { ips.each { |ip| IPAddr.new(ip).to_i } }
+  x.report('pack/unpack') { ips.each { |ip| ip_to_i(ip) } }
+  x.report('split/multiply') { ips.each { |ip| ip_to_i2(ip) } }
+  x.report('C split/multiply') { ips.each {|ip| IpConverter.str_to_int(ip) } }
+  x.report('noop') { ips.each {|ip| ip } }
+end
+

data/ext/ipconverter/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+extension_name = 'ipconverter'
+$CFLAGS << ' -I. '
+dir_config(extension_name)
+create_makefile(extension_name)

data/ext/ipconverter/ipconverter.c

@@ -0,0 +1,58 @@
+#include <ruby.h>
+#include "ipconverter.h"
+
+// Module name
+VALUE IpConverter = Qnil;
+
+void Init_ipconverter() {
+  IpConverter = rb_define_module("IpConverter");
+  rb_define_method(IpConverter, "str_to_int", method_str_to_int, 1);
+}
+
+// Converts a passed ruby string into an integer
+// returns integer or nil (if ip is invalid)
+VALUE method_str_to_int(VALUE _module_, VALUE ip_string) {
+
+  // C string version of the ip_string
+  char* c_string = RSTRING_PTR(StringValue(ip_string));
+
+  uint32_t result;
+
+  int success = ip_string_to_long(c_string, &result);
+
+  if (success) {
+    // Convert the uint32_t back to a ruby Fixnum.
+    return UINT2NUM(result);
+  } else {
+    rb_raise(rb_eArgError, "Invalid IP Address String");
+  }
+}
+
+// Returns 0 if ip is invalid; 1 otherwise.
+// takes an ip address string, like "192.168.2.254", finds the 32-bit integer
+// value and stores that in result.
+static int
+ip_string_to_long(char c_string[], uint32_t *result) {
+  int32_t i, found_octets;
+  char junk;
+  int32_t octets[4];
+
+  found_octets = sscanf((char*)c_string, "%d.%d.%d.%d%c", (int*)&octets[3], (int*)&octets[2], (int*)&octets[1], (int*)&octets[0], &junk);
+
+  // If we didn't find exactly 4 octets, bail out, unless the extra is whitespace
+  if (found_octets != 4 
+      && !(found_octets == 5 && junk == ' ')) {
+    return 0;
+  }
+
+  // If any of the octets are not in-range, bail out
+  for (i = 0; i < 4; i++) {
+    if (octets[i] > 255 || octets[i] < 0) {
+      return 0;
+    }
+  }
+
+  *result = (octets[0] + octets[1] * 256 + octets[2] * 256 * 256 + octets[3] * 256 * 256 * 256);
+  return 1;
+}
+

data/ext/ipconverter/ipconverter.h

@@ -0,0 +1,3 @@
+VALUE method_str_to_int(VALUE, VALUE);
+static int ip_string_to_long(char[], uint32_t*);
+void Init_ipconverter();

data/ipconverter.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+ext = File.expand_path('../ext', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$LOAD_PATH.unshift(ext) unless $LOAD_PATH.include?(ext)
+require 'ipconverter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ipconverter"
+  spec.version       = IpConverter::VERSION
+  spec.authors       = ["Joshua Scott"]
+  spec.email         = ["joshua.scott@gmail.com"]
+  spec.summary       = %q{Utilities for working with IP addresses}
+  spec.description   = %q{Fast C extension for converting IP addresses from string to integer}
+  spec.homepage      = "http://github.com/joshuawscott/ipconverter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.extensions    = ['ext/ipconverter/extconf.rb']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", "ext"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency 'rake-compiler', "~> 0.9"
+end

data/lib/ipconverter.rb

@@ -0,0 +1,6 @@
+require "ipconverter/version"
+require "ipconverter/ipconverter"
+
+module IpConverter
+  module_function :str_to_int
+end

data/lib/ipconverter/version.rb

@@ -0,0 +1,3 @@
+module IpConverter
+  VERSION = "0.1.0"
+end

data/test/test_ipconverter.rb

@@ -0,0 +1,39 @@
+require 'ipconverter'
+require 'minitest/autorun'
+
+class TestIpConverter < MiniTest::Test
+  def setup
+  end
+
+  def test_smallest_ip
+    int = IpConverter.str_to_int "0.0.0.0"
+    assert_equal int, 0
+  end
+
+  def test_largest_ip
+    int = IpConverter.str_to_int "255.255.255.255"
+    # maximum 32-bit integer
+    assert_equal int, 256 * 256 * 256 * 256 - 1
+  end
+
+  def test_handles_spaces
+    int = IpConverter.str_to_int " 35.49.102.66 "
+    assert_equal int, IpConverter.str_to_int("35.49.102.66")
+  end
+  def test_no_overflow
+    assert_raises(ArgumentError) { IpConverter.str_to_int "12.12.0.256" }
+  end
+
+  def test_short_ip
+    assert_raises(ArgumentError) { IpConverter.str_to_int "12.34.56" }
+  end
+
+  def test_long_ip
+    assert_raises(ArgumentError) { IpConverter.str_to_int "12.34.56.78.90" }
+  end
+
+  def test_junk
+    assert_raises(ArgumentError) { IpConverter.str_to_int "junk" }
+  end
+
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: ipconverter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Fast C extension for converting IP addresses from string to integer
+email:
+- joshua.scott@gmail.com
+executables: []
+extensions:
+- ext/ipconverter/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bench.rb
+- ext/ipconverter/extconf.rb
+- ext/ipconverter/ipconverter.c
+- ext/ipconverter/ipconverter.h
+- ipconverter.gemspec
+- lib/ipconverter.rb
+- lib/ipconverter/version.rb
+- test/test_ipconverter.rb
+homepage: http://github.com/joshuawscott/ipconverter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Utilities for working with IP addresses
+test_files:
+- test/test_ipconverter.rb