erikhansson-paperclip_cloudfiles 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Erik Hansson
+
+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.rdoc

@@ -0,0 +1,71 @@
+= paperclip_cloudfiles
+
+Enables CloudFiles storage for Paperclip. Also provides a simple mechanism
+for defining default settings for Paperclip attachments. Be warned that this
+project is largely untested. It has worked for me in a limited number of
+specific cases, but as experience shows, this is no guarantee of general
+soundness. You've been warned.
+
+
+== Installation
+
+  sudo gem install erikhansson-paperclip_cloudfiles
+  
+  
+== Setup
+
+environment.rb
+
+  config.gem 'erikhansson-paperclip_cloudfiles', :lib => 'paperclip_cloudfiles', :source => 'http://gems.github.com'
+  
+production.rb (or some other source of configuration)
+
+  Paperclip::WithDefault.use_cloudfiles_options :cloudfiles => {
+    :credentials => {
+        :username => 'username',
+        :api_key => 'abcdefghijklmnopqrstuvxyz1234567'
+      },
+    :container => 'container_name',
+    :base_url => 'http://xxxxyyyy.cdn.cloudfiles.rackspacecloud.com'
+  }
+  
+  
+== Usage
+
+  class Model < ActiveRecord::Base
+  
+    has_attached_file_with_defaults :image, :styles => { :display => "675>" }
+    
+  end
+  
+  
+== What's going on?
+
+has_attached_file_with_defaults simply calls the familiar Paperclip
+has_attached_file method with a set of default options, found in
+Paperclip::WithDefault.options.
+
+Paperclip::WithDefault.use_cloudfiles_options, sets this default
+options hash to some convenient default settings for CloudFiles. You
+can also set it directly using Paperclip::WithDefault.options=
+
+You can also set different default settings for the test and development
+environments. In fact, the test environment automagically gets new 
+default settings { :url => '/system_test/:attachment/:id/:style/:filename' }
+to keep files uploaded during tests to comingle with actual uploaded files.
+
+  
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Erik Hansson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "paperclip_cloudfiles"
+    gem.summary = %Q{Cloudfiles storage for Paperclip}
+    gem.description = %Q{Provides a :cloudfiles storage options for Paperclip.}
+    gem.email = "erik@bits2life.com"
+    gem.homepage = "http://github.com/erikhansson/paperclip_cloudfiles"
+    gem.authors = ["Erik Hansson"]
+    gem.add_dependency "rackspace-cloudfiles"
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "paperclip_cloudfiles #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/paperclip/storage/cloudfiles.rb

