lita-netping 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4be87eefd9a97bf9ee291760508ae033132bb41
-  data.tar.gz: ee2ea65ebdfec3986c5e3f591f99e4ee0691763b
+  metadata.gz: d8b70c3c276083c25dbe1a73adc20556f6a78e8e
+  data.tar.gz: fb9bf4ea069a8903e733a1b98cb42675a525ce6a
 SHA512:
-  metadata.gz: bb13f837813965d634239ac1a75686906c7e43fa26aa8126d63741c6e89dc899c585d69b063883f1d54058021ba8424af94040e1b8dac8b6308a28d43737b992
-  data.tar.gz: 00d7d3f926f31acb8feba3860b16e4b63fd4fd2799b6cec06b99ac02c140449db22d99f53295cbd29011aece8b9201fea4b74684b5e69bf66352bb7f6998f4a5
+  metadata.gz: e001e199b299409e30e1e1b85c08f1676f3bc159db605cd6b8bf935734a7e28183018d6c3f70e7a1c97c0092321627d1c7084c3c8596074ea33422a32a077d69
+  data.tar.gz: 7d244947a8a562b38a5350bb08240a6261425681ba812ccf08e09099e4694222eb90fd85fca11b29a3d7c49cf9d788bf26a4a7e05ea6fc7d64b23b86f5a6197e

data/.travis.yml

@@ -1,8 +1,7 @@
 language: ruby
 rvm:
-  - 2.1
-script: bundle exec rake
-before_install:
-  - gem update --system
+  - 2.2.5
+  - 2.3.1
 services:
   - redis-server
+cache: bundler

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+Pull requests are awesome!  Pull requests with tests are even more awesome!
+
+## Quick steps
+
+1. Fork the repo.
+2. Run the tests: `bundle && rake`
+3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, it needs a test!
+4. Make the test pass.
+5. Push to your fork and submit a pull request.

data/README.md

@@ -26,18 +26,28 @@ none
 Examples:
 
 ```
-ping google.com - Ping google.com
+ping google.com - Ping google.com via normal ICMP
+ping icmp google.com - Ping google.com via normal ICMP (same as above)
+ping http://www.google.com - Ping google.com via HTTP
+ping tcp://ldap.server:389 - Ping a TCP service running on ldap.server on port 389
+ping tcp app.server:8080 - Ping a TCP service running on app.server on port 8080
 ```
 
+Supported protocols are:
+
+* `http` - Ping a web service. It is usually simplest to just specify the URI like you would in a web browser.
+* `icmp` - The default if none is specified. This is your standard ping.
+* `tcp` - Verify that a TCP service is listening and responding. Note that this doesn't guarantee that the service is not misbehaving, just that it responds on the proper port.
+
 Syntax:
 
 ```
-ping <target> - Ping <target> (either DNS or IP address)
+ping [protocol] <target> - Ping <target> (either DNS name, IP address, or URI)
 ```
 
 ## Note
 
-This plugin uses the net-ping library, and the "Net::Ping::External" check,
+This plugin uses the net-ping library, and the ICMP ping uses the "Net::Ping::External" check,
 so it will use the "ping" equivalent on whatever host it's running on.
 
 ## License

data/lib/lita-netping.rb

