s3streamer 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,57 @@
+# S3Streamer
+
+Send your files to the end user by streaming them from S3
+
+## Usage
+
+### Installation
+
+Add the gem to your Gemfile and Bundle :
+
+```ruby
+gem "s3streamer"
+```
+
+Install initializer file :
+
+```bash
+rails generate s3streamer:install
+```
+
+Edit the initializer file with your AWS S3 credentials and your bucket name,
+and restart your server.
+**Note**: You can avoid setting your bucket if you pass it directly to the
+`#stream_file` method options.
+
+### Controller
+
+Now, you can use the `#stream_file` method in your controllers.
+
+```ruby
+def download
+  stream_file("file/key.ext")
+end
+```
+
+It can also accept a `Paperclip::Attachment` object. This method will
+automatically add "content_type=xxx/xxx" to the Content-Disposition HTTP
+response header.
+
+```ruby
+def download
+  model = Model.find(params[:id])
+  stream_file(model.file)
+end
+```
+
+There also are options that you can pass :
+
+```ruby
+def download
+  stream_file("file/key.ext", {
+    name: "File name to be used.pdf",
+    content_type: "application/pdf",
+    bucket: "your_bucket"
+  })
+end
+```

data/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'S3streamer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/lib/generators/s3streamer/install/install_generator.rb

@@ -0,0 +1,14 @@
+module S3streamer
+  class InstallGenerator < Rails::Generators::Base
+    # Copied files come from templates folder
+    source_root File.expand_path('../templates', __FILE__)
+
+    # Generator desc
+    desc "S3Streamer install generator"
+
+    def copy_initializer_file
+      say "Installing default initializer template"
+      copy_file "initializer.rb", "config/initializers/s3streamer.rb"
+    end
+  end
+end

data/lib/generators/s3streamer/install/templates/initializer.rb

@@ -0,0 +1,21 @@
+S3Streamer.config do |config|
+  # Defines the default bucket to be used when streaming a file
+  #
+  config.bucket = nil
+
+  # AWS credentials key to sign in
+  #
+  config.key = ""
+
+  # AWS credentials secret to sign in
+  #
+  config.secret = ""
+
+  # Wether or not to configure aws-sdk with credentials from inializer.
+  #
+  # Defaults to true, since key and secret are needed, but you may already have
+  # initialized config somewhere else, so you just have to toggle the variable
+  # to false
+  #
+  # config.config_auth = false
+end

data/lib/s3streamer.rb

@@ -0,0 +1,28 @@
+require "s3streamer/engine"
+
+module S3Streamer
+  # Defines the default bucket to be used when streaming a file
+  #
+  mattr_accessor :bucket
+
+  # AWS credentials key to sign in
+  #
+  mattr_accessor :key
+
+  # AWS credentials secret to sign in
+  #
+  mattr_accessor :secret
+
+  # Wether or not to configure aws-sdk with credentials from inializer.
+  #
+  mattr_accessor :config_auth
+  @@config_auth = true
+
+  def self.config
+    yield self if block_given?
+  end
+
+  # Autoloaded components
+  autoload :Streamer,          "s3streamer/streamer"
+  autoload :ControllerHelpers, "s3streamer/controller_helpers"
+end

data/lib/s3streamer/controller_helpers.rb

@@ -0,0 +1,31 @@
+module S3Streamer
+  module ControllerHelpers
+    def stream_file item, options = {}
+      case item.class.to_s
+      when "Paperclip::Attachment"
+        path = item.path.gsub(/^\//, '')
+        options[:name] ||= File.basename(item.original_filename)
+        options[:content_type] ||= item.content_type
+      else
+        path = item
+        begin
+          options[:name] ||= File.basename(item)
+        rescue TypeError => e
+          raise TypeError.new e.message +
+            " -- #stream_file only accepts String or Paperclip::Attachment" +
+            " as its first argument"
+        end
+      end
+
+      content_disposition = "attachment; filename=#{ options[:name] }"
+      # Add content type if we have it
+      if options[:content_type]
+        content_disposition += "; content-type:#{ options[:content_type] }"
+      end
+      # Set Content-Disposition HTTP header
+      response.headers['Content-Disposition'] = content_disposition
+
+      self.response_body = Streamer.new(path, options[:bucket])
+    end
+  end
+end

data/lib/s3streamer/engine.rb

@@ -0,0 +1,21 @@
+require "rails"
+require "aws"
+
+module S3Streamer
+  class Engine < Rails::Engine
+    initializer "Initialize S3 Streamer" do |app|
+      # Include controller helpers in application controller
+      app.config.to_prepare do
+        ActiveSupport.on_load :action_controller do
+          ApplicationController.send(:include, ControllerHelpers)
+        end
+      end
+
+      # Configure aws-sdk authentication
+      AWS.config(
+        access_key_id: S3Streamer.key,
+        secret_access_key: S3Streamer.secret
+      )
+    end
+  end
+end

data/lib/s3streamer/streamer.rb

@@ -0,0 +1,26 @@
+module S3Streamer
+  class Streamer
+    attr_accessor :object
+    # Creates a Stremer object by fetching object the to be stremed
+    # and storing it for further processing
+    #
+    # @param [String] key The path to the object in the bucket
+    # @param [String] bucket The bucket name to use. Can be omitted to use
+    #   the default configured bucket
+    #
+    def initialize key, bucket = nil
+      # Use default bucket if not set
+      bucket ||= S3Streamer.bucket
+      # Fetch object to be streamed
+      @object = AWS::S3::Bucket.new(bucket).objects[key]
+    end
+
+    # Method to be called by Rack to stream our stored object
+    #
+    def each
+      @object.read do |segment|
+        yield segment
+      end
+    end
+  end
+end

data/lib/s3streamer/version.rb

@@ -0,0 +1,3 @@
+module S3streamer
+  VERSION = "0.1"
+end

data/lib/tasks/s3streamer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :s3streamer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: s3streamer
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Valentin Ballestrino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: Simple S3 File streaming to client
+email:
+- vala@glyph.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/s3streamer/install/install_generator.rb
+- lib/generators/s3streamer/install/templates/initializer.rb
+- lib/s3streamer/controller_helpers.rb
+- lib/s3streamer/engine.rb
+- lib/s3streamer/streamer.rb
+- lib/s3streamer/version.rb
+- lib/s3streamer.rb
+- lib/tasks/s3streamer_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://www.glyph.fr
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Simple S3 File streaming to client
+test_files: []