dry_crud_jsonapi_swagger 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ca6f8559b627d78879620ecdc23cf364c2c66a9bdc250413583822a207c2bdb
-  data.tar.gz: acd211a583d25f1b71793298e05fde5cf4eee4fb3f09eba1c673256abed65a30
+  metadata.gz: 807ceabf80b721ba30a118e1329834c7d3bbd59b01a3cda459ff9f1988c147bb
+  data.tar.gz: e004fe507b0d66740bd4123e59e53cede709043dc0837397ba655ae40cbc288f
 SHA512:
-  metadata.gz: 42337d4de64d59e9c28e6cc456e5f5dd7c7b919618de928a0a9fbc8a1fa9564b114044e55e958deae231d8258c71de26979cff06c357871a90a5f372c918bb44
-  data.tar.gz: 64089c5fdf47d6797861726b496811b4f7a05978ce29f33f76eb7c0af6095583da13acbfcb8a6e68fc4499f6160f92a6385a5f37cbbcd0dd3ab9b81d206e1697
+  metadata.gz: 91ad6961a51fbcf661c1bc719dd9f9d7d3b69a3c3f92320cf9b31b54532261eefab8f276f674fb724be976d670995ebc6611447b20f6e97cd3fb50e18cf65fc7
+  data.tar.gz: 0d59851eb55a49cbe99a39f15839e5d06ac48e5b0f8cf14c5eae9bee2ef61303b981e42027bf65aef72ad3c7fd7d5acda557b5bed1f51cefc782bada597846f2

data/app/controllers/dry_crud_jsonapi_swagger/apidocs_controller.rb

@@ -0,0 +1,32 @@
+module DryCrudJsonapiSwagger
+  class ApidocsController < ApplicationController
+    skip_before_action :authenticate, only: [:show]
+    skip_authorization_check
+
+    layout false
+
+    def show
+      respond_to do |format|
+        format.html
+        format.json { render json: generate_doc }
+      end
+    end
+
+    private
+
+    def generate_doc
+      DryCrudJsonapiSwagger::Setup.new(request.url, controller_classes).run
+    end
+
+    def controller_classes
+      Rails.application.eager_load! if Rails.env.development?
+      json_api_controllers
+    end
+
+    def json_api_controllers
+      ListController.descendants.select { |model| model.include?(DryCrudJsonapi) }.select do |controller|
+        controller.model_class rescue false
+      end
+    end
+  end
+end

data/app/domain/{swagger → dry_crud_jsonapi_swagger}/controller_setup.rb

@@ -1,7 +1,7 @@
-module Swagger
+module DryCrudJsonapiSwagger
   class ControllerSetup
     include Rails.application.routes.url_helpers
-    include Swagger::Helper
+    include Helper
     attr_reader :controller_class
 
     def initialize(controller_class)
@@ -32,6 +32,5 @@ module Swagger
     def index_path
       polymorphic_path(model_name.route_key) rescue nil
     end
-
   end
-end
+end

data/app/domain/{swagger → dry_crud_jsonapi_swagger}/helper.rb

@@ -1,4 +1,4 @@
-module Swagger
+module DryCrudJsonapiSwagger
   module Helper
 
     def setup_swagger_path(path, helper = self, &block)
@@ -76,7 +76,7 @@ module Swagger
     def setup_tags(swagger_doc)
       swagger_doc.key :tags, [
         'All',
-        Swagger::TagsSetup.path_tag(@path)
+        TagsSetup.path_tag(@path)
       ]
     end
 
@@ -125,6 +125,5 @@ module Swagger
         end
       end
     end
-
   end
-end
+end

data/app/domain/{swagger → dry_crud_jsonapi_swagger}/nested_controller_setup.rb

@@ -1,7 +1,7 @@
-module Swagger
+module DryCrudJsonapiSwagger
   class NestedControllerSetup
     include Rails.application.routes.url_helpers
-    include Swagger::Helper
+    include Helper
 
     attr_reader :controller_class, :controller_classes, :nested_class
 
@@ -48,6 +48,5 @@ module Swagger
 
       nested.flatten.include? controller_class.model_class
     end
-
   end
-end
+end

data/app/domain/{swagger → dry_crud_jsonapi_swagger}/setup.rb

@@ -1,4 +1,4 @@
-module Swagger
+module DryCrudJsonapiSwagger
   class Setup
     attr_reader :request_uri, :controller_classes
 
@@ -21,7 +21,7 @@ module Swagger
     end
 
     def setup_tags(swagger_doc)
-      Swagger::TagsSetup.new(swagger_doc).run
+      TagsSetup.new(swagger_doc).run
     end
 
     private
@@ -93,10 +93,8 @@ module Swagger
 
     def setup_controller(controller_class)
       controller_class.send :include, Swagger::Blocks
-      Swagger::ControllerSetup.new(controller_class).run
-      Swagger::NestedControllerSetup.new(controller_classes, controller_class).run
+      ControllerSetup.new(controller_class).run
+      NestedControllerSetup.new(controller_classes, controller_class).run
     end
-
   end
-
-end
+end

data/app/domain/{swagger → dry_crud_jsonapi_swagger}/tags_setup.rb

@@ -1,4 +1,4 @@
-module Swagger
+module DryCrudJsonapiSwagger
   class TagsSetup
 
     def initialize(swagger_doc = nil)
@@ -41,6 +41,5 @@ module Swagger
       require 'yaml'
       YAML.load_file(Rails.root.join('config', 'swagger-tags.yml')) # TODO: what is this for? fill yml with sensible values
     end
-
   end
-end
+end

data/config/initializers/rswag-ui.rb

@@ -6,5 +6,5 @@ Rswag::Ui.configure do |c|
   # NOTE: If you're using rspec-api to expose Swagger files (under swagger_root) as JSON endpoints,
   # then the list below should correspond to the relative paths for those endpoints
 
-  c.swagger_endpoint '/apidocs.json', 'API Docs'
+  c.swagger_endpoint 'swagger.json', 'API Docs'
 end

data/config/routes.rb

@@ -1,4 +1,6 @@
-Rails.application.routes.draw do
-  mount Rswag::Ui::Engine => '/apidocs'
-  get 'apidocs', to: 'apidocs#show', constraints: { format: 'json' }
+DryCrudJsonapiSwagger::Engine.routes.draw do
+  mount Rswag::Ui::Engine => '/'
+  get '/swagger.json', module: 'dry_crud_jsonapi_swagger', controller: 'apidocs', action: 'show', constraints: { format: 'json' }
 end
+
+

data/lib/dry_crud_jsonapi_swagger/engine.rb

@@ -3,5 +3,6 @@ require "swagger/blocks"
 
 module DryCrudJsonapiSwagger
   class Engine < ::Rails::Engine
+    isolate_namespace DryCrudJsonapiSwagger
   end
 end

data/lib/dry_crud_jsonapi_swagger/version.rb

@@ -1,3 +1,3 @@
 module DryCrudJsonapiSwagger
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry_crud_jsonapi_swagger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Illi
@@ -89,12 +89,12 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- app/controllers/apidocs_controller.rb
-- app/domain/swagger/controller_setup.rb
-- app/domain/swagger/helper.rb
-- app/domain/swagger/nested_controller_setup.rb
-- app/domain/swagger/setup.rb
-- app/domain/swagger/tags_setup.rb
+- app/controllers/dry_crud_jsonapi_swagger/apidocs_controller.rb
+- app/domain/dry_crud_jsonapi_swagger/controller_setup.rb
+- app/domain/dry_crud_jsonapi_swagger/helper.rb
+- app/domain/dry_crud_jsonapi_swagger/nested_controller_setup.rb
+- app/domain/dry_crud_jsonapi_swagger/setup.rb
+- app/domain/dry_crud_jsonapi_swagger/tags_setup.rb
 - config/initializers/rswag-ui.rb
 - config/routes.rb
 - lib/dry_crud_jsonapi_swagger.rb

data/app/controllers/apidocs_controller.rb

@@ -1,31 +0,0 @@
-class ApidocsController < ApplicationController
-  skip_before_action :authenticate, only: [:show]
-  skip_authorization_check
-
-  layout false
-
-  def show
-    respond_to do |format|
-      format.html
-      format.json { render json: generate_doc }
-    end
-  end
-
-  private
-
-  def generate_doc
-    Swagger::Setup.new(request.url, controller_classes).run
-  end
-
-  def controller_classes
-    Rails.application.eager_load! if Rails.env.development?
-    json_api_controllers
-  end
-
-  def json_api_controllers
-    ListController.descendants.select { |model| model.include?(DryCrudJsonapi) }.select do |controller|
-      controller.model_class rescue false
-    end
-  end
-
-end