@@ -7,3 +7,4 @@ Lita.load_locales Dir[File.expand_path(
 require 'lita/handlers/netping'
 
 require 'net/ping'
+require 'uri'

data/lib/lita/handlers/netping.rb

@@ -2,7 +2,7 @@ module Lita
   module Handlers
     class Netping < Handler
       route(
-        /^ping\s(?<target>.+)/,
+        /^ping(\s+(?<proto>\S+))?\s(?<target>\S+)/,
         :ping,
         command: true,
         help: {
@@ -11,13 +11,34 @@ module Lita
       )
 
       def ping(response)
+        proto  = response.match_data['proto'] || 'icmp'
         target = response.match_data['target']
 
-        response.reply(format(target, ping_target(target)))
+        # Update the protocol based on the target
+        proto = URI(target).scheme if target =~ %r{^(\S+)://\S+}
+
+        if valid_protocol?(proto)
+          response.reply(format(target, ping_target(proto.downcase, target)))
+        else
+          response.reply(t('ping.unsupported', proto: proto))
+        end
       end
 
       private
 
+      def extract_host_and_port(target)
+        if target =~ %r{^(\S+)://\S+}
+          host = URI(target).host
+          port = URI(target).port
+        elsif target =~ /:[0-9]+$/
+          host, _, port = target.rpartition(':')
+        else
+          host = target
+          port = nil
+        end
+        [host, port]
+      end
+
       def format(host, result)
         if result
           t('ping.success', host: host)
@@ -26,8 +47,25 @@ module Lita
         end
       end
 
-      def ping_target(host)
-        Net::Ping::External.new(host).ping
+      def ping_target(proto, target)
+        # dissect the target to get the hostname and port
+        host, port = extract_host_and_port(target)
+
+        case proto
+        when 'http'
+          # With HTTP, we can just pass the target
+          p = Net::Ping::HTTP.new(target)
+        when 'icmp'
+          # The default
+          p = Net::Ping::External.new(host)
+        when 'tcp'
+          p = Net::Ping::TCP.new(host, port)
+        end
+        proto == 'icmp' ? p.ping(host, 1, 1, 1) : p.ping
+      end
+
+      def valid_protocol?(proto)
+        %w(http icmp tcp).include?(proto.downcase)
       end
     end
 

data/lita-netping.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-netping'
-  spec.version       = '0.5.0'
+  spec.version       = '0.6.0'
   spec.authors       = ['Eric Sigler']
   spec.email         = ['me@esigler.com']
   spec.description   = 'An IP ping plugin for Lita'
@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.metadata      = { 'lita_plugin_type' => 'handler' }
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  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_runtime_dependency 'lita', '>= 4.0'

data/locales/en.yml

@@ -4,8 +4,9 @@ en:
       netping:
         help:
           ping:
-            syntax: ping <target>
-            desc: Ping <target> (either DNS or IP address)
+            syntax: ping [protocol] <target>
+            desc: Ping [protocol] <target> (either DNS or IP address)
         ping:
           success: "%{host} responded to ping"
           fail: "%{host} did not respond to ping"
+          unsupported: "%{proto} is not a supported protocol"

data/spec/lita/handlers/netping_spec.rb

@@ -11,9 +11,29 @@ describe Lita::Handlers::Netping, lita_handler: true do
       expect(replies.last).to eq('example.com responded to ping')
     end
 
+    it 'returns a success if the target is pingable via HTTP' do
+      send_command('ping http example.com')
+      expect(replies.last).to eq('example.com responded to ping')
+    end
+
+    it 'returns a success if the target is pingable via TCP' do
+      send_command('ping tcp 127.0.0.1:6379')
+      expect(replies.last).to eq('127.0.0.1:6379 responded to ping')
+    end
+
+    it 'returns a success if the target is pingable via TCP as a URI' do
+      send_command('ping tcp://127.0.0.1:6379')
+      expect(replies.last).to eq('tcp://127.0.0.1:6379 responded to ping')
+    end
+
     it 'returns a failure if the target is not pingable' do
       send_command('ping unknownhost.local')
       expect(replies.last).to eq('unknownhost.local did not respond to ping')
     end
+
+    it 'returns a failure if the protocol is not supported' do
+      send_command('ping xmpp://jabber.org')
+      expect(replies.last).to eq('xmpp is not a supported protocol')
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'simplecov'
 require 'coveralls'
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
 ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-netping
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Eric Sigler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -132,6 +132,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -163,10 +164,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: An IP ping plugin for Lita
 test_files:
 - spec/lita/handlers/netping_spec.rb
 - spec/spec_helper.rb
+has_rdoc: