cookbook-omnifetch 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ae1460747cd8d56df8edb96f910ab7aedc7884d
-  data.tar.gz: dfe8988c3227ccb3660a8e591b803596ebf0a4e9
+  metadata.gz: e7d091088a8d8bc3534633afc049408ec4b1ae98
+  data.tar.gz: c41001a64b00582c791a9161d9b65989897aea44
 SHA512:
-  metadata.gz: 0da7ef63902761a5a0d8574d4fcfcd189845a3b9fe3968f4c60e68ce9556f4f9a2f19123001a2e89e5f87a4438bad8f8614c6da9d2bd9c57913add7943ed47ff
-  data.tar.gz: 5f9d292cae9cf0ed321c1a288cfa6677b6223e90e6def07a86025cb52999ac72c7934f4421dffc6d375b2fd7ba4e1b0559f15b6415bb88c97ffb89d85cc450c0
+  metadata.gz: 206300e6648ef964968ab77535acbfd494df3f20ab36d4155ae9a2ddb7224b16d23cc95192aa6a7a02799c5c5c47fb386aa161f6e3ec3d022d9c45789d173899
+  data.tar.gz: 44b5ba6fdde4ff019d481e2709a8b5b592012193b0cdfb46d741719dafe7f4a5e70dec776175d7fc91120b287e57aba5154babd81f6aa430a556b24ebb24894d

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.idea/*

data/README.md

@@ -1,10 +1,3 @@
-# WARNING
-
-This repository will be moved in the future. It possibly will not be
-transferred via github transfer mechanisms, so the git URL may break.
-
-Don't use this yet unless you're prepared to deal with some breakage.
-
 # CookbookOmnifetch
 
 `CookbookOmnifetch` provides library code for fetching Chef cookbooks
@@ -28,10 +21,63 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Inject Dependencies and Configure
+
+Cookbook Omnifetch is designed to work with utilities from both the
+Berkshelf and Chef Software ecosystems, so you have to configure it
+before you can use it. In ChefDK, we do this:
+
+```ruby
+# Configure CookbookOmnifetch's dependency injection settings to use our classes and config.
+CookbookOmnifetch.configure do |c|
+  c.cache_path = File.expand_path('~/.chefdk/cache')
+  c.storage_path = Pathname.new(File.expand_path('~/.chefdk/cache/cookbooks'))
+  c.shell_out_class = ChefDK::ShellOut
+  c.cached_cookbook_class = ChefDK::CookbookMetadata
+end
+```
+
+#### Fetching Cookbooks
+
+To download a cookbook:
+
+```ruby
+fetcher = CookbookOmnifetch.init(dependency, source_options)
+fetcher.install
+```
+
+To specify the cookbook you want, you give CookbookOmnifetch a
+dependency object that responds to `#name` and `#version_constraint`,
+e.g.:
+
+```ruby
+require 'semverse'
+
+Dependency = Struct.new(:name, :version_constraint)
+
+my_dep = Dependency.new("apache2", Semverse::Constraint.new("~> 1.0"))
+```
+
+The source options for the cookbook are given as a Hash; the keys and
+values vary based on the kind of storage location. As with Bundler's
+`gem` options, one key specifies the type of upstream service for the
+cookbook while other keys specify other options specific to that type.
+For example:
+
+```ruby
+CookbookOmnifetch.init(dependency, artifact_server: "https://supermarket.chef.io/api/v1/cookbooks/apache2/versions/3.0.1/download")
+CookbookOmnifetch.init(dependency, git: "git@github.com:svanzoest/apache2-cookbook.git", tag: "v3.0.1")
+CookbookOmnifetch.init(dependency, github: "svanzoest/apache2-cookbook", tag: "v3.0.1")
+CookbookOmnifetch.init(dependency, path: "~/chef-cookbooks/apache2")
+```
 
 ## Contributing
 
+As with other Chef Software projects, in order to contribute you need to
+[agree to the contributor license agreement.](https://supermarket.getchef.com/become-a-contributor)
+
+After that:
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/cookbook-omnifetch/artifactserver.rb

@@ -46,7 +46,8 @@ module CookbookOmnifetch
         FileUtils.mv(tempfile.path, cache_path)
       end
 
-      Dir.mktmpdir do |staging_dir|
+      FileUtils.mkdir_p(staging_root) unless staging_root.exist?
+      Dir.mktmpdir(nil, staging_root) do |staging_dir|
         Zlib::GzipReader.open(cache_path) do |gz_file|
           tar = Archive::Tar::Minitar::Input.new(gz_file)
           tar.each do |e|
@@ -90,8 +91,8 @@ module CookbookOmnifetch
 
     def lock_data
       out = {}
-      out["artifactserver"] = uri
-      out["version"] = cookbook_version
+      out['artifactserver'] = uri
+      out['version'] = cookbook_version
       out
     end
 
@@ -105,7 +106,7 @@ module CookbookOmnifetch
 
 
     def ==(other)
-      raise "TODO"
+      raise 'TODO'
       other.is_a?(GitLocation) &&
       other.uri == uri &&
       other.branch == branch &&
@@ -114,10 +115,29 @@ module CookbookOmnifetch
       other.rel == rel
     end
 
+    # The path where all pristine tarballs from an artifactserver are held.
+    # Tarballs are moved/swapped into this location once they have been staged
+    # in a co-located staging directory.
+    #
+    # @return [Pathname]
     def cache_root
       Pathname.new(CookbookOmnifetch.cache_path).join('.cache', 'artifactserver')
     end
 
+    # The path where tarballs are downloaded to and unzipped.  On certain platforms
+    # you have a better chance of getting an atomic move if your temporary working
+    # directory is on the same device/volume as the  destination.  To support this,
+    # we use a staging directory located under the cache path under the rather mild
+    # assumption that everything under the cache path is going to be on one device.
+    #
+    # Do not create anything under this directory that isn't randomly named and
+    # remember to release your files once you are done.
+    #
+    # @return [Pathname]
+    def staging_root
+      Pathname.new(CookbookOmnifetch.cache_path).join('.cache_tmp', 'artifactserver')
+    end
+
     # The path where the pristine tarball is cached
     #
     # @return [Pathname]

data/lib/cookbook-omnifetch/version.rb

@@ -1,3 +1,3 @@
 module CookbookOmnifetch
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/unit/artifactserver_spec.rb

@@ -16,7 +16,7 @@ module CookbookOmnifetch
 
     let(:options) { {artifactserver: url, version: cookbook_version } }
 
-    subject(:public_repo_location) { ArtifactserverLocation.new(dependency, options) }
+    subject(:public_repo_location) { described_class.new(dependency, options) }
 
     it "has a URI" do
       expect(public_repo_location.uri).to eq(url)
@@ -56,6 +56,60 @@ module CookbookOmnifetch
       }
       expect(public_repo_location.lock_data).to eq(expected_data)
     end
+
+    context "when asked to install a new cookbook" do
+
+      let(:http_client) { double("Http Client") }
+
+      let(:test_root) { Dir.mktmpdir(nil) }
+
+      let(:storage_path) { File.join(test_root, "storage") }
+
+      let(:cache_path) { File.join(test_root, "cache") }
+
+      let(:cookbook_fixtures_path) { fixtures_path.join('cookbooks') }
+
+      let(:cookbook_name) { "example_cookbook" }
+
+      let(:cookbook_version) { "0.5.0" }
+
+      let(:cookbook_tarball_handle) do
+        gz_file_name = File.join(test_root, 'input.gz')
+        Zlib::GzipWriter.open(gz_file_name) do |gz|
+          # Minitar writes the full paths provided and doesn't seem to have a way to
+          # remove prefixes.  So we chdir like barbarians.
+          Dir.chdir(cookbook_fixtures_path) do
+            Archive::Tar::Minitar.pack(cookbook_name, gz)
+          end
+        end
+        File.open(gz_file_name)
+      end
+
+      let(:cookbook_files) { %w". .. .gitignore .kitchen.yml Berksfile Berksfile.lock metadata.rb README.md recipes" }
+
+      before do
+        allow(CookbookOmnifetch).to receive(:storage_path).and_return(Pathname.new(storage_path))
+        allow(CookbookOmnifetch).to receive(:cache_path).and_return(cache_path)
+        FileUtils.mkdir_p(storage_path)
+      end
+
+      after do
+        FileUtils.rm_r(test_root)
+      end
+
+      it "installs the cookbook to the desired install path" do
+        expect(public_repo_location).to receive(:http_client).and_return(http_client)
+        expect(cookbook_tarball_handle).to receive(:close).and_call_original
+        expect(http_client).to receive(:streaming_request).with(nil).and_yield(cookbook_tarball_handle)
+        expect(public_repo_location).to receive(:validate_cached!)
+
+        public_repo_location.install
+
+        expect(File).to exist(public_repo_location.cache_path)
+        expect(Dir).to exist(public_repo_location.install_path)
+        expect(Dir.entries(public_repo_location.install_path)).to match_array(cookbook_files)
+      end
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookbook-omnifetch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jamie Winsor
@@ -13,48 +13,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2015-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: 
@@ -69,8 +69,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.md
@@ -110,17 +110,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Library code to fetch Chef cookbooks from a variety of sources to a local