webspicy 0.15.8 → 0.16.0

data/lib/webspicy/version.rb

@@ -1,8 +1,8 @@
 module Webspicy
   module Version
     MAJOR = 0
-    MINOR = 15
-    TINY  = 8
+    MINOR = 16
+    TINY  = 0
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

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

@@ -0,0 +1,49 @@
+require 'spec_helper'
+module Webspicy
+  class Configuration
+    describe Scope, 'each_service' do
+
+      let(:scope) {
+        Scope.new(configuration)
+      }
+
+      let(:specification) {
+        scope.each_specification.first
+      }
+
+      subject {
+        scope.each_service(specification).to_a
+      }
+
+      context 'without any filter' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder){|c|
+            c.file_filter = /getTodo.yml/
+          }
+        }
+
+        it 'returns all services' do
+          expect(subject.size).to eql(1)
+        end
+      end
+
+      context 'with a service filter as a proc' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder){|c|
+            c.file_filter = /getTodo.yml/
+            c.service_filter = ->(s) {
+              s.method == "POST"
+            }
+          }
+        }
+
+        it 'returns nothing' do
+          expect(subject.size).to eql(0)
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+require 'spec_helper'
+module Webspicy
+  class Configuration
+    describe Scope, 'each_specification' do
+
+      let(:scope) {
+        Scope.new(configuration)
+      }
+
+      subject {
+        scope.each_specification.to_a
+      }
+
+      context 'without any filter' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder)
+        }
+
+        it 'returns all files' do
+          expect(subject.size).to eql(restful_folder.glob('**/*.yml').size)
+        end
+      end
+
+      context 'with a file filter as a proc' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder){|c|
+            c.file_filter = ->(f) {
+              f.basename.to_s == "getTodo.yml"
+            }
+          }
+        }
+
+        it 'returns only that file' do
+          expect(subject.size).to eql(1)
+        end
+      end
+
+      context 'with a file filter as a Regex' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder){|c|
+            c.file_filter = /getTodo.yml/
+          }
+        }
+
+        it 'returns only that file' do
+          expect(subject.size).to eql(1)
+        end
+      end
+
+      context 'when having children folders' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder) do |c|
+            c.folder 'todo'
+          end
+        }
+
+        it 'returns all files' do
+          expect(subject.size).to eql(restful_folder.glob('**/*.yml').size)
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+require 'spec_helper'
+module Webspicy
+  class Configuration
+    describe Scope, "expand_example" do
+
+      subject{ Scope.new({}).send(:expand_example, service, example) }
+
+      context 'when the service has no default example' do
+        let(:service) {
+          Webspicy.service({
+            method: "GET",
+            description: "Test service",
+            preconditions: "Foo",
+            input_schema: "{ id: Integer }",
+            output_schema: "{}",
+            error_schema: "{}"
+          })
+        }
+
+        let(:example) {
+          Webspicy.test_case({
+            description: "Hello world"
+          })
+        }
+
+        it 'returns the example itself' do
+          expect(subject).to be(example)
+        end
+      end
+
+      context 'when the service has a default example' do
+        let(:service) {
+          Webspicy.service({
+            method: "GET",
+            description: "Test service",
+            preconditions: "Foo",
+            input_schema: "{ id: Integer }",
+            output_schema: "{}",
+            error_schema: "{}",
+            default_example: {
+              expected: { status: 200 }
+            }
+          })
+        }
+
+        let(:example) {
+          Webspicy.test_case({
+            description: "Hello world",
+            expected: { content_type: "application/json" }
+          })
+        }
+
+        it 'deep merges the default example and the example as expected' do
+          expect(subject).to be_a(Specification::TestCase)
+          expect(subject.description).to eql("Hello world")
+          expect(subject.expected).to eql({
+            status: Support::StatusRange.int(200),
+            content_type: "application/json"
+          })
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+require 'spec_helper'
+module Webspicy
+  class Configuration
+    describe Scope, 'to_real_url' do
+
+      let(:scope) {
+        Scope.new(configuration)
+      }
+
+      context 'when no host at all' do
+
+        let(:configuration) {
+          Configuration.new
+        }
+
+        it 'does nothing on absolute URLs already' do
+          url = 'http://127.0.0.1:4567/todo'
+          got = scope.to_real_url(url)
+          expect(got).to eql(url)
+        end
+
+        it 'yields the block relative URLs' do
+          got = scope.to_real_url("/todo"){ "hello" }
+          expect(got).to eql("hello")
+        end
+
+        it 'fails on relative URLs and no block is given' do
+          expect(->(){
+            scope.to_real_url("/todo")
+          }).to raise_error(/Unable to resolve `\/todo`/)
+        end
+      end
+
+      context 'with a static host' do
+
+        let(:configuration) {
+          Configuration.new do |c|
+            c.host = "http://127.0.0.1:4568"
+          end
+        }
+
+        it 'does nothing on absolute URLs already' do
+          url = 'http://127.0.0.1:4567/todo'
+          got = scope.to_real_url(url)
+          expect(got).to eql(url)
+        end
+
+        it 'resolves relative URLs as expected' do
+          url = '/todo'
+          got = scope.to_real_url(url)
+          expect(got).to eql("http://127.0.0.1:4568/todo")
+        end
+
+      end
+
+      context 'with a dynamic host resolver' do
+
+        let(:configuration) {
+          Configuration.new do |c|
+            c.host = ->(url, tc) {
+              "http://127.0.0.1:4568#{url}"
+            }
+          end
+        }
+
+        it 'resolves absolute URLs' do
+          url = 'http://127.0.0.1:4567/todo'
+          got = scope.to_real_url(url)
+          expect(got).to eql("http://127.0.0.1:4568#{url}")
+        end
+
+        it 'resolves relative URLs as expected' do
+          url = '/todo'
+          got = scope.to_real_url(url)
+          expect(got).to eql("http://127.0.0.1:4568/todo")
+        end
+
+      end
+
+    end
+  end
+end

data/spec/unit/openapi/test_generator.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'webspicy/openapi'
+require 'openapi3_parser'
+module Webspicy
+  module Openapi
+    describe Generator do
+
+      let(:config) {
+        Configuration.new(restful_folder)
+      }
+
+      subject {
+        ruby_objs = Generator.new(config).call
+        JSON.parse(ruby_objs.to_json)
+      }
+
+      it 'works fine' do
+        document = Openapi3Parser.load(subject)
+        #puts JSON.pretty_generate(subject)
+        document.errors.each do |err|
+          puts err.inspect
+        end unless document.errors.empty?
+        expect(document.errors).to be_empty
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Webspicy
+  class Specification
+    module Precondition
+      describe GlobalRequestHeaders do
+        let(:gbr){
+          GlobalRequestHeaders.new('Accept' => 'application/json')
+        }
+
+        describe "instrument" do
+          it 'injects the headers' do
+            tc = TestCase.new({})
+            gbr.instrument(tc, nil)
+            expect(tc.headers['Accept']).to eql("application/json")
+          end
+
+          it 'keeps original headers unchanged' do
+            tc = TestCase.new({
+              headers: {
+                'Content-Type' => 'text/plain'
+              }
+            })
+            gbr.instrument(tc, nil)
+            expect(tc.headers['Content-Type']).to eql("text/plain")
+            expect(tc.headers['Accept']).to eql("application/json")
+          end
+
+          it 'has low precedence' do
+            tc = TestCase.new({
+              headers: {
+                'Accept' => 'text/plain'
+              }
+            })
+            gbr.instrument(tc, nil)
+            expect(tc.headers['Accept']).to eql("text/plain")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/unit/{resource → specification}/service/test_dress_params.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 module Webspicy
-  class Resource
+  class Specification
     describe Service, "dress_params" do
 
       it 'symbolizes keys' do
@@ -30,5 +30,5 @@ module Webspicy
       end
 
     end
-  end # class Resource
+  end # class Specification
 end # module Webspicy

data/spec/unit/specification/test_case/test_mutate.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+module Webspicy
+  class Specification
+    describe TestCase, "mutate" do
+
+      it 'helps easily creating a new test by mutation' do
+        tc = TestCase.new({
+          :params => {
+            "id" => 1
+          }
+        })
+        tc2 = tc.mutate({
+          :params => {
+            "id" => 2
+          }
+        })
+        expect(tc2).to be_a(TestCase)
+        expect(tc.params["id"]).to eql(1)
+        expect(tc2.params["id"]).to eql(2)
+      end
+
+    end
+  end
+end

data/spec/unit/{resource → specification}/test_instantiate_url.rb

@@ -1,30 +1,30 @@
 require "spec_helper"
 module Webspicy
-  describe Resource, "instantiate_url" do
+  describe Specification, "instantiate_url" do
 
     it 'does nothing when the url has no placeholder' do
-      r = Resource.new(url: "/test/a/url")
+      r = Specification.new(url: "/test/a/url")
       url, params = r.instantiate_url(foo: "bar")
       expect(url).to eq("/test/a/url")
       expect(params).to eq(foo: "bar")
     end
 
     it 'instantiates placeholders and strips corresponding params' do
-      r = Resource.new(url: "/test/{foo}/url")
+      r = Specification.new(url: "/test/{foo}/url")
       url, params = r.instantiate_url(foo: "bar", baz: "coz")
       expect(url).to eq("/test/bar/url")
       expect(params).to eq(baz: "coz")
     end
 
     it 'instantiates placeholders and strips corresponding params even when multiple' do
-      r = Resource.new(url: "/test/{foo}/url/{bar}")
+      r = Specification.new(url: "/test/{foo}/url/{bar}")
       url, params = r.instantiate_url(foo: "bar", bar: "baz", baz: "coz")
       expect(url).to eq("/test/bar/url/baz")
       expect(params).to eq(baz: "coz")
     end
 
     it 'supports placeholders corresponding to subentities' do
-      r = Resource.new(url: "/test/{foo.id}/url")
+      r = Specification.new(url: "/test/{foo.id}/url")
       url, params = r.instantiate_url(foo: {id: "bar"}, baz: "coz")
       expect(url).to eq("/test/bar/url")
       expect(params).to eq(foo: {}, baz: "coz")

data/spec/unit/{resource → specification}/test_url_placeholders.rb

@@ -1,19 +1,19 @@
 require "spec_helper"
 module Webspicy
-  describe Resource, "url_placeholders" do
+  describe Specification, "url_placeholders" do
 
     it 'returns an empty array on none' do
-      r = Resource.new(url: "/test/a/url")
+      r = Specification.new(url: "/test/a/url")
       expect(r.url_placeholders).to eq([])
     end
 
     it 'returns all placeholders' do
-      r = Resource.new(url: "/test/{foo}/url/{bar}")
+      r = Specification.new(url: "/test/{foo}/url/{bar}")
       expect(r.url_placeholders).to eq(["foo", "bar"])
     end
 
     it 'returns all placeholders expr' do
-      r = Resource.new(url: "/test/{foo.id}/url/{bar}")
+      r = Specification.new(url: "/test/{foo.id}/url/{bar}")
       expect(r.url_placeholders).to eq(["foo.id", "bar"])
     end