igp 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07b9c7b783789ada3d21617353f4470d5145856e2f555454e7f09e37de0ef5c9
-  data.tar.gz: e733c5f176d331afebfd2b4ff57546555767febc77d514961c6383a88706146a
+  metadata.gz: dea3cd46567b9578ee580171eefef7ef44de44cd62acb3e809ba5644db1bdf8b
+  data.tar.gz: 1a2d1f5b44a460bf2b68d797b1d5c24b87f2130522db6d3e73ff2ecd451d210d
 SHA512:
-  metadata.gz: 720507197bc6f4325574027108b77474053dd64c832d0462611214e74875608eb6c2f025d2d5eff53d4ae867e39697dc8cbdbaf48f7918f0bd728650d103f466
-  data.tar.gz: dc0e4f4da5bae955da232efe4353fc62286e49073f431f38c0fad0e4b1c34b428d54d01608a0eabc448feab509418a86af027f1b9c386d41c2db5cb0f82065d5
+  metadata.gz: 0cbf84188e9ee2d1f7d50ac9e36b8d7d80260f134fd595de7032191821aae37b6b500f7ca5e5320d0c091d7be6e4c58ca9ba3629c1961e7366974890e87d15ce
+  data.tar.gz: 76c1fe528924bb24918cc721e1ee9b9aba476f577858356eff0f35442c1f38b1ef2e3cc017ae12136564a30dd0949f92081525b824bfdda179b4b806e6f89584

data/.github/workflows/ruby.yml

@@ -30,5 +30,7 @@ jobs:
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - name: Install dependencies
         run: bundle install
+      - name: Check Style
+        run: bundle exec rubocop
       - name: Run tests
         run: bundle exec rake

data/.gitignore

@@ -14,6 +14,8 @@
 Gemfile.lock
 .ruby-version
 .ruby-gemset
+*.gem
+pkg
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
@@ -21,9 +23,6 @@ Gemfile.lock
 # rcov generated
 coverage
 
-# jeweler generated
-pkg
-
 # logs
 log
 *.log

data/.rubocop_todo.yml

@@ -38,6 +38,7 @@ Style/ClassAndModuleChildren:
   Exclude:
     - 'lib/igp/base.rb'
     - 'lib/igp/shell.rb'
+    - 'lib/net/ping/ldap.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -72,8 +73,10 @@ Style/FrozenStringLiteralComment:
     - 'lib/igp/base.rb'
     - 'lib/igp/shell.rb'
     - 'lib/igp/version.rb'
+    - 'lib/net/ping/ldap.rb'
     - 'spec/base_spec.rb'
     - 'spec/format_spec.rb'
+    - 'spec/net/ping/ldap_spec.rb'
     - 'spec/shell_spec.rb'
     - 'spec/spec_helper.rb'
 

data/CHANGELOG

@@ -1,3 +1,14 @@
+Version 1.1.0                  Release: 2022-03-01
+==================================================
+
+* added back LDAP ping functionality (built-in for now)
+
+Version 1.0.0                  Release: 2022-03-01
+==================================================
+
+* updated to ruby 2.7+ and net-ping 2.0.8+
+* LDAP functionality removed (since dropped from net-ping)
+
 Version 0.0.3                Release: 7th May 2011
 ==================================================
 * more ruby 1.8.7 compatibility fixes:

data/igp.gemspec

@@ -20,14 +20,17 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'getoptions', '~> 0.3'
+  spec.add_runtime_dependency 'net-ldap', '~> 0.16.0'
   spec.add_runtime_dependency 'net-ping', '~> 2.0.8'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'fakeldap', '~> 0.1.1'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rb-fsevent'
   spec.add_development_dependency 'rdoc'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'ruby-ldapserver', '~> 0.5.0'
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/igp/base.rb

@@ -33,9 +33,8 @@ class Igp::Base
       @ping_handler = Net::Ping::TCP.new(@options[:host], @options[:port])
     when :http, :https
       @ping_handler = Net::Ping::HTTP.new(@options[:url])
-    # TODO: LDAP was retired from net-ping. to add back in one way or another
-    # when :ldap, :ldaps
-    #   @ping_handler = Net::Ping::LDAP.new(@options[:url])
+    when :ldap, :ldaps
+      @ping_handler = Net::Ping::LDAP.new(@options[:url])
     end
   end
 

