apiculture 0.1.7 → 0.2.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apiculture
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,24 +9,24 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2023-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mustermann
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: builder
+  name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -40,21 +40,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: rdiscount
+  name: mustache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: github-markup
+  name: mustermann
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -68,61 +68,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: mustache
+  name: rdiscount
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: cgi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -138,33 +138,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 description: A toolkit for building REST APIs on top of Rack
 email: me@julik.nl
 executables: []
@@ -175,6 +175,7 @@ extra_rdoc_files:
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -195,12 +196,6 @@ files:
 - lib/apiculture/sinatra_instance_methods.rb
 - lib/apiculture/timestamp_promise.rb
 - lib/apiculture/version.rb
-- spec/apiculture/action_spec.rb
-- spec/apiculture/app_documentation_spec.rb
-- spec/apiculture/method_documentation_spec.rb
-- spec/apiculture/openapi_documentation_spec.rb
-- spec/apiculture_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/WeTransfer/apiculture
 licenses:
 - MIT
@@ -221,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Sweet API sauce on top of Rack

data/spec/apiculture/action_spec.rb

@@ -1,45 +0,0 @@
-require_relative '../spec_helper'
-
-describe Apiculture::Action do
-  context '.new' do
-    it 'exposes the methods of the object given as a first argument to initialize' do
-      action_class = Class.new(described_class)
-      fake_app = double('Apiculture::App', something: 'value')
-      action = action_class.new(fake_app)
-      expect(action).to respond_to(:something)
-      expect(action.something).to eq('value')
-    end
-
-    it 'converts keyword arguments to instance variables' do
-      action_class = Class.new(described_class)
-      action = action_class.new(nil, foo: 'a string')
-      expect(action.instance_variable_get('@foo')).to eq('a string')
-    end
-  end
-
-  it 'responds to perform()' do
-    expect(described_class.new(nil)).to respond_to(:perform)
-  end
-
-  it 'can use bail() to throw a Sinatra halt' do
-    fake_app = double('Apiculture::App')
-    expect(fake_app).to receive(:json_halt).with('Failure', status: 400) 
-    action_class = Class.new(described_class)
-    action_class.new(fake_app).bail "Failure"
-  end
-
-  it 'can use bail() to throw a Sinatra halt with a custom status' do
-    fake_app = double('Apiculture::App')
-    expect(fake_app).to receive(:json_halt).with("Failure", status: 417)
-
-    action_class = Class.new(described_class)
-    action_class.new(fake_app).bail "Failure", status: 417
-  end
-
-  it 'can use bail() to throw a Sinatra halt with extra JSON attributes' do
-    fake_app = double('Apiculture::App')
-    expect(fake_app).to receive(:json_halt).with("Failure", status: 417, message: "Totale")
-    action_class = Class.new(described_class)
-    action_class.new(fake_app).bail "Failure", status: 417, message: 'Totale'
-  end
-end

data/spec/apiculture/app_documentation_spec.rb

@@ -1,126 +0,0 @@
-require_relative '../spec_helper'
-
-describe "Apiculture.api_documentation" do
-  let(:app) do
-    Class.new(Apiculture::App) do
-      extend Apiculture
-
-      markdown_string 'This API is very important. Because it has to do with pancakes.'
-
-      documentation_build_time!
-
-      desc 'Order a pancake'
-      required_param :diameter, "Diameter of the pancake. The pancake will be **bold**", Integer
-      param :topping, 'Type of topping', String
-      pancake_response_info = <<~EOS
-        When the pancake has been baked successfully
-        The pancake will have the following properties:
-
-        * It is going to be round
-        * It is going to be delicious
-      EOS
-      responds_with 200, pancake_response_info, { id: 'abdef..c21' }
-      api_method :post, '/pancakes' do
-      end
-
-      desc 'Check the pancake status'
-      route_param :id, 'Pancake ID to check status on'
-      responds_with 200, 'When the pancake is found', { status: 'Baking' }
-      responds_with 404, 'When no such pancake exists', { status: 'No such pancake' }
-      api_method :get, '/pancake/:id' do
-      end
-
-      desc 'Throw away the pancake'
-      route_param :id, 'Pancake ID to delete'
-      api_method :delete, '/pancake/:id' do
-      end
-
-      desc 'Pancake ingredients are in the URL'
-      route_param :topping_id, 'Pancake topping ID', Integer, cast: :to_i
-      api_method :get, '/pancake/with/:topping_id' do |topping_id|
-      end
-    end
-  end
-
-  it 'generates app documentation as HTML without the body element' do
-    docco = app.api_documentation
-    generated_html = docco.to_html_fragment
-
-    expect(generated_html).not_to include('<body')
-    expect(generated_html).to include('Pancake ID to check status on')
-    expect(generated_html).to include('Pancake ID to delete')
-  end
-
-  it 'generates app documentation in HTML' do
-    docco = app.api_documentation
-    generated_html = docco.to_html
-
-    if ENV['SHOW_TEST_DOC']
-      File.open('t.html', 'w') do |f|
-        f.write(generated_html)
-        f.flush
-        `open #{f.path}`
-      end
-    end
-
-    expect(generated_html).to include('<body')
-    expect(generated_html).to include('Pancake ID to check status on')
-    expect(generated_html).to include('When the pancake has been baked successfully')
-    expect(generated_html).to include('"id": "abdef..c21"')
-    expect(generated_html).to end_with("\n")
-  end
-
-  it 'generates app documentation in Markdown' do
-    docco = app.api_documentation
-    generated_markdown = docco.to_markdown
-
-    expect(generated_markdown).not_to include('<body')
-    expect(generated_markdown).to include('## POST /pancakes')
-  end
-
-  it 'generates app documentation honoring the mount point' do
-    overridden = Class.new(Apiculture::App) do
-      extend Apiculture
-      mounted_at '/api/v2/'
-      api_method :get, '/pancakes' do
-      end
-    end
-
-    generated_markdown = overridden.api_documentation.to_markdown
-    expect(generated_markdown).to include('## GET /api/v2/pancakes')
-  end
-
-  it 'generates app documentation injecting the inline Markdown strings' do
-    app_class = Class.new(Apiculture::App) do
-      extend Apiculture
-      markdown_string '# This describes important stuff'
-      api_method :get, '/pancakes' do
-      end
-      markdown_string '# This describes even more important stuff'
-      markdown_string 'This is a paragraph'
-    end
-
-    generated_html = app_class.api_documentation.to_html
-    expect(generated_html).to include('<h2>GET /pancakes</h2>')
-    expect(generated_html).to include('<h1>This describes even more important stuff')
-    expect(generated_html).to include('<h1>This describes important stuff')
-    expect(generated_html).to include('<p>This is a paragraph')
-  end
-
-  context 'with a file containing Markdown that has to be spliced into the docs' do
-    before(:each) { File.open('./TEST.md', 'w') { |f| f << "# This is an important header" } }
-    after(:each) { File.unlink('./TEST.md') }
-    it 'splices the contents of the file using markdown_file' do
-      app_class = Class.new(Apiculture::App) do
-        extend Apiculture
-        markdown_file './TEST.md'
-        api_method :get, '/pancakes' do
-        end
-      end
-
-      generated_html = app_class.api_documentation.to_html
-      expect(generated_html).to include('<h2>GET /pancakes</h2>')
-      expect(generated_html).to include('<h1>This is an important header')
-    end
-  end
-end

data/spec/apiculture/method_documentation_spec.rb

