rack-spec 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09c2e44eccf5df03af4ba733f212863feddc17f2
-  data.tar.gz: c20330aae4f67a16a78157d68c5ef7f7eb9b5067
+  metadata.gz: 1eaf27c620c698b3f0d4648fa5e243a391aafe03
+  data.tar.gz: e34cca3032930bbe5912ff95ff9c526a2a30ea1e
 SHA512:
-  metadata.gz: a1818d010e69c5bfac6dbea17970d6a5f9f117322de69d888695e24fdcf767c029320333d7c5203cdf758e2a088c1384e936c3e7cc98897dff9182356c9f08b2
-  data.tar.gz: 77571272b0bfb76540da3507d88f8dbc89ff13d49f4d8562faa61e4d37e829e3fd30421101d8ad4b9cf1e414861af2702532a0b185c8d009ec4e14f32cf1cec3
+  metadata.gz: 06b6732cf5f1d56cbdf792db56540407ad8139d3431fac24472cb693238004f74ef5ed71bc82e33563619b160ee5087f358ffd081db4c4d6b1ba9df5da5162d1
+  data.tar.gz: 09893425824f9924f3fa23aa60821e9a8cf86b7ff2774dd0fbd1b0104f7f00a9aec07048173280dba0202443042a3a1c45465905335d6b20e198712a511056b2

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## v0.0.2
+* Change key name: queryParameters -> parameters
+* Add a new constraint: only
+* Add a new constraint: minimumLength
+* Add a new constraint: maxinumLength
+
+## v0.0.1
+* Add a new constraint: type
+* Add a new constraint: minimum
+* Add a new constraint: maxinum

data/README.md

@@ -12,7 +12,7 @@ require "rack"
 require "rack/spec"
 require "yaml"
 
-use Rack::Spec, spec: YAML.load("spec.yml")
+use Rack::Spec, spec: YAML.load_file("spec.yml")
 
 run ->(env) do
   [200, {}, ["OK"]]
@@ -27,7 +27,7 @@ meta:
 endpoints:
   /recipes:
     GET:
-      queryParameters:
+      parameters:
         page:
           type: integer
           minimum: 1
@@ -38,6 +38,18 @@ endpoints:
           type: float
         time:
           type: iso8601
