webspicy 0.20.2 → 0.20.7

data/lib/webspicy/web.rb

@@ -1,3 +1,49 @@
+module Webspicy
+  module Web
+
+    require_relative 'web/specification'
+
+    FORMALDOC = Finitio.system(Path.dir/("web/formaldoc.fio"))
+
+    def specification(raw, file = nil, scope = Webspicy.default_scope)
+      raw = YAML.load(raw) if raw.is_a?(String)
+      Webspicy.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)
+    end
+    module_function :specification
+
+    def service(raw, scope = Webspicy.default_scope)
+      Webspicy.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 = Webspicy.default_scope)
+      Webspicy.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)
+      puts ex.root_cause.message
+      raise ex
+    end
+    module_function :handle_finitio_error
+
+  end # module Web
+end # module Webspicy
 require_relative 'web/client'
 require_relative 'web/invocation'
 require_relative 'web/mocker'

data/lib/webspicy/{formaldoc.fio → web/formaldoc.fio}

@@ -1,23 +1,17 @@
 @import finitio/data
+@import webspicy/shared
 
 Method =
     String( s | s =~ /^(GET|POST|POST_FORM|PUT|DELETE|PATCH|PUT|OPTIONS)$/ )
 
-Tag = String( s | s.length > 0 )
-
-Schema =
-    .Finitio::System <fio> String
-      \( s | ::Webspicy.schema(s) )
-      \( s | raise "Unsupported"  )
-
 FileUpload =
