vagrant-sudo-rsync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a07e77bbe856b76663eccc5dd6975afb8e2c1a07
+  data.tar.gz: 8c9fd12c29bb032f2fa563e7320e48f73cf341fa
+SHA512:
+  metadata.gz: 68ed8f8b4471a642698fc44c8e616d807f1d077a75fb7881cebedea866a9e62f5ad0a12ae19e19d319ae3d73a897a4010ac01e8ed1b78eda442b4f33c3b3a922
+  data.tar.gz: 46463b184bf48e87e6ecaad73ea9d4b1ca85611c57295d7d4f463485160de3365e45127a6c009e0382e7e176da4102eec68b8b24ef9dbccbc2fe0acf2b1feebc

data/.github_changelog_generator

@@ -0,0 +1,2 @@
+unreleased=true
+future-release=0.1.0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.rbenv-gemsets
+.ruby-version
+
+.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - https://raw.githubusercontent.com/rails/rails/master/.rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+## [0.1.0](https://github.com/TypistTech/vagrant-sudo-rsync/tree/0.1.0) (2017-09-12)
+**Merged pull requests:**
+
+- Add rubocop [\#3](https://github.com/TypistTech/vagrant-sudo-rsync/pull/3) ([TangRufus](https://github.com/TangRufus))
+- Add changelog [\#2](https://github.com/TypistTech/vagrant-sudo-rsync/pull/2) ([TangRufus](https://github.com/TangRufus))
+- First release [\#1](https://github.com/TypistTech/vagrant-sudo-rsync/pull/1) ([TangRufus](https://github.com/TangRufus))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 vagrant-sudo-rsync@typist.tech. The project team will review and investigate all complaints, and will respond in a way that it deems 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,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+group :development do
+  gem "bundler", "~> 1.15"
+  gem "rake", "~> 12.1"
+  gem "rubocop", "~> 0.49"
+end
+
+group :plugins do
+  gem "vagrant-sudo-rsync", path: "."
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tang Rufus
+
+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,112 @@
+# Vagrant Sudo Rsync
+
+[![Gem](https://img.shields.io/gem/v/vagrant-sudo-rsync.svg)](https://rubygems.org/gems/vagrant-sudo-rsync)
+[![Gem](https://img.shields.io/gem/dt/vagrant-sudo-rsync.svg)](https://rubygems.org/gems/vagrant-sudo-rsync)
+[![Dependency Status](https://gemnasium.com/badges/github.com/TypistTech/vagrant-sudo-rsync.svg)](https://gemnasium.com/github.com/TypistTech/vagrant-sudo-rsync)
+[![license](https://img.shields.io/github/license/TypistTech/vagrant-sudo-rsync.svg)](https://github.com/TypistTech/vagrant-sudo-rsync/blob/master/LICENSE)
+[![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.typist.tech/donate/sunny/)
+[![Hire Typist Tech](https://img.shields.io/badge/Hire-Typist%20Tech-ff69b4.svg)](https://www.typist.tech/contact/)
+
+Copy files from/to a Vagrant VM with sudo and necessary SSH config
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Support!](#support)
+  - [Donate via PayPal *](#donate-via-paypal-)
+  - [Why don't you hire me?](#why-dont-you-hire-me)
+  - [Want to help in other way? Want to be a sponsor?](#want-to-help-in-other-way-want-to-be-a-sponsor)
+- [Feedback](#feedback)
+- [Change log](#change-log)
+- [Author Information](#author-information)
+- [Contributing](#contributing)
+- [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Installation
+
+```bash
+$ vagrant plugin install vagrant-sudo-rsync
+```
+
+## Usage
+
+```bash
+# General
+## This is equivalent to $ rsync --rsh=<automatically determined> --rsync-path='sudo rsync' [OPTION] SRC DEST
+$ vagrant sudo-rsync [OPTION] SRC [DEST]
+
+## Synchronizing from local to remote
+$ vagrant sudo-rsync [OPTION] <some_local_file_or_dir> :<somewhere_on_the_vm>
+
+## Synchronizing from remote to local
+$ vagrant sudo-rsync [OPTION] :<somewhere_on_the_vm> <some_local_file_or_dir>
+
+# Real life example
+
+## Listing all files under /etc/nginx/ssl on remote
+$ vagrant sudo-rsync :/etc/nginx/ssl/
+drwx------          4,096 2017/09/12 00:32:17 .
+-rw-r--r--            424 2017/09/12 00:30:48 dhparams.pem
+-rw-r--r--          1,054 2017/09/12 00:32:17 www.example.cert
+-rw-r--r--          1,708 2017/09/12 00:32:17 www.example.key
+
+## Pulling /etc/nginx/ssl from remote to local desktop
+$ vagrant sudo-rsync -av --delete --info=NAME :/etc/nginx/ssl ~/Desktop
+receiving incremental file list
+ssl/
+ssl/dhparams.pem
+ssl/www.example.com.cert
+ssl/www.example.com.key
+
+sent 85 bytes  received 3,469 bytes  7,108.00 bytes/sec
+total size is 3,186  speedup is 0.90
+```
+
+- Prefix remote paths with colon (`:`)
+- `--rsh` (or `-e`) is automatically determined by `$ vagrant ssh-config` automatically
+- `--rsync-path` is set to `sudo rsync`
+- Anything after `$ vagrant sudo-rsync` is passed to `$ rsync`
+- Never specific `--rsh`, `-e` or `--rsync-path`
+
+## Support!
+
+### Donate via PayPal [![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.typist.tech/donate/vagrant-sudo-rsync/)
+
+Love Vagrant Sudo Rsync? Help me maintain it, a [donation here](https://www.typist.tech/donate/vagrant-sudo-rsync/) can help with it.
+
+### Why don't you hire me?
+
+Ready to take freelance WordPress jobs. Contact me via the contact form [here](https://www.typist.tech/contact/) or, via email [info@typist.tech](mailto:info@typist.tech)
+
+### Want to help in other way? Want to be a sponsor?
+
+Contact: [Tang Rufus](mailto:tangrufus@gmail.com)
+
+## Feedback
+
+**Please provide feedback!** We want to make this library useful in as many projects as possible.
+Please submit an [issue](https://github.com/TypistTech/vagrant-sudo-rsync/issues/new) and point out what you do and don't like, or fork the project and make suggestions.
+**No issue is too small.**
+
+## Change log
+
+Please see [CHANGELOG](./CHANGELOG.md) for more information on what has changed recently.
+
+## Author Information
+
+[Vagrant Sudo Rsync](https://github.com/TypistTech/vagrant-sudo-rsync) is a [Typist Tech](https://www.typist.tech) project and maintained by [Tang Rufus](https://twitter.com/Tangrufus), freelance developer for [hire](https://www.typist.tech/contact/).
+
+Full list of contributors can be found [here](https://github.com/TypistTech/vagrant-sudo-rsync/graphs/contributors).
+
+## Contributing
+
+Please see [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md) for details.
+
+## License
+
+[Vagrant Sudo Rsync](https://github.com/TypistTech/vagrant-sudo-rsync) is released under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/lib/vagrant-sudo-rsync.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "vagrant_sudo_rsync/identity"
+require "vagrant_sudo_rsync/plugin"

data/lib/vagrant_sudo_rsync/command.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module VagrantSudoRsync
+  class Command < Vagrant.plugin("2", :command)
+    def self.synopsis
+      "run rsync command with sudo and necessary SSH config"
+    end
+
+    def execute
+      ARGV.shift
+
+      command = [
+          "rsync",
+          "--rsh='#{rsh}'",
+          "--rsync-path='sudo rsync'",
+          ARGV
+      ].join(" ")
+
+      system(command)
+    end
+
+    def rsh
+      "ssh " + capture("echo '#{vagrant_ssh_config_without_host}' | awk -v ORS=' ' 'NF {print \"-o \" $1 \"=\" $2}'")
+    end
+
+    def vagrant_ssh_config_without_host
+      capture("echo '#{vagrant_ssh_config}' | grep -v '^Host '")
+    end
+
+    def vagrant_ssh_config
+      capture("vagrant ssh-config")
+    end
+
+    def capture(command)
+      stdout, stderr, status = Open3.capture3(command)
+
+      unless status.success?
+        @env.ui.error(stderr)
+        raise CLIInvalidUsage
+      end
+
+      stdout
+    end
+  end
+end

data/lib/vagrant_sudo_rsync/identity.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module VagrantSudoRsync
+  # Gem identity information.
+  module Identity
+    def self.name
+      "vagrant-sudo-rsync"
+    end
+
+    def self.version
+      "0.1.0"
+    end
+  end
+end

data/lib/vagrant_sudo_rsync/plugin.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VagrantSudoRsync
+  class Plugin < Vagrant.plugin("2")
+    name Identity.name
+
+    command "sudo-rsync" do
+      require_relative "command"
+      Command
+    end
+  end
+end

data/vagrant-sudo-rsync.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vagrant_sudo_rsync/identity"
+
+Gem::Specification.new do |spec|
+  spec.name          = VagrantSudoRsync::Identity.name
+  spec.version       = VagrantSudoRsync::Identity.version
+  spec.authors       = ["Tang Rufus", "Typist Tech"]
+  spec.email         = ["tangrufus@gmail.com", "vagrant-sudo-rsync@typist.tech"]
+
+  spec.summary       = "Copy files from/to a Vagrant VM with sudo and necessary SSH config"
+  spec.homepage      = "https://www.typist.tech/projects/vagrant-sudo-rsync"
+  spec.license       = "MIT"
+
+
+  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.required_ruby_version     = "~> 2.2", "< 2.4"
+  spec.required_rubygems_version = ">= 1.3.6"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 12.1"
+  spec.add_development_dependency "rubocop", "~> 0.49"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-sudo-rsync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tang Rufus
+- Typist Tech
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+description: 
+email:
+- tangrufus@gmail.com
+- vagrant-sudo-rsync@typist.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github_changelog_generator"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-sudo-rsync.rb
+- lib/vagrant_sudo_rsync/command.rb
+- lib/vagrant_sudo_rsync/identity.rb
+- lib/vagrant_sudo_rsync/plugin.rb
+- vagrant-sudo-rsync.gemspec
+homepage: https://www.typist.tech/projects/vagrant-sudo-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: '2.2'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Copy files from/to a Vagrant VM with sudo and necessary SSH config
+test_files: []