capistrano-ssh-doctor 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f6a315084d957611956b98eb45770af4d663d31
-  data.tar.gz: 2ed9041723f8508c57e4e54d2166fee521d67dc9
+  metadata.gz: ef8401ae50a229170d1d7623f17a25414a11ba54
+  data.tar.gz: 924e11bbae6cd821fba5372f72826cc1c5ac6365
 SHA512:
-  metadata.gz: 736cb8e50188ecd0dc1144a7cd0d3624e5adbfd878623ad2f725ab3d7154aec681b6cfc19bda5d53154f098dc663743b8ba225d79c4bcc9a168bf3ab4d42774d
-  data.tar.gz: 67a494421f56b50a120a3527d9af164d9e40cdc37cf3f4f212ece7203705ffdf480a4fde641c19a07d286f787136fd3a3fd9820b374d6d0663126d583ebfc8ef
+  metadata.gz: 4640484fdd03aa6b531a9a61bab3bf32b8b596d5ddfc630480eec8c19931cecc9d525d69a048c7d2638e77b1faf06e771ada0ee91f24e8fa369c4fd782e70ad5
+  data.tar.gz: a4357d2315fe1d333ecd3283771b9cc974c3f3ccd5dbc6ad9ab0caa07880a4148e780841acb55742bdf07cc5eb5b4b51392c81cc4c32a82289d3b3023a2745bf

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+### master
+- cosmetic changes
+
+### v0.0.1
+- get the plugin working

data/README.md

@@ -3,11 +3,12 @@
 This plugin helps you setup and debug `ssh-agent` forwarding for Capistrano
 deployment.
 
