api_me 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6edbf66319db35e695cd3b4b686e3b5688a2c2fe56d108eb954976732bc11bb5
-  data.tar.gz: 6063c1ca77185b64178360c103f6c3511b6fe9652575ee00da2a99d97d626dfc
+  metadata.gz: 9646af7af8c9ba9da48b8655d133eaea222e669a916435eb86670c2ab19aa848
+  data.tar.gz: c580cea45bc61f08bb8cadb103db8090b7d87f7e560d7859d990dfa256735f6a
 SHA512:
-  metadata.gz: d08b61cc42bcaa27102961bea0b54c651e1fa18adbc7034d69531147076e1acdcd5fd09204c83741880b8b527a6269d0ee2634e339159910dd043a7b8bb664c4
-  data.tar.gz: 7c610c2d85ca5009c265c1456e9c3e21d653a762e933ce8f00d6f245dd2efa57fa480c9feee608a9c52a4ff2299bb3f4ed6fd60b471989fb9071e04ffca37589
+  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
@@ -76,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
@@ -129,6 +154,18 @@ module ApiMe
 
   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

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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_me
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Sam Clopton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-31 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