net-knocker 0.0.3 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a06a05f3713cda7540c42ceb9d72543471b226bd9874d6d83fc1c1156e8d923
-  data.tar.gz: 55310cefb6bfa19cbaac755de7611fc6ceb320b00cfb60c96f16c9cb1f78f63e
+  metadata.gz: d65e2fea58b18d3c2ed02a672026a6c26e92e896a3808637a64fd95195b25304
+  data.tar.gz: 12584511bf97ded05eeccf3d3887eb57de3bc89ed65b4af8c9694bda92a56bc6
 SHA512:
-  metadata.gz: 29d2ae81c2db18ff5e7619ff817d1dfd8cad4fffdf0a0d410afecf74ceddde6ba9f614240f8a672fa689774f89666a9995d248073d3d256d03ab5595c846eb63
-  data.tar.gz: 636c3fd921b0a223bad6ab2359559043fd767a6f535e0af0fd2dc55faa407d6532891819b46f03d25d0faf9a5fef9b7f2a93588797cbf9f5bfa41ca696fbe805
+  metadata.gz: 842a57063b37bb6d3179750ba0b68818f9f36f4ca7dd6728fbc387568e6f614eabc348aeed95979a3baf5335d9737da1be17398896a86699d1d14ea7d5774c90
+  data.tar.gz: d43b070daa32a475e0f8bd54632f365d7aa77a3b11cc75f39373905b28694db33e9c84aaeb8afbf65d4a3eedb4d319bbe903464913059adf40e0fb95c48395c3

data/.ruby-version

@@ -1 +1 @@
-2.7.5
+2.7.6

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 |---------------------------|--------------------|
 | NET_KNOCKER_URL           | |
 | NET_KNOCKER_SECRET        | |
-| NET_KNOCKER_HTTP_DEBUG    | |
+| NET_KNOCKER_DEBUG    | |
 
 
 ## Usage

data/lib/net/knocker/env.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require 'logger'
+require 'net/https'
+require 'uri'
+
 module Net
   class Knocker
     module Env
@@ -12,7 +16,7 @@ module Net
           http.use_ssl = true
           http.cert = ssl_certificate
           http.key = ssl_key
-          http.set_debug_output $stderr if ENV.key? 'NET_KNOCKER_HTTP_DEBUG'
+          http.set_debug_output $stderr if ENV.key? 'NET_KNOCKER_DEBUG'
         end
       end
 
@@ -36,22 +40,54 @@ module Net
         end
       end
 
+      def info(msg, method = :info)
+        tags = [Net::Knocker, Process.pid, method.to_s.upcase].join('][')
+        log.send(method, "[#{tags}] #{msg}")
+      end
+
+      def error(msg)
+        info(msg, __method__)
+      end
+
+      def warn(msg)
+        info(msg, __method__)
+      end
+
+      def debug(msg)
+        return unless debugging?
+
+        info(msg, __method__)
+      end
+
+      def debugging?
+        @debugging ||= begin
+          env_debug = ENV.fetch('NET_KNOCKER_DEBUG', false).to_s.downcase
+          %w[true yes yep 1].include? env_debug
+        end
+      end
+
       def ssl_certificate
         @ssl_certificate ||= OpenSSL::X509::Certificate.new(env_secret)
       end
 
       def url
-        @url ||= URI.parse(ENV.fetch('NET_KNOCKER_URL')) unless should_omit?
+        return if should_omit?
+
+        @url ||= URI.parse(ENV.fetch('NET_KNOCKER_URL'))
       end
 
       def log
-        @log ||= if (defined? logger) && (logger.respond_to? :debug)
-                   logger
-                 elsif (defined? Rails.logger) && (Rails.logger.respond_to? :debug)
-                   Rails.logger
-                 else
-                   ::Logger.new($stderr)
-                 end
+        @log  ||= if (defined? logger) && (logger.respond_to? :debug)
+                    logger
+                  elsif (defined? Rails.logger) && (Rails.logger.respond_to? :debug)
+                    Rails.logger
+                  else
+                    ::Logger.new($stderr)
+                  end
+      end
+
+      def var_names
+        @var_names ||= %w[NET_KNOCKER_SECRET NET_KNOCKER_URL].freeze
       end
     end
   end

data/lib/net/knocker/peer.rb

@@ -1,27 +1,61 @@
 # frozen_string_literal: true
 
+require_relative 'env'
 module Net
   class Knocker
     class Peer
