streamy_csv 0.3.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24325070ca75478285318b9b6e0123ef9984cca3
+  data.tar.gz: 47cda2132e14791c76233c269ad967d906b81cdb
+SHA512:
+  metadata.gz: b816608ce3cac24b1f930b44b05229fcaf1400b36dd673b47632f4c7df258971bcb1132357a2b0311be5a1bcc357baf362835a8de2ce440fecf81d5b30c9cc27
+  data.tar.gz: 201fa74a9696bacdbfa0928c27674a58b30f65cae3c13f2a50b41bef7741d1c13bbd194e1686b77a77ad30903a8e25f5efa3465805e08f4108560b500e5132fa

data/.travis.yml

@@ -0,0 +1,4 @@
+dist: trusty
+sudo: false
+rvm: 2.2.7
+script: "rake"

data/README.md

@@ -1,6 +1,9 @@
 # StreamyCsv
 
-Streams CSV files one row at a time as live data is generated instead of waiting for the whole file to be created and then sent to the client. Works on most standard web servers including Nginx, Passenger, Unicorn, Thin etc., but does NOT work on Webrick.
+StreamyCSV streams CSV files one row at a time as live data is generated instead of waiting for the whole file to be created and then sent to the client. Works on most standard web servers including Nginx, Passenger, Unicorn, Thin etc., but does NOT work on Webrick.
+
+## Build Status
+[![Build Status](https://travis-ci.org/smsohan/streamy_csv.png)](https://travis-ci.org/smsohan/streamy_csv)
 
 ## Installation
 
@@ -22,11 +25,11 @@ In your model:
     class MyModel
 
       def self.header_row
-        CSV::Row([:name, :title], ['Name', 'Title'], true)
+        CSV::Row.new([:name, :title], ['Name', 'Title'], true)
       end
 
       def to_csv_row
-        CSV::Row([:name, :title], ['John', 'Mr'])
+        CSV::Row.new([:name, :title], ['John', 'Mr'])
       end
 
     end

data/lib/streamy_csv/version.rb

@@ -1,3 +1,3 @@
 module StreamyCsv
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/streamy_csv.rb

@@ -1,6 +1,8 @@
 require "streamy_csv/version"
 
 module StreamyCsv
+  CSV_OPERATORS = ['+','-','=','@','%']
+  UNESCAPED_PIPES_RGX = /(?<!\\)(?:\\{2})*\K\|/
 
   # stream_csv('data.csv', MyModel.header_row) do |rows|
   #   MyModel.find_each do |my_model|
@@ -10,13 +12,13 @@ module StreamyCsv
   #
   #
 
-  def stream_csv(file_name, header_row, &block)
+  def stream_csv(file_name, header_row, sanitize = true, &block)
     set_streaming_headers
     set_file_headers(file_name)
 
     response.status = 200
 
-    self.response_body = csv_lines(header_row, &block)
+    self.response_body = csv_lines(header_row, sanitize, &block)
   end
 
   protected
@@ -27,13 +29,31 @@ module StreamyCsv
     headers.delete("Content-Length")
   end
 
-  def csv_lines(header_row, &block)
-
-    Enumerator.new do |rows|
-      rows << header_row.to_s if header_row
+  def csv_lines(header_row, sanitize, &block)
+    Enumerator.new do |yielder|
+      rows = appendHeader([], header_row, sanitize)
       block.call(rows)
+      rows.each do |row|
+        sanitize!(row) if sanitize
+        yielder.yield row
+      end
+    end
+  end
+
+  def appendHeader(rows, header_row, sanitize)
+    if header_row && header_row.any?
+      sanitize! header_row if sanitize
+      rows << header_row.to_s
     end
+    rows
+  end
 
+  def sanitize!(enumerable)
+    return unless enumerable && enumerable.is_a?(Enumerable)
+    enumerable = enumerable.fields if enumerable.is_a?(CSV::Row)
+    enumerable.each do |field|
+      field.gsub!(UNESCAPED_PIPES_RGX,'\|') if field.is_a?(String) && field.start_with?(*CSV_OPERATORS)        
+    end
   end
 
   def set_file_headers(file_name)
@@ -43,4 +63,4 @@ module StreamyCsv
 
 end
 
-ActionController::Base.send :include, StreamyCsv
+ActionController::Base.send :include, StreamyCsv

data/spec/streamy_csv_spec.rb

@@ -59,6 +59,40 @@ describe StreamyCsv do
       @controller.response.status.should == 200
       @controller.response_body.is_a?(Enumerator).should == true
     end
+    it 'sanitizes header and contents and streams the csv file' do
+      row_1 = CSV::Row.new([:name, :title], ['AB', 'Mr'])
+      row_2 = CSV::Row.new([:name, :title], ["=cmd|' /C", 'Pres'])
+      header = [:name, "=cmd|' /C"]
+      rows = [header, row_1]
+
+      @controller.stream_csv('abc.csv', @header) do |rows|
+        rows << row_1
+        rows << row_2
+      end
+      @controller.response.status.should == 200
+      @controller.response_body.is_a?(Enumerator).should == true
+      @controller.response_body.take(1)[0].to_s[4].bytes == '\\'.bytes
+      @controller.response_body.take(1)[0].to_s[5].bytes == '|'.bytes
+      @controller.response_body.take(3)[2].to_s[4].bytes == '\\'.bytes
+      @controller.response_body.take(3)[2].to_s[5].bytes == '|'.bytes
+    end
+    it 'does not sanitize the csv if the option provided' do
+      row_1 = CSV::Row.new([:name, :title], ['AB', 'Mr'])
+      row_2 = CSV::Row.new([:name, :title], ["=cmd|' /C", 'Pres'])
+      header = [:name, "=cmd|' /C"]
+      rows = [header, row_1]
+
+      @controller.stream_csv('abc.csv', @header, false) do |rows|
+        rows << row_1
+        rows << row_2
+      end
+      @controller.response.status.should == 200
+      @controller.response_body.is_a?(Enumerator).should == true
+      @controller.response_body.take(1)[0].to_s[4].bytes == 'd'.bytes
+      @controller.response_body.take(1)[0].to_s[5].bytes == '|'.bytes
+      @controller.response_body.take(3)[2].to_s[4].bytes == 'd'.bytes
+      @controller.response_body.take(3)[2].to_s[5].bytes == '|'.bytes
+    end
   end
 
 end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: streamy_csv
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - smsohan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-10 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Streamy CSV lets you stream live generated CSV files
@@ -34,8 +31,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -46,27 +44,26 @@ files:
 - streamy_csv.gemspec
 homepage: https://github.com/smsohan/streamy_csv
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Provides a simple API for your controllers to stream CSV files one row at
   a time
 test_files: