webspicy 0.18.0 → 0.19.0

data/lib/webspicy/tester/result/postcondition_met.rb

@@ -0,0 +1,29 @@
+module Webspicy
+  class Tester
+    class Result
+      class PostconditionMet < Check
+
+        def initialize(result, post)
+          super(result)
+          @post = post
+        end
+        attr_reader :post
+
+        def behavior
+          post.to_s
+        end
+
+        def must?
+          true
+        end
+
+        def call
+          if err = post.check(invocation)
+            _! err
+          end
+        end
+
+      end # class PostconditionMet
+    end # class Result
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/result/response_header_met.rb

@@ -0,0 +1,43 @@
+module Webspicy
+  class Tester
+    class Result
+      class ResponseHeaderMet < Check
+
+        def initialize(result, header, expected, strategy = :eq)
+          unless [:eq, :start_with].include?(strategy)
+            raise ArgumentError, "Invalid strategy `#{strategy.inspect}`"
+          end
+          super(result)
+          @header = header
+          @expected = expected
+          @strategy = strategy
+        end
+        attr_reader :header, :expected, :strategy
+
+        def behavior
+          "It has a `#{header}: #{expected}` response header"
+        end
+
+        def must?
+          true
+        end
+
+        def call
+          got = response.headers[header]
+          if got.nil?
+            _! "Expected response header `#{header}` to be set"
+          else
+            msg = "Expected response header `#{header}` to be `#{expected}`, got `#{got}`"
+            case strategy
+            when :eq
+              _!(msg) unless expected == got
+            when :start_with
+              _!(msg) unless got.start_with?(expected)
+            end
+          end
+        end
+
+      end # class ResponseHeaderMet
+    end # class Result
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/result/response_status_met.rb

@@ -0,0 +1,25 @@
+module Webspicy
+  class Tester
+    class Result
+      class ResponseStatusMet < Check
+
+        def behavior
+          "It has a %d response status" % [ test_case.expected_status ]
+        end
+
+        def must?
+          test_case.has_expected_status?
+        end
+
+        def call
+          actual = response.status
+          expected = test_case.expected_status
+          unless expected === actual
+            _!("Expected response status to be #{expected}, got #{actual}")
+          end
+        end
+
+      end # class ResponseStatusMet
+    end # class Result
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/version.rb

@@ -1,7 +1,7 @@
 module Webspicy
   module Version
     MAJOR = 0
-    MINOR = 18
+    MINOR = 19
     TINY  = 0
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"

data/lib/webspicy/web.rb

@@ -0,0 +1,4 @@
+require_relative 'web/client'
+require_relative 'web/invocation'
+require_relative 'web/mocker'
+require_relative 'web/openapi'

data/lib/webspicy/web/client.rb

@@ -0,0 +1,15 @@
+module Webspicy
+  module Web
+    class Client < Tester::Client
+
+      def call(test_case)
+        response = _call(test_case)
+        Invocation.new(test_case, response, self)
+      end
+
+    end # class Client
+  end # module Web
+end # module Webspicy
+require_relative 'client/support'
+require_relative 'client/http_client'
+require_relative 'client/rack_test_client'

data/lib/webspicy/{tester → web}/client/http_client.rb

@@ -1,5 +1,5 @@
 module Webspicy
-  class Tester
+  module Web
     class HttpClient < Client
 
       class ::HTTP::Request
@@ -19,7 +19,7 @@ module Webspicy
       end
       attr_reader :api
 
-      def call(test_case)
+      def _call(test_case)
         service, specification = test_case.service, test_case.specification
 
         # Instantiate the parameters
@@ -43,11 +43,10 @@ module Webspicy
       class Api
         include Client::Support
 
-        attr_reader :last_response
-
         def initialize(scope)
           @scope = scope
         end
+        attr_reader :last_response
 
         def config
           @scope.config
@@ -57,7 +56,8 @@ module Webspicy
           info_request("OPTIONS", url, params, headers, body)
 
           params = querystring_params(params)
