sshster 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1fad7d301df4b6de92f730ae4b825594ba55c05d48cffcf8a769cc80b7f1dd0
+  data.tar.gz: 4cc12eda71b55f249740e1fcc9565bfd7267652f08ee5e5410d06161754e9063
+SHA512:
+  metadata.gz: 781b5853fa368b6b9df34ddd956fde3cf4d264384095e624215267c86d240ba3f0213a15582299bc6c2b1b30494b2c5ece812ead2b77d3cf704135669d0d5681
+  data.tar.gz: 34fa3ff5e3989befd4881e37fb941bc250b33913740a9d609eb65ea78fe1d75c13a71219e4e7f6973c2d72700dfbe438d258fdc2df058b695009dbfc1e496589

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+public/uploads

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+Metrics/LineLength:
+  Max: 120 
+Metrics/BlockLength:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vanyazin@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sshster.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    sshster (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    coolline (0.5.0)
+      unicode_utils (~> 1.4)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.2)
+    method_source (0.9.2)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-coolline (0.2.5)
+      coolline (~> 0.5)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.5.0)
+    unicode_utils (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pry
+  pry-coolline
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  sshster!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ivan Zinovyev
+
+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,43 @@
+# Sshster
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sshster`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sshster'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sshster
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/sshster. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sshster project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sshster/blob/master/CODE_OF_CONDUCT.md).

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/sshster

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# vim: set syntax=ruby
+
+require 'sshster'
+
+Sshster.run(ARGV)

data/lib/sshster/actions/base.rb

@@ -0,0 +1,38 @@
+require 'pathname'
+require 'fileutils'
+
+module Sshster
+  module Actions
+    class Base
+      attr_accessor :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def run; end
+
+      private
+
+      def config_path
+        @config_path ||= root_path.join('config')
+      end
+
+      def origin_config_path
+        @origin_config_path ||= root_path.join('config.orig')
+      end
+
+      def projects_path
+        @projects_path ||= root_path.join('sshster')
+      end
+
+      def sshster_config_path
+        @sshster_config_path ||= root_path.join('sshster.yml')
+      end
+
+      def root_path
+        @root_path ||= Pathname.new(config['ssh_config'])
+      end
+    end
+  end
+end

data/lib/sshster/actions/compose.rb

@@ -0,0 +1,87 @@
+module Sshster
+  module Actions
+    class Compose < Base
+      def run
+        @host_names = []
+        @projects = []
+        compile_projects
+        File.write(config_path, File.read(origin_config_path))
+        open(config_path, 'a') do |f|
+          f << "\n\n # === GENERATED === # \n\n"
+          @projects.map do |project|
+            compile_project(project, f)
+            f << "\n\n"
+          end
+        end
+      end
+
+      private
+
+      def compile_project(project, f)
+        options = project[:options]
+        screen_session = options['screen_session']
+        f << "Host #{project[:name]}\n"
+        f << "  ForwardAgent yes\n" if options['forward_agent']
+        f << "  HostName #{project[:hostname]}\n"
+        f << "  User #{options['user']}\n"
+        f << "  RequestTTY yes\n" if options['request_tty']
+        f << "  RemoteCommand ssh-agent ; ssh-add ; screen -SRR #{screen_session} &>/dev/null || bash --login\n" if screen_session
+      end
+
+      def parse_projects_data(projects_data, groups = [])
+        if projects_data.is_a?(Hash)
+          projects_data.each do |group, project|
+            new_groups = groups.dup
+            parse_projects_data(project, new_groups << group)
+          end
+        elsif projects_data.is_a?(Array)
+          projects_data.map do |project|
+            name = project.find { |_k, v| v.nil? }&.first
+            options = project.select { |k, v| !v.nil? }.to_h
+            @projects << prepare_project(name, groups, options)
+          end
+        end
+      end
+
+      def prepare_project(name, groups, options)
+        { name: build_project_name(name, groups),
+          hostname: name,
+          options: build_project_options(options) }
+      end
+
+      def build_project_options(options)
+        config.merge(options)
+      end
+
+      def build_project_name(name, groups)
+        return name if groups.empty?
+        name = groups.join('.')
+        names_count = @host_names.select { |host| host == name }.count + 1
+        @host_names << name
+        "#{name}#{names_count}"
+      end
+
+      def compile_projects(groups = [])
+        projects do |projects_data|
+          parse_projects_data(projects_data, groups = [])
+        end
+      end
+
+      def projects
+        projects_paths.each do |project_path|
+          data = parse_project(project_path)
+          hosts = data['hosts']
+          yield(hosts) if hosts
+        end
+      end
+
+      def parse_project(file_path)
+        YAML.safe_load(File.read(file_path))
+      end
+
+      def projects_paths
+        Dir[projects_path.join('*.yml')]
+      end
+    end
+  end
+end

data/lib/sshster/actions/help.rb

@@ -0,0 +1,19 @@
+# rubocop:disable all 
+module Sshster
+  module Actions
+    class Help
+      def run
+        puts <<~HELP
+          sshster [-h] [-c] <command>
+
+          Commands:
+
+          init    Initialize sshster configuration files inside of yours ~/.ssh dir
+          compose Compile your projects to ~/.ssh/config file
+          help    Show this help
+        HELP
+      end
+    end
+  end
+end
+# rubocop:enable all

data/lib/sshster/actions/init.rb

@@ -0,0 +1,42 @@
+module Sshster
+  module Actions
+    class Init < Base
+      def run
+        create_root_dir
+        backup_config
+        create_sshster_yml
+        create_projects_dir
+      end
+
+      private
+
+      def create_root_dir
+        return if root_path.exist?
+
+        FileUtils.mkdir_p(root_path)
+      end
+
+      def create_projects_dir
+        return if projects_path.exist?
+
+        FileUtils.mkdir(projects_path)
+      end
+
+      def create_sshster_yml
+        return if sshster_config_path.exist?
+
+        FileUtils.touch(sshster_config_path)
+      end
+
+      def backup_config
+        return if origin_config_path.exist?
+
+        if config_path.exist?
+          FileUtils.mv(config_path, origin_config_path)
+        else
+          FileUtils.touch(origin_config_path)
+        end
+      end
+    end
+  end
+end

data/lib/sshster/app.rb

@@ -0,0 +1,46 @@
+require File.expand_path('actions/base', __dir__)
+require File.expand_path('actions/init', __dir__)
+require File.expand_path('actions/compose', __dir__)
+require File.expand_path('actions/help', __dir__)
+
+module Sshster
+  class App
+    attr_accessor :options
+
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      case command
+      when :init then action_init
+      when :compose then action_compose
+      when :help then action_help
+      else action_help
+      end
+    end
+
+    def action_init
+      Actions::Init.new(config).run
+    end
+
+    def action_compose
+      action_init
+      Actions::Compose.new(config).run
+    end
+
+    def action_help
+      Actions::Help.new.run
+    end
+
+    private
+
+    def config
+      @config ||= Config.new(options.config).merge
+    end
+
+    def command
+      @command ||= @options.command
+    end
+  end
+end

data/lib/sshster/argv_parser.rb

@@ -0,0 +1,36 @@
+module Sshster
+  class ArgvParser
+    attr_reader :config, :command, :help
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def parse
+      options = parse_argv(@argv)
+      @config = options['-c']
+      @help = options['-h']
+      @command = detect_command(options)
+      self
+    end
+
+    def valid?
+      !@command.nil? && valid_commands.include?(@command)
+    end
+
+    private
+
+    def valid_commands
+      %i[init compose help]
+    end
+
+    def detect_command(options)
+      command = options.find { |_k, v| v.nil? }
+      command[0].to_sym if command
+    end
+
+    def parse_argv(argv)
+      Hash[argv.join(' ').scan(/(-?[^=\s]+)(?: ([^-]{1}[\S]+))?/)]
+    end
+  end
+end

data/lib/sshster/config.rb

@@ -0,0 +1,44 @@
+module Sshster
+  class Config
+    attr_accessor :options, :config_path
+
+    def initialize(config_path = nil)
+      @config_path = config_path || default_file_path
+      @options = default_options
+    end
+
+    def merge
+      merge_config(config_path)
+    end
+
+    private
+
+    def parse_config(config_path)
+      YAML.safe_load(File.read(config_path))
+    end
+
+    def merge_config(config_path)
+      return @options unless File.exist?(config_path)
+
+      @options.merge!(parse_config(config_path))
+    end
+
+    def default_options
+      {
+        'forward_agent' => true,
+        'user' => 'deploy',
+        'request_tty' => true,
+        'screen_session' => 'deploy',
+        'ssh_config' => default_ssh_config_path,
+      }
+    end
+
+    def default_file_path
+      ENV['HOME'] + '/.ssh/sshster.yml'
+    end
+
+    def default_ssh_config_path
+      ENV['HOME'] + '/.ssh'
+    end
+  end
+end

data/lib/sshster/version.rb

@@ -0,0 +1,3 @@
+module Sshster
+  VERSION = '0.1.0'.freeze
+end

data/lib/sshster.rb

@@ -0,0 +1,15 @@
+require 'yaml'
+require 'sshster/version'
+require 'sshster/argv_parser'
+require 'sshster/config'
+require 'sshster/app'
+
+module Sshster
+  extend self
+  class Error < StandardError; end
+
+  def run(argv)
+    options = ArgvParser.new(argv).parse
+    App.new(options).run
+  end
+end

data/sshster.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sshster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sshster'
+  spec.version       = Sshster::VERSION
+  spec.authors       = ['Ivan Zinovyev']
+  spec.email         = ['ivan@zinovyev.net']
+
+  spec.summary       = 'Manage your ssh connections with ease'
+  spec.description   = 'Ssh configuration manager'
+  spec.homepage      = 'https://github.com/zinovyev/sshster'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-coolline'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: sshster
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Zinovyev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-coolline
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Ssh configuration manager
+email:
+- ivan@zinovyev.net
+executables:
+- sshster
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sshster
+- lib/sshster.rb
+- lib/sshster/actions/base.rb
+- lib/sshster/actions/compose.rb
+- lib/sshster/actions/help.rb
+- lib/sshster/actions/init.rb
+- lib/sshster/app.rb
+- lib/sshster/argv_parser.rb
+- lib/sshster/config.rb
+- lib/sshster/version.rb
+- sshster.gemspec
+homepage: https://github.com/zinovyev/sshster
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Manage your ssh connections with ease
+test_files: []