jsonapi-swagger 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dab83649ba5e56cfa51c621a9fb47add67a4a2ae889d44b6ba4b3bc1e712fea8
-  data.tar.gz: 94a539114d9f3ae6b0da32f79562e319e75219b354e90266986168507d141fa7
+  metadata.gz: ca788a5cb82d20869ddb1d61bc35f7f70a96a087d5f5063710b5c9e7d903aff7
+  data.tar.gz: e02238b6ed49ce8b7402853bfb234571580e35a2f5a46eef351272cbe403a618
 SHA512:
-  metadata.gz: e7625c8893c464aecde1b5987776a8be6a9f4599ef6e2870f27c18d3fe3e82c25dd3eabe523953f5caa43542bcf8897afaf2df4703edf137a2b8d3f37cb26212
-  data.tar.gz: 48ad3673d7335ed35b9fbe132aa2511570760fa22dc817c97b54a75affcccf744606665695b5b28e3de594952cd445d5798913a555bc956dfd9ba487dd1ee39c
+  metadata.gz: e7a7e2e7ac26bf503e9b9a9119f4739585b5a8a4475f8ee3638e7d94c1177991c4ba0836e6d8f02a825ad9ae7f53cf60691e19cd2feaa525dee3c65e72084b84
+  data.tar.gz: 1d887fc8de0108a6e6b6bcaff773bb16219bdfabc9a51c7a4aade3324b8982468ee796bd6972acdad3d0b9c10f06c005140627314663b37cb1970f910e9ee947

data/lib/generators/jsonapi/swagger/swagger_generator.rb

@@ -61,12 +61,12 @@ module Jsonapi
       file_name.downcase.singularize
     end
 
-    def resouces_name
+    def resources_name
       model_class_name.pluralize
     end
 
-    def route_resouces
-      resouces_name.tableize
+    def route_resources
+      resources_name.tableize
     end
 
     def model_class_name
@@ -82,7 +82,7 @@ module Jsonapi
     end
 
     def model_klass
-      file_name.camelize.safe_constantize
+      model_class_name.safe_constantize
     end
 
     def resource_klass

data/lib/generators/jsonapi/swagger/templates/swagger.json.erb

@@ -16,7 +16,7 @@
         filters.each do |filter_attr, filter_config|
           parameters << { name: :"filter[#{filter_attr}]", in: :query, type: :string, description: tt(:filter_field), required: false}
         end
-        parameters << { name: :"fields[#{route_resouces}]", in: :query, type: :string, description: tt(:display_field), required: false }
+        parameters << { name: :"fields[#{route_resources}]", in: :query, type: :string, description: tt(:display_field), required: false }
         relationships.each_value do |relation|
           parameters << { name: :"fields[#{relation_table_name(relation)}]", in: :query, type: :string, description: tt(:display_field), required: false }
         end
@@ -29,7 +29,7 @@
         if relationships.present?
           parameters << { name: :include, in: :query, type: :string, description: tt(:include_related_data), required: false }
         end
-        parameters << { name: :"fields[#{route_resouces}]", in: :query, type: :string, description: tt(:display_field), required: false }
+        parameters << { name: :"fields[#{route_resources}]", in: :query, type: :string, description: tt(:display_field), required: false }
         relationships.each_value do |relation|
           parameters << { name: :"fields[#{relation_table_name(relation)}]", in: :query, type: :string, description: tt(:display_field), required: false }
         end
@@ -45,7 +45,7 @@
           data: {
             type: :object,
             properties: {
-              type: { type: :string, default: route_resouces },
+              type: { type: :string, default: route_resources },
               attributes: {
                 type: :object,
                 properties: properties(attrs: creatable_fields)
@@ -257,20 +257,20 @@
       }
     end
 
-    doc['paths']["/#{route_resouces}"] = {
+    doc['paths']["/#{route_resources}"] = {
       get: {
-        summary: "#{route_resouces} #{tt(:list)}",
-        tags: [route_resouces],
+        summary: "#{route_resources} #{tt(:list)}",
+        tags: [route_resources],
         produces: ['application/vnd.api+json'],
         parameters: list_resource_parameters,
         responses: list_resource_responses
       }
     }
 
-    doc['paths']["/#{route_resouces}/{id}"] = {
+    doc['paths']["/#{route_resources}/{id}"] = {
       get: {
-        summary: "#{route_resouces} #{tt(:detail)}",
-        tags: [route_resouces],
+        summary: "#{route_resources} #{tt(:detail)}",
+        tags: [route_resources],
         produces: ['application/vnd.api+json'],
         parameters: show_resource_parameters,
         responses: show_resource_responses
@@ -278,10 +278,10 @@
     }
 
 if mutable?
-  doc['paths']["/#{route_resouces}"].merge!({
+  doc['paths']["/#{route_resources}"].merge!({
     post: {
-      summary: "#{route_resouces} #{tt(:create)}",
-      tags: [route_resouces],
+      summary: "#{route_resources} #{tt(:create)}",
+      tags: [route_resources],
       consumes: ['application/vnd.api+json'],
       produces: ['application/vnd.api+json'],
       parameters: [create_resource_parameters],
@@ -289,10 +289,10 @@ if mutable?
     }
   })
 
-  doc['paths']["/#{route_resouces}/{id}"].merge!({
+  doc['paths']["/#{route_resources}/{id}"].merge!({
     patch: {
-      summary: "#{route_resouces} #{tt(:patch)}",
-      tags: [route_resouces],
+      summary: "#{route_resources} #{tt(:patch)}",
+      tags: [route_resources],
       consumes: ['application/vnd.api+json'],
       produces: ['application/vnd.api+json'],
       parameters: patch_resource_parameters,
@@ -300,19 +300,19 @@ if mutable?
     }
   })
 
-  doc['paths']["/#{route_resouces}/{id}"].merge!({
+  doc['paths']["/#{route_resources}/{id}"].merge!({
     delete: {
-      summary: "#{route_resouces} #{tt(:delete)}",
-      tags: [route_resouces],
+      summary: "#{route_resources} #{tt(:delete)}",
+      tags: [route_resources],
       produces: ['application/vnd.api+json'],
       parameters: delete_resource_parameters,
       responses: delete_resource_responses
     }
   })
 else
-  doc['paths']["/#{route_resouces}"].delete(:post)
-  doc['paths']["/#{route_resouces}/{id}"].delete(:patch)
-  doc['paths']["/#{route_resouces}/{id}"].delete(:delete)
+  doc['paths']["/#{route_resources}"].delete(:post)
+  doc['paths']["/#{route_resources}/{id}"].delete(:patch)
+  doc['paths']["/#{route_resources}/{id}"].delete(:delete)
 end
 -%>
   "paths": <%= JSON.pretty_generate(doc['paths'] ) %>

data/lib/generators/jsonapi/swagger/templates/swagger.rb.erb

@@ -1,5 +1,5 @@
 require 'swagger_helper'
-RSpec.describe '<%= resouces_name %>', type: :request do
+RSpec.describe '<%= resources_name %>', type: :request do
   let(:include) {''} #see https://github.com/domaindrivendev/rswag/issues/188
 
   before(:each) do
@@ -10,9 +10,9 @@ RSpec.describe '<%= resouces_name %>', type: :request do
   <% end -%>
   end
 
-  path '/<%= route_resouces %>' do
-    get '<%= route_resouces %> <%= t(:list) %>' do
-      tags '<%= route_resouces %>'
+  path '/<%= route_resources %>' do
+    get '<%= route_resources %> <%= t(:list) %>' do
+      tags '<%= route_resources %>'
       produces 'application/vnd.api+json'
       parameter name: :'page[number]', in: :query, type: :string, description: '<%= t(:page_num) %>', required: false
 <% if sortable_fields.present? -%>
@@ -24,7 +24,7 @@ RSpec.describe '<%= resouces_name %>', type: :request do
 <% filters.each do |filter_attr, filter_config| -%>
       parameter name: :'filter[<%= filter_attr %>]', in: :query, type: :string, description: '<%= t(:filter_field) %>', <% if filter_config[:default] -%>default: '<%= safe_encode(filter_config[:default]) %>',<% end %>required: false
 <% end -%>
-      parameter name: :'fields[<%= route_resouces %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
+      parameter name: :'fields[<%= route_resources %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% relationships.each_value do |relation| -%>
       parameter name: :'fields[<%= relation_table_name(relation) %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% end -%>
@@ -103,15 +103,15 @@ RSpec.describe '<%= resouces_name %>', type: :request do
     end
   end
 
-  path '/<%= route_resouces %>/{id}' do
-    get '<%= route_resouces %> <%= t(:detail) %>' do
-      tags '<%= route_resouces %>'
+  path '/<%= route_resources %>/{id}' do
+    get '<%= route_resources %> <%= t(:detail) %>' do
+      tags '<%= route_resources %>'
       produces 'application/vnd.api+json'
       parameter name: :id, in: :path, type: :integer, description: 'ID', required: true
 <% if relationships.present? -%>
       parameter name: :include, in: :query, type: :string, description: '<%= t(:include_related_data) %>', required: false
 <% end -%>
-      parameter name: :'fields[<%= route_resouces %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
+      parameter name: :'fields[<%= route_resources %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% relationships.each_value do |relation| -%>
       parameter name: :'fields[<%= relation_table_name(relation) %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% end -%>
@@ -174,9 +174,9 @@ RSpec.describe '<%= resouces_name %>', type: :request do
   end
 
 <% if mutable? -%>
-  path '/<%= route_resouces %>' do
-    post '<%= route_resouces %> <%= t(:create) %>' do
-      tags '<%= route_resouces %>'
+  path '/<%= route_resources %>' do
+    post '<%= route_resources %> <%= t(:create) %>' do
+      tags '<%= route_resources %>'
       consumes 'application/vnd.api+json'
       produces 'application/vnd.api+json'
       parameter name: :data,
@@ -186,7 +186,7 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                   data: {
                     type: :object,
                     properties: {
-                      type: { type: :string, default: '<%= route_resouces %>' },
+                      type: { type: :string, default: '<%= route_resources %>' },
                       attributes: {
                         type: :object,
                         properties: {
@@ -295,9 +295,9 @@ RSpec.describe '<%= resouces_name %>', type: :request do
     end
   end
 
-path '/<%= route_resouces %>/{id}' do
-    patch '<%= route_resouces %> <%= t(:patch) %>' do
-      tags '<%= route_resouces %>'
+path '/<%= route_resources %>/{id}' do
+    patch '<%= route_resources %> <%= t(:patch) %>' do
+      tags '<%= route_resources %>'
       consumes 'application/vnd.api+json'
       produces 'application/vnd.api+json'
       parameter name: :id, in: :path, type: :integer, description: 'ID', required: true
@@ -308,7 +308,7 @@ path '/<%= route_resouces %>/{id}' do
                   data: {
                     type: :object,
                     properties: {
-                      type: { type: :string, default: '<%= route_resouces %>' },
+                      type: { type: :string, default: '<%= route_resources %>' },
                       id: { type: :string },
                       attributes: {
                         type: :object,
@@ -419,9 +419,9 @@ path '/<%= route_resouces %>/{id}' do
     end
   end
 
-  path '/<%= route_resouces %>/{id}' do
-    delete '<%= route_resouces %> <%= t(:delete) %>' do
-      tags '<%= route_resouces %>'
+  path '/<%= route_resources %>/{id}' do
+    delete '<%= route_resources %> <%= t(:delete) %>' do
+      tags '<%= route_resources %>'
       produces 'application/vnd.api+json'
       parameter name: :id, in: :path, type: :integer, description: 'ID', required: true
 

data/lib/jsonapi/swagger/resource.rb

@@ -3,31 +3,34 @@ module Jsonapi
   module Swagger
     class Resource
       def self.with(model_class_name)
-        if Object.const_defined?("#{model_class_name}Resource")
-          @resource_class = "#{model_class_name}Resource".safe_constantize
-          unless @resource_class < JSONAPI::Resource
-            raise Jsonapi::Swagger::Error, "#{@resource_class.class} is not Subclass of JSONAPI::Resource!"
+        if (resource_class = "#{model_class_name}Resource".safe_constantize)
+          unless resource_class < JSONAPI::Resource
+            raise Jsonapi::Swagger::Error, "#{resource_class} is not Subclass of JSONAPI::Resource!"
           end
           require 'jsonapi/swagger/resources/jsonapi_resource'
-          return Jsonapi::Swagger::JsonapiResource.new(@resource_class)
-        elsif Object.const_defined?("Serializable#{model_class_name}")
-          @resource_class = "Serializable#{model_class_name}".safe_constantize
-          unless @resource_class < JSONAPI::Serializable::Resource
-            raise Jsonapi::Swagger::Error, "#{@resource_class.class} is not Subclass of JSONAPI::Serializable::Resource!"
+          return Jsonapi::Swagger::JsonapiResource.new(resource_class)
+        elsif (resource_class = serializable_class_name(model_class_name).safe_constantize)
+          unless resource_class < JSONAPI::Serializable::Resource
+            raise Jsonapi::Swagger::Error, "#{resource_class} is not Subclass of JSONAPI::Serializable::Resource!"
           end
           require 'jsonapi/swagger/resources/serializable_resource'
-          return Jsonapi::Swagger::SerializableResource.new(@resource_class)
-        elsif Object.const_defined?("#{model_class_name}Serializer")
-          @resource_class = "#{model_class_name}Serializer".safe_constantize
-          unless @resource_class < FastJsonapi::ObjectSerializer
-            raise Jsonapi::Swagger::Error, "#{@resource_class.class} is not Subclass of FastJsonapi::ObjectSerializer!"
+          return Jsonapi::Swagger::SerializableResource.new(resource_class)
+        elsif (resource_class = "#{model_class_name}Serializer".safe_constantize)
+          unless resource_class < FastJsonapi::ObjectSerializer
+            raise Jsonapi::Swagger::Error, "#{resource_class} is not Subclass of FastJsonapi::ObjectSerializer!"
           end
           require 'jsonapi/swagger/resources/fast_jsonapi_resource'
-          return Jsonapi::Swagger::FastJsonapiResource.new(@resource_class)
+          return Jsonapi::Swagger::FastJsonapiResource.new(resource_class)
         else
           raise Jsonapi::Swagger::Error, "#{model_class_name} not support!"
         end
       end
+
+      def self.serializable_class_name(model_class_name)
+        parts = model_class_name.split('::')
+        parts[-1] = "Serializable#{parts[-1]}"
+        parts.join('::')
+      end
     end
   end
-end
+end

data/lib/jsonapi/swagger/version.rb

@@ -2,6 +2,6 @@
 
 module Jsonapi
   module Swagger
-    VERSION = '0.8.1'
+    VERSION = '0.9.0'
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-swagger
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - YingRui Lu
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +65,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
 email:
 - yingruilu518@gmail.com
 executables: []
@@ -92,7 +90,6 @@ homepage: https://github.com/superiorlu/jsonapi-swagger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -107,8 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: JSON API Swagger Doc Generator
 test_files: []