file_sv 0.1.3 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8c717829a4044f5970f099311a51d86317e009cb04d01e2b596e2ac24ee5296
-  data.tar.gz: 64a21579ccd9c87ea14a0e8b634f9095450cea66167ef0d414bff97e77f7ce3f
+  metadata.gz: 43425956ba3f1325aa81876eea311cabd364f35ae2735adf79f4cb2daed69dd4
+  data.tar.gz: 629f16289572cb0407ae010a5322f96b07ab6261e591b55dd080f3c9d5e5b58c
 SHA512:
-  metadata.gz: 594bfe0862c82585f8568cf3a46d2952bd631bf6795fd7b518a74a4b578eb9eab500523016602110f5ca60094f9a53bfe91c395970ad3ca5774d3d51f2a8427e
-  data.tar.gz: dd153f38c16a882d3ff806dcec71a7b798e7578aea0fe5322f868ea77bd6af7958e7eefc23b47e31f18bb35a78c869e0386155b7936e62086e07411734a2a9ab
+  metadata.gz: ec1ca5bffdfcbcc83f94cde7838bc1cdccf844c6c58f45a768203f8d72f2c77e0ce49f706ba7878cb9ba414a58863fb7438e056d76c341a16b258e6de31d3125
+  data.tar.gz: c8e605801443bbd947769ce32bfd376daad28c98bf05dcbca4e1cbbf81a09d1b6a50b9a5f6d0dc1aab29d494f6796bf400bbda023e95ddb8e57c3e241bf16692

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/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

@@ -7,6 +7,10 @@ class GlobalSettings
   @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
@@ -14,9 +18,33 @@ 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. Deprecated now
+    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

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,6 +31,11 @@ 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
@@ -39,7 +45,7 @@ class PlannedEndpoint
   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
@@ -93,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?
@@ -103,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

@@ -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
 
@@ -34,10 +34,10 @@ class SvPlan
     # Show plan
     def show
       endpoint_desc = ""
-      endpoints.sort { |a, b| a[0].length - b[0].length }.each do |endpoint, methods|
+      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 += "  #{method_name.upcase} (#{endpoints.size} responses)\n"
+          endpoint_desc += description_message method_name, endpoints
         end
       end
 
@@ -51,10 +51,19 @@ Serving based on folder: #{Dir.pwd}. Related to folder executed: #{serving_folde
       "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.3"
+  VERSION = "0.1.7"
 end

data/lib/file_sv/virtual_server.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-require "webrick"
+require "puma"
 require "sinatra"
 require "docdsl"
+require "openssl"
 
 # Virtual server hosting virtual service defined through files
 class VirtualServer < Sinatra::Base
-  set :server, "webrick"
+  set :server, :puma
+  enable :logging if ENV['debug'] == "true"
   set :bind, "0.0.0.0"
 
   register Sinatra::DocDsl
@@ -24,28 +26,44 @@ for more details'
 
   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)    
+    @id = id
+    if ENV['debug'] == "true"
+      message = "Using endpoint based on file #{endpoint.serving_file_name}."
+      message += " Using param '#{@id}'" if id
+      puts message
+    end
+    [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]
-        documentation "Endpoint #{endpoint.path}" do
-          response "1 kind of response"
-          status endpoint.status_code
-        end
-        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
+          @params = params
+          puts "#{endpoint_base.method} #{endpoint_base.path} ?#{@params}"
+          serve endpoint, id
         end
       else
-        endpoint_base = endpoints[0]
-        documentation "Endpoint #{endpoint_base.path}" do
-          response "#{endpoints.size} kinds of response"
-        end
         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
+          @params = params
+          puts "#{endpoint_base.method} #{endpoint_base.path} ?#{@params}" unless ENV['ignore_path'] && ("/#{ENV['ignore_path']}" == endpoint_base.path)
+          serve endpoint
         end
-        # Average same methods at same endpoint
       end
     end
   end

data/lib/file_sv/yaml_processor.rb

@@ -6,8 +6,8 @@ class YamlProcessor
     # Process YAML file
     def process(filename)
       if filename == "/file_sv.yaml"
-        puts "Overriding default config based on #{File.join(Dir.pwd, filename[1..-1])}"
-        load_default_config filename[1..-1]
+        puts "Overriding default config based on #{File.join(Dir.pwd, filename[1..])}"
+        load_default_config filename[1..]
       else
         puts "Skipping #{filename}"
       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"
@@ -29,17 +30,35 @@ CONFIG_FILE = "file_sv.yaml"
 
 # Set values in global settings based on config
 def load_default_config(file_path)
-  require "yaml"
   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..]
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: file_sv
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.7
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webrick
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '0'
 description: |-
   Create a virtual REST service through file structure. Customize it more
   through ERB and special file names
@@ -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.