api_me 0.10.6 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64522583b827ed64ae2f0d8d8f12ec7c2afbacbad196bad0061c9079ec622fba
-  data.tar.gz: 4f3fd8c3740418a5e211526a2d9bd76ab16dbaa26aec211e62d84b4ca37a268f
+  metadata.gz: 9646af7af8c9ba9da48b8655d133eaea222e669a916435eb86670c2ab19aa848
+  data.tar.gz: c580cea45bc61f08bb8cadb103db8090b7d87f7e560d7859d990dfa256735f6a
 SHA512:
-  metadata.gz: 77493e6cd629345dde520b41432c78c37fecfc331a88ffd1e9042d8cc94460b2951c5395330dec1202a2d20f7edfe84dd45835622959a01a976394166a71f702
-  data.tar.gz: 29726f428276b1ac44422216a06a89035d98f2a1da7aee9feb5bc95a0761517cb8e3dd08b261a79135155978d2e303b288c1e23617c7d509834b1a9cea770dae
+  metadata.gz: 8e5bf1017206e3569e3998b419e4cd310ba80ab6787f2d71e317bc3880e99a1f32e29d3eb4d4355dc357a9c1429a1aa2f35e8a7fc6003da0faa65f0726e59189
+  data.tar.gz: 482033012c3342badf0c2b1fbeb099a04b32d217ec50af2d4940bc1bb33bd96c6e26bc5d6ef7ddebeefeac7314415e022e998f40196d97c2656b7e899b33c8f9

data/lib/api_me.rb

@@ -9,6 +9,7 @@ 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
@@ -17,6 +18,8 @@ module ApiMe
   included do
     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 +77,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,10 +120,7 @@ module ApiMe
   end
 
   def new
-    @object = model_klass.new
-    authorize_resource @object
-
-    render_errors(['new endpoint not supported'], 404)
+    render_errors(['new endpoint not supported'], :not_found)
   end
 
   def create
@@ -104,22 +128,20 @@ 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
-    @object = find_resource
-    authorize_resource @object
-
-    render_errors(['edit endpoint not supported'], 404)
+    render_errors(['edit endpoint not supported'], :not_found)
   end
 
   def update
     @object = find_resource
+    @object.assign_attributes(object_params)
     authorize_resource @object
     update_resource!
 
-    head 204
+    render status: :ok, json: @object, root: singular_root_key, serializer: serializer_klass
   end
 
   def destroy
@@ -127,11 +149,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
@@ -152,7 +186,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
 
@@ -164,11 +198,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
@@ -230,7 +264,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
@@ -238,11 +272,11 @@ module ApiMe
   end
 
   def create_resource!
-    @object.save!(object_params)
+    @object.save!
   end
 
   def update_resource!
-    @object.update!(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.6'
+  VERSION = '0.14.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_me
 version: !ruby/object:Gem::Version
-  version: 0.10.6
+  version: 0.14.0
 platform: ruby
 authors:
 - Sam Clopton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2020-12-22 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