tiki 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22362bea858f0557ca006c51c2b13a6fc5b48c7f182cbbfe4a98d0354c6705b0
+  data.tar.gz: dca021fca6946434e767c9353be636542c90612dd7ba18aeca74ebc4581a2446
+SHA512:
+  metadata.gz: 567b28b4ab36e5d66a96dc246883c9cd4d5bf508b73b534b4897ca44c6b5797e267c3d455bdff5733ba1b9e862a1b417919940e6c9a69faf21f2daf2fb962a6d
+  data.tar.gz: 1d89c45ccd07820e41a1b3a4cab67ed3ec31312b6460d7344e4d4880276230654f862cfde375796fa7d75ae04abc66423aeea211abd982ddabbd7c0345aab57c

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'hanami-router', '>= 2.0.0.beta4'
+gem 'optimist'
+
+group :development do
+  gem 'rspec'
+end

data/bin/tiki

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'tiki'
+
+tiki

data/lib/tiki/components.rb

@@ -0,0 +1,76 @@
+require_relative './props'
+require_relative './schema'
+require_relative './reference'
+require_relative './parameter'
+
+using Props
+
+class Components
+  hash_props :schemas, :parameters
+
+  # Schema
+  def schema(name, type = nil, title = nil, **named, &block)
+    @schemas ||= []
+    schema = Schema.new type, title, **named
+    schema.instance_eval(&block) if block
+    @schemas.push [name, schema]
+  end
+
+  def object(name, title = nil, **named, &block)
+    schema name, :object, title, **named, &block
+  end
+
+  def array(name, items_type = nil, title = nil, ref: nil, **named, &block)
+    if ref
+      schema :array, title do
+        items ref: ref
+      end
+    else
+      schema name, :array, title do
+        items items_type, **named, &block
+      end
+    end
+  end
+
+  def hash_map(name, items_type = nil, title = nil, ref: nil, **named, &block)
+    if ref
+      schema :object, title do
+        additional_properties ref: ref
+      end
+    else
+      schema name, :object, title do
+        additional_properties items_type, **named, &block
+      end
+    end
+  end
+
+  # Response
+  def response(name = nil, _description = nil, ref: nil, **named, &block)
+    if ref
+      reference = Reference.new ref
+      @responses << [name, reference]
+    else
+      @responses ||= []
+      response = Response.new description, **named
+      response.instance_eval(&block) if block
+      @responses << [name, response]
+    end
+  end
+
+  # Parameter
+  def parameter(name = nil, ref: nil, **named, &block)
+    @parameters ||= []
+    if ref
+      reference = Reference.new ref
+      @parameters << [name, reference]
+    else
+      parameter = Parameter.new name, **named
+      parameter.instance_eval(&block) if block
+      @parameters << [name, parameter]
+    end
+  end
+
+  def to_spec
+    hash_props
+  end
+end

data/lib/tiki/content.rb

@@ -0,0 +1,36 @@
+require_relative './media-type'
+
+module Content
+  def content(mime = nil, **named, &block)
+    @content ||= []
+    media_type = MediaType.new(**named)
+    media_type.instance_eval(&block) if block
+    @content.push [resolve_mime_type(mime), media_type]
+    media_type
+  end
+
+  def schema(type = nil, title = nil, **named, &block)
+    content do
+      schema type, title, **named, &block
+    end
+  end
+
+  def object(title, **named, &block)
+    schema :object, title, **named, &block
+  end
+
+  def array(items_type = nil, title = nil, **named, &block)
+    schema :array, title do
+      items items_type, **named, &block
+    end
+  end
+end
+
+MIME_TYPES = {
+  json: 'application/json',
+  xml: 'application/xml'
+}
+
+def resolve_mime_type(mime)
+  MIME_TYPES[mime] || mime || 'application/json'
+end

data/lib/tiki/external-documentation.rb

@@ -0,0 +1,16 @@
+require_relative './props'
+
+using Props
+
+class ExternalDocumentation
+  props :url, :description
+  scalar_props :url, :description
+
+  def initialize(url = nil)
+    @url = url
+  end
+
+  def to_spec
+    scalar_props
+  end
+end

data/lib/tiki/list-helpers.rb

@@ -0,0 +1,57 @@
+module ListHelpers
+  refine Symbol do
+    def |(other)
+      OrList.new self, other
+    end
+
+    def &(other)
+      AndList.new self, other
+    end
+  end
+
+  refine String do
+    def |(other)
+      OrList.new self, other
+    end
+
+    def &(other)
+      AndList.new self, other
+    end
+  end
+
+  refine Array do
+    def |(other)
+      OrList.new self, other
+    end
+
+    def &(other)
+      AndList.new self, other
+    end
+  end
+end
+
+class OrList
+  attr_reader :list
+
+  def initialize(*args)
+    @list = args
+  end
+
+  def |(other)
+    @list << other
+    self
+  end
+end
+
+class AndList
+  attr_reader :list
+
+  def initialize(*args)
+    @list = args
+  end
+
+  def &(other)
+    @list << other
+    self
+  end
+end

data/lib/tiki/media-type.rb

@@ -0,0 +1,32 @@
+require_relative './props'
+require_relative './reference'
+require_relative './schema'
+
+using Props
+
+class MediaType
+  props :ref
+
+  def initialize(schema: :object, ref: nil)
+    if ref
+      @schema = Reference.new ref
+    elsif schema
+      @schema = Schema.new schema
+    end
+  end
+
+  def schema(type = :object, title = nil, ref: nil, &block)
+    if ref
+      @schema = Reference.new ref
+    else
+      @schema = Schema.new type, title
+      @schema.instance_eval(&block) if block
+    end
+  end
+
+  def to_spec
+    props = {}
+    props[:schema] = @schema.to_spec if @schema
+    props
+  end
+end

data/lib/tiki/operation.rb

@@ -0,0 +1,88 @@
+require_relative './props'
+require_relative './parameter'
+require_relative './response'
+require_relative './reference'
+require_relative './reason'
+require_relative './request-body'
+
+using Props
+
+class Operation
+  props :operation_id, :summary, :description, :deprecated, :tags
+  scalar_props :operation_id, :summary, :description, :deprecated, :tags
+  hash_props :responses
+  array_props :parameters
+  object_props :request_body
+
+  def initialize(operation_id = nil)
+    @operation_id = operation_id
+    @responses = []
+  end
+
+  def external_documentation(url = nil, &block)
+    @external_documentation = ExternalDocumentation.new url
+    @external_documentation.instance_eval(&block) if block
+  end
+
+  def parameter(name = nil, ref: nil, **named, &block)
+    @parameters ||= []
+    if ref
+      reference = Reference.new ref
+      @parameters.push reference
+    else
+      parameter = Parameter.new name, **named
+      parameter.instance_eval(&block) if block
+      @parameters.push parameter
+    end
+  end
+
+  def request_body(*args, ref: nil, **named, &block)
+    if ref
+      @request_body = Reference.new ref, :request_body
+    else
+      body = RequestBody.new(*args, **named)
+      body.instance_eval(&block) if block
+      @request_body = body
+    end
+  end
+
+  def request_body!(*args, **named)
+    request_body(*args, required: true, **named)
+  end
+
+  alias request_body? request_body
+  alias body request_body
+  alias body! request_body!
+  alias body? request_body?
+
+  def response(status = nil, schema = nil, description: nil, ref: nil, &block)
+    if ref
+      @responses.push [status || 200, Reference.new(ref, :response)]
+    else
+      unless status.is_a?(Integer) || schema
+        schema = status
+        status = 200
+      end
+      response = Response.new schema, description: description || reason(status)
+      response.instance_eval(&block) if block
+      @responses.push [status, response]
+    end
+  end
+
+  def responses(*statuses)
+    statuses.each { |status| response status }
+  end
+
+  def tags(*tags)
+    @tags = tags.flatten
+  end
+
+  def to_spec
+    props = {}
+    scalar_props props
+    array_props props
+    hash_props props
+    object_props props
+    props
+  end
+end

data/lib/tiki/parameter.rb

@@ -0,0 +1,48 @@
+require_relative './props'
+require_relative './schema'
+
+using Props
+
+INS = %i[query header cookie].freeze
+
+class Parameter
+  props :description
+
+  def initialize(name, in: :query, required: false, schema: :string)
+    @name = name
+    @in = binding.local_variable_get(:in)
+    @required = required || @in == :path
+    @schema = Schema.new schema if schema
+  end
+
+  def required(required = true)
+    @required = required || @in == :path
+  end
+
+  def schema(type, &block)
+    @schema = Schema.new type
+    @schema.instance_eval(&block) if block
+  end
+
+  def path
+    @in = :path
+    @required = true
+  end
+
+  INS.each do |_in|
+    define_method _in do
+      @in = _in
+    end
+  end
+
+  def to_spec
+    props = { name: @name, in: @in, schema: @schema.to_spec }
+    props[:required] = true if @required
+    props[:description] = @description if @description
+    props
+  end
+
+  def get_name
+    @name.to_s
+  end
+end

