Module: Sinatra::API::Helpers

Defined in:
lib/sinatra/api/helpers.rb

Instance Method Summary collapse

Instance Method Details

#__api_locate_resource(r, container = nil) ⇒ Object

Attempt to locate a resource based on an ID supplied in a request parameter.

If the param map contains a resource id (ie, :folder_id), we attempt to locate and expose it to the route.

A 404 is raised if:

  1. the scope is missing (@space for folder, @space or @folder for page)
  2. the resource couldn't be identified in its scope (@space or @folder)

If the resources were located, they're accessible using @folder or @page.

The route can be halted using the :requires => [] condition when it expects a resource.

Examples:

using :requires to reject a request with an invalid @page

get '/folders/:folder_id/pages/:page_id', :requires => [ :page ] do
  @page.show    # page is good
  @folder.show  # so is its folder
end



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/sinatra/api/helpers.rb', line 171

def __api_locate_resource(r, container = nil)

  resource_id = params[r + '_id'].to_i
  rklass      = r.camelize

  collection = case
  when container.nil?;  eval "#{ResourcePrefix}#{rklass}"
  else;                 container.send("#{r.to_plural}")
  end

  puts "locating resource #{r} with id #{resource_id} from #{collection} [#{container}]"

  resource = collection.get(resource_id)

  if !resource
    m = "No such resource: #{rklass}##{resource_id}"
    if container
      m << " in #{container.class.name.to_s}##{container.id}"
    end

    halt 404, m
  end

  if respond_to?(:can?)
    unless can? :access, resource
      halt 403, "You do not have access to this #{rklass} resource."
    end
  end

  instance_variable_set('@'+r, resource)

  API.aliases_for(r).each { |resource_alias|
    instance_variable_set('@'+resource_alias, resource)
    puts "API: resource #{rklass} exported to @#{resource_alias}"
  }

  resource
end

#api_call? ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
35
 
# File 'lib/sinatra/api/helpers.rb', line 32

def api_call?
  (request.accept || '').to_s.include?('json') ||
  (request.content_type||'').to_s.include?('json')
end

#api_clear! ⇒ Object Also known as: api_reset! 



145
146
147
 
# File 'lib/sinatra/api/helpers.rb', line 145

def api_clear!()
  @api = { required: {}, optional: {} }
end

#api_consume!(keys) ⇒ Object

Consumes supplied parameters with the given keys from the API parameter map, and yields the consumed values for processing by the supplied block (if any).

This is useful if:

  1. a certain parameter does not correspond to a model attribute and needs to be renamed, or is used in a validation context
  2. the data needs special treatment
  3. the data needs to be (re)formatted


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/sinatra/api/helpers.rb', line 98

def api_consume!(keys)
  out  = nil

  keys = [ keys ] unless keys.is_a?(Array)
  keys.each do |k|
    if val = @api[:required].delete(k.to_sym)
      out = val
      out = yield(val) if block_given?
    end

    if val = @api[:optional].delete(k.to_sym)
      out = val
      out = yield(val) if block_given?
    end
  end

  out
end

#api_has_param?(key) ⇒ Boolean

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/sinatra/api/helpers.rb', line 127

def api_has_param?(key)
  @api[:optional].has_key?(key)
end

#api_optional!(args, h = params) ⇒ Object

Same as #api_required! except that fields defined in this map are optional and will be used only if they're supplied.

See Also:



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/sinatra/api/helpers.rb', line 77

def api_optional!(args, h = params)
  args.each_pair { |name, cnd|
    if cnd.is_a?(Hash)
      api_optional!(cnd, h[name])
      next
    end

    parse_api_argument(h, name, cnd, :optional)
  }
end

#api_param(key) ⇒ Object 



131
132
133
 
# File 'lib/sinatra/api/helpers.rb', line 131

def api_param(key)
  @api[:optional][key.to_sym] || @api[:required][key.to_sym]
end

#api_params(q = {}) ⇒ Object

Returns a Hash of the supplied request parameters. Rejects any parameter that was not defined in the REQUIRED or OPTIONAL maps (or was consumed).

Parameters:

  • Hash —

    q A Hash of attributes to merge with the parameters, useful for defining defaults



141
142
143
 
# File 'lib/sinatra/api/helpers.rb', line 141

def api_params(q = {})
  @api[:optional].deep_merge(@api[:required]).deep_merge(q)
end

#api_required!(args, h = params) ⇒ Object

Note:

The supplied value passed to validation blocks is not pre-processed, so you must make sure that you check for nils or bad values in validator blocks!

Define the required API arguments map. Any item defined not found in the supplied parameters of the API call will result in a 400 RC with a proper message marking the missing field.

The map is a Hash of parameter keys and optional validator blocks.

Each entry can be optionally mapped to a validation proc that will be invoked if the field was supplied. The proc will be passed the value of the field.

If the value is invalid and you need to suspend the request, you must return a String object with an appropriate error message.

Examples:

A map of required API call arguments

api_required!({ title: nil, user_id: nil })

Rejecting a title if it's rude

api_required!({
  :title => lambda { |t| return "Don't be rude" if t && t =~ /rude/ }
})



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/sinatra/api/helpers.rb', line 62

def api_required!(args, h = params)
  args.each_pair { |name, cnd|
    if cnd.is_a?(Hash)
      api_required!(cnd, h[name])
      next
    end

    parse_api_argument(h, name, cnd, :required)
  }
end

#api_transform!(key, &handler) ⇒ Object 



117
118
119
120
121
122
123
124
125
 
# File 'lib/sinatra/api/helpers.rb', line 117

def api_transform!(key, &handler)
  if val = @api[:required][key.to_sym]
    @api[:required][key.to_sym] = yield(val) if block_given?
  end

  if val = @api[:optional][key.to_sym]
    @api[:optional][key.to_sym] = yield(val) if block_given?
  end
end