sinatra-browse 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 299a354c585ed02f7ae75c3b8ffbc0ce5554d439
+  data.tar.gz: 0ffaa6e1f4a3c0315f556ef89a42f548d4701ec0
+SHA512:
+  metadata.gz: bb3763dcf26d9b9d6538f462e53d47289dfc347b7923131ac8545055f96d9346ccd41bdc30667b1b4dba95954c23915d1cf52ba519febf54d8b5b642f672d03f
+  data.tar.gz: 8ad00f11b3add8ad9f124f1f1f1b4a86d19ed8d07cba4cd713324062e61bbd891df278065c2a6107e2e2a1001d6a62b73ee96b72a3599481fc9b1f7fb4aac115

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,113 @@
+# sinatra-browse
+
+Self documenting parameter declaration framework for Sinatra.
+
+## What problem do we solve?
+
+Sinatra has tools to define `GET`, `POST`, `DELETE` etc. routes. It doesn't have any tools to define their parameters.
+
+There exist several frameworks that generate documentation based on comment blocks above routes. The problem is you have to update these every time something is changed in the code. We have seen programmers forget this in too many projects.
+
+## How do we solve it?
+
+We believe in using actual code as documentation. Take a look at the following example.
+
+```ruby
+require "sinatra/base"
+require "sinatra/browse"
+
+class App < Sinatra::Base
+  register Sinatra::Browse
+
+  description "Creates a new user"
+  param :display_name, :String, required: true
+  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
+  param :email, :String, format: /^([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})$/
+  post "/users" do
+    # ... some code that creates a new user
+  end
+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?
+
+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*
+
+The syntax is inspired by the [sinatra-param](https://github.com/mattt/sinatra-param) and [thor](https://github.com/erikhuda/thor) projects.
+
+## Parameter types
+
+At the time of writing four parameter types are available.
+
+* `:String`
+* `:Integer`
+* `:Float`
+* `:Boolean` ["1/0", "true/false", "t/f", "yes/no", "y/n"]
+
+## Default values
+
+You can set default values in your declarations. These will be used when the parameter in question wasn't provided in the request. You can either set the default value or provide a proc to generate it.
+
+```ruby
+param :media_type, :String, default: "book"
+param :year, :Integer, default: lambda { Time.now.year }
+```
+
+## Parameter validation
+
+You can write some quick validation logic directly in the parameter declaration. If the validation fails, either a standard 400 error will be returned or a custom error block will execute if provided.
+
+`required` Fails if this parameter is not provided in the request.
+
+```ruby
+param :you_must_include_me, :String, required: true
+```
+
+`depends_on` Some times there are parameters that are required by other parameters. Use `depends_on` to implement this. The example below will allow you to send *post_something* without any other parameters. If you send *user_name* though, you will be required to send *password* along with it.
+
+```ruby
+param :post_something, :String
+param :user_name, :String, depends_on: :password
+param :password, :String
+```
+
+`in` Fails if this parameter is not included in the values set by `in`. You can use anything that responds to *.member?* like an array or a range.
+
+```ruby
+param :single_digit, :Integer, in: 1..9
+param :small_prime_number, :Integer, in: Prime.take(10)
+param :order, :String, in: ["ascending", "descending"]
+```
+
+`format` This validation is only for parameters of type `:String`. You can pass a regular expression that the string provided must match to.
+
+```ruby
+param :alphanumeric, :String, format: /^[0-9A-Za-z]*$/
+```
+
+## Error handling
+
+When a validation fails, a standard 400 error will be returned. You can override this and do your own error handling using `on_error`.
+
+```ruby
+param :lets_fail, :Integer, in: 1..9, on_error: proc { halt 404, "if you're not giving us a number between 1 and 9, we're going to pretend not to be here!" }
+get 'example_route' do
+  # This is the scope that the on_error proc will be executed in.
+end
+```
+
+If a request is made that fails validation on the *lets_fail* parameter, then the proc provided to `on_error` will be called **in the same scope as your route**. Therefore you have access to Sinatra keywords such as *halt*.
+
+## Parameter transformation
+
+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 :power_of_two, :Integer, transform: proc { |n| n * n }
+```

data/lib/sinatra/browse/format.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+
+require 'yaml'
+
+module Sinatra::Browse
+  def self.format(f, browse_routes)
+    case f
+    when "kusohtml"
+      KusoHtml.new(browse_routes)
+    when "json"
+      JSON.new(browse_routes)
+    when "yaml"
+      YAML.new(browse_routes)
+    end
+  end
+
+  class BrowseFormat
+    def initialize(browse_routes)
+      @browse_routes = browse_routes
+    end
+  end
+
+  class KusoHtml < BrowseFormat
+    def generate
+      output = ""
+      @browse_routes.each { |name, route|
+        output += "<h3>#{name}</h3>"
+        output += "<p>#{route.description}</p><ul>"
+        route.parameters.each { |param_key, param_value|
+          output += "<li>#{param_key} #{param_value.to_s}</li>"
+        }
+        output += "</ul>"
+      }
+      output
+    end
+  end
+
+  class JSON < BrowseFormat
+    def generate
+      @browse_routes.values.map { |br| br.to_hash }.to_json
+    end
+  end
+
+  class YAML < BrowseFormat
+    def generate
+      @browse_routes.values.map { |br| br.to_hash }.to_yaml
+    end
+  end
+end
+

data/lib/sinatra/browse/route.rb

