altly-jammit-s3 0.6.0.2

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Jacques Crocker
+
+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/bin/jammit-s3

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'jammit-s3'
+
+Jammit::S3CommandLine.new

data/jammit-s3.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name      = 'altly-jammit-s3'
+  s.version   = '0.6.0.2'
+
+  s.homepage    = "http://documentcloud.github.com/jammit/"
+  s.summary     = "Asset Packaging for Rails with Deployment to S3/Cloudfront"
+  s.description = <<-EOS
+    Jammit-S3 is an extension to the awesome Jammit library that handles deployment to s3 and cloudfront.
+  EOS
+
+  s.authors           = ['Jacques Crocker']
+  s.email             = 'railsjedi@gmail.com'
+  s.rubyforge_project = 'jammit-s3'
+
+  s.require_paths     = ['lib']
+  s.executables       = ['jammit-s3']
+
+  s.add_dependency 'altly-jammit',    '>= 0.5.4'
+  s.add_dependency 'mimemagic',  '>= 0.1.7'
+  s.add_dependency 's3', ">= 0.3.7"
+  s.add_dependency 'ruby-hmac'
+
+  s.files = Dir['lib/**/*', 'bin/*', 'jammit-s3.gemspec', 'LICENSE', 'README']
+end

data/lib/jammit-s3.rb

@@ -0,0 +1,44 @@
+require 'jammit/command_line'
+require 'jammit/s3_command_line'
+require 'jammit/s3_uploader'
+
+module Jammit
+  def self.upload_to_s3!(options = {})
+    S3Uploader.new(options).upload
+  end
+end
+
+if defined?(Rails)
+  module Jammit
+    class JammitRailtie < Rails::Railtie
+      initializer "set asset host and asset id" do
+        config.before_initialize do
+          if Jammit.configuration[:use_cloudfront] && Jammit.configuration[:cloudfront_cname].present? && Jammit.configuration[:cloudfront_domain].present?
+            asset_hostname = Jammit.configuration[:cloudfront_cname]
+            asset_hostname_ssl = Jammit.configuration[:cloudfront_domain]
+          elsif Jammit.configuration[:use_cloudfront] && Jammit.configuration[:cloudfront_domain].present?
+            asset_hostname = asset_hostname_ssl = Jammit.configuration[:cloudfront_domain]            
+          else
+            asset_hostname = asset_hostname_ssl = "#{Jammit.configuration[:s3_bucket]}.s3.amazonaws.com"
+          end
+
+          if Jammit.package_assets and asset_hostname.present?
+            puts "Initializing Cloudfront"                      
+            ActionController::Base.asset_host = Proc.new do |source, request|
+              if Jammit.configuration.has_key?(:ssl)
+                protocol = Jammit.configuration[:ssl] ? "https://" : "http://"
+              else
+                protocol = request.protocol
+              end
+              if request.protocol == "https://"
+                "#{protocol}#{asset_hostname_ssl}"
+              else 
+                "#{protocol}#{asset_hostname}"  
+              end              
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jammit/s3_command_line.rb

@@ -0,0 +1,41 @@
+require 's3'
+module Jammit
+  class S3CommandLine < CommandLine
+    def initialize
+      super
+      ensure_s3_configuration
+
+      begin
+        Jammit.upload_to_s3!
+      rescue S3::Error::BucketAlreadyExists => e
+        # tell them to pick another name
+        puts e.message
+        exit(1)
+      end
+    end
+
+    protected
+      def ensure_s3_configuration
+        bucket_name = Jammit.configuration[:s3_bucket]
+        unless bucket_name.is_a?(String) && bucket_name.length > 0
+          puts "\nA valid s3_bucket name is required."
+          puts "Please add one to your Jammit config (config/assets.yml):\n\n"
+          puts "s3_bucket: my-bucket-name\n\n"
+          exit(1)
+        end
+
+        access_key_id = Jammit.configuration[:s3_access_key_id]
+        unless access_key_id.is_a?(String) && access_key_id.length > 0
+          puts "access_key_id: '#{access_key_id}' is not valid"
+          exit(1)
+        end
+
+        secret_access_key = Jammit.configuration[:s3_secret_access_key]
+        unless secret_access_key.is_a?(String) && secret_access_key.length > 0
+          puts "secret_access_key: '#{secret_access_key}' is not valid"
+          exit(1)
+        end
+      end
+
+  end
+end

data/lib/jammit/s3_uploader.rb