@@ -1,102 +0,0 @@
-require_relative '../spec_helper'
-require_relative '../../lib/apiculture/method_documentation'
-
-describe Apiculture::MethodDocumentation do
-  it 'generates HTML from an ActionDefinition with path, verb and both route and request params' do
-    definition = Apiculture::ActionDefinition.new
-    
-    definition.description = "This action bakes pancakes"
-    definition.parameters << Apiculture::Parameter.new(:name, 'Pancake name', true, String, :to_s)
-    definition.parameters << Apiculture::Parameter.new(:thickness, 'Pancake **thick**ness', false, Float, :to_f)
-    definition.parameters << Apiculture::Parameter.new(:diameter, 'Pancake diameter', false, Integer, :to_i)
-    
-    definition.route_parameters << Apiculture::RouteParameter.new(:pan_id, 'ID of the pancake frying pan')
-    definition.http_verb = 'get'
-    definition.path = '/pancake/:pan_id/bake'
-    definition.responses << Apiculture::PossibleResponse.new(200, "Pancake has been baked", {diameter: 10, unit: "cm"})
-    definition.responses << Apiculture::PossibleResponse.new(417, "Frying pan too cold", "ERR_NO_HEAT")
-    
-    documenter = described_class.new(definition)
-    
-    generated_html = documenter.to_html_fragment
-    generated_markdown = documenter.to_markdown
-    
-    expect(generated_html).not_to include('<body>')
-    
-    expect(generated_html).to include('<h2>GET /pancake/:pan_id/bake</h2>')
-    expect(generated_html).to include('<p>This action bakes pancakes</p>')
-    expect(generated_html).to include('<h3>URL parameters</h3>')
-    expect(generated_html).to include('ID of the pancake frying pan')
-    expect(generated_html).to include('<h3>Request parameters</h3>')
-    expect(generated_html).to include('<p>Pancake name</p>')
-    expect(generated_html).to include('<p>Pancake has been baked</p>')
-    expect(generated_html).to include('<p>Frying pan too cold</p>')
-  end
-  
-  it 'generates HTML from an ActionDefinition without route params' do
-    definition = Apiculture::ActionDefinition.new
-    
-    definition.description = "This action bakes pancakes"
-    definition.parameters << Apiculture::Parameter.new(:name, 'Pancake name', true, String, :to_s)
-    definition.parameters << Apiculture::Parameter.new(:thickness, 'Pancake **thick**ness', false, Float, :to_f)
-    definition.parameters << Apiculture::Parameter.new(:diameter, 'Pancake diameter', false, Integer, :to_i)
-    
-    definition.http_verb = 'get'
-    definition.path = '/pancake'
-    
-    documenter = described_class.new(definition)
-    generated_html = documenter.to_html_fragment
-    
-    expect(generated_html).not_to include('<h3>URL parameters</h3>')
-  end
-  
-  it 'generates HTML from an ActionDefinition without request params' do
-    definition = Apiculture::ActionDefinition.new
-    
-    definition.description = "This action bakes pancakes"
-    
-    definition.route_parameters << Apiculture::RouteParameter.new(:pan_id, 'ID of the pancake frying pan')
-    definition.http_verb = 'get'
-    definition.path = '/pancake/:pan_id/bake'
-    
-    documenter = described_class.new(definition)
-    
-    generated_html = documenter.to_html_fragment
-    generated_markdown = documenter.to_markdown
-    
-    expect(generated_html).not_to include('<h3>Request parameters</h3>')
-  end
-  
-  it 'generates HTML from an ActionDefinition with a casted route param' do
-    definition = Apiculture::ActionDefinition.new
-    
-    definition.description = "This adds a topping to a pancake"
-    
-    definition.route_parameters << Apiculture::RouteParameter.new(:topping_id, 'ID of the pancake topping', Integer, cast: :to_i)
-    definition.http_verb = 'get'
-    definition.path = '/pancake/:topping_id'
-    
-    documenter = described_class.new(definition)
-    
-    generated_html = documenter.to_html_fragment
-    generated_markdown = documenter.to_markdown
-    expect(generated_html).to include('<h3>URL parameters</h3>')
-    expect(generated_html).to include('Type after cast')
-  end
-
-
-  it 'generates Markdown from an ActionDefinition with a mountpoint' do
-    definition = Apiculture::ActionDefinition.new
-    
-    definition.description = "This action bakes pancakes"
-    
-    definition.route_parameters << Apiculture::RouteParameter.new(:pan_id, 'ID of the pancake frying pan')
-    definition.http_verb = 'get'
-    definition.path = '/pancake/:pan_id/bake'
-    
-    documenter = described_class.new(definition, '/api/v1')
-    
-    generated_markdown = documenter.to_markdown
-    expect(generated_markdown).to include('## GET /api/v1/pancake/:pan_id')
-  end
-end

data/spec/apiculture/openapi_documentation_spec.rb

@@ -1,197 +0,0 @@
-require_relative '../spec_helper'
-
-describe 'Apiculture.api_documentation' do
-  let!(:test_class) do
-    class PancakeApi < Apiculture::App
-      extend Apiculture
-
-      documentation_build_time!
-
-      desc 'Order a pancake'
-      required_param :diameter, 'Diameter of the pancake. The pancake will be **bold**', Integer
-      param :topping, 'Type of topping', String
-      pancake_response_info = <<~EOS
-        When the pancake has been baked successfully
-        The pancake will have the following properties:
-
-        * It is going to be round
-        * It is going to be delicious
-      EOS
-      responds_with 200, pancake_response_info, { id: 'abdef..c21' }
-      api_method :post, '/pancakes' do
-      end
-
-      desc 'Check the pancake status'
-      route_param :id, 'Pancake ID to check status on'
-      responds_with 200, 'When the pancake is found', { status: 'Baking' }
-      responds_with 404, 'When no such pancake exists', { status: 'No such pancake' }
-      api_method :get, '/pancake/:id' do
-      end
-
-      desc 'Throw away the pancake'
-      route_param :id, 'Pancake ID to delete'
-      api_method :delete, '/pancake/:id' do
-      end
-
-      desc 'Pancake ingredients are in the URL'
-      route_param :topping_id, 'Pancake topping ID', Integer, cast: :to_i
-      api_method :get, '/pancake/with/:topping_id' do |topping_id|
-      end
-    end
-  end
-
-  let(:documentation) { PancakeApi.api_documentation }
-  let(:open_api_map) { documentation.to_openapi.spec }
-
-  describe '.to_openapi' do
-    it 'will have openapi version' do
-      expect(open_api_map).to include(openapi: '3.0.0')
-    end
-
-    describe 'info' do
-      let(:info) { open_api_map.fetch(:info) }
-
-      it 'will not to be empty' do
-        expect(info).not_to be_empty
-      end
-
-      it 'will have title' do
-        expect(info).to include(title: 'PancakeApi')
-      end
-
-      it 'will have version' do
-        expect(info).to include(version: '0.0.1')
-      end
-
-      it 'will have description' do
-        expect(info).to include(:description)
-        expect(info[:description]).to include('PancakeApi Documentation built on')
-      end
-    end
-
-    describe 'paths' do
-      let(:paths) { open_api_map.fetch(:paths) }
-
-      it 'will have paths' do
-        expect(paths).not_to be_empty
-      end
-
-      it 'will have 4 paths' do
-        expect(paths.size).to eq(3)
-      end
-
-      context 'POST /pancakes' do
-        let(:post_pancakes) { paths.dig('/pancakes', :post) }
-
-        it 'will have route' do
-          expect(post_pancakes).not_to be_empty
-        end
-
-        describe 'request body content' do
-          let(:request_content) { post_pancakes.dig(:requestBody, :content) }
-          it 'will have correct JSON content type' do
-            expect(request_content).to have_key(:'application/json')
-          end
-
-          describe 'schema' do
-            let(:schema) { request_content.dig(:'application/json', :schema) }
-            it 'will have type' do
-              expect(schema).to include(type: :object)
-            end
-
-            it 'will have required parameters' do
-              expect(schema).to include(required: [:diameter])
-            end
-
-            describe 'properties' do
-              let(:properties) { schema.fetch(:properties) }
-              it 'will have all properties' do
-                expect(properties).to have_key :diameter
-                expect(properties).to have_key :topping
-              end
-            end
-          end
-        end
-      end
-
-      context 'GET /pancake/:id' do
-        let(:get_pancake_by_id_path) { paths.dig('/pancake/{id}', :get) }
-        it 'will have route' do
-          expect(get_pancake_by_id_path).not_to be_empty
-        end
-
-        it 'will have summary' do
-          expect(get_pancake_by_id_path).to include(summary: 'Check the pancake status')
-        end
-
-        it 'will have a description' do
-          expect(get_pancake_by_id_path).to include(description: 'Check the pancake status')
-        end
-
-        it 'will have operationId' do
-          expect(get_pancake_by_id_path).to have_key :operationId
-        end
-
-        describe 'parameters' do
-          let(:parameter) { get_pancake_by_id_path.fetch(:parameters).first }
-
-          it 'will contain parameter' do
-            expect(parameter).not_to be_empty
-          end
-
-          it 'will have required propertie' do
-            expect(parameter).to include(required: true)
-          end
-
-          it 'will indicate a path parameter' do
-            expect(parameter).to include(in: :path)
-          end
-
-          describe 'schema' do
-            let(:schema) { parameter.fetch(:schema) }
-            it 'will have object type' do
-              expect(schema).to include(type: 'string')
-            end
-
-            it 'will have an example' do
-              expect(schema).to include(example: 'string')
-            end
-          end
-        end
-
-        describe 'responses' do
-          let(:responses) { get_pancake_by_id_path.fetch(:responses) }
-
-          it 'will contain all responses by response code' do
-            expect(responses).to have_key('200')
-            expect(responses).to have_key('404')
-          end
-
-          describe 'response 200' do
-            let(:response_200) { responses.fetch('200') }
-
-            it 'will have description' do
-              expect(response_200).to include(description: 'When the pancake is found')
-            end
-
-            it 'will have correct content type' do
-              expect(response_200.fetch(:content)).to have_key(:'application/json')
-            end
-
-            describe 'schema' do
-              let(:schema) { response_200.dig(:content, :'application/json', :schema) }
-              
-              it 'will have object type' do
-                expect(schema).to include(type: 'object')
-              end
-
-              it 'will have properties' do
-                expect(schema).to have_key :properties
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end