berkshelf 0.4.0.rc4 → 0.4.0

data/lib/berkshelf/cookbook_source/git_location.rb

@@ -1,78 +0,0 @@
-module Berkshelf
-  class CookbookSource
-    # @author Jamie Winsor <jamie@vialstudios.com>
-    class GitLocation
-      include Location
-
-      location_key :git
-      valid_options :ref, :branch, :tag
-
-      attr_accessor :uri
-      attr_accessor :branch
-
-      alias_method :ref, :branch
-      alias_method :tag, :branch
-
-      # @param [#to_s] name
-      # @param [Solve::Constraint] version_constraint
-      # @param [Hash] options
-      #
-      # @option options [String] :git
-      #   the Git URL to clone
-      # @option options [String] :ref
-      #   the commit hash or an alias to a commit hash to clone
-      # @option options [String] :branch
-      #   same as ref
-      # @option options [String] :tag
-      #   same as tag
-      def initialize(name, version_constraint, options = {})
-        @name = name
-        @version_constraint = version_constraint
-        @uri = options[:git]
-        @branch = options[:branch] || options[:ref] || options[:tag]
-
-        Git.validate_uri!(@uri)
-      end
-
-      # @param [#to_s] destination
-      #
-      # @return [Berkshelf::CachedCookbook]
-      def download(destination)
-        tmp_clone = Dir.mktmpdir
-        ::Berkshelf::Git.clone(uri, tmp_clone)
-        ::Berkshelf::Git.checkout(tmp_clone, branch) if branch
-        unless branch
-          self.branch = ::Berkshelf::Git.rev_parse(tmp_clone)
-        end
-
-        unless File.chef_cookbook?(tmp_clone)
-          msg = "Cookbook '#{name}' not found at git: #{uri}" 
-          msg << " with branch '#{branch}'" if branch
-          raise CookbookNotFound, msg
-        end
-
-        cb_path = File.join(destination, "#{self.name}-#{Git.rev_parse(tmp_clone)}")
-        FileUtils.rm_rf(cb_path)
-        FileUtils.mv(tmp_clone, cb_path, force: true)
-                
-        cached = CachedCookbook.from_store_path(cb_path)
-        validate_cached(cached)
-
-        set_downloaded_status(true)
-        cached
-      end
-
-      def to_s
-        s = "git: '#{uri}'"
-        s << " with branch: '#{branch}'" if branch
-        s
-      end
-
-      private
-
-        def git
-          @git ||= Berkshelf::Git.new(uri)
-        end
-    end
-  end
-end

data/lib/berkshelf/cookbook_source/location.rb

