webspicy 0.20.16 → 0.20.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a8de4780fb659f78ce0f61cebc61abed9ab6206a45c953bff95071a67761ee7
-  data.tar.gz: 8258fbb268baddb39d4549540484816aefde696a41a6166bf3cbe45d6bdf9912
+  metadata.gz: e1540c9120b24bed9351dc01d8906cad2f4ffac8ea478c4e5cdf23ec48e3439d
+  data.tar.gz: a188f120ff0bed71f12ed525916ccafdb89e1c62d9fe6e5fc8acc1e7576d1e40
 SHA512:
-  metadata.gz: 434f5a5616992040d25c7fefd9c483ff622b96a5f71c59a1efeb3ac72ab37d6329e3e941b6487ff68ca18648e52848d9ce58dc78d7f44dcfc73bba486131c81d
-  data.tar.gz: 7aca5fd9abb963b086ccd2d0d9e80c1f783d5cafb0f691760545dfe6689f87419197daca678c03027f3c4eb2fc145896d18d2e1c823e115531903585389a862c
+  metadata.gz: 582f993602ffec966ee10e7339806ce747acb5b6f93a89a9427687bb4ce098200a33fd99db9adf4fd70575177b25f07b2a3a9014f3513a17a261e0a62c797b3e
+  data.tar.gz: 1d42856145ee337d16bfdf85c2e94eaa8b144d8e089b9cadc4d71e607bf023ed9856d229169ca511f80111350255133f1c1c5e6c6a66cea490eff4e2d2ae5a49

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.com/enspirit/webspicy.svg?branch=master)](https://travis-ci.com/enspirit/webspicy)
+[![Test](https://github.com/enspirit/webspicy/actions/workflows/integration.yml/badge.svg?branch=master)](https://github.com/enspirit/webspicy/actions/workflows/integration.yml)
 # Webspicy
 
 A specification and test framework for web services seen as black-box software

data/lib/webspicy/tester/fakesendgrid/email.rb

@@ -42,6 +42,13 @@ module Webspicy
           @subject ||= data["subject"]
         end
 
+        def headers
+          @headers ||= data["headers"].reduce(OpenStruct.new){|acc, (key, value)|
+            acc[key.downcase] = value
+            acc
+          }
+        end
+
       end # class Email
     end # class Fakesendgrid
   end # class Tester

data/lib/webspicy/tester/fakeses/email.rb

@@ -39,6 +39,13 @@ module Webspicy
           recipients - cc - to
         end
 
+        def headers
+          @headers ||= email.header.reduce(OpenStruct.new){|acc, h|
+            acc[h.name.downcase] = h.unparsed_value
+            acc
+          }
+        end
+
         def email
           @email ||= Mail.read_from_string(raw_data)
         end

data/lib/webspicy/tester/fakesmtp/email.rb

@@ -32,10 +32,18 @@ module Webspicy
         end
 
         def subject
-          @subject ||= data["headerLines"]
-            .select{|h| h["key"] == "subject" }
-            .map{|h| h["line"][/Subject:\s*(.*)$/, 1] }
-            .first
+          @subject ||= data["subject"] || data["headerLines"]
+              .select{|h| h["key"] == "subject" }
+              .map{|h| h["line"][/Subject:\s*(.*)$/, 1] }
+              .first
+        end
+
+        def headers
+          @headers ||= data["headerLines"]
+            .reduce(OpenStruct.new){|acc, h|
+              acc[h["key"].downcase] = h["line"].split(': ')[1..].join(': ')
+              acc
+            }
         end
 
       end # class Email

data/lib/webspicy/tester/reporter/documentation.rb

@@ -86,8 +86,10 @@ module Webspicy
         end
 
         def service_done
-          io.puts
-          io.flush
+          unless @spec_file_line_printed
+            io.puts
+            io.flush
+          end
         end
 
       end # class Documentation

data/lib/webspicy/tester.rb

@@ -118,13 +118,12 @@ module Webspicy
     def run_service
       scope.each_testcase(service) do |test_case|
         @test_case = test_case
-        reporter.before_test_case
         run_test_case
-        reporter.test_case_done
       end
     end
 
     def run_test_case
+      reporter.before_test_case
       hooks.fire_around(self) do
         reporter.before_each
         hooks.fire_before_each(self)
@@ -143,9 +142,9 @@ module Webspicy
         reporter.after_each
         hooks.fire_after_each(self)
         reporter.after_each_done
-
-        raise FailFast if !result.success? and failfast?
       end
+      reporter.test_case_done
+      raise FailFast if !result.success? && failfast?
     end
 
     def call_test_case_target

data/lib/webspicy/version.rb

@@ -2,7 +2,7 @@ module Webspicy
   module Version
     MAJOR = 0
     MINOR = 20
-    TINY  = 16
+    TINY  = 20
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/lib/webspicy/web/inferer/config.ru

@@ -0,0 +1,8 @@
+require "webspicy"
+require "webspicy/web"
+require "webspicy/web/inferer"
+require 'logger'
+require 'rack'
+config = Webspicy::Configuration.dress(Path("/formalspec/"))
+use Rack::CommonLogger, Logger.new(STDOUT)
+run Webspicy::Web::Inferer.new(config)

data/lib/webspicy/web/inferer.rb

@@ -0,0 +1,95 @@
+require 'rack/proxy'
+module Webspicy
+  module Web
+    class Inferer < Rack::Proxy
+
+      def initialize(config, options = nil)
+        @webspicy_config = config
+        @webspicy_options = options || options_from_env
+        super(proxy_options)
+      end
+      attr_reader :webspicy_config, :webspicy_options
+
+      def rewrite_env(env)
+        env = env.merge(static_env)
+        env = handle_path_info(env)
+        env
+      end
+
+      def rewrite_response(triplet)
+        triplet
+      end
+
+      protected
+
+      def options_from_env
+        {
+          target_endpoint: ENV['PROXY_TARGET_ENDPOINT'] || config.host
+        }
+      end
+
+      def proxy_options
+        uri = target_uri
+        backend = "#{uri.scheme}://#{uri.host}"
+        backend = "#{backend}:#{uri.port}" if uri.port != 80 && uri.port != 443
+        {
+          streaming: false,
+          backend: backend
+        }
+      end
+
+      def static_env
+        @static_env ||= begin
+          e = {}
+          e['HTTP_HOST'] = target_uri.host
+          e
+        end
+      end
+
+      def target_uri
+        @target_uri ||= URI.parse(webspicy_options[:target_endpoint])
+      end
+
+      def handle_path_info(env)
+        return env if target_uri.path.nil? || target_uri.path.empty?
+
+        env['PATH_INFO'] = "#{target_uri.path}#{env['PATH_INFO']}"
+        env
+      end
+
+      def perform_request(env)
+        webspicy_dump_request(env)
+        super.tap{|triplet|
+          webspicy_dump_response(env, triplet)
+        }
+      end
+
+      def webspicy_dump_request(env)
+        base_file = webspicy_dump_basefile(env)
+        env['rack.input'].rewind
+        input = ''
+        env['rack.input'].each { |s| input << s }
+        base_file.add_ext('.body').write(input)
+        env['rack.input'].rewind
+      end
+
+      def webspicy_dump_response(env, triplet)
+        base_file = webspicy_dump_basefile(env)
+        base_file.add_ext('.env.json').write(
+          JSON.pretty_generate(env)
+        )
+        base_file.add_ext('.triplet.json').write(
+          JSON.pretty_generate(triplet)
+        )
+      end
+
+      def webspicy_dump_basefile(env)
+        path, method = env['PATH_INFO'], env['REQUEST_METHOD'].downcase
+        target_folder = (webspicy_config.folder/'inferer'/'dump')/path[1..-1]
+        target_folder.mkdir_p
+        target_folder/"#{method}.#{Time.now.to_i}"
+      end
+
+    end # class Inferer
+  end # module Web
+end # module Webspicy

data/lib/webspicy/web/openapi/generator.rb

@@ -36,19 +36,25 @@ module Webspicy
 
         def path_for(specification)
           {
-            specification.url => {
+            standardize(specification.url) => {
               summary: specification.name
             }.merge(verbs_for(specification))
           }
         end
 
+        def standardize(url)
+          url = url.gsub(/\/$/, '') if url =~ /\/$/
+          url
+        end
+
         def verbs_for(specification)
           specification.services.inject({}) do |verbs,service|
             verb = service.method.downcase
             verb_defn = {
               description: service.description,
+              parameters: parameters_for(service),
               responses: responses_for(service)
-            }
+            }.compact
             unless ["get", "options", "delete", "head"].include?(verb)
               verb_defn[:requestBody] = request_body_for(service)
             end
@@ -58,15 +64,29 @@ module Webspicy
 
         def request_body_for(service)
           schema = actual_input_schema(service)
+          example = nil # catch(:unfound) { generator.call(schema, {}) }
           {
             required: true,
             content: {
               "application/json" => {
                 schema: schema.to_json_schema,
-                example: generator.call(schema, {})
-              }
+                example: example
+              }.compact
+            }
+          }
+        end
+
+        def parameters_for(service)
+          schema = actual_input_schema(service)
+          params = service.specification.url_placeholders.map{|p|
+            {
+              in: 'path',
+              name: p,
+              schema: { type: "string" },
+              required: true
             }
           }
+          params.empty? ? nil : params
         end
 
         def responses_for(service)

data/spec/unit/tester/fakesendgrid/test_email.rb

@@ -44,7 +44,10 @@ module Webspicy
               "value": "test <b>test</b> test",
               "type": "text/html"
             }
-          ]
+          ],
+          "headers": {
+            "x-header-key": "personalised-header-value"
+          }
         }
         J
 
