capistrano-remote 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69c743c8ffb4138b3de1c8297293bd31628e3a1b
+  data.tar.gz: a2317e84a03ca8984627a2a3df700128fc81b5bc
+SHA512:
+  metadata.gz: b8cde54646d5be139e95afb2ebb0af03a374610037a6aa069ca25f8bd272ee79c6200457a5f34c49849e4ed30c7da72dadf752e273bde025f1e5d93300f2d743
+  data.tar.gz: da727ab1448924dc784a5569b34a98b93940c75199a39df515affc1bd3846d9cf9e648c8033b1678335e8ce15fecb153b53546252192f0f72cfdafa2528a0deb

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jakob Skjerning
+
+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,65 @@
+# Capistrano Remote
+
+Every so often you need to look at your production data or otherwise run some manual maintenance tasks in your production Rails application.
+
+Sure, you could SSH to the server, find the proper path, and remember the correct invocation for your rails console, but we already have an SSH automation tool; Capistrano.
+
+This gem adds tasks to Capistrano that lets you start a Rails console or dbconsole on your servers without manually SSH'ing:
+
+## Examples
+
+### Rails console
+
+    $ cap production remote:console
+    Loading production environment (Rails 4.2.4)
+    irb(main):001:0>
+
+### Rails database console
+
+    $ cap production remote:dbconsole
+    psql (9.3.5)
+    SSL connection (cipher: DHE-RSA-AES256-SHA, bits: 256)
+    Type "help" for help.
+    
+    example_production=>
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "capistrano-remote", :require => false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-remote
+
+
+## Usage
+
+Add to Capfile:
+
+    require "capistrano/remote"
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/substancelab/capistrano-remote. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capistrano/remote"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-remote.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/remote/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-remote"
+  spec.version       = Capistrano::Remote::VERSION
+  spec.authors       = ["Jakob Skjerning"]
+  spec.email         = ["jakob@mentalized.net"]
+
+  spec.summary = \
+    "Capistrano tasks to start a Rails console or dbconsole on your servers"
+  spec.description = <<-EOF
+    Every so often you need to look at your production data or otherwise run
+    some manual maintenance tasks in your production Rails application.
+
+    This gem adds tasks to Capistrano that lets you start a Rails console or
+    dbconsole on your servers without manually SSH'ing.
+  EOF
+
+  spec.homepage      = "https://github.com/substancelab/capistrano-remote"
+  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_dependency "capistrano", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/remote.rb

@@ -0,0 +1,5 @@
+require "capistrano/remote/runner"
+require "capistrano/remote/version"
+
+# Load the actual tasks
+load File.expand_path("../tasks/remote.rake", __FILE__)

data/lib/capistrano/remote/runner.rb

@@ -0,0 +1,35 @@
+module Capistrano
+  module Remote
+    class Runner
+      attr_reader :host
+
+      def initialize(host)
+        @host = host
+      end
+
+      def run_interactively(command)
+        remote_command = "cd #{current_path} && #{rails_command(command)}"
+        local_command = "ssh -l #{user} #{hostname} -t \"#{remote_command}\""
+        exec local_command
+      end
+
+      private
+
+      def bundle_command
+        fetch(:bundle_command, SSHKit.config.command_map[:bundle])
+      end
+
+      def hostname
+        host.hostname
+      end
+
+      def rails_command(command)
+        "#{bundle_command} exec rails #{command}"
+      end
+
+      def user
+        fetch(:user, host.user)
+      end
+    end
+  end
+end

data/lib/capistrano/remote/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Remote
+    VERSION = "0.1.0"
+  end
+end

data/lib/capistrano/tasks/remote.rake

@@ -0,0 +1,21 @@
+namespace :remote do
+  desc "Run and attach to a remote Rails console"
+  task :console do
+    rails_env = fetch(:rails_env)
+    on roles(:db) do |host|
+      Capistrano::Remote::Runner.new(host).run_interactively(
+        "console #{rails_env}"
+      )
+    end
+  end
+
+  desc "Run and attach to a remote Rails database console"
+  task :dbconsole do
+    rails_env = fetch(:rails_env)
+    on roles(:db) do |host|
+      Capistrano::Remote::Runner.new(host).run_interactively(
+        "dbconsole #{rails_env} -p"
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-remote
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jakob Skjerning
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: |2
+      Every so often you need to look at your production data or otherwise run
+      some manual maintenance tasks in your production Rails application.
+
+      This gem adds tasks to Capistrano that lets you start a Rails console or
+      dbconsole on your servers without manually SSH'ing.
+email:
+- jakob@mentalized.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-remote.gemspec
+- lib/capistrano/remote.rb
+- lib/capistrano/remote/runner.rb
+- lib/capistrano/remote/version.rb
+- lib/capistrano/tasks/remote.rake
+homepage: https://github.com/substancelab/capistrano-remote
+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.6
+signing_key: 
+specification_version: 4
+summary: Capistrano tasks to start a Rails console or dbconsole on your servers
+test_files: []