https://github.com/CocoaPods/cocoapods-downloader

A small library that provides downloaders for various source types (HTTP/SVN/Git/Mercurial)
https://github.com/CocoaPods/cocoapods-downloader

Last synced: 3 months ago
JSON representation

A small library that provides downloaders for various source types (HTTP/SVN/Git/Mercurial)

• Host: GitHub
• URL: https://github.com/CocoaPods/cocoapods-downloader
• Owner: CocoaPods
• License: mit
• Created: 2012-12-12T16:32:08.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2024-06-27T10:12:32.000Z (7 months ago)
• Last Synced: 2024-10-29T12:58:46.113Z (3 months ago)
• Language: Ruby
• Homepage:
• Size: 1.72 MB
• Stars: 84
• Watchers: 17
• Forks: 72
• Open Issues: 21
• Metadata Files:
  • Readme: README.markdown
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Downloader

A small library for downloading files from remotes in a folder.

[![Build Status](https://github.com/CocoaPods/cocoapods-downloader/workflows/Specs/badge.svg)](https://github.com/CocoaPods/cocoapods-downloader/actions/workflows/Specs.yml)

[![Gem Version](https://img.shields.io/gem/v/cocoapods-downloader)](https://rubygems.org/gems/cocoapods-downloader)

[![Maintainability](https://api.codeclimate.com/v1/badges/2253ffb0c2c98e4d1c71/maintainability)](https://codeclimate.com/github/CocoaPods/cocoapods-downloader/maintainability)

## Install

```

$ [sudo] gem install cocoapods-downloader

```

## Usage

```ruby

require 'cocoapods-downloader'

target_path = './Downloads/MyDownload'

options = { :git => 'example.com' }

options = Pod::Downloader.preprocess_options(options)

downloader = Pod::Downloader.for_target(target_path, options)

downloader.cache_root = '~/Library/Caches/APPNAME'

downloader.max_cache_size = 500

downloader.download

downloader.checkout_options #=> { :git => 'example.com', :commit => 'd7f410490dabf7a6bde665ba22da102c3acf1bd9' }

```

The downloader class supports the following option keys:

- git: commit, tag, branch, submodules

- svn: revision, tag, folder, externals

- hg: revision, tag, branch

- http: type, flatten

- scp: type, flatten

The downloader also provides hooks which allow to customize its output or the way in which the commands are executed

```ruby

require 'cocoapods-downloader'

module Pod

  module Downloader

    class Base

      override_api do

        def self.execute_command(executable, command, raise_on_failure = false)

          puts "Will download"

          super

        end

        def self.ui_action(ui_message)

          puts ui_message.green

          yield

        end

      end

    end

  end

end

```

## Extraction

This gem was extracted from [CocoaPods](https://github.com/CocoaPods/CocoaPods). Refer to also that repository for the history and the contributors.

## Collaborate

All CocoaPods development happens on GitHub, there is a repository for [CocoaPods](https://github.com/CocoaPods/CocoaPods) and one for the [CocoaPods specs](https://github.com/CocoaPods/Specs). Contributing patches or Pods is really easy and gratifying and for a lot of people is their first time.

Follow [@CocoaPods](http://twitter.com/CocoaPods) to get up to date information about what's going on in the CocoaPods world.

## Development

You need to have `svn`, `hg` and `git` installed to run the specs. There are some specs which require `hdiutil` which will only run on macOS.

## License

This gem and CocoaPods are available under the MIT license.