locd 0.1.3

data/lib/locd/proxy.rb

@@ -0,0 +1,272 @@
+# frozen_string_literal: true
+# encoding: UTF-8
+
+# Refinements
+# =======================================================================
+
+using NRSER
+
+
+# Definitions
+# =======================================================================
+
+# Stuff for running the proxy server, which does "vhost"-style routing of
+# HTTP requests it receives to user-defined sites.
+# 
+# It does this by matching the HTTP `Host` header against site labels.
+# 
+# Built off [proxymachine][], which is itself built on [eventmachine][].
+# 
+# [proxymachine]: https://rubygems.org/gems/proxymachine
+# [eventmachine]: https://rubygems.org/gems/eventmachine
+# 
+module Locd::Proxy
+  
+  # Constants
+  # ======================================================================
+  
+  # {Regexp} to match HTTP "Host" header line.
+  # 
+  # @return [Regexp]
+  # 
+  HOST_RE = /^Host\:\ /i
+  
+  
+  # Label for the Loc'd proxy agent itself
+  # 
+  # @return [String]
+  # 
+  ROTATE_LOGS_LABEL = 'com.nrser.locd.rotate-logs'
+  
+  
+  # Mixins
+  # ============================================================================
+  
+  # Add {.logger} and {#logger} methods
+  include SemanticLogger::Loggable
+  
+  
+  # Module Methods
+  # ======================================================================
+  
+  # See if the lines include complete HTTP headers.
+  # 
+  # Looks for the `'\r\n\r\n'` string that separates the headers from the
+  # body.
+  # 
+  # @param [String] data
+  #   Data received so far from {ProxyMachine}.
+  # 
+  # @return [Boolean]
+  #   `true` if `data` contains complete headers.
+  # 
+  def self.headers_received? data
+    data.include? "\r\n\r\n"
+  end
+  
+  
+  # Generate an HTTP text response string.
+  # 
+  # @param [String] status
+  #   The HTTP status header.
+  # 
+  # @param [String] text
+  #   Text response body.
+  # 
+  # @return [String]
+  #   Full HTTP response.
+  # 
+  def self.http_response_for status, text
+    [
+      "HTTP/1.1 #{ status }",
+      "Content-Type: text/plain; charset=utf-8",
+      "Status: #{ status }",
+      "",
+      text
+    ].join( "\r\n" )
+  end
+  
+  
+  # Get the request host from HTTP header lines.
+  # 
+  # @param [Array<String>] lines
+  # @return [String]
+  # 
+  def self.extract_host lines
+    lines.
+      find { |line| line =~ HOST_RE }.
+      chomp.
+      split( ' ', 2 )[1]
+  end
+  
+  
+  # Get the request path from HTTP header lines.
+  # 
+  # @param [Array<String>] lines
+  # @return [String]
+  # 
+  def self.extract_path lines
+    lines[0].split( ' ' )[1]
+  end
+  
+  
+  # Route request based on data, see {ProxyMachine} docs for details.
+  # 
+  # @todo
+  #   This finds the agent using the host as a pattern, so it will match
+  #   with unique partial label. I think in the case that the host is not
+  #   the full label it should probably return a HTTP redirect to the full
+  #   label so that the user URL is bookmark-abel, etc...?
+  # 
+  # @param [String] data
+  #   Data received so far.
+  # 
+  # @return [Hash<Symbol, (Hash | Boolean)]
+  #   Command for ProxyMachine.
+  # 
+  def self.route data
+    lines = data.lines
+    
+    logger.debug "Received data:\n#{ lines.pretty_inspect }"
+    
+    unless headers_received? data
+      logger.debug "Have not yet received HTTP headers, waiting..."
+      logger.debug lines: lines
+      return {noop: true}
+    end
+    
+    logger.debug "HTTP headers received, processing...\n#{ }"
+    logger.debug lines: lines
+    
+    host = extract_host lines
+    logger.debug host: host
+    
+    path = extract_path lines
+    logger.debug path: path
+    
+    # Label is the domain without the port
+    label = if host.include? ':'
+      host.split( ':', 2 )[0]
+    else
+      host
+    end
+    
+    site = find_and_start_site label
+    remote_host = "#{ Locd.config[:site, :bind] }:#{ site.port }"
+    
+    pm_cmd = {remote: remote_host}
+    logger.debug "Routing to remote", cmd: pm_cmd
+    
+    return pm_cmd
+    
+  rescue Locd::RequestError => error
+    logger.error error
+    error.to_proxy_machine_cmd
+  rescue Exception => error
+    logger.error error
+    {close: http_response_for( '500 Server Error', error.message )}
+  end
+  
+  
+  # Range of ports to allocate to {Locd::Agent::Site} when one is not
+  # provided by the user.
+  # 
+  # Start (inclusive) and end (exclusive) values come from `site.ports.start`
+  # and `site.ports.end` config values, which default to
+  # 
+  #     55000...56000
+  # 
+  # @return [Range<Fixnum, Fixnum>]
+  # 
+  def self.port_range
+    Locd.config[:site, :ports, :start]...Locd.config[:site, :ports, :end]
+  end
+  
+  
+  # Find a port in {.port_range} that is not already used by a
+  # {Locd::Agent::Site} to give to a new site.
+  # 
+  # @return [Fixnum]
+  #   Port number.
+  # 
+  # @raise
+  #   If a port can not be found.
+  # 
+  def self.allocate_port
+    allocated_ports = Locd::Agent::Site.ports
+    
+    port = port_range.find { |port| ! allocated_ports.include? port }
+    
+    if port.nil?
+      raise "Could not allocate port for #{ remote_key }"
+    end
+    
+    port
+  end
+  
+  # Um, find and start a {Locd::Agent::Site} from a pattern.
+  # 
+  # @param pattern (see Locd::Agent.find_only!)
+  # @return [Locd::Agent::Site]
+  # @raise (see Locd::Agent.find_only!)
+  # 
+  def self.find_and_start_site pattern
+    logger.debug "Finding and starting site...", pattern: pattern
+    
+    site = Locd::Agent::Site.find_only! pattern
+    
+    logger.debug "Found site!", site: site
+    
+    if site.running?
+      logger.debug "Site is RUNNING"
+    else
+      logger.debug "Site STOPPED, starting..."
+      site.start
+      logger.debug "Site started."
+    end
+    
+    site
+  end
+  
+  
+  # Get the proxy's port from it's `.plist` if it exists, otherwise from
+  # the config setting.
+  # 
+  # @return [Fixnum]
+  #   Port number.
+  # 
+  # @raise [TypeError]
+  #   If we can't find a suitable config setting when looking for one.
+  # 
+  def self.port
+    if proxy = Locd::Agent::Proxy.get
+      proxy.port
+    else
+      Locd.config[:proxy, :port, type: t.pos_int]
+    end
+  end
+  
+  
+  # Run the proxy server.
+  # 
+  # @param [String] bind
+  #   Address to bind to.
+  # 
+  # @param [Fixnum] port
+  #   Port to listen on.
+  # 
+  # @return [void]
+  #   Not sure if/when this method ever returns.
+  # 
+  def self.serve  bind: config[:proxy, :bind],
+                  port: config[:proxy, :port]
+    logger.info "Loc'd is starting ProxyMachine, hang on a sec...",
+      bind: bind,
+      port: port
+    
+    require 'locd/proxymachine'
+    ProxyMachine.set_router method( :route )
+    ProxyMachine.run 'locd', bind, port
+  end # .serve
+  
+end # module Locd::Proxy