@@ -0,0 +1,103 @@
+
+module Paperclip
+  module Storage
+    
+    # Alternative Storage for Paperclip, using Rackspace's CloudFiles storage
+    # service. All files will be saved to a specified CDN-enabled container.
+    module Cloudfiles
+      
+      def self.extended base
+        begin
+          require 'cloudfiles'
+        rescue LoadError => e
+          e.message << " (You may need to install the rackspace-cloudfiles gem)"
+          raise e
+        end
+
+        base.instance_eval do
+          @cf_credentials    = @options[:cloudfiles][:credentials]
+          @cf_container_name = @options[:cloudfiles][:container]
+          @cf_base_url       = @options[:cloudfiles][:base_url]
+        end
+        
+        Paperclip.interpolates(:cf_base_url) do |attachment, style|
+          "#{cf_base_url}"
+        end
+      end
+      
+      def cf_connection
+        # TODO: Ensure that this works acceptably. A new CloudFiles::Connection and
+        # container instance will be created for each attachment when the corresponding
+        # methods are called. Those could probably be shared for all instances of the
+        # same attachment for the process.
+        
+        @cf_connection ||= CloudFiles::Connection.new(@cf_credentials[:username], @cf_credentials[:api_key])
+      end
+      
+      def cf_container
+        @cf_container ||= cf_connection.container(cf_container_name)
+      end
+      
+      def cf_container_name
+        @cf_container_name
+      end
+
+      def cf_base_url
+        @cf_base_url ||= cf_container.cdn_url
+      end
+
+      # Checks wether this attachment exists in the given style.
+      def exists?(style = default_style)
+        if original_filename
+          cf_container.object_exists?(path(style))
+        else
+          false
+        end
+      end
+
+      # Returns representation of the data of the file assigned to the given
+      # style, in the format most representative of the current storage.
+      def to_file style = default_style
+        return @queued_for_write[style] if @queued_for_write[style]
+        file = Tempfile.new(path(style))
+        file.write(cf_container.object(path(style)).value)
+        file.rewind
+        return file
+      end
+
+      def flush_writes #:nodoc:
+        @queued_for_write.each do |style, file|
+          begin
+            log("saving to cloudfiles #{path(style)}")
+            obj = cf_container.create_object(path(style))
+            obj.write(file, cf_headers)
+          rescue StandardError => e
+            raise
+          end
+        end
+        @queued_for_write = {}
+      end
+      
+      # Headers sent to Cloudfiles on upload. Currently used to provide
+      # a Content-Type header if one is available.
+      def cf_headers #:nodoc:
+        result = {}
+        if content_type = instance_read(:content_type)
+          result['Content-Type'] = content_type
+        end
+        result
+      end
+
+      def flush_deletes #:nodoc:
+        @queued_for_delete.each do |path|
+          begin
+            log("deleting from cloudfiles #{path}")
+            cf_container.delete(path)
+          end
+        end
+        @queued_for_delete = []
+      end
+
+    end
+  end
+end

data/lib/paperclip/with_default.rb

@@ -0,0 +1,31 @@
+module Paperclip
+  class WithDefault
+    cattr_accessor :options
+    
+    # Default options for CloudFiles.
+    def self.cloudfiles_options
+      @cloudfiles_options ||= {
+        :url           => ":cf_base_url/:path",
+        :path          => "attachments/:class/:attachment/:id/:style/:filename",
+        :storage       => :cloudfiles
+      }
+    end
+    
+    # Sets Paperclip::WithDefault.options to the given option
+    # hash merged with Paperclip::WithDefault.cloudfiles_options
+    def self.use_cloudfiles_options(options)
+      Paperclip::WithDefault.options = cloudfiles_options.merge(options)
+    end
+    
+    
+    module ClassMethods
+      
+      # Simply calls has_attached_file with the default values found in
+      # Paperclip::WitDefault.options merged into options.
+      def has_attached_file_with_defaults(name, options = {})
+        has_attached_file name, Paperclip::WithDefault.options.merge(options)
+      end
+      
+    end
+  end
+end

data/lib/paperclip_cloudfiles.rb

@@ -0,0 +1,17 @@
+require 'paperclip/storage/cloudfiles'
+require 'paperclip/with_default'
+
+
+# Make has_attached_file_with_defaults available in ActiveRecord::Base
+if Object.const_defined?("ActiveRecord")
+  ActiveRecord::Base.extend Paperclip::WithDefault::ClassMethods
+end
+
+# Provide default options, primarily for development and test environments.
+if Rails.env == 'development' || Rails.env == 'production'
+  Paperclip::WithDefault.options ||= {}
+elsif Rails.env == 'test'
+  Paperclip::WithDefault.options ||= {
+    :url => '/system_test/:attachment/:id/:style/:filename'
+  }
+end

data/spec/paperclip_cloudfiles_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "PaperclipCloudfiles" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'paperclip_cloudfiles'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: erikhansson-paperclip_cloudfiles
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Erik Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rackspace-cloudfiles
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Provides a :cloudfiles storage options for Paperclip.
+email: erik@bits2life.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/paperclip/storage/cloudfiles.rb
+- lib/paperclip/with_default.rb
+- lib/paperclip_cloudfiles.rb
+- spec/paperclip_cloudfiles_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/erikhansson/paperclip_cloudfiles
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Cloudfiles storage for Paperclip
+test_files: 
+- spec/paperclip_cloudfiles_spec.rb
+- spec/spec_helper.rb