+        kind:
+          type: string
+          only:
+            - mono
+            - di
+            - tri
+    POST:
+      parameters:
+        title:
+          type: string
+          minimumLength: 3
+          maximumLength: 10
 ```
 
 ## Development

data/lib/rack/spec.rb

@@ -4,10 +4,13 @@ require "rack/spec/spec"
 require "rack/spec/validation"
 require "rack/spec/validation_error"
 require "rack/spec/validators/base"
+require "rack/spec/validators/maximum_length_validator"
 require "rack/spec/validators/maximum_validator"
+require "rack/spec/validators/minimum_length_validator"
 require "rack/spec/validators/minimum_validator"
 require "rack/spec/validators/null_validator"
-require "rack/spec/validators/query_parameters_validator"
+require "rack/spec/validators/only_validator"
+require "rack/spec/validators/parameters_validator"
 require "rack/spec/validators/type_validator"
 require "rack/spec/validator_factory"
 require "rack/spec/version"

data/lib/rack/spec/validation.rb

@@ -7,7 +7,7 @@ module Rack
       end
 
       def call(env)
-        query_parameters_validator.validate!(env)
+        parameters_validator.validate!(env)
         @app.call(env)
       end
 
@@ -17,8 +17,8 @@ module Rack
         Spec.new(@options[:spec])
       end
 
-      def query_parameters_validator
-        @query_parameters_validator ||= Validators::QueryParametersValidator.new(spec)
+      def parameters_validator
+        @parameters_validator ||= Validators::ParametersValidator.new(spec)
       end
     end
   end

data/lib/rack/spec/validator_factory.rb

@@ -10,13 +10,16 @@ module Rack
           validator_classes[name] = klass
         end
 
-        def build(key, type, constraint)
-          validator_classes[type].new(key, constraint)
+        def build(key, type, constraint, env)
+          validator_classes[type].new(key, constraint, env)
         end
       end
 
       register "maximum", Validators::MaximumValidator
+      register "maximumLength", Validators::MaximumLengthValidator
       register "minimum", Validators::MinimumValidator
+      register "minimumLength", Validators::MinimumLengthValidator
+      register "only", Validators::OnlyValidator
       register "type", Validators::TypeValidator
     end
   end

data/lib/rack/spec/validators/base.rb

@@ -2,20 +2,36 @@ module Rack
   class Spec
     module Validators
       class Base
-        def initialize(key, constraint)
+        attr_reader :constraint, :key, :env
+
+        def initialize(key, constraint, env)
           @key = key
           @constraint = constraint
+          @env = env
         end
 
-        def validate!(env)
-          raise NotImplementedError
+        def validate!
+          unless valid?
+            raise ValidationError, error_message
+          end
         end
 
         private
 
-        def extract_value(env)
+        def valid?
+          raise NotImplementedError
+        end
+
+        def error_message
+          raise NotImplementedError
+        end
+
+        def value
+          @value ||= request.params[@key]
+        end
+
+        def request
           env["rack-spec.request"] ||= Rack::Request.new(env)
-          env["rack-spec.request"].params[@key]
         end
       end
     end

data/lib/rack/spec/validators/maximum_length_validator.rb

@@ -0,0 +1,17 @@
+module Rack
+  class Spec
+    module Validators
+      class MaximumLengthValidator < Base
+        private
+
+        def valid?
+          value.nil? || value.length <= constraint
+        end
+
+        def error_message
+          "Expected #{key} to be equal or shorter than #{constraint}, but in fact #{value.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/rack/spec/validators/maximum_validator.rb

@@ -2,17 +2,14 @@ module Rack
   class Spec
     module Validators
       class MaximumValidator < Base
-        def validate!(env)
-          value = extract_value(env)
-          if value && value.to_f > maximum
-            raise ValidationError, "Expected #@key to be equal or less than #@maximum, but in fact #{value.inspect}"
-          end
-        end
-
         private
 
-        def maximum
-          @constraint
+        def valid?
+          value.nil? || value.to_f <= constraint
+        end
+
+        def error_message
+          "Expected #{key} to be equal or higher than #{constraint}, but in fact #{value.inspect}"
         end
       end
     end

data/lib/rack/spec/validators/minimum_length_validator.rb

@@ -0,0 +1,17 @@
+module Rack
+  class Spec
+    module Validators
+      class MinimumLengthValidator < Base
+        private
+
+        def valid?
+          value.nil? || value.length >= constraint
+        end
+
+        def error_message
+          "Expected #{key} to be equal or longer than #{constraint}, but in fact #{value.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/rack/spec/validators/minimum_validator.rb

@@ -2,17 +2,14 @@ module Rack
   class Spec
     module Validators
       class MinimumValidator < Base
-        def validate!(env)
-          value = extract_value(env)
-          if value && value.to_f < minimum
-            raise ValidationError, "Expected #@key to be equal or higher than #@minimum, but in fact #{value.inspect}"
-          end
-        end
-
         private
 
-        def minimum
-          @constraint
+        def valid?
+          value.nil? || value.to_f >= constraint
+        end
+
+        def error_message
+          "Expected #{key} to be equal or higher than #{constraint}, but in fact #{value.inspect}"
         end
       end
     end

data/lib/rack/spec/validators/only_validator.rb

@@ -0,0 +1,17 @@
+module Rack
+  class Spec
+    module Validators
+      class OnlyValidator < Base
+        private
+
+        def valid?
+          value.nil? || constraint.include?(value)
+        end
+
+        def error_message
+          "Expected #{key} to be included in #{constraint}, but in fact #{value.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/rack/spec/validators/{query_parameters_validator.rb → parameters_validator.rb}

@@ -1,16 +1,16 @@
 module Rack
   class Spec
     module Validators
-      class QueryParametersValidator
+      class ParametersValidator
         def initialize(spec)
           @spec = spec
         end
 
         def validate!(env)
-          parameters = @spec.reach("endpoints", env["PATH_INFO"], env["REQUEST_METHOD"], "queryParameters") || {}
+          parameters = @spec.reach("endpoints", env["PATH_INFO"], env["REQUEST_METHOD"], "parameters") || {}
           parameters.each do |key, hash|
             hash.each do |type, constraint|
-              ValidatorFactory.build(key, type, constraint).validate!(env)
+              ValidatorFactory.build(key, type, constraint, env).validate!
             end
           end
         end

data/lib/rack/spec/validators/type_validator.rb

@@ -19,17 +19,18 @@ module Rack
         register "integer", /\A-?\d+\z/
         register "iso8601", ->(value) { Time.iso8601(value) rescue false }
 
-        def validate!(env)
-          value = extract_value(env) or return
-          unless pattern === value
-            raise ValidationError, "Expected #@key to be #@constraint, but in fact #{value.inspect}"
-          end
+        private
+
+        def valid?
+          value.nil? || pattern === value
         end
 
-        private
+        def error_message
+          "Expected #{key} to be #{constraint}, but in fact #{value.inspect}"
+        end
 
         def pattern
-          self.class.patterns[@constraint]
+          self.class.patterns[constraint]
         end
       end
     end

data/lib/rack/spec/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Spec
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/rack/spec_spec.rb

@@ -7,42 +7,43 @@ describe Rack::Spec do
   include Rack::Test::Methods
 
   let(:app) do
-    described_class.new(original_app, spec: spec)
-  end
-
-  let(:original_app) do
-    ->(env) do
-      [200, {}, ["OK"]]
+    Rack::Builder.app do
+      use Rack::Spec, spec: YAML.load(<<-EOS.strip_heredoc)
+        meta:
+          baseUri: http://api.example.com/
+        endpoints:
+          /recipes:
+            GET:
+              parameters:
+                page:
+                  type: integer
+                  minimum: 1
+                  maximum: 10
+                private:
+                  type: boolean
+                rank:
+                  type: float
+                time:
+                  type: iso8601
+                kind:
+                  type: string
+                  only:
+                    - mono
+                    - di
+                    - tri
+            POST:
+              parameters:
+                title:
+                  type: string
+                  minimumLength: 3
+                  maximumLength: 10
+      EOS
+      run ->(env) do
+        [200, {}, ["OK"]]
+      end
     end
   end
 
-  let(:spec) do
-    YAML.load(yaml)
-  end
-
-  let(:yaml) do
-    <<-EOS.strip_heredoc
-      ---
-      meta:
-        baseUri: http://api.example.com/
-
-      endpoints:
-        /recipes:
-          GET:
-            queryParameters:
-              page:
-                type: integer
-                minimum: 1
-                maximum: 10
-              private:
-                type: boolean
-              rank:
-                type: float
-              time:
-                type: iso8601
-    EOS
-  end
-
   let(:path) do
     "/recipes"
   end
@@ -56,17 +57,22 @@ describe Rack::Spec do
   end
 
   subject do
-    get path, params, env
+    send verb, path, params, env
     last_response.status
   end
 
-  describe "#call" do
+  describe "GET" do
+    let(:verb) do
+      :get
+    end
+
     context "with valid request" do
       before do
         params[:page] = 5
         params[:private] = "false"
         params[:rank] = 2.0
         params[:time] = "2000-01-01T00:00:00+00:00"
+        params[:kind] = "mono"
       end
       it { should == 200 }
     end
@@ -112,5 +118,40 @@ describe Rack::Spec do
       end
       it { should == 400 }
     end
+
+    context "with query parameter invalid on only" do
+      before do
+        params[:kind] = "tetra"
+      end
+      it { should == 400 }
+    end
+  end
+
+  describe "POST" do
+    let(:verb) do
+      :post
+    end
+
+    context "with valid request" do
+      before do
+        params[:title] = "test"
+      end
+
+      it { should == 200 }
+    end
+
+    context "with request body parameter invalid on minimumLength" do
+      before do
+        params[:title] = "te"
+      end
+      it { should == 400 }
+    end
+
+    context "with request body parameter invalid on maximumLength" do
+      before do
+        params[:title] = "toooooolong"
+      end
+      it { should == 400 }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-spec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -130,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -142,10 +143,13 @@ files:
 - lib/rack/spec/validation_error.rb
 - lib/rack/spec/validator_factory.rb
 - lib/rack/spec/validators/base.rb
+- lib/rack/spec/validators/maximum_length_validator.rb
 - lib/rack/spec/validators/maximum_validator.rb
+- lib/rack/spec/validators/minimum_length_validator.rb
 - lib/rack/spec/validators/minimum_validator.rb
 - lib/rack/spec/validators/null_validator.rb
-- lib/rack/spec/validators/query_parameters_validator.rb
+- lib/rack/spec/validators/only_validator.rb
+- lib/rack/spec/validators/parameters_validator.rb
 - lib/rack/spec/validators/type_validator.rb
 - lib/rack/spec/version.rb
 - rack-spec.gemspec