@@ -1,167 +0,0 @@
-module Berkshelf
-  class CookbookSource
-    # @author Jamie Winsor <jamie@vialstudios.com>
-    module Location
-      module ClassMethods
-        # Register the location key for the including source location with CookbookSource
-        #
-        # @param [Symbol] key
-        def location_key(key)
-          CookbookSource.add_location_key(key, self)
-        end
-
-        # Register a valid option or multiple options with the CookbookSource class
-        #
-        # @param [Symbol] opts
-        def valid_options(*opts)
-          Array(opts).each do |opt|
-            CookbookSource.add_valid_option(opt)
-          end
-        end
-
-        # Returns an array where the first element is string representing the best version
-        # for the given constraint and the second element is the URI to where the corresponding
-        # version of the Cookbook can be downloaded from
-        #
-        # @example:
-        #   constraint = Solve::Constraint.new("~> 0.101.2")
-        #   versions = { 
-        #     "1.0.0" => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/1_0_0",
-        #     "2.0.0" => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/2_0_0"
-        #   }
-        #
-        #   subject.solve_for_constraint(versions, constraint) =>
-        #     [ "2.0.0", "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/2_0_0" ]
-        #
-        # @param [String, Solve::Constraint] constraint
-        #   version constraint to solve for
-        #
-        # @param [Hash] versions
-        #   a hash where the keys are a string representing a cookbook version and the values
-        #   are the download URL for the cookbook version.
-        #
-        # @return [Array, nil]
-        def solve_for_constraint(constraint, versions)
-          graph = Solve::Graph.new
-          name = "none"
-
-          versions.each do |version, uri|
-            graph.artifacts(name, version)
-          end
-
-          graph.demands(name, constraint)
-          result = Solve.it(graph)
-
-          return nil if result.nil?
-
-          version = result[name]
-
-          [ version, versions[version] ]
-        end
-      end
-
-      class << self
-        def included(base)
-          base.send :extend, ClassMethods
-        end
-
-        # Creates a new instance of a Class implementing Location with the given name and
-        # constraint. Which Class to instantiated is determined by the values in the given
-        # options Hash. Source Locations have an associated location_key registered with
-        # CookbookSource. If your options Hash contains a key matching one of these location_keys
-        # then the Class who registered that location_key will be instantiated. If you do not
-        # provide an option with a matching location_key a SiteLocation class will be
-        # instantiated.
-        #
-        # @example
-        #   Location.init("nginx", ">= 0.0.0", git: "git://github.com/RiotGames/artifact-cookbook.git") =>
-        #     instantiates a GitLocation
-        #
-        #   Location.init("nginx", ">= 0.0.0", path: "/Users/reset/code/nginx-cookbook") =>
-        #     instantiates a PathLocation
-        #
-        #   Location.init("nginx", ">= 0.0.0", site: "http://cookbooks.opscode.com/api/v1/cookbooks") =>
-        #     instantiates a SiteLocation
-        #
-        #   Location.init("nginx", ">= 0.0.0", chef_api: "https://api.opscode.com/organizations/vialstudios") =>
-        #     instantiates a ChefAPILocation
-        #
-        #   Location.init("nginx", ">= 0.0.0") =>
-        #     instantiates a SiteLocation
-        #
-        # @param [String] name
-        # @param [String, Solve::Constraint] constraint
-        # @param [Hash] options
-        #
-        # @return [SiteLocation, PathLocation, GitLocation, ChefAPILocation]
-        def init(name, constraint, options = {})
-          klass = klass_from_options(options)
-
-          klass.new(name, constraint, options)
-        end
-
-        private
-
-          def klass_from_options(options)
-            location_keys = (options.keys & CookbookSource.location_keys.keys)
-            if location_keys.length > 1
-              location_keys.collect! { |opt| "'#{opt}'" }
-              raise InternalError, "Only one location key (#{CookbookSource.location_keys.keys.join(', ')}) may be specified. You gave #{location_keys.join(', ')}."
-            end
-
-            if location_keys.empty?
-              SiteLocation
-            else
-              CookbookSource.location_keys[location_keys.first]
-            end
-          end
-      end
-
-      attr_reader :name
-      attr_reader :version_constraint
-
-      # @param [#to_s] name
-      # @param [Solve::Constraint] version_constraint
-      # @param [Hash] options
-      def initialize(name, version_constraint, options = {})
-        @name = name
-        @version_constraint = version_constraint
-        @downloaded_status = false
-      end
-
-      # @param [#to_s] destination
-      #
-      # @return [Berkshelf::CachedCookbook]
-      def download(destination)
-        raise NotImplementedError, "Function must be implemented on includer"
-      end
-
-      # @return [Boolean]
-      def downloaded?
-        @downloaded_status
-      end
-
-      # Ensures that the given CachedCookbook satisfies the constraint
-      #
-      # @param [CachedCookbook] cached_cookbook
-      #
-      # @raise [ConstraintNotSatisfied] if the CachedCookbook does not satisfy the version constraint of
-      #   this instance of Location.
-      #
-      # @return [Boolean]
-      def validate_cached(cached_cookbook)
-        unless version_constraint.satisfies?(cached_cookbook.version)
-          raise ConstraintNotSatisfied, "A cookbook satisfying '#{name}' (#{version_constraint}) not found at #{self}"
-        end
-
-        true
-      end
-
-      private
-
-        def set_downloaded_status(state)
-          @downloaded_status = state
-        end
-    end
-  end
-end

data/lib/berkshelf/cookbook_source/path_location.rb

@@ -1,40 +0,0 @@
-module Berkshelf
-  class CookbookSource
-    # @author Jamie Winsor <jamie@vialstudios.com>
-    class PathLocation
-      include Location
-
-      location_key :path
-
-      attr_accessor :path
-
-      # @param [#to_s] name
-      # @param [Solve::Constraint] version_constraint
-      # @param [Hash] options
-      #
-      # @option options [String] :path
-      #   a filepath to the cookbook on your local disk
-      def initialize(name, version_constraint, options = {})
-        @name = name
-        @version_constraint = version_constraint
-        @path = File.expand_path(options[:path])
-        set_downloaded_status(true)
-      end
-
-      # @param [#to_s] destination
-      #
-      # @return [Berkshelf::CachedCookbook]
-      def download(destination)
-        cached = CachedCookbook.from_path(path)
-        validate_cached(cached)
-
-        set_downloaded_status(true)
-        cached
-      end
-
-      def to_s
-        "path: '#{path}'"
-      end
-    end
-  end
-end

