gitlab-mirror-pull 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5fc0a110fa694a431b08d1d858c624c8c52f73e56c34ae1e9225b9bf6680693
-  data.tar.gz: aa5308fc8d5cf0fc08c0432f7e39cce7c1d92041906c5625894c71787a71216a
+  metadata.gz: 1baa55ddcda2d170f8130520fc2a25a382818a32bae8391d1564da225aa0b4cf
+  data.tar.gz: 60b841a9815cef4d58c88048f5e53ebcc78cc31c20144cd0a09370e2daa60f98
 SHA512:
-  metadata.gz: fc1fb6e22c7235b1fbccbc13fbc9263a0f98f2412b4c7b58c4fd47d934f0d5321768eca04d8711209e45d86baa99a6f6487e97b6084f5e4117cc7d577ee20e6e
-  data.tar.gz: 165ac2091fe71892595c936258a97cc2243573e3817170b67cd251210f9d8156e2a9c702fcf45c1f0b8164e73b332430bb4136c176fdd6f37e8f57c209841086
+  metadata.gz: f3dfd3c8fcda7925aefe071e3b545df7169f6d7b684a5357f7b37fbd5deb717b1d4d1a88b968663d46ca6fcb56c519874c6e7cb50aac125b93be957e0ace25aa
+  data.tar.gz: 4093eea445259d232ff45ced78320d628ff59e3ed147542a673827b095662d56a87f1570fe654af49cb9bcadf61324b89c44d88f400e79f5bc591f13285fa2d4

data/README.md

@@ -0,0 +1,45 @@
+Fetch/update gitlab repositories automatically
+==============================================
+
+Description
+-----------
+
+Update your git repositories automatically when `remote` is set
+
+Install
+-------
+
+- Clone repository: `git clone https://github.com/ochorocho/gitlab-mirror-pull.git`
+- Run bundler: `bundle install`
+- Copy and modify `config.example.yml` to `config.yml`
+
+Run
+---
+
+```ruby
+ruby gitlab-mirror-pull.rb
+```
+
+Setup a CronJob
+---------------
+
+If you want to trigger periodically 
+
+```bash
+0 */1 * * *	/usr/bin/ruby /path/to/gitlab-mirror-pull.rb
+```
+
+Using 'gem install'
+-------------------
+
+Install
+
+```bash
+gem install gitlab-mirror-pull
+```
+
+Run
+
+```bash
+gitlab-mirror-pull -c /path/to/config.yml
+```

data/bin/gitlab-mirror-pull

@@ -1,3 +1,52 @@
 #!/usr/bin/env ruby
+require_relative '../lib/gitlab-mirror-pull.rb'
 
-require_relative '../lib/gitlab-mirror-pull.rb'
+options = {
+	:config => File.join(File.dirname(__FILE__), "../config.example.yml"),
+	:log_level => Logger::ERROR
+}
+
+# Parse commandline arguments
+#
+# == Parameters:
+# 	:config => File.join(File.dirname(__FILE__), "../config.example.yml"),
+# 	:log_level => Logger::ERROR
+#
+# == Returns:
+# Log output (default: ERROR)
+# 
+OptionParser.new do |opts|
+  opts.banner = "Usage: gitlab-mirror-pull.rb [options]"
+  opts.set_summary_indent('   ')
+  opts.set_summary_width(50)
+  opts.define_head "Fetch gitlab repositories when remote set.
+Default config #{File.join(File.dirname(__FILE__), "../config.example.yml")}\n\n"
+  
+  # Config argument
+  opts.on("-c", "--config [config.yml]", "Specify config yaml") do |yml|
+    options[:config] = yml
+  end
+
+  # LogLevel argument
+  opts.on("-l", "--log-level [INFO|WARN|ERROR|DEBUG]", "Define log level") do |level|
+  	case level
+	when "INFO"
+	  options[:log_level] = Logger::INFO
+	when "WARN"
+	  options[:log_level] = Logger::WARN
+	when "ERROR"
+	  options[:log_level] = Logger::ERROR
+	when "DEBUG"
+	  options[:log_level] = Logger::DEBUG
+	end
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+end.parse!
+
+# Run `git fetch` depending on options[:config] 
+GitlabMirrorPull.new(options[:config],options[:log_level])

data/lib/gitlab-mirror-pull.rb

@@ -1,81 +1,81 @@
+require 'optparse'
 require 'git'
 require 'logger'
 require 'yaml'
-require 'optparse'
-
-# Configure Logger
-log = Logger.new(STDOUT)
-log.level = Logger::ERROR
 
