grsync 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24eaeaafd867331a50e60e3fbdf750b603454b17
+  data.tar.gz: 0ee53dd899aae8732643d278e38a0277418a8a8f
+SHA512:
+  metadata.gz: 2dfbd96e80746a42b98c80c066701844d0b4faccc7e1266850f1a13c48e113086488bf7382b52ce903be6522de245630551d440fa87810f6de97005afbee62fc
+  data.tar.gz: 58908813abe97fb53f959d5cd7ca082ff8bcedc0b021197b2e4d70e1815c57e6c23cdeecbe58bff060e9a3b4f6fee08a9bbd96869b98878abc3aab6860030239

data/.gitignore

@@ -0,0 +1,2 @@
+.idea/
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/bin/grsync

@@ -0,0 +1,79 @@
+#! /usr/bin/env ruby
+
+require 'bundler/setup'
+require 'net/ssh'
+require 'trollop'
+
+require 'grsync'
+require 'grsync/logger'
+
+# a sample command of grsync is like:
+# ./grsync
+#   --local ~/document/myrepo
+#   --remote username@localhost:/home/username/myrepo
+#   --passwd barabara
+#   --port 2222
+
+module GRSync
+    # execution entrance
+    if __FILE__ == $0
+        # parse arguments
+        opts = Trollop::options do
+            opt :local, 'local source git repository(e.g. /path/to/repo)', :type => :string
+            opt :remote, 'remote destination git repository(e.g. username@host:/path/to/repo)', :type => :string
+            opt :passwd, 'password for ssh login', :type => :string
+            opt :port, 'port for ssh login', :default => 22
+            opt :save, 'save this synchronization link'
+        end
+
+        local = opts[:local]
+        remote_full = opts[:remote] # location with username, host and path
+
+        # since save feature is unimplemented
+        # both local and remote option have to be specified for an explicit synchronization
+        Trollop::die :local, 'must be specified' if local.nil?
+        Trollop::die :remote, 'must be specified' if remote_full.nil?
+
+        # local dir must exist
+        # always check existence asap
+        unless Dir.exist?(File.expand_path(local))
+            $Log.error "Local directory #{local} doesn't exist"
+            abort
+        end
+
+        # extract remote, user_name and host from dest_full
+        login_str, remote = remote_full.split ':'
+        if login_str.split('@').size == 2
+            user_name, host = login_str.split('@')
+        else
+            host = login_str
+            user_name = nil
+        end
+
+        # optional options for login
+        passwd = opts[:passwd] || ''
+        port = opts[:port]
+
+        # ssh login
+        begin
+            Net::SSH.start(host, user_name, :password => passwd, :port => port) do |ssh|
+                syncer = GRSync::Syncer.new ssh, local, remote
+                syncer.sync
+            end
+        rescue Net::SSH::AuthenticationFailed
+            login_info = {
+                host: host,
+                user_name: user_name,
+                port: port,
+                passwd: passwd
+            }
+            $Log.error "Authentication failed. Please check whether the following login information is correct: #{login_info}"
+            abort
+        rescue Exception => ex
+            $Log.error "#{ex.class.name} -- #{ex}"
+            abort
+        end
+    end
+end
+
+

data/grsync.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grsync/version'
+
+Gem::Specification.new do |spec|
+    spec.name          = 'grsync'
+    spec.version       = GRSync::VERSION
+    spec.authors       = ['luminocean']
+    spec.email         = ['luminocean@foxmail.com']
+
+    spec.summary       = 'development code synchronization tool'
+    spec.files         = `git ls-files`.split("\n")
+    spec.bindir        = 'bin'
+    spec.executables   = ['grsync']
+    spec.require_paths = ['lib']
+    spec.license       = 'MIT'
+    spec.homepage      = 'https://github.com/luminocean/grsync'
+
+    spec.add_dependency 'trollop', '~> 2.1'
+    spec.add_dependency 'net-ssh', '~> 3.1'
+    spec.add_dependency 'log4r', '~> 1.1'
+
+    spec.add_development_dependency 'bundler', '~> 1.10'
+end

data/lib/grsync.rb

