marz-rsync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f053b9e193d333ce9e3e59c69a4d7adbacb2b8d
+  data.tar.gz: 728c618a67bb9f252d899e4ef478a03825650cea
+SHA512:
+  metadata.gz: 1073f4ea591491ebf0fafe312673664e522626e419dd99826a0473229a4e258ba54ed68528dedc1adef1c5621f1114520661ef50230b2f4c8d70ad29510009a4
+  data.tar.gz: 8178131fce0acd2d98b2f927d213de5a2eab45e5c9a481bfe9a4a3037b47da6d3f395f943f10a4a7497ed4be3b06c6b3f62781dda0ac92d1c1d18273acfb030b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at script-deployer@me.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in marz-rsync.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    marz-rsync (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.4.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  marz-rsync!
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 marzdgzmn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Marz::Rsync
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/marz/rsync`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'marz-rsync'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install marz-rsync
+
+## Usage
+
+Minimal example
+```
+require 'marz/rsync'
+
+result = Marz::Rsync.run("/path/to/src", "/path/to/dest")
+```
+
+Complete example
+```
+require 'marz/rsync'
+
+Marz::Rsync.run("/path/to/src", "/path/to/dest") do |result|
+  if result.success?
+    puts result.total_size
+  else
+    puts result.error
+  end
+  puts result.output
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/marz-rsync. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Marz::Rsync project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/marz-rsync/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "marz/rsync"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/marz/rsync/command.rb

@@ -0,0 +1,28 @@
+require 'marz/rsync/result'
+require 'shellwords'
+
+module Marz
+  module Rsync
+    #The rsync command to be run
+    class Command
+      # Runs an rsync job, returns the exit code, and does logging
+      #
+      # @param opts {Array}
+      # @return {ExitCode}
+      def self.run(*opts)
+        cmd = ['rsync', '--itemize-changes', '--stats', '-h', opts].flatten.shelljoin
+        output = `#{cmd} 2>&1`
+        Result.new(output, $?.exitstatus)
+      end
+
+      def self.command
+        @command ||= "rsync"
+      end
+
+      def self.command=(cmd)
+        @command = cmd
+      end
+
+    end
+  end
+end

data/lib/marz/rsync/configure.rb

@@ -0,0 +1,17 @@
+module Marz
+  module Rsync
+    module Configure
+      CONFIG_KEYS = [
+        :host
+      ].freeze
+
+
+      attr_accessor *CONFIG_KEYS
+
+      def configure
+        yield self
+      end
+      
+    end
+  end
+end

data/lib/marz/rsync/result.rb

@@ -0,0 +1,71 @@
+
+module Marz
+  module Rsync
+    # The result of an rsync job
+    class Result
+      # Exit code of an rsync job
+      attr_accessor :exitcode
+
+      # Output of an rsync job
+      attr_accessor :output
+
+      #Rsync exit values/error codes
+      ERROR_CODES = {
+        #'0'  =>   'Success',
+        '1'  =>   'Syntax or usage error',
+        '2'  =>   'Protocol incompatibility',
+        '3'  =>   'Errors selecting input/output files, dirs',
+        '4'  =>   'Requested action not supported: an attempt was made to manipulate 64-bit files on a platform that cannot support them; or an option was specified that is supported by the client and not by the server.',
+        '5'  =>   'Error starting client-server protocol',
+        '6'  =>   'Daemon unable to append to log-file',
+        '10' =>   'Error in socket I/O',
+        '11' =>   'Error in file I/O',
+        '12' =>   'Error in rsync protocol data stream',
+        '13' =>   'Errors with program diagnostics',
+        '14' =>   'Error in IPC code',
+        '20' =>   'Received SIGUSR1 or SIGINT',
+        '21' =>   'Some error returned by waitpid()',
+        '22' =>   'Error allocating core memory buffers',
+        '23' =>   'Partial transfer due to error',
+        '24' =>   'Partial transfer due to vanished source files',
+        '25' =>   'The --max-delete limit stopped deletions',
+        '30' =>   'Timeout in data send/receive',
+        '35' =>   'Timeout waiting for daemon connection'
+      }
+
+      def initialize(output, exitcode)
+        @output = output
+        @exitcode = exitcode
+      end
+
+      # Whether rsync job run without errors
+      # @return {Boolean}
+      def success?
+        @exitcode == 0
+      end
+
+      # Error message corresponding to the exit code/error code
+      # @return {String}
+      def error
+        return nil if @exitcode == 0
+        error_key = @exitcode.to_s
+        if ERROR_CODES.has_key? error_key
+          ERROR_CODES[error_key].to_s
+        elsif  @raw_output =~ /Permission denied \(publickey\)/
+          "Permission denied (publickey)"
+        else
+          "Unknown Error"
+        end
+      end
+
+      # Total size of the rsync job
+      # @return {String}
+      def total_size
+        return nil if @exitcode != 0 || @output.nil?
+        #@output.match(/^*(?:total size is )(\d+\.\d+\S)/)[1]
+        @output.match(/^*(?:total size is )(\d\S*|\d+\.\d+\S*)/)[1]
+      end
+
+    end
+  end
+end

data/lib/marz/rsync/version.rb

@@ -0,0 +1,5 @@
+module Marz
+  module Rsync
+    VERSION = "0.1.0"
+  end
+end

data/lib/marz/rsync.rb

@@ -0,0 +1,23 @@
+require 'marz/rsync/version'
+require 'marz/rsync/configure'
+require 'marz/rsync/command'
+
+
+module Marz
+  # Main interface to rsyunc
+  module Rsync
+    extend Configure
+    # Runs an rsync {Command} and return the {Result}
+    # @param source {String}
+    # @param destination {String}
+    # @param opts {Array}
+    # @return {Result}
+    # @yield {Result}
+    def self.run(source, destination, opts = [], &block)
+      destination = "#{self.host}:#{destination}" if self.host
+      result = Command.run(source, destination, opts)
+      yield(result) if block_given?
+      result
+    end
+  end
+end

data/marz-rsync.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "marz/rsync/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "marz-rsync"
+  spec.version       = Marz::Rsync::VERSION
+  spec.authors       = ["marzdgzmn"]
+  spec.email         = ["marz.dgzmn@gmail.com"]
+
+  spec.summary       = %q{Marz/Rsync is a Ruby library wrapper for the rsync binary}
+  spec.homepage      = "https://github.com/marzdgzmn/marz-rsync"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against " \
+  #    "public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: marz-rsync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- marzdgzmn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: 
+email:
+- marz.dgzmn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/marz/rsync.rb
+- lib/marz/rsync/command.rb
+- lib/marz/rsync/configure.rb
+- lib/marz/rsync/result.rb
+- lib/marz/rsync/version.rb
+- marz-rsync.gemspec
+homepage: https://github.com/marzdgzmn/marz-rsync
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Marz/Rsync is a Ruby library wrapper for the rsync binary
+test_files: []