data/lib/igp/shell.rb

@@ -52,8 +52,7 @@ class Igp::Shell
   # runs the ping task
   def run
     case options[:type]
-    # TODO: LDAP was retired from net-ping. to add back in one way or another
-    when :icmp, :http, :https, :tcp, :udp # :ldap, :ldaps
+    when :icmp, :http, :https, :tcp, :udp, :ldap, :ldaps
       Igp::Base.new(options).run
     else
       usage
@@ -101,10 +100,10 @@ class Igp::Shell
           igp http://localhost:8080
           igp https://localhost:4443
 
+        LDAP/S ping:
+          igp ldap://localhost
+          igp ldaps://localhost:6636
+
     EOS
-    # TODO: LDAP was retired from net-ping. to add back in one way or another
-    # LDAP/S ping:
-    #   igp ldap://localhost
-    #   igp ldaps://localhost:6636
   end
 end

data/lib/igp/version.rb

@@ -1,3 +1,3 @@
 class Igp
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/igp.rb

@@ -1,4 +1,5 @@
 require 'net/ping'
+require 'net/ping/ldap'
 require 'igp/version'
 require 'igp/shell'
 require 'igp/base'

data/lib/net/ping/ldap.rb

@@ -0,0 +1,105 @@
+require 'net/ping'
+require 'net/ldap'
+require 'uri'
+
+# The Net module serves as a namespace only.
+module Net
+  # The Ping::LDAP class encapsulates methods for LDAP pings.
+  class Ping::LDAP < Ping
+    # uri contains the URI object for the request
+    #
+    attr_accessor :uri
+
+    # username and password may be set for ping using
+    # an authenticated LDAP bind
+    #
+    attr_accessor :username
+    attr_accessor :password
+
+    # set/get the encryption method. By default nil,
+    # but may be set to :simple_tls
+    #
+    attr_reader :encryption
+
+    def encryption=(value)
+      @encryption = value.is_a?(Symbol) ? value : value.to_sym
+    end
+
+    # Creates and returns a new Ping::LDAP object.
+    # The default +timeout+ is 5 seconds.
+    #
+    # +uri+ string is expected to be a full URI with scheme (ldap/ldaps)
+    # and optionally the port (else default port is assumed) e.g.
+    #   ldap://my.ldap.host.com
+    #   ldap://my.ldap.host.com:1389
+    #   ldaps://my.ldap.host.com
+    #   ldaps://my.ldap.host.com:6636
+    #
+    # If a plain hostname is provided as the +uri+, a default port of 389 is assumed
+    #
+    def initialize(uri = nil, timeout = 5)
+      host, port = decode_uri(uri)
+      super(host, port, timeout)
+    end
+
+    # method used to decode uri string
+    #
+    def decode_uri(value)
+      @uri = URI.parse(value)
+      if uri.scheme =~ /ldap/
+        p = @port = uri.port
+        h = @host = uri.host
+        @encryption = uri.scheme == 'ldaps' ? :simple_tls : nil
+      else
+        h = value
+        p = 389
+      end
+      [h, p]
+    end
+
+    # constructs the LDAP configuration structure
+    #
+    def config
+      {
+        host: uri.host,
+        port: uri.port,
+        encryption: encryption
+      }.merge(
+        if username && password
+          { auth: { method: :simple, username: username, password: password } }
+        else
+          { auth: { method: :anonymous } }
+        end
+      )
+    end
+
+    # perform ping, optionally providing the ping destination uri
+    #
+    def ping(host = nil)
+      decode_uri(host) if host
+      super(@host)
+
+      bool = false
+
+      start_time = Time.now
+
+      begin
+        Timeout.timeout(@timeout) do
+          Net::LDAP.new(config).bind
+        end
+      rescue StandardError => e
+        @exception = e.message
+      else
+        bool = true
+      end
+
+      # There is no duration if the ping failed
+      @duration = Time.now - start_time if bool
+
+      bool
+    end
+
+    alias ping? ping
+    alias pingecho ping
+  end
+end

data/spec/base_spec.rb

@@ -40,17 +40,16 @@ describe Igp::Base do
       base = Igp::Base.new(options)
       expect(base.ping_handler).to be_a(Net::Ping::HTTP)
     end
-    # TODO: LDAP was retired from net-ping. to add back in one way or another
-    # it 'should be Net::Ping::LDAP for :ldap' do
-    #   options = { type: :ldap, url: 'ldap://localhost' }
-    #   base = Igp::Base.new(options)
-    #   expect(base.ping_handler).to be_a(Net::Ping::LDAP)
-    # end
-    # it 'should be Net::Ping::LDAP for :ldaps' do
-    #   options = { type: :ldaps, url: 'ldaps://localhost' }
-    #   base = Igp::Base.new(options)
-    #   expect(base.ping_handler).to be_a(Net::Ping::LDAP)
-    # end
+    it 'should be Net::Ping::LDAP for :ldap' do
+      options = { type: :ldap, url: 'ldap://localhost' }
+      base = Igp::Base.new(options)
+      expect(base.ping_handler).to be_a(Net::Ping::LDAP)
+    end
+    it 'should be Net::Ping::LDAP for :ldaps' do
+      options = { type: :ldaps, url: 'ldaps://localhost' }
+      base = Igp::Base.new(options)
+      expect(base.ping_handler).to be_a(Net::Ping::LDAP)
+    end
   end
 
   describe '#run' do

data/spec/net/ping/ldap_spec.rb

