events_photos_controller.rb

# encoding: utf-8

# @api public
# @version 1.0
class Api::EventsPhotosController < Api::ApplicationController

  # Фотография события
  #
  # - id: Дата и время подготовки ответа
  # - event_id: Id события
  # - url: Фотография события
  # - preview_url: Изображение 100x100
  # - updated_at: Время последнего обновления записи
  #
  # @example [Request]
  #  GET /api/events_photos/2523
  # @example [Response]
  #  {
  #    "id":2523,
  #    "event_slug":"knowledge_stream_ross_meyfild_sotsialnye_seti_vmeste_luchshe_bystree",
  #    "url":"/system/img/event_photos/2523/original.jpg",
  #    "preview_url":"/system/img/event_photos/2523/preview.jpg",
  #    "updated_at":"2012-07-04T21:33:44+04:00"
  #  }
  #
  # @overload show(id, locale = nil)
  #   @param [Integer] id Id фотографии
  #   @param [String] locale Установить локаль явно. Возможные значения: ru/en
  def show
    @event_photo = EventPhoto.find(params[:id])
  end

  # Список фотографии событий
  #
  # - generated_at: Дата и время подготовки ответа
  # - count: Количество фотографий в ответе (странице)
  # - total_count: Количество фотографий в выборке
  # - page: Текущая страница
  # - pages: Всего страниц
  # - has_more: Есть данные на следующей странице
  # - events_photos: [event_photo, event_photo, ...]
  #
  # @example [Request]
  #   GET /api/events_photos?since=2012-05-29T21:51:27+04:00&page=2&per_page=10
  # @example [Response]
  #  {
  #    "generated_at":"2012-07-07T17:04:27+04:00",
  #    "count":10,
  #    "total_count":794,
  #    "page":2,
  #    "pages":80,
  #    "has_more":true,
  #    "events_photos":[event_photo, event_photo, ...]
  #  }
  #
  # @overload index(since, page = 1, per_page = 30, locale = nil)
  #   @param [DateTime] since Начиная с определенного времени. Если параметр не задан, то возвращаются все записи.
  #   @param [Integer] page Номер страницы.
  #   @param [Integer] per_page Количество записей в странице.
  #   @param [String] locale Установить локаль явно. Возможные значения: ru/en
  def index
    @events_photos = Filter.build(EventPhoto.by_updated_at, params, [:since, :page])
  end
end