@@ -0,0 +1,108 @@
+require 'open3'
+require 'shellwords'
+
+module GRSync
+    class Syncer
+        # * +ssh+ - ssh object used for issuing commands
+        # * +local_path+ - source of the sync link which should be a path of a directory on local machine
+        # * +remote_path+ - destination of the sync link which should be a path of a directory on remote machine
+        def initialize(ssh, local_path, remote_path)
+            @ssh = ssh
+            @local_path = local_path # existence should be checked before
+            @remote_path = remote_path # existence remains to be checked
+        end
+
+        # sync remote git repository with the local one
+        def sync
+            # preparation
+            check_remote_path_valid
+            check_git_repo
+            reset_remote_repo
+
+            diff_text = local_diff
+            apply_diff_to_remote diff_text
+
+            # output = @ssh.exec! 'hostname'
+            # puts output
+        end
+
+        private
+
+        # checkout all files from HEAD to flush all changes made in remote repo
+        # thus new git apply can be applied safely :)
+        def reset_remote_repo
+            @ssh.exec! "cd #{@remote_path} && git reset --hard" do |ch, stream, data|
+                if stream == :stderr and data.to_s != '' # check for nil or ''
+                    raise GitResetException, "reset failed: #{data}"
+                end
+            end
+        end
+
+        def apply_diff_to_remote(diff_text)
+            # be careful, string in ruby may not be used safely in shell directly
+            # so here's a conversion
+            echoable_text = Shellwords.escape diff_text
+
+            result = @ssh.exec! "cd #{@remote_path} && echo #{echoable_text} | git apply -"
+            # diff fails if something other than empty string returns
+            raise GitDiffApplyException, "apply failed: #{result}" if result != ''
+        end
+
+        # diff the local git repository and returns the diff text for later use
+        def local_diff
+            `cd #{@local_path} && git diff HEAD`
+        end
+
+        # check the followings:
+        # 1. whether both local and remote directory are git repositories
+        # 2. whether their branches are matched
+        def check_git_repo
+            # check local dir
+
+            # use Open3 in order to get stderr output from child process
+            # `` syntax only returns stdout output which is not enough
+
+            # since command are all executed in newly spawned child processes so there's no need to record old dir path
+            stdout, stderr = Open3.popen3("cd #{@local_path} && git status")[1..2]
+
+            local_branch_name = stdout.gets.to_s.match(/^On branch ([^\s]+)/)[1]
+            unless local_branch_name
+                raise GitRepoException, "local path #{@local_path} is not a git repository"
+            end
+
+            # check remote dir
+            valid = true
+            remote_branch_name = ''
+            @ssh.exec!("cd #{@remote_path} && git status") do |ch, stream, data|
+                case stream
+                    when :stdout
+                        valid = false unless (remote_branch_name = data.match(/^On branch ([^\s]+)/)[1])
+                    when :stderr
+                        valid = false unless (data.nil? or data == '')
+                end
+            end
+            unless valid
+                raise GitRepoException, "remote path #{@remote_path} is not a git repository"
+            end
+
+            # check match
+            if local_branch_name != remote_branch_name
+                raise GitRepoException, "local branch(#{local_branch_name}) and remote branch(#{remote_branch_name}) don't match"
+            end
+        end
+
+        # check whether the remote path is valid
+        def check_remote_path_valid
+            @ssh.exec!("ls #{@remote_path}") do |ch, stream, data|
+                if stream == :stderr and not data.nil?
+                    raise RemotePathInvalidException, "remote path #{@remote_path} not found"
+                end
+            end
+        end
+    end
+
+    class RemotePathInvalidException < Exception; end
+    class GitRepoException < Exception; end
+    class GitDiffApplyException < Exception; end
+    class GitResetException < Exception; end
+end

data/lib/grsync/logger.rb

@@ -0,0 +1,8 @@
+require 'log4r'
+include Log4r
+
+$Log = Logger.new STDOUT
+$Log.level = Logger::DEBUG
+$Log.formatter = proc do |severity, datetime, progname, msg|
+    "[#{severity}] #{datetime} #{progname}: #{msg}\n"
+end

data/lib/grsync/version.rb

@@ -0,0 +1,3 @@
+module GRSync
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: grsync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- luminocean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: 
+email:
+- luminocean@foxmail.com
+executables:
+- grsync
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- bin/grsync
+- grsync.gemspec
+- lib/grsync.rb
+- lib/grsync/logger.rb
+- lib/grsync/version.rb
+homepage: https://github.com/luminocean/grsync
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: development code synchronization tool
+test_files: []