dotgpg-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19a1436ce7a20848dfed96f810d4dcb7e1e3b1e5
+  data.tar.gz: 541f0b28f7bb869d83aeb6ff05865bc2c8e9a82f
+SHA512:
+  metadata.gz: b3ca145f0f8963d25a916a9cab1742808ad37ff77319c6a6661de3844b9f854eff124c0e47af6f4aae5e0b488cea8da0a097f343416eae1444d3c5ffed99d75b
+  data.tar.gz: ec9b2e0a40fcac1b68cdea05278cbe8b0cdaafe676abb5dc8d411c0ca7000b630b523d895d287b2e14d355e557319f9a7e2e4684d69af2c45f5752a63fced1ca

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,64 @@
+# Dotgpg::Rails
+
+Shim to load environment variables directly into Rails from dotgpg encrypted files.
+
+
+## Installation
+
+### Rails
+
+Add this line to the top of your application's Gemfile
+
+```ruby
+gem 'dotgpg-rails', :groups => [:development, :test]
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dotgpg-rails
+
+You should also refer to the dotenv Notes on load order section.
+
+
+## Usage
+
+This code is almost 100% copied from dotgpg/rails, refer to the [dotenv readme](https://github.com/bkeepers/dotenv/blob/master/README.md), for more info since almost all of that document applies to this gem as well.
+
+#### Note on load order
+
+dotgpg is initialized in your Rails app during the `before_configuration` callback, which is fired when the `Application` constant is defined in `config/application.rb` with `class Application < Rails::Application`. If you need it to be initialized sooner, you can manually call `Dotgpg::Railtie.load`.
+
+```ruby
+# config/application.rb
+Bundler.require(*Rails.groups)
+
+Dotgpg::Railtie.load
+
+HOSTNAME = ENV['HOSTNAME']
+```
+
+If you use gems that require environment variables to be set before they are loaded, then list `dotenv-rails` in the `Gemfile` before those other gems and require `dotgpg/rails-now`.
+
+```ruby
+gem 'dotgpg-rails', :require => 'dotgpg/rails-now'
+gem 'gem-that-requires-env-variables'
+```
+
+
+## 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.
+
+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/[my-github-username]/dotgpg-rails/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w(--color)
+  t.verbose = false
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotgpg/rails"
+
+# 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/dotgpg-rails.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dotgpg/rails/version'
+require "English"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dotgpg-rails"
+  spec.version       = Dotgpg::Rails::VERSION
+  spec.authors       = ["Jonathan Schatz"]
+  spec.email         = ["jon@divisionbyzero.com"]
+  spec.description   = spec.summary = "Autoload environment variables from dotgpg-encrypted files into Rails."
+  spec.homepage      = "https://github.com/vouch/dotgpg-rails"
+  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_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "spring"
+  spec.add_development_dependency "railties", "~>4.0"
+
+  spec.add_dependency "dotgpg"
+  spec.add_dependency "dotgpg-environment", "~> 0.1.1"
+  spec.add_dependency "dotenv", "~> 2.0.1"
+end

data/lib/dotgpg-rails.rb

@@ -0,0 +1 @@
+require 'dotgpg/rails'

data/lib/dotgpg/rails-now.rb

@@ -0,0 +1,10 @@
+# If you use gems that require environment variables to be set before they are
+# loaded, then list `dotgpg-rails` in the `Gemfile` before those other gems and
+# require `dotgpg/rails-now`.
+#
+#     gem "dotgpg-rails", :require => "dotgpg/rails-now"
+#     gem "gem-that-requires-env-variables"
+#
+
+require "dotgpg/rails"
+Dotgpg::Railtie.load

data/lib/dotgpg/rails.rb

@@ -0,0 +1,125 @@
+require "dotgpg/rails/version"
+require "dotgpg"
+require "dotgpg/environment"
+
+class Dotgpg
+
+  module Rails
+    class << self
+      attr_accessor :instrumenter
+    end
+
+    module_function
+
+    def load(*filenames)
+      with(*filenames) do |f|
+        ignoring_nonexistent_files do
+          env = Environment.new(f)
+          instrument("dotgpg.load", :env => env) { env.apply }
+        end
+      end
+    end
+
+    # same as `load`, but raises Errno::ENOENT if any files don't exist
+    def load!(*filenames)
+      with(*filenames) do |f|
+        env = Environment.new(f)
+        instrument("dotgpg.load", :env => env) { env.apply }
+      end
+    end
+
+    # same as `load`, but will override existing values in `ENV`
+    def overload(*filenames)
+      with(*filenames) do |f|
+        ignoring_nonexistent_files do
+          env = Environment.new(f)
+          instrument("dotgpg.overload", :env => env) { env.apply! }
+        end
+      end
+    end
+
+
+    # Internal: Helper to expand list of filenames.
+    #
+    # Returns a hash of all the loaded environment variables.
+    def with(*filenames, &block)
+      filenames << ".env" if filenames.empty?
+
+      filenames.reduce({}) do |hash, filename|
+        hash.merge! block.call(File.expand_path(filename)) || {}
+      end
+    end
+
+    def instrument(name, payload = {}, &block)
+      if instrumenter
+        instrumenter.instrument(name, payload, &block)
+      else
+        block.call
+      end
+    end
+
+    def ignoring_nonexistent_files
+      yield
+    rescue Errno::ENOENT
+    end
+
+  end
+
+  class Railtie < ::Rails::Railtie
+    config.before_configuration { load }
+
+    rake_tasks do
+      Rake.load_rakefile File.expand_path('../rails/tasks/dotgpg_rails.rake', __FILE__).to_s
+    end
+
+    # Public: Load dotgpg
+    #
+    # This will get called during the `before_configuration` callback, but you
+    # can manually call `Dotgpg::Railtie.load` if you needed it sooner.
+    def load
+      file = root.join 'config/dotgpg', "#{::Rails.env}.gpg"
+      if File.exists? file
+        Dotgpg::Rails.load file
+      else
+        # if our file doesn't exist don't bother trying to load. if we're not
+        # being called from our rake task print an error message to STDERR
+        unless File.basename($PROGRAM_NAME) == 'rake' && ARGV[0] == 'dotgpg:rails:init'
+          $stderr.puts "Couldn't initialize dotgpg file #{file}: " <<
+                       "(do you need to run 'rake dotgpg:rails:init' ?)"
+        end
+        # gracefully fail and return an empty string - maybe we want to make this
+        # fatal in the future?
+        ''
+      end
+    end
+
+    # Internal: `Rails.root` is nil in Rails 4.1 before the application is
+    # initialized, so this falls back to the `RAILS_ROOT` environment variable,
+    # or the current working directory.
+    def root
+      ::Rails.root || Pathname.new(ENV["RAILS_ROOT"] || Dir.pwd)
+    end
+
+    # Rails uses `#method_missing` to delegate all class methods to the
+    # instance, which means `Kernel#load` gets called here. We don't want that.
+    def self.load
+      instance.load
+    end
+
+  end
+end
+
+Dotgpg::Rails.instrumenter = ActiveSupport::Notifications
+
+# Watch all loaded env files with Spring
+begin
+  require "spring/watcher"
+  ActiveSupport::Notifications.subscribe(/^dotgpg/) do |*args|
+    event = ActiveSupport::Notifications::Event.new(*args)
+    Spring.watch event.payload[:env].filename if Rails.application
+  end
+rescue LoadError
+  # Spring is not available
+end
+
+

