photish-plugin-sshdeploy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed8fc56928caf8ad9129c31b83df81c25f428a0f
+  data.tar.gz: 82e77e569e77b8e9e473ba1c1ef38f7913bd004b
+SHA512:
+  metadata.gz: ca05d539cbcb73a3384951b73da58e026900cd76fe361b41246e057010abd0d12e754fa6962e5543435b818290ac545e8468a9b23b43bd382010f5a03dc97fe3
+  data.tar.gz: daa50877e6dc8f2f9773201e17c5b7405318b7a0b0059e9153c993d00b9320d7003aac8d216098f69f4ca788e35b5bd97a67d904e847d2455b2620580fbbb1b2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at henry.lawson@foinq.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in photish-plugin-sshdeploy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Henry Lawson
+
+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,58 @@
+# Photish::Plugin::Sshdeploy
+
+This is a simple [Deployment Engine
+Plugin](https://github.com/henrylawson/photish#deployment-engine-plugins) for
+[Photish](https://github.com/henrylawson/photish#deploy) using SSH.
+
+## Install
+
+To install it, simple include the Gem in your Gemfile:
+
+**./Gemfile**
+
+```Gemfile
+gem 'photish-plugin-sshdeploy'
+```
+
+And in your Photish config, ensure it is listed in your `plugins` Config File
+Option.
+
+**./config.yml**
+
+```YAML
+plugins: ['photish/plugin/sshdeploy']
+```
+
+Then run `bundle install`.
+
+Now that it is installed, once you have configured it, use `photish deploy
+--engine=ssh` to run it.
+
+## Configure
+
+This deployment engine requires certain values being present in your
+`config.yml` file.
+
+```YAML
+deploy:
+  host: foinq.com                                   # the host to connect and deploy too
+  publish_dir: /srv/www/foinq.com/photish-montage   # the directory to copy files too
+  publish_temp_dir: /tmp/photish-montage-publish    # the temporary directory to extract files too
+  upload_temp_dir: /tmp/photish-montage-upload      # the temporary directory to upload files too
+  www_user: www-fqc                                 # the unix user account to finally copy the files under
+```
+
+It also requires that you have configured your `~/.ssh/config` file with the
+login details of the host you wish to upload too. [See here for a simple
+guide](http://nerderati.com/2011/03/17/simplify-your-life-with-an-ssh-config-file/).
+
+## Example usage
+
+An example usage can be seen in the [Photish
+Montage](https://github.com/henrylawson/photish-montage) demo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+

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 "photish/plugin/sshdeploy"
+
+# 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

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/photish/plugin/sshdeploy.rb

@@ -0,0 +1,9 @@
+require "photish/plugin/sshdeploy/version"
+require "photish/plugin/sshdeploy/deploy"
+
+module Photish
+  module Plugin
+    module Sshdeploy
+    end
+  end
+end

data/lib/photish/plugin/sshdeploy/deploy.rb

@@ -0,0 +1,96 @@
+module Photish
+  module Plugin
+    module Sshdeploy
+      class Deploy
+        def initialize(config, log)
+          @config = config
+          @log = log
+        end
+
+        def deploy_site
+          log.info "Publishing website to #{host}"
+
+          log.info "Cleaning temp locations and ensuring directories exist"
+          execute("ssh #{host} -v '" +
+                  "mkdir -p #{publish_temp_dir} && " +
+                  "rm -rf #{publish_temp_dir}/* && " +
+                  "mkdir -p #{upload_temp_dir} && " +
+                  "rm -rf #{upload_temp_dir}/*" +
+                  "'")
+
+          log.info "Creating tar gz of photish site"
+          execute("GZIP=-9 tar -zcvf " +
+                  "#{output_dir_compress_file} " +
+                  "-C #{output_dir_with_base} .")
+
+          log.info "Uploading site to upload temp location"
+          execute("rsync -v " +
+                  "-e 'ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null' " +
+                  "--progress #{output_dir_compress_file} " +
+                  "#{host}:#{upload_temp_dir}")
+
+          log.info "Extracting site to publish temp location"
+          execute("ssh #{host} -v " +
+                  "'tar -zxvf " +
+                  "#{upload_temp_dir}/#{output_dir_compress_filename} " +
+                  "-C #{publish_temp_dir}'")
+
+          log.info "Moving publish temp to publish folder"
+          execute("ssh #{host} -v " +
+                  "'sudo su #{www_user} bash -c \"" +
+                  "mkdir -p #{publish_dir} && " +
+                  "rm -rf #{publish_dir}/* && " +
+                  "cp -rf #{publish_temp_dir}/* #{publish_dir}\"'")
+          log.info "#{Time.new}: Deployment complete"
+        ensure
+          FileUtils.rm_rf(output_dir_compress_file)
+        end
+
+        private
+
+        attr_reader :config,
+                    :log
+
+        delegate :deploy,
+                 :output_dir,
+                 :url,
+                 to: :config
+
+        delegate :host,
+                 :publish_dir,
+                 :publish_temp_dir,
+                 :upload_temp_dir,
+                 :www_user,
+                 to: :deploy
+
+        def output_dir_with_base
+          File.join([output_dir, url.base].flatten)
+        end
+
+        def output_dir_compress_filename
+          'output_dir.tar.gz'
+        end
+
+        def output_dir_compress_file
+          @output_dir_compress_file ||= File.join(Dir.mktmpdir,
+                                                  output_dir_compress_filename)
+        end
+
+        def self.is_for?(type)
+          [
+            Photish::Plugin::Type::Deploy
+          ].include?(type)
+        end
+
+        def self.engine_name
+          'ssh'
+        end
+
+        def execute(command)
+          log.info "Executing: #{command}"
+          system("#{command}") || exit(1)
+        end
+      end
+    end
+  end
+end

data/lib/photish/plugin/sshdeploy/version.rb

@@ -0,0 +1,7 @@
+module Photish
+  module Plugin
+    module Sshdeploy
+      VERSION = "0.1.0"
+    end
+  end
+end

data/photish-plugin-sshdeploy.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'photish/plugin/sshdeploy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "photish-plugin-sshdeploy"
+  spec.version       = Photish::Plugin::Sshdeploy::VERSION
+  spec.authors       = ["Henry Lawson"]
+  spec.email         = ["henry.lawson@foinq.com"]
+
+  spec.summary       = %q{A simple SSH based Deployment Engine Plugin for Photish}
+  spec.description   = %q{Deploy your Photish site via SSH using rsync}
+  spec.homepage      = "https://github.com/henrylawson/photish-plugin-sshdeploy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: photish-plugin-sshdeploy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henry Lawson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: Deploy your Photish site via SSH using rsync
+email:
+- henry.lawson@foinq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/photish/plugin/sshdeploy.rb
+- lib/photish/plugin/sshdeploy/deploy.rb
+- lib/photish/plugin/sshdeploy/version.rb
+- photish-plugin-sshdeploy.gemspec
+homepage: https://github.com/henrylawson/photish-plugin-sshdeploy
+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
+signing_key: 
+specification_version: 4
+summary: A simple SSH based Deployment Engine Plugin for Photish
+test_files: []