cloud_tempfile 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+.bundle/
+log/*.log
+pkg/
+pkg/*
+.DS_Store
+Gemfile.lock
+*.gem
+*.swp
+coverage
+coverage/*
+.env
+spec/dummy_app/public/*
+spec/dummy_app/log/*
+spec/dummy_app/tmp/*
+*tmp*
+.rbx
+gemfiles/*.lock
+.idea

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm use 1.9.3@cloud_tempfile --default

data/.travis.yml

@@ -0,0 +1,30 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - ruby-head
+gemfile:
+  - gemfiles/rails_3.1.gemfile
+  - gemfiles/rails_3.2.gemfile
+before_install:
+  - gem install bundler
+env:
+  global:
+#    - FOG_DIRECTORY=asset-sync-travis
+#    - FOG_PROVIDER=AWS
+#    - secure: "dy8Fqlg3b1ZMK1BY5z6NMQLbzAVd7GWVYY0MeCQALz76zRac0z8MyU8hkv6h\nozFry7DSdbGehGT9foOnkWTwzGzf1rzdd5cmWrUPk1wDTRgMM9SrwodPj1TU\nzsq2EFx0a79vADQN8JXkpLC1YD6kEb9aWkTxrIT9KBgw+J5H32o="
+#    - secure: "Hmx7D7/p2LlA2ya/xBIz21s/8MLIQCjvfYB7RWBNlWk1PfqRLAz8wX6TUVWy\nfAFktMjLnpRLRYO7AgQS4jcfQ/k0HYK9IXzqXzeI00TNm0Vwp0TCXhawiOFT\nSvUMhs2/1vRfjN0HOJ75XlWRhJzV/G5rOMiafAZLsVzN/0iiB8g="
+matrix:
+  include:
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: jruby-19mode
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_3.2.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_4.0.gemfile
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "rails-3.1" do
+  gem "rails", "~> 3.1.0"
+end
+
+appraise "rails-3.2" do
+  gem "rails", "~> 3.2.0"
+end
+
+appraise "rails-4.0" do
+  gem "rails", "~> 4.0.0"
+end

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# RELEASE HISTORY
+
+## v0.0.1 / 2014-02-16
+
+Version 0.0.1 (Kevin Bolduc)
+
+Changes:
+
+    * Initial commit

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in cloud_tempfile.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+gem 'rcov', :platforms => :mri_18, :group => [:development, :test]
+gem 'simplecov', :platforms => [:jruby, :mri_19, :ruby_19, :mri_20, :rbx], :group => [:development, :test], :require => false
+gem 'jruby-openssl', :platform => :jruby

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Kevin Bolduc
+
+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,232 @@
+[![Build Status](https://secure.travis-ci.org/kbolduc/cloud_tempfile.png)](http://travis-ci.org/kbolduc/cloud_tempfile)
+
+# CloudTempfile
+
+Tempfile creation directly on Amazon S3 which can be utilized by a Ruby on Rails application.
+
+This was initially built and is intended to work on [Heroku](http://heroku.com) but can work on any platform.
+
+## Installation
+
+Add the gem to your Gemfile
+
+``` ruby
+gem 'cloud_tempfile'
+```
+
+## Configuration
+
+### CloudTempfile
+
+**CloudTempfile** supports the following methods of configuration.
+
+* [Built-in Initializer](https://github.com/kbolduc/cloud_tempfile/blob/master/lib/cloud_tempfile/engine.rb) (configured through environment variables)
+* Rails Initializer
+* A YAML config file
+
+
+Using the **Built-in Initializer** is the default method and is supposed to be used with **environment** variables. It's the recommended approach for deployments on Heroku.
+
+If you need more control over configuration you will want to use a **custom rails initializer**.
+
+Configuration using a **YAML** file (a common strategy for Capistrano deployments) is also supported.
+
+The recommend way to configure **cloud_tempfile** is by using **environment variables** however it's up to you, it will work fine if you hard code them too. The main reason is that then your access keys are not checked into version control.
+
+### Built-in Initializer (Environment Variables)
+
+The Built-in Initializer will configure **CloudTempfile** based on the contents of your environment variables.
+
+Add your configuration details to **heroku**
+
+``` bash
+heroku config:add AWS_ACCESS_KEY_ID=xxxx
+heroku config:add AWS_SECRET_ACCESS_KEY=xxxx
+heroku config:add FOG_DIRECTORY=xxxx
+heroku config:add FOG_PROVIDER=AWS
+# and optionally:
+heroku config:add FOG_REGION=eu-west-1
+```
+
+Or add to a traditional unix system
+
+``` bash
+export AWS_ACCESS_KEY_ID=xxxx
+export AWS_SECRET_ACCESS_KEY=xxxx
+export FOG_DIRECTORY=xxxx
+```
+
+Rackspace configuration is also supported
+
+``` bash
+heroku config:add RACKSPACE_USERNAME=xxxx
+heroku config:add RACKSPACE_API_KEY=xxxx
+heroku config:add FOG_DIRECTORY=xxxx
+heroku config:add FOG_PROVIDER=Rackspace
+```
+
+Google Storage Cloud configuration is supported as well
+``` bash
+heroku config:add FOG_PROVIDER=Google
+heroku config:add GOOGLE_STORAGE_ACCESS_KEY_ID=xxxx
+heroku config:add GOOGLE_STORAGE_SECRET_ACCESS_KEY=xxxx
+heroku config:add FOG_DIRECTORY=xxxx
+```
+
+### Custom Rails Initializer (config/initializers/cloud_tempfile.rb)
+
+If you want to enable some of the advanced configuration options you will want to create your own initializer.
+
+Run the included Rake task to generate a starting point.
+
+    rails g cloud_tempfile:install --provider=Rackspace
+    rails g cloud_tempfile:install --provider=AWS
+
+The generator will create a Rails initializer at `config/initializers/cloud_tempfile.rb`.
+
+``` ruby
+CloudTempfile.configure do |config|
+  config.fog_provider = 'AWS'
+  config.fog_directory = ENV['FOG_DIRECTORY']
+  config.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
+  config.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+
+  # Increase upload performance by configuring your region
+  # config.fog_region = 'eu-west-1'
+  #
+  # Fail silently.  Useful for environments such as Heroku
+  # config.fail_silently = true
+end
+```
+
+### YAML (config/cloud_tempfile.yml)
+
+Run the included Rake task to generate a starting point.
+
+    rails g cloud_tempfile:install --use-yml --provider=Rackspace
+    rails g cloud_tempfile:install --use-yml --provider=AWS
+
+The generator will create a YAML file at `config/cloud_tempfile.yml`.
+
+``` yaml
+defaults: &defaults
+  fog_provider: "AWS"
+  fog_directory: "rails-app-assets"
+  aws_access_key_id: "<%= ENV['AWS_ACCESS_KEY_ID'] %>"
+  aws_secret_access_key: "<%= ENV['AWS_SECRET_ACCESS_KEY'] %>"
+  # You may need to specify what region your storage bucket is in
+  # fog_region: "eu-west-1"
+  # Fail silently.  Useful for environments such as Heroku
+  # fail_silently: true
+
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults
+```
+
+### Available Configuration Options
+
+All CloudTempfile configuration can be modified directly using environment variables with the **Built-in initializer**. e.g.
+
+```ruby
+CloudTempfile.config.fog_provider == ENV['FOG_PROVIDER']
+```
+
+#### CloudTempfile (optional)
+
+* **enabled**: (`true, false`) when false, will disable CloudTempfile and local Tempfile will be created instead. **default:** `'true'` (enabled)
+
+#### Fog (Required)
+* **fog\_provider**: your storage provider *AWS* (S3) or *Rackspace* (Cloud Files) or *Google* (Google Storage)
+* **fog\_directory**: your bucket name
+
+#### Fog (Optional)
+
+* **fog\_region**: the region your storage bucket is in e.g. *eu-west-1*
+
+#### AWS
+
+* **aws\_access\_key\_id**: your Amazon S3 access key
+* **aws\_secret\_access\_key**: your Amazon S3 access secret
+
+#### Rackspace
+
+* **rackspace\_username**: your Rackspace username
+* **rackspace\_api\_key**: your Rackspace API Key.
+
+#### Google Storage
+* **google\_storage\_access\_key\_id**: your Google Storage access key
+* **google\_storage\_secret\_access\_key**: your Google Storage access secret
+
+#### Rackspace (Optional)
+
+* **rackspace\_auth\_url**: Rackspace auth URL, for Rackspace London use: `https://lon.identity.api.rackspacecloud.com/v2.0`
+
+## Amazon S3 Multiple Region Support
+
+If you are using anything other than the US buckets with S3 then you'll want to set the **region**. For example with an EU bucket you could set the following environment variable.
+
+``` bash
+heroku config:add FOG_REGION=eu-west-1
+```
+
+Or via a custom initializer
+
+``` ruby
+CloudTempfile.configure do |config|
+  # ...
+  config.fog_region = 'eu-west-1'
+end
+```
+
+Or via YAML
+
+``` yaml
+production:
+  # ...
+  fog_region: 'eu-west-1'
+```
+
+## Fail Silently
+
+With the `fail_silently` option enabled, when running `rake assets:precompile` CloudTempfile will never throw an error due to missing configuration variables.
+
+With the new **user_env_compile** feature of Heroku (see above), this is no longer required or recommended. Yet was added for the following reasons:
+
+> With Rails 3.1 on the Heroku cedar stack, the deployment process automatically runs `rake assets:precompile`. If you are using **ENV** variable style configuration. Due to the methods with which Heroku compile slugs, there will be an error raised by asset\_sync as the environment is not available. This causes heroku to install the `rails31_enable_runtime_asset_compilation` plugin which is not necessary when using **cloud_tempfile** and also massively slows down the first incoming requests to your app.
+
+> To prevent this part of the deploy from failing (cloud_tempfile raising a config error), but carry on as normal set `fail_silently` to true in your configuration and ensure to run `heroku run rake assets:precompile` after deploy.
+
+## Rake Task
+
+A rake task is included within the **cloud_tempfile** gem to perform the clean up:
+
+``` ruby
+  namespace :cloud_tempfile do
+    desc "Synchronize assets to S3"
+    task :sync => :environment do
+      CloudTempfile.sync
+    end
+  end
+```
+
+## Todo
+
+1. Support more cloud storage providers
+3. Better test coverage
+
+## Credits
+
+Inspired by:
+
+ - [https://devcenter.heroku.com/articles/dynos#ephemeral-filesystem](https://devcenter.heroku.com/articles/dynos#ephemeral-filesystem)
+
+## License
+
+MIT License. Copyright 2014 Kevin Bolduc.

data/Rakefile

@@ -0,0 +1,43 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+  require 'appraisal'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |spec|
+    spec.pattern = 'spec/unit/*_spec.rb'
+    spec.rspec_opts = ['--backtrace']
+
+    rbx = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+    jruby = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+    if RUBY_VERSION == '1.8.7' && !(rbx || jruby)
+      spec.rcov = true
+      spec.rcov_opts = %w{--exclude gems\/,spec\/}
+    end
+  end
+  RSpec::Core::RakeTask.new(:integration) do |spec|
+    spec.pattern = 'spec/integration/*_spec.rb'
+    spec.rspec_opts = ['--backtrace']
+  end
+  desc "run spec:unit and spec:integration tasks"
+  task :all do
+    Rake::Task['spec:unit'].execute
+
+    # Travis CI does not expose encrypted ENV variables for pull requests, so
+    # do not run integration specs
+    # http://about.travis-ci.org/docs/user/build-configuration/#Set-environment-variables
+    #
+    pull_request = ENV['TRAVIS_PULL_REQUEST'] == 'true'
+    ci_build = ENV['TRAVIS'] == 'true'
+    if !ci_build || (ci_build && pull_request)
+      Rake::Task['spec:integration'].execute
+    end
+  end
+end
+
+task :default => 'spec:all'

data/cloud_tempfile.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "cloud_tempfile/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "cloud_tempfile"
+  s.version     = CloudTempfile::VERSION
+  s.date        = "2014-02-16"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kevin Bolduc"]
+  s.email       = ["kevin.bolduc@gmail.com"]
+  s.homepage    = "https://github.com/kbolduc/CloudTempfile"
+  s.summary     = %q{Tempfile creation directly on cloud storage (S3, Google, Rackspace etc] which can be utilized in a Ruby application}
+  s.description = %q{Save any CloudTempfile object and it will be directly persisted to the cloud!}
+  s.license     = 'MIT'
+
+  # rubyforge
+  #s.rubyforge_project = "cloud_tempfile"
+
+  s.add_dependency('fog', ">= 1.8.0")
+  s.add_dependency('activemodel')
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "jeweler"
+
+  s.add_development_dependency "cloud_tempfile"
+  s.add_development_dependency "appraisal"
+
+  #s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.rdoc"]
+  #s.test_files = Dir["{test,spec,features}/**/*"]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/gemfiles/rails_3.1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rcov", :platforms=>:mri_18, :group=>[:development, :test]
+gem "simplecov", :platforms=>[:jruby, :mri_19, :ruby_19, :mri_20, :rbx], :group=>[:development, :test], :require=>false
+gem "jruby-openssl", :platform=>:jruby
+gem "rails", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rcov", :platforms=>:mri_18, :group=>[:development, :test]
+gem "simplecov", :platforms=>[:jruby, :mri_19, :ruby_19, :mri_20, :rbx], :group=>[:development, :test], :require=>false
+gem "jruby-openssl", :platform=>:jruby
+gem "rails", "~> 3.2.0"
+
+gemspec :path=>"../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rcov", :platforms=>:mri_18, :group=>[:development, :test]
+gem "simplecov", :platforms=>[:jruby, :mri_19, :ruby_19, :mri_20, :rbx], :group=>[:development, :test], :require=>false
+gem "jruby-openssl", :platform=>:jruby
+gem "rails", "~> 4.0.0"
+
+gemspec :path=>"../"

