file_sv 0.1.4 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7207368213637f9e6b91164ea82a398553db87e01743a0a191d5328635e91b84
-  data.tar.gz: 70f93031650207bc4df46cbee90ecea4da58c0b2ade43db384a76e034db58cf2
+  metadata.gz: f0b7afdb64abc1410be6cebdcf263fca4f5d6a1bc3319e499aa2465b494ea144
+  data.tar.gz: f64237aecf384cafc4bc9469ebecd6c3e4958083ebad3a1e5e90959b425e2662
 SHA512:
-  metadata.gz: 5402cb767636ad98243cab0adae1008a6e9683abdffc3d98a52de3987e9042eae1b703a3394d41213e8bd6591c59b17fef2afd8bc7facd4609d5ed8755a0666c
-  data.tar.gz: d95d5443fccb5db6e05892c403667c77e216296edad1e5dd37688b4d15bf5e23f61c88175496f60ca98d06bbd68de3fc0c497120d58a93e7c64e71f8623f1bb9
+  metadata.gz: 7df5f1b80d1330a08ea6aafa52ba1d4e3d0d01ae963d276ca0a3ad0bffa4f03333e328955e227a86a4d4d980ae9c4a911ee018fea14cbf5d82ceac6baf5c4cdf
+  data.tar.gz: e6d42d44838e2bb3d44bb1427c904dd1a75bbe400b26d882ed4109ebcdd6ceae1c82ebb33333a6efc0114a647a7e861118f851d536b9461c19ee97b83ae93932

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

@@ -6,7 +6,11 @@ class GlobalSettings
 
   @empty_body_status = 204
 
-  @ignore_files = "{*.md,Dockerfile,.*}"
+  @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

@@ -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,8 +15,11 @@ 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.each { |file| process_file file }
+      file_list = Dir.glob("#{folder}/**/*.*", File::FNM_DOTMATCH) - Dir.glob("#{folder}/#{GlobalSettings.ignore_files}, File::FNM_DOTMATCH")
+      file_list.each do |file| 
+        next if File.directory? file
+        process_file file
+      end
     end
 
     # Process file, for the most part creating endpoint.method from it
@@ -34,7 +37,7 @@ 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 += description_message method_name, endpoints

data/lib/file_sv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FileSv
-  VERSION = "0.1.4"
+  VERSION = "0.1.8"
 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
@@ -32,11 +34,13 @@ for more details'
 
   # 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}."
+  def serve(endpoint, id = nil)    
     @id = id
-    message += " Using param '#{@id}'" if id
-    puts message
+    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
 
@@ -49,11 +53,15 @@ for more details'
       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
         send(endpoint_base.method, endpoint_base.path) do
           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
       end

data/lib/file_sv/yaml_processor.rb

@@ -1,16 +1,16 @@
-# frozen_string_literal: true
-
-# Process YAML files
-class YamlProcessor
-  class << self
-    # 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]
-      else
-        puts "Skipping #{filename}"
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+# Process YAML files
+class YamlProcessor
+  class << self
+    # Process YAML file
+    def process(filename)
+      if filename == "/file_sv.yaml"
+        puts "Overriding default config based on #{File.join(Dir.pwd, filename[1..])}"
+        load_default_config filename[1..]
+      else
+        puts "Skipping #{filename}"
+      end
+    end
+  end
+end

data/lib/file_sv.rb

@@ -1,52 +1,64 @@
-# frozen_string_literal: true
-
-require "yaml"
-require_relative "file_sv/version"
-require_relative "file_sv/global_settings"
-require_relative "file_sv/sv_plan"
-require_relative "file_sv/service_loader"
-require_relative "file_sv/planned_endpoint"
-
-# Create Service Virtualization from a simple file system
-module FileSv
-  # General error for FileSv
-  class Error < StandardError; end
-
-  # Error related to incorrect format of filename
-  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, put: PutSettings
-      }
-    end
-  end
-end
-
-CONFIG_FILE = "file_sv.yaml"
-
-# 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
-
-load_default_config CONFIG_FILE
+# frozen_string_literal: true
+
+require "yaml"
+require_relative "file_sv/version"
+require_relative "file_sv/global_settings"
+require_relative "file_sv/sv_plan"
+require_relative "file_sv/service_loader"
+require_relative "file_sv/planned_endpoint"
+
+# Create Service Virtualization from a simple file system
+module FileSv
+  # General error for FileSv
+  class Error < StandardError; end
+
+  # Error related to incorrect format of filename
+  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, put: PutSettings
+      }
+    end
+  end
+end
+
+CONFIG_FILE = "file_sv.yaml"
+
+# 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..]
+    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.4
+  version: 0.1.8
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2022-01-19 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.2.32
 signing_key:
 specification_version: 4
 summary: REST service virtualisation through file structure.