webspicy 0.16.3 → 0.20.1

data/examples/restful/webspicy/todo/putTodo.yml

@@ -1,65 +0,0 @@
----
-name: |-
-  Todo
-
-url: |-
-  /todo/{id}
-
-services:
-- method: |-
-    PUT
-
-  description: |-
-    Update a single Todo item
-
-  preconditions:
-    - Must be authenticated
-
-  input_schema: |-
-    TodoPut
-
-  output_schema: |-
-    Todo
-
-  error_schema: |-
-    ErrorSchema
-
-  default_example:
-    expected:
-      content_type: application/json
-      status: 200
-
-  examples:
-
-    - description: |-
-        when requested on an existing TODO
-      params:
-        id: 1
-        description: 'hello world'
-      assert:
-        - "pathFD('', description: 'hello world')"
-
-  counterexamples:
-
-    - description: |-
-        when requested on an unexisting TODO
-      params:
-        id: 999254654
-        description: 'hello world'
-      expected:
-        content_type: application/json
-        status: 404
-      assert:
-        - "pathFD('', error: 'No such todo')"
-
-    - description: |-
-        when violating the Put data type
-      params:
-        id: 1
-        description: 'hello world'
-        nosuchone: 'foobar'
-      dress_params:
-        false
-      expected:
-        content_type: application/json
-        status: 400

data/examples/restful/webspicy/todo/todos.csv

@@ -1,4 +0,0 @@
-id,description
-10,Write documentation
-11,Create website
-12,Add smart tools

data/examples/single_spec/spec.yml

@@ -1,59 +0,0 @@
----
-name: |-
-  Todo
-
-url: |-
-  http://127.0.0.1:4567/todo/{id}
-
-services:
-- method: |-
-    GET
-
-  description: |-
-    Returns a single todo item
-
-  input_schema: |-
-    {
-      id: Integer
-    }
-
-  output_schema: |-
-    {
-      id: Integer
-      description: String
-    }
-
-  error_schema: |-
-    {
-      error: String
-    }
-
-  examples:
-
-    - description: |-
-        when requested on an existing TODO
-      headers:
-        Accept: application/json
-      params:
-        id: 1
-      expected:
-        content_type: application/json
-        status: 200
-      assert:
-        - "pathFD('', id: 1)"
-        - "match('description', /Refactor/)"
-        - "notMatch('description', /Foo/)"
-
-  counterexamples:
-
-    - description: |-
-        when requested on an unexisting TODO
-      headers:
-        Accept: application/json
-      params:
-        id: 999254654
-      expected:
-        content_type: application/json
-        status: 404
-      assert:
-        - "pathFD('', error: 'No such todo')"

data/examples/website/config.rb

@@ -1,2 +0,0 @@
-Webspicy::Configuration.new{|c|
-}

data/examples/website/schema.fio

@@ -1 +0,0 @@
-@import webspicy/scalars

data/examples/website/specification/get-http.yml

@@ -1,30 +0,0 @@
----
-url: |-
-  http://yourbackendisbroken.dev
-
-method: |-
-  GET
-
-description: |-
-  Redirects to the https version
-
-input_schema: |-
-  Any
-
-output_schema: |-
-  Any
-
-error_schema: |-
-  Any
-
-examples:
-
-  - description: |-
-      it works
-    params:
-      id: 1
-    expected:
-      content_type: text/html
-      status: 3xx
-      headers:
-        Location: https://yourbackendisbroken.dev/?id=1

data/examples/website/specification/get-https.yml

@@ -1,30 +0,0 @@
----
-url: |-
-  https://yourbackendisbroken.dev
-
-method: |-
-  GET
-
-description: |-
-  Returns the web page
-
-input_schema: |-
-  Any
-
-output_schema: |-
-  Any
-
-error_schema: |-
-  Any
-
-examples:
-
-  - description: |-
-      it works
-    params:
-      id: 1
-    expected:
-      content_type: text/html
-      status: 200
-    assert:
-      - notEmpty

data/lib/webspicy/checker.rb

