webspicy 0.15.8 → 0.17.0

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
 

data/spec/unit/test_configuration.rb

@@ -31,6 +31,23 @@ module Webspicy
         expect(c.preconditions.size).to eq(1)
       end
 
+      it 'supports an URL and returns a specific configuration instance' do
+        c = Configuration.dress("http://google.com/")
+        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.to_a.size).to eql(1)
+      end
+
+      it 'supports a single .yml file and returns a specific configuration instance' do
+        file = restful_folder/"formaldef/todo/get.yml"
+        c = Configuration.dress(file)
+        expect(c).to be_a(Configuration)
+        expect(c.folder).to eq(restful_folder)
+        expect(c.each_scope.to_a.size).to eql(1)
+        expect(c.each_scope.to_a.first.each_specification.to_a.size).to eql(1)
+      end
+
       it 'yields the block with the configuration, if given' do
         seen = nil
         Configuration.dress(Path.dir/'configuration'){|c|
@@ -56,20 +73,20 @@ module Webspicy
 
       it 'creates a child when adding a folder' do
         Configuration.new(Path.dir) do |c|
-          child = c.folder 'resource'
+          child = c.folder 'specification'
           expect(child).to be_a(Configuration)
-          expect(child.folder).to eql(Path.dir/'resource')
+          expect(child.folder).to eql(Path.dir/'specification')
         end
       end
 
       it 'yield the child to the block if any given' do
         Configuration.new(Path.dir) do |c|
           seen = nil
-          c.folder 'resource' do |child|
+          c.folder 'specification' do |child|
             seen = child
           end
           expect(seen).to be_a(Configuration)
-          expect(seen.folder).to eql(Path.dir/'resource')
+          expect(seen.folder).to eql(Path.dir/'specification')
         end
       end
     end
@@ -223,7 +240,7 @@ module Webspicy
       let(:before_aller) { ->(){} }
       let(:after_aller) { ->(){} }
       let(:config) do
-        Configuration.new(Path.dir/'resource') do |c|
+        Configuration.new(Path.dir/'specification') do |c|
           c.before_all(&before_aller)
           c.before_each(&before_eacher)
           c.after_each(&after_eacher)
@@ -243,7 +260,7 @@ module Webspicy
     describe 'dup' do
 
       let(:original) do
-        Configuration.new(Path.dir/'resource') do |c|
+        Configuration.new(Path.dir/'specification') do |c|
           c.host = "http://127.0.0.1"
           c.folder 'service'
         end
@@ -253,7 +270,7 @@ module Webspicy
         duped = original.dup do |d|
           d.host = "http://127.0.0.1:4567"
         end
-        expect(duped.folder).to eql(Path.dir/'resource')
+        expect(duped.folder).to eql(Path.dir/'specification')
         expect(duped.host).to eql("http://127.0.0.1:4567")
         expect(original.host).to eql("http://127.0.0.1")
       end

data/spec/unit/tester/client/test_around.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+module Webspicy
+  class Tester
+    describe Client, "around" do
+
+      it 'work with no around at all' do
+        config = Configuration.new
+
+        seen = false
+        block = ->(){ seen = true }
+
+        scope = Configuration::Scope.new(config)
+        Client.new(scope).around(1, 2, 3, &block)
+        expect(seen).to be(true)
+      end
+
+      it 'work with one around' do
+        config = Configuration.new
+
+        seen = false
+        seen_args = nil
+        config.around_each do |*args, &bl|
+          seen_args = args
+          bl.call
+        end
+
+        scope = Configuration::Scope.new(config)
+        block = ->(){ seen = true }
+        Client.new(scope).around(1, 2, 3, &block)
+
+        expect(seen_args[0...-1]).to eql([1, 2, 3])
+        expect(seen).to be(true)
+      end
+
+      it 'works with two arounds' do
+        config = Configuration.new
+
+        seen = false
+
+        seen_args = []
+        config.around_each do |*args, &bl|
+          seen_args << args
+          bl.call
+        end
+        config.around_each do |*args, &bl|
+          seen_args << args
+          bl.call
+        end
+
+        scope = Configuration::Scope.new(config)
+        block = ->(){ seen = true }
+        Client.new(scope).around(1, 2, 3, &block)
+
+        expect(seen_args.size).to eql(2)
+        expect(seen_args.all?{|sa| sa[0...-1] == [1,2,3] }).to be(true)
+        expect(seen).to be(true)
+      end
+
+    end
+  end
+end