@@ -0,0 +1,101 @@
+# -*- coding: utf-8 -*-
+
+ module Sinatra::Browse
+  class Route
+    attr_reader :parameters
+    attr_reader :name
+    attr_reader :match
+    attr_reader :description
+
+    class ValidationError < Exception; end
+
+    # This is here because we're using the name as the keys for the
+    # _browse_routes hash. We want to build it outside of this class for that.
+    def self.build_name(request_method, path_info)
+      "#{request_method}  #{path_info}"
+    end
+
+    def initialize(request_method, path_info, description, parameters = nil)
+      @name = build_name(request_method, path_info)
+      @match = build_match(request_method, path_info)
+      @description = description
+      @parameters = parameters || {}
+    end
+
+    def to_hash
+      {name: @name, description: @description}.merge @parameters
+    end
+
+    def matches?(request_method, path_info)
+      !! (build_name(request_method,path_info) =~ @match)
+    end
+
+    def has_parameter?(parameter)
+      @parameters.has_key?(parameter.to_sym)
+    end
+
+    def coerce_type(params)
+      @parameters.each { |k,v|
+        params[k] &&= case v[:type]
+        when :Boolean
+          cast_to_boolean(params[k])
+        else
+          send(v[:type], params[k])
+        end
+      }
+    end
+
+    def set_defaults(params)
+      @parameters.each { |k,v|
+        unless params[k] || v[:default].nil?
+          params[k] = v[:default].is_a?(Proc) ? v[:default].call(params[k]) : v[:default]
+        end
+      }
+    end
+
+    def delete_undefined(params)
+      params.delete_if { |i| !self.has_parameter?(i) }
+    end
+
+    def validate(params)
+      @parameters.each { |k,v|
+        return fail_validation v, :required if !params[k] && v[:required]
+        if params[k]
+          return fail_validation v, :depends_on if v[:depends_on] && !params[v[:depends_on]]
+          return fail_validation v, :in if v[:in] && !v[:in].member?(params[k])
+          return fail_validation v, :format if v[:type] == :String && v[:format] && !(params[k] =~ v[:format])
+        end
+      }
+
+      {success: true}
+    end
+
+    def transform(params)
+      @parameters.each { |k,v|
+        params[k] = v[:transform].to_proc.call(params[k]) if params[k] && v[:transform]
+      }
+    end
+
+    private
+    def cast_to_boolean(param)
+      case param
+      when "y", "yes", "t", "true", "1"
+        true
+      when "n", "no", "f", "false", "0"
+        false
+      end
+    end
+
+    def fail_validation(parameter, reason)
+      { success: false, reason: reason }.merge parameter
+    end
+
+    def build_name(request_method, path_info)
+      self.class.build_name(request_method, path_info)
+    end
+
+    def build_match(request_method, path_info)
+      /^#{request_method}\s\s#{path_info.gsub(/:[^\/]*/, '[^\/]*')}$/
+    end
+  end
+end

data/lib/sinatra/browse.rb

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+
+require 'sinatra/base'
+
+Dir["#{File.dirname(__FILE__)}/browse/*.rb"].each {|f| require f }
+
+module Sinatra::Browse
+  def param(name, type, options = {})
+    temp_browse_params[name] = options.merge({ type: type })
+  end
+
+  def parameter_options(parameter, options)
+    #TODO: Raise error when the parameter overridden doesn't exist
+    temp_browse_params[parameter].merge! options
+  end
+  alias :param_options :parameter_options
+
+  def temp_browse_params
+    @_temp_browse_params ||= reset_temp_params
+  end
+
+  def reset_temp_params
+    @_temp_browse_params = {}
+  end
+
+  def browse_routes
+    @_browse_routes ||= {}
+  end
+
+  def browse_description
+    @_browse_description ||= ""
+  end
+
+  def describe(description)
+    @_browse_description = description
+  end
+  alias :desc :describe
+
+  def browse_routes_for(request_method, path_info)
+    browse_routes.values.find { |v| v.matches?(request_method, path_info) }
+  end
+
+  #TODO: Rename method... It doesn't sound like we'd be creating a new route object here
+  def set_browse_routes_for(request_method, path_info, description = browse_description, new_params = temp_browse_params)
+    new_route = Route.new(request_method, path_info, browse_description, new_params)
+    browse_routes[new_route.name] = new_route
+  end
+
+  def self.registered(app)
+    @app = app
+
+    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
+        browse_route.coerce_type(params)
+        browse_route.set_defaults(params)
+        validation_result = browse_route.validate(params)
+        unless validation_result[:success]
+          if validation_result[:on_error].respond_to?(:to_proc)
+            instance_exec &validation_result[:on_error].to_proc
+          else
+            halt 400, {
+              error: "parameter validation failed",
+              parameter: validation_result[:name],
+              reason: validation_result[:reason]
+            }.to_json
+          end
+        end
+        browse_route.transform(params)
+      end
+    end
+
+    # Create the (future) browsable api
+    app.param :format, :String, in: ["kusohtml", "json", "yaml"], default: "kusohtml"
+    app.get '/browse' do
+      Sinatra::Browse.format(params["format"], app.browse_routes).generate
+    end
+  end
+
+  def self.route_added(verb, path, block)
+    @app.set_browse_routes_for(verb, path)
+    @app.reset_temp_params
+    @app.desc ""
+  end
+end
+
+module Sinatra; register(Browse) end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-browse
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Axsh Co. LTD
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies: []
+description: Parameter declaration framework and browsable API for Sinatra
+email: dev@axsh.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sinatra/browse.rb
+- lib/sinatra/browse/route.rb
+- lib/sinatra/browse/format.rb
+- LICENSE
+- README.md
+homepage: https://github.com/axsh/sinatra-browse
+licenses:
+- LGPLv3
+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: Parameter declaration framework and browsable API for Sinatra
+test_files: []
+has_rdoc: