rack-spec 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa1f5b2caa1ab2a81b5a1d16ab2c2c42061ca322
-  data.tar.gz: 593e35231041acbdb78ede30ef3b6d05a84e31d3
+  metadata.gz: 982ed4f72ecd493a91d0c53fb4bf960b2850a303
+  data.tar.gz: f012454fe35d8abf802a7c32fa138ddfedd21d50
 SHA512:
-  metadata.gz: 58f77db673d54bbe9c01a31094cfaebdceaee8bc0c25720d5f0029576f3f8548f9dcc7ad7f7b5850be6a226914c7b73d142b9771cd2837a6d3c2e7c2c2bccd32
-  data.tar.gz: 5fcc86a1e6aad44874f912987dca182a5784d93589691a90b407a34ab78f07c322879d8c1012ed5ca14d2a4b89838cf453b0c699fa6c7e6829d999f13a1fb19a
+  metadata.gz: 28e45afcf7f5d03cf4bc764f737e846012e8d1d5c63e7936eada092c117385d05e7152533bba5e3044fab6c6d1b3a808fc19802f511ff22aca8b3594bda21d13
+  data.tar.gz: 5a8239586bf0f19227a2d1606bc4a220c4655864157d1afaa9ed7faa69fc1f4e18aa021380bab99c0f9e84a43ecb09866db484e560348e405d3bb94b5b65642b

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.0.4
+* Add Rack::Spec::Restful, strongly conventional RESTful API Provider
+
 ## v0.0.3
 * Add a new constraint: required
 * More DRY way for validator definition

data/README.md

@@ -6,13 +6,19 @@ Define specifications of your Rack application.
 gem install rack-spec
 ```
 
-## Usage
+## Rack::Spec::Validation
+Rack::Spec::Validation is a rack-middleware and works as a validation layer for your rack-application.
+It loads spec definition (= a pure Hash object in specific format) to validate each request.
+If the request is not valid on your definition, it will raise Rack::Spec::Exceptions::ValidationError.
+Rack::Spec::ExceptionHandler is a utility rack-middleware to rescue validation error and return 400.
+
 ```ruby
 require "rack"
 require "rack/spec"
 require "yaml"
 
-use Rack::Spec, spec: YAML.load_file("spec.yml")
+use Rack::Spec::ExceptionHandler
+use Rack::Spec::Validation, spec: YAML.load_file("spec.yml")
 
 run ->(env) do
   [200, {}, ["OK"]]
@@ -50,6 +56,60 @@ endpoints:
           type: string
           minimumLength: 3
           maximumLength: 10
+          required: true
+```
+
+## Custom Validator
+Custom validator can be defined by inheriting Rack::Spec::Validators::Base.
+The following FwordValidator rejects any parameter starting with "F".
+See [lib/rack/spec/validators](https://github.com/r7kamura/rack-spec/tree/master/lib/rack/spec/validators) for more examples.
+
+```ruby
+# Example:
+#
+# parameters:
+#   title:
+#     fword: false
+#
+class FwordValidator < Rack::Spec::Validators::Base
+  register_as "fword"
+
+  def valid?
+    value.nil? || !value.start_with?("F")
+  end
+end
+```
+
+## Exception Handling
+Replace Rack::Spec::ExceptionHandler to customize error behavior.
+
+```ruby
+use MyExceptionHandler # Rack::Spec::ValidationError must be rescued
+use Rack::Spec::Validation, spec: YAML.load_file("spec.yml")
+```
+
+## Rack::Spec::Restful
+Rack::Spec::Restful provides strongly conventional RESTful APIs as a rack-middleware.
+It recognizes a preferred instruction from the request method & path, then tries to call it.
+
+| verb   | path          | instruction                |
+| ----   | ----          | ----                       |
+| GET    | /recipes/     | Recipe.index(id)           |
+| GET    | /recipes/{id} | Recipe.show(id, params)    |
+| POST   | /recipes/     | Recipe.create(id)          |
+| PUT    | /recipes/{id} | Recipe.update(id, params)  |
+| DELETE | /recipes/{id} | Recipe.destroy(id, params) |
+
+```ruby
+class Recipe
+  def self.index(params)
+    order(params[:order]).page(params[:page])
+  end
+
+  def self.show(id, params)
+    find(id)
+  end
+end
 ```
 
 ## Development

data/lib/rack/spec.rb

@@ -1,8 +1,10 @@
 require "rack/builder"
 require "rack/spec/exception_handler"
+require "rack/spec/exceptions/base"
+require "rack/spec/exceptions/validation_error"
+require "rack/spec/restful"
 require "rack/spec/spec"
 require "rack/spec/validation"
-require "rack/spec/validation_error"
 require "rack/spec/validators/base"
 require "rack/spec/validators/null_validator"
 require "rack/spec/validator_factory"
@@ -23,6 +25,7 @@ module Rack
       @app = Rack::Builder.app do
         use Rack::Spec::ExceptionHandler
         use Rack::Spec::Validation, options
+        use Rack::Spec::Restful, options
         run app
       end
     end

data/lib/rack/spec/exception_handler.rb

@@ -7,7 +7,7 @@ module Rack
 
       def call(env)
         @app.call(env)
-      rescue ValidationError => exception
+      rescue Exceptions::ValidationError => exception
         exception.to_rack_response
       end
     end

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

@@ -0,0 +1,8 @@
+module Rack
+  class Spec
+    module Exceptions
+      class Base < StandardError
+      end
+    end
+  end
+end

data/lib/rack/spec/exceptions/validation_error.rb

@@ -0,0 +1,43 @@
+require "json"
+
+module Rack
+  class Spec
+    module Exceptions
+      class ValidationError < Base
+        def initialize(validator)
+          @validator = validator
+        end
+
+        def message
+          "Invalid #{key} on `#{constraint_name}` constraint"
+        end
+
+        def to_rack_response
+          [status, header, body]
+        end
+
+        private
+
+        def constraint_name
+          @validator.class.registered_name
+        end
+
+        def key
+          @validator.key
+        end
+
+        def status
+          400
+        end
+
+        def header
+          { "Content-Type" => "application/json" }
+        end
+
+        def body
+          { message: message }.to_json
+        end
+      end
+    end
+  end
+end

data/lib/rack/spec/restful.rb

@@ -0,0 +1,116 @@
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/string/inflections"
+
+module Rack
+  class Spec
+    class Restful
+      def initialize(app, options = {})
+        @app = app
+        @options = options
+      end
+
+      def call(env)
+        Proxy.new(@app, spec, env).call
+      end
+
+      private
+
+      def spec
+        Spec.new(@options[:spec])
+      end
+
+      class Proxy
+        def initialize(app, spec, env)
+          @app = app
+          @spec = spec
+          @env = env
+        end
+
+        def call
+          if endpoint
+            response = handler_class.send(handler_method_name, *handler_args)
+            [
+              response.try(:status) || default_status,
+              default_header.merge(response.try(:header) || {}),
+              [(response.try(:body) || response).to_json]
+            ]
+          else
+            @app.call(@env)
+          end
+        end
+
+        private
+
+        def endpoint
+          @endpoint ||= @spec.find_endpoint(@env)
+        end
+
+        def handler_args
+          if id
+            [id, params]
+          else
+            [params]
+          end
+        end
+
+        def handler_class
+          path_segments[1].singularize.camelize.constantize
+        end
+
+        def id
+          path_segments[2]
+        end
+
+        def path_segments
+          @path_segments ||= path.split("/")
+        end
+
+        def handler_method_name
+          case request_method
+          when "GET"
+            if id
+              :show
+            else
+              :index
+            end
+          when "POST"
+            :create
+          when "PUT"
+            :update
+          when "DELETE"
+            :destroy
+          end
+        end
+
+        def path
+          request.path
+        end
+
+        def request
+          @env["rack-spec.request"] ||= Rack::Request.new(@env)
+        end
+
+        def request_method
+          @env["REQUEST_METHOD"]
+        end
+
+        def params
+          request.params
+        end
+
+        def default_status
+          {
+            "GET" => 200,
+            "POST" => 201,
+            "PUT" => 204,
+            "DELETE" => 204,
+          }[request_method]
+        end
+
+        def default_header
+          { "Content-tYpe" => "application/json" }
+        end
+      end
+    end
+  end
+end

data/lib/rack/spec/spec.rb

@@ -1,3 +1,5 @@
+require "addressable/template"
+
 module Rack
   class Spec
     class Spec < Hash
@@ -7,6 +9,16 @@ module Rack
         end
       end
 
