webspicy 0.20.4 → 0.20.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9afe697a47ba4391d2e059f1bf3707c04f97f9d6fd50557104a59c6602dbd75c
-  data.tar.gz: 66ec4036f8e76dad7af0f8b0cf83ea139a67a7b1020aa0a304c26fdc9402d593
+  metadata.gz: 0bdf5cfac3023b3a121368cd16c4b36df8cc212b6093672c836fbb2c392e5d68
+  data.tar.gz: 3506d6e9ec23a6d21299dcabf2564b1d643a49cf58ba853d6263763838d8efe7
 SHA512:
-  metadata.gz: 79feb96443a47523b38f16e4cf7e7edfcd675f5a71c6b33aa452ad452aeacd5e64de1ce1ffa9ff3f5bf9cf428d59dc183e8f1455e1ce26126f2eddf9a14795fb
-  data.tar.gz: 2761eb20d67f4c697dedf7c27496cfd36ceed4f988f1f54f17809358e570102f1e40c29c47e46f614671504dcf1c877ce2fe6ccb7a72b510994a9da95bb74de1
+  metadata.gz: 4c84f0fde9c02350d61969503fd93fa139dc2b39bd377f800597adfae760bfb60b25a83894bac2642b75029c67963a3293a463eed4c00eb85491920a8bd53af4
+  data.tar.gz: f215620b9e9a0b7346c09b1ef1a1d1e3acac1f28f57df64ea0864156ceb9e9a7a888bddb4b67462255efc1a15f9860af368fbe510f148ea09871526e90da79fa

data/bin/webspicy

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 #/
 #/ Document & test web services as black-box operations.
-#/ (c) Enspirit SRL. Distributed under MIT licence.
+#/ Webspicy vVERSION, (c) Enspirit SRL. Distributed under MIT licence.
 #/
 #/ Usage: webspicy [options] URL                 # run default test againt url
 #/ Usage: webspicy [options] path/to/config.rb   # run whole test suite
@@ -28,7 +28,7 @@ require 'optparse'
 
 def showhelp
   file = __FILE__
-  exec "grep ^#/<'#{file}'|cut -c4-"
+  exec "grep ^#/<'#{file}'|cut -c4-|sed s/VERSION/#{Webspicy::VERSION}/g"
 end
 
 ARGV.options do |opts|

data/lib/finitio/webspicy/shared.fio

@@ -0,0 +1,10 @@
+@import finitio/data
+
+Tag = String( s | s.length > 0 )
+
+Schema =
+    .Finitio::System <fio> String
+      \( s | ::Webspicy.schema(s) )
+      \( s | raise "Unsupported"  )
+
+Params = .Array|.Hash

data/lib/webspicy.rb

@@ -7,7 +7,7 @@ require 'ostruct'
 require 'yaml'
 require 'rack/test'
 require 'mustermann'
-require 'colorized_string'
+require 'paint'
 require 'securerandom'
 require 'forwardable'
 module Webspicy
@@ -21,22 +21,10 @@ module Webspicy
   require 'webspicy/specification'
   require 'webspicy/configuration'
   require 'webspicy/tester'
-  require 'webspicy/web'
 
   class Error < StandardError; end
   class TimeoutError < Error; end
 
-  ###
-  ### Backward compatibility
-  ###
-  Client = Tester::Client
-  HttpClient = Web::HttpClient
-  RackTestClient = Web::RackTestClient
-  Resource = Specification
-  FileUpload = Specification::FileUpload
-  Scope = Configuration::Scope
-  Checker = Tester::FileChecker
-
   ###
   ### About folders
   ###
@@ -49,10 +37,11 @@ module Webspicy
   ### About formal doc and specifications defined there
   ###
   Finitio.stdlib_path(Path.dir/"finitio")
+
   DEFAULT_SYSTEM = Finitio.system(<<~FIO)
     @import webspicy/scalars
   FIO
-  FORMALDOC = Finitio.system(Path.dir/("webspicy/formaldoc.fio"))
+
 
   ###
   ### Exceptions that we let pass during testing
@@ -66,45 +55,6 @@ module Webspicy
   end
   module_function :default_scope
 
-  def specification(raw, file = nil, scope = default_scope)
-    raw = YAML.load(raw) if raw.is_a?(String)
-    with_scope(scope) do
-      r = FORMALDOC["Specification"].dress(raw)
-      r.config = scope.config
-      r.located_at!(file) if file
-      r
-    end
-  rescue Finitio::Error => ex
-    handle_finitio_error(ex, scope)
-  end
-  module_function :specification
-
-  def service(raw, scope = default_scope)
-    with_scope(scope) do
-      FORMALDOC["Service"].dress(raw)
-    end
-  rescue Finitio::Error => ex
-    handle_finitio_error(ex)
-  end
-  module_function :service
-
-  def test_case(raw, scope = default_scope)
-    with_scope(scope) do
-      FORMALDOC["TestCase"].dress(raw)
-    end
-  rescue Finitio::Error => ex
-    handle_finitio_error(ex)
-  end
-  module_function :test_case
-
-  def handle_finitio_error(ex, scope)
-    # msg = "#{ex.message}:\n    #{ex.root_cause.message}"
-    # msg = Support::Colorize.colorize_error(msg, scope.config)
-    # fatal(msg)
-    raise
-  end
-  module_function :handle_finitio_error
-
   #
   # Yields the block after having installed `scope` globally.
   #