data/lib/tiki/path-item.rb

@@ -0,0 +1,71 @@
+require_relative './props'
+require_relative './operation'
+require_relative './server'
+
+using Props
+
+VERBS = %i[get put post delete options head patch trace].freeze
+
+class PathItem
+  include ServerMethods
+
+  props :ref, :summary, :description
+  scalar_props :summary, :description
+  array_props :servers
+
+  def initialize(parent, summary = nil, ref: nil)
+    @parameters = []
+    @parent = parent
+    @summary = summary
+    @ref = ref
+  end
+
+  VERBS.each do |verb|
+    define_method verb do |operation_id = nil, &block|
+      @operations ||= []
+      operation = Operation.new operation_id
+      operation.instance_eval(&block) if block
+      @operations.push [verb, operation]
+    end
+  end
+
+  def parameter(name = nil, ref: nil, **named, &block)
+    if ref
+      reference = Reference.new ref
+      @parameters.push reference
+    else
+      named[:in] ||= :path
+      parameter = Parameter.new name, **named
+      parameter.instance_eval(&block) if block
+      @parameters.push parameter
+    end
+  end
+
+  def path(url, summary = nil, **named, &block)
+    child = @parent.child url, @parameters
+    path = PathItem.new child, summary, **named
+    path.instance_eval(&block) if block
+    child.add path
+  end
+
+  def to_spec
+    if @ref
+      { :$ref => @ref }
+    else
+      props = @operations&.map(&->((n, s)) { { n => s.to_spec } })&.inject(&:merge) || {}
+      parameters = @parent.parameters + @parameters
+      props[:parameters] = parameters.map(&:to_spec) unless parameters.empty?
+      scalar_props props
+      array_props props
+      props
+    end
+  end
+
+  def check_parameters(path)
+    parameters = @parent.parameters + @parameters
+    params = path.scan(/\{([a-zA-Z0-9_]+)\}/).map(&:first)
+    params.each do |param|
+      @parameters << Parameter.new(param, in: :path) unless parameters.find { |p| p.get_name == param }
+    end
+  end
+end

data/lib/tiki/props.rb

@@ -0,0 +1,96 @@
+module Props
+  refine Class do
+    def props(*names)
+      names.flatten.each do |name|
+        define_method name do |value|
+          instance_variable_set("@#{name}", value)
+        end
+      end
+    end
+
+    def marker_props(*names)
+      names.flatten.each do |name|
+        define_method name do
+          instance_variable_set("@#{name}", true)
+        end
+      end
+    end
+
+    def named_props(*names)
+      define_method :named_props do |named|
+        names = names.flatten
+        named.each_pair do |name, value|
+          if names.include? name
+            instance_variable_set "@#{name}", value unless value.nil?
+          else
+            puts "Unknown named argument #{name}"
+          end
+        end
+      end
+    end
+
+    def scalar_props(*names)
+      define_method :scalar_props do |props = {}|
+        names.flatten.each do |name|
+          value = instance_variable_get "@#{name}"
+          props[to_camel(name).to_sym] = value unless value.nil?
+        end
+        props
+      end
+    end
+
+    def object_props(*names)
+      define_method :object_props do |props = {}|
+        names.flatten.each do |name|
+          value = instance_variable_get "@#{name}"
+          props[to_camel(name).to_sym] = value.to_spec unless value.nil?
+        end
+        props
+      end
+    end
+
+    def object_or_scalar_props(*names)
+      define_method :object_or_scalar_props do |props = {}|
+        names.flatten.each do |name|
+          value = instance_variable_get "@#{name}"
+          unless value.nil?
+            value = value.to_spec if value.respond_to? :to_spec
+            props[to_camel(name).to_sym] = value
+          end
+        end
+        props
+      end
+    end
+
+    def hash_props(*names)
+      define_method :hash_props do |props = {}|
+        names.flatten.each do |name|
+          hashes = instance_variable_get "@#{name}"
+          unless hashes.nil?
+            value = hashes.map(&->((n, s)) { { n => s.to_spec } }).inject(&:merge) || {}
+            props[to_camel(name).to_sym] = value
+          end
+        end
+        props
+      end
+    end
+
+    def array_props(*names)
+      define_method :array_props do |props = {}|
+        names.flatten.each do |name|
+          array = instance_variable_get "@#{name}"
+          props[to_camel(name).to_sym] = array.map(&:to_spec) unless array.nil?
+        end
+        props
+      end
+    end
+  end
+end
+
+def to_camel(snake)
+  snake.to_s.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
+end
+
+def to_snake(camel)
+  camel.to_s.gsub(/([A-Z])/) { "_#{Regexp.last_match(1).downcase}" }
+end