+      def find_endpoint(env)
+        self["endpoints"].find do |path, source|
+          if Addressable::Template.new(path).extract(env["PATH_INFO"])
+            if endpoint = source[env["REQUEST_METHOD"]]
+              break endpoint
+            end
+          end
+        end
+      end
+
       def reach(*keys)
         keys.inject(self) do |hash, key|
           hash[key] if hash.respond_to?(:[])

data/lib/rack/spec/validation.rb

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

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

@@ -21,19 +21,15 @@ module Rack
 
         def validate!
           unless valid?
-            raise ValidationError, self
+            raise Exceptions::ValidationError, self
           end
         end
 
-        private
-
         def valid?
           raise NotImplementedError
         end
 
-        def error_message
-          raise NotImplementedError
-        end
+        private
 
         def value
           @value ||= request.params[@key]

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

@@ -4,8 +4,6 @@ module Rack
       class MaximumLengthValidator < Base
         register_as "maximumLength"
 
-        private
-
         def valid?
           value.nil? || value.length <= constraint
         end

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

@@ -4,8 +4,6 @@ module Rack
       class MaximumValidator < Base
         register_as "maximum"
 
-        private
-
         def valid?
           value.nil? || value.to_f <= constraint
         end

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

@@ -4,8 +4,6 @@ module Rack
       class MinimumLengthValidator < Base
         register_as "minimumLength"
 
-        private
-
         def valid?
           value.nil? || value.length >= constraint
         end

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

@@ -4,8 +4,6 @@ module Rack
       class MinimumValidator < Base
         register_as "minimum"
 
-        private
-
         def valid?
           value.nil? || value.to_f >= constraint
         end

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

@@ -2,7 +2,8 @@ module Rack
   class Spec
     module Validators
       class NullValidator < Base
-        def validate!
+        def valid?
+          true
         end
       end
     end

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

@@ -4,8 +4,6 @@ module Rack
       class OnlyValidator < Base
         register_as "only"
 
-        private
-
         def valid?
           value.nil? || constraint.include?(value)
         end

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

@@ -2,18 +2,24 @@ module Rack
   class Spec
     module Validators
       class ParametersValidator
-        def initialize(spec)
+        def initialize(spec, env)
           @spec = spec
+          @env = env
         end
 
-        def validate!(env)
-          parameters = @spec.reach("endpoints", env["PATH_INFO"], env["REQUEST_METHOD"], "parameters") || {}
+        def validate!
           parameters.each do |key, hash|
             hash.each do |type, constraint|
-              ValidatorFactory.build(key, type, constraint, env).validate!
+              ValidatorFactory.build(key, type, constraint, @env).validate!
             end
           end
         end
+
+        private
+
+        def parameters
+          @spec.find_endpoint(@env).try(:[], "parameters") || []
+        end
       end
     end
   end

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

@@ -4,8 +4,6 @@ module Rack
       class RequiredValidator < Base
         register_as "required"
 
-        private
-
         def valid?
           value.nil? == !constraint
         end

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

@@ -21,12 +21,12 @@ module Rack
         pattern "integer", /\A-?\d+\z/
         pattern "iso8601", ->(value) { Time.iso8601(value) rescue false }
 
-        private
-
         def valid?
           value.nil? || pattern === value
         end
 
+        private
+
         def pattern
           self.class.patterns[constraint]
         end

data/lib/rack/spec/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Spec
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/rack-spec.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport"
+  spec.add_dependency "addressable"
   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"

data/spec/fixtures/spec.yml

@@ -0,0 +1,36 @@
+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
+          required: true
+  /recipes/{id}:
+    GET:
+      description: Get the recipe
+    PUT:
+      description: Update the recipe
+    DELETE:
+      description: Delete the recipe

data/spec/rack/spec_spec.rb

@@ -1,44 +1,40 @@
 require "spec_helper"
-require "active_support/core_ext/string/strip"
-require "rack/test"
-require "yaml"
 
 describe Rack::Spec do
   include Rack::Test::Methods
 
+  before do
+    stub_const(
+      "Recipe",
+      Class.new do
+        class << self
+          def index(params)
+            [
+              { name: "test" }
+            ]
+          end
+
+          def show(id, params)
+            { name: "test#{id}" }
+          end
+
+          def create(params)
+            { name: "test" }
+          end
+
+          def update(id, params)
+          end
+
+          def destroy(id, params)
+          end
+        end
+      end
+    )
+  end
+
   let(:app) do
     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
-                  required: true
-      EOS
+      use Rack::Spec, spec: YAML.load_file("spec/fixtures/spec.yml")
       run ->(env) do
         [200, {}, ["OK"]]
       end
@@ -57,12 +53,16 @@ describe Rack::Spec do
     {}
   end
 
+  let(:response) do
+    last_response
+  end
+
   subject do
     send verb, path, params, env
     last_response.status
   end
 
-  describe "GET" do
+  describe "Validation on GET" do
     let(:verb) do
       :get
     end
@@ -128,7 +128,7 @@ describe Rack::Spec do
     end
   end
 
-  describe "POST" do
+  describe "Validation on POST" do
     before do
       params[:title] = "test"
     end
@@ -138,7 +138,7 @@ describe Rack::Spec do
     end
 
     context "with valid request" do
-      it { should == 200 }
+      it { should == 201 }
     end
 
     context "with request body parameter invalid on minimumLength" do
@@ -162,4 +162,60 @@ describe Rack::Spec do
       it { should == 400 }
     end
   end
+
+  describe "Restful" do
+    context "with GET /recipes" do
+      it "calls Recipe.index(params)" do
+        get "/recipes"
+        response.status.should == 200
+        response.body.should be_json_as(
+          [
+            { name: "test" },
+          ]
+        )
+      end
+    end
+
+    context "with GET /recipes/{id}" do
+      it "calls Recipe.show(id, params)" do
+        get "/recipes/1"
+        response.status.should == 200
+        response.body.should be_json_as(name: "test1")
+      end
+    end
+
+    context "with POST /recipes" do
+      before do
+        params[:title] = "test"
+      end
+
+      it "calls Recipe.create(params)" do
+        post "/recipes", params
+        response.status.should == 201
+        response.body.should be_json_as(name: "test")
+      end
+    end
+
+    context "with PUT /recipes/{id}" do
+      it "calls Recipe.update(id, params)" do
+        put "/recipes/1"
+        response.status.should == 204
+      end
+    end
+
+    context "with DELETE /recipes/{id}" do
+      it "calls Recipe.update(id, params)" do
+        delete "/recipes/1"
+        response.status.should == 204
+      end
+    end
+
+    context "with undefined endpoint" do
+      it "falls back to the inner rack app" do
+        get "/undefined"
+        response.status.should == 200
+        response.body.should == "OK"
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "rack/spec"
+require "rack/test"
 require "rspec/json_matcher"
+require "yaml"
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rack-spec
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-22 00:00:00.000000000 Z
+date: 2014-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -25,19 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 4.0.2
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: '0'
+- !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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -138,9 +152,11 @@ files:
 - lib/rack-spec.rb
 - lib/rack/spec.rb
 - lib/rack/spec/exception_handler.rb
+- lib/rack/spec/exceptions/base.rb
+- lib/rack/spec/exceptions/validation_error.rb
+- lib/rack/spec/restful.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_length_validator.rb
@@ -154,6 +170,7 @@ files:
 - lib/rack/spec/validators/type_validator.rb
 - lib/rack/spec/version.rb
 - rack-spec.gemspec
+- spec/fixtures/spec.yml
 - spec/rack/spec_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/r7kamura/rack-spec
@@ -181,6 +198,7 @@ signing_key:
 specification_version: 4
 summary: Define specifications of your Rack application.
 test_files:
+- spec/fixtures/spec.yml
 - spec/rack/spec_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/rack/spec/validation_error.rb

@@ -1,41 +0,0 @@
-require "json"
-
-module Rack
-  class Spec
-    class ValidationError < StandardError
-      def initialize(validator)
-        @validator = validator
-      end
-
-      def message
-        "Invalid #{key} on `#{constraint_name}` constraint"
-      end
-
-      def to_rack_response
-        [status, header, body]
-      end
-
-      private
-
-      def constraint_name
-        @validator.class.registered_name
-      end
-
-      def key
-        @validator.key
-      end
-
-      def status
-        400
-      end
-
-      def header
-        { "Content-Type" => "application/json" }
-      end
-
-      def body
-        { message: message }.to_json
-      end
-    end
-  end
-end