capistrano-demand_forward_agent 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b77ebfb30a2d0a46fcd407be9eb48c7d48556180
+  data.tar.gz: 36267a8cd039ff4761dc43e410b4e06bfdf677b7
+SHA512:
+  metadata.gz: 03eeb58af6a2e3e2bf79e11329f20089827ef16af9a3e5f6e4278f52d890b3322107cd715b1b620a62b4e9b9946d9543e4eeb1f738a87abc7887047326d5a83a
+  data.tar.gz: d97e8ce569f1a4ae6263b79df84e933e353c215364d27cd4b4cf5b4c76a30ffc28ef0cf57755255297e0dc62f24134007452099bbb09b01ff0f4bf8dd2741d88

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Takeru Naito
+
+MIT License
+
+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,46 @@
+Capistrano::DemandForwardAgent
+==============================
+
+Demand forward-agent on deploying.
+
+- Confirming agent connection.
+- Confirming identity status.
+
+Unless satisfied then raise exception.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-demand_forward_agent',
+      git: 'git@github.com:elim/capistrano-demand_forward_agent.git'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-demand_forward_agent
+
+
+Usage
+-----
+
+Put the following to your `deploy.rb`.
+
+    require 'capistrano-demand_forward_agent'
+
+    demand_forward_agent.confirm
+
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/capistrano-demand_forward_agent.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/demand_forward_agent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-demand_forward_agent'
+  spec.version       = Capistrano::DemandForwardAgent::VERSION
+  spec.authors       = ['Takeru Naito']
+  spec.email         = ['takeru.naito@gmail.com']
+  spec.description   = %q{Demand SSH forward agent on capistrano.}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/elim/capistrano-demand_forward_agent'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'capistrano'
+  spec.add_development_dependency 'net-ssh'
+end

data/lib/capistrano/demand_forward_agent.rb

@@ -0,0 +1,45 @@
+require 'capistrano/demand_forward_agent/version'
+require 'capistrano'
+require 'net/ssh'
+
+module Capistrano
+  module DemandForwardAgent
+    extend self
+    include Net::SSH::Authentication
+
+    SSHAgentError    = Class.new Capistrano::Error
+    SSHIdentityError = Class.new Capistrano::Error
+
+    def confirm
+      set_ssh_option
+      agent = connect_agent
+      confirm_identity agent
+    end
+
+    def set_ssh_option
+      ssh_options[:forward_agent] = true
+    end
+
+    def connect_agent
+      begin
+        agent = Agent.connect
+      rescue AgentNotAvailable
+        raise SSHAgentError.new 'Please run the `eval $(ssh-agent)` first.'
+      end
+
+      agent
+    end
+
+    def confirm_identity agent
+      if agent.identities.length == 0
+        raise SSHIdentityError.new 'Please run the `ssh-add` first.'
+      end
+
+      true
+    end
+
+  end
+end
+
+Capistrano.plugin :demand_forward_agent, Capistrano::DemandForwardAgent
+

data/lib/capistrano/demand_forward_agent/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module DemandForwardAgent
+    VERSION = "0.0.1"
+  end
+end

data/spec/capistrano/demand_forward_agent_spec.rb

@@ -0,0 +1,123 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+require 'capistrano'
+require 'capistrano/ssh'
+
+describe Capistrano::DemandForwardAgent do
+
+  before :all do
+    class Container
+      include Capistrano::DemandForwardAgent
+      attr_accessor :ssh_options
+
+      def initialize
+        @ssh_options = {}
+      end
+    end
+
+    @container = Container.new
+  end
+
+  before do
+    Net::SSH::Authentication::Agent.stub(:connect) do
+      Net::SSH::Authentication::Agent.new
+    end
+
+    Net::SSH::Authentication::Agent.any_instance.stub(:identities) do
+      [1]
+    end
+  end
+
+  describe 'version number' do
+    it do
+      Capistrano::DemandForwardAgent::VERSION.should_not be_nil
+    end
+  end
+
+  describe '#confirm' do
+    it do
+      @container.should_receive(:set_ssh_option).once
+      @container.should_receive(:connect_agent).once
+      @container.should_receive(:confirm_identity).once
+      @container.confirm
+    end
+  end
+
+  describe '#set_ssh_option' do
+    context 'ssh_options[:forward_agent] = true' do
+      before do
+        @container.ssh_options[:forward_agent] = true
+      end
+
+      it do
+        expect(@container.set_ssh_option).to be_true
+      end
+    end
+
+    context 'ssh_options[:forward_agent] = false' do
+      before do
+        @container.ssh_options[:forward_agent] = false
+      end
+
+      it do
+        expect(@container.set_ssh_option).to be_true
+      end
+    end
+
+    context 'unset ssh_options[:forward_agent]' do
+      it do
+        expect(@container.set_ssh_option).to be_true
+      end
+    end
+  end
+
+  describe '#connect_agent' do
+    context 'when ssh-agent running' do
+      it do
+        expect(@container.connect_agent).to be_instance_of Net::SSH::Authentication::Agent
+      end
+    end
+
+    context 'when ssh-agent is stopped' do
+      before do
+        Net::SSH::Authentication::Agent.stub(:connect) do
+          raise Net::SSH::Authentication::AgentNotAvailable
+        end
+      end
+
+      it do
+        expect do
+          @container.connect_agent
+        end.to raise_error Capistrano::DemandForwardAgent::SSHAgentError
+      end
+    end
+  end
+
+  describe '#confirm_identity' do
+    context 'when there is one identify' do
+      before do
+        @agent = @container.connect_agent
+        Net::SSH::Authentication::Agent.any_instance.stub(:identities) do
+          [1]
+        end
+      end
+
+      it do
+        expect(@container.confirm_identity(@agent)).to be_true
+      end
+    end
+
+    context 'when there is no identify' do
+      before do
+        @agent = @container.connect_agent
+        Net::SSH::Authentication::Agent.any_instance.stub(:identities) do
+          []
+        end
+      end
+
+      it do
+        expect {@container.confirm_identity(@agent)}.to raise_error Capistrano::DemandForwardAgent::SSHIdentityError
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'capistrano/demand_forward_agent'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-demand_forward_agent
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takeru Naito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Demand SSH forward agent on capistrano.
+email:
+- takeru.naito@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-demand_forward_agent.gemspec
+- lib/capistrano/demand_forward_agent.rb
+- lib/capistrano/demand_forward_agent/version.rb
+- spec/capistrano/demand_forward_agent_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/elim/capistrano-demand_forward_agent
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Demand SSH forward agent on capistrano.
+test_files:
+- spec/capistrano/demand_forward_agent_spec.rb
+- spec/spec_helper.rb