weak_swagger_parameters 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85e46ed943f82522b4affcca0fbe25da225527c8
-  data.tar.gz: e8f515e3aa857121ec296d75c7783cdb0758334c
+  metadata.gz: cecd75ac8a8c7da9b795eeaaf4830bcb99670970
+  data.tar.gz: 115a0037332d2fe62126774588676c6fa98ce27d
 SHA512:
-  metadata.gz: db40e7a3e5b89864cc151dc2f516d0769a1134bed82a3d6308506de488b720f1eae1052286a058546695f78dcaaa64c3d0ba10409b32e5b46b5de1a79043524c
-  data.tar.gz: 5e261df19f41b3c7a99e0c381d21b695df5997ae306390b25fa3913918399effd8fc0c9d9b88a9746fb41fbe2786df500fbc15e081ce8f1b672874d35f5d21e4
+  metadata.gz: 3b23c81c52f4ffe42c1d9a670af103a90fe22338a20cd09477317fe8e90c2fddddd705daaef2fb86f129e2e8227bf197d040acfd7c8117f38ffd244f2bfd19a1
+  data.tar.gz: 4391e29cdbd8066d920838a26a6439e9d0904b60a1eabfbbe6c1065450f70264bc13eaad71aed114757b980e4808acefca9bc8544ac053045b890d6e5ddf1cd9

data/lib/weak_swagger_parameters/controller.rb

@@ -50,9 +50,7 @@ module WeakSwaggerParameters
 
       def render_docs(docs_section)
         ensure_loaded
-        controllers = controllers_in_docs_section(docs_section)
-
-        render json: Swagger::Blocks.build_root_json(controllers)
+        render json: Swagger::Blocks.build_root_json(doc_components_for(docs_section))
       end
 
       def handle_param_validation_error(e)
@@ -61,26 +59,20 @@ module WeakSwaggerParameters
 
       private
 
-      def controllers_in_docs_section(docs_section)
-        controllers = []
+      def doc_components_for(docs_section)
+        doc_components = []
         ObjectSpace.each_object(Class) do |klass|
-          if controller?(klass) && in_docs_section?(klass, docs_section)
-            controllers << klass
-          end
+          doc_components << klass if in_docs_section?(klass, docs_section)
         end
-        controllers
+        doc_components
       end
 
       def ensure_loaded
         Rails.application.eager_load! if !Rails.configuration.eager_load || !Rails.configuration.cache_classes
       end
 
-      def controller?(klass)
-        klass.ancestors.include?(AbstractController::Base)
-      end
-
       def in_docs_section?(klass, docs_section)
-        klass.respond_to?(:in_doc_section?) && klass.in_doc_section?(docs_section)
+        klass.methods.include?(:in_doc_section?) && klass.respond_to?(:in_doc_section?) && klass.in_doc_section?(docs_section)
       end
     end
   end

data/lib/weak_swagger_parameters/definitions/api.rb

@@ -24,8 +24,8 @@ module WeakSwaggerParameters
         @param_definition = WeakSwaggerParameters::Definitions::Params.new(&block)
       end
 
-      def response(status_code, description = '')
-        @response_definitions << WeakSwaggerParameters::Definitions::Response.new(status_code, description)
+      def response(status_code, description = '', &block)
+        @response_definitions << WeakSwaggerParameters::Definitions::Response.new(status_code, description, &block)
       end
 
       def apply_validations(controller_class)
@@ -42,7 +42,7 @@ module WeakSwaggerParameters
       def apply_docs(controller_class)
         this = self
         http_method = @http_method
-        operation_params = operation_params(http_method, controller_class)
+        operation_params = operation_params(@action, controller_class)
 
         controller_class.instance_eval do
           swagger_path this.path do
@@ -54,7 +54,15 @@ module WeakSwaggerParameters
       end
 
       def child_definitions
-        (validation_definitions + @response_definitions).compact
+        result = validation_definitions
+
+        if @response_definitions.empty?
+          result << WeakSwaggerParameters::Definitions::Response.new(200, 'Success')
+        else
+          result += @response_definitions
+        end
+
+        result
       end
 
       private
@@ -63,11 +71,11 @@ module WeakSwaggerParameters
         [@param_definition].compact
       end
 
-      def operation_params(method, controller_class)
+      def operation_params(action, controller_class)
         name = resource_name(controller_class)
         {
           summary: @summary,
-          operationId: operation_id(method, controller_class),
+          operationId: operation_id(action, controller_class),
           tags: [name]
         }.tap do |h|
           h[:description] = @description unless @description.blank?
@@ -78,8 +86,8 @@ module WeakSwaggerParameters
         controller_class.controller_name.humanize
       end
 
-      def operation_id(method, controller_class)
-        "#{method}_#{controller_class.controller_name}".camelize(:lower)
+      def operation_id(action, controller_class)
+        "#{action}_#{controller_class.controller_name}".camelize(:lower)
       end
     end
   end

data/lib/weak_swagger_parameters/definitions/body.rb

@@ -9,28 +9,28 @@ module WeakSwaggerParameters
 
       def string(name, description, options = {})
         @required_fields << name if options.try(:[], :required)
-        @child_definitions << WeakSwaggerParameters::Definitions::BodyParam.new(:string, name, description, options)
+        @child_definitions << WeakSwaggerParameters::Definitions::Property.new(:string, name, description, options)
       end
 
       def boolean(name, description, options = {})
         @required_fields << name if options.try(:[], :required)
-        @child_definitions << WeakSwaggerParameters::Definitions::BodyParam.new(:boolean, name, description, options)
+        @child_definitions << WeakSwaggerParameters::Definitions::Property.new(:boolean, name, description, options)
       end
 
       def integer(name, description, options = {})
         @required_fields << name if options.try(:[], :required)
-        @child_definitions << WeakSwaggerParameters::Definitions::BodyParam.new(:integer, name, description, options)
+        @child_definitions << WeakSwaggerParameters::Definitions::Property.new(:integer, name, description, options)
       end
 
       def apply_docs(parent_node)
         param_definitions = @child_definitions
-        required_fields = @required_fields
+        schema_options = {}
+        schema_options[:required] = @required_fields unless @required_fields.empty?
 
         parent_node.instance_eval do
           parameter name: :body, in: :body, required: true do
-            schema required: required_fields do
-              schema_node = self
-              param_definitions.each { |definition| definition.apply_docs(schema_node) }
+            schema schema_options do
+              param_definitions.each { |definition| definition.apply_docs(self) }
             end
           end
         end

data/lib/weak_swagger_parameters/definitions/collection_property.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Definitions
+    class CollectionProperty
+      def initialize(name, description, model_class)
+        @name = name
+        @description = description
+        @model_class = model_class
+      end
+
+      def apply_docs(parent_node)
+        name = @name
+        description = @description
+        model_class = @model_class
+
+        parent_node.instance_eval do
+          property name, description: description, type: :array do
+            items do
+              key :'$ref', model_class.docs_model_name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/definitions/collection_ref.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Definitions
+    class CollectionRef
+      def initialize(model_class)
+        @model_class = model_class
+      end
+
+      def apply_docs(parent_node)
+        model_class = @model_class
+
+        parent_node.instance_eval do
+          schema type: :array do
+            items do
+              key :'$ref', model_class.docs_model_name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/definitions/hash_property.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Definitions
+    class HashProperty
+      include WeakSwaggerParameters::Definitions::PropertyContainer
+
+      def initialize(name, description, &block)
+        @name = name
+        @description = description
+
+        instance_eval(&block) if block.present?
+      end
+
+      def apply_docs(parent_node)
+        name = @name
+        description = @description
+        definitions = child_definitions
+
+        parent_node.instance_eval do
+          property name, description: description, type: :object do
+            hash_node = self
+            definitions.each { |definition| definition.apply_docs(hash_node) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/definitions/hash_ref.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Definitions
+    class HashRef
+      include WeakSwaggerParameters::Definitions::PropertyContainer
+
+      def initialize(&block)
+        instance_eval(&block) if block.present?
+      end
+
+      def apply_docs(parent_node)
+        definitions = child_definitions
+
+        parent_node.instance_eval do
+          schema do
+            definitions.each { |definition| definition.apply_docs(self) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/definitions/model.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Definitions
+    class Model
+      include WeakSwaggerParameters::Definitions::PropertyContainer
+
+      def initialize(model_name, &block)
+        @model_name = model_name
+
+        instance_eval(&block) if block.present?
+      end
+
+      def apply_docs(parent_node)
+        model_name = @model_name
+        definitions = child_definitions
+        schema_options = {}
+        schema_options[:required] = required_fields unless required_fields.empty?
+
+        parent_node.instance_eval do
+          swagger_schema model_name, schema_options do
+            schema_node = self
+            definitions.each { |definition| definition.apply_docs(schema_node) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/definitions/model_property.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Definitions
+    class ModelProperty
+      def initialize(name, description, model_class)
+        @name = name
+        @description = description
+        @model_class = model_class
+      end
+
+      def apply_docs(parent_node)
+        name = @name
+        description = @description
+        model_class = @model_class
+
+        parent_node.instance_eval do
+          property name, description: description, type: :object do
+            key :'$ref', model_class.docs_model_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/definitions/model_ref.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Definitions
+    class ModelRef
+      def initialize(model_class)
+        @model_class = model_class
+      end
+
+      def apply_docs(parent_node)
+        model_class = @model_class
+
+        parent_node.instance_eval do
+          schema do
+            key :'$ref', model_class.docs_model_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/definitions/path_params/integer.rb

@@ -21,7 +21,7 @@ module WeakSwaggerParameters
           description = @description
 
           parent_node.instance_eval do
-            parameter name: name, type: :integer, format: :int32, in: :path, description: description
+            parameter name: name, in: :path, required: true, description: description, type: :integer, format: :int32
           end
         end
       end

data/lib/weak_swagger_parameters/definitions/path_params/string.rb

@@ -21,7 +21,7 @@ module WeakSwaggerParameters
           description = @description
 
           parent_node.instance_eval do
-            parameter name: name, type: :string, in: :path, description: description
+            parameter name: name, in: :path, required: true, description: description, type: :string
           end
         end
       end

data/lib/weak_swagger_parameters/definitions/{body_param.rb → property.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module WeakSwaggerParameters
   module Definitions
-    class BodyParam
+    class Property
       def initialize(type, name, description, options = {})
         @type = type
         @name = name

data/lib/weak_swagger_parameters/definitions/property_container.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Definitions
+    module PropertyContainer
+      extend ActiveSupport::Concern
+
+      # rubocop:disable Metrics/BlockLength
+      included do
+        def string(name, description, options = {})
+          register_definition name, options, WeakSwaggerParameters::Definitions::Property.new(:string, name, description, options)
+        end
+
+        def boolean(name, description, options = {})
+          register_definition name, options, WeakSwaggerParameters::Definitions::Property.new(:boolean, name, description, options)
+        end
+
+        def integer(name, description, options = {})
+          register_definition name, options, WeakSwaggerParameters::Definitions::Property.new(:integer, name, description, options)
+        end
+
+        def hash(name, description, options = {}, &block)
+          register_definition name, options, WeakSwaggerParameters::Definitions::HashProperty.new(name, description, &block)
+        end
+
+        def model(name, description, model_class, options = {})
+          register_definition name, options, WeakSwaggerParameters::Definitions::ModelProperty.new(name, description, model_class)
+        end
+
+        def collection(name, description, model_class, options = {})
+          register_definition name, options, WeakSwaggerParameters::Definitions::CollectionProperty.new(name, description, model_class)
+        end
+
+        private
+
+        def register_definition(name, options, definition)
+          required_fields << name if options.try(:[], :required)
+          child_definitions << definition
+        end
+
+        def required_fields
+          @required_fields ||= []
+        end
+
+        def child_definitions
+          @child_definitions ||= []
+        end
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/definitions/response.rb

@@ -2,17 +2,37 @@
 module WeakSwaggerParameters
   module Definitions
     class Response
-      def initialize(status_code, description)
+      def initialize(status_code, description, &block)
         @status_code = status_code
         @description = description
+        @content_schema = nil
+
+        instance_eval(&block) if block.present?
+      end
+
+      def hash(&block)
+        @content_schema = WeakSwaggerParameters::Definitions::HashRef.new(&block)
+      end
+
+      def model(model_class)
+        @content_schema = WeakSwaggerParameters::Definitions::ModelRef.new(model_class)
+      end
+
+      def collection(model_class)
+        @content_schema = WeakSwaggerParameters::Definitions::CollectionRef.new(model_class)
       end
 
       def apply_docs(parent_node)
         status_code = @status_code
         response_options = { description: @description }
+        content_schema = @content_schema
 
         parent_node.instance_eval do
-          response status_code, response_options
+          response status_code, response_options do
+            response_node = self
+
+            content_schema.apply_docs(response_node) if content_schema.present?
+          end
         end
       end
     end

data/lib/weak_swagger_parameters/definitions.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
-require 'weak_swagger_parameters/definitions/body_param'
 require 'weak_swagger_parameters/definitions/path_params/integer'
 require 'weak_swagger_parameters/definitions/path_params/string'
 require 'weak_swagger_parameters/definitions/query_params/string'
 require 'weak_swagger_parameters/definitions/param_container'
+require 'weak_swagger_parameters/definitions/property_container'
+require 'weak_swagger_parameters/definitions/hash_property'
+require 'weak_swagger_parameters/definitions/collection_property'
+require 'weak_swagger_parameters/definitions/model_property'
+require 'weak_swagger_parameters/definitions/property'
+require 'weak_swagger_parameters/definitions/collection_ref'
+require 'weak_swagger_parameters/definitions/hash_ref'
+require 'weak_swagger_parameters/definitions/model_ref'
+require 'weak_swagger_parameters/definitions/model'
 require 'weak_swagger_parameters/definitions/body'
 require 'weak_swagger_parameters/definitions/path'
 require 'weak_swagger_parameters/definitions/query'

data/lib/weak_swagger_parameters/model.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def add_to_doc_section(doc_section)
+        @doc_sections ||= []
+        @doc_sections << doc_section
+      end
+
+      def in_doc_section?(doc_section)
+        (@doc_sections || []).include?(doc_section)
+      end
+
+      def model(&block)
+        api_docs = WeakSwaggerParameters::Definitions::Model.new(docs_model_name, &block)
+        api_docs.apply_docs(self)
+      end
+
+      def docs_model_name
+        name.split('::').join('_')
+      end
+    end
+
+    included do
+      include Swagger::Blocks
+    end
+  end
+end

data/lib/weak_swagger_parameters/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module WeakSwaggerParameters
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/weak_swagger_parameters.rb

@@ -7,7 +7,7 @@ require 'swagger/blocks'
 require 'weak_swagger_parameters/version'
 require 'weak_swagger_parameters/definitions'
 require 'weak_swagger_parameters/controller'
+require 'weak_swagger_parameters/model'
 
 module WeakSwaggerParameters
-  # Your code goes here...
 end

data/weak_swagger_parameters.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-rails', '~> 3.4'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
   spec.add_development_dependency 'rubocop', '~> 0.42'
+  spec.add_development_dependency 'json-schema', '~> 2.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weak_swagger_parameters
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - AgileFreaks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.42'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: Basic integration between swagger-blocks and weak_parameters
 email:
 - office@agilefreaks.com
@@ -172,15 +186,24 @@ files:
 - lib/weak_swagger_parameters/definitions.rb
 - lib/weak_swagger_parameters/definitions/api.rb
 - lib/weak_swagger_parameters/definitions/body.rb
-- lib/weak_swagger_parameters/definitions/body_param.rb
+- lib/weak_swagger_parameters/definitions/collection_property.rb
+- lib/weak_swagger_parameters/definitions/collection_ref.rb
+- lib/weak_swagger_parameters/definitions/hash_property.rb
+- lib/weak_swagger_parameters/definitions/hash_ref.rb
+- lib/weak_swagger_parameters/definitions/model.rb
+- lib/weak_swagger_parameters/definitions/model_property.rb
+- lib/weak_swagger_parameters/definitions/model_ref.rb
 - lib/weak_swagger_parameters/definitions/param_container.rb
 - lib/weak_swagger_parameters/definitions/params.rb
 - lib/weak_swagger_parameters/definitions/path.rb
 - lib/weak_swagger_parameters/definitions/path_params/integer.rb
 - lib/weak_swagger_parameters/definitions/path_params/string.rb
+- lib/weak_swagger_parameters/definitions/property.rb
+- lib/weak_swagger_parameters/definitions/property_container.rb
 - lib/weak_swagger_parameters/definitions/query.rb
 - lib/weak_swagger_parameters/definitions/query_params/string.rb
 - lib/weak_swagger_parameters/definitions/response.rb
+- lib/weak_swagger_parameters/model.rb
 - lib/weak_swagger_parameters/version.rb
 - weak_swagger_parameters.gemspec
 homepage: https://github.com/Agilefreaks/weak_swagger_parameters
@@ -203,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Generate docs and Validate request parameters