Merge pull request #5 from simplepractice/oas3

[P4M-646] Use OAS version 3 for Frontend API

Author: krasnoukhov

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    # Check for updates to GitHub Actions every weekday
+    interval: "daily"
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "11:00"
+  open-pull-requests-limit: 10

.github/workflows/ci.yml

@@ -0,0 +1,65 @@
+---
+
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: "Testing"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Recent Rubies and Rails
+          - ruby-version: '3.2'
+          - ruby-version: '3.1'
+          - ruby-version: '3.0'
+          - ruby-version: '2.7'
+          - ruby-version: '2.6'
+          - ruby-version: '2.6'
+          - ruby-version: '2.7'
+          - ruby-version: '2.6'
+          # Old Rubies and Rails
+          - ruby-version: '2.5'
+            bundler: '1'
+          - ruby-version: '2.4'
+            bundler: '1'
+          - ruby-version: '2.4'
+            bundler: '1'
+          # Failing with a stack trace in active support
+          # - ruby-version: '2.4'
+          #   rails-version: '4.1'
+          #   bundler: '1'
+
+    continue-on-error: "${{ endsWith(matrix.ruby-version, 'head') }}"
+
+    env:
+      CI: "1"
+
+    steps:
+      - name:                     "Checkout Code"
+        uses:                     "actions/checkout@v4"
+        timeout-minutes:          5
+        with:
+          fetch-depth:            0
+
+      # - name: Install required libs
+      #   run: |
+      #     sudo apt-get -yqq install libsqlite3-dev
+
+      - name: "Build Ruby"
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version:   "${{ matrix.ruby-version }}"
+          bundler:        "${{ matrix.bundler || 2 }}"
+          bundler-cache:  true
+        # env:
+        #   RAILS_VERSION: ${{ matrix.rails-version }}
+
+      - name: "Run tests"
+        run: |
+          bundle exec rake
+        # env:
+        #   RAILS_VERSION: ${{ matrix.rails-version }}

.gitignore

@@ -9,3 +9,4 @@ example/public/docs
 *.swp
 /html/
 /.idea
+Gemfile.lock

.travis.yml

@@ -1,5 +1,3 @@
 source 'http://rubygems.org'
 
 gemspec
-
-gem 'inch'

Gemfile

@@ -1,5 +1,3 @@
-[![Build Status](https://travis-ci.org/zipmark/rspec_api_documentation.svg?branch=master)](https://travis-ci.org/zipmark/rspec_api_documentation)
-[![Dependency Status](https://gemnasium.com/badges/github.com/zipmark/rspec_api_documentation.svg)](https://gemnasium.com/github.com/zipmark/rspec_api_documentation)
 [![Code Climate](https://codeclimate.com/github/zipmark/rspec_api_documentation/badges/gpa.svg)](https://codeclimate.com/github/zipmark/rspec_api_documentation)
 [![Inline docs](https://inch-ci.org/github/zipmark/rspec_api_documentation.svg?branch=master)](https://inch-ci.org/github/zipmark/rspec_api_documentation)
 [![Gem Version](https://badge.fury.io/rb/rspec_api_documentation.svg)](https://badge.fury.io/rb/rspec_api_documentation)
@@ -185,6 +183,7 @@ RspecApiDocumentation.configure do |config|
   config.configurations_dir = Rails.root.join("doc", "configurations", "api")
 
   # Output folder
+  # **WARNING*** All contents of the configured directory will be cleared, use a dedicated directory.
   config.docs_dir = Rails.root.join("doc", "api")
 
   # An array of output format(s).
@@ -238,6 +237,7 @@ RspecApiDocumentation.configure do |config|
   config.define_group :public do |config|
     # By default the group's doc_dir is a subfolder under the parent group, based
     # on the group's name.
+    # **WARNING*** All contents of the configured directory will be cleared, use a dedicated directory.
     config.docs_dir = Rails.root.join("doc", "api", "public")
 
     # Change the filter to only include :public examples

Gemfile.lock

@@ -2,6 +2,7 @@ Feature: Use OAuth2 MAC client as a test client
   Background:
     Given a file named "app_spec.rb" with:
       """
+      require "webmock/rspec"
       require "rspec_api_documentation"
       require "rspec_api_documentation/dsl"
       require "rack/builder"

README.md

@@ -1,6 +1,3 @@
-[![Travis status](https://secure.travis-ci.org/zipmark/rspec_api_documentation.png)](https://secure.travis-ci.org/zipmark/rspec_api_documentation)
-[![Gemnasium status](https://gemnasium.com/zipmark/rspec_api_documentation.png)](https://gemnasium.com/zipmark/rspec_api_documentation)
-
 http://github.com/zipmark/rspec_api_documentation
 
 # RSpec API Doc Generator

features/oauth2_mac_client.feature

@@ -1,7 +1,9 @@
 require 'active_support'
 require 'active_support/inflector'
+require 'active_support/core_ext/array/extract_options'
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/hash/keys'
 require 'cgi'
 require 'json'
 
@@ -52,25 +54,27 @@ module Writers
   module OpenApi
     extend ActiveSupport::Autoload
 
+    autoload :Components
+    autoload :Contact
+    autoload :ExternalDocs
+    autoload :Flow
+    autoload :Header
     autoload :Helper
-    autoload :Node
-    autoload :Root
     autoload :Info
-    autoload :Contact
     autoload :License
-    autoload :Paths
-    autoload :Path
-    autoload :Tag
+    autoload :Media
+    autoload :Node
     autoload :Operation
     autoload :Parameter
-    autoload :Responses
+    autoload :Path
+    autoload :RequestBody
     autoload :Response
-    autoload :Example
-    autoload :Headers
-    autoload :Header
+    autoload :Root
     autoload :Schema
-    autoload :SecurityDefinitions
-    autoload :SecuritySchema
+    autoload :SecurityScheme
+    autoload :Server
+    autoload :Tag
+    autoload :Variable
   end
 
   module Views

features/readme.md

@@ -30,7 +30,7 @@ def self.define_action(method)
 
       def callback(*args, &block)
         begin
-          require 'webmock'
+          require 'webmock/rspec'
         rescue LoadError
           raise "Callbacks require webmock to be installed"
         end

lib/rspec_api_documentation.rb

@@ -4,7 +4,7 @@
   # ActiveSupport::SecureRandom not provided in activesupport >= 3.2
 end
 begin
-  require "webmock"
+  require "webmock/rspec"
 rescue LoadError
   raise "Webmock needs to be installed before using the OAuth2MACClient"
 end

lib/rspec_api_documentation/dsl/resource.rb

@@ -0,0 +1,13 @@
+module RspecApiDocumentation
+  module OpenApi
+    class Components < Node
+      add_setting :schemas, :schema => { '' => Schema }
+      add_setting :responses, :schema => { '' => Response }
+      add_setting :parameters, :schema => { '' => Parameter }
+      add_setting :headers, :schema => { '' => Header }
+      add_setting :securitySchemes, :schema => { '' => SecurityScheme }
+      add_setting :links
+      add_setting :callbacks
+    end
+  end
+end