lib/berkshelf/cookbook_source/site_location.rb in berkshelf-0.3.7 vs lib/berkshelf/cookbook_source/site_location.rb in berkshelf-0.4.0.rc1

@@ -2,10 +2,12 @@
   class CookbookSource
     # @author Jamie Winsor <[e-mail]>
     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
 
@@ -15,63 +17,34 @@
         # @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, nil]
-        #   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
-
-          nil
-        end
       end
 
       # @param [#to_s] name
-      # @param [DepSelector::VersionConstraint] version_constraint
+      # @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}")
 
@@ -83,130 +56,88 @@
         
         set_downloaded_status(true)
         cached
       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
+      # 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" ]
-      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"
+      #   }
       #
-      #   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 [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
-        versions = Hash.new
-        quietly {
+        {}.tap do |versions|
           rest.get_rest(name)['versions'].each do |uri|
-            version_string = version_from_uri(File.basename(uri))
-            version = DepSelector::Version.new(version_string)
+            version = version_from_uri(File.basename(uri))
 
             versions[version] = uri
           end
-        }
-
-        versions
+        end
       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
+      # Returns the latest version of the cookbook and it's download link.
       #
-      #   Example:
-      #       [ 0.101.2 => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/0_101_2" ]
+      # @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_string = version_from_uri(uri)
-          dep_ver = DepSelector::Version.new(version_string)
 
-          [ dep_ver, uri ]
+          [ 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 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
+        attr_reader :rest
 
         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.
+        # 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" ]
         #
-        #   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" ]
+        # @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 '#{api_uri}' that would satisfy constraint (#{version_constraint})."
+              raise NoSolution, "No cookbook version of '#{name}' found at #{self} that would satisfy constraint (#{version_constraint})."
             end
 
             solution
           else
             latest_version