rails_stream_file 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e67f8bf1b1829cc5b7a3d4e9ef5e20477e5377b0
+  data.tar.gz: a9a9d0d53404e336939214e914f117650b2b997f
+SHA512:
+  metadata.gz: b7584ce3a883ddfaf6d5d84d1cbd5bd8d5d72b049f9a5bac214bb7cea19820e04bbb5645a3b5adbf3216b7e46211b0e61e2735b867be66f253398f70de17380f
+  data.tar.gz: 21145a5b678aacd0359aa6335165a8b81ca3d13f766273da23ecedc760873bdd607deae09b0d7e678e5cc946e9635e7fc0c23830bb107ad5fe932a5dbca250db

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails-stream_file.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Bernardo Farah
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Rails::StreamFile
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_stream_file', git: 'https://github.com/berfarah/rails_stream_file', require: "rails/stream_file"
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Adds `stream_file` method to rails which takes an enumerator to output a binary file. Example usage below:
+
+```ruby
+require "csv"
+class EnumerableObject
+  def each(&block)
+    block.call %w(My Headers Go Here).to_csv
+    block.call [1, 2, 3, 4].to_csv
+    [
+      [123, 123, 123, 123],
+      [123, 123, 123, 123]
+    ].each { |e| block.call(e.to_csv) }
+  end
+end
+
+class MyController < ActionController::Base
+  def show
+    stream_file EnumerableObject.new, filename: "example.csv", mimetype: "text/csv"
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake rspec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rails/stream_file.rb

@@ -0,0 +1,29 @@
+module Rails
+  # Include this to have a streamable file
+  module StreamFile
+    VERSION = "0.0.1"
+
+    private
+
+      def stream_file(enum, filename: "example.txt",
+                                   mimetype: "text/plain")
+        file_headers(filename, mimetype)
+        streaming_headers
+        response.status = 200
+        self.response_body = enum
+      end
+
+      def file_headers(filename, mimetype)
+        headers["Content-Type"] = mimetype
+        headers["Content-Disposition"] = "attachment; filename=\"#{filename}\""
+        headers["Content-Transfer-Encoding"] = "binary"
+        headers["Last-Modified"] = Time.now.ctime.to_s
+      end
+
+      def streaming_headers
+        headers["X-Accel-Buffering"] = "no"
+        headers["Cache-Control"] ||= "no-cache"
+        headers.delete("Content-Length")
+      end
+  end
+end

data/rails_stream_file.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails/stream_file"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_stream_file"
+  spec.version       = Rails::StreamFile::VERSION
+  spec.authors       = ["Bernardo Farah"]
+  spec.email         = ["bfarah@walmart.com"]
+
+  spec.summary       = "Add file streaming as a method in ActionController"
+  spec.description   = "Allows file streaming where files are enumerables"
+  spec.homepage      = "https://github.com/berfarah/rails_stream_file"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: rails_stream_file
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bernardo Farah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows file streaming where files are enumerables
+email:
+- bfarah@walmart.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rails/stream_file.rb
+- rails_stream_file.gemspec
+homepage: https://github.com/berfarah/rails_stream_file
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Add file streaming as a method in ActionController
+test_files: []
+has_rdoc: