git_duplicator 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c56bf9a2478b996375f297102452f577a678625f
-  data.tar.gz: c9dcca68935f1f25245686697d9e1ee191811b33
+  metadata.gz: 41ed03abddf02fd443578e3f337713da86e085ae
+  data.tar.gz: 065fb1a481102c0ebc59425d2cd2d34321cf7481
 SHA512:
-  metadata.gz: 43b7d1d5308dcfbe6b812166463282c7ad47f6d0dbcd87b550ff38dab6eefaf36c17b481210c09af1d775dde79c4a05f82b1a6168399ac06497815f058f2d41f
-  data.tar.gz: a21c7b71c3b1269b19be4593c646873f05ade3fd6cf4e1dda211ffc1586e507dec80480d9bdbf0fe637936d1c401d144415dd89651e49d077e7713a364529ea9
+  metadata.gz: 55a30dabf88926510f0c62e81e1c5a6c35e806a7462714e8cfbef483bf99b0aff6e6e2880f4956234f0167fa1a0bd82ce78fd6956aaef779b22f2752c0e02692
+  data.tar.gz: 862524fa37e6105d6e8812d851bab25dfbf01104537e1641e8ec7d5f5b91e22e72295a4c9181201198a3eb5dbe8a62185780497fc4da6af15f9bada5ea54a86e

data/README.md

@@ -1,10 +1,13 @@
 # Git Duplicator
 
-Duplicating git repositories without forking.
+[![Gem Version](https://badge.fury.io/rb/git_duplicator.svg)](http://badge.fury.io/rb/git_duplicator) [![Build Status](https://travis-ci.org/Startappz/git_duplicator.svg?branch=master)](https://travis-ci.org/Startappz/git_duplicator) [![Coverage Status](https://coveralls.io/repos/Startappz/git_duplicator/badge.png?branch=master)](https://coveralls.io/r/Startappz/git_duplicator?branch=master) [![Dependency Status](https://gemnasium.com/Startappz/git_duplicator.svg)](https://gemnasium.com/Startappz/git_duplicator) [![Code Climate](https://codeclimate.com/github/Startappz/git_duplicator/badges/gpa.svg)](https://codeclimate.com/github/Startappz/git_duplicator)
 
-- [x] Duplicate any repository
-- [x] Additional Github support
-- [x] Additional Bibucket support
+
+Duplicating git repositories without forking. It depends on the flow described in [this](https://help.github.com/articles/duplicating-a-repository) article.
+
+- [x] Duplicate any repository in two ways: one time usage and frequent updates.
+- [x] Additional Github [support](https://github.com/Startappz/git_duplicator/blob/master/lib/git_duplicator/services/github.rb) to create and delete repositories.
+- [x] Additional Bibucket [support](https://github.com/Startappz/git_duplicator/blob/master/lib/git_duplicator/services/bitbucket.rb)  to create and delete repositories.
 
 ## Installation
 
@@ -22,30 +25,105 @@ Or install it yourself as:
 
 ## Usage
 
-### Basic usage
+### Duplicate with no future updates 
+
+Duplicate a repository. Then you can turn off the source repo and move to the mirrored one.
 
-Duplicate a repository. It assumes that you have the destination repository initiated. 
+#### Basic usage
+
+It assumes that you have the destination repository initiated. 
 
 ```ruby
 require 'git_duplicator'
-from = GitDuplicator::Repository
-.new('source repo name', 'source repo url')
-to = GitDuplicator::Repository
-.new('destination repo name', 'destination repo url')
+
+from = GitDuplicator::Repository.new('source repo name', 'source repo url')
+
+to = GitDuplicator::Repository.new('mirrored repo name', 'mirrored repo url')
+
 GitDuplicator.perform(from, to)
 
+
 ```
-### Advanced usage
+#### Advanced usage
 - You can create the destination repository automatically. This needs you to provide the needed authentication credentials for the script.
 - You can set the clone working path locally for the script to work. It's a temporary workplace that will get swiped after finishing.
 
 ```ruby
 require 'git_duplicator'
-from = GitDuplicator::Repository
-.new('source repo name', 'source repo url')
-to = GitDuplicator::Services::GithubRepository
-.new('destination repo name', 'destination owner', {auth2_token: 'some token'})
-GitDuplicator.perform(from, to, force_create_destination: true, clone_path: 'path/to/tmp')
+
+from = GitDuplicator::Repository.new('source repo name', 'source repo url')
+
+to = GitDuplicator::Services::GithubRepository.new(
+  'mirrored repo name', 'mirrored owner',
+  credentials: { oauth2_token: 'some token' },
+  remote_options: { has_issues: false, has_wiki: false }
+)
+
+GitDuplicator.perform(
+  from, to,
+  force_create_destination: true,
+  clone_path: 'path/to/clone/folder'
+)
+
+```
+### Duplicate with future updates 
+
+Duplicate a repository. To update your mirror, fetch updates and push, which could be automated by running a cron job.
+
+#### Basic usage
+
+It assumes that you have the destination repository initiated. 
+
+```ruby
+require 'git_duplicator'
+
+from = GitDuplicator::Repository.new('source repo name', 'source repo url')
+
+to = GitDuplicator::Repository.new('mirrored repo name', 'mirrored repo url')
+
+GitDuplicator.perform_for_update(from, to)
+
+# Later on if you want to update the mirrored one
+local_repo = GitDuplicator::Repository.new(
+  'source repo name',
+  'source repo url',
+  'path/to/working/directory'
+)
+
+local_repo.update_mirrored
+
+```
+#### Advanced usage
+- You can create the destination repository automatically. This needs you to provide the needed authentication credentials for the script.
+- You can set the clone working path locally for the script to work. It's a temporary workplace that will get swiped after finishing.
+
+```ruby
+require 'git_duplicator'
+
+from = GitDuplicator::Repository.new('source repo name', 'source repo url')
+
+to = GitDuplicator::Services::GithubRepository.new(
+  'mirrored repo name',
+  'mirrored owner',
+  credentials: { oauth2_token: 'some token' },
+  remote_options: { has_issues: false, has_wiki: false }
+)
+
+GitDuplicator.perform_for_update(
+  from, to,
+  force_create_destination: true,
+  clone_path: 'path/to/clone/folder'
+)
+
+# Later on if you want to update the mirrored one
+local_repo = GitDuplicator::Repository.new(
+  'source repo name',
+  'source repo url',
+  'path/to/working/directory'
+)
+
+local_repo.update_mirrored
+
 ```
 
 ### Available Services

data/lib/git_duplicator.rb

@@ -1,5 +1,5 @@
 require_relative 'git_duplicator/version'
-require_relative 'git_duplicator/duplicator'
+require_relative 'git_duplicator/duplicators'
 require_relative 'git_duplicator/repositories'
 require_relative 'git_duplicator/services'
 
@@ -7,9 +7,15 @@ require_relative 'git_duplicator/services'
 module GitDuplicator
   class << self
     # Perform the duplication
-    # @see GitDuplicator::Duplicator
+    # @see GitDuplicator::MirrorDuplicator
     def perform(from, to, options)
-      Duplicator.new(from, to, options).perform
+      MirrorDuplicator.new(from, to, options).perform
+    end
+
+    # Perform the duplication for updates
+    # @see GitDuplicator::UpdateDuplicator
+    def perform_for_update(from, to, options)
+      UpdateDuplicator.new(from, to, options).perform
     end
   end
 end

data/lib/git_duplicator/{duplicator.rb → duplicator/duplicator.rb}

@@ -1,7 +1,5 @@
-require 'fileutils'
-require_relative 'null_logger'
-
 module GitDuplicator
+  # Abstract class
   class Duplicator
     attr_accessor :from, :to, :logger, :clone_path, :force_create_destination
 
@@ -33,10 +31,6 @@ module GitDuplicator
       clean_up
     end
 
-    private
-
-    attr_accessor :source_cloned
-
     def recreate_destination
       return unless force_create_destination
       logger.info("Deleting existing destination repo: #{to.url}")
@@ -47,20 +41,29 @@ module GitDuplicator
 
     def clone_source
       logger.info("Cloning bare Gitorious repo: #{from.url}")
-      from.bare_clone(clone_path)
-      self.source_cloned = true
+      perform_clone_source
     end
 
     def mirror
       logger.info("Mirroring Gitorious to Bitbucket: #{from.url}")
-      from.mirror(to.url)
+      perform_mirror
     end
 
     def clean_up
-      return unless source_cloned
       logger.info 'Clean local source repo'
-      FileUtils.rm_rf("#{clone_path}/#{from.name}")
-      @cloned = nil
+      perform_clean_up
+    end
+
+    def perform_clone_source
+      fail NotImplementedError
+    end
+
+    def perform_mirror
+      fail NotImplementedError
+    end
+
+    def perform_clean_up
+      fail NotImplementedError
     end
   end
 end

data/lib/git_duplicator/duplicator/mirror_duplicator.rb

@@ -0,0 +1,18 @@
+module GitDuplicator
+  # Mirror a repository
+  class MirrorDuplicator < Duplicator
+    protected
+
+    def perform_clone_source
+      from.bare_clone(clone_path)
+    end
+
+    def perform_mirror
+      from.mirror(to.url)
+    end
+
+    def perform_clean_up
+      FileUtils.rm_rf("#{clone_path}/#{from.name}")
+    end
+  end
+end

data/lib/git_duplicator/duplicator/update_duplicator.rb

@@ -0,0 +1,17 @@
+module GitDuplicator
+  # Mirror a repository and end make it ready for updates
+  class UpdateDuplicator < Duplicator
+    protected
+    
+    def perform_clone_source
+      from.mirror_clone(clone_path)
+    end
+
+    def perform_mirror
+      from.set_mirrored_remote(to.url)
+      from.update_mirrored
+    end
+
+    def perform_clean_up; end
+  end
+end

data/lib/git_duplicator/duplicators.rb

@@ -0,0 +1,5 @@
+require 'fileutils'
+require_relative 'null_logger'
+require_relative 'duplicator/duplicator'
+require_relative 'duplicator/mirror_duplicator'
+require_relative 'duplicator/update_duplicator'

data/lib/git_duplicator/errors.rb

@@ -8,4 +8,8 @@ module GitDuplicator
   class RepositoryCloningError < MigrationError; end
 
   class RepositoryMirorringError < MigrationError; end
+
+  class RepositoryMirorredUpdatingError < MigrationError; end
+
+  class RepositorySettingRemoteError < MigrationError; end
 end

data/lib/git_duplicator/repositories.rb

@@ -1,3 +1,4 @@
 require_relative 'errors'
+require_relative 'helpers/authorization_header'
 require_relative 'repository/repository'
 require_relative 'repository/service_repository'

data/lib/git_duplicator/repository/repository.rb

@@ -4,21 +4,21 @@ module GitDuplicator
   # Basic Repostiroy
   class Repository
     attr_accessor :name, :url
-    attr_reader :repo
+    attr_reader :working_directory
 
     # Initializer
     # @param [String] name name of the repository
     # @param [String] url URL of the repository
-    def initialize(name, url)
+    # @param [String] working_directory working directory of the repository
+    def initialize(name, url, working_directory = nil)
       self.name = name
       self.url = url
+      self.working_directory = working_directory
     end
 
-    # Repository attribute setter
-    # @param [Git::Base] repository
-    def repo=(repository)
-      fail(TypeError) unless repository.is_a?(Git::Base)
-      @repo = repository
+    def working_directory=(value)
+      @working_directory = value
+      @repo = repo_from_path
     end
 
     # Bare clone the repository
@@ -29,13 +29,89 @@ module GitDuplicator
       raise RepositoryCloningError, exception.message
     end
 
+    # Mirror clone the repository
+    # @param [String] path_to_repo path to clone the repository to
+    def mirror_clone(path_to_repo)
+      path = File.join(path_to_repo, name)
+      command('clone', '--mirror', url, path)
+      self.repo = Git.bare(path)
+    rescue => exception
+      raise RepositoryCloningError, exception.message
+    end
+
     # Mirror the repository
-    # @param [String] destination_url URL of destination repository 
-    def mirror(destination_url)
+    # @param [String] mirrored_url URL of mirrored repository
+    def mirror(mirrored_url)
       fail('No local repo defined. Set the "repo" attribute') unless repo
-      repo.push(destination_url, '--mirror')
+      repo.push(mirrored_url, '--mirror')
     rescue => exception
       raise RepositoryMirorringError, exception.message
     end
+
+    # Set the remote URL of the mirrored
+    # @param [String] mirrored_url URL of mirrored repository
+    def set_mirrored_remote(mirrored_url)
+      fail('No local repo defined. Set the "repo" attribute') unless repo
+      command('remote', 'set-url', '--push', 'origin', mirrored_url)
+    rescue => exception
+      raise RepositorySettingRemoteError, exception.message
+    end
+
+    # Update a mirrored repository
+    def update_mirrored
+      fail('No local repo defined. Set the "repo" attribute') unless repo
+      command('fetch', '-p', 'origin')
+      command('push', '--mirror')
+    rescue => exception
+      raise RepositoryMirorredUpdatingError, exception.message
+    end
+
+    protected
+
+    attr_reader :repo # for testing
+
+    def repo=(value)
+      @repo = value
+      @working_directory = working_directory_from_repo
+    end
+
+    def repo_from_path
+      if working_directory
+        Git.open(working_directory) rescue Git.bare(working_directory)
+      else
+        nil
+      end
+    end
+
+    def working_directory_from_repo
+      return nil if repo.nil?
+      if repo.dir
+        repo.dir.path
+      elsif repo.repo
+        repo.repo.path
+      else
+        nil
+      end
+    end
+
+    def command(cmd, *opts)
+      git_cmd = "git #{cmd} #{opts.join(' ')}"
+      out = run_command(git_cmd)
+      if $?.exitstatus > 0
+        if $?.exitstatus == 1 && out == ''
+          return ''
+        end
+        fail(git_cmd + ': ' + out.to_s)
+      end
+    end
+
+    def run_command(cmd)
+      exec = "#{cmd} 2>&1"
+      if working_directory
+        Dir.chdir(working_directory) { `#{exec}` }
+      else
+        `#{exec}`
+      end.chomp
+    end
   end
 end

data/lib/git_duplicator/repository/service_repository.rb

@@ -6,9 +6,10 @@ module GitDuplicator
     # Initializer
     # @param [String] name name of the repository
     # @param [String] owner owner of the repository
-    def initialize(name, owner)
+    # @param [String] working_directory working directory of the repository
+    def initialize(name, owner, working_directory = nil)
       self.owner = owner
-      super(name, url)
+      super(name, url, working_directory)
     end
 
     # URL of the repositroy

data/lib/git_duplicator/services/bitbucket.rb

@@ -1,30 +1,31 @@
 require 'http'
-require_relative '../helpers/authorization_header'
-
 module GitDuplicator
   module Services
     # Bitbucket based repository
     class BitbucketRepository < ServiceRepository
       BASE_URI = 'https://api.bitbucket.org/2.0'
 
-      attr_accessor :credentials, :options
+      attr_accessor :credentials, :remote_options
 
       # Initializer
       # @param [String] name name of the repository
       # @param [String] owner owner of the repository
-      # @param [Hash] credentials
-      # @option credentials [Symbol] :consumer_key used in oAuth authentication
-      # @option credentials [Symbol] :consumer_secret used in oAuth authentication
-      # @option credentials [Symbol] :token used in oAuth authentication
-      # @option credentials [Symbol] :token_secret used in oAuth authentication
-      # @option credentials [Symbol] :username used in basic authentication
-      # @option credentials [Symbol] :password used in basic authentication
-      # @param [Hash] options options for creation
-      # @see https://confluence.atlassian.com/display/BITBUCKET/repository+Resource#repositoryResource-POSTanewrepository
-      def initialize(name, owner, credentials = {}, options = {})
-        super(name, owner)
-        self.credentials = credentials
-        self.options = options
+      # @param [Hash] options
+      #   * :credentials (Hash) credentials for remote service
+      #     * :consumer_key (Symbol) used in oAuth authentication
+      #     * :consumer_secret (Symbol) used in oAuth authentication
+      #     * :token (Symbol) used in oAuth authentication
+      #     * :token_secret (Symbol) used in oAuth authentication
+      #     * :username (Symbol) used in basic authentication
+      #     * :password (Symbol) used in basic authentication
+      #   * :remote_options (Hash) creation options for remote service
+      #    @see https://confluence.atlassian.com/display/BITBUCKET/repository+Resource#repositoryResource-POSTanewrepository
+      #   * :working_directory (String) assing a working directory
+      def initialize(name, owner, options = {})
+        self.credentials = options.fetch(:credentials) { {} }
+        self.remote_options = options.fetch(:remote_options) { {} }
+        self.working_directory = options.fetch(:working_directory) { nil }
+        super(name, owner, working_directory)
       end
 
       # URL of the repositroy
@@ -37,7 +38,7 @@ module GitDuplicator
       def create
         request_url = BASE_URI + "/repositories/#{owner}/#{name}"
         response = HTTP.with(headers(:post, request_url))
-        .post(request_url, json: options)
+        .post(request_url, json: remote_options)
         code, body = response.code.to_i, response.body
         fail(RepositoryCreationError, body) unless 200 == code
       end