data/lib/dotgpg/rails/tasks/dotgpg_rails.rake

@@ -0,0 +1,57 @@
+namespace :dotgpg do
+  namespace :rails do
+    desc "initialize dotgpg_rails"
+    task :init do
+      require 'fileutils'
+      require 'dotgpg'
+
+      # create config/dotgpg if it doesn't already exist
+      dir = Rails.root.join 'config/dotgpg'
+      unless File.directory?(dir)
+        $stdout.puts "Creating #{dir}"
+        FileUtils.mkdir_p dir
+      end
+
+      # setup dotgpg directory if necessary
+      dotgpg_dir = Dotgpg::Dir.new(dir)
+      unless dotgpg_dir.dotgpg?
+        begin
+          $stdout.puts "Initializing dotgpg directory #{dir}"
+          Dir.chdir dir
+          Dotgpg.interactive = true
+          Dotgpg::Cli.start ['init']
+        ensure
+          # make sure thor didn't overwrite STDIN/STDOUT/STDERR
+          $stderr = STDERR
+          $stdin = STDIN
+          $stdout = STDOUT
+
+          # and change back to our RAILS_ROOT
+          Dir.chdir Rails.root
+        end
+      end
+
+      # get the list of rails environments that we require dotgpg-rails in and
+      # initialize a dotgpg file for each one. this depends on having the gem
+      # listed either in :default or in groups that match 1:1 environments we
+      # can find in config/environments. it's somewhat error-prone, i suppose we
+      # could also just create one for every environment?
+      definition = Bundler.definition
+      envs = Dir['./config/environments/*'].map{|f| File.basename f, '.*'}
+      if definition.specs_for([:default])['dotgpg-rails'].empty?
+        # we're not in the default group, check our gemfile for groups that match
+        # our environment names
+        envs.reject!{|e| definition.specs_for([e.to_sym])['dotgpg-rails'].empty? }
+      end
+
+      # for each of the environments that require dotgpg-rails initialize a blank
+      # dotgpg file in config/dotgpg/environment.gpg
+      envs.each do |env|
+        path = File.join dir, "#{env}.gpg"
+        next if File.exists? path
+        $stdout.puts "Initializing empty dotgpg file #{path}"
+        dotgpg_dir.encrypt path, "# placeholder dotgpg file for #{env} environment.\n"
+      end
+    end
+  end
+end

data/lib/dotgpg/rails/version.rb

@@ -0,0 +1,5 @@
+class Dotgpg
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: dotgpg-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Schatz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spring
+  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: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: dotgpg
+  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: dotgpg-environment
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Autoload environment variables from dotgpg-encrypted files into Rails.
+email:
+- jon@divisionbyzero.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dotgpg-rails.gemspec
+- lib/dotgpg-rails.rb
+- lib/dotgpg/rails-now.rb
+- lib/dotgpg/rails.rb
+- lib/dotgpg/rails/tasks/dotgpg_rails.rake
+- lib/dotgpg/rails/version.rb
+homepage: https://github.com/vouch/dotgpg-rails
+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: Autoload environment variables from dotgpg-encrypted files into Rails.
+test_files: []