photish-plugin-sshdeploy 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: ed8fc56928caf8ad9129c31b83df81c25f428a0f
4
+ data.tar.gz: 82e77e569e77b8e9e473ba1c1ef38f7913bd004b
5
+ SHA512:
6
+ metadata.gz: ca05d539cbcb73a3384951b73da58e026900cd76fe361b41246e057010abd0d12e754fa6962e5543435b818290ac545e8468a9b23b43bd382010f5a03dc97fe3
7
+ data.tar.gz: daa50877e6dc8f2f9773201e17c5b7405318b7a0b0059e9153c993d00b9320d7003aac8d216098f69f4ca788e35b5bd97a67d904e847d2455b2620580fbbb1b2
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.2
4
+ before_install: gem install bundler -v 1.11.2
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at henry.lawson@foinq.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in photish-plugin-sshdeploy.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Henry Lawson
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,58 @@
1
+ # Photish::Plugin::Sshdeploy
2
+
3
+ This is a simple [Deployment Engine
4
+ Plugin](https://github.com/henrylawson/photish#deployment-engine-plugins) for
5
+ [Photish](https://github.com/henrylawson/photish#deploy) using SSH.
6
+
7
+ ## Install
8
+
9
+ To install it, simple include the Gem in your Gemfile:
10
+
11
+ **./Gemfile**
12
+
13
+ ```Gemfile
14
+ gem 'photish-plugin-sshdeploy'
15
+ ```
16
+
17
+ And in your Photish config, ensure it is listed in your `plugins` Config File
18
+ Option.
19
+
20
+ **./config.yml**
21
+
22
+ ```YAML
23
+ plugins: ['photish/plugin/sshdeploy']
24
+ ```
25
+
26
+ Then run `bundle install`.
27
+
28
+ Now that it is installed, once you have configured it, use `photish deploy
29
+ --engine=ssh` to run it.
30
+
31
+ ## Configure
32
+
33
+ This deployment engine requires certain values being present in your
34
+ `config.yml` file.
35
+
36
+ ```YAML
37
+ deploy:
38
+ host: foinq.com # the host to connect and deploy too
39
+ publish_dir: /srv/www/foinq.com/photish-montage # the directory to copy files too
40
+ publish_temp_dir: /tmp/photish-montage-publish # the temporary directory to extract files too
41
+ upload_temp_dir: /tmp/photish-montage-upload # the temporary directory to upload files too
42
+ www_user: www-fqc # the unix user account to finally copy the files under
43
+ ```
44
+
45
+ It also requires that you have configured your `~/.ssh/config` file with the
46
+ login details of the host you wish to upload too. [See here for a simple
47
+ guide](http://nerderati.com/2011/03/17/simplify-your-life-with-an-ssh-config-file/).
48
+
49
+ ## Example usage
50
+
51
+ An example usage can be seen in the [Photish
52
+ Montage](https://github.com/henrylawson/photish-montage) demo.
53
+
54
+ ## License
55
+
56
+ The gem is available as open source under the terms of the [MIT
57
+ License](http://opensource.org/licenses/MIT).
58
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "photish/plugin/sshdeploy"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,9 @@
1
+ require "photish/plugin/sshdeploy/version"
2
+ require "photish/plugin/sshdeploy/deploy"
3
+
4
+ module Photish
5
+ module Plugin
6
+ module Sshdeploy
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,96 @@
1
+ module Photish
2
+ module Plugin
3
+ module Sshdeploy
4
+ class Deploy
5
+ def initialize(config, log)
6
+ @config = config
7
+ @log = log
8
+ end
9
+
10
+ def deploy_site
11
+ log.info "Publishing website to #{host}"
12
+
13
+ log.info "Cleaning temp locations and ensuring directories exist"
14
+ execute("ssh #{host} -v '" +
15
+ "mkdir -p #{publish_temp_dir} && " +
16
+ "rm -rf #{publish_temp_dir}/* && " +
17
+ "mkdir -p #{upload_temp_dir} && " +
18
+ "rm -rf #{upload_temp_dir}/*" +
19
+ "'")
20
+
21
+ log.info "Creating tar gz of photish site"
22
+ execute("GZIP=-9 tar -zcvf " +
23
+ "#{output_dir_compress_file} " +
24
+ "-C #{output_dir_with_base} .")
25
+
26
+ log.info "Uploading site to upload temp location"
27
+ execute("rsync -v " +
28
+ "-e 'ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null' " +
29
+ "--progress #{output_dir_compress_file} " +
30
+ "#{host}:#{upload_temp_dir}")
31
+
32
+ log.info "Extracting site to publish temp location"
33
+ execute("ssh #{host} -v " +
34
+ "'tar -zxvf " +
35
+ "#{upload_temp_dir}/#{output_dir_compress_filename} " +
36
+ "-C #{publish_temp_dir}'")
37
+
38
+ log.info "Moving publish temp to publish folder"
39
+ execute("ssh #{host} -v " +
40
+ "'sudo su #{www_user} bash -c \"" +
41
+ "mkdir -p #{publish_dir} && " +
42
+ "rm -rf #{publish_dir}/* && " +
43
+ "cp -rf #{publish_temp_dir}/* #{publish_dir}\"'")
44
+ log.info "#{Time.new}: Deployment complete"
45
+ ensure
46
+ FileUtils.rm_rf(output_dir_compress_file)
47
+ end
48
+
49
+ private
50
+
51
+ attr_reader :config,
52
+ :log
53
+
54
+ delegate :deploy,
55
+ :output_dir,
56
+ :url,
57
+ to: :config
58
+
59
+ delegate :host,
60
+ :publish_dir,
61
+ :publish_temp_dir,
62
+ :upload_temp_dir,
63
+ :www_user,
64
+ to: :deploy
65
+
66
+ def output_dir_with_base
67
+ File.join([output_dir, url.base].flatten)
68
+ end
69
+
70
+ def output_dir_compress_filename
71
+ 'output_dir.tar.gz'
72
+ end
73
+
74
+ def output_dir_compress_file
75
+ @output_dir_compress_file ||= File.join(Dir.mktmpdir,
76
+ output_dir_compress_filename)
77
+ end
78
+
79
+ def self.is_for?(type)
80
+ [
81
+ Photish::Plugin::Type::Deploy
82
+ ].include?(type)
83
+ end
84
+
85
+ def self.engine_name
86
+ 'ssh'
87
+ end
88
+
89
+ def execute(command)
90
+ log.info "Executing: #{command}"
91
+ system("#{command}") || exit(1)
92
+ end
93
+ end
94
+ end
95
+ end
96
+ end
@@ -0,0 +1,7 @@
1
+ module Photish
2
+ module Plugin
3
+ module Sshdeploy
4
+ VERSION = "0.1.0"
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'photish/plugin/sshdeploy/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "photish-plugin-sshdeploy"
8
+ spec.version = Photish::Plugin::Sshdeploy::VERSION
9
+ spec.authors = ["Henry Lawson"]
10
+ spec.email = ["henry.lawson@foinq.com"]
11
+
12
+ spec.summary = %q{A simple SSH based Deployment Engine Plugin for Photish}
13
+ spec.description = %q{Deploy your Photish site via SSH using rsync}
14
+ spec.homepage = "https://github.com/henrylawson/photish-plugin-sshdeploy"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 1.11"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ spec.add_development_dependency "rspec", "~> 3.0"
25
+ end
metadata ADDED
@@ -0,0 +1,100 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: photish-plugin-sshdeploy
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Henry Lawson
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-12-27 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.11'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.11'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: Deploy your Photish site via SSH using rsync
56
+ email:
57
+ - henry.lawson@foinq.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - lib/photish/plugin/sshdeploy.rb
73
+ - lib/photish/plugin/sshdeploy/deploy.rb
74
+ - lib/photish/plugin/sshdeploy/version.rb
75
+ - photish-plugin-sshdeploy.gemspec
76
+ homepage: https://github.com/henrylawson/photish-plugin-sshdeploy
77
+ licenses:
78
+ - MIT
79
+ metadata: {}
80
+ post_install_message:
81
+ rdoc_options: []
82
+ require_paths:
83
+ - lib
84
+ required_ruby_version: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ required_rubygems_version: !ruby/object:Gem::Requirement
90
+ requirements:
91
+ - - ">="
92
+ - !ruby/object:Gem::Version
93
+ version: '0'
94
+ requirements: []
95
+ rubyforge_project:
96
+ rubygems_version: 2.4.5
97
+ signing_key:
98
+ specification_version: 4
99
+ summary: A simple SSH based Deployment Engine Plugin for Photish
100
+ test_files: []