winrm-fs 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.rubocop.yml +9 -0
- data/.travis.yml +5 -0
- data/Gemfile +3 -0
- data/LICENSE +202 -0
- data/README.md +62 -0
- data/Rakefile +30 -0
- data/VERSION +1 -0
- data/Vagrantfile +9 -0
- data/bin/rwinrmcp +86 -0
- data/changelog.md +1 -0
- data/lib/winrm-fs.rb +27 -0
- data/lib/winrm-fs/core/command_executor.rb +69 -0
- data/lib/winrm-fs/core/file_uploader.rb +84 -0
- data/lib/winrm-fs/core/temp_zip_file.rb +95 -0
- data/lib/winrm-fs/core/upload_orchestrator.rb +118 -0
- data/lib/winrm-fs/exceptions.rb +28 -0
- data/lib/winrm-fs/file_manager.rb +123 -0
- data/lib/winrm-fs/scripts/checksum.ps1.erb +13 -0
- data/lib/winrm-fs/scripts/create_dir.ps1.erb +6 -0
- data/lib/winrm-fs/scripts/decode_file.ps1.erb +36 -0
- data/lib/winrm-fs/scripts/delete.ps1.erb +6 -0
- data/lib/winrm-fs/scripts/download.ps1.erb +7 -0
- data/lib/winrm-fs/scripts/exists.ps1.erb +8 -0
- data/lib/winrm-fs/scripts/scripts.rb +31 -0
- data/spec/config-example.yml +5 -0
- data/spec/file_manager_spec.rb +140 -0
- data/spec/matchers.rb +54 -0
- data/spec/spec_helper.rb +48 -0
- data/spec/temp_zip_file_spec.rb +71 -0
- data/winrm-fs.gemspec +36 -0
- metadata +189 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 959e097cf30b655d2e95f26e6ec808e9f99b5606
|
4
|
+
data.tar.gz: cff6d9bc348a2ac845ed9c4ae16890ea55ce509e
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 35047acdb0750d38697dd484dfcdbaa48972471b653a07f222cf7490746e913acb2da62dc47055c55cd7997158ca311d732e5b4cfcd933a5a9257706735087f7
|
7
|
+
data.tar.gz: dd3abe06a552686fb4cea084a056898f6012b2acceb9202226f5568f59d6cab1da0d839e25d7ae9328d5f2c7ae93aecf87d78be08428059b8dabc50cee616483
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.rubocop.yml
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
# File system operations over Windows Remote Management (WinRM) for Ruby
|
2
|
+
[![Build Status](https://travis-ci.org/WinRb/winrm-fs.svg?branch=master)](https://travis-ci.org/WinRb/winrm-fs)
|
3
|
+
[![Gem Version](https://badge.fury.io/rb/winrm-fs.svg)](http://badge.fury.io/rb/winrm-fs)
|
4
|
+
|
5
|
+
## Uploading files
|
6
|
+
Files may be copied from the local machine to the winrm endpoint. Individual
|
7
|
+
files or directories may be specified:
|
8
|
+
```ruby
|
9
|
+
require 'winrm-fs'
|
10
|
+
|
11
|
+
service = WinRM::WinRMWebService.new(...
|
12
|
+
file_manager = WinRM::FS::FileManager.new(service)
|
13
|
+
file_manager.upload('c:/dev/my_dir', '$env:AppData')
|
14
|
+
```
|
15
|
+
Or an array of several files and/or directories can be included:
|
16
|
+
```ruby
|
17
|
+
file_manager.upload(['c:/dev/file1.txt','c:/dev/dir1'], '$env:AppData')
|
18
|
+
```
|
19
|
+
|
20
|
+
### Handling progress events
|
21
|
+
If you want to implemnt your own custom progress handling, you can pass a code
|
22
|
+
block and use the proggress data that `upload` yields to this block:
|
23
|
+
```ruby
|
24
|
+
file_manager.upload('c:/dev/my_dir', '$env:AppData') do |bytes_copied, total_bytes, local_path, remote_path|
|
25
|
+
puts "#{bytes_copied}bytes of #{total_bytes}bytes copied"
|
26
|
+
end
|
27
|
+
```
|
28
|
+
|
29
|
+
## Contributing
|
30
|
+
|
31
|
+
1. Fork it.
|
32
|
+
2. Create a branch (git checkout -b my_feature_branch)
|
33
|
+
3. Run the unit and integration tests (bundle exec rake integration)
|
34
|
+
4. Commit your changes (git commit -am "Added a sweet feature")
|
35
|
+
5. Push to the branch (git push origin my_feature_branch)
|
36
|
+
6. Create a pull requst from your branch into master (Please be sure to provide enough detail for us to cipher what this change is doing)
|
37
|
+
|
38
|
+
### Running the tests
|
39
|
+
|
40
|
+
We use Bundler to manage dependencies during development.
|
41
|
+
|
42
|
+
```
|
43
|
+
$ bundle install
|
44
|
+
```
|
45
|
+
|
46
|
+
Once you have the dependencies, you can run the unit tests with `rake`:
|
47
|
+
|
48
|
+
```
|
49
|
+
$ bundle exec rake spec
|
50
|
+
```
|
51
|
+
|
52
|
+
To run the integration tests you will need a Windows box with the WinRM service properly configured. Its easiest to use the Vagrant Windows box in the Vagrantilfe of this repo.
|
53
|
+
|
54
|
+
1. Create a Windows VM with WinRM configured (see above).
|
55
|
+
2. Copy the config-example.yml to config.yml - edit this file with your WinRM connection details.
|
56
|
+
3. Run `bundle exec rake integration`
|
57
|
+
|
58
|
+
## WinRM-fs Authors
|
59
|
+
* Shawn Neal (https://github.com/sneal)
|
60
|
+
* Matt Wrock (https://github.com/mwrock)
|
61
|
+
|
62
|
+
[Contributors](https://github.com/WinRb/winrm-fs/graphs/contributors)
|
data/Rakefile
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
require 'rubygems'
|
3
|
+
require 'bundler/setup'
|
4
|
+
require 'rspec/core/rake_task'
|
5
|
+
require 'rubocop/rake_task'
|
6
|
+
|
7
|
+
# Change to the directory of this file.
|
8
|
+
Dir.chdir(File.expand_path('../', __FILE__))
|
9
|
+
|
10
|
+
# For gem creation and bundling
|
11
|
+
require 'bundler/gem_tasks'
|
12
|
+
|
13
|
+
RSpec::Core::RakeTask.new(:spec) do |task|
|
14
|
+
task.pattern = 'test/spec/*_spec.rb'
|
15
|
+
task.rspec_opts = ['--color', '-f documentation']
|
16
|
+
task.rspec_opts << '-tunit'
|
17
|
+
end
|
18
|
+
|
19
|
+
# Run the integration test suite
|
20
|
+
RSpec::Core::RakeTask.new(:integration) do |task|
|
21
|
+
task.pattern = 'test/spec/*_spec.rb'
|
22
|
+
task.rspec_opts = ['--color', '-f documentation']
|
23
|
+
task.rspec_opts << '-tintegration'
|
24
|
+
end
|
25
|
+
|
26
|
+
RuboCop::RakeTask.new
|
27
|
+
|
28
|
+
task default: [:spec, :rubocop]
|
29
|
+
|
30
|
+
task all: [:default, :integration]
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.1.0
|
data/Vagrantfile
ADDED
data/bin/rwinrmcp
ADDED
@@ -0,0 +1,86 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# encoding: UTF-8
|
3
|
+
#
|
4
|
+
# Copyright 2014 Shawn Neal <sneal@sneal.net>
|
5
|
+
#
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
15
|
+
# See the License for the specific language governing permissions and
|
16
|
+
# limitations under the License.
|
17
|
+
|
18
|
+
# TODO: refactor this
|
19
|
+
# rubocop:disable all
|
20
|
+
|
21
|
+
$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
|
22
|
+
|
23
|
+
require 'io/console'
|
24
|
+
require 'winrm-fs'
|
25
|
+
|
26
|
+
def help_msg
|
27
|
+
puts 'Usage: rwinrmcp sourcefile user@host:directory/targetfile'
|
28
|
+
puts ''
|
29
|
+
end
|
30
|
+
|
31
|
+
def parse_options
|
32
|
+
options = {}
|
33
|
+
fail 'Missing required options' unless ARGV.length == 2
|
34
|
+
|
35
|
+
options[:source_path] = ARGV[0]
|
36
|
+
fail "Cannot find source file: #{options[:source_path]}" unless \
|
37
|
+
File.exist?(options[:source_path])
|
38
|
+
|
39
|
+
m = /^(?<user>\w+)@{1}(?<host>[a-zA-Z0-9\.]+)(?<port>:[0-9]+)?:{1}(?<file>.+)/.match(ARGV[1])
|
40
|
+
fail "#{ARGV[1]} is an invalid destination" unless m
|
41
|
+
options[:user] = m[:user]
|
42
|
+
options[:endpoint] = "http://#{m[:host]}#{m[:port] || ':5985'}/wsman"
|
43
|
+
options[:dest_path] = m[:file]
|
44
|
+
|
45
|
+
# Get the password
|
46
|
+
print 'Password: '
|
47
|
+
options[:pass] = STDIN.noecho(&:gets).chomp
|
48
|
+
puts
|
49
|
+
|
50
|
+
# Set some defaults required by WinRM WS
|
51
|
+
options[:auth_type] = :plaintext
|
52
|
+
options[:basic_auth_only] = true
|
53
|
+
|
54
|
+
options
|
55
|
+
rescue StandardError => e
|
56
|
+
puts e.message
|
57
|
+
help_msg
|
58
|
+
exit 1
|
59
|
+
end
|
60
|
+
|
61
|
+
def file_manager(options)
|
62
|
+
service = WinRM::WinRMWebService.new(
|
63
|
+
options[:endpoint],
|
64
|
+
options[:auth_type].to_sym,
|
65
|
+
options)
|
66
|
+
WinRM::FS::FileManager.new(service)
|
67
|
+
end
|
68
|
+
|
69
|
+
def run(options)
|
70
|
+
bytes = file_manager(options).upload(options[:source_path], options[:dest_path])
|
71
|
+
puts "#{bytes} total bytes transfered"
|
72
|
+
exit 0
|
73
|
+
rescue Interrupt
|
74
|
+
puts 'exiting'
|
75
|
+
# ctrl-c
|
76
|
+
rescue WinRM::WinRMAuthorizationError
|
77
|
+
puts 'Authentication failed, bad user name or password'
|
78
|
+
exit 1
|
79
|
+
rescue StandardError => e
|
80
|
+
puts e.message
|
81
|
+
exit 1
|
82
|
+
end
|
83
|
+
|
84
|
+
run(parse_options)
|
85
|
+
|
86
|
+
# rubocop:enable all
|