Module: ApiMe

Extended by:
ActiveSupport::Concern
Defined in:
lib/api_me/csv_stream_writer.rb,
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

Overview

frozen_string_literal: true

Defined Under Namespace

Modules: ClassMethods, Generators Classes: BaseFilter, CsvStreamWriter, Engine, Model, Pagination, Sorting

Constant Summary collapse

VERSION = 
'0.14.2'

Instance Method Summary collapse

Instance Method Details

#create ⇒ Object 



128
129
130
131
132
133
134
 
# File 'lib/api_me.rb', line 128

def create
  @object = build_resource
  authorize_resource @object
  create_resource!

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

#destroy ⇒ Object 



149
150
151
152
153
154
155
 
# File 'lib/api_me.rb', line 149

def destroy
  @object = find_resource
  authorize_resource @object
  destroy_resource!

  head :no_content
end

#edit ⇒ Object 



136
137
138
 
# File 'lib/api_me.rb', line 136

def edit
  render_errors(['edit endpoint not supported'], :not_found)
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.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/api_me.rb', line 76

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)

  respond_to do |format|
    format.csv do
      @csv_includes_scope = csv_includes_scope(@sorted_scope)
      response.headers['Content-Type'] = 'text/csv'
      response.headers['Cache-Control'] = 'no-cache'
      # Hack to work around https://github.com/rack/rack/issues/1619
      response.headers['Last-Modified'] = Time.current.httpdate
      # Disable gzip in nginx
      response.headers['X-Accel-Buffering'] = 'no'
      response.headers['Content-Disposition'] = "attachment; filename=\"#{csv_filename}\""

      ::ApiMe::CsvStreamWriter.generate(response.stream) do |csv|
        # headers
        csv << csv_headers
        @csv_includes_scope.find_each do |object|
          csv << object.try('to_csv')
        end
      end
    ensure
      response.stream.close
    end
    format.all do
      render(
        json: @pagination_object.results,
        root: collection_root_key,
        each_serializer: serializer_klass,
        meta: {
          page: @pagination_object.page_meta,
          sort: sorting_meta(@filter_scope)
        }
      )
    end
  end
end

#new ⇒ Object 



124
125
126
 
# File 'lib/api_me.rb', line 124

def new
  render_errors(['new endpoint not supported'], :not_found)
end

#show ⇒ Object 



117
118
119
120
121
122
 
# File 'lib/api_me.rb', line 117

def show
  @object = find_resource
  authorize_resource @object

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

#update ⇒ Object 



140
141
142
143
144
145
146
147
 
# File 'lib/api_me.rb', line 140

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

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