berkshelf 0.1.1

data/lib/berkshelf/cookbook_source/site_location.rb

@@ -0,0 +1,206 @@
+module Berkshelf
+  class CookbookSource
+    # @author Jamie Winsor <jamie@vialstudios.com>
+    class SiteLocation
+      include Location
+
+      attr_reader :api_uri
+      attr_accessor :version_constraint
+
+      OPSCODE_COMMUNITY_API = 'http://cookbooks.opscode.com/api/v1/cookbooks'.freeze
+
+      class << self
+        # @param [String] target
+        #   file path to the tar.gz archive on disk
+        # @param [String] destination
+        #   file path to extract the contents of the target to
+        def unpack(target, destination)
+          Archive::Tar::Minitar.unpack(Zlib::GzipReader.new(File.open(target, 'rb')), destination)
+        end
+
+        # @param [DepSelector::VersionConstraint] constraint
+        #   version constraint to solve for
+        #
+        # @param [Hash] versions
+        #   a hash where the keys are a DepSelector::Version representing a Cookbook version
+        #   number and their values are the URI the Cookbook of the corrosponding version can
+        #   be downloaded from. This format is also the output of the #versions function on 
+        #   instances of this class.
+        #
+        #   Example:
+        #       { 
+        #         0.101.2 => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_101_2",
+        #         0.101.0 => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_101_0",
+        #         0.100.2 => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_100_2",
+        #         0.100.0 => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_100_0"
+        #       }
+        #
+        # @return [Array]
+        #   an array where the first element is a DepSelector::Version representing the best version
+        #   for the given constraint and the second element is the URI to where the corrosponding
+        #   version of the Cookbook can be downloaded from
+        #
+        #   Example:
+        #       [ 0.101.2 => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_101_2" ]
+        def solve_for_constraint(constraint, versions)
+          versions.each do |version, uri|
+            if constraint.include?(version)
+              return [ version, uri ]
+            end
+          end
+        end
+      end
+
+      def initialize(name, options = {})
+        options[:site] ||= OPSCODE_COMMUNITY_API
+
+        @name = name
+        @version_constraint = options[:version_constraint]
+        @api_uri = options[:site]
+      end
+
+      def download(destination)
+        version, uri = target_version
+        remote_file = rest.get_rest(uri)['file']
+        downloaded_tf = rest.get_rest(remote_file, true)
+
+        dir = Dir.mktmpdir
+        cb_path = File.join(destination, "#{name}-#{version}")
+
+        self.class.unpack(downloaded_tf.path, dir)
+        FileUtils.mv(File.join(dir, name), cb_path, :force => true)
+
+        cb_path
+      end
+
+      # @return [Array]
+      #   an Array where the first element is a DepSelector::Version representing the latest version of
+      #   the Cookbook and the second element is the URI to where the corrosponding version of the
+      #   Cookbook can be downloaded from
+      #
+      #   Example:
+      #       [ 0.101.2, "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_101_2" ]
+      def version(version_string)
+        quietly {
+          result = rest.get_rest("#{name}/versions/#{uri_escape_version(version_string)}")
+          dep_ver = DepSelector::Version.new(result['version'])
+
+          [ dep_ver, result['file'] ]
+        }
+      rescue Net::HTTPServerException => e
+        if e.response.code == "404"
+          raise CookbookNotFound, "Cookbook name: '#{name}' version: '#{version_string}' not found at site: '#{api_uri}'"
+        else
+          raise
+        end
+      end
+
+      # @return [Hash]
+      #   a hash where the keys are a DepSelector::Version representing a Cookbook version
+      #   number and their values are the URI the Cookbook of the corrosponding version can
+      #   be downloaded from
+      #
+      #   Example:
+      #       { 
+      #         0.101.2 => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_101_2",
+      #         0.101.0 => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_101_0",
+      #         0.100.2 => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_100_2",
+      #         0.100.0 => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_100_0"
+      #       }
+      def versions
+        versions = Hash.new
+        quietly {
+          rest.get_rest(name)['versions'].each do |uri|
+            version_string = version_from_uri(File.basename(uri))
+            version = DepSelector::Version.new(version_string)
+
+            versions[version] = uri
+          end
+        }
+
+        versions
+      rescue Net::HTTPServerException => e
+        if e.response.code == "404"
+          raise CookbookNotFound, "Cookbook '#{name}' not found at site: '#{api_uri}'"
+        else
+          raise
+        end
+      end
+
+      # @return [Array]
+      #   an array where the first element is a DepSelector::Version representing the latest version of
+      #   the Cookbook and the second element is the URI to where the corrosponding version of the
+      #   Cookbook can be downloaded from
+      #
+      #   Example:
+      #       [ 0.101.2 => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_101_2" ]
+      def latest_version
+        quietly {
+          uri = rest.get_rest(name)['latest_version']
+          version_string = version_from_uri(uri)
+          dep_ver = DepSelector::Version.new(version_string)
+
+          [ dep_ver, uri ]
+        }
+      rescue Net::HTTPServerException => e
+        if e.response.code == "404"
+          raise CookbookNotFound, "Cookbook '#{name}' not found at site: '#{api_uri}'"
+        else
+          raise
+        end
+      end
+
+      def api_uri=(uri)
+        @rest = nil
+        @api_uri = uri
+      end
+
+      def to_s
+        "site: '#{api_uri}'"
+      end
+
+      private
+
+        def rest
+          @rest ||= Chef::REST.new(api_uri, false, false)
+        end
+
+        def uri_escape_version(version)
+          version.gsub('.', '_')
+        end
+
+        def version_from_uri(latest_version)
+          File.basename(latest_version).gsub('_', '.')
+        end
+
+        # @return [Array]
+        #   an Array where the first element is a DepSelector::Version and the second element is
+        #   the URI to where the corrosponding version of the Cookbook can be downloaded from.
+        #
+        #
+        #   The version is determined by the value of the version_constraint attribute of this
+        #   instance of SiteLocation:
+        #
+        #   If it is not set: the latest_version of the Cookbook will be returned
+        #
+        #   If it is set: the return value will be determined by the version_constraint and the 
+        #     available versions will be solved
+        #
+        #   Example:
+        #       [ 0.101.2, "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_101_2" ]
+        def target_version
+          if version_constraint
+            solution = self.class.solve_for_constraint(version_constraint, versions)
+            
+            unless solution
+              raise NoSolution, "Could not satisfy version constraint: #{version_constraint} for Cookbook '#{name}'"
+            end
+
+            solution
+          else
+            latest_version
+          end
+        end
+    end
+  end
+end

data/lib/berkshelf/cookbook_store.rb

@@ -0,0 +1,77 @@
+require 'fileutils'
+
+module Berkshelf
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  class CookbookStore
+    attr_reader :storage_path
+
+    # Create a new instance of CookbookStore with the given
+    # storage_path.
+    #
+    # @param [String] storage_path
+    #   local filesystem path to the location to be initialized
+    #   as a CookbookStore.
+    def initialize(storage_path)
+      @storage_path = Pathname.new(storage_path)
+      initialize_filesystem
+    end
+
+    # Returns an instance of CachedCookbook representing the
+    # Cookbook of your given name and version.
+    #
+    # @param [String] name
+    #   name of the Cookbook you want to retrieve
+    # @param [String] version
+    #   version of the Cookbook you want to retrieve
+    #
+    # @return [Berkshelf::CachedCookbook]
+    def cookbook(name, version)
+      return nil unless downloaded?(name, version)
+
+      path = cookbook_path(name, version)
+      CachedCookbook.from_path(path)
+    end
+
+    # Returns an array of all of the Cookbooks that have been cached
+    # to the storage_path of this instance of CookbookStore.
+    #
+    # @return [Array<Berkshelf::CachedCookbook>]
+    def cookbooks
+      [].tap do |cookbooks|
+        storage_path.each_child do |p|
+          cached_cookbook = CachedCookbook.from_path(p)
+          
+          cookbooks << cached_cookbook if cached_cookbook
+        end
+      end
+    end
+
+    # Returns an expanded path to the location on disk where the Cookbook
+    # of the given name and version is located.
+    #
+    # @param [String] name
+    # @param [String] version
+    #
+    # @return [Pathname]
+    def cookbook_path(name, version)
+      storage_path.join("#{name}-#{version}")
+    end
+
+    # Returns true if the Cookbook of the given name and verion is downloaded
+    # to this instance of CookbookStore.
+    #
+    # @param [String] name
+    # @param [String] version
+    #
+    # @return [Boolean]
+    def downloaded?(name, version)
+      cookbook_path(name, version).cookbook?
+    end
+
+    private
+
+      def initialize_filesystem
+        FileUtils.mkdir_p(storage_path, :mode => 0755)
+      end
+  end
+end

data/lib/berkshelf/core_ext.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/core_ext/*.rb"].sort.each do |path|
+  require "berkshelf/core_ext/#{File.basename(path, '.rb')}"
+end

data/lib/berkshelf/core_ext/file.rb

@@ -0,0 +1,14 @@
+class File
+  class << self
+    # Returns true or false if the given path is a Chef Cookbook
+    #
+    # @param [#to_s] path
+    #   path of directory to reflect on
+    #
+    # @return [Boolean]
+    def cookbook?(path)
+      File.exists?(File.join(path, "metadata.rb"))
+    end
+    alias_method :chef_cookbook?, :cookbook?
+  end
+end

data/lib/berkshelf/core_ext/kernel.rb

@@ -0,0 +1,33 @@
+# From ActiveSupport: https://github.com/rails/rails/blob/c2c8ef57d6f00d1c22743dc43746f95704d67a95/activesupport/lib/active_support/core_ext/kernel/reporting.rb#L39
+
+require 'rbconfig'
+
+module Kernel
+  # Silences any stream for the duration of the block.
+  #
+  #   silence_stream(STDOUT) do
+  #     puts 'This will never be seen'
+  #   end
+  #
+  #   puts 'But this will'
+  def silence_stream(stream)
+    old_stream = stream.dup
+    stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+    stream.sync = true
+    yield
+  ensure
+    stream.reopen(old_stream)
+  end
+
+  # Silences both STDOUT and STDERR, even for subprocesses.
+  #
+  #   quietly { system 'bundle install' }
+  #
+  def quietly
+    silence_stream(STDOUT) do
+      silence_stream(STDERR) do
+        yield
+      end
+    end
+  end
+end

data/lib/berkshelf/core_ext/pathname.rb

@@ -0,0 +1,24 @@
+class Pathname
+  # Returns true or false if the path of the instantiated 
+  # Pathname or a parent directory contains a Tryhard Pack 
+  # data directory.
+  #
+  # @return [Boolean]
+  def cookbook?
+    self.join('metadata.rb').exist?
+  end
+  alias_method :chef_cookbook?, :cookbook?
+
+  # Ascend the directory structure from the given path to find a
+  # the root of a Chef Cookbook. If no Cookbook is found, nil is returned
+  #
+  # @return [Pathname, nil]
+  def cookbook_root
+    self.ascend do |potential_root|
+      if potential_root.cookbook?
+        return potential_root
+      end
+    end
+  end
+  alias_method :chef_cookbook_root, :cookbook_root
+end

data/lib/berkshelf/downloader.rb

@@ -0,0 +1,92 @@
+module Berkshelf
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  class Downloader
+    extend Forwardable
+
+    attr_reader :cookbook_store
+    attr_reader :queue
+
+    def_delegators :@cookbook_store, :storage_path
+
+    def initialize(cookbook_store)
+      @cookbook_store = cookbook_store
+      @queue = []
+    end
+
+    # Add a CookbookSource to the downloader's queue
+    #
+    # @param [Berkshelf::CookbookSource] source
+    # 
+    # @return [Array<Berkshelf::CookbookSource>]
+    #   the queue - an array of Berkshelf::CookbookSources
+    def enqueue(source)
+      unless validate_source(source)
+        raise ArgumentError, "Invalid CookbookSource: can only enqueue valid instances of CookbookSource."
+      end
+
+      @queue << source
+    end
+
+    # Remove a CookbookSource from the downloader's queue
+    #
+    # @param [Berkshelf::CookbookSource] source
+    #
+    # @return [Berkshelf::CookbookSource]
+    #   the CookbookSource removed from the queue
+    def dequeue(source)
+      @queue.delete(source)
+    end
+
+    # Download each CookbookSource in the queue. Upon successful download
+    # of a CookbookSource it is removed from the queue. If a CookbookSource
+    # fails to download it remains in the queue.
+    #
+    # @return [TXResultSet]
+    def download_all
+      results = TXResultSet.new
+
+      queue.each do |source|
+        results.add_result download(source)
+      end
+
+      results.success.each { |result| dequeue(result.source) }
+      
+      results
+    end
+
+    # Downloads the given CookbookSource
+    #
+    # @param [CookbookSource] source
+    #   the source to download
+    #
+    # @return [TXResult]
+    def download(source)
+      status, message = source.download(storage_path)
+      TXResult.new(status, message, source)
+    end
+
+    # Downloads the given CookbookSource. Raises a DownloadFailure error
+    # if the download was not successful.
+    #
+    # @param [CookbookSource] source
+    #   the source to download
+    #
+    # @return [TXResult]
+    def download!(source)
+      result = download(source)
+      raise DownloadFailure, result.message if result.failed?
+      
+      result
+    end
+
+    def downloaded?(source)
+      source.downloaded? || cookbook_store.downloaded?(source.name, source.local_version)
+    end
+
+    private
+
+      def validate_source(source)
+        source.is_a?(Berkshelf::CookbookSource)
+      end
+  end
+end