Module: ApiMe

Extended by:
ActiveSupport::Concern
Includes:
Pundit
Defined in:
lib/api_me.rb,
lib/api_me/model.rb,
lib/api_me/engine.rb,
lib/api_me/sorting.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, Engine, Model, Pagination, Sorting

Constant Summary collapse

VERSION = 
'0.9.4'.freeze

Instance Method Summary collapse

Instance Method Details

#create ⇒ Object 



91
92
93
94
95
96
97
98
99
 
# File 'lib/api_me.rb', line 91

def create
  @object = build_resource
  authorize_resource @object
  @object.save!(object_params)

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

#destroy ⇒ Object 



118
119
120
121
122
123
124
125
126
 
# File 'lib/api_me.rb', line 118

def destroy
  @object = find_resource
  authorize_resource @object
  @object.destroy

  head 204
rescue ActiveRecord::RecordInvalid => e
  handle_errors(e)
end

#edit ⇒ Object 



101
102
103
104
105
106
 
# File 'lib/api_me.rb', line 101

def edit
  @object = find_resource
  authorize_resource @object

  render_errors(['edit endpoint not supported'], 404)
end

#index ⇒ Object

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.



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

def index
  @policy_scope = policy_scope(resource_scope)
  @filter_scope = filter_scope(@policy_scope)
  @sorted_scope = sort_scope(@filter_scope)
  @pagination_object = paginate_scope(@sorted_scope, page_params)

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

#new ⇒ Object 



84
85
86
87
88
89
 
# File 'lib/api_me.rb', line 84

def new
  @object = model_klass.new
  authorize_resource @object

  render_errors(['new endpoint not supported'], 404)
end

#show ⇒ Object 



77
78
79
80
81
82
 
# File 'lib/api_me.rb', line 77

def show
  @object = find_resource
  authorize_resource @object

  render json: @object, root: singular_root_key, serializer: serializer_klass
end

#update ⇒ Object 



108
109
110
111
112
113
114
115
116
 
# File 'lib/api_me.rb', line 108

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

  head 204
rescue ActiveRecord::RecordInvalid => e
  handle_errors(e)
end