file_sv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 373ecafe042decab366929da1430ddb873aca264006aaa1d59c4eaa5d67b68d0
+  data.tar.gz: 730539bcd6461534c4ff9899abaf989518d002ffe0ab2865f87b30d08bd0b463
+SHA512:
+  metadata.gz: f68f20ec798767c092128c50dfc6bd131d77350566b3dc37c72b2497728126bdfdb674cce6c99edf6882285761447b106895be6418cd1bf989e0692868ab4500
+  data.tar.gz: c3f182e5d686d715b28513dde7a72231a181312e7e9be729eedc34ff464b153f93908d84417ff340f2ff9b3a9ee4cfb8af6f867d0e5eaf58963d5cbf23e5641e

data/exe/file_sv

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "thor"
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+# Executable for Generic Test
+class Exe < Thor
+  desc "plan folder", "Show plan for service virtualization based on folder"
+  def plan(folder)
+    require "file_sv"
+    ServiceLoader.create_plan_for folder
+  end
+
+  desc "serve folder", "Serve virtual service based on folder"
+  def serve(folder)
+    plan folder
+    ServiceLoader.serve_plan
+  end
+
+  desc "version", "Version of FileTest"
+  def version
+    require "file_sv"
+    puts "GenericTest version #{FileTest::VERSION}"
+  end
+end
+
+Exe.start(ARGV)

data/lib/file_sv.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+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
+    def rest_methods
+      {
+        get: GetSettings, post: PostSettings, patch: PatchSettings, options: OptionsSettings,
+        delete: DeleteSettings
+      }
+    end
+  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
+    config["global"]&.each do |key, value|
+      send("#{key}=", value)
+    end
+
+    FileSv.rest_methods.each do |method, setting_class|
+      config[method.to_s]&.each do |key, value|
+        setting_class.send("#{key}=", value)
+      end
+    end
+  end
+end

data/lib/file_sv/file_processor.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "sv_plan"
+# General render for any non special files
+class FileProcessor
+  class << self
+    # Process file, adding it to plan
+    def process(filename)
+      SvPlan + PlannedEndpoint.new(filename)
+    end
+  end
+end

data/lib/file_sv/global_settings.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Settings to configure this gem
+class GlobalSettings
+  @default_method = "get"
+
+  @empty_body_status = 204
+  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
+  end
+end
+
+module CommonHttpSettings
+  attr_accessor :default_status
+end
+
+# Settings specific to GET
+class GetSettings
+  extend CommonHttpSettings
+end
+
+# Settings specific to POST
+class PostSettings
+  extend CommonHttpSettings
+end
+
+# Settings specific to PATCH
+class PatchSettings
+  extend CommonHttpSettings
+end
+
+# Settings specific to OPTIONS
+class OptionsSettings
+  extend CommonHttpSettings
+end
+
+# Settings specific to DELETE
+class DeleteSettings
+  extend CommonHttpSettings
+end

data/lib/file_sv/planned_endpoint.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "erb"
+require "securerandom"
+
+# Endpoint planned to be served
+class PlannedEndpoint
+  # Location where endpoint will be hosted
+  attr_accessor :path
+  # @return [String] Path where content is sourced from
+  attr_accessor :file_path
+  # @return [String] REST Method
+  attr_accessor :method
+  # @return [Integer] HTTP Status code
+  attr_accessor :status_code
+
+  # @return [Array]
+  HTTP_METHODS = %w[get post patch delete options].freeze
+
+  # Represent a new endpoint
+  def initialize(path)
+    self.file_path = path
+    self.path = File.split(path).first
+    @file = true if not_text?
+    assign_params_from_name
+    self.method ||= GlobalSettings.default_method
+    return if status_code
+
+    set_default_status_code
+  end
+
+  # @return [Boolean] Whether endpoint serves a file not a string
+  def file?
+    @file
+  end
+
+  def default_empty_code
+    return false if not_text?
+
+    if content.strip.empty?
+      self.status_code = GlobalSettings.empty_body_status
+      return true
+    end
+    false
+  end
+
+  def set_default_status_code
+    return if default_empty_code
+
+    setting_class = FileSv.rest_methods[method.to_sym]
+    raise NotImplementedError, "Unable to interpret method #{method}" unless setting_class
+
+    self.status_code = setting_class.default_status
+  end
+
+  # @return [String] Filename without extension or containing folder
+  def filename
+    File.basename(file_path, ".*")
+  end
+
+  # Set attributes based on filename
+  def assign_params_from_name
+    file_parts = filename.split("_")
+    assign_method_from file_parts
+    assign_status_from file_parts
+  end
+
+  # Set status code based on filename
+  def assign_status_from(file_parts)
+    status_parts = file_parts.find_all { |part| part.to_i > 99 && part.to_i < 1000 }
+    if status_parts.size > 1
+      raise FileSv::FileNameError, "Filename #{filename} has more than 1 status code #{status_parts}"
+    end
+
+    self.status_code = status_parts[0].to_i if status_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 }
+    if method_parts.size > 1
+      raise FileSv::FileNameError, "Filename #{filename} has more than 1 REST methods #{method_parts}"
+    end
+
+    self.method = method_parts[0] if method_parts.size == 1
+  end
+
+  def serving_file_name
+    File.join(SvPlan.serving_folder, file_path)
+  end
+
+  # @return [Object] Content of file
+  def content
+    render_text
+  end
+
+  def not_text?
+    extension = File.extname(file_path).delete(".")
+    %w[ico png jpg mp4 mp3].include? extension
+  end
+
+  # @return [String] Render text
+  def render_text
+    ERB.new(File.read(serving_file_name)).result(binding)
+  end
+end

