wd_sinatra 0.2.1 → 0.2.2

data/README.md

@@ -58,10 +58,11 @@ To generate documentation for the APIs you created in the api folder.
 ### Testing
 
 TODO
+see 'wd_sinatra/test_helpers'
 
 ## Writing a service
 
-TODO see Weasel Diesel for now.
+TODO see Weasel Diesel for now and the generated service example.
 
 ## Config and hooks
 
@@ -86,21 +87,26 @@ being required before the specific env file.
 
 ### Hooks
 
-The request dispatcher offers 3 hooks which you can see demonstrated in
+The request dispatcher offers a fews hooks which you can see demonstrated in
 `config/hooks.rb`.
 
 * `params_preprocessor_hook(params)`
 * `params_postprocessor_hook(params)`
+* `params_exception_handler(exception)`
 * `pre_dispatch_hook`
 
 The two first hooks are used to process the params and when implemented
 are expected to return the params that will be used in the request.
 
+The `params_exception_handler` hook allows you to overwrite the default
+exception handling happening when an exception is raised while handling
+the params (pre procssing, validation or post processing).
+
 The `pre_dispatch_hook` is called just before the request is dispatched
 to the service implementation. This is where you might want to implement
 an authentication verification system for instance.
 
-These 3 hooks have access to the entire request context, including the
+These hooks have access to the entire request context, including the
 `service` being called. You can use the service `extra` option to set
 some custom settings that can then be used in this pre dispatch hook.
 

data/lib/wd_sinatra/sinatra_ext.rb

@@ -71,7 +71,11 @@ class WeaselDiesel
       rescue Exception => e
         LOGGER.error e.message
         LOGGER.error "passed params: #{app.params.inspect}"
-        halt 400, {'Content-Type' => 'application/json'}, {:error => e.message}.to_json
+        if self.respond_to?(:params_exception_handler)
+          params_exception_handler(e)
+        else
+          halt 400, {'Content-Type' => 'application/json'}, {:error => e.message}.to_json
+        end
       end
 
       # Define WeaselDiesel::RequestHandler#authorization_check in your app if

data/lib/wd_sinatra/version.rb

@@ -1,5 +1,5 @@
 module WD
   module Sinatra
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

data/templates/lib/body_parser.rb

@@ -7,7 +7,7 @@ module BodyParser
   def parse(params, body, content_type)
     case content_type
     when JSON_TYPE 
-      params.merge(json_parser.parse(body.string))
+      params.merge(json_parser.parse(body.read))
     else
       params
     end

data/templates/lib/hooks.rb

@@ -29,6 +29,18 @@ module WDSinatraHooks
     end
   end
 
+
+  # This hooks gets called when an exception is raised while preprocessing the params,
+  # verifying them or post processing them.
+  # If this method isn't defined, the default handler is used (a 400 error is returned with the 
+  # exception message sent back as a json.
+  #
+  # @param [Exception] exception The exception that was rescued.
+  # def pre_dispatch_hook(exception)
+  #   # example implementation:
+  #   # halt 400, {'Content-Type' => 'application/json'}, {:error => e.message}.to_json
+  # end
+
   # This hook gets called after the params are being verified.
   # You can use this hook to modify the params before sending them to
   # your service.

data/templates/lib/tasks/doc_generator/template.erb

@@ -68,6 +68,13 @@
                 <span class='label important'>Authentication required</span>
               <% end %>
               <%= "<p>#{api.doc.desc}</p>" if api.doc.desc %>
+              <% unless api.doc.examples.empty? %>
+                <ul>
+                  <% api.doc.examples.each do |example| %>
+                    <li><code><%= example %></code></li>
+                  <%  end %>
+                </ul>
+              <%  end %>
               <%# TODO support for namespaced params %>
               <% [["Required", :required_rules], ["Optional", :optional_rules]].each do |label,rule_meth| %>
                 <% unless api.send(rule_meth).empty? %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wd_sinatra
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-11 00:00:00.000000000 Z
+date: 2012-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: weasel_diesel
-  requirement: &70278796206600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70278796206600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70278796222300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70278796222300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra
   apps using the Weasel Diesel DSL
 email:
@@ -147,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra apps