-      def self.any?
-        return unless ENV
-
-        Dir['/proc/*/environ']
-          .select { |path| File.readable_real? path }
-          .grep_v(self_patterns)
-          .select do |path|
-            content = File.read(path)
-            env_var_patterns.any? { |pattern| content.include? pattern }
+      extend Env
+
+      attr_reader :pid, :exe, :environ_path
+
+      def initialize(pid)
+        @pid = pid
+        @exe ||= Pathname("/proc/#{pid}/exe").realpath
+        @environ_path ||= Pathname("/proc/#{pid}/environ")
+      end
+
+      def environ
+        @environ ||= environ_path.binread.split("\0").map do |line|
+          line.split('=', 2)
+        end.to_h
+      end
+
+      # rubocop:todo Metrics/PerceivedComplexity
+      # rubocop:todo Metrics/AbcSize
+      def self.try_peer(path) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+        pid = File.basename(path).to_i
+        return if pid.zero? || (pid.eql? Process.pid)
+
+        peer_candidate = new(pid)
+        return unless peer_candidate.exe.basename.eql? Pathname('/proc/self/exe').realpath.basename
+        return unless var_names.all? { |e| peer_candidate.environ.key? e }
+        return unless URI.parse(peer_candidate.environ.fetch('NET_KNOCKER_URL')).eql? url
+        return unless peer_candidate.environ.fetch('NET_KNOCKER_SECRET').eql? env_secret
+
+        peer_candidate
+      rescue Errno::EACCES
+        nil
+      rescue StandardError => e
+        debug "non-crical exception raised: #{e.class}: #{e.message}"
+        nil
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      def self.peers
+        @peers ||= Dir['/proc/*/'].map do |path|
+          try_peer(path).tap do |p|
+            debug("peer found #{p.pid}") unless p.nil?
           end
-          .any?
+        end.compact
       end
 
-      def self.env_var_patterns
-        @env_var_patterns ||= %W[NET_KNOCKER_URL NET_KNOCKER_SECRET #{ENV['NET_KNOCKER_URL']}].freeze
+      def self.pids
+        @pids ||= peers.map(&:pid)
       end
 
-      def self.self_patterns
-        @self_patterns ||= %r{proc/((?:thread-)?self|#{Process.pid})/environ}.freeze
+      def self.any?(&block)
+        peers.any?(&block)
       end
     end
   end

data/lib/net/knocker/version.rb

@@ -2,6 +2,6 @@
 
 module Net
   class Knocker
-    VERSION = '0.0.3'
+    VERSION = '0.0.7'
   end
 end

data/lib/net/knocker.rb

@@ -3,9 +3,6 @@
 require_relative './knocker/version'
 require_relative './knocker/env'
 require_relative './knocker/peer'
-require 'logger'
-require 'net/https'
-require 'uri'
 
 module Net
   class Knocker
@@ -20,11 +17,22 @@ module Net
     end
 
     def in
-      send_request 'PUT'
+      return debug(omit_message('PUT')) if should_omit?
+
+      send_request('PUT').tap do |response|
+        # Omit sending the DELETE request after receiving `Not Modified` response
+        @should_omit ||= response.code.start_with? '3'
+      end
+    end
+
+    def omit_message(http_method = 'DELETE')
+      msg_end = url.to_s.empty? ? '' : "to #{url}"
+      "not sending #{http_method} request #{msg_end}"
     end
 
     def out
-      return log.info("[#{self.class}:#{Process.pid}] omitting to send a request") if Peer.any?
+      return debug(omit_message) if should_omit?
+      return info("#{omit_message}, blocked by PID(s) #{Peer.pids.join(',')}") if Peer.any?
 
       send_request 'DELETE'
     end
@@ -32,10 +40,8 @@ module Net
     private
 
     def send_request(http_method)
-      return log.info("[#{self.class}:#{Process.pid}] omitting to send a request") if should_omit?
-
       http_client.send_request(http_method, '/') do |response|
-        log.debug("[#{self.class}][#{__method__}] Public IP: #{response.body} ")
+        debug("[#{self.class}][#{__method__}] Public IP: #{response.body} ")
       end
     end
   end

data/net-knocker.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Use Mutual TLS to knock to remote endpoint.'
   # spec.description   = ''
   spec.homepage      = 'https://github.com/todosmodos/net-knocker'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0') # rubocop:todo Gemspec/RequiredRubyVersion
 
   # spec.metadata['homepage_uri'] = spec.homepage
   # spec.metadata['source_code_uri'] = 'TODO: Put your gem's public repo URL here.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-knocker
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.7
 platform: ruby
 authors:
 - Tio Teath
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: