apiculture 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d78cc86595f72f0ec4ea08adaa5b545798eb54653aafedb47d3e6923351b3b76
-  data.tar.gz: 532aa3794d65dfd962d4d5984a29678e026b5da43efd1f5ad5dbaea4d4ee6ff1
+  metadata.gz: 1669c3138f92cf9b5c0db92933612e3d3c15430a0b641141eae633859663d069
+  data.tar.gz: cb9c4458d470ee191a62b9df0ab28cc0fdb432ec28ad155f22e8497a91633692
 SHA512:
-  metadata.gz: b351b52e4a10c1c7ee2b7d4f7b5c8f63d4ed8b28f65348ebf63ec0f064ccb55b9bfd6cad6f21d49c34867436dfc50036e67f4d8fdb206f3525581346ee7db3a8
-  data.tar.gz: 9a0d97711023461335d4237f44e077daf2b1669c9509bb53dcd79571fb8a157188fb06b9d93db28ab9df69f170d152c50746ce8c27f73eb2af7781963d8e26bf
+  metadata.gz: 400c9e119a6d47b3812cbd93ac2fb827b68ba7d9e25d1201a007494c42eba7f5dd75009334b26dc21c8cd2f8b50193e858ee25ebfb3bfa057e52bd518f1e953d
+  data.tar.gz: 8b314eb600095c4ad707ce6fe3f0f793e33d14ae374f55eda70d7a226532a59d93c8b312aac370ac05024b9a1c03e647f72f272a188bacbc58885a2131bfb578

data/.github/dependabot.yml

@@ -0,0 +1,16 @@
+---
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+      time: "10:00"
+      timezone: Europe/Amsterdam
+  - package-ecosystem: bundler
+    directory: /
+    registries: "*"
+    schedule:
+      interval: daily
+      time: "09:00"
+      timezone: Europe/Amsterdam

data/.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+name: CI
+on:
+  pull_request:
+    branches:
+      - master
+    # dependabot PRs only have read permission so cannot run this workflow.
+    paths-ignore:
+      - "**/*.md"
+      - ".gitignore"
+      - "README.md"
+      - ".env.example"
+      - "docs/*"
+jobs:
+  validate:
+    uses: ./.github/workflows/validate.yml

data/.github/workflows/validate.yml

@@ -0,0 +1,28 @@
+name: Validate
+on:
+  workflow_call:
+
+jobs:
+  validate:
+    name: Validate
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.2'
+          - '3.3'
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: |
+          bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,7 @@
 ## 0.2.0
 * Add ruby 3 support
 * Bump `mustermann` dependency to '~> 3'
+
+
+## 0.2.1
+* Add support for nested fields

data/README.md

@@ -2,7 +2,7 @@
 
 A little toolkit for building RESTful API backends on top of Rack.
 
-[![Build Status](https://travis-ci.org/WeTransfer/apiculture.svg?branch=master)](https://travis-ci.org/WeTransfer/apiculture)
+[![CI](https://github.com/WeTransfer/apiculture/actions/workflows/ci.yml/badge.svg)](https://github.com/WeTransfer/apiculture/actions/workflows/ci.yml)
 
 ## Ideas
 

data/apiculture.gemspec

@@ -15,13 +15,7 @@ Gem::Specification.new do |s|
   # Prevent pushing this gem to RubyGems.org.
   # To allow pushes either set the 'allowed_push_host'
   # To allow pushing to a single host or delete this section to allow pushing to any host.
-  if s.respond_to?(:metadata)
-    s.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
+  s.metadata['allowed_push_host'] = 'https://rubygems.org'
   s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
   s.extra_rdoc_files = [
     'LICENSE.txt',

data/lib/apiculture/app_documentation.rb

@@ -6,38 +6,38 @@ class Apiculture::AppDocumentation
     def to_markdown
       string.to_markdown.to_s rescue string.to_s
     end
-    
+
     def to_html
       '<section class="%s">%s</section>' % [Rack::Utils.escape_html(section_class), render_markdown(to_markdown)]
     end
-    
+
     def render_markdown(s)
       GitHub::Markup.render('section.markdown', s.to_s)
     end
   end
-  
+
   def initialize(app, mountpoint, action_definitions_and_markdown_segments)
     @app_title = app.to_s
     @mountpoint = mountpoint
     @chunks = action_definitions_and_markdown_segments
   end
-  
+
   # Generates a Markdown string that contains the entire API documentation
   def to_markdown
     (['## %s' % @app_title] + to_markdown_slices).join("\n\n")
-  end 
+  end
 
   def to_openapi
     OpenApiDocumentation::Base.new(@app_title, @mountpoint, @chunks)
   end
-  
+
   # Generates an HTML fragment string that can be included into another HTML document
   def to_html_fragment
     to_markdown_slices.map do |tagged_markdown|
       tagged_markdown.to_html
     end.join("\n\n")
   end
-  
+
   def to_markdown_slices
     markdown_slices = @chunks.map do | action_def_or_doc |
       if action_def_or_doc.respond_to?(:http_verb) # ActionDefinition
@@ -48,7 +48,7 @@ class Apiculture::AppDocumentation
       end
     end
   end
-  
+
   # Generates a complete HTML document string that can be saved into a file
   def to_html
     require 'mustache'

data/lib/apiculture/openapi_documentation.rb

@@ -8,9 +8,9 @@ module OpenApiDocumentation
       @paths = chunks.select { |chunk| chunk.respond_to?(:http_verb) }
       @data = {
         openapi: '3.0.0',
-        info: { 
-          title: @app.to_s, 
-          version: '0.0.1', 
+        info: {
+          title: @app.to_s,
+          version: '0.0.1',
           description: @app.to_s + " " + chunks.select { |chunk| chunk.respond_to?(:to_markdown) }.map(&:to_markdown).join("\n")
         },
         tags: []
@@ -27,7 +27,7 @@ module OpenApiDocumentation
     end
 
     def spec
-      @data      
+      @data
     end
 
     private
@@ -137,7 +137,7 @@ module OpenApiDocumentation
 
     def build_request_body
       return nil if VERBS_WITHOUT_BODY.include?(@path.http_verb)
-      
+
       body_params = Hash[ @path.parameters.collect do |parameter|
         [parameter.name, {
           type: Util.map_type(parameter.matchable),
@@ -171,7 +171,7 @@ module OpenApiDocumentation
         unless response.jsonable_object_example.nil? || response.jsonable_object_example.empty?
           _response[:content] = {
             'application/json': {
-                schema: 
+                schema:
                   { type: 'object',
                   properties: Util.response_to_schema(response.jsonable_object_example) }
             }
@@ -198,15 +198,27 @@ module OpenApiDocumentation
     }.freeze
 
     def self.response_to_schema(response)
-      schema = {}
-      return nil if response.nil? || response.empty? || response.class == String
-      response.each do |key, value|
-        schema[key] = {
-          type: 'string',
-          example: value.to_s
-        }
+      case response
+      when NilClass
+      when String
+        { type: 'string', example: response }
+      when Integer
+        { type: 'integer', example: response }
+      when Float
+        { type: 'float', example: response }
+      when Array
+        if response.empty?
+          { type: 'array', items: {} }
+        else
+          { type: 'array', items: response.map { |elem| response_to_schema(elem) } }
+        end
+      when Hash
+        response.each_with_object({}) do |(key, val), schema_hash|
+          schema_hash[key] = response_to_schema(val)
+        end
+      else
+        { type: response.class.name.downcase, example: response.to_s }
       end
-      schema
     end
 
     def self.map_type(type)

data/lib/apiculture/version.rb

@@ -1,3 +1,3 @@
 module Apiculture
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/lib/apiculture.rb

@@ -2,7 +2,6 @@
 module Apiculture
   require_relative 'apiculture/version'
   require_relative 'apiculture/indifferent_hash'
-  require_relative 'apiculture/app'
   require_relative 'apiculture/action'
   require_relative 'apiculture/sinatra_instance_methods'
   require_relative 'apiculture/action_definition'
@@ -16,6 +15,12 @@ module Apiculture
     super
   end
 
+  class Void
+    def <<(_item); end
+    def map; []; end
+    def select; []; end
+  end
+
   IDENTITY_PROC = ->(arg) { arg }
 
   AC_APPLY_TYPECAST_PROC = ->(cast_proc_or_method, v) {
@@ -277,7 +282,16 @@ module Apiculture
   end
 
   def apiculture_stack
-    @apiculture_actions_and_docs ||= []
+    if environment == "development"
+      @apiculture_actions_and_docs ||= []
+    else
+      @apiculture_actions_and_docs ||= Void.new
+    end
     @apiculture_actions_and_docs
   end
+
+  # Based on the RACK_ENV it will generate documentation or not
+  def environment
+    @environment ||= ENV.fetch("RACK_ENV", "development")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apiculture
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-08 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -173,20 +173,19 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/validate.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - apiculture.gemspec
-- gemfiles/Gemfile.rack-1.x
-- gemfiles/Gemfile.rack-2.x
 - lib/apiculture.rb
 - lib/apiculture/action.rb
 - lib/apiculture/action_definition.rb
-- lib/apiculture/app.rb
 - lib/apiculture/app_documentation.rb
 - lib/apiculture/app_documentation_tpl.mustache
 - lib/apiculture/indifferent_hash.rb
@@ -216,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Sweet API sauce on top of Rack

data/.travis.yml

@@ -1,13 +0,0 @@
-gemfile:
-  - gemfiles/Gemfile.rack-1.x
-  - gemfiles/Gemfile.rack-2.x
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0
-  - 3.2
-sudo: false
-cache: bundler

data/gemfiles/Gemfile.rack-1.x

@@ -1,16 +0,0 @@
-source "http://rubygems.org"
-gem 'rack', "~> 1"
-
-gem 'mustermann', '~> 1'
-gem 'builder', '~> 3'
-gem 'rdiscount', '~> 2'
-gem 'github-markup', '~> 1'
-gem 'mustache', '~> 1'
-
-group :development do
-  gem 'rack-test'
-  gem "rspec", "~> 3"
-  gem "rdoc", "~> 6.0"
-  gem "rake"
-  gem "bundler"
-end

data/gemfiles/Gemfile.rack-2.x

@@ -1,16 +0,0 @@
-source "http://rubygems.org"
-gem 'rack', "~> 2"
-
-gem 'mustermann', '~> 1'
-gem 'builder', '~> 3'
-gem 'rdiscount', '~> 2'
-gem 'github-markup', '~> 1'
-gem 'mustache', '~> 1'
-
-group :development do
-  gem 'rack-test'
-  gem "rspec", "~> 3"
-  gem "rdoc", "~> 6.0"
-  gem "rake"
-  gem "bundler"
-end

data/lib/apiculture/app.rb

@@ -1,131 +0,0 @@
-require'mustermann'
-
-class Apiculture::App
-
-  class << self
-    def use(middlreware_factory, middleware_options, &middleware_blk)
-      @middleware_configurations ||= []
-      @middleware_configurations << [middleware_factory, middleware_options, middleware_blk]
-    end
-
-    def middleware_configurations
-      @middleware_configurations || []
-    end
-
-    def get(url, **options, &handler_blk)
-      define_action :get, url, **options, &handler_blk
-    end
-
-    def post(url, **options, &handler_blk)
-      define_action :post, url, **options, &handler_blk
-    end
-
-    def put(url, **options, &handler_blk)
-      define_action :put, url, **options, &handler_blk
-    end
-
-    def delete(url, **options, &handler_blk)
-      define_action :delete, url, **options, &handler_blk
-    end
-
-    def actions
-      @actions || []
-    end
-
-    def define_action(http_method, url_path, **options, &handler_blk)
-      @actions ||= []
-      @actions << [http_method.to_s.upcase, url_path, options, handler_blk]
-    end
-  end
-
-  def call_without_middleware(env)
-    @env = env
-
-    # First try to route via actions...
-    given_http_method = env.fetch('REQUEST_METHOD')
-    given_path = env.fetch('PATH_INFO')
-    given_path = '/' + given_path unless given_path.start_with?('/')
-
-    action_list = self.class.actions
-    # TODO: I believe Sinatra matches bottom-up, not top-down.
-    action_list.reverse.each do | (action_http_method, action_url_path, action_options, action_handler_callable)|
-      route_pattern = Mustermann.new(action_url_path)
-      if given_http_method == action_http_method && route_params = route_pattern.params(given_path)
-        @request = Rack::Request.new(env)
-        @params.merge!(@request.params)
-        @route_params = route_params
-
-        match = route_pattern.match(given_path)
-        @route_params['captures'] = match.captures unless match.nil?
-        @params.merge!(@route_params)
-        return perform_action_block(&action_handler_callable)
-      end
-    end
-
-    # and if nothing works out - respond with a 404
-    out = JSON.pretty_generate({
-      error: 'No matching action found for %s %s' % [given_http_method, given_path],
-    })
-    [404, {'Content-Type' => 'application/json', 'Content-Length' => out.bytesize.to_s}, [out]]
-  end
-
-  def self.call(env)
-    app = new
-    Rack::Builder.new do
-      (@middleware_configurations || []).each do |middleware_args|
-        use(*middleware_args)
-      end
-      run ->(env) { app.call_without_middleware(env) }
-    end.to_app.call(env)
-  end
-
-  attr_reader :request
-  attr_reader :env
-  attr_reader :params
-
-  def initialize
-    @status = 200
-    @content_type = 'text/plain'
-    @params = Apiculture::IndifferentHash.new
-  end
-
-  def content_type(new_type)
-    @content_type = Rack::Mime.mime_type('.%s' % new_type)
-  end
-
-  def status(status_code)
-    @status = status_code.to_i
-  end
-
-  def halt(rack_status, rack_headers, rack_body)
-    throw :halt, [rack_status, rack_headers, rack_body]
-  end
-
-  def perform_action_block(&blk)
-    # Executes the action in a Sinatra-like fashion - passing the route parameter values as
-    # arguments to the given block/callable. This is where in the future we should ditch
-    # the Sinatra calling conventions - Sinatra mandates that the action accept the route parameters
-    # as arguments and grab all the useful stuff from instance methods like `params` etc. whereas
-    # we probably want to have just Rack apps mounted per route (under an action)
-    response = catch(:halt) do
-      body_string_or_rack_triplet = instance_exec(*@route_params.values, &blk)
-
-      if rack_triplet?(body_string_or_rack_triplet)
-        return body_string_or_rack_triplet
-      end
-
-     [@status, {'Content-Type' => @content_type}, [body_string_or_rack_triplet]]
-    end
-
-    return response
-  end
-
-  def rack_triplet?(maybe_triplet)
-    maybe_triplet.is_a?(Array) &&
-    maybe_triplet.length == 3 &&
-    maybe_triplet[0].is_a?(Integer) &&
-    maybe_triplet[1].is_a?(Hash) &&
-    maybe_triplet[1].keys.all? {|k| k.is_a?(String) } &&
-    maybe_triplet[2].respond_to?(:each)
-  end
-end