buildpack-utils 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bda82697d95d1aa6cb76a0e785aea130753f4130
+  data.tar.gz: 549cfc1b63231a311e065ef914f5e42265a7e758
+SHA512:
+  metadata.gz: dad9181bdc893d7c291fbf4b21dd2368f9b000978942971c603f1e362f90d579851354a70e2864065308f73b4a594e2bbdeaaf823d530c1f1e1c823d330661e5
+  data.tar.gz: d7c6b770d92c71502a4a583204ed560c1d4f810c47bcd938cc83611eb0deaf0d8eac7c7dc439d7f1b3f892f04c6498521a70c1046e2587fcb11e73cd98ccb4a1

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,2 @@
+   Cloud Foundry Buildpack Utilities
+   Copyright 2013 the original author or authors.

data/README.md

@@ -0,0 +1,9 @@
+# Cloud Foundry Buildpack Utilities
+[![Build Status](https://travis-ci.org/cloudfoundry/buildpack-utils.png?branch=master)](https://travis-ci.org/cloudfoundry/buildpack-utils)
+[![Gem Version](https://badge.fury.io/rb/buildpack-utils.png)](http://badge.fury.io/rb/buildpack-utils)
+[![Dependency Status](https://gemnasium.com/cloudfoundry/buildpack-utils.png)](http://gemnasium.com/cloudfoundry/buildpack-utils)
+[![Code Climate](https://codeclimate.com/github/cloudfoundry/buildpack-utils.png)](https://codeclimate.com/github/cloudfoundry/buildpack-utils)
+
+`buildpack-utils` provides a set of additional utilities for use in [Cloud Foundry][cf] buildpacks
+
+[cf]: http://www.cloudfoundry.com

data/lib/buildpack-utils/application_cache.rb

@@ -0,0 +1,34 @@
+# Cloud Foundry Buildpack Utilities
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'buildpack-utils/download_cache'
+
+# An extension of {BuildpackUtils::DownloadCache} that is configured to use the application cache.  The application
+# cache location is defined by the second argument (<tt>ARGV[1]</tt>) to the +compile+ script.
+#
+# <b>WARNING: This cache should only by used by code run by the +compile+ script</b>
+class BuildpackUtils::ApplicationCache < BuildpackUtils::DownloadCache
+
+  # Creates an instance that is configured to use the application cache.  The application cache location is defined by
+  # the second argument (<tt>ARGV[1]</tt>) to the +compile+ script.
+  #
+  # @raise if the second argument (<tt>ARGV[1]</tt>) to the +compile+ script is +nil+
+  def initialize
+    application_cache_directory = ARGV[1]
+    raise 'Application cache directory is undefined' if application_cache_directory.nil?
+    super(application_cache_directory)
+  end
+
+end

data/lib/buildpack-utils/download_cache.rb

@@ -0,0 +1,161 @@
+# Cloud Foundry Buildpack Utilities
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'net/http'
+require 'tmpdir'
+
+# A cache for downloaded files that is configured to use a filesystem as the backing store. This cache uses standard
+# file locking (<tt>File.flock()</tt>) in order ensure that mutation of files in the cache is non-concurrent across
+# processes.  Reading files (once they've been downloaded) happens concurrently so read performance is not impacted.
+class BuildpackUtils::DownloadCache
+
+  # Creates an instance of the cache that is backed by the filesystem rooted at +cache_root+
+  #
+  # @param [String] cache_root the filesystem root for downloaded files to be cached in
+  def initialize(cache_root = Dir.tmpdir)
+    @cache_root = cache_root
+  end
+
+  # Retrieves an item from the cache.  Retrieval of the item uses the following algorithm:
+  #
+  # 1. Obtain an exclusive lock based on the key of the item. This allows concurrency for different items, but not for
+  #    the same item.
+  # 2. If the the cached item does not exist, download from +uri+ and cache it, its +Etag+, and its +Last-Modified+
+  #    values if they exist
+  # 3. If the cached file does exist, and the original download had an +Etag+ or a +Last-Modified+ value, attempt to
+  #    download from +uri+ again.  If the result is +304+ (+Not-Modified+), then proceed without changing the cached
+  #    item.  If it is anything else, overwrite the cached file and its +Etag+ and +Last-Modified+ values if they exist.
+  # 4. Downgrade the lock to a shared lock as no further mutation of the cache is possible.  This allows concurrency for
+  #    read access of the item.
+  # 5. Yield the cached file (opened read-only) to the passed in block. Once the block is complete, the file is closed
+  #    and the lock is released.
+  #
+  # @param [String] key the key of the item to retrieve
+  # @param [String] uri the uri to download if the item is not already in the cache.  Also used in the case where the
+  #                     item is already in the cache, to validate that the item is up to date
+  # @yieldparam [File] file the file representing the cached item. In order to ensure that the file is not changed or
+  #                    deleted while it is being used, the cached item can only be accessed as part of a block.
+  # @return [void]
+  def get(key, uri)
+    filenames = filenames(key)
+    File.open(filenames[:lock], File::CREAT) do |lock_file|
+      lock_file.flock(File::LOCK_EX)
+
+      if should_update(filenames)
+        update(filenames, uri)
+      elsif should_download(filenames)
+        download(filenames, uri)
+      end
+
+      lock_file.flock(File::LOCK_SH)
+
+      File.open(filenames[:cached], File::RDONLY) do |cached_file|
+        yield cached_file
+      end
+    end
+  end
+
+  # Remove an item from the cache
+  #
+  # @param [String] key the key of the item to remove
+  # @return [void]
+  def evict(key)
+    filenames = filenames(key)
+    File.open(filenames[:lock], File::CREAT) do |lock_file|
+      lock_file.flock(File::LOCK_EX)
+
+      delete_file filenames[:cached]
+      delete_file filenames[:etag]
+      delete_file filenames[:last_modified]
+      delete_file filenames[:lock]
+    end
+  end
+
+  def delete_file(filename)
+    File.delete filename if File.exists? filename
+  end
+  private
+
+
+  def download(filenames, uri)
+    rich_uri = URI(uri)
+
+    Net::HTTP.start(rich_uri.host, rich_uri.port) do |http|
+      request = Net::HTTP::Get.new(uri)
+      http.request request do |response|
+        write_response(filenames, response)
+      end
+    end
+  end
+
+  def filenames(key)
+    {
+        cached:        File.join(@cache_root, "#{key}.cached"),
+        etag:          File.join(@cache_root, "#{key}.etag"),
+        last_modified: File.join(@cache_root, "#{key}.last_modified"),
+        lock:          File.join(@cache_root, "#{key}.lock"),
+    }
+  end
+
+  def persist_header(response, header, filename)
+    unless response[header].nil?
+      File.open(filename, File::CREAT|File::WRONLY) do |file|
+        file.write(response[header])
+      end
+    end
+  end
+
+  def set_header(request, header, filename)
+    if File.exists?(filename)
+      File.open(filename, File::RDONLY) do |file|
+        request[header] = file.read
+      end
+    end
+  end
+
+  def should_download(filenames)
+    !File.exists?(filenames[:cached])
+  end
+
+  def should_update(filenames)
+    File.exists?(filenames[:cached]) && (File.exists?(filenames[:etag]) || File.exists?(filenames[:last_modified]))
+  end
+
+  def update(filenames, uri)
+    rich_uri = URI(uri)
+
+    Net::HTTP.start(rich_uri.host, rich_uri.port) do |http|
+      request = Net::HTTP::Get.new(uri)
+      set_header request, 'If-None-Match', filenames[:etag]
+      set_header request, 'If-Modified-Since', filenames[:last_modified]
+
+      http.request request do |response|
+        write_response(filenames, response) unless response.code == '304'
+      end
+    end
+  end
+
+  def write_response(filenames, response)
+    persist_header response, 'Etag', filenames[:etag]
+    persist_header response, 'Last-Modified', filenames[:last_modified]
+
+    File.open(filenames[:cached], File::CREAT|File::WRONLY) do |cached_file|
+      response.read_body do |chunk|
+        cached_file.write(chunk)
+      end
+    end
+  end
+
+end

data/lib/buildpack-utils/global_cache.rb

@@ -0,0 +1,32 @@
+# Cloud Foundry Buildpack Utilities
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'buildpack-utils/download_cache'
+
+# An extension of {BuildpackUtils::DownloadCache} that is configured to use the global cache.  The global cache location
+# is defined by the +BUILDPACK_CACHE+ environment variable
+class BuildpackUtils::GlobalCache < BuildpackUtils::DownloadCache
+
+  # Creates an instance that is configured to use the global cache.  The global cache location is defined by the
+  # +BUILDPACK_CACHE+ environment variable
+  #
+  # @raise if the +BUILDPACK_CACHE+ environment variable is +nil+
+  def initialize
+    global_cache_directory = ENV['BUILDPACK_CACHE']
+    raise 'Global cache directory is undefined' if global_cache_directory.nil?
+    super(global_cache_directory)
+  end
+
+end

data/lib/buildpack_utils.rb

@@ -0,0 +1,22 @@
+# Cloud Foundry Buildpack Utilities
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# A collection of utilities that are useful when implementing Cloud Foundry buildpacks.
+module BuildpackUtils
+end
+
+require 'buildpack-utils/application_cache'
+require 'buildpack-utils/download_cache'
+require 'buildpack-utils/global_cache'

data/spec/buildpack-utils/application_cache_spec.rb

@@ -0,0 +1,53 @@
+# Cloud Foundry Buildpack Utilities
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+require 'tmpdir'
+
+describe BuildpackUtils::ApplicationCache do
+
+  before do
+    @previous_value = ARGV[1]
+    ARGV[1] = nil
+  end
+
+  after do
+    ARGV[1] = @previous_value
+  end
+
+  it 'should raise an error if ARGV[1] is not defined' do
+    lambda { BuildpackUtils::ApplicationCache.new }.should raise_error
+  end
+
+  it 'should use ARGV[1] directory' do
+    stub_request(:get, 'http://foo-uri/').to_return(
+        :status => 200,
+        :body => 'foo-cached',
+        :headers => {
+            :Etag => 'foo-etag',
+            'Last-Modified' => 'foo-last-modified'
+        }
+    )
+
+    Dir.mktmpdir do |root|
+      ARGV[1] = root
+
+      BuildpackUtils::ApplicationCache.new().get('foo', 'http://foo-uri/') {}
+
+      expect(File.exists?(File.join(root, 'foo.cached'))).to be_true
+    end
+  end
+
+end

data/spec/buildpack-utils/download_cache_spec.rb

@@ -0,0 +1,245 @@
+# Cloud Foundry Buildpack Utilities
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+require 'tmpdir'
+
+describe BuildpackUtils::DownloadCache do
+
+  it 'should download from a uri if the cached file does not exist' do
+    stub_request(:get, 'http://foo-uri/').to_return(
+        :status => 200,
+        :body => 'foo-cached',
+        :headers => {
+            :Etag => 'foo-etag',
+            'Last-Modified' => 'foo-last-modified'
+        }
+    )
+
+    Dir.mktmpdir do |root|
+      BuildpackUtils::DownloadCache.new(root).get('foo', 'http://foo-uri/') {}
+
+      expect_file_content root, 'cached', 'foo-cached'
+      expect_file_content root, 'etag', 'foo-etag'
+      expect_file_content root, 'last_modified', 'foo-last-modified'
+    end
+  end
+
+  it 'should download from a uri if the cached file exists and etag exists' do
+    stub_request(:get, 'http://foo-uri/').with(
+        :headers => {
+            'If-None-Match' => 'foo-etag'
+        }
+    ).to_return(
+        :status => 200,
+        :body => 'foo-cached',
+        :headers => {
+            :Etag => 'foo-etag',
+            'Last-Modified' => 'foo-last-modified'
+        }
+    )
+
+    Dir.mktmpdir do |root|
+      touch root, 'cached', 'foo-cached'
+      touch root, 'etag', 'foo-etag'
+
+      BuildpackUtils::DownloadCache.new(root).get('foo', 'http://foo-uri/') {}
+
+      expect_file_content root, 'cached', 'foo-cached'
+      expect_file_content root, 'etag', 'foo-etag'
+      expect_file_content root, 'last_modified', 'foo-last-modified'
+    end
+  end
+
+  it 'should download from a uri if the cached file exists and last modified exists' do
+    stub_request(:get, 'http://foo-uri/').with(
+        :headers => {
+            'If-Modified-Since' => 'foo-last-modified'
+        }
+    ).to_return(
+        :status => 200,
+        :body => 'foo-cached',
+        :headers => {
+            :Etag => 'foo-etag',
+            'Last-Modified' => 'foo-last-modified'
+        }
+    )
+
+    Dir.mktmpdir do |root|
+      touch root, 'cached', 'foo-cached'
+      touch root, 'last_modified', 'foo-last-modified'
+
+      BuildpackUtils::DownloadCache.new(root).get('foo', 'http://foo-uri/') {}
+
+      expect_file_content root, 'cached', 'foo-cached'
+      expect_file_content root, 'etag', 'foo-etag'
+      expect_file_content root, 'last_modified', 'foo-last-modified'
+    end
+  end
+
+  it 'should download from a uri if the cached file exists, etag exists, and last modified exists' do
+    stub_request(:get, 'http://foo-uri/').with(
+        :headers => {
+            'If-None-Match' => 'foo-etag',
+            'If-Modified-Since' => 'foo-last-modified'
+        }
+    ).to_return(
+        :status => 200,
+        :body => 'foo-cached',
+        :headers => {
+            :Etag => 'foo-etag',
+            'Last-Modified' => 'foo-last-modified'
+        }
+    )
+
+    Dir.mktmpdir do |root|
+      touch root, 'cached', 'foo-cached'
+      touch root, 'etag', 'foo-etag'
+      touch root, 'last_modified', 'foo-last-modified'
+
+      BuildpackUtils::DownloadCache.new(root).get('foo', 'http://foo-uri/') {}
+
+      expect_file_content root, 'cached', 'foo-cached'
+      expect_file_content root, 'etag', 'foo-etag'
+      expect_file_content root, 'last_modified', 'foo-last-modified'
+    end
+  end
+
+  it 'should not download from a uri if the cached file exists and the etag and last modified do not exist' do
+    Dir.mktmpdir do |root|
+      touch root, 'cached', 'foo-cached'
+
+      BuildpackUtils::DownloadCache.new(root).get('foo', 'http://foo-uri/') {}
+
+      expect_file_content root, 'cached', 'foo-cached'
+    end
+  end
+
+  it 'should not overwrite existing information if 304 is received' do
+    stub_request(:get, 'http://foo-uri/').with(
+        :headers => {
+            'If-None-Match' => 'foo-etag',
+            'If-Modified-Since' => 'foo-last-modified'
+        }
+    ).to_return(
+        :status => 304,
+        :body => 'bar-cached',
+        :headers => {
+            :Etag => 'bar-etag',
+            'Last-Modified' => 'bar-last-modified'
+        }
+    )
+
+    Dir.mktmpdir do |root|
+      touch root, 'cached', 'foo-cached'
+      touch root, 'etag', 'foo-etag'
+      touch root, 'last_modified', 'foo-last-modified'
+
+      BuildpackUtils::DownloadCache.new(root).get('foo', 'http://foo-uri/') {}
+
+      expect_file_content root, 'cached', 'foo-cached'
+      expect_file_content root, 'etag', 'foo-etag'
+      expect_file_content root, 'last_modified', 'foo-last-modified'
+    end
+  end
+
+  it 'should overwrite existing information if 304 is not received' do
+    stub_request(:get, 'http://foo-uri/').with(
+        :headers => {
+            'If-None-Match' => 'foo-etag',
+            'If-Modified-Since' => 'foo-last-modified'
+        }
+    ).to_return(
+        :status => 200,
+        :body => 'bar-cached',
+        :headers => {
+            :Etag => 'bar-etag',
+            'Last-Modified' => 'bar-last-modified'
+        }
+    )
+
+    Dir.mktmpdir do |root|
+      touch root, 'cached', 'foo-cached'
+      touch root, 'etag', 'foo-etag'
+      touch root, 'last_modified', 'foo-last-modified'
+
+      BuildpackUtils::DownloadCache.new(root).get('foo', 'http://foo-uri/') {}
+
+      expect_file_content root, 'cached', 'bar-cached'
+      expect_file_content root, 'etag', 'bar-etag'
+      expect_file_content root, 'last_modified', 'bar-last-modified'
+    end
+  end
+
+  it 'should pass read-only file to block' do
+    stub_request(:get, 'http://foo-uri/').to_return(
+        :status => 200,
+        :body => 'foo-cached',
+        :headers => {
+            :Etag => 'foo-etag',
+            'Last-Modified' => 'foo-last-modified'
+        }
+    )
+
+    Dir.mktmpdir do |root|
+      BuildpackUtils::DownloadCache.new(root).get('foo', 'http://foo-uri/') do |file|
+        expect(file.read).to eq('foo-cached')
+        lambda { file.write('bar') }.should raise_error
+      end
+    end
+  end
+
+  it 'should delete the cached file if it exists' do
+    expect_file_deleted 'cached'
+  end
+
+  it 'should delete the etag file if it exists' do
+    expect_file_deleted 'etag'
+  end
+
+  it 'should delete the last_modified file if it exists' do
+    expect_file_deleted 'last_modified'
+  end
+
+  it 'should delete the lock file if it exists' do
+    expect_file_deleted 'lock'
+  end
+
+  private
+
+  def touch(root, extension, content = '')
+    file = File.join(root, "foo.#{extension}")
+    File.open(file, 'w') { |f| f.write(content) }
+    file
+  end
+
+  def expect_file_deleted(extension)
+    Dir.mktmpdir do |root|
+      file = touch root, extension
+      expect(File.exists?(file)).to be_true
+
+      BuildpackUtils::DownloadCache.new(root).evict('foo')
+
+      expect(File.exists?(file)).to be_false
+    end
+  end
+
+  def expect_file_content(root, extension, content = '')
+    file = File.join(root, "foo.#{extension}")
+    expect(File.exists?(file)).to be_true
+    File.open(file, 'r') { |f| expect(f.read).to eq(content)}
+  end
+
+end

data/spec/buildpack-utils/global_cache_spec.rb

@@ -0,0 +1,52 @@
+# Cloud Foundry Buildpack Utilities
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+require 'tmpdir'
+
+describe BuildpackUtils::GlobalCache do
+
+  before do
+    @previous_value = ENV.delete 'BUILDPACK_CACHE'
+  end
+
+  after do
+    ENV['BUILDPACK_CACHE'] = @previous_value
+  end
+
+  it 'should raise an error if BUILDPACK_CACHE is not defined' do
+    lambda { BuildpackUtils::GlobalCache.new }.should raise_error
+  end
+
+  it 'should use BUILDPACK_CACHE directory' do
+    stub_request(:get, 'http://foo-uri/').to_return(
+        :status => 200,
+        :body => 'foo-cached',
+        :headers => {
+            :Etag => 'foo-etag',
+            'Last-Modified' => 'foo-last-modified'
+        }
+    )
+
+    Dir.mktmpdir do |root|
+      ENV['BUILDPACK_CACHE'] = root
+
+      BuildpackUtils::GlobalCache.new().get('foo', 'http://foo-uri/') {}
+
+      expect(File.exists?(File.join(root, 'foo.cached'))).to be_true
+    end
+  end
+
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: buildpack-utils
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ben Hale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Provides a set of utilities for use in Cloud Foundry buildpacks
+email: bhale@gopivotal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- NOTICE
+- README.md
+- lib/buildpack-utils/application_cache.rb
+- lib/buildpack-utils/download_cache.rb
+- lib/buildpack-utils/global_cache.rb
+- lib/buildpack_utils.rb
+- spec/buildpack-utils/application_cache_spec.rb
+- spec/buildpack-utils/download_cache_spec.rb
+- spec/buildpack-utils/global_cache_spec.rb
+homepage: https://github.com/cloudfoundry/buildpack-utils
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Utilities for use in Cloud Foundry buildpacks
+test_files:
+- spec/buildpack-utils/application_cache_spec.rb
+- spec/buildpack-utils/download_cache_spec.rb
+- spec/buildpack-utils/global_cache_spec.rb
+has_rdoc: