file_sv 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7207368213637f9e6b91164ea82a398553db87e01743a0a191d5328635e91b84
-  data.tar.gz: 70f93031650207bc4df46cbee90ecea4da58c0b2ade43db384a76e034db58cf2
+  metadata.gz: bb4214e64bca77866967b848fb88c40eabe0a999d03e1ba88e47500662314b44
+  data.tar.gz: de2aa37269d3fc2d22904a1535a2d8e6308f011baae82fd352ee853def74f4d4
 SHA512:
-  metadata.gz: 5402cb767636ad98243cab0adae1008a6e9683abdffc3d98a52de3987e9042eae1b703a3394d41213e8bd6591c59b17fef2afd8bc7facd4609d5ed8755a0666c
-  data.tar.gz: d95d5443fccb5db6e05892c403667c77e216296edad1e5dd37688b4d15bf5e23f61c88175496f60ca98d06bbd68de3fc0c497120d58a93e7c64e71f8623f1bb9
+  metadata.gz: 72685470cd73d2f13d6e0d5894980d7603787204bcd5d454f339f81d105f96f0276b9d32026e3485e02abeb9001fcfe25648d64686fa804c0f57fc5a9df3ec0d
+  data.tar.gz: 786f78f51f7c02605b235c4306b972f67c33cd31c537a1af0ec41b363f5b8c340baee5648f40a3ae9006dc3561783d8dab6086d4412e4844da0515ff5d6175d8

data/exe/file_sv

@@ -12,10 +12,12 @@ class Exe < Thor
     ServiceLoader.create_plan_for folder
   end
 
+  option :crt, default: nil, banner: "HTTPS CRT"
+  option :key, default: nil, banner: "HTTPS key"
   desc "serve folder", "Serve virtual service based on folder"
   def serve(folder)
     plan folder
-    ServiceLoader.serve_plan
+    ServiceLoader.serve_plan options
   end
 
   desc "inspect folder", "Inspect details of what's served at folder"

data/lib/file_sv/global_settings.rb

@@ -7,6 +7,8 @@ class GlobalSettings
   @empty_body_status = 204
 
   @ignore_files = "{*.md,Dockerfile,.*}"
+
+  @https = false
   class << self
     # @return [String] Default REST method when none specified by filename
     attr_accessor :default_method
@@ -14,6 +16,12 @@ class GlobalSettings
     attr_accessor :empty_body_status
     # @return [Array] Expression representing files to ignore
     attr_accessor :ignore_files
+    # @return [Boolean] Whether to serve https using self signed certificate
+    attr_accessor :https
+    # @return [String] Path to HTTPS cert
+    attr_accessor :cert
+    # @return [String] Path to HTTPS key
+    attr_accessor :key
   end
 end
 

data/lib/file_sv/planned_endpoint.rb

@@ -17,7 +17,7 @@ class PlannedEndpoint
   attr_accessor :status_code
 
   # @return [Array]
-  HTTP_METHODS = %w[get post patch delete options].freeze
+  HTTP_METHODS = %w[get put post patch delete options].freeze
 
   # Represent a new endpoint
   def initialize(path)

data/lib/file_sv/service_loader.rb

@@ -19,9 +19,11 @@ module ServiceLoader
     end
 
     # Serve plan
-    def serve_plan
+    def serve_plan(thor_options)
       require "sinatra"
       require_relative "virtual_server"
+      GlobalSettings.key = thor_options[:key] if thor_options[:key]
+      GlobalSettings.cert = thor_options[:crt] if thor_options[:crt]
       VirtualServer.run!
     end
   end

data/lib/file_sv/sv_plan.rb

@@ -15,7 +15,7 @@ class SvPlan
     def create(folder)
       self.serving_folder = folder
       puts "Creating service based on files in #{folder}"
-      file_list = Dir.glob("#{folder}/**/*.*") - Dir.glob(GlobalSettings.ignore_files)
+      file_list = Dir.glob("#{folder}/**/*.*") - Dir.glob("#{folder}/#{GlobalSettings.ignore_files}")
       file_list.each { |file| process_file file }
     end
 

data/lib/file_sv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FileSv
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/file_sv/virtual_server.rb

@@ -3,6 +3,8 @@
 require "webrick"
 require "sinatra"
 require "docdsl"
+require "webrick/https"
+require "openssl"
 
 # Virtual server hosting virtual service defined through files
 class VirtualServer < Sinatra::Base
@@ -11,6 +13,41 @@ class VirtualServer < Sinatra::Base
 
   register Sinatra::DocDsl
 
+  if GlobalSettings.https
+    def self.own_certs(webrick_options)
+      puts "Using cert from #{GlobalSettings.cert}"
+      cert = OpenSSL::X509::Certificate.new File.read GlobalSettings.cert
+      pkey = OpenSSL::PKey::RSA.new File.read GlobalSettings.key
+      webrick_options[:SSLCertificate] = cert
+      webrick_options[:SSLPrivateKey] = pkey
+      webrick_options
+    end
+
+    def self.determine_certs(webrick_options)
+      if GlobalSettings.key && GlobalSettings.cert
+        webrick_options = own_certs webrick_options
+      else
+        puts "Using self signed cert"
+        webrick_options[:ServerName] = "localhost"
+        webrick_options[:SSLCertName] = "/CN=localhost"
+      end
+      webrick_options
+    end
+
+    # Run as https with self signed cert
+    def self.run!
+      logger = WEBrick::Log.new(nil, WEBrick::BasicLog::WARN)
+      webrick_options = { Port: port, SSLEnable: true, Logger: logger }
+      webrick_options = determine_certs webrick_options
+      # TODO: Following run does not work on Ruby 3
+      Rack::Handler::WEBrick.run(self, webrick_options) do |server|
+        %i[INT TERM].each { |sig| trap(sig) { server.stop } }
+        server.threaded = settings.threaded if server.respond_to? :threaded=
+        set :running, true
+      end
+    end
+  end
+
   page do
     title "File SV"
     header "Service virtualization created from #{Dir.pwd}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: file_sv
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Samuel Garratt
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: REST service virtualisation through file structure.