renv 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e26c29836717d549fdf77aeb14b7532b0dc36f8c
-  data.tar.gz: 0e2ec7d01003e5582aec6d90d2c1cce9ff508e19
+  metadata.gz: 2ce592555a68c352b441bafb892b77a01ff64d93
+  data.tar.gz: 424d50fc6061eea8ea4367930c74b503abb07fea
 SHA512:
-  metadata.gz: 7b68c0ecca614b4c6e088a78e17d9f3e3343ad00d7b52711cfa83143b97c15eb53161cb2dc6ab16d2fb67215d77f55daf42fe5844acfc5b90079ef134bdf6c7e
-  data.tar.gz: 9aa845d58d33b6700b4b1180e9d1e8e1b139a31a7b308d4afc1e186d1e989eb3bb6b0cf3c7514b2ea596c9edbb6c20be7160f3e34e58f324fd70b6eb163f4f92
+  metadata.gz: e4cf5e5ac2314ef0ebfeb797dc43e2d0c6853e30e63339751efd503751b4caeb93481f6226e5b95fa55dca7a3525bd5ff89452084854eb94b0d178ff9594e5d6
+  data.tar.gz: d49b2c4950e42f474dc63fa581d9431ab2ac7f0367cc51a30ae82bd64e57d586be30952afdb36f416aef16885935e6e84fc9f18342715905fc587335b54c637f

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+- 2.1.2
+script:
+- bundle exec rspec

data/Guardfile

@@ -0,0 +1,18 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+# vi: ft=ruby

data/README.md

@@ -7,6 +7,8 @@ The name stands for "Remote ENVironment" (thanks, captain obvious).
 It can be used to provide a replacement to Heroku's superb `config:get` /
 `config:set` in Capistrano-land.
 
