gitti-backup 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10cb944dcd9536d4c7b558b2490db1eb0addb9ce
-  data.tar.gz: 4cb0022b84627722a8891d0adc4a1aa20f9935bc
+  metadata.gz: da31fe3c40e34387650d37bac81a8a4c15ce858c
+  data.tar.gz: 595414af6e4655bb6dddc552db194794ac31cb72
 SHA512:
-  metadata.gz: 3a6b92b4850612350321f78a3def3fd968b1ed33b321e21dd3174d7a295930e8128f3abc80af49a22b2c752da4bfc3af45c76717c462d20f594459dff993cd0a
-  data.tar.gz: 2e42a28928f778f55e40cef53a7368df2b933035020fc790ea172158484c96889ca922a264f25fac0cc9041c85c8d29b736a408dfdf4d85bb67304ca8599521b
+  metadata.gz: 3881867d7f7513f4af361c9a15b96092ce026ed122055d960ef24f3158f777b293dda7a01c1819bf6fee6673060639c29d1720d761ee43ad7a5734d0ba7de312
+  data.tar.gz: e4d6a6066aebdc6e12b2ddaeac156583b78bdba87fac097d80fb2875ef7b5c37983d76b8c730f7772530aa07f1e08a85f306b0ee83929c56cdcb0edaecb893a0

data/Manifest.txt

@@ -1,10 +1,10 @@
-HISTORY.md
+CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
 lib/gitti/backup.rb
 lib/gitti/backup/backup.rb
-lib/gitti/backup/repo.rb
+lib/gitti/backup/base.rb
 lib/gitti/backup/version.rb
 test/data/repos.yml
 test/helper.rb

data/README.md

@@ -2,15 +2,40 @@
 
 gitti-backup gem - (yet) another (lite) git backup command line script
 
