Class: Jammit::S3Uploader

Inherits:
Object
  • Object
show all
Defined in:
lib/jammit/s3_uploader.rb

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ S3Uploader

Returns a new instance of S3Uploader.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/jammit/s3_uploader.rb', line 11

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

Instance Method Details

#find_or_create_bucket ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/jammit/s3_uploader.rb', line 106

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

#invalidate_cache(files) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/jammit/s3_uploader.rb', line 122

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

#log(msg) ⇒ Object 



161
162
163
 
# File 'lib/jammit/s3_uploader.rb', line 161

def log(msg)
  puts msg
end

#result_message(req, res) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/jammit/s3_uploader.rb', line 145

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

#upload ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/jammit/s3_uploader.rb', line 29

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

#upload_from_glob(glob) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/jammit/s3_uploader.rb', line 60

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