file_sv 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac55a5c60dd473f97a05d4a7679772db4eaf54d2990420652e2ae96260dc7ec5
-  data.tar.gz: bf4e58836d690c6058392323144be3c4bbf53143e5535d7b0aa720d51b33462a
+  metadata.gz: a6fe6c5fff5f5d93506024349027d89d5ae0331b22f1dc15c94aaf72b18d1c8a
+  data.tar.gz: b8c7f47b3602949beb64b5b7e9fa7f859b2fc3020f5c1a3d91fa9a6309a1ad8a
 SHA512:
-  metadata.gz: 87ed6a07aad15e535cc11299447538ebdb2683b608b87777ac39a71e8f32c53b99a26d6416d1d5c3c3f5ab8917dd6ec31f511220a218d110514305cf674c20ae
-  data.tar.gz: 6a3521c2f94a59fc598d2c13c11bacfbc87a3f0213b2d078a6e222db632d80253c9c72d73fc1d2e20f06e6797cc1c612442928fa0e5ed39392601c8caf3fcad6
+  metadata.gz: 3b6521770efbd56f4b790650de3801668e80b4c197e995d3cdd1a97326013c58e241d265caf1735eeeae020050aa775ad44d7acb29b0c651aa3401b109bd7be0
+  data.tar.gz: ac3d6a6d948161f2b96f38090a148e3605927a9a43a690a05933b3a942905903f1c95b9e84ead1a204441b7edd66ef179be8aac3e30d6ddb2946a0330314d195

data/exe/file_sv

@@ -12,16 +12,24 @@ 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 "version", "Version of FileTest"
-  def version
+  desc "inspect folder", "Inspect details of what's served at folder"
+  def inspect(folder)
     require "file_sv"
-    puts "GenericTest version #{FileTest::VERSION}"
+    ServiceLoader.inspect folder
+  end
+
+  desc "version", "Version of FileSv"
+  def version
+    require "file_sv/version"
+    puts "FileSv version #{FileSv::VERSION}"
   end
 end
 

data/lib/file_sv.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "yaml"
 require_relative "file_sv/version"
 require_relative "file_sv/global_settings"
 require_relative "file_sv/sv_plan"
@@ -15,29 +16,49 @@ module FileSv
   class FileNameError < Error; end
 
   class << self
+    # @return [Hash] Mapping of REST method names to setting classes
     def rest_methods
       {
         get: GetSettings, post: PostSettings, patch: PatchSettings, options: OptionsSettings,
-        delete: DeleteSettings
+        delete: DeleteSettings, put: PutSettings
       }
     end
   end
 end
 
-require "yaml"
 CONFIG_FILE = "file_sv.yaml"
-if File.exist? CONFIG_FILE
-  # Set values in global settings based on config
-  class GlobalSettings
-    config = YAML.load_file CONFIG_FILE
-    config["global"]&.each do |key, value|
-      send("#{key}=", value)
-    end
 
-    FileSv.rest_methods.each do |method, setting_class|
-      config[method.to_s]&.each do |key, value|
-        setting_class.send("#{key}=", value)
-      end
+# Set values in global settings based on config
+def load_default_config(file_path)
+  return unless File.exist? file_path
+
+  config = YAML.load_file file_path
+  return unless config # Handle empty YAML file
+
+  config["global"]&.each do |key, value|
+    GlobalSettings.send("#{key}=", value)
+  end
+
+  load_rest_method_config config
+end
+
+# Load details of each REST method
+def load_rest_method_config(config)
+  FileSv.rest_methods.each do |method, setting_class|
+    config[method.to_s]&.each { |key, value| setting_class.send("#{key}=", value) }
+  end
+end
+
+# Set global params based on ENV vars
+def set_based_on_env_vars
+  GlobalSettings.instance_variables.each do |setting|
+    setting_name = setting.to_s[1..-1]
+    if ENV[setting_name]
+      puts "Setting #{setting_name} to #{ENV[setting_name]}"
+      GlobalSettings.send("#{setting_name}=", ENV[setting_name])
     end
   end
 end
+
+load_default_config CONFIG_FILE
+set_based_on_env_vars

data/lib/file_sv/file_processor.rb

@@ -6,7 +6,8 @@ class FileProcessor
   class << self
     # Process file, adding it to plan
     def process(filename)
-      SvPlan + PlannedEndpoint.new(filename)
+      endpoint = PlannedEndpoint.new(filename)
+      SvPlan + endpoint unless GlobalSettings.ignored_status? endpoint.status_code
     end
   end
 end

data/lib/file_sv/global_settings.rb

@@ -5,14 +5,46 @@ class GlobalSettings
   @default_method = "get"
 
   @empty_body_status = 204
