shellject 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42c5c16ef31d11d1568b3b56f5046272b8ec650f
+  data.tar.gz: 01560ee6b533f226a683b1211ec4edf3abaccab8
+SHA512:
+  metadata.gz: 5aa0308255c3dbdc2b9eb89f724c12a48d4c813f1b1ea0714ae01d9ad8ae69afd1c7e02e1937449190e3a06b78505f261893a1cb1ffaa7f71c3b1c0dac55f6df
+  data.tar.gz: de9e1de5191d93961f5fb64dc2fd308b81f82edf7d7266b86f4926e97fb78ff14497a726f9c94f65cf3d596e3c0696ba52d13e026b4e26aa59d080cd9d832bf3

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.0
+addons:
+    code_climate:
+      repo_token: 0c1e171a171c155a28b285b4f51de50259744fdc720521df22a18d028774881d

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, 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 shellject.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sergei Matheson
+
+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,58 @@
+# Shellject
+
+Store your secret environment variables (API keys, AWS secrets etc.) with GPGME, and inject them into your current shell when needed.
+
+[![Build Status](https://travis-ci.org/sergei-matheson/shellject.svg?branch=master)](https://travis-ci.org/sergei-matheson/shellject)
+[![Code Climate](https://codeclimate.com/github/sergei-matheson/shellject/badges/gpa.svg)](https://codeclimate.com/github/sergei-matheson/shellject)
+[![Test Coverage](https://codeclimate.com/github/sergei-matheson/shellject/badges/coverage.svg)](https://codeclimate.com/github/sergei-matheson/shellject)
+
+## Installation
+
+1. Install [GPGTools](https://gpgtools.org) on OSX and create a new key pair, if you don't have one already
+1. If you have more than 1 secret key in your keyring, you may want to ensure that the 'default-key' is specified in ~/.gnupg/gpg.conf
+1. Then install the gem:
+  ```ruby
+  # In your Gemfile
+  gem 'shellject'
+  ```
+
+  And then execute:
+
+    ```
+    $ bundle
+    ```
+
+  Or install it yourself as:
+
+    ```
+    $ gem install shellject
+    ```
+
+  *You may need to brew install gpgme on mac, or use your favourite package manager in linux*
+
+4. Finally, run
+
+    ```
+    $ shellject setup
+    ```
+  for instructions on how to set up the shell wrapper needed for injection, and, optionally, command-line completion.
+
+
+## Usage
+
+    $ shellject --help
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec shellject` to use the code located in this directory, ignoring other installed copies of this gem.
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/sergei-matheson/shellject/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Test your changes (`bundle exec rake`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,29 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'reek/rake/task'
+require 'rubocop/rake_task'
+
+Reek::Rake::Task.new do |task|
+  task.config_file = './config.reek'
+end
+
+begin
+  require 'cane/rake_task'
+
+  desc 'Run cane to check quality metrics'
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.abc_max = 10
+    cane.add_threshold 'coverage/.last_run.json', :>=, 100
+  end
+
+rescue LoadError
+  warn 'cane not available, quality task not provided.'
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+task default: [:spec, :quality, :reek, :rubocop]

data/bash/shellject_completion.sh

@@ -0,0 +1,33 @@
+_shellject()
+{
+  local cur prev opts base save_dir
+  COMPREPLY=()
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+
+  case "${prev}" in
+    shellject)
+      COMPREPLY=($(compgen -W "load save setup --help --version" -- ${cur}))
+      return 0
+      ;;
+    save)
+      #  Use default filename completion (when combined with -o default below)
+      COMPREPLY=()
+      return 0
+      ;;
+    load)
+      #
+      #  Shelljections we know about, removing save dir as a  prefix.
+      #
+      save_dir=${SHELLJECT_SAVE_DIR:- $(ls -d ~/.shellject/shelljections)}
+      # Escape save_dir for regex
+      local prefix=$(echo ${save_dir}/ | sed -e 's/[\/&]/\\&/g')
+      local shelljections=$(find ${save_dir} -type f| sed -e "s/${prefix}\(.*\)/\1/")
+      COMPREPLY=( $(compgen -W "${shelljections}" -- ${cur}) )
+      return 0
+      ;;
+  esac
+
+}
+complete -F _shellject -o default shellject
+

data/bash/shellject_wrapper.sh

@@ -0,0 +1,21 @@
+shellject ()
+{
+  local executable output shellject_exit eval_exit
+  executable=$( type -P shellject );
+  output=$( $executable $@ );
+  shellject_exit=$?;
+  if [[ $shellject_exit == 0 && "$1" == "load" && ! $@ =~ "--help" ]]; then
+    eval "$output";
+    eval_exit=$?
+    if [[ $eval_exit != 0 ]]; then
+      echo "Loading shelljection $2 FAILED";
+      return $eval_exit
+    fi;
+  else
+    if [[ $shellject_exit == 0 ]]; then
+      echo "$output";
+    else
+      return $shellject_exit;
+    fi;
+  fi
+}

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'shellject'
+
+# 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

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/config.reek

@@ -0,0 +1 @@
+---

data/exe/shellject

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require 'shellject'
+require 'clamp'
+
+Clamp do
+
+  option ['--save-dir', '-s'], 'DIRECTORY',
+    'The directory in which to store encrypted shelljections.',
+    environment_variable: 'SHELLJECT_SAVE_DIR',
+    default: '~/.shellject/shelljections',
+    attribute_name: 'save_dir_path'
+
+  option ['--version', '-v'], :flag, 'Show version' do
+    puts Shellject::VERSION
+    exit(0)
+  end
+
+  def save_directory
+    Shellject::SaveDirectory.new(File.expand_path save_dir_path)
+  end
+
+  def with_error_handling
+    yield
+  rescue Shellject::ShelljectError => ex
+    STDERR.puts "ERROR: #{ex.message}"
+    STDERR.puts help
+    exit(1)
+  end
+
+  subcommand 'save', 'Save the specified file as a shelljection' do
+    option ['--name', '-n'], 'NAME',
+      'What to name the shelljection. If not specified, the basename of the file will be used.'
+    parameter 'INPUT_FILE', 'File to save', :attribute_name => :input_file
+    def execute
+      with_error_handling do
+        Shellject::Tasks::Save.new(save_directory, input_file, name).call
+      end
+    end
+  end
+
+  subcommand 'load', 'Load the specified shelljection' do
+    parameter 'NAME',
+      'Name of the shelljection to load', :attribute_name => :name
+    def execute
+      with_error_handling do
+        Shellject::Tasks::Load.new(save_directory, name).call
+      end
+    end
+  end
+
+  subcommand 'setup', 'Setup wrapper and completion' do
+    def execute
+
+      bash_dir = Pathname.new File.expand_path('../bash', __dir__)
+      puts <<-eos
+# You'll need to source the bash wrapper in order for values to be injected
+# into your shell.
+# Add the following line to your ~/.bash_profile or ~/.bashrc
+
+source #{bash_dir.join 'shellject_wrapper.sh'}
+
+# To add command line completion, add the following line to your ~/.bash_profile or ~/.bashrc
+
+source #{bash_dir.join 'shellject_completion.sh'}
+
+      eos
+    end
+  end
+
+end

data/lib/shellject.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+require 'pathname'
+
+require 'gpgme'
+
+require 'shellject/version'
+require 'shellject/save_directory'
+require 'shellject/tasks/load'
+require 'shellject/tasks/save'
+
+# Main module
+module Shellject
+  # Standard shellject error
+  class ShelljectError < StandardError; end
+end

data/lib/shellject/save_directory.rb

@@ -0,0 +1,14 @@
+module Shellject
+  # Models the shelljections directory as a repository.
+  class SaveDirectory
+    attr_reader :path
+
+    def initialize(path)
+      @path ||= Pathname.new path
+    end
+
+    def path_for(name)
+      path.join name
+    end
+  end
+end

data/lib/shellject/tasks/load.rb

@@ -0,0 +1,39 @@
+module Shellject
+  module Tasks
+    # Loads, decrypts, and outputs a shelljection
+    class Load
+      attr_reader :save_directory, :name
+
+      def initialize(save_directory, name)
+        @save_directory = save_directory
+        @name = name
+      end
+
+      def call
+        ensure_readable
+        file = File.open path
+        STDOUT.print crypto.decrypt(file)
+      ensure
+        file.close if file
+      end
+
+      private
+
+      def ensure_readable
+        fail ShelljectError, "Could not read file #{path}" unless readable?
+      end
+
+      def readable?
+        path.readable?
+      end
+
+      def path
+        @path ||= save_directory.path_for name
+      end
+
+      def crypto
+        GPGME::Crypto.new always_trust: true
+      end
+    end
+  end
+end

data/lib/shellject/tasks/save.rb

@@ -0,0 +1,62 @@
+module Shellject
+  module Tasks
+    # Encrypts and saves a file as a shelljection.
+    class Save
+      attr_reader :save_directory, :input_path, :name
+
+      def initialize(save_directory, input_path, name = nil)
+        @save_directory = save_directory
+        @input_path = input_path
+        @name = name
+      end
+
+      def call
+        ensure_readable
+        ensure_writable
+        with_files do |from, to|
+          crypto.encrypt from, output: to
+        end
+      end
+
+      private
+
+      def with_files
+        from = File.open(input_path)
+        to = File.open(output_path, 'wb')
+        yield from, to
+      ensure
+        from.close if from
+        to.close if to
+      end
+
+      def ensure_writable
+        FileUtils.mkdir_p(output_path.parent)
+        fail ShelljectError, "Cannot save to #{output_path}" unless writable?
+      end
+
+      def writable?
+        output_path.parent.writable?
+      end
+
+      def ensure_readable
+        fail ShelljectError, "Cannot read file #{input_path}" unless readable?
+      end
+
+      def readable?
+        File.readable? input_path
+      end
+
+      def output_path
+        @output_path ||= save_directory.path_for name
+      end
+
+      def name
+        @name ||= File.basename(input_path)
+      end
+
+      def crypto
+        GPGME::Crypto.new always_trust: true
+      end
+    end
+  end
+end

data/lib/shellject/version.rb

@@ -0,0 +1,4 @@
+# Provides the gem version.
+module Shellject
+  VERSION = '0.1.0'
+end

data/shellject.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shellject/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shellject'
+  spec.version       = Shellject::VERSION
+  spec.authors       = ['Sergei Matheson']
+  spec.email         = ['sergei.matheson@gmail.com']
+
+  spec.summary       = 'Secure storage and injection of environment variables.'
+  spec.description   = 'Store your secret environment variables with GPGME, and inject them into your current shell when needed.'
+  spec.homepage      = 'https://github.com/sergei-matheson/shellject'
+  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.post_install_message = <<-eos
+Shellject:
+  You can get instructions on how to setup your installation with `shellject setup`.
+  eos
+
+  spec.add_dependency 'gpgme'
+  spec.add_dependency 'clamp'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'cane'
+
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: shellject
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergei Matheson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gpgme
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: reek
+  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: 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'
+- !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: simplecov
+  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: cane
+  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: codeclimate-test-reporter
+  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: Store your secret environment variables with GPGME, and inject them into
+  your current shell when needed.
+email:
+- sergei.matheson@gmail.com
+executables:
+- shellject
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bash/shellject_completion.sh
+- bash/shellject_wrapper.sh
+- bin/console
+- bin/setup
+- config.reek
+- exe/shellject
+- lib/shellject.rb
+- lib/shellject/save_directory.rb
+- lib/shellject/tasks/load.rb
+- lib/shellject/tasks/save.rb
+- lib/shellject/version.rb
+- shellject.gemspec
+homepage: https://github.com/sergei-matheson/shellject
+licenses:
+- MIT
+metadata: {}
+post_install_message: |
+  Shellject:
+    You can get instructions on how to setup your installation with `shellject setup`.
+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.5
+signing_key: 
+specification_version: 4
+summary: Secure storage and injection of environment variables.
+test_files: []