@@ -0,0 +1,167 @@
+require 'rubygems'
+require 'hmac'
+require 'hmac-sha1'
+require 'net/https'
+require 'base64'
+require 'mimemagic'
+require 'digest/md5'
+
+module Jammit
+  class S3Uploader
+    def initialize(options = {})
+      @bucket = options[:bucket]
+      unless @bucket
+        @bucket_name = options[:bucket_name] || Jammit.configuration[:s3_bucket]
+        @access_key_id = options[:access_key_id] || Jammit.configuration[:s3_access_key_id]
+        @secret_access_key = options[:secret_access_key] || Jammit.configuration[:s3_secret_access_key]
+        @bucket_location = options[:bucket_location] || Jammit.configuration[:s3_bucket_location]
+        @cache_control = options[:cache_control] || Jammit.configuration[:s3_cache_control]
+        @acl = options[:acl] || Jammit.configuration[:s3_permission]
+
+        @bucket = find_or_create_bucket
+        if Jammit.configuration[:use_cloudfront]
+          @changed_files = []
+          @cloudfront_dist_id = options[:cloudfront_dist_id] || Jammit.configuration[:cloudfront_dist_id]
+        end
+      end
+    end
+
+    def upload
+      log "Pushing assets to S3 bucket: #{@bucket.name}"
+      globs = []
+
+      # add default package path
+      if Jammit.gzip_assets
+        globs << "public/#{Jammit.package_path}/**/*.gz"
+      else
+        globs << "public/#{Jammit.package_path}/**/*.css"
+        globs << "public/#{Jammit.package_path}/**/*.js"
+      end
+
+      # add images
+      globs << "public/images/**/*" unless Jammit.configuration[:s3_upload_images] == false
+
+      # add custom configuration if defined
+      s3_upload_files = Jammit.configuration[:s3_upload_files]
+      globs << s3_upload_files if s3_upload_files.is_a?(String)
+      globs += s3_upload_files if s3_upload_files.is_a?(Array)
+
+      # upload all the globs
+      globs.each do |glob|
+        upload_from_glob(glob)
+      end
+
+      if Jammit.configuration[:use_cloudfront] && !@changed_files.empty?
+        log "invalidating cloudfront cache for changed files"
+        invalidate_cache(@changed_files)
+      end
+    end
+
+    def upload_from_glob(glob)
+      log "Pushing files from #{glob}"
+      log "#{ASSET_ROOT}/#{glob}"
+      Dir["#{ASSET_ROOT}/#{glob}"].each do |local_path|
+        next if File.directory?(local_path)
+        remote_path = local_path.gsub(/^#{ASSET_ROOT}\/public\//, "")
+
+        use_gzip = false
+
+        # handle gzipped files
+        if File.extname(remote_path) == ".gz"
+          use_gzip = true
+          remote_path = remote_path.gsub(/\.gz$/, "")
+        end
+        
+        # check if the file already exists on s3
+        begin
+          obj = @bucket.objects.find_first(remote_path)
+        rescue
+          obj = nil
+        end
+
+        # if the object does not exist, or if the MD5 Hash / etag of the 
+        # file has changed, upload it
+        if !obj || (obj.etag != Digest::MD5.hexdigest(File.read(local_path)))
+
+          # save to s3
+          new_object = @bucket.objects.build(remote_path)
+          new_object.cache_control = @cache_control if @cache_control
+          new_object.content_type = MimeMagic.by_path(remote_path)
+          new_object.content = open(local_path)
+          new_object.content_encoding = "gzip" if use_gzip
+          new_object.acl = @acl if @acl
+          log "pushing file to s3: #{remote_path}"
+          new_object.save
+
+          if Jammit.configuration[:use_cloudfront] && obj
+            log "File changed and will be invalidated in cloudfront: #{remote_path}"
+            @changed_files << remote_path
+          end
+        else
+          log "file has not changed: #{remote_path}"
+        end
+      end
+    end
+
+    def find_or_create_bucket
+      s3_service = S3::Service.new(:access_key_id => @access_key_id, :secret_access_key => @secret_access_key)
+
+      # find or create the bucket
+      begin
+        s3_service.buckets.find(@bucket_name)
+      rescue S3::Error::NoSuchBucket
+        log "Bucket not found. Creating '#{@bucket_name}'..."
+        bucket = s3_service.buckets.build(@bucket_name)
+
+        location = (@bucket_location.to_s.strip.downcase == "eu") ? :eu : :us
+        bucket.save(location)
+        bucket
+      end
+    end
+    
+    def invalidate_cache(files)
+      paths = ""
+      files.each do |key|
+        log "adding /#{key} to list of invalidation requests"
+        paths += "<Path>/#{key}</Path>"
+      end
+      digest = HMAC::SHA1.new(@secret_access_key)
+      digest << date = Time.now.utc.strftime("%a, %d %b %Y %H:%M:%S %Z")
+      uri = URI.parse("https://cloudfront.amazonaws.com/2010-11-01/distribution/#{@cloudfront_dist_id}/invalidation")
+      req = Net::HTTP::Post.new(uri.path)
+      req.initialize_http_header({
+        'x-amz-date' => date,
+        'Content-Type' => 'text/xml',
+        'Authorization' => "AWS %s:%s" % [@access_key_id, Base64.encode64(digest.digest).gsub("\n", '')]
+      })
+      req.body = "<InvalidationBatch>#{paths}<CallerReference>#{@cloudfront_dist_id}_#{Time.now.utc.to_i}</CallerReference></InvalidationBatch>"
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      res = http.request(req)
+      log result_message(req, res)
+    end
+
+    def result_message req, res
+      if res.code == "201"
+        'Invalidation request succeeded'
+      else
+        <<-EOM.gsub(/^\s*/, '')
+        =============================
+        Failed with #{res.code} error!
+        Request path:#{req.path}
+        Request header: #{req.to_hash}
+        Request body:#{req.body}
+        Response body: #{res.body}
+        =============================
+        EOM
+      end
+    end
+
+    def log(msg)
+      puts msg
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: altly-jammit-s3
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.6.0.2
+platform: ruby
+authors: 
+- Jacques Crocker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: altly-jammit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mimemagic
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: s3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.7
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: "    Jammit-S3 is an extension to the awesome Jammit library that handles deployment to s3 and cloudfront.\n"
+email: railsjedi@gmail.com
+executables: 
+- jammit-s3
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/jammit/s3_command_line.rb
+- lib/jammit/s3_uploader.rb
+- lib/jammit-s3.rb
+- bin/jammit-s3
+- jammit-s3.gemspec
+- LICENSE
+has_rdoc: true
+homepage: http://documentcloud.github.com/jammit/
+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: jammit-s3
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Asset Packaging for Rails with Deployment to S3/Cloudfront
+test_files: []
+