@@ -0,0 +1,193 @@
+require 'spec_helper'
+require 'fakeldap'
+
+describe Net::Ping::LDAP do
+  before :all do
+    @ldap_server = FakeLDAP::Server.new(port: 2389)
+    @ldap_server.run_tcpserver
+    @ldap_server.add_user('cn=el.Daper,ou=USERS,dc=example,dc=com', 'ldappassword')
+  end
+
+  after :all do
+    @ldap_server.stop
+  end
+
+  context 'when valid ldap url' do
+    let(:timeout) { 30 }
+    let(:cn) { 'el.Daper' }
+    let(:password) { 'ldappassword' }
+    let(:uri) { 'ldap://localhost:2389' }
+    subject(:ldap) do
+      ldap = Net::Ping::LDAP.new(uri, timeout)
+      ldap.username = cn
+      ldap.password = password
+      ldap
+    end
+
+    describe '#ping' do
+      subject { ldap.ping }
+      it 'ping basic functionality' do
+        expect { subject }.to_not raise_error
+        expect(subject).to eql(true)
+      end
+    end
+    describe '#ping?' do
+      subject { ldap.ping? }
+      it 'returns a boolean' do
+        expect(subject).to eql(true)
+      end
+    end
+    describe '#pingecho' do
+      subject { ldap.pingecho }
+      it 'returns a boolean' do
+        expect(subject).to eql(true)
+      end
+    end
+    describe '#duration' do
+      subject { ldap.duration }
+      before  { ldap.ping }
+      it 'returns a float' do
+        expect(subject).to be_a(Float)
+      end
+    end
+  end
+
+  context 'when bad ldap url' do
+    let(:uri) { 'ldap://blabfoobarurghxxxx.com' }
+    subject(:ldap) { Net::Ping::LDAP.new(uri) }
+    describe '#ping' do
+      subject { ldap.ping }
+      it 'ping basic functionality' do
+        expect { subject }.to_not raise_error
+        expect(subject).to eql(false)
+      end
+    end
+    describe '#ping?' do
+      subject { ldap.ping? }
+      it 'returns a boolean' do
+        expect(subject).to eql(false)
+      end
+    end
+    describe '#pingecho' do
+      subject { ldap.pingecho }
+      it 'returns a boolean' do
+        expect(subject).to eql(false)
+      end
+    end
+    describe '#duration' do
+      subject { ldap.duration }
+      before  { ldap.ping }
+      it 'returns nil' do
+        expect(subject).to be_nil
+      end
+    end
+  end
+
+  # test 'host attribute basic functionality' do
+  #   assert_respond_to(@ldap, :host)
+  #   assert_respond_to(@ldap, :host=)
+  #   assert_equal(@@host, @ldap.host)
+  # end
+
+  # test 'port attribute basic functionality' do
+  #   assert_respond_to(@ldap, :port)
+  #   assert_respond_to(@ldap, :port=)
+  # end
+
+  # test 'port attribute expected value' do
+  #   assert_equal(@@port, @ldap.port)
+  # end
+
+  # test 'timeout attribute basic functionality' do
+  #   assert_respond_to(@ldap, :timeout)
+  #   assert_respond_to(@ldap, :timeout=)
+  # end
+
+  # test 'timeout attribute expected values' do
+  #   assert_equal(@@timeout, @ldap.timeout)
+  #   assert_equal(5, @bad.timeout)
+  # end
+
+  # test 'exception attribute basic functionality' do
+  #   assert_respond_to(@ldap, :exception)
+  #   assert_nil(@ldap.exception)
+  # end
+
+  # test 'exception attribute is nil if the ping is successful' do
+  #   assert_true(@ldap.ping)
+  #   assert_nil(@ldap.exception)
+  # end
+
+  # test 'exception attribute is not nil if the ping is unsuccessful' do
+  #   assert_false(@bad.ping)
+  #   assert_not_nil(@bad.exception)
+  # end
+
+  # test 'warning attribute basic functionality' do
+  #   assert_respond_to(@ldap, :warning)
+  #   assert_nil(@ldap.warning)
+  # end
+
+  # test 'uri attribute basic functionality' do
+  #   assert_respond_to(@ldap, :uri)
+  #   assert_respond_to(@ldap, :uri=)
+  # end
+
+  # test 'username attribute basic functionality' do
+  #   assert_respond_to(@ldap, :username)
+  #   assert_respond_to(@ldap, :username=)
+  # end
+
+  # test 'password attribute basic functionality' do
+  #   assert_respond_to(@ldap, :password)
+  #   assert_respond_to(@ldap, :password=)
+  # end
+
+  # test 'encryption attribute basic functionality' do
+  #   assert_respond_to(@ldap, :encryption)
+  #   assert_respond_to(@ldap, :encryption=)
+  # end
+
+  # test 'encryption defaults to nil for ldap' do
+  #   assert_nil(Net::Ping::LDAP.new('ldap://somehost.example.net').encryption)
+  # end
+
+  # test 'encryption defaults to simple_tls for ldaps' do
+  #   assert_equal(:simple_tls, Net::Ping::LDAP.new('ldaps://somehost.example.net').encryption)
+  # end
+
+  # test 'port defaults to 389 for ldap' do
+  #   assert_equal(389, Net::Ping::LDAP.new('ldap://somehost.example.net').port)
+  # end
+
+  # test 'port defaults to 636 for ldaps' do
+  #   assert_equal(636, Net::Ping::LDAP.new('ldaps://somehost.example.net').port)
+  # end
+
+  # test 'port extracted from uri if provided' do
+  #   assert_equal(12345, Net::Ping::LDAP.new('ldap://somehost.example.net:12345').port)
+  #   assert_equal(12345, Net::Ping::LDAP.new('ldaps://somehost.example.net:12345').port)
+  # end
+
+  # test 'encryption setting is forced to symbol' do
+  #   @ldap.encryption = 'simple_tls'
+  #   assert_true( @ldap.encryption.is_a? Symbol )
+  #   assert_true( @ldap.config[:encryption].is_a? Symbol )
+  # end
+
+  # test 'username/password set in config auth section' do
+  #   @ldap.username, @ldap.password = 'fred', 'derf'
+  #   assert_equal('fred', @ldap.config[:auth][:username] )
+  #   assert_equal('derf', @ldap.config[:auth][:password] )
+  # end
+
+  # test 'auth method defaults to simple if username/password set' do
+  #   @ldap.username, @ldap.password = 'fred', 'derf'
+  #   assert_equal(:simple, @ldap.config[:auth][:method] )
+  # end
+
+  # test 'if no username/password then defaults to auth anonymous' do
+  #   @ldap.username = @ldap.password = nil
+  #   assert_equal({:method => :anonymous}, @ldap.config[:auth] )
+  # end
+end

data/spec/shell_spec.rb

