vinz-clortho 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e824892bb1bc45ec04ca1320b0cbebe7438cdc9f
+  data.tar.gz: b5337b8ee3585da400042b7cbb57c65479680e3a
+SHA512:
+  metadata.gz: 07751f3a4954589e3836f77e0bac528d4e2cd854683401770b9db6c288958b31ba24c6b1490eb6a0d1f70fb103f25bb2ac635188919ba859573af2baa16e4175
+  data.tar.gz: 595234d57b070c7007425f67cef93cd1a2eb2b6b14c02e2b6379e3f8c6ee206d51981804282812c9ff6bf9d04f46016df2de3ed6dbf8d740ea3abe82d3f69d03

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/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing
+
+* Fork the [project](https://github.com/pivotal/clortho)
+* Create a feature branch
+* Make sure any new code added to `lib/` has appropriate tests in `test/`
+* Rebase on master
+* Issue a [pull request](https://github.com/pivotal/clortho/pulls)
+
+Feel free to create new [issues](https://github.com/pivotal/clortho/issues). If you'd like to see what else is in our pipeline, look at our public [Tracker](https://www.pivotaltracker.com/n/projects/1437254).

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Pivotal Labs
+
+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,31 @@
+# Vinz Clortho
+
+<img src="http://i.giphy.com/Sf0xvEgdWyraU.gif" alt="Vinz Clortho" width="100%">
+
+Vinz Clortho is a Ruby-based tool for managing SSH authentication when dealing with git.
+
+## Requirements
+
+Vinz Clortho requires a `.git-authors` file to be present, similar in format to [git-duet](https://github.com/git-duet/git-duet) and [git-pair](https://github.com/pivotal/git_scripts). In addition to authors and email addresses, Vinz Clortho will look for a `sshkey_paths` entry where each pair of initials below points to the location of a private key (perhaps on a flash drive). For example:
+
+``` yaml
+sshkey_paths:
+  jd: /Volumes/jdoe/.ssh/id_rsa
+  fb: /Volumes/fbar/.ssh/id_rsa
+```
+See the [.git-authors](.git-authors) file in this repository as a full example.
+
+Vinz Clortho also requires the [Octokit](https://github.com/octokit/octokit.rb) rubygem for communicating with GitHub. You can install this via `gem install octokit`.
+
+## Usage
+Run `git ssh-login (committer-initials)` to add the SSH key corresponding to the committer's initials. The key expiry is set to 12:30 PM if executed before 12:30 PM, 6:00 PM if executed after that but before 6:00 PM, or within 15 minutes if executed after 6:00 PM.
+
+```
+Usage: git ssh-login [options] (committer-initials)
+
+    -h, --help                       Shows help
+    -v, --version                    Returns version
+        --add-to-github              Adds a public key to GitHub
+```
+
+You can also use `git push-authenticated [args]` to authenticate all existing keys for a period of 5 seconds and then push immediately. It takes the same arguments as `git push` (and just passes them on).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/exe/git-push-authenticated

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require 'vinz/clortho'
+
+begin
+  Vinz::Clortho::SSHSetup.new.login_all(5)
+  `git push #{ARGV.join ' '}`
+rescue => e
+  puts e.message
+  exit 1
+end

data/exe/git-ssh-login

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'io/console'
+require 'vinz/clortho'
+
+begin
+  ssh_setup = Vinz::Clortho::SSHSetup.new
+  initials = ARGV[0]
+
+  parser = OptionParser.new do |opts|
+    opts.banner = ssh_setup.usage_msg
+
+    opts.on('-h', '--help', 'Shows help') do |v|
+      puts parser
+      exit 0
+    end
+    opts.on('-v', '--version', 'Returns version') do |v|
+      puts Vinz::Clortho::VERSION
+      exit 0
+    end
+    opts.on('--add-to-github', 'Adds a public key to GitHub') do |v|
+      print "Enter your username: "
+      username = gets.chomp
+      print "Enter your password: "
+      password = STDIN.noecho(&:gets).chomp
+      puts # because previous line of code doesn't insert newline
+      uploader = Vinz::Clortho::GitHubKeyUploader.new(initials, username, password)
+      print "Enter title for key: "
+      title = gets.chomp
+      uploader.upload title
+      exit 0
+    end
+  end
+
+  parser.parse!
+  ssh_setup.login(initials)
+rescue OptionParser::InvalidOption => e
+  puts parser
+  exit 1
+rescue => e
+  puts e.message
+  puts parser
+  exit (e.is_a? Vinz::Clortho::UserNotFoundError) ? 2 : 1
+end
+
+puts "Key will expire at #{ssh_setup.key_expiry}"

data/exe/git-ssh-login-all

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'vinz/clortho'
+
+begin
+  Vinz::Clortho::SSHSetup.new.login_all
+rescue => e
+  puts e.message
+  exit 1
+end

data/exe/git-ssh-login-install-hook

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+path_to_post_commit_hook = File.join(`git rev-parse --show-toplevel`.chomp, '.git', 'hooks', 'post-commit')
+
+cmd = orig_cmd = "exec git-ssh-login-all"
+cmd = "#!/bin/sh\n#{cmd}" unless File.exist?(path_to_post_commit_hook)
+
+File.open(path_to_post_commit_hook, 'a+', 0755) do |file|
+  file.write cmd unless file.read.include? orig_cmd
+end

data/lib/vinz/clortho.rb

@@ -0,0 +1,4 @@
+require 'vinz/clortho/version'
+require 'vinz/clortho/git_authors_manager'
+require 'vinz/clortho/ssh_setup'
+require 'vinz/clortho/github_key_uploader'

data/lib/vinz/clortho/git_authors_manager.rb

@@ -0,0 +1,40 @@
+require 'yaml'
+
+module Vinz
+  module Clortho
+    class UserNotFoundError < StandardError
+    end
+
+    class GitAuthorsManager
+      def initialize
+        @git_authors = YAML::load_file(git_authors_file)
+      end
+
+      def all_key_paths
+        @git_authors['sshkey_paths']
+      end
+
+      def key_path_for(initials)
+        raise ArgumentError.new('Committer initials are required') unless initials
+        @git_authors['sshkey_paths'][initials] or raise UserNotFoundError.new(user_not_found_msg)
+      end
+
+      private
+
+      def git_authors_file(current_dir = Dir.pwd)
+        git_authors_location = File.join(current_dir, '.git-authors')
+        if File.exist?(git_authors_location)
+          git_authors_location
+        elsif current_dir == '/'
+          raise Errno::ENOENT.new
+        else
+          git_authors_file(File.expand_path('..', current_dir))
+        end
+      end
+
+      def user_not_found_msg
+        "ERROR: Unable to find committer initials in mapping (check the \"sshkey_paths\" mapping for your initials)."
+      end
+    end
+  end
+end

data/lib/vinz/clortho/github_key_uploader.rb

@@ -0,0 +1,23 @@
+require 'octokit'
+
+module Vinz
+  module Clortho
+    class GitHubKeyUploader
+      def initialize(initials, username, password)
+        @manager = GitAuthorsManager.new
+        @initials = initials
+        @username, @password = username, password
+      end
+
+      def upload(title)
+        key = File.open("#{@manager.key_path_for(@initials)}.pub", "r").read
+        client.add_key(title, key)
+      end
+
+      private
+      def client
+        @client ||= Octokit::Client.new(login: @username, password: @password)
+      end
+    end
+  end
+end

data/lib/vinz/clortho/ssh_setup.rb

@@ -0,0 +1,64 @@
+module Vinz
+  module Clortho
+    class SSHSetup
+      attr_reader :key_expiry
+
+      def initialize
+        @git_authors_mgr = GitAuthorsManager.new
+      end
+
+      def login(initials)
+        set_key_expiry
+        key_ttl = @key_expiry.to_i - Time.now.to_i
+        key_path = @git_authors_mgr.key_path_for initials
+        raise Errno::ENOENT.new unless File.exist? key_path
+        ssh_add(key_ttl, key_path)
+      end
+
+      def login_all(key_ttl = nil)
+        if key_ttl.nil?
+          set_key_expiry
+          key_ttl = @key_expiry.to_i - Time.now.to_i
+        end
+
+        @git_authors_mgr.all_key_paths.values.each do |path|
+          ssh_add(key_ttl, path) if File.exist?(path)
+        end
+      end
+
+      def ssh_add(key_ttl, key_path)
+        `ssh-add -t #{key_ttl} #{key_path}`
+      end
+
+      def usage_msg
+        committers_and_keypaths = @git_authors_mgr.all_key_paths.map do |committer_initials, keypath|
+          "\t#{committer_initials} : #{keypath}"
+        end
+        msg = <<-MSG
+Usage: git ssh-login [options] (committer-initials)
+
+known committers:
+#{committers_and_keypaths.join("\n")}
+
+If there is no mapping from your initials to your keypath, add it to .git-authors.
+        MSG
+      end
+
+      private
+      def set_key_expiry
+        now = Time.now
+        lunchtime = Time.new(now.year, now.month, now.day, 12, 30)
+        end_of_day = Time.new(now.year, now.month, now.day, 18, 0)
+        in_fifteen_minutes = now + (60 * 15)
+
+        @key_expiry = if now < lunchtime
+          lunchtime
+        elsif now < end_of_day
+          end_of_day
+        else
+          in_fifteen_minutes
+        end
+      end
+    end
+  end
+end

data/lib/vinz/clortho/version.rb

@@ -0,0 +1,5 @@
+module Vinz
+  module Clortho
+    VERSION = "0.1.1"
+  end
+end

data/vinz-clortho.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vinz/clortho/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vinz-clortho'
+  spec.version       = Vinz::Clortho::VERSION
+  spec.authors       = ['Liam Morley', 'Navya Canumalla']
+  spec.email         = %w(lmorley@pivotal.io ncanumalla@pivotal.io)
+
+  spec.summary       = %q{Git plugin for managing SSH authentication}
+  spec.homepage      = 'https://github.com/pivotal/clortho'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test/|\.)}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'octokit', '~> 4.1.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'minitest'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: vinz-clortho
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Liam Morley
+- Navya Canumalla
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: minitest
+  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: 
+email:
+- lmorley@pivotal.io
+- ncanumalla@pivotal.io
+executables:
+- git-push-authenticated
+- git-ssh-login
+- git-ssh-login-all
+- git-ssh-login-install-hook
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- exe/git-push-authenticated
+- exe/git-ssh-login
+- exe/git-ssh-login-all
+- exe/git-ssh-login-install-hook
+- lib/vinz/clortho.rb
+- lib/vinz/clortho/git_authors_manager.rb
+- lib/vinz/clortho/github_key_uploader.rb
+- lib/vinz/clortho/ssh_setup.rb
+- lib/vinz/clortho/version.rb
+- vinz-clortho.gemspec
+homepage: https://github.com/pivotal/clortho
+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.8
+signing_key: 
+specification_version: 4
+summary: Git plugin for managing SSH authentication
+test_files: []