gitti-backup 0.0.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d7f9258dfc4b2096d4eba9f5ee6d4c5ce959c0f
-  data.tar.gz: d4d6ae45a22ef15d65bdaaf36c50e48d04b13814
+  metadata.gz: 98528e760c07a1b0d66ddd120073ef829bce821a
+  data.tar.gz: b9e5e7e4c2cb3d88cac33b00874274623fb34a29
 SHA512:
-  metadata.gz: e810a27fcd3ed818223625b4f1f5baf42cb90b19dd37307ef896c435821c0b89b73f0253f74c858548cabb0f4164c682a4fcdcc97ee24ba07eac88238aeff854
-  data.tar.gz: 857d68067ced2982261bf8408dcadc4c992553223a7771f1446b108690d7d94752cfa42cde2a19d25c5277aeae734e1be7f48c9b7c1f839e9d65182f3c0ffb1d
+  metadata.gz: 88be2d1aef4b657bdc49ea048c72cdd5fdaf1fcb39555302d19c7db118550597a64a1e83b8ff88a3d8114d26973f0b5da272e840d8ebc9f1eb379b05fcbdff8d
+  data.tar.gz: 2e51ed36028c50f21419bada59e72fed01d7e564a5a42c621073f2e42f128fe2a9fa257849be5253e479d88f73eaa109075aae3c1522d0b4a56b5e9e9f2f8a32

data/Manifest.txt

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

data/README.md

@@ -2,15 +2,117 @@
 
 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
+### `backup` Command Line Tool
+
+Use the `backup` command line tool to backup all repos listed in a "manifest" file (e.g. `repos.yml`, `code.yml`, `github.yml` or such). Example:
+
+```
+backup repos.yml             # or
+backup code.yml data.yml
+```
+
+In a nutshell backup will backup all repos by using
+1. `git clone --mirror` or
+2. `git remote update`  (if the local backup already exists)
+and store all bare repos (without workspace) in the `~/backup` directory.
+
+
+#### Repos Manifest
+
+For now only github repos are supported listed by
+owner / organization. Example `repos.yml`:
+
+``` yaml
+sportdb:
+- sport.db
+- sport.db.sources
+- football.db
+
+yorobot:
+- cache.csv
+- sport.db.more
+- football.db
+- football.csv
+
+openfootball:
+- leagues
+- clubs
+```
+
+Using `backup` with defaults this will result in:
+
+```
+~/backup
+   /sportdb
+      /sport.db.git
+      /sport.db.sources.git
+      /football.db.git
+   /yorobot
+      /cache.csv.git
+      /sport.db.more.git
+      /football.db.git
+      /football.csv.git
+   /openfootball
+      /leagues.git
+      /clubs.git
+```
+
+
+
+### Scripting
+
+You can script your backup in ruby. Example:
+
+
+``` 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' ) )
+```
+
+or
+
+``` ruby
+require 'gitti/backup'
+
+## step 1: setup the root backup directory
+##   1) use custom directory e.g. /backups
+##   2) auto-add a daily directory e.g. /backups/2020-09-27
+backup = GitBackup.new( '/backups', daily: true )
+
+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

@@ -3,28 +3,28 @@ require './lib/gitti/backup/version.rb'
 
 Hoe.spec 'gitti-backup' do
 
-  self.version = Gitti::GitBackup::VERSION
+  self.version = GittiBackup::VERSION
 
   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/bin/backup

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+###################
+# DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -Ilib bin/backup
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/backup
+#
+
+require 'gitti/backup/base'
+
+Gitti::GitBackup::Tool.main

data/lib/gitti/backup.rb

@@ -1,11 +1,7 @@
-# encoding: utf-8
+require_relative 'backup/base'
 
-require 'gitti'
 
-# our own code
-require 'gitti/backup/version'   # note: let version always go first
-
-
-# say hello
-puts Gitti::GitBackup.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

@@ -0,0 +1,110 @@
+
+module Gitti
+
+
+class GitBackup
+
+  class Tool   ## nested class
+    def self.main( args=ARGV )
+      backup = GitBackup.new
+      args.each do |arg|
+        backup.backup( GitRepoSet.read( arg ))
+      end
+    end
+  end ## nested class Tool
+
+
+
+  def initialize( root= '~/backup', daily: false )
+    @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
+
+    @daily = daily
+  end
+
+
+  ##  auto-add "daily" date folder / dir
+  ##    e.g. 2015-11-20 using Date.today.strftime('%Y-%m-%d')
+  def daily=(value) @daily=value; 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_path = "#{@root}"
+    backup_path <<  "/#{Date.today.strftime('%Y-%m-%d')}"  if @daily
+    pp backup_path
+
+    FileUtils.mkdir_p( backup_path )   ## make sure path exists
+
+    repos.each do |org, names|
+      org_path = "#{backup_path}/#{org}"
+      FileUtils.mkdir_p( org_path )   ## make sure path exists
+
+      names.each do |name|
+        puts "[#{count_repos+1}/#{total_repos}] #{org}@#{name}..."
+
+        repo = GitHubRepo.new( org, name )  ## owner, name e.g. rubylibs/webservice
+
+        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
+
+        ## todo/check:  fail if success still false after x retries? -- why? why not?
+
+        count_repos += 1
+      end
+      count_orgs += 1
+    end
+
+    ## print stats
+    puts "  #{count_repos} repo(s) @ #{count_orgs} org(s)"
+  end  ## backup
+
+
+  ######
+  # 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,10 +1,8 @@
-# encoding: utf-8
 
-module Gitti
-  module GitBackup
+module GittiBackup
 
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 0
+  MINOR = 4
   PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
@@ -19,7 +17,6 @@ module Gitti
   def self.root
     "#{File.expand_path( File.dirname(File.dirname(File.dirname(File.dirname(__FILE__)))) )}"
   end
-  
-end  # module GitBackup 
-end # module Gitti
+
+end # module GittiBackup
 

data/test/data/repos.yml

@@ -0,0 +1,16 @@
+##########################
+# some repos
+
+openbeer (2):
+- at-austria
+- be-belgium
+
+openfootball (3):
+- austria
+- mexico
+- world-cup
+
+openmundi (2):
+- austria.db
+- world.db
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+## note: use the local version of gitti gems
+$LOAD_PATH.unshift( File.expand_path( '../gitti/lib' ))
+
+## minitest setup
+require 'minitest/autorun'
+
+
+## our own code
+require 'gitti/backup'
+

data/test/test_backup.rb

@@ -0,0 +1,30 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_backup.rb
+
+
+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_ii
+    repos = GitRepoSet.read( "#{GittiBackup.root}/test/data/repos.yml" )
+    pp repos
+
+    backup = GitBackup.new
+    backup.backup( repos )
+
+    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.0.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-20 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,30 +44,37 @@ 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: []
+executables:
+- backup
 extensions: []
 extra_rdoc_files:
-- HISTORY.md
+- CHANGELOG.md
 - Manifest.txt
 - README.md
 files:
-- HISTORY.md
+- CHANGELOG.md
 - Manifest.txt
 - README.md
 - Rakefile
+- bin/backup
 - lib/gitti/backup.rb
+- lib/gitti/backup/backup.rb
+- lib/gitti/backup/base.rb
 - lib/gitti/backup/version.rb
-homepage: https://github.com/rubylibs/gitti
+- test/data/repos.yml
+- test/helper.rb
+- test/test_backup.rb
+homepage: https://github.com/rubycoco/gitti
 licenses:
 - Public Domain
 metadata: {}
@@ -81,7 +88,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:
   - - ">="
@@ -89,7 +96,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