cocoapods-downloader 1.1.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 39f931857e0e88b2b1bfbd27f1444194e1f0964f
-  data.tar.gz: 04825acb584a9417a5dae4fa01a328e4233b5e82
+SHA256:
+  metadata.gz: 128f7eaefbd34c1b7f9c66c06a45dd5e3d186322938a8346fc5283df450617d0
+  data.tar.gz: 60a084074452df93b41cfda6248c2fc455b8111c109fc471075e96ca7085e5b9
 SHA512:
-  metadata.gz: 8fbd2e3973f247c1a86243b1c5ab2bf00717cc928f55c8c71f5465001f1120c88c3e81bd7316847c3e7acb8fd15df300890408b9b60eaabdb615ae3cccd3584c
-  data.tar.gz: b5aadb492243642b60dece83d37a16968aaf997af47f94b1d56af92bc0bb091d1b2243aabf6ac1746b3b0866f56af232572c05b9f2ce08f661a520642e2175f2
+  metadata.gz: 2fd8b780dc60807be9317865fea329ecf608f18ce1e81bca8653c23b548589d9b7c3099d4e82ff7c7097e75f256e856ff788d2691f34312798e61f13f13154f3
+  data.tar.gz: 8435a98df7285ea8753b443656e306d1467dc8bfa28551c70d018630c03ad8820dc564576bd70a90d51d848cdad184a8e8b00ab59d05950740af4548d0971ae0

data/README.markdown

@@ -33,6 +33,7 @@ The downloader class supports the following option keys:
 - svn: revision, tag, folder, externals
 - hg: revision, tag, branch
 - http: type, flatten
+- scp: type, flatten
 - bzr: revision, tag
 
 The downloader also provides hooks which allow to customize its output or the way in which the commands are executed

data/lib/cocoapods-downloader.rb

@@ -9,6 +9,7 @@ module Pod
     autoload :Git,         'cocoapods-downloader/git'
     autoload :Http,        'cocoapods-downloader/http'
     autoload :Mercurial,   'cocoapods-downloader/mercurial'
+    autoload :Scp,         'cocoapods-downloader/scp'
     autoload :Subversion,  'cocoapods-downloader/subversion'
 
     # Denotes the error generated by a Downloader
@@ -24,6 +25,7 @@ module Pod
         :git  => Git,
         :hg   => Mercurial,
         :http => Http,
+        :scp  => Scp,
         :svn  => Subversion,
       }
     end

data/lib/cocoapods-downloader/base.rb

@@ -121,6 +121,18 @@ module Pod
         raise 'Abstract method'
       end
 
+      # Returns a User-Agent string that itentifies http network requests as
+      # originating from CocoaPods.
+      # Contains version numbers from the CocoaPods Gem and the cocoapods-downloader Gem.
+      #
+      # @param  [module] base_module The Base CocoaPods Module to retrieve the version number from.
+      # @return [String] the User-Agent string.
+      #
+      def self.user_agent_string(base_module = Pod)
+        pods_version = base_module.const_defined?('VERSION') ? "CocoaPods/#{base_module::VERSION} " : ''
+        "#{pods_version}cocoapods-downloader/#{Pod::Downloader::VERSION}"
+      end
+
       #-----------------------------------------------------------------------#
 
       # Defines two methods for an executable, based on its name. The bang

data/lib/cocoapods-downloader/gem_version.rb

@@ -3,6 +3,6 @@ module Pod
     # @return [String] Downloader’s version, following
     #         [semver](http://semver.org).
     #
-    VERSION = '1.1.3'.freeze
+    VERSION = '1.4.0'.freeze
   end
 end

data/lib/cocoapods-downloader/git.rb

@@ -27,16 +27,37 @@ module Pod
                    options[:git],
                    options[:branch]]
         output = Git.execute_command('git', command)
-        match = /^([a-z0-9]*)\t.*/.match(output)
+        match = commit_from_ls_remote output, options[:branch]
 
         return options if match.nil?
 
-        options[:commit] = match[1]
+        options[:commit] = match
         options.delete(:branch)
 
         options
       end
 
