duffel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d8b5557e0783d46497128c02928f779cbf1f7ff
+  data.tar.gz: a9babc104a73f8fdde5148f9fba5654c18fd9bf3
+SHA512:
+  metadata.gz: a80a022e07991c7ca4d8b80f5786f4e1ac1f1c20f0f60878b64a40b1b1312033b8dcf9e9c3f560fc0dc92e50cb23d987722354d725cd0f54c9be2f851acd39a3
+  data.tar.gz: c37a98a23cc8fcb6106333bbc6d1fb24af74d206d986e2d637054300176352b4aa72e3ef62ac6f190d7ca10be37f720bc27c9d9580eb1d2d8e4709eebad9d088

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version
+.ruby-gemset

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - ruby-head

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric Roberts
+
+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,75 @@
+# Duffel
+
+Fetch your environment settings. Raise errors or set defaults when a setting does not exist.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'duffel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install duffel
+
+## Usage
+
+Duffel is a simple gem for reading things out of your environment.
+
+You have something in your environment named `SUPER_SECRET_PASSWORD`? No problem. To get it out, just do the following:
+
+    Duffel.super_secret_password
+
+Simple, right? But why add a layer of abstraction here? Well, there are a few reasons:
+
+Most people get their environment variables like so: `ENV['SUPER_SECRET_PASSWORD']`. This will return nil if the variable is not found. Duffel will return a KeyError, so you are told about missing things.
+
+### But I don't want it to raise an exception!
+
+That's fine too, you can specify a fallback for Duffel in case something isn't found. Example:
+
+    Duffel.super_secret_password(fallback: 'another-password')
+
+### What if I want to just return nil if it's not found?
+
+No problem, we can set our fallback to nil:
+
+    Duffel.super_secret_password(fallback: nil)
+
+### What about other settings I might have?
+
+I actually started writing this because I noticed was using a combination of `ENV['SOME_VARIABLE_NAME_HERE']` and `Settings.some_method_name`. I wanted to just use the `Settings.method_name` pattern everywhere, so I wrote Duffel.
+
+So while Duffel by default gets things out of your environment, you can use it as a general purpose settings drawer.
+
+Let's say you wanted to actually have a constant called Settings but still take advantage of Duffel. You could do something like this:
+
+    class Settings < Duffel
+      def self.some_other_awesome_setting
+        'awesome setting return value'
+      end
+    end
+
+Calling `Settings.env_variable_name` will still return you your environment variable, should it exist.
+
+### Duffel is a stupid name
+
+I know.  
+
+### Why did you do it this way and not this [obviously better way]
+
+Because I probably don't know the obviously better way. Feel free to submit a pull request or open an issue and I'll look into it!
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/duffel/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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/duffel.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'duffel'
+
+Gem::Specification.new do |spec|
+  spec.name          = "duffel"
+  spec.version       = Duffel::VERSION
+  spec.authors       = ["Eric Roberts"]
+  spec.email         = ["ericroberts@gmail.com"]
+  spec.summary       = "Fetch your environment settings."
+  spec.description   = "Fetch your environment settings. Raise errors or set defaults when a setting does not exist."
+  spec.homepage      = "https://github.com/ericroberts/duffel"
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/duffel.rb

@@ -0,0 +1,18 @@
+class Duffel
+  VERSION = "0.0.1"
+
+  def self.method_missing(method, *args, &block)
+    fetch_default = lambda do |key|
+      raise KeyError.new("key not found: #{key}")
+    end
+
+    define_singleton_method(method) do |options=(args.first || {})|
+      return_value = options.fetch(:fallback, fetch_default)
+      fallback = return_value.is_a?(Proc) ? return_value : lambda { |key| return_value }
+
+      env_name = method.to_s.upcase
+      ENV.fetch(env_name, &fallback)
+    end
+    self.send(method)
+  end
+end

data/spec/lib/duffel_spec.rb

@@ -0,0 +1,40 @@
+require 'duffel'
+
+describe Duffel do
+  it 'should not raise an error' do
+    expect { subject }.to_not raise_error
+  end
+
+  describe '.not_an_existing_method' do
+    context 'without a matching environment variable' do
+      it 'should raise an error if nothing exists in the environment' do
+        expect { subject.not_an_existing_method }.to raise_error(KeyError)
+      end
+
+      context 'with a fallback passed' do
+        it 'should return the fallback' do
+          expect(
+            subject.another_non_existing_method(:fallback => 'blah')
+          ).to eq 'blah'
+        end
+
+        context 'fallback is nil' do
+          it 'should return nil' do
+            expect(
+              subject.yet_another_non_existing_method(:fallback => nil)
+            ).to eq nil
+          end
+        end
+      end
+    end
+
+    context 'with a matching environment variable' do
+      before { expect(ENV).to receive(:fetch).with('AN_EXISTING_METHOD').and_return(response) }
+      let(:response) { 'response' }
+
+      it 'should return the env variable' do
+        expect(subject.an_existing_method).to eq response
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: duffel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Fetch your environment settings. Raise errors or set defaults when a
+  setting does not exist.
+email:
+- ericroberts@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- duffel.gemspec
+- lib/duffel.rb
+- spec/lib/duffel_spec.rb
+homepage: https://github.com/ericroberts/duffel
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Fetch your environment settings.
+test_files:
+- spec/lib/duffel_spec.rb