file_sv 0.1.8 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0b7afdb64abc1410be6cebdcf263fca4f5d6a1bc3319e499aa2465b494ea144
-  data.tar.gz: f64237aecf384cafc4bc9469ebecd6c3e4958083ebad3a1e5e90959b425e2662
+  metadata.gz: f83c739611ce58614e8d076e6be444b889ff63727b174dcfbd13025e3367b2d6
+  data.tar.gz: 042d4b3ae8ad91e6708b19bcdf9ad5b3473682494a8a6c4879ef50e61dbcce29
 SHA512:
-  metadata.gz: 7df5f1b80d1330a08ea6aafa52ba1d4e3d0d01ae963d276ca0a3ad0bffa4f03333e328955e227a86a4d4d980ae9c4a911ee018fea14cbf5d82ceac6baf5c4cdf
-  data.tar.gz: e6d42d44838e2bb3d44bb1427c904dd1a75bbe400b26d882ed4109ebcdd6ceae1c82ebb33333a6efc0114a647a7e861118f851d536b9461c19ee97b83ae93932
+  metadata.gz: fbe538e3dad13e5bdd4af99c8d10b792397e5a1252c2a9809a5120a9aec9302a5d83aff05f3a36d9ef112a3c335184c2c97d4668fa9e44f25fe2ffe319b9175c
+  data.tar.gz: d5427782a507a555b305578c50354405f89b6307824d810916a529018f392c541f003f3068d96d257fb8d8ea9460bae38b6db176cba33210bbca62edb1636cbb

data/lib/file_sv/planned_endpoint.rb

@@ -15,6 +15,8 @@ class PlannedEndpoint
   attr_accessor :method
   # @return [Integer] HTTP Status code
   attr_accessor :status_code
+  # @return [Integer] Delay before responding
+  attr_accessor :delay
 
   # @return [Array]
   HTTP_METHODS = %w[get put post patch delete options].freeze
@@ -26,6 +28,7 @@ class PlannedEndpoint
     @file = true if not_text?
     assign_params_from_name
     self.method ||= GlobalSettings.default_method
+    self.delay ||= 0
     return if status_code
 
     set_default_status_code
@@ -71,6 +74,7 @@ class PlannedEndpoint
   def assign_params_from_name
     file_parts = filename.split("_")
     assign_method_from file_parts
+    assign_delay_from file_parts
     assign_status_from file_parts
   end
 
@@ -84,9 +88,19 @@ class PlannedEndpoint
     self.status_code = status_parts[0].to_i if status_parts.size == 1
   end
 
+  # Set status code based on filename
+  def assign_delay_from(file_parts)
+    delay_parts = file_parts.find_all { |part| part.start_with?('delay') }
+    if delay_parts.size > 1
+      raise FileSv::FileNameError, "Filename #{filename} has more than 1 delay #{delay_parts}"
+    end
+
+    self.delay = delay_parts[0][5..-1].to_i if delay_parts.size == 1
+  end
+
   # Set REST method used based on filename
   def assign_method_from(file_parts)
-    method_parts = file_parts.find_all { |pa| HTTP_METHODS.include? pa }
+    method_parts = file_parts.find_all { |part| HTTP_METHODS.include? part }
     if method_parts.size > 1
       raise FileSv::FileNameError, "Filename #{filename} has more than 1 REST methods #{method_parts}"
     end
@@ -112,4 +126,10 @@ class PlannedEndpoint
   def render_text(binding)
     ERB.new(File.read(serving_file_name)).result(binding)
   end
+
+  def short_description
+    desc = self.status_code.to_s
+    desc += " (delay #{self.delay} sec)" if self.delay > 0
+    return desc
+  end
 end

data/lib/file_sv/service_loader.rb

@@ -3,7 +3,7 @@
 # Responsible for loading all files in service directory and creating service
 module ServiceLoader
   # @return [String] Folder where service served from
-  @serving_folder = ""
+  @serving_folder = "."
 
   class << self
     # Create virtual service plan based on folder

data/lib/file_sv/sv_plan.rb

@@ -5,19 +5,24 @@ require_relative "file_processor"
 # Holds plan of what virtual service will look like
 class SvPlan
   @endpoints = {}
+  @file_list = []
   class << self
     # @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
 
+    # @return [String] List of files plan is built from
+    attr_accessor :file_list
+
     # Create a plan new plan for a virtual service
     def create(folder)
       self.serving_folder = folder
       puts "Creating service based on files in #{folder}"
-      file_list = Dir.glob("#{folder}/**/*.*", File::FNM_DOTMATCH) - Dir.glob("#{folder}/#{GlobalSettings.ignore_files}, File::FNM_DOTMATCH")
+      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
+        SvPlan.file_list << file
         process_file file
       end
     end
@@ -64,9 +69,9 @@ Serving based on folder: #{Dir.pwd}. Related to folder executed: #{serving_folde
 
     private
 
-    # @return [String]
+    # @return [String] Message to description all endpoints for a method undera endpoint
     def description_message(method_name, endpoints)
-      "  #{method_name.upcase} (#{endpoints.size} responses) #{endpoints.collect(&:status_code)}\n"
+      "  #{method_name.upcase} (#{endpoints.size} responses) #{endpoints.collect(&:short_description)}\n"
     end
   end
 end

data/lib/file_sv/version.rb

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

data/lib/file_sv/virtual_server.rb

@@ -32,15 +32,29 @@ for more details'
     endpoint.file? ? send_file(endpoint.serving_file_name) : endpoint.content(binding)
   end
 
+  def append_content_type(endpoint)
+    if (endpoint.file_path.end_with? '.json')
+      content_type :json
+    elsif endpoint.file_path.end_with? '.xml'
+      content_type :xml
+    elsif endpoint.file_path.end_with? '.css'
+      content_type :css
+    elsif endpoint.file_path.end_with? '.js'
+      content_type :js    
+    end
+  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
+    append_content_type(endpoint)
     if ENV['debug'] == "true"
       message = "Using endpoint based on file #{endpoint.serving_file_name}."
       message += " Using param '#{@id}'" if id
       puts message
     end
+    sleep endpoint.delay if endpoint.delay > 0
     [endpoint.status_code, output_for(endpoint, binding)]
   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..])}"
-        load_default_config filename[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,64 +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
-
-# 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
+# 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.8
+  version: 0.1.11
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2024-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  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: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: REST service virtualisation through file structure.