Module: ApiMe

Extended by:
ActiveSupport::Concern
Includes:
Pundit
Defined in:
lib/api_me.rb,
lib/api_me/version.rb,
lib/api_me/pagination.rb,
lib/api_me/base_filter.rb,
lib/generators/api_me/install_generator.rb,
lib/generators/api_me/filter/filter_generator.rb,
lib/generators/api_me/policy/policy_generator.rb,
lib/generators/api_me/resource/resource_generator.rb,
lib/generators/api_me/controller/controller_generator.rb

Defined Under Namespace

Modules: ClassMethods, Generators Classes: BaseFilter, Pagination

Constant Summary collapse

VERSION =
'0.5.0'

Instance Method Summary collapse

Instance Method Details

#createObject



86
87
88
89
90
91
92
93
94
# File 'lib/api_me.rb', line 86

def create
  @object = model_klass.new(object_params)
  authorize @object
  @object.save!(object_params)

  render status: 201, json: @object, serializer: serializer_klass
rescue ActiveRecord::RecordInvalid => e
  handle_errors(e)
end

#destroyObject



106
107
108
109
110
111
112
# File 'lib/api_me.rb', line 106

def destroy
  @object = find_resource
  authorize @object
  @object.destroy

  render status: 204, nothing: true
end

#indexObject

Currently merge params in filters hash to support common use case of filtering ids using the top level ids array param. Would eventually like to move to support the jsonapi.org standard closer.



67
68
69
70
71
72
73
74
75
76
77
# File 'lib/api_me.rb', line 67

def index
  ids_filter_hash = params[:ids] ? { ids: params[:ids] } : {}
  @scoped_objects = policy_scope(resource_scope)
  @filter_object = filter_klass.new(
      scope: @scoped_objects,
      filters: (filter_params || {}).merge(ids_filter_hash)
  )
  @pagination_object = ApiMe::Pagination.new(scope: @filter_object.results, page_params: params[:page])

  render json: @pagination_object.results, each_serializer: serializer_klass, meta: { page: @pagination_object.page_meta }
end

#showObject



79
80
81
82
83
84
# File 'lib/api_me.rb', line 79

def show
  @object = find_resource
  authorize @object

  render json: @object, serializer: serializer_klass
end

#updateObject



96
97
98
99
100
101
102
103
104
# File 'lib/api_me.rb', line 96

def update
  @object = find_resource
  authorize @object
  @object.update!(object_params)

  render status: 204, nothing: true
rescue ActiveRecord::RecordInvalid => e
  handle_errors(e)
end