right_scraper 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 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.

data/README.rdoc

@@ -0,0 +1,81 @@
+= 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
+
+<b>RightScraper</b>
+
+Copyright:: Copyright (c) 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.

data/Rakefile

@@ -0,0 +1,74 @@
+#--
+# Copyright: Copyright (c) 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.
+#++
+
+require 'rubygems'
+require 'fileutils'
+require 'rake'
+require 'spec/rake/spectask'
+
+task :default => 'spec'
+
+# == Unit Tests == #
+
+desc "Run unit tests"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = Dir['**/*_spec.rb']
+end
+
+desc "Run unit tests with RCov"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_files = Dir['**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = lambda do
+    IO.readlines(File.join(File.dirname(__FILE__), 'rcov.opts')).map {|l| l.chomp.split " "}.flatten
+  end
+end
+
+desc "Print Specdoc for unit tests"
+Spec::Rake::SpecTask.new(:doc) do |t|
+   t.spec_opts = ["--format", "specdoc", "--dry-run"]
+   t.spec_files = Dir['**/*_spec.rb']
+end
+
+# == Gem Management == #
+
+desc "Build right_scraper gem"
+task :gem do
+   ruby 'right_scraper.gemspec'
+   pkg_dir = File.join(File.dirname(__FILE__), 'pkg')
+   FileUtils.mkdir_p(pkg_dir)
+   FileUtils.mv(Dir.glob(File.join(File.dirname(__FILE__), '*.gem')), pkg_dir)
+end
+
+desc 'Install the right_scraper library as a gem'
+task :install => [:gem] do
+   file = Dir["pkg/*.gem"].last
+   sh "gem install #{file}"
+end
+
+desc 'Uninstalls and reinstalls the right_scraper library as a gem'
+task :reinstall do
+   sh "gem uninstall right_scraper"
+   sh "rake install"
+end
+

data/lib/right_scraper/repository.rb

@@ -0,0 +1,66 @@
+#--
+# Copyright: Copyright (c) 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.
+#++
+
+module RightScale
+
+  # Description of remote repository that needs to be scraped.
+  class Repository
+    
+    # (String) Human readable repository name used for progress reports
+    attr_accessor :display_name
+    
+    # (String) One of 'git', 'svn' or 'download'
+    attr_accessor :repo_type
+    
+    # (String) URL to repository (e.g 'git://github.com/rightscale/right_scraper.git')
+    attr_accessor :url
+    
+    # (String) Optional, tag or branch of repository that should be downloaded
+    # Not used for 'download' repositories
+    attr_accessor :tag
+    
+    # (String) Optional, SVN username or git private SSH key content
+    attr_accessor :first_credential
+    
+    # (String) Optional, SVN password
+    attr_accessor :second_credential
+   
+    # Initialize repository from given hash
+    # Hash keys should correspond to attributes of this class
+    #
+    # === Parameters
+    # opts(Hash):: Hash to be converted into a RightScale::Repository instance
+    #
+    # === Return
+    # repo(RightScale::Repository):: Resulting repository instance
+    def self.from_hash(opts)
+      repo = RightScale::Repository.new
+      opts.each do |k, v|
+        repo.__send__("#{k.to_s}=".to_sym, v)
+      end
+      repo
+    end
+           
+  end
+  
+end

data/lib/right_scraper/scraper.rb

@@ -0,0 +1,96 @@
+#--
+# Copyright: Copyright (c) 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.
+#++
+
+module RightScale
+
+  # Hash of repository types associated with corresponding scraper class
+  SCRAPERS = { 'git'      => RightScale::GitScraper,
+               'svn'      => RightScale::SvnScraper,
+               'download' => RightScale::DownloadScraper }
+
+  # Library main entry point. Instantiate this class and call the scrape
+  # method to download or update a remote repository to the local disk.
+  class Scraper
+
+    # (String) Path to directory where remote repository was downloaded
+    # Note: This will be a subfolder of the scrape directory (directory given to initializer)
+    attr_reader :repo_dir
+    
+    # Initialize scrape destination directory
+    #
+    # === Parameters
+    # scrape_dir(String):: Scrape destination directory
+    def initialize(scrape_dir)
+      @scrape_dir = scrape_dir
+      @scrapers = {}
+    end
+
+    # Scrape given repository.
+    # Create unique directory inside scrape directory when called for the first time.
+    # Update content of unique directory incrementally when possible with further calls.
+    #
+    # === Parameters
+    # repo(Hash|RightScale::Repository):: Repository to be scraped
+    # Note: repo can either be a Hash or a RightScale::Repo instance.
+    # See the RightScale::Repo class for valid Hash keys.
+    #
+    # === Block
+    # If a block is given, it will be called back with progress information
+    # the block should take two arguments:
+    # - first argument is the string containing the info
+    # - second argument is a boolean indicating whether to increment progress
+    # The block is called exactly once with the increment flag set to true
+    #
+    # === Return
+    # true:: If scrape was successful
+    # false:: If scrape failed, call error_message for information on failure
+    #
+    # === Raise
+    # 'Invalid repository type':: If repository type is not known
+    def scrape(repo, &callback)
+      repo = RightScale::Repository.from_hash(repo) if repo.is_a?(Hash)
+      raise "Invalid repository type" unless SCRAPERS.include?(repo.repo_type)
+      @scraper = @scrapers[repo.repo_type] ||= SCRAPERS[repo.repo_type].new(@scrape_dir)
+      @scraper.scrape(repo, &callback)
+      @repo_dir = @scraper.repo_dir
+      @scraper.succeeded?
+    end
+
+    # Error messages in case of failure
+    #
+    # === Return
+    # errors(Array):: Error messages or empty array if no error
+    def errors
+      errors = @scraper && @scraper.errors || []
+    end
+
+    # Was scraping successful?
+    # Call error_message to get error messages if false
+    #
+    # === Return
+    # succeeded(Boolean):: true if scrape finished with no error, false otherwise.
+    def succeeded?
+      succeeded = @errors.nil? || @errors.size == 0
+    end
+  end
+end

data/lib/right_scraper/scraper_base.rb

@@ -0,0 +1,99 @@
+#--
+# Copyright: Copyright (c) 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.
+#++
+
+require 'digest/md5'
+
+module RightScale
+
+  # Base class for all scrapers.
+  # Actual scraper implementation should override scrape_imp and optionally incremental_update?
+  class ScraperBase
+
+    # (String) Path to directory containing all scraped repositories
+    attr_accessor :root_dir
+
+    # (RightScale::Repository) Last scraped repository
+    attr_reader :repo
+
+    # (Array) Error messages if any
+    attr_reader :errors
+
+    # (String) Path to local directory where repository was downloaded
+    attr_reader :repo_dir
+
+    # Set path to directory containing all scraped repos
+    #
+    # === Parameters
+    # root_dir(String):: Path to scraped repos parent directory
+    def initialize(root_dir)
+      @root_dir = root_dir
+    end
+
+    # Common implementation of scrape method for all repository types.
+    # Each scraper implementation should override scrape_imp which is called
+    # after this method initializes all the scraper attributes properly.
+    # See RightScale::Scraper#scrape
+    def scrape(repo, &callback)
+      @repo            = repo
+      @callback        = callback
+      @scrape_dir_name = Digest::MD5.hexdigest(repo.to_s)
+      @scrape_dir_path = File.join(root_dir, @scrape_dir_name)
+      @repo_dir        = "#{@scrape_dir_path}/repo"
+      @incremental     = incremental_update?
+      @errors          = []
+      FileUtils.rm_rf(@repo_dir) unless @incremental
+      scrape_imp
+      true
+    end
+
+    # Was last call to scrapesuccessful?
+    # Call errors to get error messages if false
+    #
+    # === Return
+    # succeeded(TrueClass|FalseClass):: true if scrape finished with no error, false otherwise.
+    def succeeded?
+      succeeded = @errors.nil? || @errors.size == 0
+    end
+    
+    protected
+
+    # Check whether it is possible to perform an incremental update of the repo
+    #
+    # === Return
+    # true:: Scrape directory contains files belonging to the scraped repo and protocol supports
+    #        incremental updates
+    # false:: Otherwise
+    def incremental_update?
+      false # Incremental updates not supported by default
+    end
+    
+    # Override this method with scraper specific implementation in descendants
+    #
+    # === Return
+    # true:: Always return true
+    def scrape_imp
+      raise "Method not implemented"
+    end
+    
+  end
+end

data/lib/right_scraper/scrapers/download_scraper.rb

@@ -0,0 +1,58 @@
+#--
+# Copyright: Copyright (c) 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.
+#++
+
+module RightScale
+
+  class DownloadScraper < ScraperBase
+
+    # Download and expand remote repository, see RightScale::ScraperBase#scrape
+    #
+    # === Return
+    # true:: Always return true
+    def scrape_imp
+      msg = "Downloading repository '#{@repo.display_name}'"
+      @callback.call(msg, is_step=true) if @callback
+      filename = @repo.url.split('/').last
+      user_opt = @repo.first_credential && @repo.second_credential ? "--user #{@repo.first_credential}:#{@repo.second_credential}" : ''
+      cmd = "curl --fail --silent --show-error --insecure --location #{user_opt} --output '#{@repo_dir}/#{filename}' '#{@repo.url}' 2>&1"
+      FileUtils.mkdir_p(@repo_dir)
+      res = `#{cmd}`
+      @errors << res if $? != 0
+      if succeeded?
+        unzip_opt = case @repo.url[/\.(.*)$/]
+          when 'bzip', 'bzip2' then 'j'
+          when 'tgz', 'gzip' then 'z'
+          else ''
+        end
+        Dir.chdir(@repo_dir) do
+          cmd = "tar x#{unzip_opt}f #{filename} 2>&1"
+          res = `#{cmd}`
+          @errors << res if $? != 0
+          File.delete(filename)
+        end
+      end
+      true
+    end
+
+  end
+end

data/lib/right_scraper/scrapers/git_scraper.rb

@@ -0,0 +1,168 @@
+#--
+# Copyright: Copyright (c) 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.
+#++
+
+module RightScale
+
+  class GitScraper < ScraperBase
+
+    # Check whether it is possible to perform an incremental update of the repo
+    #
+    # === Return
+    # true:: Scrape directory contains files belonging to the scraped repo and protocol supports
+    #        incremental updates
+    # false:: Otherwise
+    def incremental_update?
+      return false unless File.directory?(@repo_dir)
+      Dir.chdir(@repo_dir) do
+        remote_url = `git config --get remote.origin.url`.chomp
+        $?.success? && remote_url == @repo.url
+      end
+    end
+
+    # Scrape git repository, see RightScale::ScraperBase#scrape
+    #
+    # === Return
+    # true:: Always return true
+    def scrape_imp
+      msg = @incremental ? "Pulling " : "Cloning "
+      msg += "git repository '#{@repo.display_name}'"
+      @callback.call(msg, is_step=true) if @callback
+      ssh_cmd = ssh_command
+      res = ""
+      is_tag = nil
+      is_branch = nil
+
+      if @incremental
+        Dir.chdir(@repo_dir) do
+          is_tag, is_branch, res = git_tag_kind(ssh_cmd)
+          if !is_tag && !is_branch
+            @callback.call("Nothing to update: repo tag refers to neither a branch nor a tag", is_step=false)
+            return true
+          end
+          if is_tag && is_branch
+            @errors << 'Repository tag ambiguous: could be git tag or git branch'
+          else
+            tag = @repo.tag.nil? || @repo.tag.empty? ? 'master' : @repo.tag
+            res += `#{ssh_cmd} git pull --quiet --depth 1 origin #{tag} 2>&1`
+            if $? != 0
+              @callback.call("Failed to pull repo: #{res}, falling back to cloning", is_step=false) if @callback
+              FileUtils.rm_rf(@repo_dir)
+              @incremental = false
+            end
+          end
+        end
+      end
+      if !@incremental
+        res += `#{ssh_cmd} git clone --quiet --depth 1 #{@repo.url} #{@repo_dir} 2>&1`
+        @errors << res if $? != 0
+        if !@repo.tag.nil? && !@repo.tag.empty? && @repo.tag != 'master' && succeeded?
+          Dir.chdir(@repo_dir) do
+            if is_tag.nil?
+              is_tag, is_branch, out = git_tag_kind(ssh_cmd)
+              res += out
+            end
+            if is_tag && is_branch
+              @errors << 'Repository tag ambiguous: could be git tag or git branch'
+            elsif is_branch
+              res += `git branch #{@repo.tag} origin/#{@repo.tag} 2>&1`
+              @errors << res if $? != 0
+            elsif !is_tag # Not a branch nor a tag, SHA ref? fetch everything so we have all SHAs
+              res += `#{ssh_cmd} git fetch origin master --depth #{2**31 - 1} 2>&1`
+              @errors << res if $? != 0
+            end
+            if succeeded?
+              res += `git checkout #{@repo.tag} 2>&1`
+              @errors << res if $? != 0
+            end
+          end
+        end
+      end
+      true
+    end
+
+    # Default SSH options used with git
+    DEFAULT_SSH_OPTIONS = { :PasswordAuthentication  => 'no',
+                            :HostbasedAuthentication => 'no',
+                            :StrictHostKeyChecking   => 'no',
+                            :IdentitiesOnly          => 'yes' }
+
+    # SSH options command line built from default options and given custom options
+    #
+    # === Parameters
+    # opts(Hash):: Custom options
+    #
+    # === Return
+    # options(String):: SSH command line options
+    def ssh_options(opts={})
+      opts = DEFAULT_SSH_OPTIONS.merge(opts || {})
+      options = opts.inject('') { |o, (k, v)| o << "#{k.to_s}=#{v}\n" }
+    end
+
+    # Store public SSH key into temporary folder and create temporary script
+    # that wraps SSH and uses this key.
+    #
+    # === Return
+    # ssh(String):: Code to initialize GIT_SSH environment variable with path to SSH wrapper script
+    def ssh_command
+      ssh_dir = File.join(@scrape_dir_path, '.ssh')
+      FileUtils.mkdir_p(ssh_dir)
+      key_content = @repo.first_credential
+      if key_content.nil?
+        # Explicitely disable public key authentication so we don't endup using the system's key
+        options = { :PubkeyAuthentication => 'no' }
+      else    
+        ssh_key_path = File.join(ssh_dir, 'ssh.pub')
+        File.open(ssh_key_path, 'w') { |f| f.puts(key_content) }
+        File.chmod(0600, ssh_key_path)
+        options = { :IdentityFile => ssh_key_path }
+      end
+      ssh_config = File.join(ssh_dir, 'ssh_config')
+      File.open(ssh_config, 'w') { |f| f.puts(ssh_options(options)) }
+      ssh = File.join(ssh_dir, 'ssh')
+      File.open(ssh, 'w') { |f| f.puts("ssh -F #{ssh_config} $*") }
+      File.chmod(0755, ssh)
+      "GIT_SSH=#{ssh}"
+    end
+
+    # Resolves whehter repository tag is a git tag or a git branch
+    # Return output of run commands too
+    # Note:: Assume that current working directory is a git directory
+    #
+    # === Parameters
+    # ssh_cmd<String>:: SSH command to be used with git if any
+    #
+    # === Return
+    # res<Array>::
+    #   - res[0] is true if git repo has a tag with a name corresponding to the repository tag
+    #   - res[1] is true if git repo has a branch with a name corresponding to the repository tag
+    #   - res[2] contains the git output
+    def git_tag_kind(ssh_cmd)
+      return [ false, true, "" ] if @repo.tag.nil? || @repo.tag.empty? || @repo.tag == 'master'
+      output = `#{ssh_cmd} git fetch --tags --depth 1 2>&1`
+      is_tag = `git tag`.split("\n").include?(@repo.tag)
+      is_branch = `git branch -r`.split("\n").map { |t| t.strip }.include?("origin/#{@repo.tag}")
+      res = [ is_tag, is_branch, output ]
+    end
+
+  end
+end