rack-spec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09c2e44eccf5df03af4ba733f212863feddc17f2
+  data.tar.gz: c20330aae4f67a16a78157d68c5ef7f7eb9b5067
+SHA512:
+  metadata.gz: a1818d010e69c5bfac6dbea17970d6a5f9f117322de69d888695e24fdcf767c029320333d7c5203cdf758e2a088c1384e936c3e7cc98897dff9182356c9f08b2
+  data.tar.gz: 77571272b0bfb76540da3507d88f8dbc89ff13d49f4d8562faa61e4d37e829e3fd30421101d8ad4b9cf1e414861af2702532a0b185c8d009ec4e14f32cf1cec3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-spec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryo Nakamura
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Rack::Spec
+Define specifications of your Rack application.
+
+## Installation
+```
+gem install rack-spec
+```
+
+## Usage
+```ruby
+require "rack"
+require "rack/spec"
+require "yaml"
+
+use Rack::Spec, spec: YAML.load("spec.yml")
+
+run ->(env) do
+  [200, {}, ["OK"]]
+end
+```
+
+```yaml
+# spec.yml
+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
+```
+
+## Development
+```sh
+# setup
+git clone git@github.com:r7kamura/rack-spec.git
+cd rack-spec
+bundle install
+
+# testing
+bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rack-spec.rb

@@ -0,0 +1 @@
+require "rack/spec"

data/lib/rack/spec.rb

@@ -0,0 +1,29 @@
+require "rack/builder"
+require "rack/spec/exception_handler"
+require "rack/spec/spec"
+require "rack/spec/validation"
+require "rack/spec/validation_error"
+require "rack/spec/validators/base"
+require "rack/spec/validators/maximum_validator"
+require "rack/spec/validators/minimum_validator"
+require "rack/spec/validators/null_validator"
+require "rack/spec/validators/query_parameters_validator"
+require "rack/spec/validators/type_validator"
+require "rack/spec/validator_factory"
+require "rack/spec/version"
+
+module Rack
+  class Spec
+    def initialize(app, options)
+      @app = Rack::Builder.app do
+        use Rack::Spec::ExceptionHandler
+        use Rack::Spec::Validation, options
+        run app
+      end
+    end
+
+    def call(env)
+      @app.call(env)
+    end
+  end
+end

data/lib/rack/spec/exception_handler.rb

@@ -0,0 +1,15 @@
+module Rack
+  class Spec
+    class ExceptionHandler
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env)
+      rescue ValidationError => exception
+        exception.to_rack_response
+      end
+    end
+  end
+end

data/lib/rack/spec/spec.rb

@@ -0,0 +1,17 @@
+module Rack
+  class Spec
+    class Spec < Hash
+      def initialize(hash)
+        hash.each do |key, value|
+          self[key] = value
+        end
+      end
+
+      def reach(*keys)
+        keys.inject(self) do |hash, key|
+          hash[key] if hash.respond_to?(:[])
+        end
+      end
+    end
+  end
+end

data/lib/rack/spec/validation.rb

@@ -0,0 +1,25 @@
+module Rack
+  class Spec
+    class Validation
+      def initialize(app, options = {})
+        @app = app
+        @options = options
+      end
+
+      def call(env)
+        query_parameters_validator.validate!(env)
+        @app.call(env)
+      end
+
+      private
+
+      def spec
+        Spec.new(@options[:spec])
+      end
+
+      def query_parameters_validator
+        @query_parameters_validator ||= Validators::QueryParametersValidator.new(spec)
+      end
+    end
+  end
+end

data/lib/rack/spec/validation_error.rb

@@ -0,0 +1,33 @@
+require "json"
+
+module Rack
+  class Spec
+    class ValidationError < StandardError
+      def initialize(message)
+        @message = message
+      end
+
+      def message
+        @message
+      end
+
+      def to_rack_response
+        [status, header, body]
+      end
+
+      private
+
+      def status
+        400
+      end
+
+      def header
+        { "Content-Type" => "application/json" }
+      end
+
+      def body
+        { message: @message }.to_json
+      end
+    end
+  end
+end

data/lib/rack/spec/validator_factory.rb

@@ -0,0 +1,23 @@
+module Rack
+  class Spec
+    class ValidatorFactory
+      class << self
+        def validator_classes
+          @validator_classes ||= Hash.new(Validators::NullValidator)
+        end
+
+        def register(name, klass)
+          validator_classes[name] = klass
+        end
+
+        def build(key, type, constraint)
+          validator_classes[type].new(key, constraint)
+        end
+      end
+
+      register "maximum", Validators::MaximumValidator
+      register "minimum", Validators::MinimumValidator
+      register "type", Validators::TypeValidator
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Rack
+  class Spec
+    module Validators
+      class Base
+        def initialize(key, constraint)
+          @key = key
+          @constraint = constraint
+        end
+
+        def validate!(env)
+          raise NotImplementedError
+        end
+
+        private
+
+        def extract_value(env)
+          env["rack-spec.request"] ||= Rack::Request.new(env)
+          env["rack-spec.request"].params[@key]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Rack
+  class Spec
+    module Validators
+      class NullValidator < Base
+        def validate!(env)
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,37 @@
+require "time"
+
+module Rack
+  class Spec
+    module Validators
+      class TypeValidator < Base
+        class << self
+          def patterns
+            @patterns ||= Hash.new(//)
+          end
+
+          def register(name, pattern)
+            patterns[name] = pattern
+          end
+        end
+
+        register "boolean", /\A(?:true|false)\z/
+        register "float", /\A-?\d+(?:\.\d+)*\z/
+        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
+        end
+
+        private
+
+        def pattern
+          self.class.patterns[@constraint]
+        end
+      end
+    end
+  end
+end

data/lib/rack/spec/version.rb

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

data/rack-spec.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/spec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-spec"
+  spec.version       = Rack::Spec::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Define specifications of your Rack application."
+
+  spec.homepage      = "https://github.com/r7kamura/rack-spec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+  spec.add_development_dependency "activesupport", "4.0.2"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "2.14.1"
+  spec.add_development_dependency "rspec-json_matcher", "0.1.3"
+end

data/spec/rack/spec_spec.rb

@@ -0,0 +1,116 @@
+require "spec_helper"
+require "active_support/core_ext/string/strip"
+require "rack/test"
+require "yaml"
+
+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"]]
+    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
+
+  let(:params) do
+    {}
+  end
+
+  let(:env) do
+    {}
+  end
+
+  subject do
+    get path, params, env
+    last_response.status
+  end
+
+  describe "#call" do
+    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"
+      end
+      it { should == 200 }
+    end
+
+    context "with query parameter invalid on integer" do
+      before do
+        params[:page] = "1.0"
+      end
+      it { should == 400 }
+    end
+
+    context "with query parameter invalid on float" do
+      before do
+        params[:rank] = "x"
+      end
+      it { should == 400 }
+    end
+
+    context "with query parameter invalid on boolean" do
+      before do
+        params[:private] = 1
+      end
+      it { should == 400 }
+    end
+
+    context "with query parameter invalid on iso8601" do
+      before do
+        params[:time] = "2000-01-01 00:00:00 +0000"
+      end
+      it { should == 400 }
+    end
+
+    context "with query parameter invalid on minimum" do
+      before do
+        params[:page] = 0
+      end
+      it { should == 400 }
+    end
+
+    context "with query parameter invalid on maximum" do
+      before do
+        params[:page] = 11
+      end
+      it { should == 400 }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "rack/spec"
+require "rspec/json_matcher"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.include RSpec::JsonMatcher
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: rack-spec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rspec-json_matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-spec.rb
+- lib/rack/spec.rb
+- lib/rack/spec/exception_handler.rb
+- lib/rack/spec/spec.rb
+- lib/rack/spec/validation.rb
+- lib/rack/spec/validation_error.rb
+- lib/rack/spec/validator_factory.rb
+- lib/rack/spec/validators/base.rb
+- lib/rack/spec/validators/maximum_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/type_validator.rb
+- lib/rack/spec/version.rb
+- rack-spec.gemspec
+- spec/rack/spec_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/r7kamura/rack-spec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Define specifications of your Rack application.
+test_files:
+- spec/rack/spec_spec.rb
+- spec/spec_helper.rb
+has_rdoc: