asset_uploader 0.0.2

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dave Thomas
+
+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,23 @@
+# AssetUploader
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'asset_uploader'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install asset_uploader
+
+## Usage
+
+TODO: Write usage instructions here
+
+

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+#require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+#  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test
+

data/asset_uploader.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/asset_uploader/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dave Thomas"]
+  gem.email         = ["dave@pragprog.com"]
+  gem.description   = %q{Support uploading of checksummed assets to S3}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "asset_uploader"
+  gem.require_paths = ["lib"]
+  gem.version       = AssetUploader::VERSION
+end

data/bin/asset_uploader

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+# Usage:
+#
+#      asset_uploader  [ --no-upload | --no-sign ]  target_prefix  asset asset...
+#
+#   Takes the files (or files under directories) named by asset... and uploads them
+#   to S3, renaming each file to include a checksum. Prints the path for each
+#   file uploaded.
+#
+#   The target_prefix specifies where the file is stored on S3. 
+#
+#   The --no-upload option prints the path but does not upload
+#
+#   The --no-sign option uploads the file with no checksum. Files uploaded with
+#   no checksum will be hard to change, as the caching front end won't know they
+#   have changed
+#
+#   You need to set the S3 credentials in your environment
+#
+#       export AU_ACCESS_KEY_ID=...
+#       export SECRET_ACCESS_KEY=...
+#       export AU_BUCKET_NAME=...
+#
+#   The default bucket name for assets is a-origin.pragprog.com
+#
+# Examples
+#
+#   asset_uploader  magazines/2012-06/images  images
+#
+#   asset_uploader  --no-sign newsletter/2012-06-04 newsletter.html
+
+require 'optparse'
+
+begin
+  gem 'asset_uploader' 
+rescue Gem::LoadError
+end
+
+require 'asset_uploader'
+
+def usage
+  STDERR.puts File.read(__FILE__).sub(/^\s*$.*/m, '').gsub(/^#/, '')
+  exit
+end
+
+def process(prefix, asset, opt)
+  au = AssetUploader.new(prefix, asset)
+  au.sign if opt[:sign]
+  if opt[:upload]
+    s3_path = au.upload 
+  else
+    s3_path = au.target_path
+  end
+  puts "#{asset}\t#{s3_path}"
+end
+
+opt = { :upload => true, :sign => true }
+
+parser = OptionParser.new
+parser.on("-n", "--no-upload")  { opt[:upload] = false }
+parser.on("-u", "--no-sign" )   { opt[:sign]   = false }
+parser.on("-h", "--help")       { usage }
+
+params = parser.parse(ARGV)
+prefix = params.shift || usage
+
+until params.empty?
+  asset = params.shift
+  if File.directory?(asset)
+    Dir.glob("#{asset}/*").each {|f| params.unshift(f) }
+  else
+    process(prefix, asset, opt)
+  end
+end

data/lib/asset_uploader/uploader.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+gem 'aws-s3'
+require 'aws/s3'
+
+class AssetUploader
+  class Uploader
+    
+    def self.get_env(name)
+      ENV[name] || begin
+        STDERR.puts "#{name} is not set in your environment"
+        exit(1)
+      end
+    end
+
+    S3_CONFIG = {
+      :access_key_id     => get_env('AU_ACCESS_KEY_ID'),
+      :secret_access_key => get_env('SECRET_ACCESS_KEY'),
+      :bucket_name       => get_env('AU_BUCKET_NAME')
+    }
+
+    def do_upload(name, filename)
+      content = open(filename)
+      connect_to_s3  
+      bucket = S3_CONFIG[:bucket_name]
+      ext = File.extname(filename)
+      AWS::S3::S3Object.store(name, 
+                              content, 
+                              bucket, 
+                              :access => :public_read)
+#                              :content_type => MIME_TYPES[ext], 
+#                              :content_disposition => 'attachment')
+      AWS::S3::S3Object.url_for(name, bucket)
+    end
+    
+  private
+
+    def connect_to_s3
+      self.class.connect_to_s3
+    end
+
+    def self.connect_to_s3
+      AWS::S3::Base.establish_connection!(
+        :access_key_id     => S3_CONFIG[:access_key_id],
+        :secret_access_key => S3_CONFIG[:secret_access_key]
+      )
+    end
+
+  end
+end

data/lib/asset_uploader/version.rb

@@ -0,0 +1,3 @@
+class AssetUploader
+  VERSION = "0.0.2"
+end

data/lib/asset_uploader.rb

@@ -0,0 +1,36 @@
+require "asset_uploader/version"
+require "asset_uploader/uploader"
+
+require 'digest/sha1'
+
+class AssetUploader
+ 
+  SIGNATURE_LENGTH = 6
+  PADDING = "x" * SIGNATURE_LENGTH
+
+  def initialize(prefix, path_to_asset)
+    @prefix = prefix
+    @path_to_asset = path_to_asset
+    @original_file_name = @target_file_name = File.basename(@path_to_asset)
+  end
+
+  def sign
+    content = File.read(@path_to_asset)
+    digest  = Digest::SHA1.digest(content)
+    digest  = digest.unpack("q").first
+    digest  = -digest if digest < 0
+    digest  =  "#{digest.to_s(36)}#{PADDING}"[0, SIGNATURE_LENGTH]
+    @target_file_name = @original_file_name.sub(/\.(\w+)$/) { "__#{digest}__.#{$1}" }
+  end
+
+  def target_path
+    File.join(@prefix, @target_file_name)
+  end
+
+  def upload
+    uploader = Uploader.new
+    path = uploader.do_upload(target_path, @path_to_asset)
+    path.sub(/s3.amazonaws.com\//, '').sub(/\?AWS.*/, '').sub(/-origin/, '')
+  end
+
+end

data/test/test_asset_uploader.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'asset_uploader'
+require 'flexmock/test_unit'
+
+class TestAssetUploader < Test::Unit::TestCase
+
+  def test_initial_state
+    au = AssetUploader.new('prefix', 'myfile.jpg')
+    assert_equal "prefix/myfile.jpg", au.target_path
+  end
+
+  def test_signing
+    au = AssetUploader.new('prefix', 'myfile.jpg')
+    flexmock(File).should_receive(:read).with('myfile.jpg').and_return('something')
+    digest = 1234567890
+    flexmock(Digest::SHA1).should_receive(:digest).and_return([digest].pack('q'))
+    signed_path =  "myfile__#{digest.to_s(36)}__.jpg"
+    assert_equal signed_path, au.sign
+    assert_equal File.join('prefix', signed_path), au.target_path
+  end
+
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: asset_uploader
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Dave Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-11 00:00:00.000000000 Z
+dependencies: []
+description: Support uploading of checksummed assets to S3
+email:
+- dave@pragprog.com
+executables:
+- asset_uploader
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- asset_uploader.gemspec
+- bin/asset_uploader
+- lib/asset_uploader.rb
+- lib/asset_uploader/uploader.rb
+- lib/asset_uploader/version.rb
+- test/test_asset_uploader.rb
+homepage: ''
+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.19
+signing_key: 
+specification_version: 3
+summary: Support uploading of checksummed assets to S3
+test_files:
+- test/test_asset_uploader.rb