@@ -117,44 +117,43 @@ describe Igp::Shell do
     end
   end
 
-  # TODO: LDAP was retired from net-ping. to add back in one way or another
-  # describe 'ldap configuration' do
-  #   before(:each) do
-  #     @type = :ldap
-  #     @host = 'localhost'
-  #     @port = 389
-  #     @options_server_value = "#{@type}://#{@host}"
-  #     @shell = Igp::Shell.new(GetOptions.new(Igp::Shell::OPTIONS, []), [@options_server_value])
-  #   end
-  #   it 'should support url accessor' do
-  #     expect(@shell.options[:url]).to eql(@options_server_value)
-  #   end
-  #   it 'should default to tcp ping with url when given server with tcp protocol setting' do
-  #     expect(@shell.options[:type]).to eql(@type)
-  #   end
-  #   it 'should resolve host/port' do
-  #     expect(@shell.options[:host]).to eql(@host)
-  #     expect(@shell.options[:port]).to eql(@port)
-  #   end
-  # end
+  describe 'ldap configuration' do
+    before(:each) do
+      @type = :ldap
+      @host = 'localhost'
+      @port = 389
+      @options_server_value = "#{@type}://#{@host}"
+      @shell = Igp::Shell.new(GetOptions.new(Igp::Shell::OPTIONS, []), [@options_server_value])
+    end
+    it 'should support url accessor' do
+      expect(@shell.options[:url]).to eql(@options_server_value)
+    end
+    it 'should default to tcp ping with url when given server with tcp protocol setting' do
+      expect(@shell.options[:type]).to eql(@type)
+    end
+    it 'should resolve host/port' do
+      expect(@shell.options[:host]).to eql(@host)
+      expect(@shell.options[:port]).to eql(@port)
+    end
+  end
 
-  # describe 'ldaps configuration' do
-  #   before(:each) do
-  #     @type = :ldaps
-  #     @host = 'localhost'
-  #     @port = 636
-  #     @options_server_value = "#{@type}://#{@host}"
-  #     @shell = Igp::Shell.new(GetOptions.new(Igp::Shell::OPTIONS, []), [@options_server_value])
-  #   end
-  #   it 'should support url accessor' do
-  #     expect(@shell.options[:url]).to eql(@options_server_value)
-  #   end
-  #   it 'should default to tcp ping with url when given server with tcp protocol setting' do
-  #     expect(@shell.options[:type]).to eql(@type)
-  #   end
-  #   it 'should resolve host/port' do
-  #     expect(@shell.options[:host]).to eql(@host)
-  #     expect(@shell.options[:port]).to eql(@port)
-  #   end
-  # end
+  describe 'ldaps configuration' do
+    before(:each) do
+      @type = :ldaps
+      @host = 'localhost'
+      @port = 636
+      @options_server_value = "#{@type}://#{@host}"
+      @shell = Igp::Shell.new(GetOptions.new(Igp::Shell::OPTIONS, []), [@options_server_value])
+    end
+    it 'should support url accessor' do
+      expect(@shell.options[:url]).to eql(@options_server_value)
+    end
+    it 'should default to tcp ping with url when given server with tcp protocol setting' do
+      expect(@shell.options[:type]).to eql(@type)
+    end
+    it 'should resolve host/port' do
+      expect(@shell.options[:host]).to eql(@host)
+      expect(@shell.options[:port]).to eql(@port)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: igp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Gallagher
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: net-ping
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-ldapserver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 description: 'Simple command-line server monitoring with a range of protocols: ICMP,
   TCP, UDP, HTTP/S, LDAP/S'
 email:
@@ -161,8 +203,10 @@ files:
 - lib/igp/base.rb
 - lib/igp/shell.rb
 - lib/igp/version.rb
+- lib/net/ping/ldap.rb
 - spec/base_spec.rb
 - spec/format_spec.rb
+- spec/net/ping/ldap_spec.rb
 - spec/shell_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/tardate/igp
@@ -192,5 +236,6 @@ summary: It goes PING!
 test_files:
 - spec/base_spec.rb
 - spec/format_spec.rb
+- spec/net/ping/ldap_spec.rb
 - spec/shell_spec.rb
 - spec/spec_helper.rb