net-fping 0.2.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff8f5ae54f34481b98c2b3744124da8e57d6d0be
-  data.tar.gz: adb7a3ad0bcc3bf33569d5f5aef3959f3f756a45
+  metadata.gz: 0844a28f622940227eca27a24393106db83aca17
+  data.tar.gz: 1b41817221c7c2776abac62c6e08badb23e99ee0
 SHA512:
-  metadata.gz: aafb98dc4b5f6342e50427fb88e96c0bac6b68634706115ee72eae0ae7680e23759a2c812e49650fe6b65de3e0addab1080343ae26e9c865ec3f1a65daac36a6
-  data.tar.gz: 4eb76c23a432ec58cb3a74aa03e05b5904b34984925147681c7d398aa63b126ce7dd6d332365e2c7305e62c26d1ca8248382d4797a5313d3944d8e0f608b4bb4
+  metadata.gz: 72e415c0e5c4b60a783ca757f3beb52eb3e2d7dac27de2f4c2bb6dc68c70057efbfed5ea0e6e9c4909b79d3dba9fbd0e6855376d52c82b14d6744b8bf99f7aaf
+  data.tar.gz: 38b9cbc9b00dc12837aedfe6256cba14a8c803d7af373d2f936c065ed32a0af28e09d770a4df01a4abef1b7d215b932c94be7655dbd1f273573187b723659bc4

data/README.md

@@ -9,15 +9,46 @@ Pretty straight forward:
 ```ruby
 require 'net/fping'
 
-alive = Fping.alive(["10.0.0.1", "10.0.0.2", "10.0.0.3"])
+alive = Net::Fping.alive(["10.0.0.1", "10.0.0.2", "10.0.0.3"])
 > ["10.0.0.1", "10.0.0.3"]
 
-alive = Fping.dead(["10.0.0.1", "10.0.0.2", "10.0.0.3"])
+alive = Net::Fping.dead(["10.0.0.1", "10.0.0.2", "10.0.0.3"])
 > ["10.0.0.2"]
 
-alive = Fping.alive_in_subnet("192.168.0.0/24")
+alive = Net::Fping.alive_in_subnet("192.168.0.0/24")
 > ["192.168.0.1", "192.168.0.100", "192.168.0.254"]
 
-alive = Fping.alive_in_range("192.168.0.0", "192.168.0.200")
+alive = Net::Fping.alive_in_range("192.168.0.0", "192.168.0.200")
 > ["192.168.0.1", "192.168.0.100"]
 ```
+
+You can also specify the following options on each command (defaults as per fping shown):
+
+```ruby
+{
+  retries: 3,
+  count: 1,
+  bytes: 56,
+  interval: 25,
+  timeout: 500
+}
+```
+
+So this would be a faster way to ping a 16 bit subnet:
+
+```ruby
+alive = Net::Fping.alive_in_subnet("172.16.0.0/16", retries: 0)
+```
+
+You can also extract latencies:
+
+```ruby
+latencies = Net::Fping.latency("4.2.2.2", 68, 6, 1000)
+pp latencies
+> [
+  0,     # LOSS
+  13.7,  # MIN
+  15.5,  # AVG
+  17.3   # MAX
+]
+```

data/lib/net/fping.rb

@@ -4,24 +4,43 @@ module Net
   module Fping
     class << self
 
-      def alive(hosts=[])
+      def default_options
+        {
+          retries: 3,
+          count: 1,
+          bytes: 56,
+          interval: 25,
+          timeout: 500
+        }
+      end
+
+      def build_args(opts)
+        opts = default_options.merge(options)
+        "-c #{opts[:count]} -r #{opts[:retries]} -t #{opts[:timeout]} -i #{opts[:interval]} -b #{opts[:bytes]}"
+      end
+
+      def alive(hosts=[], **opts)
         return [] if hosts.empty?
-        %x[fping -a #{hosts.join(" ")} 2>/dev/null].split("\n");
+        args = build_args(opts)
+        %x[fping #{args} -a #{hosts.join(" ")} 2>/dev/null].split("\n");
       end
 
-      def dead(hosts=[])
+      def dead(hosts=[], **opts)
         return [] if hosts.empty?
-        %x[fping -u #{hosts.join(" ")} 2>/dev/null].split("\n")
+        args = build_args(opts)
+        %x[fping #{args} -u #{hosts.join(" ")} 2>/dev/null].split("\n")
       end
 
-      def alive_in_subnet(subnet)
-        %x[fping -ag #{subnet} 2>/dev/null].split("\n")
+      def alive_in_subnet(subnet, **opts)
+        args = build_args(opts)
+        %x[fping #{args} -ag #{subnet} 2>/dev/null].split("\n")
       end
 
-      def alive_in_range(from, to)
-        %x[fping -ag #{from} #{to} 2>/dev/null].split("\n")
+      def alive_in_range(from, to, **opts)
+        args = build_args(opts)
+        %x[fping #{args} -ag #{from} #{to} 2>/dev/null].split("\n")
       end
-      
+
       # Added defs for latency based metrics
       def latency_simple(host)
         bytes = 68
@@ -30,13 +49,13 @@ module Net
         %x[fping -b #{bytes} -c #{count} -q -p #{interval} #{host}]
       end
 
-      def latency(host, bytes, count, interval)
+      def latency(host, bytes, count, interval=1000)
         cmd = "fping -b #{bytes} -c #{count} -q -p #{interval} #{host}"
         Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
           # output is written to stderr for some reason
           ltc = stderr.read.gsub(/[%, ]/, "/")
           ltc = ltc.split(/.*loss\/=\/[0-9]+\/[0-9]+\/([0-9]+)\/\/\/min\/avg\/max\/=\/([0-9.]+)\/([0-9.]+)\/([0-9.]+)/)[-5..4]
-	  return ltc
+	        return ltc
         end
       end
 

data/net-fping.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "net-fping"
-  spec.version       = "0.2.1"
+  spec.version       = "0.3"
   spec.authors       = ["Robert McLeod"]
   spec.email         = ["robert@penguinpower.co.nz"]
   spec.description   = %q{Net-fping is an fping wrapper that allows fast ping checks on multiple remote hosts}
@@ -15,4 +15,3 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split($/)
   spec.require_paths = ["lib"]
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-fping
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
 platform: ruby
 authors:
 - Robert McLeod
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-13 00:00:00.000000000 Z
+date: 2016-05-30 00:00:00.000000000 Z
 dependencies: []
 description: Net-fping is an fping wrapper that allows fast ping checks on multiple
   remote hosts
@@ -41,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: fast ping checks using fping