file_sv 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa3ba8f0ed5971a7bda5814fb1c3905e6705cf2d164f8a13efab46983b31a4fe
-  data.tar.gz: d8e303e7b3170f5435828e0cf4e36507e980e75669526e7ebced88db3d0f394d
+  metadata.gz: b8c717829a4044f5970f099311a51d86317e009cb04d01e2b596e2ac24ee5296
+  data.tar.gz: 64a21579ccd9c87ea14a0e8b634f9095450cea66167ef0d414bff97e77f7ce3f
 SHA512:
-  metadata.gz: 717ee4f0ad3368c5ad27fbe4c751b778cc29359ec79345c143aa0272dbb079deb2e7d5fbdad4d16807b01a0fd39d5dc3764b6592fc5ec88594dbeaa98c1db433
-  data.tar.gz: 0e84459ad829475c060a8947a9526fe8618fcb1bc5e46653da7c7ab65b41d540e050801dc55dc502f550091189d3dd285898a0382896ea14fa5a916e86650959
+  metadata.gz: 594bfe0862c82585f8568cf3a46d2952bd631bf6795fd7b518a74a4b578eb9eab500523016602110f5ca60094f9a53bfe91c395970ad3ca5774d3d51f2a8427e
+  data.tar.gz: dd153f38c16a882d3ff806dcec71a7b798e7578aea0fe5322f868ea77bd6af7958e7eefc23b47e31f18bb35a78c869e0386155b7936e62086e07411734a2a9ab

data/lib/file_sv.rb

@@ -15,10 +15,11 @@ 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
@@ -29,17 +30,15 @@ CONFIG_FILE = "file_sv.yaml"
 # Set values in global settings based on config
 def load_default_config(file_path)
   require "yaml"
-  if File.exist? file_path
-    config = YAML.load_file file_path
-    config["global"]&.each do |key, value|
-      GlobalSettings.send("#{key}=", value)
-    end
+  return unless File.exist? file_path
 
-    FileSv.rest_methods.each do |method, setting_class|
-      config[method.to_s]&.each do |key, value|
-        setting_class.send("#{key}=", value)
-      end
-    end
+  config = YAML.load_file file_path
+  config["global"]&.each do |key, value|
+    GlobalSettings.send("#{key}=", value)
+  end
+
+  FileSv.rest_methods.each do |method, setting_class|
+    config[method.to_s]&.each { |key, value| setting_class.send("#{key}=", value) }
   end
 end
 

data/lib/file_sv/global_settings.rb

@@ -5,11 +5,15 @@ class GlobalSettings
   @default_method = "get"
 
   @empty_body_status = 204
+
+  @ignore_files = "{*.md,Dockerfile,.*}"
   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
   end
 end
 
@@ -35,6 +39,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

@@ -35,6 +35,7 @@ class PlannedEndpoint
     @file
   end
 
+  # Return default status code for an empty body
   def default_empty_code
     return false if not_text?
 
@@ -45,6 +46,7 @@ class PlannedEndpoint
     false
   end
 
+  # Set default status code based on empty body or type of METHOD
   def set_default_status_code
     return if default_empty_code
 

data/lib/file_sv/sv_plan.rb

@@ -15,27 +15,26 @@ 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(GlobalSettings.ignore_files)
+      file_list.each { |file| process_file file }
     end
 
     # Process file, for the most part creating endpoint.method from it
-    def process_file(file)
-      file.slice! serving_folder
-      extension = File.extname(file)
+    # @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
 
     # 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].length - b[0].length }.each do |endpoint, methods|
         endpoint_desc += "#{endpoint} \n"
         methods.each do |method_name, endpoints|
           endpoint_desc += "  #{method_name.upcase} (#{endpoints.size} responses)\n"

data/lib/file_sv/version.rb

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

data/lib/file_sv/virtual_server.rb

@@ -12,16 +12,17 @@ class VirtualServer < Sinatra::Base
   register Sinatra::DocDsl
 
   page do
-    title 'File SV'
+    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'
+    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')
+  get "/favicon.ico" do
+    send_file File.join(__dir__, "file_sv.ico")
   end
 
-  doc_endpoint '/docs'
+  doc_endpoint "/docs"
 
   SvPlan.endpoints.each do |_endpoint_path, endpoint_value|
     endpoint_value.each do |_method_name, endpoints|

data/lib/file_sv/yaml_processor.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: file_sv
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker