sober_swag 0.1.0 → 0.2.0

data/example/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/example/.ruby-version

@@ -1 +1 @@
-2.7.0
+2.7.1

data/example/Gemfile

@@ -1,14 +1,16 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '2.7.0'
+ruby '2.7.1'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '~> 6.0.2', '>= 6.0.2.1'
+gem 'rails', '~> 6.0.2', '>= 6.0.2.2'
+
+gem 'actionpack', '>= 6.0.3.2'
 # Use sqlite3 as the database for Active Record
 gem 'sqlite3', '~> 1.4'
 # Use Puma as the app server
-gem 'puma', '~> 4.1'
+gem 'puma', '~> 4.3'
 # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
 # gem 'jbuilder', '~> 2.7'
 # Use Active Model has_secure_password
@@ -20,14 +22,16 @@ gem 'bootsnap', '>= 1.4.2', require: false
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
 # gem 'rack-cors'
 
-gem 'sober_swag',  path: '..'
+gem 'sober_swag', path: '..'
 
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
-  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+  gem 'byebug', platforms: %i[mri mingw x64_mingw]
 
   gem 'dry-types-rails'
 
+  gem 'rspec-rails'
+
   gem 'pry'
 end
 
@@ -39,4 +43,4 @@ group :development do
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]

data/example/Gemfile.lock

