sober_swag 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad86b8f4701d16ec53f0fc998bb2a881cdc448acfbb509bbfeb7821cc7142d1b
-  data.tar.gz: ce70ffa29ca02b8fc70e7f78c0b41bf56e8e3cdffbcf7282d8dad1cf16717b23
+  metadata.gz: 7a0e2ee1acc571a7f6a90db87f4c15b6d7d820f24b75abd3f37cb369d431f271
+  data.tar.gz: 6384f275b7b1bd21ef35f4972b519be59a19d1a5e24a5c2138e203748a9702bb
 SHA512:
-  metadata.gz: '081ef6717877b1c40682fbcbf1436a7e44fd51307a03650edc9a6d4a594a99bc4e9f07adbb73a9073f784aa75dc6a5463f0aa1d77b77fefc976c0531273ced22'
-  data.tar.gz: c1fb5da8a19b9d6ee1324badbbff4caac4db49349efd301b9daaa74097372f2241e174617af5b59970b467610145419b6e392b579fc4a3457073439e5ec6824e
+  metadata.gz: c1d8b82b62dc05656482b0e550bc5edb24cdf76dde9dc9bcd4729381c5439983df7e98704eb9a0d54964f70297c8097b8192a016736db5ffff3126849d5425e9
+  data.tar.gz: f55485cc2dd04c4dd414b7c2b5668be91d1c8ada7ad51cf20d04bad62925054d27f940caf83c6c83e1763928c3ea5295d9c592b7a83f85e133cdfbaca697652c

data/.github/workflows/lint.yml

@@ -24,10 +24,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - uses: actions/cache@v2

data/.github/workflows/ruby.yml

@@ -20,14 +20,10 @@ jobs:
     strategy:
       matrix:
         ruby: [ '2.6', '2.7' ]
-
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version:  ${{ matrix.ruby }}
     - uses: actions/cache@v2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v0.17.0]: 2020-11-30
+
+- Allow tagging endpoints via the new `tags` method.
+
 ## [v0.16.0]: 2020-10-23
 
 - Allow non-class types to be used as the inputs to controllers

data/README.md

@@ -268,6 +268,20 @@ QueryInput = SoberSwag.input_object do
 end
 ```
 
+## Tags
+
+If you want to organize your API into sections, you can use `tags`.
+It's quite simple:
+
+```ruby
+define :patch, :update, '/people/{id}' do
+  # other cool config
+  tags 'people', 'mutations', 'incurs_cost'
+end
+```
+
+This will map to OpenAPI's `tags` field (naturally), and the UI codegen will automatically organize your endpoints by their tags.
+
 ## Testing the validity of output objects
 
 If you're using RSpec and want to test the validity of output objects, you can do so relatively easily.

data/example/app/controllers/people_controller.rb

@@ -35,6 +35,7 @@ class PeopleController < ApplicationController
     request_body(PersonParams)
     response(:ok, 'the person created', PersonOutputObject)
     response(:unprocessable_entity, 'the validation errors', PersonErrorsOutputObject)
+    tags 'people', 'create'
   end
   def create
     p = Person.new(parsed_body.person.to_h)
@@ -50,6 +51,7 @@ class PeopleController < ApplicationController
     path_params { attribute :id, Types::Params::Integer }
     response(:ok, 'the person updated', PersonOutputObject)
     response(:unprocessable_entity, 'the validation errors', PersonErrorsOutputObject)
+    tags 'people', 'update'
   end
   def update
     if @person.update(parsed_body.person.to_h)
@@ -68,6 +70,7 @@ class PeopleController < ApplicationController
       attribute :view, Types::String.default('base'.freeze).enum('base', 'detail')
     end
     response(:ok, 'all the people', PersonOutputObject.array)
+    tags 'people', 'list'
   end
   def index
     @people = Person.all
@@ -81,6 +84,7 @@ class PeopleController < ApplicationController
       attribute :id, Types::Params::Integer
     end
     response(:ok, 'the person requested', PersonOutputObject)
+    tags 'people', 'show'
   end
   def show
     respond!(:ok, @person)

data/example/app/controllers/posts_controller.rb

@@ -47,6 +47,7 @@ class PostsController < ApplicationController
       MARKDOWN
     end
     response(:ok, 'all the posts', PostOutputObject.array)
+    tags 'posts', 'list'
   end
   def index
     @posts = Post.all
@@ -60,6 +61,7 @@ class PostsController < ApplicationController
     path_params(ShowPath)
     query_params { attribute? :view, ViewTypes }
     response(:ok, 'the requested post', PostOutputObject)
+    tags 'posts', 'show'
   end
   def show
     respond!(:ok, @post, serializer_opts: { view: parsed_query.view })
@@ -68,6 +70,7 @@ class PostsController < ApplicationController
   define :post, :create, '/posts/' do
     request_body(PostCreate)
     response(:created, 'the created post', PostOutputObject)
+    tags 'posts', 'create'
   end
   def create
     @post = Post.new(parsed_body.post.to_h)
@@ -83,6 +86,7 @@ class PostsController < ApplicationController
     path_params(ShowPath)
     request_body(PostUpdate)
     response(:ok, 'the post updated', PostOutputObject.view(:base))
+    tags 'posts', 'update'
   end
   def update
     if @post.update(parsed_body.post.to_h)
@@ -95,6 +99,7 @@ class PostsController < ApplicationController
   define :delete, :destroy, '/posts/{id}' do
     path_params(ShowPath)
     response(:ok, 'the post deleted', PostOutputObject.view(:base))
+    tags 'posts', 'delete'
   end
   def destroy
     @post.destroy

data/lib/sober_swag/compiler/path.rb

@@ -21,6 +21,7 @@ module SoberSwag
         base[:parameters] = params if params.any?
         base[:responses] = responses
         base[:requestBody] = request_body if request_body
+        base[:tags] = tags if tags
         base
       end
 
@@ -72,6 +73,12 @@ module SoberSwag
           }
         }
       end
+
+      def tags
+        return nil unless route.tags.any?
+
+        route.tags
+      end
     end
   end
 end

data/lib/sober_swag/controller/route.rb

@@ -9,6 +9,7 @@ module SoberSwag
         @action_name = action_name
         @response_serializers = {}
         @response_descriptions = {}
+        @tags = []
       end
 
       attr_reader :response_serializers, :response_descriptions, :controller, :method, :path, :action_name
@@ -23,6 +24,14 @@ module SoberSwag
       # What to parse the path params into.
       attr_reader :path_params_class
 
+      ##
+      # Standard swagger tags.
+      def tags(*args)
+        return @tags if args.empty?
+
+        @tags = args.flatten
+      end
+
       ##
       # Define the request body, using SoberSwag's type-definition scheme.
       # The block passed will be used to define the body of a new sublcass of `base` (defaulted to {SoberSwag::InputObject}.)

data/lib/sober_swag/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SoberSwag
-  VERSION = '0.16.0'
+  VERSION = '0.17.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sober_swag
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Anthony Super
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport