api_me 0.10.7 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19d6a0588c78c9c54147a063e94ad1bce087748819f1c422c847d351ce3df156
-  data.tar.gz: 3dd3e873f6aa2518fee3a85d804d084822dac85dfa2a130c8d472a56d2cf7b5c
+  metadata.gz: b406ddb8c9fb3a865f90531fc62819b2e6d3870b45c2e11c20975ead90fb6345
+  data.tar.gz: 7a31d26119457065f33a499c0ff6913a3a0eed34c460ec878d60935458b23b76
 SHA512:
-  metadata.gz: 1bd2149f84f9f7a76fe8fa39875b6a133ef19e707b634ded5c16607ca1007a5122593ea3b3cb8c8f757f6311828227ff7429f3ac915038fcac91a558ac1a787a
-  data.tar.gz: 8438532c00323267eb7b4303af85948712b3821e5993b1d212441a7249cd3a00e9fedccdce32ef62b223cb7f716b21a48574390ba757636c93c352d5b4e58434
+  metadata.gz: 7d5fdc0406b3ba44ead6d00957966cfa3f734f62444594dd66ad3149ca115ebe916e828c8e3ba70cc3107537f67c58ef8e78fbaf6e0f463034be4737e793249c
+  data.tar.gz: 41267c7fb138975facca66c4f56929e7872459e6986f283a3f344efd4f4342f7423a07086724b685c7185967b029afd2fb4d66d8a7206211d4bc312dd8e547b5

data/lib/api_me.rb

@@ -9,14 +9,19 @@ require 'api_me/version'
 require 'api_me/base_filter'
 require 'api_me/sorting'
 require 'api_me/pagination'
+require 'api_me/csv_stream_writer'
 
 module ApiMe
   extend ActiveSupport::Concern
-  include ::Pundit
 
   included do
+    include ::Pundit
+    include ActionController::Live
+
     rescue_from Pundit::NotAuthorizedError, with: :user_not_authorized
     rescue_from ActiveRecord::RecordInvalid, with: :handle_active_record_errors
+    rescue_from ActiveRecord::RecordNotDestroyed, with: :handle_active_record_errors
+    rescue_from ActiveRecord::ReadOnlyRecord, with: :handle_active_record_errors
     rescue_from ActiveRecord::RecordNotFound, with: :resource_not_found
   end
 
@@ -74,15 +79,39 @@ module ApiMe
     @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,
-        sort: sorting_meta(@filter_scope)
-      }
-    )
+    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
 
   def show
@@ -93,7 +122,7 @@ module ApiMe
   end
 
   def new
-    render_errors(['new endpoint not supported'], 404)
+    render_errors(['new endpoint not supported'], :not_found)
   end
 
   def create
@@ -101,11 +130,11 @@ module ApiMe
     authorize_resource @object
     create_resource!
 
-    render status: 201, json: @object, root: singular_root_key, serializer: serializer_klass
+    render status: :created, json: @object, root: singular_root_key, serializer: serializer_klass
   end
 
   def edit
-    render_errors(['edit endpoint not supported'], 404)
+    render_errors(['edit endpoint not supported'], :not_found)
   end
 
   def update
@@ -114,7 +143,7 @@ module ApiMe
     authorize_resource @object
     update_resource!
 
-    head 204
+    render status: :ok, json: @object, root: singular_root_key, serializer: serializer_klass
   end
 
   def destroy
@@ -122,11 +151,23 @@ module ApiMe
     authorize_resource @object
     destroy_resource!
 
-    head 204
+    head :no_content
   end
 
   protected
 
+  def csv_filename
+    "#{model_klass.name.dasherize}-#{Time.zone.now.to_date.to_s(:default)}.csv"
+  end
+
+  def csv_headers
+    model_klass.respond_to?('csv_headers') ? model_klass.csv_headers : []
+  end
+
+  def csv_includes_scope(scope)
+    scope
+  end
+
   def singular_root_key
     model_klass.name.singularize.underscore
   end
@@ -147,7 +188,7 @@ module ApiMe
     params[:sort]
   end
 
-  def render_errors(errors, status = 422)
+  def render_errors(errors, status = :unprocessable_entity)
     render(json: { errors: errors }, status: status)
   end
 
@@ -159,11 +200,11 @@ module ApiMe
 
   def user_not_authorized
     payload = { message: "User is not allowed to access #{params[:action]} on this resource" }
-    render json: payload, status: 403
+    render json: payload, status: :forbidden
   end
 
   def resource_not_found
-    head 404
+    head :not_found
   end
 
   def model_klass
@@ -225,7 +266,7 @@ module ApiMe
   end
 
   def find_resource
-    @find_resource ||= model_klass.find_by_id!(params[:id])
+    @find_resource ||= model_klass.find_by!(id: params[:id])
   end
 
   def build_resource
@@ -233,11 +274,11 @@ module ApiMe
   end
 
   def create_resource!
-    @object.save!(object_params)
+    @object.save!
   end
 
   def update_resource!
-    @object.save!(object_params)
+    @object.save!
   end
 
   def destroy_resource!

data/lib/api_me/csv_stream_writer.rb

@@ -0,0 +1,32 @@
+require 'csv'
+# frozen_string_literal: true
+
+module ApiMe
+  class CsvStreamWriter
+    # @!attribute [r] stream
+    #   @return [IO]
+    attr_reader :stream
+
+    # Provides a similar interface to CSV.generate but compatible with an IO stream
+    # @example
+    #   CsvStreamWriter.generate(stream) do |csv|
+    #     csv << ['foo', 'bar']
+    #   end
+    #
+    # @param [IO]
+    # @yield [CsvStreamWriter] csv
+    def self.generate(stream)
+      yield new(stream)
+    end
+
+    # @param [IO]
+    def initialize(stream)
+      @stream = stream
+    end
+
+    # @param [Array<String>]
+    def <<(row)
+      stream.write CSV.generate_line(row)
+    end
+  end
+end

data/lib/api_me/sorting.rb

@@ -2,13 +2,16 @@
 
 module ApiMe
   class Sorting
-    attr_accessor :sort_criteria, :sort_reverse, :scope
+    attr_accessor :sort_criteria, :sort_reverse, :scope, :custom_sort_options
 
-    def initialize(scope:, sort_params:)
+    def initialize(scope:, sort_params:, custom_sort_options: {})
       self.scope = scope
+
       return unless sort_params
+
       self.sort_criteria = sort_params[:criteria] || default_sort_criteria
       self.sort_reverse = sort_params[:reverse] || false
+      self.custom_sort_options = custom_sort_options
     end
 
     def results
@@ -39,7 +42,14 @@ module ApiMe
     end
 
     def sorted_scope(criteria)
-      if sort_reverse === 'true'
+      criteria_key = criteria.to_sym
+      if custom_sort_options.key?(criteria_key)
+        if sort_reverse == 'true'
+          custom_sort_scope(criteria_key).order(Arel.sql("#{custom_sort_options[criteria_key][:column]} DESC"))
+        else
+          custom_sort_scope(criteria_key).order(Arel.sql("#{custom_sort_options[criteria_key][:column]} ASC"))
+        end
+      elsif sort_reverse == 'true'
         scope.order(criteria => :desc)
       else
         scope.order(criteria => :asc)
@@ -48,6 +58,10 @@ module ApiMe
 
     private
 
+    def custom_sort_scope(criteria)
+      custom_sort_options[criteria].key?(:joins) ? scope.joins(custom_sort_options[criteria][:joins]) : scope
+    end
+
     def default_sort_criteria
       'id'
     end

data/lib/api_me/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApiMe
-  VERSION = '0.10.7'
+  VERSION = '0.14.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_me
 version: !ruby/object:Gem::Version
-  version: 0.10.7
+  version: 0.14.1
 platform: ruby
 authors:
 - Sam Clopton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-14 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -162,6 +162,7 @@ files:
 - Rakefile
 - lib/api_me.rb
 - lib/api_me/base_filter.rb
+- lib/api_me/csv_stream_writer.rb
 - lib/api_me/engine.rb
 - lib/api_me/model.rb
 - lib/api_me/pagination.rb
@@ -199,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Api Me