webspicy 0.15.5 → 0.16.1

data/examples/restful/webspicy/support/must_be_authenticated.rb

@@ -30,7 +30,7 @@ class MustBeAuthenticated
   def counterexample(description, role, expected, status = 401)
     YAML.load <<-YML.gsub(/^\s+[#][ ]/, "")
     # description: |-
-    #   (#{self.class.name}) #{description}
+    #   #{description} (#{self.class.name} PRE)
     # params:
     #   id: 1
     # dress_params:
@@ -41,7 +41,7 @@ class MustBeAuthenticated
     #   content_type: application/json
     #   status: #{status}
     # assert:
-    #   - "pathFD('', error: '#{expected}')" 
+    #   - "pathFD('', error: '#{expected}')"
     YML
   end
 

data/examples/restful/webspicy/support/todo_removed.rb

@@ -0,0 +1,18 @@
+class TodoRemoved
+  include Webspicy::Specification::Postcondition
+
+  def self.match(service, descr)
+    return TodoRemoved.new if descr =~ /The todo has been removed/
+  end
+
+  def check(invocation)
+    client = invocation.client
+    id = invocation.test_case.params['id']
+    url = "/todo/#{id}"
+    response = client.api.get(url, {}, {
+      "Accept" => "application/json"
+    })
+    return nil if response.status == 404
+    "Todo `#{id}` was not deleted, it has been found"
+  end
+end

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

@@ -15,13 +15,16 @@ services:
   preconditions:
     - Must be an admin
 
+  postconditions:
+    - The todo has been removed
+
   input_schema: |-
     {
       id: Integer
     }
 
   output_schema: |-
-    .
+    Any
 
   error_schema: |-
     ErrorSchema

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

@@ -0,0 +1,46 @@
+---
+url: |-
+  /todo/{id}
+
+method: |-
+  GET
+
+description: |-
+  Returns a single todo item
+
+input_schema: |-
+  {
+    id: Integer
+  }
+
+output_schema: |-
+  Todo
+
+error_schema: |-
+  ErrorSchema
+
+examples:
+
+  - description: |-
+      when requested on an existing TODO
+    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
+    params:
+      id: 999254654
+    expected:
+      content_type: application/json
+      status: 404
+    assert:
+      - "pathFD('', error: 'No such todo')"

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

@@ -17,7 +17,7 @@ services:
     }
 
   output_schema: |-
-    .
+    Any
 
   error_schema: |-
     ErrorSchema

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

@@ -36,6 +36,9 @@ services:
       params:
         id: 1
         description: 'hello world'
+      expected:
+        content_type: application/json
+        status: 200
       assert:
         - "pathFD('', description: 'hello world')"
 

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

@@ -16,7 +16,7 @@ services:
     - Must be authenticated
 
   input_schema: |-
-    .
+    Any
 
   output_schema: |-
     { count: Integer }

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

@@ -0,0 +1,65 @@
+---
+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/single_spec/spec.yml

@@ -0,0 +1,59 @@
+---
+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

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

data/examples/website/schema.fio

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

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

@@ -0,0 +1,34 @@
+---
+name: |-
+  Your backend is broken website
+
+url: |-
+  http://yourbackendisbroken.dev
+
+services:
+- 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

@@ -0,0 +1,34 @@
+---
+name: |-
+  Your backend is broken website
+
+url: |-
+  https://yourbackendisbroken.dev
+
+services:
+- 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/finitio/webspicy/scalars.fio

@@ -0,0 +1,25 @@
+# Any
+Any        = .
+
+# Booleans
+Nil        = .NilClass
+True       = .TrueClass
+False      = .FalseClass
+Boolean    = .TrueClass|.FalseClass
+
+# Numbers
+Numeric = .Numeric
+Integer = .Integer
+Float   = .Float
+Real    = .Float
+
+# String
+String  = .String
+
+# Date, Time, DateTime
+Date     = .Date     <iso8601> .String \( s | Date.iso8601(s) )
+                                       \( d | d.iso8601       )
+Time     = .Time     <iso8601> .String \( s | Time.iso8601(s) )
+                                       \( t | t.iso8601       )
+DateTime = .DateTime <iso8601> .String \( s | DateTime.iso8601(s) )
+                                       \( t | t.iso8601           )

data/lib/webspicy.rb

@@ -7,25 +7,33 @@ require 'ostruct'
 require 'yaml'
 require 'rspec'
 require 'rack/test'
-require "mustermann"
+require 'mustermann'
+require 'colorized_string'
+require 'securerandom'
 module Webspicy
 
   ###
   ### Load library
   ###
 
+  require 'webspicy/version'
   require 'webspicy/support'
+  require 'webspicy/specification'
   require 'webspicy/configuration'
-  require 'webspicy/file_upload'
-  require 'webspicy/scope'
-  require 'webspicy/client'
-  require 'webspicy/resource'
-  require 'webspicy/precondition'
-  require 'webspicy/postcondition'
   require 'webspicy/checker'
   require 'webspicy/tester'
-  require 'webspicy/tester/assertions'
-  require 'webspicy/tester/asserter'
+
+  ###
+  ### Backward compatibility
+  ###
+  Client = Tester::Client
+  HttpClient = Tester::HttpClient
+  RackTestClient = Tester::RackTestClient
+  Resource = Specification
+  Precondition = Specification::Precondition
+  Postcondition = Specification::Postcondition
+  FileUpload = Specification::FileUpload
+  Scope = Configuration::Scope
 
   ###
   ### About folders
@@ -36,30 +44,38 @@ module Webspicy
   EXAMPLES_FOLDER = ROOT_FOLDER/('examples')
 
   ###
-  ### About formal doc and resources defined there
+  ### About formal doc and specifications defined there
   ###
-
+  Finitio.stdlib_path(Path.dir/"finitio")
+  DEFAULT_SYSTEM = Finitio.system(<<~FIO)
+    @import webspicy/scalars
+  FIO
   FORMALDOC = Finitio.system(Path.dir/("webspicy/formaldoc.fio"))
 
   # Returns a default scope instance.
   def default_scope
-    Scope.new(Configuration.new)
+    Configuration::Scope.new(Configuration.new)
   end
   module_function :default_scope
 
-  def resource(raw, file = nil, scope = default_scope)
+  def specification(raw, file = nil, scope = default_scope)
+    raw = YAML.load(raw) if raw.is_a?(String)
     with_scope(scope) do
-      r = FORMALDOC["Resource"].dress(raw)
+      r = FORMALDOC["Specification"].dress(raw)
       r.located_at!(file) if file
       r
     end
+  rescue Finitio::Error => ex
+    handle_finitio_error(ex, scope)
   end
-  module_function :resource
+  module_function :specification
 
   def service(raw, scope = default_scope)
     with_scope(scope) do
       FORMALDOC["Service"].dress(raw)
     end
+  rescue Finitio::Error => ex
+    handle_finitio_error(ex)
   end
   module_function :service
 
@@ -67,9 +83,19 @@ module 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, scope)
+    # msg = "#{ex.message}:\n    #{ex.root_cause.message}"
+    # msg = Support::Colorize.colorize_error(msg, scope.config)
+    # fatal(msg)
+    raise
+  end
+  module_function :handle_finitio_error
+
   #
   # Yields the block after having installed `scope` globally.
   #
@@ -120,7 +146,7 @@ module Webspicy
     if scope = Thread.current[:webspicy_scope]
       scope.parse_schema(fio)
     else
-      Finitio.system(fio)
+      DEFAULT_SYSTEM.system(fio)
     end
   end
   module_function :schema
@@ -132,7 +158,7 @@ module Webspicy
   LOGGER = ::Logger.new(STDOUT)
   LOGGER.level = Logger.const_get(ENV['LOG_LEVEL'] || 'WARN')
   LOGGER.formatter = proc { |severity, datetime, progname, msg|
-    "      " + msg + "\n"
+    "  " + msg + "\n"
   }
 
   def info(*args, &bl)
@@ -145,4 +171,9 @@ module Webspicy
   end
   module_function :debug
 
+  def fatal(*args, &bl)
+    LOGGER && LOGGER.fatal(*args, &bl)
+  end
+  module_function :fatal
+
 end