data/lib/tiki/reason.rb

@@ -0,0 +1,66 @@
+REASONS =
+  {
+    100 => 'Continue',
+    101 => 'Switching Protocols',
+    102 => 'Processing',
+    200 => 'OK',
+    201 => 'Created',
+    202 => 'Accepted',
+    203 => 'Non-Authoritative Information',
+    204 => 'No Content',
+    205 => 'Reset Content',
+    206 => 'Partial Content',
+    207 => 'Multi-Status',
+    208 => 'Already Reported',
+    226 => 'IM Used',
+    300 => 'Multiple Choices',
+    301 => 'Moved Permanently',
+    302 => 'Found',
+    303 => 'See Other',
+    304 => 'Not Modified',
+    305 => 'Use Proxy',
+    307 => 'Temporary Redirect',
+    308 => 'Permanent Redirect',
+    400 => 'Bad Request',
+    401 => 'Unauthorized',
+    402 => 'Payment Required',
+    403 => 'Forbidden',
+    404 => 'Not Found',
+    405 => 'Method Not Allowed',
+    406 => 'Not Acceptable',
+    407 => 'Proxy Authentication Required',
+    408 => 'Request Timeout',
+    409 => 'Conflict',
+    410 => 'Gone',
+    411 => 'Length Required',
+    412 => 'Precondition Failed',
+    413 => 'Payload Too Large',
+    414 => 'URI Too Long',
+    415 => 'Unsupported Media Type',
+    416 => 'Range Not Satisfiable',
+    417 => 'Expectation Failed',
+    421 => 'Misdirected Request',
+    422 => 'Unprocessable Entity',
+    423 => 'Locked',
+    424 => 'Failed Dependency',
+    426 => 'Upgrade Required',
+    428 => 'Precondition Required',
+    429 => 'Too Many Requests',
+    431 => 'Request Header Fields Too Large',
+    451 => 'Unavailable For Legal Reasons',
+    500 => 'Internal Server Error',
+    501 => 'Not Implemented',
+    502 => 'Bad Gateway',
+    503 => 'Service Unavailable',
+    504 => 'Gateway Timeout',
+    505 => 'HTTP Version Not Supported',
+    506 => 'Variant Also Negotiates',
+    507 => 'Insufficient Storage',
+    508 => 'Loop Detected',
+    510 => 'Not Extended',
+    511 => 'Network Authentication Required'
+  }.each { |_, v| v.freeze }.freeze
+
+def reason(status)
+  REASONS[status]
+end

data/lib/tiki/reference.rb

@@ -0,0 +1,21 @@
+GROUPS = {
+  schema: 'components/schemas',
+  response: 'components/responses',
+  request_body: 'components/requestBody'
+}.freeze
+
+class Reference
+  attr_reader :ref
+
+  def initialize(ref, group = :schema)
+    @ref = create_reference ref, group
+  end
+
+  def to_spec
+    { :$ref => @ref }
+  end
+end
+
+def create_reference(ref, group = :schema)
+  ref.is_a?(Symbol) ? "#/#{GROUPS[group]}/#{ref}" : ref
+end

data/lib/tiki/request-body.rb

@@ -0,0 +1,27 @@
+require_relative './props'
+require_relative './content'
+
+using Props
+
+class RequestBody
+  include Content
+  props :description, :required
+  scalar_props :description
+  hash_props :content
+
+  def initialize(type = nil, mime = nil, description: nil, required: false)
+    @description = description
+    @required = required
+    content mime do
+      schema(type) if type
+    end
+  end
+
+  def to_spec
+    props = {}
+    scalar_props props
+    hash_props props
+    props[:required] = @required if @required
+    props
+  end
+end

data/lib/tiki/response.rb

@@ -0,0 +1,27 @@
+require_relative './props'
+require_relative './content'
+
+using Props
+
+# TODO: headers and links
+
+class Response
+  include Content
+  props :description
+  scalar_props :description
+  hash_props :content
+
+  def initialize(type = nil, mime = nil, description: nil)
+    @description = description
+    content mime do
+      schema(type) if type
+    end
+  end
+
+  def to_spec
+    props = {}
+    scalar_props props
+    hash_props props
+    props
+  end
+end