data/lib/file_sv/render_file.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class RenderFile
+end

data/lib/file_sv/service_loader.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Responsible for loading all files in service directory and creating service
+module ServiceLoader
+  # @return [String] Folder where service served from
+  @serving_folder = ""
+
+  class << self
+    # Create virtual service plan based on folder
+    def create_plan_for(folder)
+      SvPlan.create folder
+      puts SvPlan.inspect
+    end
+
+    # Serve plan
+    def serve_plan
+      require "sinatra"
+      require_relative "virtual_server"
+      VirtualServer.run!
+    end
+  end
+end

data/lib/file_sv/sv_plan.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "yaml_processor"
+require_relative "file_processor"
+# Holds plan of what virtual service will look like
+class SvPlan
+  @endpoints = {}
+  class << self
+    # @return [Array]
+    attr_reader :endpoints
+    # @return [String] Folder plan is served from
+    attr_accessor :serving_folder
+
+    # 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_list.each do |file|
+        process_file file
+      end
+    end
+
+    def process_file(file)
+      file.slice! serving_folder
+      extension = File.extname(file)
+      case extension
+      when "yaml" then YamlProcessor.process(file)
+      else
+        FileProcessor.process(file)
+      end
+    end
+
+    def inspect
+      "** VIRTUAL SERVICE PLAN **
+Serving based on folder: #{serving_folder}
+Endpoints: #{endpoints.inspect}
+"
+    end
+
+    def +(other)
+      @endpoints[other.path] ||= {}
+      @endpoints[other.path][other.method] ||= []
+      @endpoints[other.path][other.method] << other
+    end
+  end
+end

data/lib/file_sv/version.rb

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

data/lib/file_sv/virtual_server.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "webrick"
+require "sinatra"
+
+# Virtual server hosting virtual service defined through files
+class VirtualServer < Sinatra::Base
+  set :server, "webrick"
+  set :bind, "0.0.0.0"
+
+  SvPlan.endpoints.each do |_endpoint_path, endpoint_value|
+    endpoint_value.each do |_method_name, endpoints|
+      if endpoints.size < 2
+        endpoint = endpoints[0]
+        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]
+        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]
+        end
+        # Average same methods at same endpoint
+      end
+    end
+  end
+end

data/lib/file_sv/yaml_processor.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Process YAML files
+class YamlProcessor
+  class << self
+    def process(filename)
+      puts "Overriding default config based on #{filename}" if filename == "file_sv"
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: file_sv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Garratt
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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
+    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: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+description: |-
+  Create a virtual REST service through file structure. Customize it more
+  through ERB and special file names
+email:
+- samuel.garratt@integrationqa.com
+executables:
+- file_sv
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/file_sv
+- lib/file_sv.rb
+- lib/file_sv/file_processor.rb
+- lib/file_sv/global_settings.rb
+- lib/file_sv/planned_endpoint.rb
+- lib/file_sv/render_file.rb
+- lib/file_sv/service_loader.rb
+- lib/file_sv/sv_plan.rb
+- lib/file_sv/version.rb
+- lib/file_sv/virtual_server.rb
+- lib/file_sv/yaml_processor.rb
+homepage: https://gitlab.com/samuel-garratt/file_sv
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/samuel-garratt/file_sv
+  source_code_uri: https://gitlab.com/samuel-garratt/file_sv
+  changelog_uri: https://gitlab.com/samuel-garratt/file_sv/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: REST service virtualisation through file structure.
+test_files: []