-* home  :: [github.com/rubylibs/gitti](https://github.com/rubylibs/gitti)
-* bugs  :: [github.com/rubylibs/gitti/issues](https://github.com/rubylibs/gitti/issues)
+* home  :: [github.com/rubycoco/gitti](https://github.com/rubycoco/gitti)
+* bugs  :: [github.com/rubycoco/gitti/issues](https://github.com/rubycoco/gitti/issues)
 * gem   :: [rubygems.org/gems/gitti-backup](https://rubygems.org/gems/gitti-backup)
 * rdoc  :: [rubydoc.info/gems/gitti-backup](http://rubydoc.info/gems/gitti-backup)
 
 
 ## Usage
 
-TBD
+
+``` ruby
+require 'gitti/backup'
+
+## step 1: setup the root backup directory - defaults to ~/backup
+backup = GitBackup.new
+
+## step 2: pass in all repos to backup by using
+##   1) git clone --mirror or
+##   2) git remote update  (if local backup already exists)
+backup.backup( GitRepoSet.read( './repos.yml' ) )
+```
+
+That's all for now.
+
+
+
+## Installation
+
+Use
+
+    gem install gitti-backup
+
+or add to your Gemfile
+
+    gem 'gitti-backup'
 
 
 ## License

data/Rakefile

@@ -8,23 +8,23 @@ Hoe.spec 'gitti-backup' do
   self.summary = 'gitti-backup - (yet) another (lite) git backup command line script'
   self.description = summary
 
-  self.urls    = ['https://github.com/rubylibs/gitti']
+  self.urls    = { home: 'https://github.com/rubycoco/gitti' }
 
   self.author  = 'Gerald Bauer'
   self.email   = 'ruby-talk@ruby-lang.org'
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'
-  self.history_file = 'HISTORY.md'
+  self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
-    ['gitti' ],
+    ['gitti', '>= 0.3.0' ],
   ]
 
   self.licenses = ['Public Domain']
 
   self.spec_extras = {
-   required_ruby_version: '>= 1.9.2'
+   required_ruby_version: '>= 2.2.2'
   }
 
 end

data/lib/gitti/backup.rb

@@ -1,13 +1,7 @@
-# encoding: utf-8
+require_relative 'backup/base'
 
-require 'gitti'
 
-# our own code
-require 'gitti/backup/version'   # note: let version always go first
-require 'gitti/backup/repo'
-require 'gitti/backup/backup'
-
-
-# say hello
-puts GittiBackup.banner    if defined?($RUBYLIBS_DEBUG)
+## note: auto include Gitti; for "modular" version use ("Sinatra-style")
+##         require "gitti/backup/base"
 
+include Gitti

data/lib/gitti/backup/backup.rb

@@ -1,53 +1,90 @@
-# encoding: utf-8
-
 
 module Gitti
 
 
 class GitBackup
 
-  def initialize( backup_dir = '~/backup' )
-    @backup_dir = File.expand_path( backup_dir )
-    pp @backup_dir
-    ##  use/renmae to backup_root - why? why not??
+  def initialize( root= '~/backup' )
+    @root = File.expand_path( root )
+    pp @root
+
+    ## use current working dir for the log path; see do_with_log helper for use
+    @log_path = File.expand_path( '.' )
+    pp @log_path
   end
 
+
   def backup( repos )
+    count_orgs  = 0
+    count_repos = 0
+
+    total_repos  = repos.size
+
     ##  default to adding folder per day ## e.g. 2015-11-20
-    backup_dir = "#{@backup_dir}/#{Date.today.strftime('%Y-%m-%d')}"
-    pp backup_dir
-    
-    FileUtils.mkdir_p( backup_dir )   ## make sure path exists
+    backup_path = "#{@root}/#{Date.today.strftime('%Y-%m-%d')}"
+    pp backup_path
 
-    org_count   = 0
-    repo_count  = 0
+    FileUtils.mkdir_p( backup_path )   ## make sure path exists
 
-    repos.each do |key,values|
-      dest_dir = "#{backup_dir}/#{key}"
-      FileUtils.mkdir_p( dest_dir )   ## make sure path exists
+    repos.each do |org, names|
+      org_path = "#{backup_path}/#{org}"
+      FileUtils.mkdir_p( org_path )   ## make sure path exists
 
-      values.each_with_index do |value,i|
-        puts " \##{repo_count+1} [#{i+1}/#{values.size}] #{value}"
+      names.each do |name|
+        puts "[#{count_repos+1}/#{total_repos}] #{org}@#{name}..."
 
-        puts "     #{key}/#{value}"
+        repo = GitHubRepo.new( org, name )  ## owner, name e.g. rubylibs/webservice
 
-        repo    = GitHubBareRepo.new( key, value )  ## owner, name e.g. rubylibs/webservice
-        success = repo.backup_with_retries( dest_dir )   ## note: defaults to two tries   
-        ## todo/check:  fail if success still false after x retries? -- why? why not?
+        success = Dir.chdir( org_path ) do
+                    if Dir.exist?( "#{repo.name}.git" )
+                      GitMirror.open( "#{repo.name}.git" ) do |mirror|
+                        do_with_retries { mirror.update }   ## note: defaults to two tries
+                      end
+                    else
+                      do_with_retries { Git.mirror( repo.https_clone_url ) }
+                    end
+                  end
 
-        repo_count += 1
+        ## todo/check:  fail if success still false after x retries? -- why? why not?
 
-        ###  exit if repo_count > 2
+        count_repos += 1
       end
-
-      org_count += 1  
+      count_orgs += 1
     end
-  
-    ## print stats
 
-    puts "  #{org_count} orgs, #{repo_count} repos"
+    ## print stats
+    puts "  #{count_repos} repo(s) @ #{count_orgs} org(s)"
   end  ## backup
 
-end  ## GitBackup
 
+  ######
+  # private helpers
+
+  def do_with_log( &blk )
+    blk.call
+    true  ## return true  ## success/ok
+  rescue GitError => ex
+    puts "!! ERROR: #{ex.message}"
+
+    File.open( "#{@log_path}/errors.log", 'a' ) do |f|
+      f.write "#{Time.now} -- #{ex.message}\n"
+    end
+    false ## return false  ## error/nok
+  end
+
+
+  def do_with_retries( retries: 2, sleep: 5, &blk )
+    retries_count = 0
+    success = false
+    loop do
+      success = do_with_log( &blk )
+      retries_count += 1
+      break if success || retries_count >= retries
+      puts "retrying in #{sleep}secs... sleeping..."
+      sleep( sleep )  ## sleep 5secs or such
+    end
+    success   ## return if success or not  (true/false)
+  end
+
+end ## class GitBackup
 end ## module Gitti

data/lib/gitti/backup/base.rb

@@ -0,0 +1,11 @@
+require 'gitti/base'   # note: include "modular" base without (auto)include Gitti
+
+
+# our own code
+require 'gitti/backup/version'   # note: let version always go first
+require 'gitti/backup/backup'
+
+
+# say hello
+puts GittiBackup.banner       ##  if defined?($RUBYCOCO_DEBUG)
+

data/lib/gitti/backup/version.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
 
 module GittiBackup
 
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 2
+  MINOR = 4
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
@@ -18,6 +17,6 @@ module GittiBackup
   def self.root
     "#{File.expand_path( File.dirname(File.dirname(File.dirname(File.dirname(__FILE__)))) )}"
   end
-  
+
 end # module GittiBackup
 

data/test/data/repos.yml

@@ -6,8 +6,8 @@ openbeer (2):
 - be-belgium
 
 openfootball (3):
-- at-austria
-- br-brazil
+- austria
+- mexico
 - world-cup
 
 openmundi (2):

data/test/helper.rb

@@ -1,13 +1,10 @@
-# encoding: utf-8
-
-## $:.unshift(File.dirname(__FILE__))
+## note: use the local version of gitti gems
+$LOAD_PATH.unshift( File.expand_path( '../gitti/lib' ))
 
 ## minitest setup
 require 'minitest/autorun'
 
 
-$RUBYLIBS_DEBUG = true
-
 ## our own code
 require 'gitti/backup'
 

data/test/test_backup.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 ###
 #  to run use
 #     ruby -I ./lib -I ./test test/test_backup.rb
@@ -10,17 +8,22 @@ require 'helper'
 
 class TestBackup < MiniTest::Test
 
+  def test_backup_i
+    repos = GitRepoSet.read( "#{GittiBackup.root}/test/data/repos.yml" )
+    pp repos
+
+    backup = GitBackup.new
+    assert true    ## assume everything ok if get here
+  end
 
-  def test_backup
- 
-    repos = Gitti::GitRepoSet.from_file( "#{GittiBackup.root}/test/data/repos.yml" )
+  def test_backup_ii
+    repos = GitRepoSet.read( "#{GittiBackup.root}/test/data/repos.yml" )
     pp repos
- 
-    backup = Gitti::GitBackup.new
+
+    backup = GitBackup.new
     backup.backup( repos )
-    
-    assert true
-    ## assume everything ok if get here
+
+    assert true    ## assume everything ok if get here
   end
 
 end # class TestBackup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitti-backup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-22 00:00:00.000000000 Z
+date: 2020-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitti
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -44,35 +44,35 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.16'
 description: gitti-backup - (yet) another (lite) git backup command line script
 email: ruby-talk@ruby-lang.org
 executables: []
 extensions: []
 extra_rdoc_files:
-- HISTORY.md
+- CHANGELOG.md
 - Manifest.txt
 - README.md
 files:
-- HISTORY.md
+- CHANGELOG.md
 - Manifest.txt
 - README.md
 - Rakefile
 - lib/gitti/backup.rb
 - lib/gitti/backup/backup.rb
-- lib/gitti/backup/repo.rb
+- lib/gitti/backup/base.rb
 - lib/gitti/backup/version.rb
 - test/data/repos.yml
 - test/helper.rb
 - test/test_backup.rb
-homepage: https://github.com/rubylibs/gitti
+homepage: https://github.com/rubycoco/gitti
 licenses:
 - Public Domain
 metadata: {}
@@ -86,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: gitti-backup - (yet) another (lite) git backup command line script

data/lib/gitti/backup/repo.rb

@@ -1,60 +0,0 @@
-# encoding: utf-8
-
-module Gitti
-
-
-class GitHubBareRepo    ## use/rename to GitHubServerRepo - why? why not?
-  def initialize( owner, name )
-    @owner = owner    ## use/rename to login or something - why? why not??
-    @name  = name     #  e.g. "rubylibs/webservice"
-  end
-
-  def http_clone_url   ## use clone_url( http: true )  -- why? why not?
-     ##  check: use https: as default? for github - http:// still supported? or redirected?
-    "http://github.com/#{@owner}/#{@name}"
-  end
-
-  def git_dir
-     ## todo: rename to use bare_git_dir or mirror_dir  or something ??
-     "#{@name}.git"
-  end
-
-
-  def backup_with_retries( dest_dir, retries: 2 )
-    retries_count = 0
-    success = false
-    begin
-      success = backup( dest_dir )
-      retries_count += 1
-    end until success || retries_count >= retries
-    success   ## return if success or not  (true/false)
-  end
-
-  def backup( dest_dir )
-    ###
-    ##  use --mirror
-    ##  use -n  (--no-checkout)   -- needed - why? why not?
-
-    Dir.chdir( dest_dir ) do
-      if Dir.exist?( git_dir )
-        Dir.chdir( git_dir ) do
-          Git.remote_update
-        end
-      else
-        Git.mirror( http_clone_url )
-      end
-    end
-    true  ## return true  ## success/ok
-  rescue GitError => ex
-    puts "*** error: #{ex.message}"
-    
-    File.open( './errors.log', 'a' ) do |f|
-      f.write "#{Time.now} -- repo #{@owner}/#{@name} - #{ex.message}\n"
-    end
-    false ## return false  ## error/nok
-  end ## method backup
-
-end   ## class Repo
-
-end  ## module Gitti
-