+![Version](https://badge.fury.io/rb/renv.svg)
+![Build status](https://travis-ci.org/HouseTrip/renv.svg?branch=master)
 
 ## Installation
 

data/lib/renv/cli.rb

@@ -37,16 +37,21 @@ module Renv
     private
 
     def _engine
+      connection = Connection.new(
+        app:        options[:app],
+        bucket:     options[:bucket]
+      )
       Engine.new(
-        app:    options[:app],
-        name:   options[:name],
-        bucket: options[:bucket])
+        name:       options[:name],
+        connection: connection)
     end
 
+    # Transforms an array of KEY=VALUE pairs into a { KEY => VALUE } hash.
+    # The key is the part at the left of the first equals sign.
     def _parse_pairs(pairs)
       Hash.new.tap do |h|
         pairs.each do |p|
-          if p !~ /^([^=]+)=(.*)$/
+          if p !~ /^([^=]+)=(.*)$/ # left/right of the first equals sign
             $stderr.puts "Not a valid key-value: '#{p}'"
             exit 1
           end

data/lib/renv/connection.rb

@@ -0,0 +1,53 @@
+require 'fog'
+require 'delegate'
+require 'renv'
+
+module Renv
+  class Connection < SimpleDelegator
+
+    def initialize(app: nil, bucket: bucket)
+      @_app     = app
+      @_bucket  = bucket
+
+      connection = Fog::Storage.new(
+        provider:              'AWS',
+        aws_access_key_id:     ENV.fetch("RENV_AWS_KEY_#{_app}"),
+        aws_secret_access_key: ENV.fetch("RENV_AWS_SECRET_#{_app}"),
+        region:                ENV.fetch("RENV_AWS_REGION_#{_app}", 'eu-west-1')
+      )
+
+      if connection.nil?
+        $stderr.puts "Failed to connect to AWS, please check your key and secret."
+        exit 1
+      end
+
+      bucket = connection.directories.get(_bucket).tap do |b|
+        if b.nil?
+          $stderr.puts "Bucket '#{_bucket}' does not seem to exist"
+          exit 1
+        end
+      end
+
+      super bucket
+
+    rescue Excon::Errors::Forbidden
+      $stderr.puts "Credentials rejected by AWS, please check your settings."
+      exit 1
+    end
+
+    
+    def app_name ; _app ; end
+
+    private
+
+    def _app
+      @_app ||= ENV.fetch('RENV_APP')
+    end
+
+    def _bucket
+      @_bucket ||= ENV.fetch("RENV_BUCKET_#{_app}")
+    end
+
+  end
+end
+

data/lib/renv/data.rb

@@ -5,7 +5,7 @@ module Renv
   class Data
     extend Forwardable
 
-    def initialize(payload)
+    def initialize(payload = '')
       @data = _parse(payload)
     end
 
@@ -22,7 +22,8 @@ module Renv
     end
 
     def load(payload)
-      @data = _parse(payload).merge(@data)
+      @data = @data.merge(_parse(payload))
+      self
     end
 
     private

data/lib/renv/engine.rb

@@ -1,19 +1,22 @@
 require 'renv'
 require 'fog'
 require 'renv/data'
+require 'renv/connection'
 
 module Renv
   class Engine
-    def initialize(app: nil, name: nil, bucket: nil)
-      @_app    = app
-      @_name   = name
-      @_bucket = bucket
+    def initialize(connection:, name: nil, data: nil)
+      @_name       = name
+      @_connection = connection
+      @_data       = data || Data.new
+      @_loaded     = false
     end
 
     def get(key)
       _data[key]
     end
 
+    # Sets one or more key-value pairs
     def set(hash)
       hash.each_pair do |key, value|
         _data[key] = value
@@ -21,6 +24,7 @@ module Renv
       _save
     end
 
+    # Deletes one or more keys-value pairs
     def del(keys)
       keys.each { |key| _data.delete(key) }
       _save
@@ -38,16 +42,16 @@ module Renv
     private
 
     def _data
-      @_data ||= begin
-        s3file = _directory.files.get(_path_current)
-        payload = s3file ? s3file.body : ''
-        Data.new(payload)
-      end
+      return @_data if @_loaded
+      s3file = @_connection.files.get(_path_current)
+      payload = s3file ? s3file.body : ''
+      @_loaded = true
+      @_data.load(payload)
     end
 
     def _save
       [_path_new, _path_current].each do |path|
-        _directory.files.create(key: path, body: _data.dump, public: false)
+        @_connection.files.create(key: path, body: _data.dump, public: false)
       end
     end
 
@@ -55,38 +59,17 @@ module Renv
       @_path_current ||= "#{_name}/current"
     end
 
+    # "Backup" path, which is a timestamp in ISO format (2014-08-07T11:24:25)
     def _path_new
       @_path_new ||= "#{_name}/#{Time.now.strftime('%FT%T')}"
     end
 
-    def _directory
-      @_directory ||= _connection.directories.get(_bucket).tap do |dir|
-        if dir.nil?
-          $stderr.puts "Bucket '#{_bucket}' does not seem to exist"
-          exit 1
-        end
-      end
-    end
-    
-    def _connection
-      @_connection ||= Fog::Storage.new(
-        provider:              'AWS',
-        aws_access_key_id:     ENV.fetch("RENV_AWS_KEY_#{_app}"),
-        aws_secret_access_key: ENV.fetch("RENV_AWS_SECRET_#{_app}"),
-        region:                ENV.fetch("RENV_AWS_REGION_#{_app}", 'eu-west-1')
-      )
-    end
-
-    def _bucket
-      @_bucket ||= ENV.fetch("RENV_BUCKET_#{_app}")
-    end
-
     def _name
-      @_name ||= _app
+      @_name ||= @_connection.app_name
     end
 
     def _app
-      @_app ||= ENV.fetch('RENV_APP')
+      @_connection.app
     end
     
   end

data/lib/renv/version.rb

@@ -1,3 +1,3 @@
 module Renv
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/renv.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'timecop'
 
   spec.add_runtime_dependency 'fog'
   spec.add_runtime_dependency 'thor'

data/spec/renv/data_spec.rb

@@ -0,0 +1,91 @@
+require 'renv/data'
+
+describe Renv::Data do
+  let(:payload) { '' }
+  subject { described_class.new(payload) }
+
+  context 'with a simple payload' do
+    let(:payload) { "FOO=bar\nBAR=baz" }
+    
+    describe '#[]' do
+      it 'returns nil for unknown keys' do
+        expect(subject['DO_YOU_EVEN']).to be_nil
+      end
+
+      it 'returns key values' do
+        expect(subject['FOO']).to eq('bar')
+      end
+    end
+
+    describe '#[]=' do
+      it 'aborts on bad keys' do
+        expect { subject['hello, world!'] = 'foo' }.to raise_error(SystemExit)
+      end
+
+      it 'sets key values' do
+        subject['DO_YOU'] = 'even'
+        expect(subject['DO_YOU']).to eq('even')
+      end
+    end
+
+    describe '#dump' do
+      it 'serializes the hash' do
+        subject['BAZ'] = 'qux'
+        expect(subject.dump).to eq("FOO=bar\nBAR=baz\nBAZ=qux\n")
+      end
+    end
+
+    describe '#load' do
+      it 'adds extra keys' do
+        subject.load('QUX=even')
+        expect(subject['QUX']).to eq('even')
+      end
+
+      it 'does not remove existing keys' do
+        subject.load('QUX=even')
+        expect(subject['FOO']).to eq('bar')
+      end
+
+      it 'replaces same keys' do
+        subject.load('FOO=qux')
+        expect(subject['FOO']).to eq('qux')
+      end
+    end
+  end
+
+  describe '#initialize' do
+    it 'does not require a payload' do
+      expect { described_class.new }.not_to raise_error
+    end
+
+    it 'accepts comments' do
+      payload.replace "# comment1\nFOO=bar\n# comment 2"
+      expect(subject['FOO']).to eq('bar')
+    end
+
+    it 'accepts blank lines' do
+      payload.replace "\n\nFOO=bar\n\n\n# comment 2\n\n"
+      expect(subject['FOO']).to eq('bar')
+    end
+
+    it 'accepts multiple equal signs' do
+      payload.replace "FOO=bar=baz"
+      expect(subject['FOO']).to eq('bar=baz')
+    end
+
+    it 'accepts spaces in values' do
+      payload.replace "FOO=bar  baz"
+      expect(subject['FOO']).to eq('bar  baz')
+    end
+
+    it 'rejects misformatted pairs' do
+      payload.replace "FOO: bar baz"
+      expect { subject }.to raise_error(SystemExit)
+    end
+
+    it 'only loads the last of identical keys' do
+      payload.replace "FOO=bar\nFOO=qux"
+      expect(subject['FOO']).to eq('qux')
+    end
+  end
+end

data/spec/renv/engine_spec.rb

@@ -0,0 +1,141 @@
+require 'renv/engine'
+require 'timecop'
+require 'fog'
+
+describe Renv::Engine do
+  let(:tempdir)  { Pathname.new('tmp').join("%08x" % rand(1<<31)) }
+  let(:name)     { 'staging' }
+  let(:app_name) { 'testapp' }
+  let(:data)     { Renv::Data.new }
+
+  let(:connection) do
+    c = Fog::Storage.new(provider: 'Local', local_root: tempdir.to_s)
+    c.directories.create(key: 'testbucket')
+  end
+
+  let(:options) {{ name: name, connection: connection, data: data }}
+  
+  let(:default_data) { "KEY1=value1\nKEY2=value2" }
+
+  subject { described_class.new(**options) }
+
+  def data_for(entry, value = nil)
+    path = tempdir.join("testbucket/#{name}/#{entry}")
+    if value
+      path.parent.mkpath
+      path.write(value)
+    elsif path.exist?
+      path.read
+    else
+      nil
+    end
+  end
+
+  around do |example|
+    tempdir.mkpath
+    example.run
+    tempdir.rmtree
+  end
+  
+  before do
+    allow(connection).to receive(:app_name).and_return(app_name)
+    # TODO: proper separation would use the injected Data dependency
+    # and do the following instead of parsing files:
+    # allow(data).to receive(:dump).and_return('dump')
+  end
+
+  before do
+    data_for(:current, default_data) if default_data
+  end
+
+  shared_examples 'writer' do
+    it 'creates a backup' do
+      timestamp = '2014-07-30T01:23:45'
+      Timecop.freeze(timestamp) { perform }
+      expect(data_for(timestamp)).not_to be_nil
+    end
+  end
+
+  shared_examples 'preserving existing keypairs' do
+    it 'leaves existing keypairs intact' do
+      data_for(:current, "#{default_data}\nPRESERVED=value\n")
+      perform
+      expect(data_for(:current)).to match(/^PRESERVED=value$/)
+    end
+  end
+
+  shared_examples 'initial conditions' do
+    let(:default_data) { nil }
+    
+    it 'has no initial data' do
+      expect(data_for(:current)).to be_nil
+    end
+
+    it 'works with an empty bucket' do
+      expect { perform }.not_to raise_error
+    end
+  end
+
+  describe 'set' do
+    let(:perform) { subject.set('FOO' => 'bar', 'BAZ' => 'qux') }
+    it 'writes keys to file' do
+      perform
+      expect(data_for(:current)).to match(/^FOO=bar$/)
+      expect(data_for(:current)).to match(/^BAZ=qux$/)
+    end
+
+    it_behaves_like 'writer'
+    it_behaves_like 'preserving existing keypairs'
+    it_behaves_like 'initial conditions'
+  end
+
+  describe 'del' do
+    let(:perform) { subject.del(['KEY1']) }
+
+    it 'deletes key from store' do
+      perform
+      expect(data_for(:current)).not_to match(/^KEY1=/)
+    end
+
+    it_behaves_like 'writer'
+    it_behaves_like 'preserving existing keypairs'
+    it_behaves_like 'initial conditions'
+  end
+
+  describe 'load' do
+    let(:perform) { subject.load("FOO=bar\nBAZ=qux") }
+
+    it 'deletes key from store' do
+      perform
+      expect(data_for(:current)).to match(/^FOO=bar$/)
+      expect(data_for(:current)).to match(/^BAZ=qux$/)
+    end
+
+    it_behaves_like 'writer'
+    it_behaves_like 'preserving existing keypairs'
+    it_behaves_like 'initial conditions'
+  end
+
+  describe 'get' do
+    let(:perform) { subject.get('KEY1') }
+
+    it 'returns the value' do
+      expect(perform).to eq('value1')
+    end
+
+    it_behaves_like 'preserving existing keypairs'
+    it_behaves_like 'initial conditions'
+  end
+
+  describe 'dump' do
+    let(:perform) { subject.dump }
+
+    it 'returns the value' do
+      expect(perform).to match(/^KEY1=value1$/)
+      expect(perform).to match(/^KEY2=value2$/)
+    end
+
+    it_behaves_like 'preserving existing keypairs'
+    it_behaves_like 'initial conditions'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renv
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-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: timecop
+  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: fog
   requirement: !ruby/object:Gem::Requirement
@@ -89,17 +117,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/renv
 - lib/renv.rb
 - lib/renv/cli.rb
+- lib/renv/connection.rb
 - lib/renv/data.rb
 - lib/renv/engine.rb
 - lib/renv/version.rb
 - renv.gemspec
+- spec/renv/data_spec.rb
+- spec/renv/engine_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -124,4 +159,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Manages out-of-repository .env file
-test_files: []
+test_files:
+- spec/renv/data_spec.rb
+- spec/renv/engine_spec.rb
+- spec/spec_helper.rb