data/lib/locd/proxymachine.rb

@@ -0,0 +1,34 @@
+##
+# This file...
+# 
+# 1.  Requires {ProxyMachine} (because requiring it boots it up, causing ruckus
+#     when you don't want to run it, like during specs).
+#     
+# 2.  Monkey-patch {ProxyMachine#fast_shutdown} so I can change the sleep
+#     time... 10 seconds is forever to wait when developing, and I don't see
+#     a way to configure it without patching.
+# 
+##
+
+require 'proxymachine'
+
+class ProxyMachine
+  @@max_fast_shutdown_seconds = 1
+  
+  def self.fast_shutdown(signal)
+    EM.stop_server($server) if $server
+    # Can't log in trap context (guess you used to be able to?) and this method
+    # is only entered from trap contexts, so comment these out to avoid the
+    # warning...
+    # 
+    # LOGGER.info "Received #{signal} signal. No longer accepting new connections."
+    # LOGGER.info "Maximum time to wait for connections is #{@@max_fast_shutdown_seconds} seconds."
+    # LOGGER.info "Waiting for #{ProxyMachine.count} connections to finish."
+    $server = nil
+    EM.stop if ProxyMachine.count == 0
+    Thread.new do
+      sleep @@max_fast_shutdown_seconds
+      exit!
+    end
+  end
+end

data/lib/locd/util.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+
+
+# Definitions
+# =======================================================================
+
+module Locd
+  
+  def self.resolve project_root, path = nil
+    return project_root if path.nil?
+    
+    if path.start_with? '//'
+      project_root / path[2..-1]
+    elsif path.start_with? '/'
+      path.to_pn
+    else
+      project_root / path
+    end
+  end
+  
+  
+  # Just like {.resolve} but returns a {String} (instead of a {Pathname}).
+  # 
+  # @param (see .resolve)
+  # @return [String]
+  # 
+  def self.resolve_to_s *args
+    resolve( *args ).to_s
+  end
+  
+end # module Locd

data/lib/locd/version.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Locd
+  # Absolute, expanded path to the gem's root directory.
+  # 
+  # @return [Pathname]
+  # 
+  ROOT = ( Pathname.new( __FILE__ ).dirname / '..' / '..' ).expand_path
+  
+  
+  # String version read from `//VERSION`
+  # 
+  # @return [String]
+  # 
+  VERSION = (ROOT / 'VERSION').read
+  
+  
+  # The gem name
+  # 
+  # @return [String]
+  # 
+  GEM_NAME = 'locd'
+end

data/locd.gemspec

@@ -0,0 +1,66 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "locd/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = Locd::GEM_NAME
+  spec.version       = Locd::VERSION
+  spec.authors       = ["nrser"]
+  spec.email         = ["neil@ztkae.com"]
+
+  spec.summary       = %q{Get loc'd out!}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/nrser/locd"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|dev)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.required_ruby_version = '>= 2.3.0'
+
+  # Dependencies
+  # ============================================================================
+  
+  # Development Dependencies
+  # ----------------------------------------------------------------------------
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  
+  # Nicer REPL experience
+  spec.add_development_dependency "pry", '~> 0.10.4'
+  # GitHub-Flavored Markdown (GFM) for use with `yard`
+  spec.add_development_dependency 'github-markup', '~> 1.6'
+  # Doc site generation with `yard`
+  spec.add_development_dependency 'yard', '~> 0.9.12'
+  # Provider for `commonmarker`, the new GFM lib
+  spec.add_development_dependency 'yard-commonmarker', '~> 0.3.0'
+  
+  
+  # Runtime Dependencies
+  # ----------------------------------------------------------------------------
+  
+  # My guns
+  spec.add_dependency "nrser", '>= 0.2.0.pre.1'
+  
+  # Used to process command templates from projects' `//dev/locd.yml` files
+  spec.add_dependency "cmds", ">= 0.2.8"
+  
+  # Content-aware proxy in Ruby based on EventMachine
+  spec.add_dependency 'proxymachine', '~> 1.2'
+  
+  # Manipulate the `.plist` XML files that `launchd` uses for service defs
+  spec.add_dependency 'plist', '~> 3.4'
+  
+  # Atli, my fork of Thor for CLI interface
+  spec.add_dependency 'atli', '>= 0.1.2'
+  
+  # 
+  # spec.add_dependency 'terminal-table', '~> 1.8'
+end