-# Parse commandline arguments
-options = {
-	:config => File.join(File.dirname(__FILE__), "../config.example.yml"),
-	:log_level => Logger::ERROR
-}
-OptionParser.new do |opts|
-  opts.banner = "Usage: gitlab-mirror-pull.rb [options]"
-  opts.set_summary_indent('   ')
-  opts.set_summary_width(50)
-  opts.define_head "Fetch gitlab repositories when remote set.
-Default config #{File.join(File.dirname(__FILE__), "../config.example.yml")}\n\n"
-  
-  # Config argument
-  opts.on("-c", "--config [config.yml]", "Specify config yaml") do |yml|
-    options[:config] = yml
-  end
-
-  # LogLevel argument
-  opts.on("-l", "--log-level [INFO|WARN|ERROR|DEBUG]", "Define log level") do |level|
-  	case level
-	when "INFO"
-	  log.level = Logger::INFO
-	when "WARN"
-	  log.level = Logger::WARN
-	when "ERROR"
-	  log.level = Logger::ERROR
-	else
-	  log.level = Logger::DEBUG
+class GitlabMirrorPull
+	
+	attr_accessor :config, :log_level
+	
+	# Parse commandline arguments
+	#
+	# == Parameters:
+	# config:: 
+	#	Path to config file (e.g. ../config.example.yml)
+	#
+	# log_level::
+	#   Set log level. Possible values: `Logger::INFO`, `Logger::WARN`, `Logger::ERROR`, `Logger::DEBUG`
+	#
+	# == Returns:
+	# Returns `@log` and `@config`
+	# 
+	def initialize(config = File.join(File.dirname(__FILE__), "../config.example.yml"), log_level = Logger::ERROR)
+		
+		# Configure Logger
+		@log = Logger.new(STDOUT)
+		@log.level = log_level
+		@config = YAML.load_file(config)
+		self.fetch_repositories
 	end
-  end
-
-  opts.on_tail("-h", "--help", "Show this message") do
-    puts opts
-    exit
-  end
-
-end.parse!
 
-# Load config.yml
-yml = YAML.load_file(options[:config])
-
-# Init git settings
-Git.configure do |config|
-	config.binary_path = "#{yml['git']['path']}"
-end
+	# Prepare list of repositories
+	#
+	# == Returns:
+	# List of repositories to update using `git fetch`. Excludes `*.wiki` and repositories defined in `config.yml -> git -> repos`
+	# 
+	def repositories_to_fetch
+		# Find all .git Repositories - Ignore *.wiki.git
+		repos = Dir.glob("#{config['git']['repos']}/*/*{[!.wiki]}.git")
+		
+		# Build up array of NOT ignored repositories
+		delete_path = []
+		@config['ignore'].each do |ignored|
+			path = File.join(@config['git']['repos'], ignored)
+			delete_path += repos.grep /^#{path}/
+			repos.delete(delete_path)
+		end
+		
+		return repos - delete_path 
 
-# Find all .git Repositories - Ignore *.wiki.git
-repos = Dir.glob("#{yml['git']['repos']}/*/*{[!.wiki]}.git")
+	end
 
-# Build up array of NOT ignored repositories
-delete_path = []
-yml['ignore'].each do |ignored|
-	path = File.join(yml['git']['repos'], ignored)
-	delete_path += repos.grep /^#{path}/
-	repos.delete(delete_path)
-end
-repos_to_fetch = repos - delete_path 
+	# Fetch repositories return by `repositories_to_fetch`
+	#
+	# == Returns:
+	# Logging infos on fetched repos
+	# 
+	def fetch_repositories
+		# Init git settings
+		Git.configure do |config|
+			config.binary_path = "#{@config['git']['path']}"
+		end		
 
-# Loop through repos and fetch it
-repos_to_fetch.each do |repo| 	
-	if File.directory?(repo)
-		# Get branches
-		g = Git.bare("#{repo}", :log => log)
-		g.remotes.each do |remote|
-			# Determine which "remote" to fetch e.g. "git fetch github"
-			if yml['provider'].include?("#{remote}")
-				log.info("Fetching remote #{remote} in #{repo}")
-				g.remote(remote).fetch
+		# Loop through repos and fetch it
+		repos_to_fetch = self.repositories_to_fetch
+		repos_to_fetch.each do |repo| 	
+			if File.directory?(repo)
+				# Get branches
+				g = Git.bare("#{repo}", :log => @log)
+				g.remotes.each do |remote|
+					# Determine which "remote" to fetch e.g. "git fetch github"
+					if @config['provider'].include?("#{remote}")
+						@log.info("Fetching remote #{remote} in #{repo}")
+						g.remote(remote).fetch
+					end
+				end
 			end
-		end
+		end		
+
 	end
-end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-mirror-pull
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - ochorocho
@@ -38,6 +38,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/gitlab-mirror-pull
 - config.example.yml
 - lib/gitlab-mirror-pull.rb