carrierwave-aws 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.config
+Gemfile.lock
+bin
+vendor

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Parker Selbert
+
+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,50 @@
+# Carrierwave AWS Storage
+
+Use the officially supported AWS-SDK library for S3 storage rather than relying
+on fog. There are several things going for it:
+
+* Full featured, it supports more of the API than Fog
+* Significantly smaller footprint
+* Fewer dependencies
+* Clear documentation
+
+Here is a simple comparison table [02/04/2013]
+
+| Library | Disk Space | Lines of Code | Boot Time | Runtime Deps | Develop Deps |
+| ------- | ---------- | ------------- | --------- | ------------ | ------------ |
+| fog     | 28.0M      | 133469        | 0.693     | 9            | 11           |
+| aws-sdk | 4.4M       |  80017        | 0.098     | 3            | 8            |
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'carrierwave-aws'
+
+## Usage
+
+Configure and use it just like you would Fog. The only notable difference is
+the use of `aws_bucket` instead of `fog_directory`, and `aws_acl` instead of
+`fog_public`.
+
+```ruby
+CarrierWave.configure do |config|
+  config.storage    = :aws
+  config.aws_bucket = ENV['S3_BUCKET_NAME']
+  config.aws_acl    = :public_read
+  config.aws_authenticated_url_expiration = 60 * 60 * 24 * 365
+
+  config.aws_credentials = {
+    access_key_id:     ENV['AWS_ACCESS_KEY_ID'],
+    secret_access_key: ENV['AWS_SECRET_ACCESS_KEY']
+  }
+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-aws.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carrierwave/aws/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'carrierwave-aws'
+  gem.version       = Carrierwave::AWS::VERSION
+  gem.authors       = ['Parker Selbert']
+  gem.email         = ['parker@sorentwo.com']
+  gem.description   = %q{Use aws-sdk for S3 support in CarrierWave}
+  gem.summary       = %q{A slimmer alternative to using Fog for S3 support in CarrierWave}
+  gem.homepage      = "https://github.com/sorentwo/carrierwave-aws-sdk"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'carrierwave', '>= 0.7.0'
+  gem.add_dependency 'aws-sdk',     '~> 1.8.1.2'
+
+  gem.add_development_dependency 'rspec', '~> 2.12.0'
+end

data/lib/carrierwave-aws.rb

@@ -0,0 +1,15 @@
+require 'carrierwave'
+require 'carrierwave/aws/version'
+require 'carrierwave/storage/aws'
+
+class CarrierWave::Uploader::Base
+  add_config :aws_attributes
+  add_config :aws_authenticated_url_expiration
+  add_config :aws_credentials
+  add_config :aws_bucket
+  add_config :aws_acl
+
+  configure do |config|
+    config.storage_engines[:aws] = 'CarrierWave::Storage::AWS'
+  end
+end

data/lib/carrierwave/aws/version.rb

@@ -0,0 +1,5 @@
+module Carrierwave
+  module AWS
+    VERSION = '0.1.0'
+  end
+end

data/lib/carrierwave/storage/aws.rb

@@ -0,0 +1,117 @@
+require 'aws/s3'
+
+module CarrierWave
+  module Storage
+    class AWS < Abstract
+      def self.connection_cache
+        @connection_cache ||= {}
+      end
+
+      def store!(file)
+        File.new(uploader, self, uploader.store_path).tap do |aws_file|
+          aws_file.store(file)
+        end
+      end
+
+      def retrieve!(identifier)
+        File.new(uploader, self, uploader.store_path(identifier))
+      end
+
+      def connection
+        @connection ||= begin
+          credentials = uploader.aws_credentials
+          self.class.connection_cache[credentials] ||= ::AWS::S3.new(credentials)
+        end
+      end
+
+      class File
+        attr_reader :uploader, :base, :path
+
+        def initialize(uploader, base, path)
+          @uploader, @base, @path = uploader, base, path
+        end
+
+        def attributes
+          file.attributes
+        end
+
+        def content_type
+          @content_type || file.content_type
+        end
+
+        def content_type=(new_content_type)
+          @content_type = new_content_type
+        end
+
+        def delete
+          file.delete
+        end
+
+        def extension
+          path.split('.').last
+        end
+
+        def read
+          file.read
+        end
+
+        def size
+          file.content_length
+        end
+
+        def exists?
+          !!file
+        end
+
+        def store(new_file)
+          aws_file = new_file.to_file
+
+          @file = bucket.objects[path].write(aws_file, {
+            acl: uploader.aws_acl,
+            content_type: new_file.content_type
+          }.merge(uploader.aws_attributes))
+
+          aws_file.close unless aws_file.closed?
+
+          true
+        end
+
+        def authenticated_url
+          file.url_for(:read, expires: uploader.aws_authenticated_url_expiration).to_s
+        end
+
+        def public_url
+          file.public_url.to_s
+        end
+
+        def url(options = {})
+          if uploader.aws_acl != :public_read
+            authenticated_url
+          else
+            public_url
+          end
+        end
+
+        def filename(options = {})
+          if file_url = url(options)
+            file_url.gsub(/.*\/(.*?$)/, '\1')
+          end
+        end
+
+        private
+
+        def connection
+          base.connection
+        end
+
+        def bucket
+          @bucket ||= connection.buckets[uploader.aws_bucket]
+        end
+
+        def file
+          @file ||= bucket.objects[path]
+        end
+      end
+    end
+  end
+end

data/spec/carrierwave-aws_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe CarrierWave::Uploader::Base do
+  it 'defines aws specific storage options' do
+    described_class.should respond_to(:aws_attributes)
+  end
+
+  it 'inserts aws as a known storage engine' do
+    described_class.configure do |config|
+      config.storage_engines.should have_key(:aws)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require 'carrierwave'
+require 'carrierwave-aws'

data/spec/storage/aws_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe CarrierWave::Storage::AWS do
+  let(:credentials) { { access_key_id: 'abc', secret_access_key: '123' } }
+  let(:uploader)    { mock(:uploader, aws_credentials: credentials) }
+  let(:storage)     { described_class.new(uploader) }
+
+  describe '#connection' do
+    it 'instantiates a new connection' do
+      AWS::S3.should_receive(:new).with(credentials)
+
+      storage.connection
+    end
+
+    it 'caches connections by credentials' do
+      AWS::S3.should_receive(:new).with(credentials).and_return(mock)
+
+      storage.connection.should === storage.connection
+    end
+  end
+end
+
+describe CarrierWave::Storage::AWS::File do
+  let(:file)       { mock(:file, read: '0101010') }
+  let(:objects)    { { 'files/1/file.txt' => file } }
+  let(:bucket)     { mock(:bucket, objects: objects) }
+  let(:connection) { mock(:connection, buckets: { 'example-com' => bucket }) }
+  let(:uploader)   { mock(:uploader, aws_bucket: 'example-com') }
+  let(:storage)    { mock(:storage, connection: connection) }
+  let(:path)       { 'files/1/file.txt' }
+
+  subject(:aws_file) { described_class.new(uploader, storage, path) }
+
+  describe '#read' do
+    it 'reads from the remote file object' do
+      aws_file.read.should == '0101010'
+    end
+  end
+
+  describe '#authenticated_url' do
+    it 'requests a url for reading with the configured expiration' do
+      uploader.stub(aws_authenticated_url_expiration: 60)
+
+      file.should_receive(:url_for).with(:read, expires: 60)
+
+      aws_file.authenticated_url
+    end
+  end
+
+  describe '#url' do
+    it 'requests a public url if acl is public readable' do
+      uploader.stub(aws_acl: :public_read)
+      file.should_receive(:public_url)
+
+      aws_file.url
+    end
+
+    it 'requests an authenticated url if acl is not public readable' do
+      uploader.stub(aws_acl: :private, aws_authenticated_url_expiration: 60)
+
+      file.should_receive(:url_for)
+
+      aws_file.url
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-aws
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Parker Selbert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Use aws-sdk for S3 support in CarrierWave
+email:
+- parker@sorentwo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- carrierwave-aws.gemspec
+- lib/carrierwave-aws.rb
+- lib/carrierwave/aws/version.rb
+- lib/carrierwave/storage/aws.rb
+- spec/carrierwave-aws_spec.rb
+- spec/spec_helper.rb
+- spec/storage/aws_spec.rb
+homepage: https://github.com/sorentwo/carrierwave-aws-sdk
+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.23
+signing_key: 
+specification_version: 3
+summary: A slimmer alternative to using Fog for S3 support in CarrierWave
+test_files:
+- spec/carrierwave-aws_spec.rb
+- spec/spec_helper.rb
+- spec/storage/aws_spec.rb