+      # Matches a commit from the branches reported by git ls-remote.
+      #
+      # @note   When there is a branch and tag with the same name, it will match
+      #         the branch, since `refs/heads` is sorted before `refs/tags`.
+      #
+      # @param  [String] output
+      #         The output from git ls-remote.
+      #
+      # @param  [String] branch_name
+      #         The desired branch to match a commit to.
+      #
+      # @return [String] commit hash string, or nil if no match found
+      #
+      def self.commit_from_ls_remote(output, branch_name)
+        return nil if branch_name.nil?
+        match = %r{([a-z0-9]*)\trefs\/(heads|tags)\/#{Regexp.quote(branch_name)}}.match(output)
+        match[1] unless match.nil?
+      end
+
+      private_class_method :commit_from_ls_remote
+
       private
 
       # @!group Base class hooks

data/lib/cocoapods-downloader/http.rb

@@ -1,179 +1,33 @@
-require 'zlib'
-require 'fileutils'
-require 'uri'
+require 'cocoapods-downloader/remote_file'
 
 module Pod
   module Downloader
-    class Http < Base
-      def self.options
-        [:type, :flatten, :sha1, :sha256]
-      end
-
-      class UnsupportedFileTypeError < StandardError; end
+    class Http < RemoteFile
+      USER_AGENT_HEADER = 'User-Agent'.freeze
 
       private
 
       executable :curl
-      executable :unzip
-      executable :tar
-      executable :hdiutil
-
-      attr_accessor :filename, :download_path
-
-      def download!
-        @filename = filename_with_type(type)
-        @download_path = (target_path + @filename)
-        download_file(@download_path)
-        verify_checksum(@download_path)
-        extract_with_type(@download_path, type)
-      end
-
-      def type
-        if options[:type]
-          options[:type].to_sym
-        else
-          type_with_url(url)
-        end
-      end
-
-      # @note   The archive is flattened if it contains only one folder and its
-      #         extension is either `tgz`, `tar`, `tbz` or the options specify
-      #         it.
-      #
-      # @return [Bool] Whether the archive should be flattened if it contains
-      #         only one folder.
-      #
-      def should_flatten?
-        if options.key?(:flatten)
-          true
-        elsif [:tgz, :tar, :tbz, :txz].include?(type)
-          true # those archives flatten by default
-        else
-          false # all others (actually only .zip) default not to flatten
-        end
-      end
-
-      def type_with_url(url)
-        case URI.parse(url).path
-        when /\.zip$/
-          :zip
-        when /\.(tgz|tar\.gz)$/
-          :tgz
-        when /\.tar$/
-          :tar
-        when /\.(tbz|tar\.bz2)$/
-          :tbz
-        when /\.(txz|tar\.xz)$/
-          :txz
-        when /\.dmg$/
-          :dmg
-        end
-      end
-
-      def filename_with_type(type = :zip)
-        case type
-        when :zip
-          'file.zip'
-        when :tgz
-          'file.tgz'
-        when :tar
-          'file.tar'
-        when :tbz
-          'file.tbz'
-        when :txz
-          'file.txz'
-        when :dmg
-          'file.dmg'
-        else
-          raise UnsupportedFileTypeError, "Unsupported file type: #{type}"
-        end
-      end
 
       def download_file(full_filename)
-        curl! '-f', '-L', '-o', full_filename, url, '--create-dirs', '--netrc-optional'
-      end
-
-      def extract_with_type(full_filename, type = :zip)
-        unpack_from = full_filename
-        unpack_to = @target_path
-        case type
-        when :zip
-          unzip! unpack_from, '-d', unpack_to
-        when :tgz
-          tar! 'xfz', unpack_from, '-C', unpack_to
-        when :tar
-          tar! 'xf', unpack_from, '-C', unpack_to
-        when :tbz
-          tar! 'xfj', unpack_from, '-C', unpack_to
-        when :txz
-          tar! 'xf', unpack_from, '-C', unpack_to
-        when :dmg
-          extract_dmg(unpack_from, unpack_to)
-        else
-          raise UnsupportedFileTypeError, "Unsupported file type: #{type}"
-        end
-
-        # If the archive is a tarball and it only contained a folder, move its
-        # contents to the target (#727)
-        #
-        if should_flatten?
-          contents = @target_path.children
-          contents.delete(target_path + @filename)
-          entry = contents.first
-          if contents.count == 1 && entry.directory?
-            FileUtils.move(entry.children, target_path)
-          end
-        end
-      end
-
-      def extract_dmg(unpack_from, unpack_to)
-        require 'rexml/document'
-        plist_s = hdiutil! 'attach', '-plist', '-nobrowse', unpack_from, '-mountrandom', unpack_to
-        plist = REXML::Document.new plist_s
-        xpath = '//key[.="mount-point"]/following-sibling::string'
-        mount_point = REXML::XPath.first(plist, xpath).text
-        FileUtils.cp_r(Dir.glob(mount_point + '/*'), unpack_to)
-        hdiutil! 'detach', mount_point
-      end
+        parameters = ['-f', '-L', '-o', full_filename, url, '--create-dirs', '--netrc-optional', '--retry', '2']
+        parameters << user_agent_argument if headers.nil? ||
+            headers.none? { |header| header.casecmp(USER_AGENT_HEADER).zero? }
 
-      def compare_hash(filename, hasher, hash)
-        incremental_hash = hasher.new
+        headers.each do |h|
+          parameters << '-H'
+          parameters << h
+        end unless headers.nil?
 
-        File.open(filename, 'rb') do |file|
-          buf = ''
-          incremental_hash << buf while file.read(1024, buf)
-        end
-
-        computed_hash = incremental_hash.hexdigest
-
-        if computed_hash != hash
-          raise DownloaderError, 'Verification checksum was incorrect, ' \
-            "expected #{hash}, got #{computed_hash}"
-        end
+        curl! parameters
       end
 
-      # Verify that the downloaded file matches a sha1 hash
+      # Returns a cURL command flag to add the CocoaPods User-Agent.
       #
-      def verify_sha1_hash(filename, hash)
-        require 'digest/sha1'
-        compare_hash(filename, Digest::SHA1, hash)
-      end
-
-      # Verify that the downloaded file matches a sha256 hash
-      #
-      def verify_sha256_hash(filename, hash)
-        require 'digest/sha2'
-        compare_hash(filename, Digest::SHA2, hash)
-      end
-
-      # Verify that the downloaded file matches the hash if set
+      # @return [String] cURL command -A flag and User-Agent.
       #
-      def verify_checksum(filename)
-        if options[:sha256]
-          verify_sha256_hash(filename, options[:sha256])
-        elsif options[:sha1]
-          verify_sha1_hash(filename, options[:sha1])
-        end
+      def user_agent_argument
+        "-A '#{Http.user_agent_string}'"
       end
     end
   end

data/lib/cocoapods-downloader/remote_file.rb

@@ -0,0 +1,182 @@
+require 'fileutils'
+require 'uri'
+require 'zlib'
+
+module Pod
+  module Downloader
+    class RemoteFile < Base
+      def self.options
+        [:type, :flatten, :sha1, :sha256, :headers]
+      end
+
+      class UnsupportedFileTypeError < StandardError; end
+
+      private
+
+      executable :unzip
+      executable :tar
+      executable :hdiutil
+
+      attr_accessor :filename, :download_path
+
+      def download!
+        @filename = filename_with_type(type)
+        @download_path = target_path + @filename
+        download_file(@download_path)
+        verify_checksum(@download_path)
+        extract_with_type(@download_path, type)
+      end
+
+      def type
+        if options[:type]
+          options[:type].to_sym
+        else
+          type_with_url(url)
+        end
+      end
+
+      def headers
+        options[:headers]
+      end
+
+      # @note   The archive is flattened if it contains only one folder and its
+      #         extension is either `tgz`, `tar`, `tbz` or the options specify
+      #         it.
+      #
+      # @return [Bool] Whether the archive should be flattened if it contains
+      #         only one folder.
+      #
+      def should_flatten?
+        if options.key?(:flatten)
+          options[:flatten]
+        elsif [:tgz, :tar, :tbz, :txz].include?(type)
+          true # those archives flatten by default
+        else
+          false # all others (actually only .zip) default not to flatten
+        end
+      end
+
+      def type_with_url(url)
+        case URI.parse(url).path
+        when /\.zip$/
+          :zip
+        when /\.(tgz|tar\.gz)$/
+          :tgz
+        when /\.tar$/
+          :tar
+        when /\.(tbz|tar\.bz2)$/
+          :tbz
+        when /\.(txz|tar\.xz)$/
+          :txz
+        when /\.dmg$/
+          :dmg
+        end
+      end
+
+      def filename_with_type(type = :zip)
+        case type
+        when :zip, :tgz, :tar, :tbz, :txz, :dmg
+          "file.#{type}"
+        else
+          raise UnsupportedFileTypeError, "Unsupported file type: #{type}"
+        end
+      end
+
+      def download_file(_full_filename)
+        raise NotImplementedError
+      end
+
+      def extract_with_type(full_filename, type = :zip)
+        unpack_from = full_filename
+        unpack_to = @target_path
+
+        case type
+        when :zip
+          unzip! unpack_from, '-d', unpack_to
+        when :tgz
+          tar! 'xfz', unpack_from, '-C', unpack_to
+        when :tar
+          tar! 'xf', unpack_from, '-C', unpack_to
+        when :tbz
+          tar! 'xfj', unpack_from, '-C', unpack_to
+        when :txz
+          tar! 'xf', unpack_from, '-C', unpack_to
+        when :dmg
+          extract_dmg(unpack_from, unpack_to)
+        else
+          raise UnsupportedFileTypeError, "Unsupported file type: #{type}"
+        end
+
+        # If the archive is a tarball and it only contained a folder, move its
+        # contents to the target (#727)
+        #
+        if should_flatten?
+          contents = target_path.children
+          contents.delete(target_path + @filename)
+          entry = contents.first
+          if contents.count == 1 && entry.directory?
+            tmp_entry = entry.sub_ext("#{entry.extname}.tmp")
+            begin
+              FileUtils.move(entry, tmp_entry)
+              FileUtils.move(tmp_entry.children, target_path)
+            ensure
+              FileUtils.remove_entry(tmp_entry)
+            end
+          end
+        end
+
+        FileUtils.rm(unpack_from) if File.exist?(unpack_from)
+      end
+
+      def extract_dmg(unpack_from, unpack_to)
+        require 'rexml/document'
+        plist_s = hdiutil! 'attach', '-plist', '-nobrowse', unpack_from, '-mountrandom', unpack_to
+        plist = REXML::Document.new plist_s
+        xpath = '//key[.="mount-point"]/following-sibling::string'
+        mount_point = REXML::XPath.first(plist, xpath).text
+        FileUtils.cp_r(Dir.glob(mount_point + '/*'), unpack_to)
+        hdiutil! 'detach', mount_point
+      end
+
+      def compare_hash(filename, hasher, hash)
+        incremental_hash = hasher.new
+
+        File.open(filename, 'rb') do |file|
+          buf = ''
+          incremental_hash << buf while file.read(1024, buf)
+        end
+
+        computed_hash = incremental_hash.hexdigest
+
+        if computed_hash != hash
+          raise DownloaderError, 'Verification checksum was incorrect, ' \
+            "expected #{hash}, got #{computed_hash}"
+        end
+      end
+
+      # Verify that the downloaded file matches a sha1 hash
+      #
+      def verify_sha1_hash(filename, hash)
+        require 'digest/sha1'
+        compare_hash(filename, Digest::SHA1, hash)
+      end
+
+      # Verify that the downloaded file matches a sha256 hash
+      #
+      def verify_sha256_hash(filename, hash)
+        require 'digest/sha2'
+        compare_hash(filename, Digest::SHA2, hash)
+      end
+
+      # Verify that the downloaded file matches the hash if set
+      #
+      def verify_checksum(filename)
+        if options[:sha256]
+          verify_sha256_hash(filename, options[:sha256])
+        elsif options[:sha1]
+          verify_sha1_hash(filename, options[:sha1])
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-downloader/scp.rb

@@ -0,0 +1,30 @@
+require 'uri'
+require 'cocoapods-downloader/remote_file'
+
+module Pod
+  module Downloader
+    class Scp < RemoteFile
+      DEFAULT_PORT = 22
+
+      private
+
+      executable :scp
+
+      def download_file(full_filename)
+        scp! '-P', port, '-q', source, full_filename
+      end
+
+      def source
+        "#{uri.user ? uri.user + '@' : ''}#{uri.host}:'#{uri.path}'"
+      end
+
+      def port
+        uri.port || DEFAULT_PORT
+      end
+
+      def uri
+        @uri ||= URI.parse(url)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-downloader
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Eloy Duran
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-17 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -30,8 +30,10 @@ files:
 - lib/cocoapods-downloader/git.rb
 - lib/cocoapods-downloader/http.rb
 - lib/cocoapods-downloader/mercurial.rb
+- lib/cocoapods-downloader/remote_file.rb
+- lib/cocoapods-downloader/scp.rb
 - lib/cocoapods-downloader/subversion.rb
-homepage: https://github.com/CocoaPods/Downloader
+homepage: https://github.com/CocoaPods/cocoapods-downloader
 licenses:
 - MIT
 metadata: {}
@@ -43,15 +45,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 3
 summary: A small library for downloading files from remotes in a folder.