weak_swagger_parameters 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cecd75ac8a8c7da9b795eeaaf4830bcb99670970
-  data.tar.gz: 115a0037332d2fe62126774588676c6fa98ce27d
+  metadata.gz: df79ed08bcdb90cad48b9466283861b1cfd61199
+  data.tar.gz: cdbb4a90317df9dcf9695fee1f2a5ec9de516900
 SHA512:
-  metadata.gz: 3b23c81c52f4ffe42c1d9a670af103a90fe22338a20cd09477317fe8e90c2fddddd705daaef2fb86f129e2e8227bf197d040acfd7c8117f38ffd244f2bfd19a1
-  data.tar.gz: 4391e29cdbd8066d920838a26a6439e9d0904b60a1eabfbbe6c1065450f70264bc13eaad71aed114757b980e4808acefca9bc8544ac053045b890d6e5ddf1cd9
+  metadata.gz: 8899fb0b89164feceb4fe573dae3447774ba98bbab12ea4dc9b434dfa6866d0e9db8f55995ba1e37f4131a63ee90391721a8ec1915e3d3e07e3f8fe343d6a533
+  data.tar.gz: 0507ae0fdadc9294c8c90eef106e3c2b8065d2103b1f149fb2fdfcf72244044d2cffd735261eec289a489c93d8557ce05f59e671e3b08d2e0b07aefd29f495bc

data/lib/weak_swagger_parameters.rb

@@ -6,6 +6,7 @@ require 'swagger/blocks'
 
 require 'weak_swagger_parameters/version'
 require 'weak_swagger_parameters/definitions'
+require 'weak_swagger_parameters/services'
 require 'weak_swagger_parameters/controller'
 require 'weak_swagger_parameters/model'
 

data/lib/weak_swagger_parameters/definitions.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
-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/leaf_definition'
 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/parameter'
 require 'weak_swagger_parameters/definitions/property'
 require 'weak_swagger_parameters/definitions/collection_ref'
 require 'weak_swagger_parameters/definitions/hash_ref'

data/lib/weak_swagger_parameters/definitions/body.rb

@@ -1,31 +1,21 @@
 # frozen_string_literal: true
 module WeakSwaggerParameters
   module Definitions
-    class Body < ParamContainer
-      def initialize(&block)
-        @required_fields = []
-        super
-      end
+    class Body
+      include WeakSwaggerParameters::Definitions::PropertyContainer
 
-      def string(name, description, options = {})
-        @required_fields << name if options.try(:[], :required)
-        @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::Property.new(:boolean, name, description, options)
+      def initialize(&block)
+        instance_eval(&block) if block.present?
       end
 
-      def integer(name, description, options = {})
-        @required_fields << name if options.try(:[], :required)
-        @child_definitions << WeakSwaggerParameters::Definitions::Property.new(:integer, name, description, options)
+      def apply_validations(parent_node)
+        child_definitions.each { |definition| definition.apply_validations(parent_node) }
       end
 
       def apply_docs(parent_node)
-        param_definitions = @child_definitions
+        param_definitions = child_definitions
         schema_options = {}
-        schema_options[:required] = @required_fields unless @required_fields.empty?
+        schema_options[:required] = required_fields unless required_fields.empty?
 
         parent_node.instance_eval do
           parameter name: :body, in: :body, required: true do

data/lib/weak_swagger_parameters/definitions/hash_property.rb

@@ -11,6 +11,17 @@ module WeakSwaggerParameters
         instance_eval(&block) if block.present?
       end
 
+      def apply_validations(parent_node)
+        name = @name
+        param_definitions = child_definitions
+
+        parent_node.instance_eval do
+          hash name, strong: true do
+            param_definitions.each { |definition| definition.apply_validations(parent_node) }
+          end
+        end
+      end
+
       def apply_docs(parent_node)
         name = @name
         description = @description

data/lib/weak_swagger_parameters/definitions/leaf_definition.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Definitions
+    module LeafDefinition
+      def apply_validations(parent_node)
+        type = @options[:type]
+        name = @options[:name]
+
+        validation_options = WeakSwaggerParameters::Services::WeakParametersOptionsAdapter.adapt(@options)
+        parent_node.instance_eval { send type, name, validation_options }
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/definitions/model.rb

@@ -10,6 +10,10 @@ module WeakSwaggerParameters
         instance_eval(&block) if block.present?
       end
 
+      def apply_validations(parent_node)
+        child_definitions.each { |definition| definition.apply_validations(parent_node) }
+      end
+
       def apply_docs(parent_node)
         model_name = @model_name
         definitions = child_definitions

data/lib/weak_swagger_parameters/definitions/model_property.rb

@@ -8,6 +8,17 @@ module WeakSwaggerParameters
         @model_class = model_class
       end
 
+      def apply_validations(parent_node)
+        name = @name
+        node = @model_class.wsp_node
+
+        parent_node.instance_eval do
+          hash name, strong: true do
+            node.apply_validations(parent_node)
+          end
+        end
+      end
+
       def apply_docs(parent_node)
         name = @name
         description = @description

data/lib/weak_swagger_parameters/definitions/parameter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Definitions
+    class Parameter
+      include WeakSwaggerParameters::Definitions::LeafDefinition
+
+      def initialize(location, type, name, description, options = {})
+        @options = options.merge(location: location, type: type, name: name, description: description)
+      end
+
+      def apply_docs(parent_node)
+        parameter_options = WeakSwaggerParameters::Services::SwaggerOptionsAdapter.adapt(@options)
+
+        parent_node.instance_eval { parameter parameter_options }
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/definitions/path.rb

@@ -2,12 +2,18 @@
 module WeakSwaggerParameters
   module Definitions
     class Path < ParamContainer
-      def string(name, description)
-        @child_definitions << WeakSwaggerParameters::Definitions::PathParams::String.new(name, description)
+      def string(name, description, options = {})
+        register_definition(:string, name, description, options)
       end
 
-      def integer(name, description)
-        @child_definitions << WeakSwaggerParameters::Definitions::PathParams::Integer.new(name, description)
+      def integer(name, description, options = {})
+        register_definition(:integer, name, description, options)
+      end
+
+      private
+
+      def register_definition(type, name, description, options)
+        @child_definitions << WeakSwaggerParameters::Definitions::Parameter.new(:path, type, name, description, options)
       end
     end
   end

data/lib/weak_swagger_parameters/definitions/property.rb

@@ -2,54 +2,18 @@
 module WeakSwaggerParameters
   module Definitions
     class Property
-      def initialize(type, name, description, options = {})
-        @type = type
-        @name = name
-        @description = description
-        @options = options || {}
-      end
+      include WeakSwaggerParameters::Definitions::LeafDefinition
 
-      def apply_validations(parent_node)
-        type = @type
-        name = @name
-        validation_options = {}
-        validation_options[:strong] = true
-        validation_options[:required] = @options.key?(:required)
-        validation_options[:only] = @options[:enum] if @options.key?(:enum)
-
-        parent_node.instance_eval { send type, name, validation_options }
+      def initialize(type, name, description, options = {})
+        @options = options.merge(name: name, type: type, description: description)
       end
 
       def apply_docs(parent_node)
-        name = @name
-        property_options = { description: @description }
-        property_options[:default] = @options[:default] if @options.key?(:default)
-        property_options[:enum] = @options[:enum] if @options.key?(:enum)
-        property_options.merge!(swagger_type_options)
+        name = @options[:name]
+        property_options = WeakSwaggerParameters::Services::SwaggerOptionsAdapter.adapt(@options.except(:name, :required))
 
         parent_node.instance_eval { property name, property_options }
       end
-
-      private
-
-      # rubocop:disable MethodLength
-      def swagger_type_options
-        known_types = {
-          integer: { type: :integer, format: :int32 },
-          long: { type: :integer, format: :int64 },
-          float: { type: :number, format: :float },
-          double: { type: :number, format: :double },
-          string: { type: :string },
-          byte: { type: :string, format: :byte },
-          binary: { type: :string, format: :binary },
-          boolean: { type: :boolean },
-          date: { type: :string, format: :date },
-          dateTime: { type: :string, format: :'date-time' },
-          password: { type: :string, format: :password }
-        }
-
-        known_types[@type]
-      end
     end
   end
 end

data/lib/weak_swagger_parameters/definitions/property_container.rb

@@ -7,27 +7,27 @@ module WeakSwaggerParameters
       # rubocop:disable Metrics/BlockLength
       included do
         def string(name, description, options = {})
-          register_definition name, options, WeakSwaggerParameters::Definitions::Property.new(: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)
+          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)
+          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)
+          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)
+          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)
+          register_definition(name, options, WeakSwaggerParameters::Definitions::CollectionProperty.new(name, description, model_class))
         end
 
         private

data/lib/weak_swagger_parameters/definitions/query.rb

@@ -2,8 +2,8 @@
 module WeakSwaggerParameters
   module Definitions
     class Query < ParamContainer
-      def string(name, description)
-        @child_definitions << WeakSwaggerParameters::Definitions::QueryParams::String.new(name, description)
+      def string(name, description, options = {})
+        @child_definitions << WeakSwaggerParameters::Definitions::Parameter.new(:query, :string, name, description, options)
       end
     end
   end

data/lib/weak_swagger_parameters/model.rb

@@ -14,8 +14,12 @@ module WeakSwaggerParameters
       end
 
       def model(&block)
-        api_docs = WeakSwaggerParameters::Definitions::Model.new(docs_model_name, &block)
-        api_docs.apply_docs(self)
+        @wsp_node = WeakSwaggerParameters::Definitions::Model.new(docs_model_name, &block)
+        @wsp_node.apply_docs(self)
+      end
+
+      def wsp_node
+        @wsp_node
       end
 
       def docs_model_name