@@ -58,6 +61,7 @@ module Webspicy
           expect(subject.cc).to eql(["a-cc-recipient@world.com"])
           expect(subject.bcc).to eql(["a-bcc-recipient@world.com"])
           expect(subject.subject).to eql("Hello World")
+          expect(subject.headers['x-header-key']).to eql('personalised-header-value')
         end
 
       end

data/spec/unit/tester/fakeses/test_email.rb

@@ -12,6 +12,7 @@ module Webspicy
         To: someone@world.com, someoneelse@world.com
         CC: a-cc-recipient@world.com
         Subject: Hey world, hello!
+        X-Ses-Configuration-Set: SesConfigurationSet
         Message-ID: <2421bae3-9c42-7988-23b4-b1f6168130c9@webspicy.io>
         Date: Thu, 24 Jun 2021 13:45:16 +0000
         MIME-Version: 1.0
@@ -55,6 +56,11 @@ module Webspicy
           expect(subject.cc).to eql(["a-cc-recipient@world.com"])
           expect(subject.bcc).to eql(["a-bcc-recipient@world.com"])
           expect(subject.subject).to eql("Hey world, hello!")
+          expect(subject.headers[:from]).to eql("Webspicy <noreply@webspicy.io>")
+          expect(subject.headers[:cc]).to eql("a-cc-recipient@world.com")
+          expect(subject.headers["message-id"]).to eql("<2421bae3-9c42-7988-23b4-b1f6168130c9@webspicy.io>")
+          expect(subject.headers["mime-version"]).to eql("1.0")
+          expect(subject.headers["x-ses-configuration-set"]).to eql("SesConfigurationSet")
         end
 
       end

