envee 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f94f269e8d206155b0b450605a6d6c8583b691e
+  data.tar.gz: 7c00b33fbdabc979917bff9252082061953b4b66
+SHA512:
+  metadata.gz: 40bb0f11403e0a96e5ad0fcdbb3c7d528b849854c202ffa0d6402635e5dc69dbd833acaec456fa247b2f8a4c57146b33d896e51b3291df7a6a66cd1830b8731b
+  data.tar.gz: 283fb912b6021af77e8511d5cf5cc5ddd9261fc71d0e1e9564830c222d1d241dd94958dc187560a16934c95f0f15eb1bb313206268e46b4865e6849761d29faf

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Allen Madsen
+
+MIT License
+
+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,55 @@
+# Envee
+
+Provides casting wrappers around fetch for environment variables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'envee'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install envee
+
+## Usage
+
+``` ruby
+ENV['NUM'] = '1'
+ENV.int('NUM') #=> 1
+
+ENV['NAME'] = 'bob'
+ENV.str('NAME') #=> 'bob'
+
+ENV['TIME'] = '1970-01-01 00:00:00 UTC'
+ENV.time('TIME') #=> 1970-01-01 00:00:00 UTC
+
+ENV['ITIME'] = 0
+ENV.int_time('ITIME') #=> 1970-01-01 00:00:00 UTC
+
+ENV['START'] = 'false' # or no, off, 0. Everything else is true.
+ENV.bool(START) #=> falsey
+
+# Specify defaults like you do with fetch
+ENV.int('MISSING', '1') #=> 1, also casts default
+ENV.time('TIME2'){Time.at(0)} #=> 1970-01-01 00:00:00 UTC
+
+ENV['MISSING'] = 'CHANGEME'
+ENV.validate!(missing_value: 'CHANGEME') #=> Envee::MissingValuesError,
+                                         #   The following environment variables are not set, but should be:
+                                         #   MISSING
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/secondrotation/envee/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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/envee.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'envee/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "envee"
+  spec.version       = Envee::VERSION
+  spec.authors       = ["Allen Madsen"]
+  spec.email         = ["blatyo@gmail.com"]
+  spec.summary       = 'Provides casting wrappers around fetch for environment variables.'
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/envee.rb

@@ -0,0 +1,47 @@
+require 'envee/version'
+require 'time'
+
+module Envee
+  class MissingValuesError < StandardError
+    def initialize(missing_keys)
+      super(
+        "The following environment variables are not set, but should be:\n"\
+        "#{missing_keys.join("\n")}\n"
+      )
+    end
+  end
+
+  def int(*args, &block)
+    Integer(fetch(*args, &block))
+  end
+
+  def str(*args, &block)
+    String(fetch(*args, &block))
+  end
+
+  def bool(*args, &block)
+    value = fetch(*args, &block)
+
+    value && value !~ /^(0|no|false|off|)$/i
+  end
+
+  def time(*args, &block)
+    value = fetch(*args, &block)
+    return value if value.is_a?(Time)
+    Time.parse(value).utc
+  end
+
+  def int_time(*args, &block)
+    value = Integer(fetch(*args, &block))
+    return value if value.is_a?(Time)
+    Time.at(value).utc
+  end
+
+  def validate!(options)
+    missing = options[:missing_value]
+    missing_keys = select{|k, v| v.include?(missing)}.map(&:first)
+    raise MissingValuesError.new(missing_keys) unless missing_keys.empty?
+  end
+end
+
+ENV.extend(Envee)

data/lib/envee/version.rb

@@ -0,0 +1,3 @@
+module Envee
+  VERSION = "0.0.1"
+end

data/spec/envee_spec.rb

@@ -0,0 +1,198 @@
+require 'spec_helper'
+
+describe Envee do
+  it 'has a version number' do
+    expect(Envee::VERSION).not_to be nil
+  end
+
+  let(:env){{}.extend(described_class)}
+
+  describe '#int' do
+    context 'when requesting a value in env without default' do
+      it 'returns env value casted as integer' do
+        env['NUM'] = '1'
+        expect(env.int('NUM')).to eq(1)
+      end
+    end
+
+    context 'when requesting a value not in env with a default value' do
+      it 'returns the default value casted as integer' do
+        expect(env.int('NUM', '2')).to eq(2)
+      end
+    end
+
+    context 'when requesting a value not in env with a default block' do
+      it 'returns the default block value casted as integer' do
+        expect(env.int('NUM'){'2'}).to eq(2)
+      end
+    end
+
+    context 'when requesting a value not in env with no default' do
+      it 'raises an KeyError' do
+        expect{env.int('NUM')}.to raise_error(KeyError)
+      end
+    end
+
+    context 'when requesting a value in env that cannot be casted to integer' do
+      it 'raises an ArgumentError' do
+        env['NUM'] = 'a'
+        expect{env.int('NUM')}.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#str' do
+    context 'when requesting a value in env without default' do
+      it 'returns env value casted as string' do
+        env['NUM'] = '1'
+        expect(env.str('NUM')).to eq('1')
+      end
+    end
+
+    context 'when requesting a value not in env with a default value' do
+      it 'returns the default value casted as string' do
+        expect(env.str('NUM', 2)).to eq('2')
+      end
+    end
+
+    context 'when requesting a value not in env with a default block' do
+      it 'returns the default block value casted as string' do
+        expect(env.str('NUM'){2}).to eq('2')
+      end
+    end
+
+    context 'when requesting a value not in env with no default' do
+      it 'raises an KeyError' do
+        expect{env.str('NUM')}.to raise_error(KeyError)
+      end
+    end
+  end
+
+  describe '#bool' do
+    context 'when requesting a value in env without default' do
+      it 'returns env value casted as truthy' do
+        env['START'] = 'true'
+        expect(env.bool('START')).to be_truthy
+      end
+    end
+
+    context 'when requesting a value not in env with a default value' do
+      it 'returns the default value casted as truthy' do
+        expect(env.bool('START', '2')).to be_truthy
+      end
+    end
+
+    context 'when requesting a value not in env with a default block' do
+      it 'returns the default block value casted as integer' do
+        expect(env.bool('START'){'2'}).to be_truthy
+      end
+    end
+
+    %w(0 false no off).each do |false_value|
+      context "when the env value is #{false_value}" do
+        it 'returns a false value' do
+          env['START'] = false_value
+          expect(env.bool('START')).to be_falsy
+        end
+      end
+    end
+
+    context 'when requesting a value not in env with no default' do
+      it 'raises an KeyError' do
+        expect{env.bool('START')}.to raise_error(KeyError)
+      end
+    end
+  end
+
+  describe '#time' do
+    context 'when requesting a value in env without default' do
+      it 'returns env value casted as time' do
+        env['TIME'] = '1970-01-01 00:00:00 UTC'
+        expect(env.time('TIME')).to eq(Time.at(0))
+      end
+    end
+
+    context 'when requesting a value not in env with a default value' do
+      it 'returns the default value casted as time' do
+        expect(env.time('TIME', '1970-01-01 00:00:01 UTC')).to eq(Time.at(1))
+      end
+    end
+
+    context 'when requesting a value not in env with a default block' do
+      it 'returns the default block value casted as time' do
+        expect(env.time('TIME'){'1970-01-01 00:00:01 UTC'}).to eq(Time.at(1))
+      end
+    end
+
+    context 'when requesting a value not in env with a default block and default already is a time' do
+      it 'returns the default block value casted as time' do
+        expect(env.time('TIME'){Time.at(1)}).to eq(Time.at(1))
+      end
+    end
+
+    context 'when requesting a value not in env with no default' do
+      it 'raises an KeyError' do
+        expect{env.time('TIME')}.to raise_error(KeyError)
+      end
+    end
+
+    context 'when requesting a value in env that cannot be casted to time' do
+      it 'raises an ArgumentError' do
+        env['TIME'] = 'a'
+        expect{env.time('TIME')}.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#int_time' do
+    context 'when requesting a value in env without default' do
+      it 'returns env value casted as time' do
+        env['TIME'] = '0'
+        expect(env.int_time('TIME')).to eq(Time.at(0))
+      end
+    end
+
+    context 'when requesting a value not in env with a default value' do
+      it 'returns the default value casted as time' do
+        expect(env.int_time('TIME', '1')).to eq(Time.at(1))
+      end
+    end
+
+    context 'when requesting a value not in env with a default block' do
+      it 'returns the default block value casted as time' do
+        expect(env.int_time('TIME'){'1'}).to eq(Time.at(1))
+      end
+    end
+
+    context 'when requesting a value not in env with no default' do
+      it 'raises an KeyError' do
+        expect{env.int_time('TIME')}.to raise_error(KeyError)
+      end
+    end
+
+    context 'when requesting a value in env that cannot be casted to time' do
+      it 'raises an ArgumentError' do
+        env['TIME'] = 'a'
+        expect{env.int_time('TIME')}.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#validate!' do
+    context 'when no missing values are found' do
+      it 'does not raise an error' do
+        expect{env.validate!(missing_value: 'CHANGEME')}.to_not raise_error
+      end
+    end
+
+    context 'when there are missing values' do
+      it 'raises an error with all the missing values keys' do
+        env['A'] = env['B'] = 'CHANGEME'
+        expect{env.validate!(missing_value: 'CHANGEME')}.to raise_error(
+          Envee::MissingValuesError,
+          "The following environment variables are not set, but should be:\nB\nA\n"
+        )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'envee'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: envee
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Allen Madsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-18 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+description: 
+email:
+- blatyo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- envee.gemspec
+- lib/envee.rb
+- lib/envee/version.rb
+- spec/envee_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.3
+signing_key: 
+specification_version: 4
+summary: Provides casting wrappers around fetch for environment variables.
+test_files:
+- spec/envee_spec.rb
+- spec/spec_helper.rb