-It's created to complement the official [capistrano authentication guide](http://capistranorb.com/documentation/getting-started/authentication-and-authorisation/).
+It's created to complement the official
+[capistrano authentication guide](http://capistranorb.com/documentation/getting-started/authentication-and-authorisation/).
 
 The following is presumed:
 - you're using `git`
-- you want to use passwordless ssh login to the servers
+- you want to use passwordless ssh to login to the servers
 - you want to use the `ssh-agent` forwarding strategy for checking out code in
 the remote repository (btw. good choice, it's a least hassle)
 
@@ -21,16 +22,12 @@ this configuration. The above assumptions should hold true for 98% users.
 The plugin is made for beginners and users that are not sure if their setup is
 good, so they want to confirm or debug it.
 
-If you have enough knowldge/experience with `ssh` tool and you're sure you have
-`ssh-agent` forwarding working for your server, you probably don't need this
-plugin.
-
 ### Installation
 
 Put the following in your application's `Gemfile`:
 
     group :development do
-      gem 'capistrano', '~> 3.1'
+      gem 'capistrano', '~> 3.2.1'
       gem 'capistrano-ssh-doctor'
     end
 
@@ -50,15 +47,15 @@ In the console run:
 
     $ bundle exec cap production ssh:doctor
 
-The plugin will perform a number of checks and output a report at the end.
+A number of checks will be performed and you'll get a report at the end.
 
-**Solving Errors**
+#### Solving Errors
 
 In case there are errors in your setup, specific instructions for next
 steps will be provided in report output.
 
 **Important:** errors should be tackled in the order of their output. So, if
-you got errors 2, 5 and 7 in the report, start by solving error 2.
+you get errors 2, 5 and 7 in the report, start by solving error 2.
 
 It is very probable that "solving" one or two initial errors will actually make
 everything work. A lot of the checks are inter-dependent. So don't be
@@ -72,7 +69,7 @@ tasks. You're ok with proceeding with the deployment then.
 
 ### Which checks are performed?
 
-1. checks that you're using `git` repository protocol
+1. checks that you're using `git` as a `scm`
 2. checks that ssh private key file exists locally
 3. checks if `ssh-agent` process is running locally
 4. checks that `ssh-add` process can communicate with `ssh-agent`
@@ -88,29 +85,14 @@ task.
 
 ### More Capistrano automation?
 
-If you'd like to streamline your Capistrano deploys, you might want to check
-these zero-configuration, plug-n-play plugins:
-
-- [capistrano-unicorn-nginx](https://github.com/bruno-/capistrano-unicorn-nginx)<br/>
-no-configuration unicorn and nginx setup with sensible defaults
-- [capistrano-postgresql](https://github.com/bruno-/capistrano-postgresql)<br/>
-plugin that automates postgresql configuration and setup
-- [capistrano-rbenv-install](https://github.com/bruno-/capistrano-rbenv-install)<br/>
-would you like Capistrano to install rubies for you automatically?
-- [capistrano-safe-deploy-to](https://github.com/bruno-/capistrano-safe-deploy-to)<br/>
-if you're annoyed that Capistrano does **not** create a deployment path for the
-app on the server (default `/var/www/myapp`), this is what you need!
+Check out [capistrano-plugins](https://github.com/capistrano-plugins) github org.
 
 ### Contributing and bug reports
 
 If you got stuck at some point and really can't find a solution, please open a
-[github issue](/issues) and maybe I can help you.
-
-Also, I can use your problem to improve this plugin.
+github issue and maybe I can help. Also, your problem can be used to improve
+this plugin and help others.
 
 ### License
 
 [MIT](LICENSE.md)
-
-# TODO
-- do not store text in report hash, store only success/fail there

data/capistrano-ssh-doctor.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
     are any errors with the setup.
   EOF
   gem.summary       = 'This plugin helps you setup and debug `ssh-doctor` forwarding for Capistrano deployment.'
-  gem.homepage      = 'https://github.com/bruno-/capistrano-ssh-doctor'
+  gem.homepage      = 'https://github.com/capistrano-plugins/capistrano-ssh-doctor'
 
   gem.license       = 'MIT'
 

data/lib/capistrano/ssh_doctor/report.rb

@@ -4,11 +4,7 @@ module Capistrano
   module SshDoctor
     class Report
 
-      include Capistrano::SshDoctor::Report::Messages
-
-      def self.report
-        @report ||= new
-      end
+      include Messages
 
       def initialize
         @report_messages = default_messages

data/lib/capistrano/ssh_doctor/report/messages.rb

@@ -39,7 +39,7 @@ module Capistrano
         end
 
         def config_repo_url_error(_)
-          <<-EOF.gsub(/^\s+/, '')
+          <<-EOF.gsub(/^ +/, '')
             It seems the git repository url in `repo_url` setting uses https
             protocol. Https protocol prompts for password and so git protocol
             should be used.
@@ -54,7 +54,7 @@ module Capistrano
           msg = "It seems Capistrano connects to the following hosts using password login:\n"
           msg << hosts.map(&:to_s).join(', ')
           msg.concat "\n"
-          msg.concat <<-EOF.gsub(/^\s+/, '')
+          msg.concat <<-EOF.gsub(/^ +/, '')
             It is strongly suggested to use passwordless ssh login.
 
             Actions:
@@ -72,7 +72,7 @@ module Capistrano
           msg = "It seems Capistrano connects without ssh agent forwarding to the following hosts:\n"
           msg << hosts.join(', ')
           msg.concat "\n"
-          msg.concat <<-EOF.gsub(/^\s+/, '')
+          msg.concat <<-EOF.gsub(/^ +/, '')
             Actions:
             - make sure Capistrano uses the default ssh option for `forward_agent`.
             Just remove any `forward_agent` setting from the stage file (e.g.
@@ -81,7 +81,7 @@ module Capistrano
         end
 
         def local_private_key_exists_error(_)
-          <<-EOF.gsub(/^\s+/, '')
+          <<-EOF.gsub(/^ +/, '')
             Uh, oh. It seems you do not have ssh private keys generated, or they're
             not located in standard location.
 
@@ -93,7 +93,7 @@ module Capistrano
         end
 
         def local_agent_running_env_var_error(_)
-          <<-EOF.gsub(/^\s+/, '')
+          <<-EOF.gsub(/^ +/, '')
             It seems `ssh-agent` is not running on local machine.
 
             Actions:
@@ -103,7 +103,7 @@ module Capistrano
         end
 
         def local_agent_running_ssh_add_error(_)
-          <<-EOF.gsub(/^\s+/, '')
+          <<-EOF.gsub(/^ +/, '')
             It seems ssh-add cannot make a connection with ssh-agent process
             on local machine.
 
@@ -119,7 +119,7 @@ module Capistrano
         end
 
         def local_keys_added_to_agent_error(_)
-          <<-EOF.gsub(/^\s+/, '')
+          <<-EOF.gsub(/^ +/, '')
             It seems local ssh-agent process has no loaded keys.
 
             Actions:
@@ -131,7 +131,7 @@ module Capistrano
         end
 
         def local_repo_access_error(_)
-          <<-EOF.gsub(/^\s+/, '')
+          <<-EOF.gsub(/^ +/, '')
             It seems git application repository cannot be accessed from local machine.
 
             Actions:
@@ -146,7 +146,7 @@ module Capistrano
           msg = "It seems Capistrano did not succeed in making ssh agent forwarding for these hosts:\n"
           msg << hosts.join(', ')
           msg.concat "\n"
-          msg.concat <<-EOF.gsub(/^\s+/, '')
+          msg.concat <<-EOF.gsub(/^ +/, '')
             Actions:
             - make sure all the previous checks pass
           EOF
@@ -156,7 +156,7 @@ module Capistrano
           msg = "It seems Capistrano cannot access application git repository from these hosts:\n"
           msg << hosts.join(', ')
           msg.concat "\n"
-          msg.concat <<-EOF.gsub(/^\s+/, '')
+          msg.concat <<-EOF.gsub(/^ +/, '')
             Actions:
             - make sure all the previous checks pass. That should make this one work too.
           EOF

data/lib/capistrano/ssh_doctor/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module SshDoctor
-    VERSION = "0.0.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/capistrano/tasks/ssh_doctor.rake

@@ -1,7 +1,11 @@
-require 'capistrano/ssh_doctor/dsl'
+require 'capistrano/ssh_doctor/report'
 
 namespace :ssh do
 
+  def report
+    @report ||= Capistrano::SshDoctor::Report.new
+  end
+
   namespace :config do
 
     task :git do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-ssh-doctor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Bruno Sutic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -57,12 +57,11 @@ files:
 - capistrano-ssh-doctor.gemspec
 - lib/capistrano-ssh-doctor.rb
 - lib/capistrano/ssh_doctor.rb
-- lib/capistrano/ssh_doctor/dsl.rb
 - lib/capistrano/ssh_doctor/report.rb
 - lib/capistrano/ssh_doctor/report/messages.rb
 - lib/capistrano/ssh_doctor/version.rb
 - lib/capistrano/tasks/ssh_doctor.rake
-homepage: https://github.com/bruno-/capistrano-ssh-doctor
+homepage: https://github.com/capistrano-plugins/capistrano-ssh-doctor
 licenses:
 - MIT
 metadata: {}
@@ -82,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: This plugin helps you setup and debug `ssh-doctor` forwarding for Capistrano

data/lib/capistrano/ssh_doctor/dsl.rb

@@ -1,14 +0,0 @@
-require_relative 'report'
-
-module Capistrano
-  module SshDoctor
-    module DSL
-
-      def report
-        Capistrano::SshDoctor::Report.report
-      end
-
-    end
-  end
-end
-self.extend Capistrano::SshDoctor::DSL