sinatra-browse 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 299a354c585ed02f7ae75c3b8ffbc0ce5554d439
-  data.tar.gz: 0ffaa6e1f4a3c0315f556ef89a42f548d4701ec0
+  metadata.gz: eb3a18b58acc57c6a80b56bf6a0e08d96e2b04e0
+  data.tar.gz: 87150a5f51798b69ac97540940caec5ba16a5f9d
 SHA512:
-  metadata.gz: bb3763dcf26d9b9d6538f462e53d47289dfc347b7923131ac8545055f96d9346ccd41bdc30667b1b4dba95954c23915d1cf52ba519febf54d8b5b642f672d03f
-  data.tar.gz: 8ad00f11b3add8ad9f124f1f1f1b4a86d19ed8d07cba4cd713324062e61bbd891df278065c2a6107e2e2a1001d6a62b73ee96b72a3599481fc9b1f7fb4aac115
+  metadata.gz: 64b8e196681b25a346f8f0cfe135e220a9ebd1b38da76c50481491be880e9817d2384b293e588da7f4155bb0f7131cff9cef974516146bc230452775b8c285e7
+  data.tar.gz: 004f30d10ea627e10adce8b34a2115c820ff2b0934bbc3af47bb2a9d3116e154d04fd2d92a6d671047aaa4961674e42adf636e194706072d03c43581b8a431bf

data/README.md

@@ -1,6 +1,6 @@
 # sinatra-browse
 
-Self documenting parameter declaration framework for Sinatra.
+Parameter declaration framework and browsable API for Sinatra.
 
 ## What problem do we solve?
 
@@ -10,6 +10,8 @@ There exist several frameworks that generate documentation based on comment bloc
 
 ## How do we solve it?
 
+**Parameter Declaration**
+
 We believe in using actual code as documentation. Take a look at the following example.
 
 ```ruby
@@ -21,7 +23,7 @@ class App < Sinatra::Base
 
   description "Creates a new user"
   param :display_name, :String, required: true
-  param :type, :String, in: ["admin", "moderator", "user"], default: user
+  param :type, :String, in: ["admin", "moderator", "user"], default: "user"
   param :age, :Integer
   param :gender, :String, in: ["m", "w", "M", "W"], transform: :upcase
   param :activated, :Boolean, default: false
@@ -34,11 +36,15 @@ end
 
 Here we have a clear list of what parameters are expected and how they are validated. Since this is code and not a comment block, it will always be up to date with the behaviour of our application.
 
-**Question:** But we don't want to go look at source code just to get api documentation. What do we do?
+The syntax is inspired by the [sinatra-param](https://github.com/mattt/sinatra-param) and [thor](https://github.com/erikhuda/thor) projects.
 
-Sinatra-browse automatically generates documentation from your parameter validations. Just surf to the following url in your browser. *http://<api_ip_address>:<api_port>/browse*
+**Browsable API**
 
-The syntax is inspired by the [sinatra-param](https://github.com/mattt/sinatra-param) and [thor](https://github.com/erikhuda/thor) projects.
+Sinatra-browse allows you to surf to your API. This works as documentation and allows you to send requests and see their responses directly in your browser.
+
+    http://<api_ip_address>:<api_port>/browse
+
+*Remark:* This is still work in progress. Right now the page only shows some simple documentation.
 
 ## Parameter types
 
@@ -108,6 +114,15 @@ If a request is made that fails validation on the *lets_fail* parameter, then th
 You can use transform to execute a quick method on any prameter provided. Anything that will respond to *to_proc* will do.
 
 ```ruby
-param :only_caps, :String, transform :upcase
+param :only_caps, :String, transform: :upcase
 param :power_of_two, :Integer, transform: proc { |n| n * n }
 ```
+## Removing undefined parameters
+
+By default sinatra-browse removes all parameters that weren't defined. You can disable this behaviour with the following line.
+
+    disable :remove_undefined_parameters
+
+You can also set a `system_parameters` variable to allow for a select few parameters that aren't removed. By default this is set to *[ "splat", "captures" ]*.
+
+    set system_parameters: [ "id", "username", "password" ]

data/lib/sinatra/browse/parameter.rb

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+
+module Sinatra::Browse
+  def ValidationError < Exception; end
+
+  class Validation
+    attr_reader :fail_message
+  end
+
+  class In < Validation
+    def fail_message(value, accepted)
+      "Invalid value: '#{value}'. Must be a member of #{accepted.inspect}."
+    end
+    
+    def validate(value)
+    end
+
+    def fail(value, accepted)
+      raise ValidationError, fail_message(value, accepted)
+    end
+  end
+
+  class Parameter
+    attr_reader :value
+
+    def initialize(value)
+      @value = coerce(value)
+    end
+
+    def validate()
+    end
+  end
+
+  class BPString < Parameter
+    def coerce(v); String(v) end
+  end
+
+  class BPBoolean < Parameter
+    def coerce(v)
+      case v
+      when "y", "yes", "t", "true", "1"
+        true
+      when "n", "no", "f", "false", "0"
+        false
+      end
+    end
+  end
+end
+

data/lib/sinatra/browse/route.rb

@@ -53,8 +53,8 @@
       }
     end
 
-    def delete_undefined(params)
-      params.delete_if { |i| !self.has_parameter?(i) }
+    def delete_undefined(params, system_params)
+      params.delete_if { |i| !(self.has_parameter?(i) || system_params.member?(i)) }
     end
 
     def validate(params)

data/lib/sinatra/browse.rb

@@ -49,12 +49,20 @@ module Sinatra::Browse
   def self.registered(app)
     @app = app
 
+    app.enable :remove_undefined_parameters
+    app.set system_parameters: ["splat", "captures"]
+
     app.before do
       browse_route = app.browse_routes_for(request.request_method, request.path_info)
 
       if browse_route
         #TODO: Optionally throw error for undefined params
-        browse_route.delete_undefined(params) #TODO: Make this optional per route and global
+        #TODO: Make undefined parameter deletion optional per route
+
+        if settings.remove_undefined_parameters
+          browse_route.delete_undefined(params, settings.system_parameters)
+        end
+
         browse_route.coerce_type(params)
         browse_route.set_defaults(params)
         validation_result = browse_route.validate(params)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-browse
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Axsh Co. LTD
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies: []
 description: Parameter declaration framework and browsable API for Sinatra
 email: dev@axsh.net
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - lib/sinatra/browse.rb
 - lib/sinatra/browse/route.rb
+- lib/sinatra/browse/parameter.rb
 - lib/sinatra/browse/format.rb
 - LICENSE
 - README.md