data/lib/berkshelf/cookbook_source/site_location.rb

@@ -1,149 +0,0 @@
-module Berkshelf
-  class CookbookSource
-    # @author Jamie Winsor <jamie@vialstudios.com>
-    class SiteLocation
-      include Location
-
-      location_key :site
-
-      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
-      end
-
-      # @param [#to_s] name
-      # @param [Solve::Constraint] version_constraint
-      # @param [Hash] options
-      #
-      # @option options [String] :site
-      #   a URL pointing to a community API endpoint
-      def initialize(name, version_constraint, options = {})
-        options[:site] ||= OPSCODE_COMMUNITY_API
-
-        @name = name
-        @version_constraint = version_constraint
-        @api_uri = options[:site]
-        @rest = Chef::REST.new(api_uri, false, false)
-      end
-
-      # @param [#to_s] destination
-      #
-      # @return [Berkshelf::CachedCookbook]
-      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)
-
-        cached = CachedCookbook.from_store_path(cb_path)
-        validate_cached(cached)
-        
-        set_downloaded_status(true)
-        cached
-      end
-
-      # Returns a hash of all the cookbook versions found at communite site URL for the cookbook
-      # name of this location.
-      #
-      # @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"
-      #   }
-      #
-      # @return [Hash]
-      #   a hash representing the cookbook versions on at a Chef API for location's cookbook.
-      #   The keys are version strings and the values are URLs to download the cookbook version.
-      def versions
-        {}.tap do |versions|
-          rest.get_rest(name)['versions'].each do |uri|
-            version = version_from_uri(File.basename(uri))
-
-            versions[version] = uri
-          end
-        end
-      rescue Net::HTTPServerException => e
-        if e.response.code == "404"
-          raise CookbookNotFound, "Cookbook '#{name}' not found at site: '#{api_uri}'"
-        else
-          raise
-        end
-      end
-
-      # Returns the latest version of the cookbook and it's download link.
-      #
-      # @example
-      #   [ "0.101.2" => "https://api.opscode.com/organizations/vialstudios/cookbooks/nginx/0.101.2" ]
-      #
-      # @return [Array]
-      #   an array containing the version and download URL for the cookbook version that
-      #   should be downloaded for this location.
-      def latest_version
-        quietly {
-          uri = rest.get_rest(name)['latest_version']
-
-          [ version_from_uri(uri), 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 to_s
-        "site: '#{api_uri}'"
-      end
-
-      private
-
-        attr_reader :rest
-
-        def uri_escape_version(version)
-          version.gsub('.', '_')
-        end
-
-        def version_from_uri(latest_version)
-          File.basename(latest_version).gsub('_', '.')
-        end
-
-        # Returns an array containing the version and download URL for the cookbook version that
-        # should be downloaded for this location.
-        #
-        # @example
-        #   [ "0.101.2" => "https://api.opscode.com/organizations/vialstudios/cookbooks/nginx/0.101.2" ]
-        #
-        # @return [Array]
-        def target_version
-          if version_constraint
-            solution = self.class.solve_for_constraint(version_constraint, versions)
-            
-            unless solution
-              raise NoSolution, "No cookbook version of '#{name}' found at #{self} that would satisfy constraint (#{version_constraint})."
-            end
-
-            solution
-          else
-            latest_version
-          end
-        end
-    end
-  end
-end

data/lib/berkshelf/dsl.rb

@@ -1,45 +0,0 @@
-module Berkshelf
-  module DSL
-    @@active_group = nil
-
-    def cookbook(*args)
-      source = CookbookSource.new(*args)
-      source.add_group(@@active_group) if @@active_group
-      add_source(source)
-    end
-
-    def group(*args)
-      @@active_group = args
-      yield
-      @@active_group = nil
-    end
-
-    def metadata(options = {})
-      path = options[:path] || File.dirname(filepath)
-
-      metadata_file = Berkshelf.find_metadata(path)
-
-      unless metadata_file
-        raise CookbookNotFound, "No 'metadata.rb' found at #{path}"
-      end
-
-      metadata = Chef::Cookbook::Metadata.new
-      metadata.from_file(metadata_file.to_s)
-
-      name = if metadata.name.empty? || metadata.name.nil?
-        File.basename(File.dirname(metadata_file))
-      else
-        metadata.name
-      end
-
-      source = CookbookSource.new(name, path: File.dirname(metadata_file))
-      add_source(source)
-    end
-
-    private
-
-      def filepath
-        File.join(File.expand_path('.'), "DSLFile")
-      end
-  end
-end