data/lib/weak_swagger_parameters/services.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require 'weak_swagger_parameters/services/swagger_options_adapter'
+require 'weak_swagger_parameters/services/weak_parameters_options_adapter'

data/lib/weak_swagger_parameters/services/swagger_options_adapter.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Services
+    class SwaggerOptionsAdapter
+      KNOWN_TYPES = {
+        integer: { type: :integer, format: :int32 },
+        long: { type: :integer, format: :int64 },
+        float: { type: :number, format: :float },
+        double: { type: :number, format: :double },
+        string: { type: :string },
+        byte: { type: :string, format: :byte },
+        binary: { type: :string, format: :binary },
+        boolean: { type: :boolean },
+        date: { type: :string, format: :date },
+        dateTime: { type: :string, format: :'date-time' },
+        password: { type: :string, format: :password }
+      }.freeze
+
+      def self.adapt(options)
+        result = {}
+        result = result.merge(about_options(options))
+        result = result.merge(enum_options(options))
+        result = result.merge(default_options(options))
+        result = result.merge(type_options(options))
+        result = result.merge(required_options(options))
+        result = result.merge(range_options(options))
+        result
+      end
+
+      def self.type_options(options)
+        KNOWN_TYPES[options[:type]]
+      end
+
+      def self.about_options(options)
+        result = {}
+        result = result.merge(name: options[:name]) if options[:name].present?
+        result = result.merge(description: options[:description]) if options[:description].present?
+        result = result.merge(in: options[:location]) if options[:location].present?
+        result
+      end
+
+      def self.required_options(options)
+        result = {}
+        result = result.merge(required: true) if options[:location] == :path
+        result = result.merge(required: options[:required]) if options[:required]
+        result
+      end
+
+      def self.range_options(options)
+        result = {}
+        result = result.merge(minimum: options[:min]) if options[:min].present?
+        result = result.merge(maximum: options[:max]) if options[:max].present?
+        result
+      end
+
+      def self.default_options(options)
+        options[:default].present? ? { default: options[:default] } : {}
+      end
+
+      def self.enum_options(options)
+        options[:enum].present? ? { enum: options[:enum] } : {}
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/services/weak_parameters_options_adapter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module WeakSwaggerParameters
+  module Services
+    class WeakParametersOptionsAdapter
+      MAX_VALUE = (2**(0.size * 8 - 2) - 1)
+      MIN_VALUE = -(2**(0.size * 8 - 2))
+
+      def self.adapt(options)
+        result = {}
+        result[:strong] = true
+        result[:required] = options[:required]
+        result[:only] = options[:enum] if options[:enum].present?
+        result = result.merge(range_options(options))
+
+        result
+      end
+
+      def self.range_options(options)
+        return {} unless options.key?(:min) || options.key?(:max)
+
+        max = options[:max] || MAX_VALUE
+        min = options[:min] || MIN_VALUE
+        { only: min...max }
+      end
+    end
+  end
+end

data/lib/weak_swagger_parameters/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weak_swagger_parameters
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - AgileFreaks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -190,20 +190,22 @@ files:
 - 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/leaf_definition.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/parameter.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/services.rb
+- lib/weak_swagger_parameters/services/swagger_options_adapter.rb
+- lib/weak_swagger_parameters/services/weak_parameters_options_adapter.rb
 - lib/weak_swagger_parameters/version.rb
 - weak_swagger_parameters.gemspec
 homepage: https://github.com/Agilefreaks/weak_swagger_parameters
@@ -226,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Generate docs and Validate request parameters

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-module WeakSwaggerParameters
-  module Definitions
-    module PathParams
-      class Integer
-        def initialize(name, description)
-          @name = name
-          @description = description
-        end
-
-        def apply_validations(parent_node)
-          name = @name
-
-          parent_node.instance_eval do
-            integer name, strong: true
-          end
-        end
-
-        def apply_docs(parent_node)
-          name = @name
-          description = @description
-
-          parent_node.instance_eval do
-            parameter name: name, in: :path, required: true, description: description, type: :integer, format: :int32
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-module WeakSwaggerParameters
-  module Definitions
-    module PathParams
-      class String
-        def initialize(name, description)
-          @name = name
-          @description = description
-        end
-
-        def apply_validations(parent_node)
-          name = @name
-
-          parent_node.instance_eval do
-            string name, strong: true
-          end
-        end
-
-        def apply_docs(parent_node)
-          name = @name
-          description = @description
-
-          parent_node.instance_eval do
-            parameter name: name, in: :path, required: true, description: description, type: :string
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-module WeakSwaggerParameters
-  module Definitions
-    module QueryParams
-      class String
-        def initialize(name, description)
-          @name = name
-          @description = description
-        end
-
-        def apply_validations(parent_node)
-          name = @name
-
-          parent_node.instance_eval do
-            string name, strong: true
-          end
-        end
-
-        def apply_docs(parent_node)
-          name = @name
-          description = @description
-
-          parent_node.instance_eval do
-            parameter name: name, type: :string, in: :query, description: description
-          end
-        end
-      end
-    end
-  end
-end