httpme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c36c1d9a162dd656edeedabcaede1013f203df65d486908901545894c4d2da70
+  data.tar.gz: 1927215e0164392810328e76758a11dc8b58822b47d1dd4d8bd56af0881317fc
+SHA512:
+  metadata.gz: 6f2ba944c4077805f1850cfe14886fbb0b9491096d5ea4d9e1782ca1b1d2b16d149474e9ac087f86b18c4ded5455c140c146990022d292991ae71adb469a3cef
+  data.tar.gz: bb79c9deb998a6c79faabb7cf2e26efe74949d8b12b06c8a31a23520433a14f4e8eb41c5c1189cd462defad6cf943a7debd8e15f19ef81b8a40e756229b2d679

data/README.md

@@ -0,0 +1,63 @@
+# HTTPMe
+
+[![Gem Version](https://badge.fury.io/rb/httpme.svg)](https://badge.fury.io/rb/httpme)
+[![Build Status](https://github.com/DannyBen/httpme/workflows/Test/badge.svg)](https://github.com/DannyBen/victor/actions?query=workflow%3ATest)
+
+---
+
+Static files web server with basic authentication.
+
+---
+
+## Installation
+
+    $ gem install httpme
+
+## Usage
+
+
+```shell
+httpme - static web server with basic authentication
+
+Options can be set using command line arguments or environment variables
+
+Usage:
+  httpme [PATH] [--port PORT --host HOST --auth AUTH]
+  httpme (-h|--help)
+
+Options:
+  -p, --port PORT
+    Server port (default: 3000)
+
+  -o, --host HOST
+    Server host (default: 0.0.0.0)
+
+  -a, --auth AUTH
+    Specify user:password to enable basic authentication
+
+  -h --help
+    Show this help
+
+Parameters:
+  PATH
+    Path to the directory you want to serve [default: .]
+
+Environment Variables:
+  HTTPME_PATH
+    Same as --path
+
+  HTTPME_AUTH
+    Same as --auth
+
+  HTTPME_PORT
+    Same as --port
+
+  HTTPME_HOST
+    Same as --host
+
+Examples:
+  httpme -p 3000
+  httpme docs --auth admin:s3cr3t
+  HTTPME_AUTH=admin:s3cr3t httpme docs  # same result as above
+```
+

data/bin/httpme

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'httpme'
+require 'httpme/cli'
+include Colsole
+
+router = HTTPMe::CLI.router
+
+begin
+  exit router.run ARGV
+rescue => e
+  puts e.backtrace.reverse if ENV['DEBUG']
+  say! "!txtred!#{e.class}: #{e.message}"
+  exit 1
+end

data/lib/httpme.rb

@@ -0,0 +1,2 @@
+require 'httpme/server'
+require 'byebug' if ENV['BYEBUG']

data/lib/httpme/cli.rb

@@ -0,0 +1,9 @@
+require 'httpme/command'
+
+module HTTPMe
+  class CLI
+    def self.router
+      MisterBin::Runner.new version: VERSION, handler: Command
+    end
+  end
+end

data/lib/httpme/command.rb

@@ -0,0 +1,41 @@
+require 'mister_bin'
+require 'colsole'
+
+module HTTPMe
+  class Command < MisterBin::Command
+    include Colsole
+
+    summary "httpme - static web server with basic authentication"
+
+    help "Options can be set using command line arguments or environment variables"
+
+    usage "httpme [PATH] [--port PORT --host HOST --auth AUTH]"
+    usage "httpme (-h|--help)"
+
+    param "PATH", "Path to the directory you want to serve [default: .]"
+    option "-p, --port PORT", "Server port (default: 3000)"
+    option "-o, --host HOST", "Server host (default: 0.0.0.0)"
+    option "-a, --auth AUTH", "Specify user:password to enable basic authentication"
+
+    environment 'HTTPME_PATH', "Same as --path"
+    environment 'HTTPME_AUTH', "Same as --auth"
+    environment 'HTTPME_PORT', "Same as --port"
+    environment 'HTTPME_HOST', "Same as --host"
+
+    example "httpme -p 3000"
+    example "httpme docs --auth admin:s3cr3t"
+    example "HTTPME_AUTH=admin:s3cr3t httpme docs  # same result as above"
+
+    def run
+      path = args['PATH'] || ENV['HTTPME_PATH'] || '.'
+      port = (args['--port'] || ENV['HTTPME_PORT'] || 3000).to_i
+      host = args['--host'] || ENV['HTTPME_HOST'] || '0.0.0.0'
+      auth = args['--auth'] || ENV['HTTPME_AUTH']
+
+      raise ArgumentError, "Path not found [#{path}]" unless Dir.exist? path
+
+      server = Server.new path: path, host: host, port: port, auth: auth
+      server.run
+    end
+  end
+end

data/lib/httpme/server.rb

@@ -0,0 +1,49 @@
+require 'rack'
+require 'rack/handler/puma'
+
+module HTTPMe
+  class Server
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def run
+      Rack::Handler::Puma.run(app, rack_options) do |server|
+        # :nocov: - FIXME: Can we test this?
+        [:INT, :TERM].each do |sig|
+          trap(sig) { server.stop }
+        end
+        # :nocov:
+      end
+    end
+
+    def app
+      path = options[:path] || '.'
+      auth = options[:auth]
+      zone = options[:zone] || 'Restricted Area'
+
+      Rack::Builder.new do
+        if auth
+          use Rack::Auth::Basic, zone do |username, password|
+            auth.split(':') == [username, password]
+          end
+        end
+
+        use Rack::Static, urls: ["/"], root: path, cascade: true, index: 'index.html'
+        run Rack::Directory.new(path)
+      end
+    end
+
+  private
+
+    def rack_options
+      {
+        Port: (options[:port] || '3000'),
+        Host: (options[:host] || '0.0.0.0'),
+      }
+    end
+
+  end
+end

data/lib/httpme/version.rb

@@ -0,0 +1,3 @@
+module HTTPMe
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: httpme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mister_bin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: colsole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: Command line utility for running a web server for static files with basic
+  authentication support
+email: db@dannyben.com
+executables:
+- httpme
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/httpme
+- lib/httpme.rb
+- lib/httpme/cli.rb
+- lib/httpme/command.rb
+- lib/httpme/server.rb
+- lib/httpme/version.rb
+homepage: https://github.com/dannyben/httpme
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Static files web server with basic authentication
+test_files: []