file_sv 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac55a5c60dd473f97a05d4a7679772db4eaf54d2990420652e2ae96260dc7ec5
-  data.tar.gz: bf4e58836d690c6058392323144be3c4bbf53143e5535d7b0aa720d51b33462a
+  metadata.gz: aa3ba8f0ed5971a7bda5814fb1c3905e6705cf2d164f8a13efab46983b31a4fe
+  data.tar.gz: d8e303e7b3170f5435828e0cf4e36507e980e75669526e7ebced88db3d0f394d
 SHA512:
-  metadata.gz: 87ed6a07aad15e535cc11299447538ebdb2683b608b87777ac39a71e8f32c53b99a26d6416d1d5c3c3f5ab8917dd6ec31f511220a218d110514305cf674c20ae
-  data.tar.gz: 6a3521c2f94a59fc598d2c13c11bacfbc87a3f0213b2d078a6e222db632d80253c9c72d73fc1d2e20f06e6797cc1c612442928fa0e5ed39392601c8caf3fcad6
+  metadata.gz: 717ee4f0ad3368c5ad27fbe4c751b778cc29359ec79345c143aa0272dbb079deb2e7d5fbdad4d16807b01a0fd39d5dc3764b6592fc5ec88594dbeaa98c1db433
+  data.tar.gz: 0e84459ad829475c060a8947a9526fe8618fcb1bc5e46653da7c7ab65b41d540e050801dc55dc502f550091189d3dd285898a0382896ea14fa5a916e86650959

data/exe/file_sv

@@ -18,10 +18,16 @@ class Exe < Thor
     ServiceLoader.serve_plan
   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

@@ -24,14 +24,15 @@ module FileSv
   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
+
+# 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|
-      send("#{key}=", value)
+      GlobalSettings.send("#{key}=", value)
     end
 
     FileSv.rest_methods.each do |method, setting_class|
@@ -41,3 +42,5 @@ if File.exist? CONFIG_FILE
     end
   end
 end
+
+load_default_config CONFIG_FILE

data/lib/file_sv/service_loader.rb

@@ -9,6 +9,12 @@ 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
 

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
@@ -21,21 +21,35 @@ class SvPlan
       end
     end
 
+    # Process file, for the most part creating endpoint.method from it
     def process_file(file)
       file.slice! serving_folder
       extension = File.extname(file)
       case extension
-      when "yaml" then YamlProcessor.process(file)
+      when ".yaml" then YamlProcessor.process(file)
       else
         FileProcessor.process(file)
       end
     end
 
-    def inspect
+    # Show plan
+    def show
+      endpoint_desc = ""
+      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"
+        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
 
     def +(other)

data/lib/file_sv/version.rb

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

data/lib/file_sv/virtual_server.rb

@@ -2,21 +2,43 @@
 
 require "webrick"
 require "sinatra"
+require "docdsl"
 
 # Virtual server hosting virtual service defined through files
 class VirtualServer < Sinatra::Base
   set :server, "webrick"
   set :bind, "0.0.0.0"
 
+  register Sinatra::DocDsl
+
+  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'
+
   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]
         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

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 #{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.2
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-03-04 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