resolv-hosts-dynamic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 625a6c978f45ec588d4b5711ba9812ff771df9bd
+  data.tar.gz: d8fe024b406abc13f2b5a673cc7a7966d01259d5
+SHA512:
+  metadata.gz: ddfc51c87e75e33ae548e17f9dd08ce5423a5a6c765d275419c521ba6cef2d5819547bfd7dcfcd707a622ebc91fb3dd45fa14cda7b24090bb4cd4a8751551b39
+  data.tar.gz: ccefb782906119fd46b398159d1e1f09d7a5aae83685187cbc2829a0a077634859eff689295312788d91b458aa8c50f97b369ba808367d253e37e50e9a393414

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format
+documentation
+--color

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Chris Reeves
+
+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,129 @@
+# Resolv::Hosts::Dynamic
+
+Dynamic in-memory 'hosts' file for resolving hostnames. Injects entries into
+an in-memory 'hosts' file which can later be used for name resolution without
+having to modify the system hosts file. This is an extension to the standard
+ruby Resolv library and is useful for over-riding name resolution during
+testing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resolv-hosts-dynamic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resolv-hosts-dynamic
+
+## Usage
+
+### Adding entries to the dynamic host resolver
+
+Entries can be added during class instantiation or at any point afterwards
+(via the `add_address` function) if we've still got a handle on the object. An
+entry consists of a hash with the `addr` and `hostname` properties, plus an
+optional `aliases` property. Entries added during class instantiation can be
+in the form of a single entry or an array of entries. `add_address` only
+accepts a single entry at a time.
+
+```ruby
+require 'resolv-hosts-dynamic'
+
+res = Resolv::Hosts::Dynamic.new([
+  {
+    'addr'     => '127.1.2.3',
+    'hostname' => 'host.example.com',
+  },
+  {
+    'addr'     => '127.4.5.6',
+    'hostname' => 'host2.example.com',
+    'aliases'  => 'host2',
+  },
+])
+
+res.add_address({
+  'addr'     => '127.7.8.9',
+  'hostname' => 'host3.example.com',
+  'aliases'  => [ 'host3', 'www.example.com' ],
+})
+```
+
+### Resolving hostnames/IPs
+
+This class can be used on its own or within the standard ruby Resolv library.
+
+On its own:
+```ruby
+require 'resolv-hosts-dynamic'
+
+res = Resolv::Hosts::Dynamic.new({
+  'addr'     => '127.1.2.3',
+  'hostname' => 'host.example.com',
+})
+
+res.getaddress('host.example.com')
+res.getname('127.1.2.3')
+```
+
+Within the standard ruby Resolv library:
+```ruby
+require 'resolv-hosts-dynamic'
+
+res = Resolv.new([
+  Resolv::Hosts::Dynamic.new({
+    'addr'     => '127.1.2.3',
+    'hostname' => 'host.example.com',
+  }),
+  Resolv::Hosts.new,
+  Resolv::DNS.new,
+])
+
+res.getaddress('host.example.com')
+res.getname('127.1.2.3')
+
+res.getaddresses('rubygems.org')
+```
+
+Replacing the default resolver in the standard ruby Resolv library (using
+`resolve-replace`):
+```ruby
+require 'resolv-hosts-dynamic'
+require 'resolv-replace'
+
+dynres = Resolv::Hosts::Dynamic.new({
+  'addr'     => '127.1.2.3',
+  'hostname' => 'host.example.com',
+})
+
+Resolv::DefaultResolver.replace_resolvers([
+  dynres,
+  Resolv::Hosts.new,
+  Resolv::DNS.new,
+])
+
+Resolv.getaddress('host.example.com')
+Resolv.getname('127.1.2.3')
+Resolv.getaddresses('www.google.com')
+
+dynres.add_address({
+  'addr'     => '127.4.5.6',
+  'hostname' => 'www.google.com',
+})
+
+Resolv.getaddresses('www.google.com')
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/chris-reeves/gem-resolv-hosts-dynamic/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,5 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/resolv-hosts-dynamic.rb

@@ -0,0 +1,104 @@
+require 'resolv'
+
+class Resolv
+  class Hosts
+    class Dynamic
+
+      def initialize(hosts = [])
+        @mutex = Mutex.new
+        @name2addr = {}
+        @addr2name = {}
+
+        hosts = [hosts] if !hosts.is_a? Array
+
+        hosts.each { |host|
+          self.add_address(host)
+        }
+      end
+
+      ##
+      # Adds +host+ to the custom resolver.
+
+      def add_address(host)
+        @mutex.synchronize {
+          addr = host['addr']
+          hostname = host['hostname']
+          aliases = host['aliases']
+
+          raise "Must specify 'addr' for host" unless addr
+          raise "Must specify 'hostname' for host" unless hostname
+
+          addr.untaint
+          hostname.untaint
+
+          # So that aliases can be passed a string or an array of strings
+          aliases = [aliases] if aliases.is_a? String
+
+          @addr2name[addr] = [] unless @addr2name.include? addr
+          @addr2name[addr] << hostname
+          @addr2name[addr] += aliases if aliases
+          @name2addr[hostname] = [] unless @name2addr.include? hostname
+          @name2addr[hostname] << addr
+          aliases.each {|n|
+            n.untaint
+            @name2addr[n] = [] unless @name2addr.include? n
+            @name2addr[n] << addr
+          } if aliases
+        }
+      end
+
+      ##
+      # Gets the IP address of +name+ from the custom resolver.
+
+      def getaddress(name)
+        each_address(name) {|address| return address}
+        raise ResolvError.new("No dynamic hosts entry for name: #{name}")
+      end
+
+      ##
+      # Gets all IP addresses for +name+ from the custom resolver.
+
+      def getaddresses(name)
+        ret = []
+        each_address(name) {|address| ret << address}
+        return ret
+      end
+
+      ##
+      # Iterates over all IP addresses for +name+ retrieved from the custom resolver.
+
+      def each_address(name, &proc)
+        if @name2addr.include?(name)
+          @name2addr[name].each(&proc)
+        end
+      end
+
+      ##
+      # Gets the hostname of +address+ from the custom resolver.
+
+      def getname(address)
+        each_name(address) {|name| return name}
+        raise ResolvError.new("No dynamic hosts entry for address: #{address}")
+      end
+
+      ##
+      # Gets all hostnames for +address+ from the custom resolver.
+
+      def getnames(address)
+        ret = []
+        each_name(address) {|name| ret << name}
+        return ret
+      end
+
+      ##
+      # Iterates over all hostnames for +address+ retrieved from the custom resolver.
+
+      def each_name(address, &proc)
+        if @addr2name.include?(address)
+          @addr2name[address].each(&proc)
+        end
+      end
+
+    end
+  end
+end

data/resolv-hosts-dynamic.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "resolv-hosts-dynamic"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Chris Reeves"]
+  spec.email         = ["chris.reeves@york.ac.uk"]
+  spec.summary       = %q{Dynamic in-memory 'hosts' file for resolving hostnames.}
+  spec.description   = %q{Dynamic in-memory 'hosts' file for resolving hostnames. Injects entries into an in-memory 'hosts' file which can later be used for name resolution without having to modify the system hosts file. This is an extension to the standard ruby Resolv library and is useful for over-riding name resolution during testing.}
+  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 "rspec"
+end

data/spec/resolv-hosts-dynamic_spec.rb

@@ -0,0 +1,287 @@
+require 'spec_helper'
+
+describe Resolv::Hosts::Dynamic do
+
+  describe '#initialize' do
+    context 'with an empty params list' do
+      res = Resolv::Hosts::Dynamic.new
+
+      it 'should have empty lookup maps' do
+        expect(
+          res.instance_variable_get(:@name2addr).empty?
+        ).to eq true
+
+        expect(
+          res.instance_variable_get(:@addr2name).empty?
+        ).to eq true
+      end
+    end
+
+    context 'with a single (hash) param' do
+      res = Resolv::Hosts::Dynamic.new({
+        'addr'     => '127.1.2.3',
+        'hostname' => 'host.example.com',
+      })
+
+      it 'should have a single record in the name2addr map' do
+        expect(
+          res.instance_variable_get(:@name2addr).size
+        ).to eq 1
+      end
+
+      it 'should have a single record in the addr2name map' do
+        expect(
+          res.instance_variable_get(:@addr2name).size
+        ).to eq 1
+      end
+    end
+
+    context 'with a single (array) param' do
+      res = Resolv::Hosts::Dynamic.new([
+        {
+          'addr'     => '127.1.2.3',
+          'hostname' => 'host.example.com',
+        },
+        {
+          'addr'     => '127.4.5.6',
+          'hostname' => 'host2.example.com',
+        },
+        {
+          'addr'     => '127.7.8.9',
+          'hostname' => 'host3.example.com',
+        },
+      ])
+
+      it 'should have three records in the name2addr map' do
+        expect(
+          res.instance_variable_get(:@name2addr).size
+        ).to eq 3
+      end
+
+      it 'should have three records in the addr2name map' do
+        expect(
+          res.instance_variable_get(:@addr2name).size
+        ).to eq 3
+      end
+    end
+  end
+
+  describe '#add_address' do
+    context 'with a simple hostname -> address map' do
+      res = Resolv::Hosts::Dynamic.new
+
+      res.add_address({
+        'addr'     => '127.1.2.3',
+        'hostname' => 'host.example.com',
+      })
+
+      it 'should map the hostname to the address' do
+        expect(
+          res.instance_variable_get(:@name2addr)['host.example.com']
+        ).to eq(['127.1.2.3'])
+      end
+
+      it 'should map the address to the hostname' do
+        expect(
+          res.instance_variable_get(:@addr2name)['127.1.2.3']
+        ).to eq(['host.example.com'])
+      end
+    end
+
+    context 'with a hostname plus a single alias' do
+      res = Resolv::Hosts::Dynamic.new
+
+      res.add_address({
+        'addr'     => '127.1.2.3',
+        'hostname' => 'host.example.com',
+        'aliases'  => 'host',
+      })
+
+      it 'should map the hostname to the address' do
+        expect(
+          res.instance_variable_get(:@name2addr)['host.example.com']
+        ).to eq(['127.1.2.3'])
+      end
+
+      it 'should map the alias to the address' do
+        expect(
+          res.instance_variable_get(:@name2addr)['host']
+        ).to eq(['127.1.2.3'])
+      end
+
+      it 'should map the address to the hostname and alias' do
+        expect(
+          res.instance_variable_get(:@addr2name)['127.1.2.3']
+        ).to eq(['host.example.com', 'host'])
+      end
+    end
+
+    context 'with a hostname plus multiple aliases' do
+      res = Resolv::Hosts::Dynamic.new
+
+      res.add_address({
+        'addr'     => '127.1.2.3',
+        'hostname' => 'host.example.com',
+        'aliases'  => [ 'host', 'host2' ],
+      })
+
+      it 'should map the hostname to the address' do
+        expect(
+          res.instance_variable_get(:@name2addr)['host.example.com']
+        ).to eq(['127.1.2.3'])
+      end
+
+      it 'should map both aliases to the address' do
+        expect(
+          res.instance_variable_get(:@name2addr)['host']
+        ).to eq(['127.1.2.3'])
+
+        expect(
+          res.instance_variable_get(:@name2addr)['host2']
+        ).to eq(['127.1.2.3'])
+      end
+
+      it 'should map the address to the hostname and the aliases' do
+        expect(
+          res.instance_variable_get(:@addr2name)['127.1.2.3']
+        ).to eq(['host.example.com', 'host', 'host2'])
+      end
+    end
+
+    context 'with multiple hostnames for the same address added in separate calls' do
+      res = Resolv::Hosts::Dynamic.new
+
+      res.add_address({
+        'addr'     => '127.1.2.3',
+        'hostname' => 'host.example.com',
+      })
+
+      res.add_address({
+        'addr'     => '127.1.2.3',
+        'hostname' => 'host2.example.com',
+      })
+
+      it 'should map both hostnames to the address' do
+        expect(
+          res.instance_variable_get(:@name2addr)['host.example.com']
+        ).to eq(['127.1.2.3'])
+
+        expect(
+          res.instance_variable_get(:@name2addr)['host2.example.com']
+        ).to eq(['127.1.2.3'])
+      end
+
+      it 'should map the address to both hostnames' do
+        expect(
+          res.instance_variable_get(:@addr2name)['127.1.2.3']
+        ).to eq(['host.example.com', 'host2.example.com'])
+      end
+    end
+
+    context 'with multiple addresses for the same hostname' do
+      res = Resolv::Hosts::Dynamic.new
+
+      res.add_address({
+        'addr'     => '127.1.2.3',
+        'hostname' => 'host.example.com',
+      })
+
+      res.add_address({
+        'addr'     => '127.4.5.6',
+        'hostname' => 'host.example.com',
+      })
+
+      it 'should map the hostname to both addresses' do
+        expect(
+          res.instance_variable_get(:@name2addr)['host.example.com']
+        ).to eq(['127.1.2.3', '127.4.5.6'])
+      end
+
+      it 'should map both addresses to the hostname' do
+        expect(
+          res.instance_variable_get(:@addr2name)['127.1.2.3']
+        ).to eq(['host.example.com'])
+
+        expect(
+          res.instance_variable_get(:@addr2name)['127.4.5.6']
+        ).to eq(['host.example.com'])
+      end
+    end
+  end
+
+  # takes the first ip if there are multiple IPs
+  describe 'resolver methods' do
+    dynres = Resolv::Hosts::Dynamic.new
+
+    # address with multiple names
+    dynres.add_address({
+      'addr'     => '127.1.2.3',
+      'hostname' => 'host.example.com',
+      'aliases'  => 'host'
+    })
+
+    # name with multiple addresses
+    dynres.add_address({
+      'addr'     => '127.4.5.6',
+      'hostname' => 'host.example.com',
+    })
+
+    res = Resolv.new([dynres])
+
+    describe '#getaddress' do
+      it 'resolves host.example.com to a single address' do
+        expect(
+          res.getaddress('host.example.com')
+        ).to eq '127.1.2.3'
+      end
+
+      it 'raises ResolvError if the name can not be looked up' do
+        expect{
+          res.getaddress('no.such.host.')
+        }.to raise_error(Resolv::ResolvError)
+      end
+    end
+
+    describe '#getaddresses' do
+      it 'resolves host.example.com to multiple addresses' do
+        expect(
+          res.getaddresses('host.example.com')
+        ).to eq [ '127.1.2.3', '127.4.5.6' ]
+      end
+
+      it 'resolves to no addresses if the name can not be looked up' do
+        expect(
+          res.getaddresses('no.such.host.').empty?
+        ).to be true
+      end
+    end
+
+    describe '#getname' do
+      it 'resolves 127.1.2.3 to a single hostname' do
+        expect(
+          res.getname('127.1.2.3')
+        ).to eq 'host.example.com'
+      end
+
+      it 'raises ResolvError if the address can not be looked up' do
+        expect{
+          res.getname('127.7.8.9')
+        }.to raise_error(Resolv::ResolvError)
+      end
+    end
+
+    describe '#getnames' do
+      it 'resolves 127.1.2.3 to a single hostname' do
+        expect(
+          res.getnames('127.1.2.3')
+        ).to eq [ 'host.example.com', 'host' ]
+      end
+
+      it 'resolves to no hostnames if the address can not be looked up' do
+        expect(
+          res.getnames('127.7.8.9').empty?
+        ).to be true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'resolv-hosts-dynamic'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: resolv-hosts-dynamic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Reeves
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-08 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: 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: Dynamic in-memory 'hosts' file for resolving hostnames. Injects entries
+  into an in-memory 'hosts' file which can later be used for name resolution without
+  having to modify the system hosts file. This is an extension to the standard ruby
+  Resolv library and is useful for over-riding name resolution during testing.
+email:
+- chris.reeves@york.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/resolv-hosts-dynamic.rb
+- resolv-hosts-dynamic.gemspec
+- spec/resolv-hosts-dynamic_spec.rb
+- spec/spec_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.4.3
+signing_key: 
+specification_version: 4
+summary: Dynamic in-memory 'hosts' file for resolving hostnames.
+test_files:
+- spec/resolv-hosts-dynamic_spec.rb
+- spec/spec_helper.rb