@@ -9,69 +9,70 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.2.1)
-      actionpack (= 6.0.2.1)
+    actioncable (6.0.3.2)
+      actionpack (= 6.0.3.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionmailbox (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       mail (>= 2.7.1)
-    actionmailer (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      actionview (= 6.0.2.1)
-      activejob (= 6.0.2.1)
+    actionmailer (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.2.1)
-      actionview (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actiontext (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       nokogiri (>= 1.8.5)
-    actionview (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
       globalid (>= 0.3.6)
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activerecord (6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activestorage (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activestorage (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
       marcel (~> 0.3.1)
-    activesupport (6.0.2.1)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     bootsnap (1.4.6)
       msgpack (~> 1.0)
     builder (3.2.4)
-    byebug (11.1.1)
-    coderay (1.1.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
-    dry-configurable (0.11.3)
+    diff-lcs (1.4.4)
+    dry-configurable (0.11.6)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
       dry-equalizer (~> 0.2)
@@ -102,76 +103,93 @@ GEM
       dry-types (>= 0.8.1)
       rails (>= 3)
     erubi (1.9.0)
-    ffi (1.12.2)
+    ffi (1.13.1)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.2)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
-    loofah (2.4.0)
+    loofah (2.6.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
-    method_source (0.9.2)
-    mimemagic (0.3.4)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    minitest (5.14.1)
     msgpack (1.3.3)
     nio4r (2.5.2)
-    nokogiri (1.10.9)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    puma (4.3.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    puma (4.3.5)
       nio4r (~> 2.0)
-    rack (2.2.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.2.1)
-      actioncable (= 6.0.2.1)
-      actionmailbox (= 6.0.2.1)
-      actionmailer (= 6.0.2.1)
-      actionpack (= 6.0.2.1)
-      actiontext (= 6.0.2.1)
-      actionview (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    rails (6.0.3.2)
+      actioncable (= 6.0.3.2)
+      actionmailbox (= 6.0.3.2)
+      actionmailer (= 6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actiontext (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       bundler (>= 1.3.0)
-      railties (= 6.0.2.1)
+      railties (= 6.0.3.2)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rake (13.0.1)
-    rb-fsevent (0.10.3)
+    rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (4.0.1)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.9)
+      rspec-expectations (~> 3.9)
+      rspec-mocks (~> 3.9)
+      rspec-support (~> 3.9)
+    rspec-support (3.9.3)
     ruby_dep (1.5.0)
     spring (2.1.0)
     spring-watcher-listen (2.0.1)
       listen (>= 2.7, < 4.0)
       spring (>= 1.2, < 3.0)
-    sprockets (4.0.0)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.1)
@@ -181,24 +199,26 @@ GEM
     sqlite3 (1.4.2)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    websocket-driver (0.7.1)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
-    zeitwerk (2.3.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionpack (>= 6.0.3.2)
   bootsnap (>= 1.4.2)
   byebug
   dry-types-rails
   listen (>= 3.0.5, < 3.2)
   pry
-  puma (~> 4.1)
-  rails (~> 6.0.2, >= 6.0.2.1)
+  puma (~> 4.3)
+  rails (~> 6.0.2, >= 6.0.2.2)
+  rspec-rails
   sober_swag!
   spring
   spring-watcher-listen (~> 2.0.0)
@@ -206,7 +226,7 @@ DEPENDENCIES
   tzinfo-data
 
 RUBY VERSION
-   ruby 2.7.0p0
+   ruby 2.7.1p83
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/example/app/controllers/people_controller.rb

@@ -1,45 +1,61 @@
+##
+# Demonstration controller that involves people.
 class PeopleController < ApplicationController
-
   include SoberSwag::Controller
 
   before_action :load_person, only: %i[show update]
 
+  PersonBodyParams = SoberSwag.input_object do
+    identifier 'PersonBodyParams'
 
-  PersonBodyParams = SoberSwag.struct do
     attribute :first_name, SoberSwag::Types::String
     attribute :last_name, SoberSwag::Types::String
     attribute? :date_of_birth, SoberSwag::Types::Params::DateTime.optional
   end
 
-  PersonParams = SoberSwag.struct do
+  PersonBodyPatchParams = SoberSwag.input_object(PersonBodyParams) do
+    identifier 'PersonBodyPatchParams'
+
+    attribute? :first_name, SoberSwag::Types::String
+    attribute? :last_name, SoberSwag::Types::String
+    attribute? :date_of_birth, SoberSwag::Types::Params::DateTime.optional
+  end
+
+  PersonParams = SoberSwag.input_object do
+    identifier 'PersonParams'
     attribute :person, PersonBodyParams
   end
 
-  PersonSerializer = SoberSwag::Blueprint.define do
-    field :id, primitive(:Integer)
-    field :first_name, primitive(:String)
-    field :last_name, primitive(:String)
+  PersonPatchParams = SoberSwag.input_object do
+    identifier 'PersonPatchParams'
+    attribute :person, PersonBodyPatchParams
   end
 
   define :post, :create, '/people/' do
     request_body(PersonParams)
-    response(:ok, 'the person created', PersonSerializer)
+    response(:ok, 'the person created', PersonOutputObject)
+    response(:unprocessable_entity, 'the validation errors', PersonErrorsOutputObject)
   end
   def create
-    p = Person.create!(parsed_body.to_h)
-    respond!(:ok, p)
+    p = Person.new(parsed_body.person.to_h)
+    if p.save
+      respond!(:ok, p)
+    else
+      respond!(:unprocessable_entity, p.errors)
+    end
   end
 
   define :patch, :update, '/people/{id}' do
-    request_body(PersonParams)
+    request_body(PersonPatchParams)
     path_params { attribute :id, Types::Params::Integer }
-    response(:ok, 'the person updated', PersonSerializer)
+    response(:ok, 'the person updated', PersonOutputObject)
+    response(:unprocessable_entity, 'the validation errors', PersonErrorsOutputObject)
   end
   def update
-    if @person.update(parsed_body.to_h)
+    if @person.update(parsed_body.person.to_h)
       respond!(:ok, @person)
     else
-      render json: @person.errors, status: :unprocessable_entity
+      respond!(:unprocessable_entity, @person.errors)
     end
   end
 
@@ -47,22 +63,22 @@ class PeopleController < ApplicationController
     query_params do
       attribute? :first_name, Types::String
       attribute? :last_name, Types::String
+      attribute? :view, Types::String.enum('base', 'detail')
     end
-    response(:ok, 'all the people', PersonSerializer.new.array)
+    response(:ok, 'all the people', PersonOutputObject.array)
   end
-
   def index
     @people = Person.all
-    @people = @people.where('first_name ILIKE ?', "%#{parsed_query.first_name}%") if parsed_query.first_name
-    @people = @people.where('last_name ILIKE ?', "%#{parsed_query.last_name}%") if parsed_query.last_name
-    respond!(:ok, @people)
-    end
+    @people = @people.where('UPPER(first_name) LIKE UPPER(?)', "%#{parsed_query.first_name}%") if parsed_query.first_name
+    @people = @people.where('UPPER(last_name) LIKE UPPER(?)', "%#{parsed_query.last_name}%") if parsed_query.last_name
+    respond!(:ok, @people.includes(:posts), serializer_opts: { view: parsed_query.view })
+  end
 
   define :get, :show, '/people/{id}' do
     path_params do
       attribute :id, Types::Params::Integer
     end
-    response(:ok, 'the person requested', PersonSerializer.new)
+    response(:ok, 'the person requested', PersonOutputObject)
   end
   def show
     respond!(:ok, @person)

data/example/app/controllers/posts_controller.rb

@@ -0,0 +1,102 @@
+##
+# Example controller for posts.
+class PostsController < ApplicationController
+  before_action :set_post, only: %i[show update destroy]
+
+  include SoberSwag::Controller
+
+  PostCreateParamsBody = SoberSwag.input_object do
+    identifier 'PostCreateParamsBody'
+    attribute :person_id, SoberSwag::Types::Params::Integer.meta(description: 'Unique ID obtained from a person')
+    attribute :title, SoberSwag::Types::String.meta(description: 'Short title of a post')
+    attribute :body, SoberSwag::Types::String.meta(description: 'Post body in markdown format')
+  end
+
+  PostCreate = SoberSwag.input_object do
+    identifier 'PostCreate'
+    attribute :post, PostCreateParamsBody
+  end
+
+  PostUpdateParamsBody = SoberSwag.input_object do
+    identifier 'PostUpdateParamsBody'
+    attribute? :person_id, SoberSwag::Types::Params::Integer
+    attribute? :title, SoberSwag::Types::String
+    attribute? :body, SoberSwag::Types::String
+  end
+
+  PostUpdate = SoberSwag.input_object do
+    identifier 'PostUpdate'
+    attribute :post, PostUpdateParamsBody
+  end
+
+  ViewTypes = SoberSwag::Types::String.enum('base', 'detail')
+
+  ShowPath = SoberSwag.input_object do
+    identifier 'ShowPersonPathParams'
+    attribute :id, Types::Params::Integer
+  end
+
+  define :get, :index, '/posts/' do
+    query_params do
+      attribute? :view, ViewTypes
+    end
+    response(:ok, 'all the posts', PostOutputObject.array)
+  end
+  def index
+    @posts = Post.all
+
+    respond!(:ok, @posts.includes(:person), serializer_opts: { view: parsed_query.view })
+  end
+
+  define :get, :show, '/posts/{id}' do
+    path_params(ShowPath)
+    query_params { attribute? :view, ViewTypes }
+    response(:ok, 'the requested post', PostOutputObject)
+  end
+  def show
+    respond!(:ok, @post, serializer_opts: { view: parsed_query.view })
+  end
+
+  define :post, :create, '/posts/' do
+    request_body(PostCreate)
+    response(:created, 'the created post', PostOutputObject)
+  end
+  def create
+    @post = Post.new(parsed_body.post.to_h)
+
+    if @post.save
+      respond! :created, @post, rails_opts: { location: @post }
+    else
+      render json: @post.errors, status: :unprocessable_entity
+    end
+  end
+
+  define :patch, :update, '/posts/{id}' do
+    path_params(ShowPath)
+    request_body(PostUpdate)
+    response(:ok, 'the post updated', PostOutputObject.view(:base))
+  end
+  def update
+    if @post.update(parsed_body.post.to_h)
+      respond!(:ok, @post)
+    else
+      render json: @post.errors, status: :unprocessable_entity
+    end
+  end
+
+  define :delete, :destroy, '/posts/{id}' do
+    path_params(ShowPath)
+    response(:ok, 'the post deleted', PostOutputObject.view(:base))
+  end
+  def destroy
+    @post.destroy
+    respond!(:ok, @post)
+  end
+
+  private
+
+  # Use callbacks to share common setup or constraints between actions.
+  def set_post
+    @post = Post.find(parsed_path.id)
+  end
+end