mezza-bcms_s3 0.3.0

data/README.markdown

@@ -0,0 +1,64 @@
+# A [BrowserCMS](http://www.browsercms.org) module to allow storage of images and files on the Amazon S3 storage facility
+## Using S3 for file storage
+To enable S3 file storage set Cms::S3.enabled in config/initializers/browsercms.rb (create this if it does not exist) to true.  Ensure that you as provide a s3.yml file that contains your credentials and bucket.
+This should be in the following format
+
+    access_key_id: your AWS access key
+    secret_access_key: your AWS secret access key
+    bucket: your unique bucket name
+
+## Using this module with [Heroku](http://heroku.com)
+If using this module in conjunction with deployment on heroku you should probably turning heroku caching on by setting Cms::S3.heroku_caching in config/initializers/browsercms.rb to true.
+
+In order to avoid putting your secret AWS key in the s3.yml file, you can take advantage of [heroku's config vars](http://docs.heroku.com/config-vars). Use ERB to read the values from the environment.  This way you can safely commit your s3.yml file to the repository without revealing your amazon credentials.
+
+    access_key_id: <%= ENV['s3_access_key_id'] %>
+    secret_access_key: <%= ENV['s3_secret_access_key'] %>
+    bucket: <%= ENV['s3_bucket'] %>
+
+For developing on your local machine, export the s3 variables to your environment.
+
+    export s3_access_key_id='your AWS access key'
+    export s3_secret_access_key='your AWS secret access key'
+    export s3_bucket='your unique bucket name'
+
+Set the config vars on heroku to get it working there as well.
+
+    heroku config:add s3_access_key_id='your AWS access key'
+    heroku config:add s3_secret_access_key='your AWS secret access key'
+    heroku config:add s3_bucket='your unique bucket name'
+
+## www prefix for non cms urls
+If your non cms domain is www.myapp.com rather than app.com this can be enabled by setting Cms::S3.www_domain_prefix in config/initializers/browsercms.rb to true.
+
+## using cnames to your S3 bucket
+If you've set up CNAMES in your DNS to point to your bucket, then you can enable the use of that instead of the FQDN ending in amazonaws.com by setting Cms::S3.options[:s3_cname] in your s3.yml file.
+
+## Important things to note
+1. The s3.yml should be excluded from public repositories (e.g github) since it contains your secret AWS key which should **never** be revealed to the public.   
+**Please note**. This no longer applies since the access keys and buckets are now specified in environmental variables and therefore the s3.yml file now contains just references to these environmental variables.
+2. Changing from local storage to S3 storage will require you to re-upload all your files (or copy the tree to s3)
+3. This module requires the RightAWS gem from RightScale (sudo gem install right_aws)
+
+##### Based on original work on S3 storage for BrowserCMS by [Neil Middleton](http://github.com/neilmiddleton/)
+
+## Important note for use with Rails 3 and BCMS 3.1.x-axes
+
+Due to the use of Engines, I can't work out how to extend the Cms::AttachmentsController and Models from within the module, so you will need to add the block below in the initializer for browsercms.rb
+
+    Cms::AttachmentsController.send(:include, Cms::S3::AttachmentsController)
+    Cms::ContentController.send(:include, Cms::S3::ContentController)
+    Attachment.send(:include, Cms::S3::Attachment)
+    Cms::ApplicationController.send(:include, Cms::S3::ApplicationController)
+    # ensure S3 storage disabled by default
+    Cms::S3.enabled = false if Cms::S3.enabled.nil?
+    # ensure heroku caching disabled by default
+    Cms::S3.heroku_caching = false if Cms::S3.heroku_caching.nil?
+    # function to set domain prefix without url to 'www' is disabled by default
+    Cms::S3.www_domain_prefix = false if Cms::S3.www_domain_prefix.nil?
+    # load s3 options if s3.yml exists
+    if File.exists?("#{RAILS_ROOT}/config/s3.yml")
+      yaml_string = IO.read("#{RAILS_ROOT}/config/s3.yml")
+      Cms::S3.options =  YAML::load(ERB.new(yaml_string).result)
+      Cms::S3.options.symbolize_keys!
+    end

data/lib/bcms_s3.rb

@@ -0,0 +1,2 @@
+require 'bcms_s3/routes'
+require 'bcms_s3/s3_module'

data/lib/bcms_s3/routes.rb

@@ -0,0 +1,7 @@
+module Cms::Routes
+  def routes_for_bcms_s3
+    namespace(:cms) do |cms|
+      #cms.content_blocks :s3s
+    end  
+  end
+end

data/lib/bcms_s3/s3_module.rb

@@ -0,0 +1,138 @@
+require 'right_aws'
+module Cms
+  module S3
+    class << self
+      attr_accessor :enabled
+      attr_accessor :heroku_caching
+      attr_accessor :www_domain_prefix
+      attr_accessor :options
+    end
+    module AttachmentsController
+      def self.included(controller_class)
+        controller_class.alias_method_chain :show, :s3
+      end
+      
+      def show_with_s3
+        @attachment = ::Attachment.find(params[:id])
+        @attachment = @attachment.as_of_version(params[:version]) if params[:version]
+        if Cms::S3.enabled
+          #get the file off S3
+          if Cms::S3.options[:s3_cname]
+            redirect_to("http://#{Cms::S3.options[:s3_cname]}/#{@attachment.file_location}")
+          else
+            redirect_to("http://#{Cms::S3.options[:bucket]}.s3.amazonaws.com/#{@attachment.file_location}")
+          end
+        else
+          #Construct a path to where this file would be if it were cached
+          @file = @attachment.full_file_location
+
+          #Stream the file if it exists
+          if @path != "/" && File.exists?(@file)
+            send_file(@file, 
+            :filename    => @attachment.file_name,
+            :type        => @attachment.file_type,
+            :disposition => "inline"
+            )
+          end
+        end
+      end
+    end
+    module ContentController
+      def self.included(controller_class)
+        controller_class.alias_method_chain :render_page_with_caching, :s3
+        controller_class.alias_method_chain :try_to_stream_file, :s3
+      end
+      def render_page_with_caching_with_s3
+        render_page
+        response.headers['Cache-Control'] = 'public, max-age=300' if Cms::S3.heroku_caching
+      end
+      def try_to_stream_file_with_s3
+        split = @paths.last.to_s.split('.')
+        ext  = split.size > 1 ? split.last.to_s.downcase : nil
+
+        #Only try to stream cache file if it has an extension
+        unless ext.blank?
+
+          #Check access to file
+          @attachment    = ::Attachment.find_live_by_file_path(@path)
+          if @attachment
+            raise Cms::Errors::AccessDenied unless current_user.able_to_view?(@attachment)
+
+            if Cms::S3.enabled
+              #get the file off S3
+              if Cms::S3.options[:s3_cname]
+                redirect_to("http://#{Cms::S3.options[:s3_cname]}/#{@attachment.file_location}")
+              else
+                redirect_to("http://#{Cms::S3.options[:bucket]}.s3.amazonaws.com/#{@attachment.file_location}")
+              end
+            else
+              #Construct a path to where this file would be if it were cached
+              @file = @attachment.full_file_location
+
+              #Stream the file if it exists
+              if @path != "/" && File.exists?(@file)
+                send_file(@file, 
+                :filename    => @attachment.file_name,
+                :type        => @attachment.file_type,
+                :disposition => "inline"
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+    module Attachment
+      def self.included(model_class)
+        model_class.alias_method_chain :set_file_location, :s3
+        model_class.alias_method_chain :write_temp_file_to_storage_location, :s3
+      end
+      def set_file_location_with_s3
+        unless temp_file.blank? 
+          prefix = temp_file.original_filename.sub(/\..+$/,'') 
+          if temp_file.original_filename =~ /.+(\..+)$/ 
+            suffix = $1 
+          else 
+            suffix = "" 
+          end 
+          new_filename = "#{prefix}-#{ActiveSupport::SecureRandom.hex(4)}#{suffix}" 
+          self.file_location = "#{Time.now.strftime("%Y/%m/%d")}/#{new_filename}" 
+        end 
+      end
+      def write_temp_file_to_storage_location_with_s3
+        unless temp_file.blank?
+          FileUtils.mkdir_p File.dirname(full_file_location)  if !Cms::S3.enabled
+          if temp_file.local_path
+
+            if Cms::S3.enabled
+              s3 = RightAws::S3.new(Cms::S3.options[:access_key_id], Cms::S3.options[:secret_access_key] )
+              bucket = s3.bucket(Cms::S3.options[:bucket], true, 'public-read')
+              key = RightAws::S3::Key.create(bucket, file_location)
+              key.put(temp_file.read,'public-read', {"Content-Type" => file_type})
+            else
+              FileUtils.copy temp_file.local_path, full_file_location
+            end
+          else
+            open(full_file_location, 'w') {|f| f << temp_file.read }
+          end
+
+          if Cms.attachment_file_permission  && !Cms::S3.enabled
+            FileUtils.chmod Cms.attachment_file_permission, full_file_location
+          end
+        end
+      end
+    end
+    module ApplicationController
+      def self.included(controller_class)
+        controller_class.alias_method_chain :url_without_cms_domain_prefix, :www
+      end
+      def url_without_cms_domain_prefix_with_www
+        if Cms::S3.www_domain_prefix
+          request.url.sub(/#{cms_domain_prefix}\./,'www.')
+        else
+          request.url.sub(/#{cms_domain_prefix}\./,'')
+        end
+      end
+    end
+  end
+end

data/templates/blank.rb

@@ -0,0 +1,31 @@
+# Remove the file on both *unix and Windows
+if Gem.win_platform?
+  run "del public\\index.html"
+else
+  run "rm public/index.html"
+end
+
+gem "browsercms"
+if Gem.win_platform?
+  puts "        rake  db:create"
+  `rake.cmd db:create`
+else
+  rake "db:create"
+end
+route "map.routes_for_browser_cms"
+generate :browser_cms
+environment 'SITE_DOMAIN="localhost:3000"', :env => "development"
+environment 'SITE_DOMAIN="localhost:3000"', :env => "test"
+environment 'SITE_DOMAIN="localhost:3000"', :env => "production"
+environment 'config.action_view.cache_template_loading = false', :env => "production"
+environment 'config.action_controller.page_cache_directory = RAILS_ROOT + "/public/cache/"', :env => "production"
+initializer 'browsercms.rb', <<-CODE
+Cms.attachment_file_permission = 0640
+Cms::S3.enabled = false
+Cms::S3.heroku_caching = false
+CODE
+if Gem.win_platform?
+  puts "        rake  db:migrate"
+  `rake.cmd db:migrate`
+else
+  rak

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: mezza-bcms_s3
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Anthony Underwood
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-25 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: email2ants@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- lib/bcms_s3.rb
+- lib/bcms_s3/routes.rb
+- lib/bcms_s3/s3_module.rb
+- templates/blank.rb
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/aunderwo/bcms_s3
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: This is a browsercms (browsercms.org) module to allow the facility to have attachments stored on Amazon S3. Also there is the option to change caching to suit heroku and/or use 'www' as the prefix for the non-cms site. Based on original work by Neil Middleton
+test_files: []
+