@@ -185,4 +135,23 @@ module Webspicy
   end
   module_function :fatal
 
+  require 'webspicy/web'
+
+  ###
+  ### Backward compatibility
+  ###
+  Client = Tester::Client
+  HttpClient = Web::HttpClient
+  RackTestClient = Web::RackTestClient
+  Resource = Specification
+  FileUpload = Web::Specification::FileUpload
+  Scope = Configuration::Scope
+  Checker = Tester::FileChecker
+
+  [:specification, :service, :test_case].each do |meth|
+    define_method(meth) do |*args, &bl|
+      Webspicy::Web.send(meth, *args, &bl)
+    end
+    module_function(meth)
+  end
 end

data/lib/webspicy/configuration.rb

@@ -39,6 +39,7 @@ module Webspicy
         :success => :green
       }
       @colorize = true
+      @factory = Webspicy::Web
       @scope_factory = ->(config){ Scope.new(config) }
       @client = Web::HttpClient
       @reporter = default_reporter
@@ -109,6 +110,7 @@ module Webspicy
       end
     end
 
+    attr_accessor :factory
     attr_accessor :scope_factory
 
     def factor_scope
@@ -445,7 +447,7 @@ module Webspicy
       @reporter << Tester::Reporter::Documentation.new
       @reporter << Tester::Reporter::Exceptions.new
       @reporter << Tester::Reporter::Summary.new
-      @reporter << Tester::Reporter::ErrorCount.new
+      @reporter << Tester::Reporter::SuccessOrNot.new
     end
     attr_accessor :reporter
 

data/lib/webspicy/configuration/scope.rb

@@ -35,7 +35,7 @@ module Webspicy
       def each_specification(apply_filter = true, &bl)
         return enum_for(:each_specification, apply_filter) unless block_given?
         each_specification_file(apply_filter) do |file, folder|
-          yield Webspicy.specification(file.load, file, self)
+          yield config.factory.specification(file.load, file, self)
         end
       end
 
@@ -138,7 +138,7 @@ module Webspicy
           return example unless service.default_example
           h1 = service.default_example.to_info
           h2 = example.to_info
-          ex = Specification::TestCase.new(merge_maps(h1, h2))
+          ex = config.factory.test_case(merge_maps(h1, h2), self)
           ex.bind(service, example.counterexample?)
         end
 

data/lib/webspicy/configuration/single_url.rb

@@ -10,37 +10,47 @@ module Webspicy
         end
         attr_reader :url
 
-        def each_specification(&bl)
+        def each_specification_file(*args, &bl)
+          return enum_for(:each_specification_file) unless block_given?
+          yield Path.tempfile(["specification",".yml"]).tap{|f|
+            f.write(specification_src)
+          }
+        end
+
+        def each_specification(*args, &bl)
           return enum_for(:each_specification) unless block_given?
-          spec = <<~YML
+          yield config.factory.specification(specification_src, nil, self)
+        end
+
+        def specification_src
+          <<~YML.tap{|s| Webspicy.debug(s) }
           ---
-          name: |-
-            Default specification
+          description: |-
+            Getting #{url}
+
           url: |-
             #{url}
 
-          services:
-          - method: |-
-              GET
-            description: |-
-              Getting #{url}
-
-            input_schema: |-
-              Any
-            output_schema: |-
-              Any
-            error_schema: |-
-              Any
-
-            examples:
-              - description: |-
-                  it returns a 200
-                params: {}
-                expected:
-                  status: 200
+          method: |-
+            GET
+
+          input_schema: |-
+            Any
+
+          output_schema: |-
+            Any
+
+          error_schema: |-
+            Any
+
+          examples:
+
+            - description: |-
+                it returns a 200
+              params: {}
+              expected:
+                status: 200
           YML
-          Webspicy.debug(spec)
-          yield Webspicy.specification(spec, nil, self)
         end
 
       end # class SingleUrlScope

data/lib/webspicy/configuration/single_yml_file.rb

@@ -10,9 +10,14 @@ module Webspicy
         end
         attr_reader :file
 
-        def each_specification(&bl)
+        def each_specification_file(*args, &bl)
+          return enum_for(:each_specification_file) unless block_given?
+          yield(file)
+        end
+
+        def each_specification(*args, &bl)
           return enum_for(:each_specification) unless block_given?
-          yield Webspicy.specification(file.read, nil, self)
+          yield config.factory.specification(file.read, nil, self)
         end
 
       end # class SingleYmlFileScope

data/lib/webspicy/specification.rb

@@ -10,25 +10,14 @@ module Webspicy
     attr_accessor :config
     attr_reader :location
 
-    def self.info(raw)
-      new(raw)
-    end
-
-    def self.singleservice(raw)
-      converted = {
-        name: raw[:name] || "Unamed specification",
-        url: raw[:url],
-        services: [
-          Webspicy.service(raw.reject{|k| k==:url or k==:name }, Webspicy.current_scope)
-        ]
-      }
-      info(converted)
-    end
-
     def located_at!(location)
       @location = Path(location)
     end
 
+    def relative_location
+      @location && @location.relative_to(config.folder)
+    end
+
     def locate(relative_path)
       file = @location.parent/relative_path
       raise "File not found: #{file}" unless file.exists?
@@ -36,54 +25,15 @@ module Webspicy
     end
 
     def name
-      @raw[:name]
-    end
-
-    def url
-      @raw[:url]
-    end
-
-    def url_pattern
-      @url_pattern ||= Mustermann.new(url, type: :template)
+      @raw[:name] || relative_location || "Unnamed"
     end
 
     def services
       @raw[:services] || []
     end
 
-    def url_placeholders
-      url.scan(/\{([a-zA-Z]+(\.[a-zA-Z]+)*)\}/).map{|x| x.first }
-    end
-
-    def instantiate_url(params)
-      url, rest = self.url, params.dup
-      url_placeholders.each do |placeholder|
-        value, rest = extract_placeholder_value(rest, placeholder)
-        url = url.gsub("{#{placeholder}}", value.to_s)
-      end
-      [ url, rest ]
-    end
-
-    def to_singleservice
-      raise NotImplementedError
-    end
-
   private
 
-    def extract_placeholder_value(params, placeholder, split = nil)
-      return extract_placeholder_value(params, placeholder, placeholder.split(".")) unless split
-
-      key = [ split.first, split.first.to_sym ].find{|k| params.has_key?(k) }
-      raise "Missing URL parameter `#{placeholder}`" unless key
-
-      if split.size == 1
-        [ params[key], params.dup.delete_if{|k| k == key } ]
-      else
-        value, rest = extract_placeholder_value(params[key], placeholder, split[1..-1])
-        [ value, params.merge(key => rest) ]
-      end
-    end
-
     def bind_services
       services.each do |s|
         s.specification = self
@@ -99,4 +49,3 @@ require_relative 'specification/post'
 require_relative 'specification/err'
 require_relative 'specification/oldies'
 require_relative 'specification/test_case'
-require_relative 'specification/file_upload'

data/lib/webspicy/specification/service.rb

@@ -21,10 +21,6 @@ module Webspicy
         specification.config
       end
 
-      def method
-        @raw[:method]
-      end
-
       def description
         @raw[:description]
       end
@@ -68,7 +64,7 @@ module Webspicy
       def generated_counterexamples
         preconditions.map{|pre|
           pre.counterexamples(self).map{|tc|
-            tc = Webspicy.test_case(tc, Webspicy.current_scope)
+            tc = config.factory.test_case(tc, Webspicy.current_scope)
             tc.bind(self, true)
           }
         }.flatten

data/lib/webspicy/specification/test_case.rb

@@ -43,10 +43,6 @@ module Webspicy
         @raw[:seeds]
       end
 
-      def headers
-        @raw[:headers] ||= {}
-      end
-
       def metadata
         @raw[:metadata] ||= {}
       end
@@ -55,47 +51,10 @@ module Webspicy
         @raw[:tags] ||= []
       end
 
-      def dress_params
-        @raw.fetch(:dress_params){ true }
-      end
-      alias :dress_params? :dress_params
-
-      def params
-        @raw[:params] || {}
-      end
-
-      def body
-        @raw[:body]
-      end
-
-      def file_upload
-        @raw[:file_upload]
-      end
-
-      def located_file_upload
-        file_upload ? file_upload.locate(specification) : nil
-      end
-
       def expected
         @raw[:expected] || {}
       end
 
-      def expected_content_type
-        expected[:content_type]
-      end
-
-      def expected_status
-        expected[:status]
-      end
-
-      def is_expected_status?(status)
-        expected_status === status
-      end
-
-      def has_expected_status?
-        not expected[:status].nil?
-      end
-
       def expected_error
         expected[:error]
       end
@@ -104,14 +63,6 @@ module Webspicy
         !expected_error.nil?
       end
 
-      def expected_headers
-        expected[:headers] || {}
-      end
-
-      def has_expected_headers?
-        !expected_headers.empty?
-      end
-
       def assert
         @raw[:assert] || []
       end