+
+  @ignore_files = "{*.md,Dockerfile,.*}"
+
+  @https = false
+
+  @ignore_status_codes = nil
   class << self
     # @return [String] Default REST method when none specified by filename
     attr_accessor :default_method
     # @return [Integer] Default status of response when file is empty
     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
+    # @return [Array] List of http status codes to ignore
+    attr_accessor :ignore_status_codes
+
+    # @param [Integer] status_code HTTP status code
+    # @return [Boolean] Whether status code is currently ignored
+    def ignored_status?(status_code)
+      return unless ignore_status_codes
+
+      ignore_status_codes.split(",").each do |code|
+        regex = Regexp.new code.to_s
+        result = status_code.to_s[regex]
+        next unless result
+
+        return true unless result.empty?
+      end
+      false
+    end
   end
 end
 
+# Http settings that all HTTP method types inherit
 module CommonHttpSettings
   attr_accessor :default_status
 end
@@ -35,6 +67,12 @@ class PatchSettings
   extend CommonHttpSettings
 end
 
+# Settings specific to PATCH
+class PutSettings
+  @default_status = 200
+  extend CommonHttpSettings
+end
+
 # Settings specific to OPTIONS
 class OptionsSettings
   @default_status = 200

data/lib/file_sv/planned_endpoint.rb

@@ -3,6 +3,7 @@
 require "erb"
 require "securerandom"
 require "faker"
+require "pathname"
 
 # Endpoint planned to be served
 class PlannedEndpoint
@@ -16,12 +17,12 @@ 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)
     self.file_path = path
-    self.path = File.split(path).first
+    self.path = serving_loc_for path
     @file = true if not_text?
     assign_params_from_name
     self.method ||= GlobalSettings.default_method
@@ -30,21 +31,28 @@ class PlannedEndpoint
     set_default_status_code
   end
 
+  def serving_loc_for(path)
+    loc = File.split(path).first # TODO: Handle if path has a % at beginning of a folder
+    loc.gsub("#{File::SEPARATOR}%", "#{File::SEPARATOR}:")
+  end
+
   # @return [Boolean] Whether endpoint serves a file not a string
   def file?
     @file
   end
 
+  # Return default status code for an empty body
   def default_empty_code
     return false if not_text?
 
-    if content.strip.empty?
+    if content(binding).strip.empty?
       self.status_code = GlobalSettings.empty_body_status
       return true
     end
     false
   end
 
+  # Set default status code based on empty body or type of METHOD
   def set_default_status_code
     return if default_empty_code
 
@@ -91,8 +99,8 @@ class PlannedEndpoint
   end
 
   # @return [Object] Content of file
-  def content
-    render_text
+  def content(binding)
+    render_text(binding)
   end
 
   def not_text?
@@ -101,7 +109,7 @@ class PlannedEndpoint
   end
 
   # @return [String] Render text
-  def render_text
+  def render_text(binding)
     ERB.new(File.read(serving_file_name)).result(binding)
   end
 end

data/lib/file_sv/service_loader.rb

@@ -9,13 +9,21 @@ module ServiceLoader
     # Create virtual service plan based on folder
     def create_plan_for(folder)
       SvPlan.create folder
+      puts SvPlan.show
+    end
+
+    # Inspect plan
+    def inspect(folder)
+      create_plan_for folder
       puts SvPlan.inspect
     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

@@ -6,7 +6,7 @@ require_relative "file_processor"
 class SvPlan
   @endpoints = {}
   class << self
-    # @return [Array]
+    # @return [Hash] Endpoints included in plan. Key - endpoint, value - methods served under it
     attr_reader :endpoints
     # @return [String] Folder plan is served from
     attr_accessor :serving_folder
@@ -15,33 +15,55 @@ class SvPlan
     def create(folder)
       self.serving_folder = folder
       puts "Creating service based on files in #{folder}"
-      file_list = Dir.glob("#{folder}/**/*.*")
-      file_list.each do |file|
-        process_file file
-      end
+      file_list = Dir.glob("#{folder}/**/*.*") - Dir.glob("#{folder}/#{GlobalSettings.ignore_files}")
+      file_list.each { |file| process_file file }
     end
 
-    def process_file(file)
-      file.slice! serving_folder
-      extension = File.extname(file)
+    # Process file, for the most part creating endpoint.method from it
+    # @param [String] filename Path to file to process
+    def process_file(filename)
+      filename.slice! serving_folder
+      extension = File.extname(filename)
       case extension
-      when "yaml" then YamlProcessor.process(file)
+      when ".yaml" then YamlProcessor.process(filename)
       else
-        FileProcessor.process(file)
+        FileProcessor.process(filename)
       end
     end
 