@@ -1,25 +0,0 @@
-module Webspicy
-  class Checker
-
-    def initialize(config)
-      @config = Configuration.dress(config)
-    end
-    attr_reader :config
-
-    def call
-      config.each_scope do |scope|
-        scope.each_specification_file do |file, folder|
-          RSpec.describe file.relative_to(folder).to_s do
-
-            it 'meets the formal doc data schema' do
-              Webspicy.specification(file.load, file, scope)
-            end
-
-          end
-        end
-      end
-      RSpec::Core::Runner.run config.rspec_options
-    end
-
-  end
-end

data/lib/webspicy/mocker.rb

@@ -1,88 +0,0 @@
-require "finitio/generation"
-require "json"
-module Webspicy
-  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 Webspicy

data/lib/webspicy/openapi/generator.rb

@@ -1,127 +0,0 @@
-require "finitio/generation"
-require "finitio/json_schema"
-module Webspicy
-  module Openapi
-    class Generator
-
-      def initialize(config)
-        @config = Configuration.dress(config)
-        @generator = config.generator || Finitio::Generation.new
-      end
-      attr_reader :config, :generator
-
-      def call
-        {
-          openapi: "3.0.2",
-          info: {
-            version: "1.0.0",
-            title: "Hello API"
-          },
-          paths: paths
-        }
-      end
-
-    private
-
-      def paths
-        config.each_scope.inject({}) do |paths,scope|
-          scope.each_specification.inject(paths) do |paths,specification|
-            paths.merge(path_for(specification)){|k,ps,qs|
-              ps.merge(qs)
-            }
-          end
-        end
-      end
-
-      def path_for(specification)
-        {
-          specification.url => {
-            summary: specification.name
-          }.merge(verbs_for(specification))
-        }
-      end
-
-      def verbs_for(specification)
-        specification.services.inject({}) do |verbs,service|
-          verb = service.method.downcase
-          verb_defn = {
-            description: service.description,
-            responses: responses_for(service)
-          }
-          unless ["get", "options", "delete", "head"].include?(verb)
-            verb_defn[:requestBody] = request_body_for(service)
-          end
-          verbs.merge({ verb => verb_defn })
-        end
-      end
-
-      def request_body_for(service)
-        schema = actual_input_schema(service)
-        {
-          required: true,
-          content: {
-            "application/json" => {
-              schema: schema.to_json_schema,
-              example: generator.call(schema, {})
-            }
-          }
-        }
-      end
-
-      def responses_for(service)
-        result = {}
-        service.examples.each_with_object(result) do |test_case, rs|
-          rs.merge!(response_for(test_case, false)){|k,r1,r2| r1 }
-        end
-        service.counterexamples.each_with_object(result) do |test_case, rs|
-          rs.merge!(response_for(test_case, true)){|k,r1,r2| r1 }
-        end
-        result
-      end
-
-      def response_for(test_case, counterexample)
-        res = {
-          description: test_case.description,
-        }
-        status = (test_case.expected_status && test_case.expected_status.to_int) || 200
-        if test_case.expected_content_type && status != 204
-          content = {
-            schema: schema_for(test_case, counterexample)
-          }
-          unless counterexample
-            content[:example] = example_for(test_case, counterexample)
-          end
-          res[:content] = {
-            test_case.expected_content_type => content
-          }
-        end
-        {
-          status => res
-        }
-      end
-
-      def schema_for(test_case, counterexample)
-        schema = actual_output_schema(test_case, counterexample)
-        schema.to_json_schema
-      end
-
-      def example_for(test_case, counterexample)
-        schema = actual_output_schema(test_case, counterexample)
-        generator.call(schema, {})
-      end
-
-      def actual_output_schema(test_case, counterexample)
-        if counterexample
-          test_case.service.error_schema['Main']
-        else
-          test_case.service.output_schema['Main']
-        end
-      end
-
-      def actual_input_schema(service)
-        service.input_schema['Main']
-      end
-
-    end # class Generator
-  end # module Openapi
-end # module Webspicy