carrierwave-cascade 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c43112326672ab79459094a4a061d9c024ee1c86
+  data.tar.gz: 00a6b125f62061e5193d40c09e27ec5994ed7aba
+SHA512:
+  metadata.gz: 9f023fffbf2763a83ddcc708b5a15a5485c850e7840e7277ccfbdb4b5af1e63a6a970f43f4a023021cf141ab09cf1e5e1c60abf1cafd01b391fd1b130b437e4e
+  data.tar.gz: df5b572946044c0d6faede7244539a35a6e95b6c64b7a1d40fabdefde4c79ed6f1de7ee10bfd0f96dabedd6da26370daa6f1ce47c0c25992ad82759ac9ed1e3b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kevin Glowacz
+
+MIT License
+
+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,54 @@
+# Carrierwave::Cascade
+
+[![Build Status](https://travis-ci.org/kjg/carrierwave-cascade.png?branch=master)](https://travis-ci.org/kjg/carrierwave-cascade)
+
+A storage plugin for carrierwave that will retrieving files from a
+secondary storage if the file is not present in the primary storage.
+New files will always be stored in the primary storage. This is
+perfect for use while migrating from one storage to another, or to
+avoid polluting a production environment when running a staging
+mirror.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'carrierwave-cascade'
+```
+
+## Usage
+
+Configure carrierwave to use Cascade as its storage engine. Then set
+primary and secondary storages to be used. Supply other
+configuration as needed for the storages.
+
+```ruby
+CarrierWave.configure do |config|
+  config.storage    = :cascade
+  config.primary_storage   = :file
+  config.secondary_storage = :fog
+
+  config.fog_credentials = {
+    :provider               => 'AWS'
+  }
+end
+```
+
+By default, cascade will prevent files from being deleted out of the
+secondary storage. If you wish secondary storage file to be deleted,
+specify this in the configs.
+
+```ruby
+CarrierWave.configure do |config|
+  config.allow_secondary_file_deletion = true
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/carrierwave-cascade.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carrierwave/cascade/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carrierwave-cascade"
+  spec.version       = Carrierwave::Cascade::VERSION
+  spec.authors       = ["Kevin Glowacz"]
+  spec.email         = ["kevin@glowacz.info"]
+  spec.description   = %q{A storage plugin for carrierwave that will
+    retrieving files from a secondary storageif the file is not present in the
+    primary storage. New files will always be stored in the primary storage.
+    This is perfect for use while migrating from one storage to another, or to
+    avoid polluting a production environment when running a staging mirror.
+  }
+  spec.summary       = %q{Retrieve from a secondary storage when the file is
+    not in the primary storage.
+  }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'carrierwave', '>= 0.5.8'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 2.12.0'
+  spec.add_development_dependency 'fog'
+end

data/lib/carrierwave-cascade.rb

@@ -0,0 +1,20 @@
+require 'carrierwave'
+require 'carrierwave/cascade/version'
+require 'carrierwave/storage/cascade'
+
+if defined?(CarrierWave::Storage::Fog::File)
+  file = CarrierWave::Storage::Fog::File.new(nil,nil,nil)
+  unless file.respond_to?(:exists?)
+    require 'carrierwave/storage/fog/file_patch'
+  end
+end
+
+class CarrierWave::Uploader::Base
+  add_config :primary_storage
+  add_config :secondary_storage
+  add_config :allow_secondary_file_deletion
+
+  configure do |config|
+    config.storage_engines[:cascade] = 'CarrierWave::Storage::Cascade'
+  end
+end

data/lib/carrierwave/cascade/version.rb

@@ -0,0 +1,5 @@
+module Carrierwave
+  module Cascade
+    VERSION = "1.0.0"
+  end
+end

data/lib/carrierwave/storage/cascade.rb

@@ -0,0 +1,62 @@
+module CarrierWave
+  module Storage
+    class Cascade < Abstract
+      attr_reader :primary_storage, :secondary_storage
+
+      def initialize(*args)
+        super(*args)
+
+        @primary_storage    = get_storage(uploader.class.primary_storage).new(*args)
+        @secondary_storage  = get_storage(uploader.class.secondary_storage).new(*args)
+      end
+
+      def store!(*args)
+        primary_storage.store!(*args)
+      end
+
+      def retrieve!(*args)
+        primary_file = primary_storage.retrieve!(*args)
+        secondary_file = secondary_storage.retrieve!(*args)
+
+        if !primary_file.exists? && secondary_file.exists?
+          return SecondaryFileProxy.new(uploader, secondary_file)
+        else
+          return primary_file
+        end
+      end
+
+      private
+
+      def get_storage(storage = nil)
+        storage.is_a?(Symbol) ? eval(uploader.storage_engines[storage]) : storage
+      end
+
+      class SecondaryFileProxy
+
+        attr_reader :real_file
+
+        def initialize(uploader, real_file)
+          @uploader = uploader
+          @real_file = real_file
+        end
+
+        def delete
+          if true === @uploader.allow_secondary_file_deletion
+            return real_file.delete
+          else
+            return true
+          end
+        end
+
+        def method_missing(*args, &block)
+          real_file.send(*args, &block)
+        end
+
+        def respond_to?(*args)
+          @real_file.respond_to?(*args)
+        end
+      end
+
+    end
+  end
+end

data/lib/carrierwave/storage/fog/file_patch.rb

@@ -0,0 +1,11 @@
+ class CarrierWave::Storage::Fog::File
+  ##
+  # Check if the file exists on the remote service
+  #
+  # === Returns
+  #
+  # [Boolean] true if file exists or false
+  def exists?
+    !!directory.files.head(path)
+  end
+end

data/spec/carrierwave-cascade_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe CarrierWave::Uploader::Base do
+  it { should respond_to :primary_storage }
+  it { should respond_to :secondary_storage }
+  it { should respond_to :allow_secondary_file_deletion }
+
+  its(:storage_engines){ should have_key :cascade }
+end

data/spec/carrierwave/storage/cascade_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe CarrierWave::Storage::Cascade do
+
+  let(:uploader){ CarrierWave::Uploader::Base.new }
+
+  before do
+    CarrierWave::Uploader::Base.configure do |config|
+      config.primary_storage = :fog
+      config.secondary_storage = :file
+    end
+  end
+
+  subject(:cascade){ CarrierWave::Storage::Cascade.new(uploader) }
+
+  describe "#initialize" do
+    its(:primary_storage){ should be_a(CarrierWave::Storage::Fog)}
+    its(:secondary_storage){ should be_a(CarrierWave::Storage::File)}
+  end
+
+  describe "#store!" do
+    let(:file){ CarrierWave::SanitizedFile.new("hello") }
+
+    before do
+      cascade.primary_storage.stub(:store! => file)
+      cascade.secondary_storage.stub(:store! => file)
+    end
+
+    it "stores to the primary_storage" do
+      cascade.primary_storage.should_receive(:store!).with(file)
+      cascade.store!(file)
+    end
+
+    it "does not store to the secondary_storage" do
+      cascade.secondary_storage.should_not_receive(:store!)
+      cascade.store!(file)
+    end
+  end
+
+  describe "#retrieve!" do
+    let(:primary_file){ CarrierWave::SanitizedFile.new("primary") }
+    let(:secondary_file){ CarrierWave::SanitizedFile.new("secondary") }
+
+    before do
+      cascade.primary_storage.stub(:retrieve! => primary_file)
+      cascade.secondary_storage.stub(:retrieve! => secondary_file)
+    end
+
+    context "when file exists in primary_storage" do
+      before do
+        primary_file.stub(:exists? => true)
+      end
+
+      context "when file exists in secondary_storage" do
+        before do
+          secondary_file.stub(:exists? => true)
+        end
+
+        it "returns the primary_file" do
+          cascade.retrieve!('file').should == primary_file
+        end
+      end
+
+      context "when file doesn't exist in secondary_storage" do
+        before do
+          secondary_file.stub(:exists? => false)
+        end
+
+        it "returns the primary_file" do
+          cascade.retrieve!('file').should == primary_file
+        end
+      end
+
+    end
+
+    context "when file doesn't exist in primary_storage" do
+      before do
+        primary_file.stub(:exists? => false)
+      end
+
+      context "when file exists in secondary_storage" do
+        before do
+          secondary_file.stub(:exists? => true)
+        end
+
+        it "returns a secondary_file proxy" do
+          cascade.retrieve!('file').should be_a(CarrierWave::Storage::Cascade::SecondaryFileProxy)
+        end
+
+        it "returns a proxy to the real secondary_file" do
+          cascade.retrieve!('file').real_file.should == secondary_file
+        end
+      end
+
+      context "when file doesn't exist in secondary_storage" do
+        before do
+          secondary_file.stub(:exists? => false)
+        end
+
+        it "returns the primary_file" do
+          cascade.retrieve!('file').should == primary_file
+        end
+      end
+    end
+  end
+end
+
+describe CarrierWave::Storage::Cascade::SecondaryFileProxy do
+  let(:uploader){ CarrierWave::Uploader::Base.new }
+  let(:file){ CarrierWave::SanitizedFile.new("file") }
+
+  subject(:cascade_file){ CarrierWave::Storage::Cascade::SecondaryFileProxy.new(uploader, file) }
+
+  before do
+    CarrierWave::Uploader::Base.configure do |config|
+      config.primary_storage = :fog
+      config.secondary_storage = :file
+    end
+  end
+
+  it "delegates all methods to the real file" do
+    file.should_receive(:foooooo)
+    cascade_file.foooooo
+  end
+
+  context "when allow_secondary_file_deletion is not set" do
+    it "doesn't delete the file" do
+      file.should_not_receive(:delete)
+      cascade_file.delete
+    end
+  end
+
+  context "when allow_secondary_file_deletion is false" do
+    before do
+      CarrierWave::Uploader::Base.configure do |config|
+        config.allow_secondary_file_deletion = false
+      end
+    end
+
+    it "doesn't delete the file" do
+      file.should_not_receive(:delete)
+      cascade_file.delete
+    end
+  end
+
+  context "when allow_secondary_file_deletion is true" do
+    before do
+      CarrierWave::Uploader::Base.configure do |config|
+        config.allow_secondary_file_deletion = true
+      end
+    end
+
+    it "does delete the file" do
+      file.should_receive(:delete)
+      cascade_file.delete
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'carrierwave'
+require 'carrierwave-cascade'
+require 'fog'

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-cascade
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kevin Glowacz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: fog
+  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: "A storage plugin for carrierwave that will\n    retrieving files from
+  a secondary storageif the file is not present in the\n    primary storage. New files
+  will always be stored in the primary storage.\n    This is perfect for use while
+  migrating from one storage to another, or to\n    avoid polluting a production environment
+  when running a staging mirror.\n  "
+email:
+- kevin@glowacz.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- carrierwave-cascade.gemspec
+- lib/carrierwave-cascade.rb
+- lib/carrierwave/cascade/version.rb
+- lib/carrierwave/storage/cascade.rb
+- lib/carrierwave/storage/fog/file_patch.rb
+- spec/carrierwave-cascade_spec.rb
+- spec/carrierwave/storage/cascade_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Retrieve from a secondary storage when the file is not in the primary storage.
+test_files:
+- spec/carrierwave-cascade_spec.rb
+- spec/carrierwave/storage/cascade_spec.rb
+- spec/spec_helper.rb