rack-spec 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 982ed4f72ecd493a91d0c53fb4bf960b2850a303
-  data.tar.gz: f012454fe35d8abf802a7c32fa138ddfedd21d50
+  metadata.gz: bf3a96b091fcf262c279bfd214379e55ed856c7a
+  data.tar.gz: 313b5fd8342e4ddd245fced70fad0d348db2092f
 SHA512:
-  metadata.gz: 28e45afcf7f5d03cf4bc764f737e846012e8d1d5c63e7936eada092c117385d05e7152533bba5e3044fab6c6d1b3a808fc19802f511ff22aca8b3594bda21d13
-  data.tar.gz: 5a8239586bf0f19227a2d1606bc4a220c4655864157d1afaa9ed7faa69fc1f4e18aa021380bab99c0f9e84a43ecb09866db484e560348e405d3bb94b5b65642b
+  metadata.gz: 2ef09a48686f6e9818fbd4e2c8aef235b8d45981a26f4703e54efe051deb7f057a57dee84ab6d93cb3fb41e327691dd717db083b41835ef50d3e5796170d6368
+  data.tar.gz: f625b179cae1770d3877b050492d3e93fa9b05e226a4f84ad359a5acaad62b176277cf0eb8b1afd862bd8c77b69bed2d866a2247b441e4eda909cd779a922f60

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.0.5
+* Change RESTful resource API (#get, #post, #put, and #delete)
+
 ## v0.0.4
 * Add Rack::Spec::Restful, strongly conventional RESTful API Provider
 

data/README.md

@@ -1,28 +1,14 @@
 # Rack::Spec
-Define specifications of your Rack application.
+Spec based web-application middleware for Rack.
 
-## Installation
-```
-gem install rack-spec
-```
-
-## 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.
+* Rack::Spec - all-in-one middleware
+ * Rack::Spec::Validation - validates requests along given specifications
+ * Rack::Spec::ExceptionHandler - rescues exceptions raised from Rack::Spec::Validation
+ * Rack::Spec::Restful - provides strongly-conventional RESTful API endpoints
 
 ```ruby
-require "rack"
-require "rack/spec"
-require "yaml"
-
-use Rack::Spec::ExceptionHandler
-use Rack::Spec::Validation, spec: YAML.load_file("spec.yml")
-
-run ->(env) do
-  [200, {}, ["OK"]]
-end
+use Rack::Spec, spec: YAML.load_file("spec.yml")
+run ->(env) { [404, {}, ["Not Found"]] }
 ```
 
 ```yaml
@@ -59,7 +45,18 @@ endpoints:
           required: true
 ```
 
-## Custom Validator
+## 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
+use Rack::Spec::ExceptionHandler
+use Rack::Spec::Validation, spec: YAML.load_file("spec.yml")
+```
+
+### 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.
@@ -80,25 +77,30 @@ class FwordValidator < Rack::Spec::Validators::Base
 end
 ```
 
-## Exception Handling
+### Exception Handling
 Replace Rack::Spec::ExceptionHandler to customize error behavior.
 
 ```ruby
-use MyExceptionHandler # Rack::Spec::ValidationError must be rescued
+use MyExceptionHandler # Rack::Spec::Exceptions::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.
+Rack::Spec::Restful provides strongly-conventional RESTful API endpoints as a rack-middleware.
+
+### Convention
 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) |
+| verb   | path          | instruction           |
+| ----   | ----          | ----                  |
+| GET    | /recipes      | Recipe.get(params)    |
+| GET    | /recipes/{id} | Recipe.get(params)    |
+| POST   | /recipes      | Recipe.post(params)   |
+| PUT    | /recipes/{id} | Recipe.put(params)    |
+| DELETE | /recipes/{id} | Recipe.delete(params) |
+
+### Example
+You must implement correspondent class & methods for your API.
 
 ```ruby
 class Recipe
@@ -110,6 +112,15 @@ class Recipe
     find(id)
   end
 end
+
+require "rack"
+require "rack/spec"
+require "yaml"
+
+use Rack::Spec::Restful, spec: YAML.load_file("spec.yml")
+run ->(env) do
+  [404, {}, ["Not Found"]]
+end
 ```
 
 ## Development

data/lib/rack/spec/restful.rb

@@ -28,7 +28,7 @@ module Rack
 
         def call
           if endpoint
-            response = handler_class.send(handler_method_name, *handler_args)
+            response = handler_class.send(handler_method_name, params)
             [
               response.try(:status) || default_status,
               default_header.merge(response.try(:header) || {}),
@@ -45,14 +45,6 @@ module Rack
           @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
@@ -66,20 +58,7 @@ module Rack
         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
+          request_method.downcase
         end
 
         def path
@@ -95,7 +74,7 @@ module Rack
         end
 
         def params
-          request.params
+          request.params.merge(@env["rack-spec.uri_parameters"])
         end
 
         def default_status

data/lib/rack/spec/spec.rb

@@ -11,8 +11,9 @@ module Rack
 
       def find_endpoint(env)
         self["endpoints"].find do |path, source|
-          if Addressable::Template.new(path).extract(env["PATH_INFO"])
+          if parameters = Addressable::Template.new(path).extract(env["PATH_INFO"])
             if endpoint = source[env["REQUEST_METHOD"]]
+              env["rack-spec.uri_parameters"] = parameters
               break endpoint
             end
           end

data/lib/rack/spec/version.rb

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

data/rack-spec.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Rack::Spec::VERSION
   spec.authors       = ["Ryo Nakamura"]
   spec.email         = ["r7kamura@gmail.com"]
-  spec.summary       = "Define specifications of your Rack application."
+  spec.summary       = "Spec based web-application middleware for Rack."
 
   spec.homepage      = "https://github.com/r7kamura/rack-spec"
   spec.license       = "MIT"

data/spec/rack/spec_spec.rb

@@ -8,24 +8,24 @@ describe Rack::Spec do
       "Recipe",
       Class.new do
         class << self
-          def index(params)
-            [
-              { name: "test" }
-            ]
+          def get(params)
+            if params["id"]
+              { name: "test#{params["id"]}"}
+            else
+              [
+                { name: "test" }
+              ]
+            end
           end
 
-          def show(id, params)
-            { name: "test#{id}" }
-          end
-
-          def create(params)
+          def post(params)
             { name: "test" }
           end
 
-          def update(id, params)
+          def put(params)
           end
 
-          def destroy(id, params)
+          def delete(params)
           end
         end
       end
@@ -177,7 +177,7 @@ describe Rack::Spec do
     end
 
     context "with GET /recipes/{id}" do
-      it "calls Recipe.show(id, params)" do
+      it "calls Recipe.get(params)" do
         get "/recipes/1"
         response.status.should == 200
         response.body.should be_json_as(name: "test1")
@@ -189,7 +189,7 @@ describe Rack::Spec do
         params[:title] = "test"
       end
 
-      it "calls Recipe.create(params)" do
+      it "calls Recipe.post(params)" do
         post "/recipes", params
         response.status.should == 201
         response.body.should be_json_as(name: "test")
@@ -197,14 +197,14 @@ describe Rack::Spec do
     end
 
     context "with PUT /recipes/{id}" do
-      it "calls Recipe.update(id, params)" do
+      it "calls Recipe.put(params)" do
         put "/recipes/1"
         response.status.should == 204
       end
     end
 
     context "with DELETE /recipes/{id}" do
-      it "calls Recipe.update(id, params)" do
+      it "calls Recipe.delete(params)" do
         delete "/recipes/1"
         response.status.should == 204
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-spec
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -196,7 +196,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Define specifications of your Rack application.
+summary: Spec based web-application middleware for Rack.
 test_files:
 - spec/fixtures/spec.yml
 - spec/rack/spec_spec.rb