RightScraper

DESCRIPTION

Synopsis

RightScraper provides a simple interface to download and keep repositories up-to-date using various protocols.

The supported protocols include:

  • git: RightScraper will clone then pull repos from git

  • SVN: RightScraper will checkout then update SVN repositories

  • tarballs: Includes uncompressed (.tar), gzip (.tgz, .gzip) and bzip (.bzip, .bzip2) tar files.

The scraper first inspects the local directory to see if the repo has already been scraped and if so runs some basic checks before it tries to update it. Incremental updates are not supported with tar files.

Rationale

The idea is to have many repos that need to be downloaded/kept up-to-date in a central place. Point the scraper to this central place and it will take care of creating unique local directories for each remote repository and keep that mapping to download changes incrementally upon request.

USAGE

Simple Example

require 'rubygems'
require 'right_scraper'

scraper = RightScale::Scraper.new('/tmp')
scraper.scrape(:type => :git, :url => 'git://github.com/rightscale/right_scraper.git')

INSTALLATION

RightScraper can be installed by entering the following at the command prompt:

gem install right_scraper

DEPENDENCIES

RightScraper relies on the following tools:

  • git

  • svn

  • curl

TESTING

Install the following RubyGems required for testing:

  • rspec

The build can be tested using the RSpec gem.

rake spec

LICENSE

RightScraper

Copyright

Copyright © 2010 RightScale, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.