data/spec/unit/tester/fakesmtp/test_email.rb

@@ -96,6 +96,10 @@ module Webspicy
           expect(subject.to).to eql(["someone@world.com", "someoneelse@world.com"])
           expect(subject.cc).to eql(["a-cc-recipient@world.com"])
           expect(subject.subject).to eql("Hello World")
+          expect(subject.headers[:cc]).to eql("a-cc-recipient@world.com")
+          expect(subject.headers[:date]).to eql("Tue, 20 Apr 2021 14:06:13 +0000")
+          expect(subject.headers['message-id']).to eql("<607edfd56836e_1b0492af@1d3356d02030.mail>")
+          expect(subject.headers['mime-version']).to eql("1.0")
         end
 
       end

data/spec/unit/web/inferer/test_inferer.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'rack/test'
+require 'webspicy/web'
+require 'webspicy/web/inferer'
+module Webspicy
+  module Web
+    describe Inferer do
+      include Rack::Test::Methods
+
+      let(:config) {
+        Configuration.dress(restful_folder)
+      }
+
+      let(:options) {{
+        :target_endpoint => "https://reqres.in/api"
+      }}
+
+      let(:app) {
+        Inferer.new(config, options)
+      }
+
+      describe 'proxy_options' do
+        it 'works' do
+          expect(app.send(:proxy_options)).to eql({
+            :streaming => false,
+            :backend => "https://reqres.in"
+          })
+        end
+      end
+
+      describe 'static_env' do
+        it 'works' do
+          expect(app.send(:static_env)).to eql({
+            "HTTP_HOST" => "reqres.in"
+          })
+        end
+      end
+
+      describe 'the proxy itself' do
+        it 'works as expected' do
+          get '/users'
+          expect(last_response.status).to eql(200)
+          expect(last_response.body).not_to be_empty
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.20.16
+  version: 0.20.20
 platform: ruby
 authors:
 - Bernard Lambeau
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-25 00:00:00.000000000 Z
+date: 2021-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -226,6 +226,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rack-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description: Webspicy helps testing web services as software operation black boxes
 email: blambeau@gmail.com
 executables:
@@ -310,6 +324,8 @@ files:
 - lib/webspicy/web/client/rack_test_client.rb
 - lib/webspicy/web/client/support.rb
 - lib/webspicy/web/formaldoc.fio
+- lib/webspicy/web/inferer.rb
+- lib/webspicy/web/inferer/config.ru
 - lib/webspicy/web/invocation.rb
 - lib/webspicy/web/mocker.rb
 - lib/webspicy/web/mocker/config.ru
@@ -344,6 +360,7 @@ files:
 - spec/unit/tester/fakesmtp/test_email.rb
 - spec/unit/tester/test_asserter.rb
 - spec/unit/tester/test_assertions.rb
+- spec/unit/web/inferer/test_inferer.rb
 - spec/unit/web/mocker/test_mocker.rb
 - spec/unit/web/openapi/test_generator.rb
 - spec/unit/web/specification/test_instantiate_url.rb
@@ -354,7 +371,7 @@ homepage: http://github.com/enspirit/webspicy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -369,8 +386,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!
 test_files: []