before_action :catch_redirect_hint
before_action :load_required_parameters
- before_action(:find_object_by_uuid,
- except: [:index, :create] + ERROR_ACTIONS)
- before_action(:set_nullable_attrs_to_null, only: [:update, :create])
before_action :load_limit_offset_order_params, only: [:index, :contents]
+ before_action :load_select_param
+ before_action(:find_object_by_uuid,
+ except: [:index, :create, :update] + ERROR_ACTIONS)
+ before_action :find_object_for_update, only: [:update]
before_action :load_where_param, only: [:index, :contents]
before_action :load_filters_param, only: [:index, :contents]
before_action :find_objects_for_index, :only => :index
+ before_action(:set_nullable_attrs_to_null, only: [:update, :create])
before_action :reload_object_before_update, :only => :update
before_action(:render_404_if_no_object,
except: [:index, :create] + ERROR_ACTIONS)
end
def show
- send_json @object.as_api_response(nil, select: @select)
+ send_json @object.as_api_response(nil, select: select_for_klass(@select, model_class))
end
def create
end
err[:errors] ||= args
err[:errors].map! do |err|
- err += " (" + Thread.current[:request_id] + ")"
+ err += " (#{request.request_id})"
end
err[:error_token] = [Time.now.utc.to_i, "%08x" % rand(16 ** 8)].join("+")
status = err.delete(:status) || 422
@objects = model_class.apply_filters(@objects, @filters)
end
+ def select_for_klass sel, model_class
+ # Filter the select fields to only the ones that apply to the
+ # given class.
+ sel.map do |column|
+ sp = column.split(".")
+ if sp.length == 2 && sp[0] == model_class.table_name
+ sp[1]
+ elsif model_class.selectable_attributes.include? column
+ column
+ else
+ nil
+ end
+ end.compact
+ end
+
def apply_where_limit_order_params model_class=nil
model_class ||= self.model_class
apply_filters model_class
# Map attribute names in @select to real column names, resolve
# those to fully-qualified SQL column names, and pass the
# resulting string to the select method.
- columns_list = model_class.columns_for_attributes(@select).
+ columns_list = model_class.columns_for_attributes(select_for_klass @select, model_class).
map { |s| "#{ar_table_name}.#{ActiveRecord::Base.connection.quote_column_name s}" }
@objects = @objects.select(columns_list.join(", "))
end
@objects = @objects.order(@orders.join ", ") if @orders.any?
@objects = @objects.limit(@limit)
@objects = @objects.offset(@offset)
- @objects = @objects.distinct(@distinct) if not @distinct.nil?
+ @objects = @objects.distinct() if @distinct
end
# limit_database_read ensures @objects (which must be an
return if @limit == 0 || @limit == 1
model_class ||= self.model_class
limit_columns = model_class.limit_index_columns_read
- limit_columns &= model_class.columns_for_attributes(@select) if @select
+ limit_columns &= model_class.columns_for_attributes(select_for_klass @select, model_class) if @select
return if limit_columns.empty?
model_class.transaction do
limit_query = @objects.
if not current_user
respond_to do |format|
format.json { send_error("Not logged in", status: 401) }
- format.html { redirect_to '/auth/joshid' }
+ format.html { redirect_to '/login' }
end
false
end
end
def set_current_request_id
- req_id = request.headers['X-Request-Id']
- if !req_id || req_id.length < 1 || req_id.length > 1024
- # Client-supplied ID is either missing or too long to be
- # considered friendly.
- req_id = "req-" + Random::DEFAULT.rand(2**128).to_s(36)[0..19]
- end
- response.headers['X-Request-Id'] = Thread.current[:request_id] = req_id
- Rails.logger.tagged(req_id) do
+ Rails.logger.tagged(request.request_id) do
yield
end
- Thread.current[:request_id] = nil
end
def append_info_to_payload(payload)
super
- payload[:request_id] = response.headers['X-Request-Id']
+ payload[:request_id] = request.request_id
payload[:client_ipaddr] = @remote_ip
payload[:client_auth] = current_api_client_authorization.andand.uuid || nil
end
controller_name
end
- def find_object_by_uuid
+ def find_object_for_update
+ find_object_by_uuid(with_lock: true)
+ end
+
+ def find_object_by_uuid(with_lock: false)
if params[:id] and params[:id].match(/\D/)
params[:uuid] = params.delete :id
end
@filters = []
@objects = nil
find_objects_for_index
- @object = @objects.first
+ if with_lock && Rails.configuration.API.LockBeforeUpdate
+ @object = @objects.lock.first
+ else
+ @object = @objects.first
+ end
end
def nullable_attributes
:self_link => "",
:offset => @offset,
:limit => @limit,
- :items => @objects.as_api_response(nil, {select: @select})
+ :items => @objects.as_api_response(nil, {select: select_for_klass(@select, model_class)})
}
if @extra_included
- list[:included] = @extra_included.as_api_response(nil, {select: @select})
+ list[:included] = @extra_included.as_api_response(nil, {select: select_for_klass(@select, model_class)})
end
case params[:count]
when nil, '', 'exact'
if @objects.respond_to? :except
list[:items_available] = @objects.
except(:limit).except(:offset).
- distinct.count(:id)
+ count(@distinct ? :id : '*')
end
when 'none'
else
def self._create_requires_parameters
{
+ select: {
+ type: 'array',
+ description: "Attributes of the new object to return in the response.",
+ required: false,
+ },
ensure_unique_name: {
type: "boolean",
description: "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
end
def self._update_requires_parameters
- {}
+ {
+ select: {
+ type: 'array',
+ description: "Attributes of the updated object to return in the response.",
+ required: false,
+ },
+ }
+ end
+
+ def self._show_requires_parameters
+ {
+ select: {
+ type: 'array',
+ description: "Attributes of the object to return in the response.",
+ required: false,
+ },
+ }
end
def self._index_requires_parameters
filters: { type: 'array', required: false },
where: { type: 'object', required: false },
order: { type: 'array', required: false },
- select: { type: 'array', required: false },
- distinct: { type: 'boolean', required: false },
+ select: {
+ type: 'array',
+ description: "Attributes of each object to return in the response.",
+ required: false,
+ },
+ distinct: { type: 'boolean', required: false, default: false },
limit: { type: 'integer', required: false, default: DEFAULT_LIMIT },
offset: { type: 'integer', required: false, default: 0 },
count: { type: 'string', required: false, default: 'exact' },
}
end
- def client_accepts_plain_text_stream
- (request.headers['Accept'].split(' ') &
- ['text/plain', '*/*']).count > 0
- end
-
def render *opts
if opts.first
response = opts.first[:json]