Module: Sinatra::Browse

Defined in:
lib/sinatra/browse/format.rb,
lib/sinatra/browse/route.rb,
lib/sinatra/browse.rb

Defined Under Namespace

Classes: BrowseFormat, JSON, KusoHtml, Route, YAML

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.format(f, browse_routes) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
 
# File 'lib/sinatra/browse/format.rb', line 6

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

.registered(app) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/sinatra/browse.rb', line 54

def self.registered(app)
  @app = app

  app.enable :remove_undefined_parameters
  app.set allowed_undefined_parameters: []

  app.disable :show_head_routes

  app.class_eval {
    def _default_on_error(error_hash)
      halt 400, {
        error: "parameter validation failed",
        parameter: error_hash[:parameter],
        value: error_hash[:value],
        reason: error_hash[:reason]
      }.to_json
    end
  }

  app.default_on_error { |error_hash| _default_on_error(error_hash) }

  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

      if settings.remove_undefined_parameters
        browse_route.delete_undefined(params, settings.allowed_undefined_parameters)
      end

      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)
          error_proc = validation_result.delete(:on_error).to_proc
          instance_exec validation_result, &error_proc
        else
          instance_exec validation_result, &app.default_on_error
        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

.route_added(verb, path, block) ⇒ Object 



107
108
109
110
111
112
 
# File 'lib/sinatra/browse.rb', line 107

def self.route_added(verb, path, block)
  return if verb == "HEAD" && !@app.settings.show_head_routes
  @app.set_browse_routes_for(verb, path)
  @app.reset_temp_params
  @app.desc ""
end

Instance Method Details

#browse_description ⇒ Object 



30
31
32
 
# File 'lib/sinatra/browse.rb', line 30

def browse_description
  @_browse_description ||= ""
end

#browse_routes ⇒ Object 



26
27
28
 
# File 'lib/sinatra/browse.rb', line 26

def browse_routes
  @_browse_routes ||= {}
end

#browse_routes_for(request_method, path_info) ⇒ Object 



39
40
41
 
# File 'lib/sinatra/browse.rb', line 39

def browse_routes_for(request_method, path_info)
  browse_routes.values.find { |v| v.matches?(request_method, path_info) }
end

#default_on_error(&blk) ⇒ Object 



49
50
51
52
 
# File 'lib/sinatra/browse.rb', line 49

def default_on_error(&blk)
  @default_on_error = blk if block_given?
  @default_on_error
end

#describe(description) ⇒ Object Also known as: desc 



34
35
36
 
# File 'lib/sinatra/browse.rb', line 34

def describe(description)
  @_browse_description = description
end

#param(name, type, options = {}) ⇒ Object 



8
9
10
 
# File 'lib/sinatra/browse.rb', line 8

def param(name, type, options = {})
  temp_browse_params[name] = options.merge({ type: type })
end

#parameter_options(parameter, options) ⇒ Object Also known as: param_options 



12
13
14
15
 
# File 'lib/sinatra/browse.rb', line 12

def parameter_options(parameter, options)
  #TODO: Raise error when the parameter overridden doesn't exist
  temp_browse_params[parameter].merge! options
end

#reset_temp_params ⇒ Object 



22
23
24
 
# File 'lib/sinatra/browse.rb', line 22

def reset_temp_params
  @_temp_browse_params = {}
end

#set_browse_routes_for(request_method, path_info, description = browse_description, new_params = temp_browse_params) ⇒ Object

TODO: Rename method… It doesn’t sound like we’d be creating a new route object here



44
45
46
47
 
# File 'lib/sinatra/browse.rb', line 44

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

#temp_browse_params ⇒ Object 



18
19
20
 
# File 'lib/sinatra/browse.rb', line 18

def temp_browse_params
  @_temp_browse_params ||= reset_temp_params
end