kdwatch 0.4.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50e6ea6a1e81ab7f17173c1251395a6fbeb1a4b4c236d1c9c6fd1731f3118ca8
-  data.tar.gz: 31235eb66b35d5c39ebd1f124e938dfcc9b3f305a020ddf05dc610b7e8832707
+  metadata.gz: 78de5f5fc93f9cab8290038be3ef8671ad55616aa894a1adc8065ddaee91afe5
+  data.tar.gz: 8bbc03a04d4924a48ba6b44f911ae7e081f5e5c01d5e18bfd7b181efb50afeb7
 SHA512:
-  metadata.gz: 39e2d6062ef4adf87ce11d05c2d18e4d305de91e8212d1c204bc7bd0b8c8086f3c662e59deeaa284779f326bebdbd3c06af6ec993c4bc3ad4ad0dea0a468ee80
-  data.tar.gz: 9db4d837a11aea7413de4362bc418cb56fb2f987dc926ab722bd1b8be06850a2a2e51110e78dd75caebec5b2b7280e0b14592910f00478879b127e8724d0b070
+  metadata.gz: c1401f0029d6a39e348d22c35a53e541f70400300dcf2fd0ddf60474733ca4871039a8e3890a16c5ba70dcf48e3a823ed6acf5f1248ebb2fa80af49f0ce8ec06
+  data.tar.gz: 4bd5673bb06462c267ff344509c6ec9c280a2d9856d8fe31cb98503de0a544b1ade1b4f6c095e558487b572e2f8482599bc958856814a5a95a48077386b67d5c

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Carsten Bormann
+Copyright (c) 2021, 2022 Carsten Bormann
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -51,9 +51,11 @@ There can only be one kdwatch active on each host and port.  You will
 need to specify a different port (or host!) to run more than one
 kdwatch at the same time.
 
-* `-p port` to select a port number (default: 7991)
-* `-1` to `6` as a shortcut for `-p 7991` (default) to `-p 7996` (must be last
+* `-p port` to select a specific port number
+* `-1` to `6` as a shortcut for `-p 7991` to `-p 7996` (must be last
   option because of an idiosyncrasy of the optionparser library)
+* if no port number is given, `kdwatch` will hunt for a port number
+  that doesn't have a listener, starting with 7991.
 
 kdwatch has two flags to simplify handling servers that might be
 accumulating on one host/port:
@@ -64,18 +66,19 @@ accumulating on one host/port:
 So the most likely use is going to be:
 
 ```
-kdwatch -r
+kdwatch
 ```
 
-or maybe
+to start a new server on a new port number.
+
+These tend to accumulate a bit, so sometimes you'll want to replace an
+existing one (here: port number 7992):
 
 ```
 kdwatch -r2
 ```
 
-for the second draft you are editing at the same time,
-
-or, if your drafts are weirdly named or you need to select one out of
+If your drafts are weirdly named or you need to select one out of
 many
 
 ```
@@ -118,6 +121,35 @@ another laptop), and save some screen real-estate on your laptop.
 With a globally routable address, kdwatch even can be used for joint
 viewing in a team.
 
+### Finding and accessing kdwatch servers
+
+The `kds` tool can list active local (127.0.0.1) kdwatch servers and
+optionally quickly open the page for a selected kdwatch server.
+
+```
+Usage: kds [options] [match...]
+Version: n.m.l (from kdwatch)
+    -v, --version                    Show version and exit
+    -h, --help                       Show option summary and exit
+    -f, --from=NUM                   Search from port number (7991)
+    -t, --to=NUM                     Search to port number (7999)
+```
+
+```
+$ kds
+http://127.0.0.1:7991  Packed CBOR
+http://127.0.0.1:7992  Concise Problem Details For CoAP APIs
+$ kds prob
+http://127.0.0.1:7991  Packed CBOR
+http://127.0.0.1:7992  Concise Problem Details For CoAP APIs
+(...web page http://127.0.0.1:7992 opens...)
+$
+```
+
+Any match arguments are concatenated with spaces; for servers that
+offer a page with the match string in the title (case insensitive), a
+window is opened in the default browser.
+
 ## Feedback, please
 
 This has only been tested on macOS and briefly on Linux.  No idea about WSL.

data/bin/kds

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+require 'socket'
+require 'uri'
+require 'open-uri'
+require 'optparse'
+
+KDWATCH_VERSION=Gem.loaded_specs["kdwatch"].version rescue "unknown-version"
+
+loport = 7991
+hiport = 7999
+match = nil
+
+op = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Usage: kds [options] [match...]
+Version: #{KDWATCH_VERSION} (from kdwatch)
+BANNER
+  opts.on("-v", "--version", "Show version and exit") do |v|
+    puts "kds, from kdwatch #{KDWATCH_VERSION}"
+    exit
+  end
+  opts.on("-h", "--help", "Show option summary and exit") do |v|
+    puts opts
+    exit
+  end
+  opts.on("-fNUM", "--from=NUM", Integer, "Search from port number (#{loport})") do |v|
+    loport = v
+  end
+  opts.on("-tNUM", "--to=NUM", Integer, "Search to port number (#{hiport})") do |v|
+    hiport = v
+  end
+end
+op.parse!
+
+if ARGV.size != 0
+  match = ARGV.join(" ")
+end
+
+(loport..hiport).each do |p|
+  url = "http://127.0.0.1:#{p}"
+  URI(url).open do |f|
+    s = f.readpartial(40000)
+    sc = s.scan(/id="title".*?<|Internal server error/)
+    sc.each do |scl|
+      scl.sub!(/id="title">/, "")
+      scl.chomp!('<')
+      puts "#{url}  #{scl}"
+      if match && scl.downcase.include?(match.downcase)
+        spawn("open #{url} || xdg-open #{url} || echo @@@ Please open #{url}")
+      end
+      break
+    end
+  end rescue nil
+end

data/bin/kdwatch

@@ -6,11 +6,24 @@ ENV["KRAMDOWN_PERSISTENT"]="yes"
 
 require 'optparse'
 require 'ostruct'
+require 'socket'
 
 require_relative "../lib/kdwatch/version"
 
 KDWATCH_PORT = 7991             # currently unregistered...
 
+def socket_is_free(host, port, uri)
+  begin
+    TCPSocket.new(host, port, connect_timeout: 1)
+  rescue Errno::ECONNREFUSED => e
+    return true
+  rescue => e
+    warn "*** #{uri} -- #{e.inspect}"
+    return nil                  # break, but don't use
+  end
+  return false
+end
+
 options = OpenStruct.new
 
 op = OptionParser.new do |opts|
@@ -30,7 +43,7 @@ BANNER
   opts.on("-r", "--[no-]replace", "Replace existing server")
   opts.on("-oNAME", "--host=NAME", String, "Server host (127.0.0.1)")
   opts.on("-i", "--internet", 'Abbr. "on the Internet" (host = "::")')
-  opts.on("-pNUM", "--port=NUM", Integer, "Port number (#{KDWATCH_PORT})")
+  opts.on("-pNUM", "--port=NUM", Integer, "Port number (#{KDWATCH_PORT}...)")
   opts.on("-[1-6]", "--[1-6]", Integer, "Abbr. port number (#{KDWATCH_PORT/10}x), must be last")
 end
 begin
@@ -52,7 +65,26 @@ if short_port = options[""]
   warn "** overriding port #{options.port} with #{port}" if options.port
   options.port = port
 else
-  options.port ||= KDWATCH_PORT
+  unless options.port
+    port = KDWATCH_PORT
+    host = options.host
+    host = "[#{host}]" if host =~ /:/
+    uri = nil
+    found = false
+    100.times do
+      uri = "http://#{host}:#{port}"
+      # warn "Trying URI #{uri}"
+      found = socket_is_free(options.host, port, uri)
+      break unless found == false
+      port += 1
+    end
+    unless found
+      warn "*** Cannot find port number available to serve from!"
+      exit 1
+    end
+    warn "*** Using URI: #{uri}"
+    options.port = port
+  end
 end
 
 # p options

data/kdwatch.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.executables   = ['kdwatch']
+  spec.executables   = ['kdwatch', 'kds']
   spec.require_paths = ["lib"]
 
   spec.add_dependency "bundler", '~> 2.2'

data/lib/kdwatch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kdwatch
-  VERSION = "0.4.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kdwatch
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,6 +127,7 @@ email:
 - cabo@tzi.org
 executables:
 - kdwatch
+- kds
 extensions: []
 extra_rdoc_files: []
 files:
@@ -134,6 +135,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- bin/kds
 - bin/kdwatch
 - kdwatch.gemspec
 - lib/kdwatch-app.rb
@@ -157,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: 'kdwatch: open auto-reloaded HTML for kramdown-rfc in a browser.'