-    def inspect
+    # Show plan
+    def show
+      endpoint_desc = ""
+      endpoints.sort { |a, b| a[0].casecmp b[0] }.each do |endpoint, methods|
+        endpoint_desc += "#{endpoint} \n"
+        methods.each do |method_name, endpoints|
+          endpoint_desc += description_message method_name, endpoints
+        end
+      end
+
       "** VIRTUAL SERVICE PLAN **
-Serving based on folder: #{serving_folder}
-Endpoints: #{endpoints.inspect}
-"
+Serving based on folder: #{Dir.pwd}. Related to folder executed: #{serving_folder}
+#{endpoint_desc}"
+    end
+
+    # Inspect details
+    def inspect
+      "Endpoints: #{endpoints.inspect}"
     end
 
+    # Add endpoint to plan
+    # @param [PlannedEndpoint] other Endpoint to add to plan
     def +(other)
       @endpoints[other.path] ||= {}
       @endpoints[other.path][other.method] ||= []
       @endpoints[other.path][other.method] << other
     end
+
+    private
+
+    # @return [String]
+    def description_message(method_name, endpoints)
+      "  #{method_name.upcase} (#{endpoints.size} responses) #{endpoints.collect(&:status_code)}\n"
+    end
   end
 end

data/lib/file_sv/version.rb

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

data/lib/file_sv/virtual_server.rb

@@ -2,27 +2,97 @@
 
 require "webrick"
 require "sinatra"
+require "docdsl"
+require "webrick/https"
+require "openssl"
 
 # Virtual server hosting virtual service defined through files
 class VirtualServer < Sinatra::Base
   set :server, "webrick"
   set :bind, "0.0.0.0"
 
+  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}"
+    introduction 'Created using file_sv. See <a href="https://gitlab.com/samuel-garratt/file_sv">File SV</a>
+for more details'
+  end
+
+  get "/favicon.ico" do
+    send_file File.join(__dir__, "file_sv.ico")
+  end
+
+  doc_endpoint "/docs"
+
+  # Output for endpoint, either a file or text content
+  # @param [PlannedEndpoint] endpoint Planned endpoint to serve
+  def output_for(endpoint, binding)
+    endpoint.file? ? send_file(endpoint.serving_file_name) : endpoint.content(binding)
+  end
+
+  # Log endpoint. Return content and status code defined by endpoint
+  # @param [PlannedEndpoint] endpoint Planned endpoint to serve
+  def serve(endpoint, id = nil)
+    message = "Using endpoint based on file #{endpoint.serving_file_name}."
+    @id = id
+    message += " Using param '#{@id}'" if id
+    puts message
+    [endpoint.status_code, output_for(endpoint, binding)]
+  end
+
   SvPlan.endpoints.each do |_endpoint_path, endpoint_value|
     endpoint_value.each do |_method_name, endpoints|
-      if endpoints.size < 2
-        endpoint = endpoints[0]
-        send(endpoint.method, endpoint.path) do
-          [endpoint.status_code, endpoint.file? ? send_file(endpoint.serving_file_name) : endpoint.content]
+      endpoint_base = endpoints[0]
+      documentation "Endpoint #{endpoint_base.path}" do
+        response "#{endpoints.size} kinds of response"
+      end
+      if endpoint_base.path.include? "#{File::Separator}:"
+        send(endpoint_base.method, endpoint_base.path) do |id|
+          endpoint = endpoints.sample
+          serve endpoint, id
         end
       else
-        endpoint_base = endpoints[0]
         send(endpoint_base.method, endpoint_base.path) do
-          my_points = endpoints
-          endpoint = my_points.sample
-          [endpoint.status_code, endpoint.file? ? send_file(endpoint.serving_file_name) : endpoint.content]
+          endpoint = endpoints.sample
+          serve endpoint
         end
-        # Average same methods at same endpoint
       end
     end
   end

data/lib/file_sv/yaml_processor.rb

@@ -3,8 +3,14 @@
 # Process YAML files
 class YamlProcessor
   class << self
+    # Process YAML file
     def process(filename)
-      puts "Overriding default config based on #{filename}" if filename == "file_sv"
+      if filename == "/file_sv.yaml"
+        puts "Overriding default config based on #{File.join(Dir.pwd, filename[1..-1])}"
+        load_default_config filename[1..-1]
+      else
+        puts "Skipping #{filename}"
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: file_sv
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-docdsl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +93,7 @@ files:
 - exe/file_sv
 - lib/file_sv.rb
 - lib/file_sv/file_processor.rb
+- lib/file_sv/file_sv.ico
 - lib/file_sv/global_settings.rb
 - lib/file_sv/planned_endpoint.rb
 - lib/file_sv/render_file.rb
@@ -109,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.