-          @last_response = HTTP[headers || {}].options(url, params: params)
+          http_opts = http_options(params: params)
+          @last_response = HTTP[headers || {}].options(url, http_opts)
 
           debug_response(@last_response)
 
@@ -68,7 +68,8 @@ module Webspicy
           info_request("GET", url, params, headers, body)
 
           params = querystring_params(params)
-          @last_response = HTTP[headers || {}].get(url, params: params)
+          http_opts = http_options(params: params)
+          @last_response = HTTP[headers || {}].get(url, http_opts)
 
           debug_response(@last_response)
 
@@ -85,18 +86,21 @@ module Webspicy
           case body
           when NilClass
             headers['Content-Type'] ||= 'application/json'
-            @last_response = HTTP[headers].post(url, body: params.to_json)
+            http_opts = http_options(body: params.to_json)
+            @last_response = HTTP[headers].post(url, http_opts)
           when FileUpload
             file = HTTP::FormData::File.new(body.path.to_s, {
               content_type: body.content_type,
               filename: body.path.basename.to_s
             })
-            @last_response = HTTP[headers].post(url, form: {
+            http_opts = http_options(form: {
               body.param_name.to_sym => file
             })
+            @last_response = HTTP[headers].post(url, http_opts)
           else
             headers['Content-Type'] ||= 'application/json'
-            @last_response = HTTP[headers].post(url, body: body)
+            http_opts = http_options(body: body)
+            @last_response = HTTP[headers].post(url, http_opts)
           end
 
           debug_response(@last_response)
@@ -109,7 +113,8 @@ module Webspicy
 
           headers ||= {}
           headers['Content-Type'] ||= 'application/json'
-          @last_response = HTTP[headers].patch(url, body: params.to_json)
+          http_opts = http_options(body: params.to_json)
+          @last_response = HTTP[headers].patch(url, http_opts)
 
           debug_response(@last_response)
 
@@ -121,7 +126,8 @@ module Webspicy
 
           headers ||= {}
           headers['Content-Type'] ||= 'application/json'
-          @last_response = HTTP[headers].put(url, body: params.to_json)
+          http_opts = http_options(body: params.to_json)
+          @last_response = HTTP[headers].put(url, http_opts)
 
           debug_response(@last_response)
 
@@ -131,7 +137,8 @@ module Webspicy
         def post_form(url, params = {}, headers = nil, body = nil)
           info_request("POST", url, params, headers, body)
 
-          @last_response = HTTP[headers || {}].post(url, form: params)
+          http_opts = http_options(form: params)
+          @last_response = HTTP[headers || {}].post(url, http_opts)
 
           debug_response(@last_response)
 
@@ -141,14 +148,27 @@ module Webspicy
         def delete(url, params = {}, headers = nil, body = nil)
           info_request("DELETE", url, params, headers, body)
 
-          @last_response = HTTP[headers || {}].delete(url, body: params.to_json)
+          http_opts = http_options(body: params.to_json)
+          @last_response = HTTP[headers || {}].delete(url, http_opts)
 
           debug_response(@last_response)
 
           @last_response
         end
+
+        def http_options(extra)
+          if config.insecure
+            ctx = OpenSSL::SSL::SSLContext.new
+            ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            {
+              :ssl_context => ctx
+            }.merge(extra)
+          else
+            extra
+          end
+        end
       end # class Api
 
     end # class HttpClient
-  end # class Tester
+  end # module Web
 end # module Webspicy

data/lib/webspicy/{tester → web}/client/rack_test_client.rb

@@ -1,5 +1,5 @@
 module Webspicy
-  class Tester
+  module Web
     class RackTestClient < Client
 
       def self.for(app)
@@ -12,7 +12,7 @@ module Webspicy
       end
       attr_reader :api
 
-      def call(test_case)
+      def _call(test_case)
         service, specification = test_case.service, test_case.specification
 
         # Instantiate the parameters
@@ -184,5 +184,5 @@ module Webspicy
       end # class Api
 
     end # class RackTestClient
-  end # class Client
+  end # module Web
 end # module Webspicy

data/lib/webspicy/{tester → web}/client/support.rb

@@ -1,6 +1,6 @@
 module Webspicy
-  class Tester
-    class Client
+  module Web
+    class Client < Tester::Client
       module Support
         include Webspicy::Support::Colorize
 

data/lib/webspicy/web/invocation.rb

@@ -0,0 +1,65 @@
+module Webspicy
+  module Web
+    class Invocation < Tester::Invocation
+
+      ### Getters on response
+
+      def response_code
+        code = response.status
+        code = code.code unless code.is_a?(Integer)
+        code
+      end
+
+      ### Query methods
+
+      def done?
+        !response.nil?
+      end
+
+      def is_expected_success?
+        test_case.expected_status.to_i >= 200 && test_case.expected_status.to_i < 300
+      end
+
+      def is_success?
+        response_code >= 200 && response_code < 300
+      end
+
+      def is_empty_response?
+        response_code == 204
+      end
+
+      def is_redirect?
+        response_code >= 300 && response_code < 400
+      end
+
+      def raw_output
+        response.body.to_s
+      end
+
+      def loaded_output
+        ct = response.content_type || test_case.expected_content_type
+        ct = ct.mime_type if ct.respond_to?(:mime_type)
+        case ct
+        when %r{json}
+          raise "Body empty while expected" if raw_output.empty?
+          @loaded_output ||= ::JSON.parse(response.body)
+        else
+          raw_output
+        end
+      end
+      alias :loaded_body :loaded_output
+
+      def output
+        schema = is_expected_success? ? service.output_schema : service.error_schema
+        begin
+          schema.dress(loaded_output)
+        rescue Finitio::TypeError => ex
+          ex
+        end
+      end
+      alias :dressed_body :output
+      alias :error :output
+
+    end # class Invocation
+  end # module Web
+end # module Webspicy

data/lib/webspicy/web/mocker.rb

@@ -0,0 +1,90 @@
+require "finitio/generation"
+require "json"
+module Webspicy
+  module Web
+    class Mocker
+
+      def initialize(config)
+        @config = Configuration.dress(config)
+        @generator = config.generator || Finitio::Generation.new
+      end
+      attr_reader :config, :generator
+
+      def call(env)
+        req = Rack::Request.new(env)
+        path = req.path
+        meth = req.request_method
+        if meth == "OPTIONS" && has_service?(path)
+          [204, {}, []]
+        elsif service = find_service(meth, path)
+          status = best_status_code(service)
+          body = status == 204 ? "" : random_body(service, req)
+          headers = generate_headers(service)
+          [ status, headers, [ body ].compact ]
+        else
+          [404, {}, []]
+        end
+      end
+
+    private
+
+      def has_service?(path)
+        config.each_scope do |scope|
+          scope.each_specification do |specification|
+            next unless url_matches?(specification, path)
+            return true
+          end
+        end
+        return false
+      end
+
+      def find_service(method, path)
+        config.each_scope do |scope|
+          scope.each_specification do |specification|
+            next unless url_matches?(specification, path)
+            scope.each_service(specification) do |service|
+              return service if service.method == method
+            end
+          end
+        end
+        nil
+      end
+
+      def generate_headers(service)
+        {
+          "Content-Type" => best_content_type(service)
+        }.delete_if{|k,v| v.nil? }
+      end
+
+      def best_status_code(service)
+        if ex = service.examples.first
+          (ex.expected_status && ex.expected_status.to_i) || 200
+        else
+          200
+        end
+      end
+
+      def best_content_type(service)
+        if ex = service.examples.first
+          ex.expected_content_type
+        else
+          "application/json"
+        end
+      end
+
+      def url_matches?(specification, path)
+        specification.url_pattern.match(path)
+      end
+
+      def random_body(service, request)
+        world = OpenStruct.new({
+          service: service,
+          request: request
+        })
+        data = generator.call(service.output_schema.main, world)
+        JSON.pretty_generate(data) if data
+      end
+
+    end # class Mocker
+  end # module Web
+end # module Webspicy