data/lib/cloud_tempfile/cloud_tempfile.rb

@@ -0,0 +1,106 @@
+# cloud_tempfile/cloud_tempfile.rb
+#
+# Author::    Kevin Bolduc
+# Date::      14-02-24
+# Time::      3:23 PM
+
+module CloudTempfile
+
+  class << self
+    attr_accessor :file_name
+    attr_accessor :file_raw_data
+
+    def initialize(file_name=nil, file_raw_data=nil)
+      self.file_name = file_name
+      self.file_raw_data = file_raw_data
+    end
+
+
+    def config=(data)
+      @config = data
+    end
+
+    def config
+      @config ||= Config.new
+      @config
+    end
+
+    def reset_config!
+      remove_instance_variable :@config if defined?(@config)
+    end
+
+    def configure(&proc)
+      @config ||= Config.new
+      yield @config
+    end
+
+    def storage
+      @storage ||= Storage.new(self.config)
+    end
+
+    # This action will responsible for persisting the Tempfile
+    # == Options
+    # [:+file_name+:] The file name to use for the Tempfile
+    # [:+file_raw_data+:] The raw file data to be persisted
+    #
+    # @param [Hash] options The Hash of options
+    # @return [File]
+    def write(options = {})
+      _file_name = ((options.has_key?(:file_name))? options[:file_name] : self.file_name)
+      _file_raw_data = ((options.has_key?(:file_raw_data))? options[:file_raw_data] : self.file_raw_data)
+
+      return false if _file_name.nil? || _file_name.blank? || _file_raw_data.nil?
+
+      with_config do
+        if !(config && config.local?)
+          return self.storage.upload_file(_file_name, _file_raw_data)
+        else
+          return self.storage.local_file(_file_name, _file_raw_data)
+        end
+      end
+    end
+
+    # Delete the remote file which are expired if the "config.clean_up" is true
+    # and "config.clean_up_older_than" is the amount of seconds it is older than.
+    #
+    # Note: This action should be used with the "bundle exec rake cloud_tempfile:clear" rake command (cronjob)
+    def clear
+      with_config do
+        self.storage.delete_expired_tempfiles
+      end
+    end
+
+    def with_config(&block)
+      return unless CloudTempfile.enabled?
+
+      errors = config.valid? ? "" : config.errors.full_messages.join(', ')
+
+      if !(config && config.valid?)
+        if config.fail_silently?
+          self.warn(errors)
+        else
+          raise Config::Invalid.new(errors)
+        end
+      else
+        block.call
+      end
+    end
+
+    def warn(msg)
+      stderr.puts msg
+    end
+
+    def log(msg)
+      stdout.puts msg if config.log_silently?
+    end
+
+    def enabled?
+      config.enabled?
+    end
+
+    # Log Stub methods
+    def stderr ; STDERR ; end
+    def stdout ; STDOUT ; end
+
+  end
+end