-    .Webspicy::FileUpload <info> {
+    .Webspicy::Web::Specification::FileUpload <info> {
         path         :  String
         content_type :  String
         param_name   :? String
     }
 
-Specification = .Webspicy::Specification
+Specification = .Webspicy::Web::Specification
   <info> {
     name: String
     url: String
@@ -41,7 +35,7 @@ Specification = .Webspicy::Specification
   }
 
 Service =
-    .Webspicy::Specification::Service <info> {
+    .Webspicy::Web::Specification::Service <info> {
         method          :  Method
         description     :  String
         preconditions   :? [String]|String
@@ -57,7 +51,7 @@ Service =
     }
 
 TestCase =
-    .Webspicy::Specification::TestCase <info> {
+    .Webspicy::Web::Specification::TestCase <info> {
         description      :? String
         dress_params     :? Boolean
         params           :? Params
@@ -77,8 +71,6 @@ TestCase =
         tags             :? [Tag]
     }
 
-Params = .Array|.Hash
-
 StatusRange = .Webspicy::Support::StatusRange
   <int> Integer
   <str> String(s | s =~ /^\dxx$/ )

data/lib/webspicy/web/specification.rb

@@ -0,0 +1,68 @@
+module Webspicy
+  module Web
+    class Specification < Webspicy::Specification
+
+      class << self
+        def info(raw)
+          new(raw)
+        end
+
+        def singleservice(raw)
+          converted = {
+            name: raw[:name] || "Unamed specification",
+            url: raw[:url],
+            services: [
+              Webspicy::Web.service(raw.reject{|k| k==:url or k==:name }, Webspicy.current_scope)
+            ]
+          }
+          info(converted)
+        end
+      end
+
+      def url
+        @raw[:url]
+      end
+
+      def url_pattern
+        @url_pattern ||= Mustermann.new(url, type: :template)
+      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
+
+    end # class Specification
+  end # module Web
+end # module Webspicy
+require_relative 'specification/service'
+require_relative 'specification/test_case'
+require_relative 'specification/file_upload'

data/lib/webspicy/web/specification/file_upload.rb

@@ -0,0 +1,39 @@
+module Webspicy
+  module Web
+    class Specification
+      class FileUpload
+
+        def initialize(raw)
+          @path = raw[:path]
+          @content_type = raw[:content_type]
+          @param_name = raw[:param_name] || "file"
+        end
+
+        attr_reader :path, :content_type, :param_name
+
+        def self.info(raw)
+          new(raw)
+        end
+
+        def locate(specification)
+          FileUpload.new({
+            path: specification.locate(path),
+            content_type: content_type
+          })
+        end
+
+        def to_info
+          { path: path.to_s,
+            content_type: content_type,
+            param_name: param_name }
+        end
+
+        def to_s
+          "FileUpload(#{to_info})"
+        end
+        alias :inspect :to_s
+
+      end # class FileUpload
+    end # class Specification
+  end # module Web
+end # module Webspicy

data/lib/webspicy/web/specification/service.rb

@@ -0,0 +1,13 @@
+module Webspicy
+  module Web
+    class Specification
+      class Service < Webspicy::Specification::Service
+
+        def method
+          @raw[:method]
+        end
+
+      end # class Service
+    end # class Specification
+  end # module Web
+end # module Webspicy

data/lib/webspicy/web/specification/test_case.rb

@@ -0,0 +1,58 @@
+module Webspicy
+  module Web
+    class Specification
+      class TestCase < Webspicy::Specification::TestCase
+
+        def headers
+          @raw[:headers] ||= {}
+        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_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_headers
+          expected[:headers] || {}
+        end
+
+        def has_expected_headers?
+          !expected_headers.empty?
+        end
+
+      end # class TestCase
+    end # class Specification
+  end # module Web
+end # module Webspicy

data/spec/unit/configuration/scope/test_expand_example.rb

@@ -3,11 +3,17 @@ module Webspicy
   class Configuration
     describe Scope, "expand_example" do
 
-      subject{ Scope.new({}).send(:expand_example, service, example) }
+      let(:config){
+        Configuration.new(Path.dir)
+      }
+
+      subject{
+        Scope.new(config).send(:expand_example, service, example)
+      }
 
       context 'when the service has no default example' do
         let(:service) {
-          Webspicy.service({
+          Webspicy::Web.service({
             method: "GET",
             description: "Test service",
             preconditions: "Foo",
@@ -18,7 +24,7 @@ module Webspicy
         }
 
         let(:example) {
-          Webspicy.test_case({
+          Webspicy::Web.test_case({
             description: "Hello world"
           })
         }
@@ -30,7 +36,7 @@ module Webspicy
 
       context 'when the service has a default example' do
         let(:service) {
-          Webspicy.service({
+          Webspicy::Web.service({
             method: "GET",
             description: "Test service",
             preconditions: "Foo",
@@ -44,7 +50,7 @@ module Webspicy
         }
 
         let(:example) {
-          Webspicy.test_case({
+          Webspicy::Web.test_case({
             description: "Hello world",
             expected: { content_type: "application/json" }
           })

data/spec/unit/specification/pre/test_global_request_headers.rb

@@ -15,13 +15,13 @@ module Webspicy
 
         describe "instrument" do
           it 'injects the headers' do
-            tc = TestCase.new({})
+            tc = Web::Specification::TestCase.new({})
             instrument(tc)
             expect(tc.headers['Accept']).to eql("application/json")
           end
 
           it 'keeps original headers unchanged' do
-            tc = TestCase.new({
+            tc = Web::Specification::TestCase.new({
               headers: {
                 'Content-Type' => 'text/plain'
               }
@@ -32,7 +32,7 @@ module Webspicy
           end
 
           it 'has low precedence' do
-            tc = TestCase.new({
+            tc = Web::Specification::TestCase.new({
               headers: {
                 'Accept' => 'text/plain'
               }

data/spec/unit/specification/service/test_dress_params.rb

@@ -4,7 +4,7 @@ module Webspicy
     describe Service, "dress_params" do
 
       it 'symbolizes keys' do
-        service = Webspicy.service({
+        service = Webspicy::Web.service({
           method: "GET",
           description: "Test service",
           preconditions: "Foo",
@@ -17,7 +17,7 @@ module Webspicy
       end
 
       it 'supports an array' do
-        service = Webspicy.service({
+        service = Webspicy::Web.service({
           method: "GET",
           description: "Test service",
           preconditions: "Foo",

data/spec/unit/test_configuration.rb

@@ -36,6 +36,7 @@ module Webspicy
         expect(c).to be_a(Configuration)
         expect(c.folder).to eq(Path.pwd)
         expect(c.each_scope.to_a.size).to eql(1)
+        expect(c.each_scope.to_a.first.each_specification_file.to_a.size).to eql(1)
         expect(c.each_scope.to_a.first.each_specification.to_a.size).to eql(1)
       end
 

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

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require 'webspicy/tester/fakesmtp'
+module Webspicy
+  class Tester
+    class Fakesmtp
+      describe Email do
+
+        DATA = JSON.parse <<~J
+        {
+          "attachments": [],
+          "headerLines": [
+            {
+              "key": "date",
+              "line": "Date: Tue, 20 Apr 2021 14:06:13 +0000"
+            },
+            {
+              "key": "from",
+              "line": "From: info@mydomain.be"
+            },
+            {
+              "key": "reply-to",
+              "line": "Reply-To: test@email.be"
+            },
+            {
+              "key": "to",
+              "line": "To: support@mydomain.fr"
+            },
+            {
+              "key": "message-id",
+              "line": "Message-ID: <607edfd56836e_1b0492af@1d3356d02030.mail>"
+            },
+            {
+              "key": "subject",
+              "line": "Subject: Hello World"
+            },
+            {
+              "key": "mime-version",
+              "line": "Mime-Version: 1.0"
+            }
+          ],
+          "html": "<p>Hello World!!</p>",
+          "text": "Hello World!!",
+          "textAsHtml": "Hello World!!",
+          "subject": "Hello World",
+          "date": "2021-04-20T14:06:13.000Z",
+          "to": {
+            "value": [
+              {
+                "address": "support@mydomain.fr",
+                "name": ""
+              }
+            ],
+            "html": "<span class=\\"mp_address_group\\"><a href=\\"mailto:support@mydomain.fr\\" class=\\"mp_address_email\\">support@mydomain.fr</a></span>",
+            "text": "support@mydomain.fr"
+          },
+          "from": {
+            "value": [
+              {
+                "address": "info@mydomain.be",
+                "name": ""
+              }
+            ],
+            "html": "<span class=\\"mp_address_group\\"><a href=\\"mailto:info@mydomain.be\\" class=\\"mp_address_email\\">info@mydomain.be</a></span>",
+            "text": "info@mydomain.be"
+          },
+          "messageId": "<607edfd56836e_1b0492af@1d3356d02030.mail>",
+          "replyTo": {
+            "value": [
+              {
+                "address": "test@email.be",
+                "name": ""
+              }
+            ],
+            "html": "<span class=\\"mp_address_group\\"><a href=\\"mailto:test@email.be\\" class=\\"mp_address_email\\">test@email.be</a></span>",
+            "text": "test@email.be"
+          }
+        }
+        J
+
+        subject{
+          Email.new(DATA)
+        }
+
+        it 'works as expected' do
+          expect(subject.from).to eql("info@mydomain.be")
+          expect(subject.to).to eql(["support@mydomain.fr"])
+          expect(subject.subject).to eql("Hello World")
+        end
+
+      end
+    end
+  end
+end