foundry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9da30abaa99f3fd6c765f67591499dc5cca98f12
+  data.tar.gz: 6df1988b72d7e206e11253cd80e6d1eed20ac506
+SHA512:
+  metadata.gz: 4e427ccece01e33d3b1387246a92a73ff9c4d316ad5d77651fd1d67df0a95fbeddabd94bd2b152110f4d3f6e4aba8f2f374b2cb0c873bef1d7a975aadd1cd141
+  data.tar.gz: 1fab1178b3d77026e47e205a004ddb0c430172853e6b334c5b648cfeb642b3eef2b8f2a31a1a2480737f5041a74aaa377c6c2dca33dde602a4d7d743b59db310

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.ruby-gemset
+.ruby-version
+coverage
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tags
+tags.*
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-2
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - jruby-19mode
+  - rbx-2

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jonathan W. Zaleski
+
+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,52 @@
+# Foundry 
+
+[![Build Status](https://secure.travis-ci.org/jzaleski/foundry.png?branch=master)](http://travis-ci.org/jzaleski/foundry)
+[![Dependency Status](https://gemnasium.com/jzaleski/foundry.png)](https://gemnasium.com/jzaleski/foundry)
+
+An application configuration gem that aims to keep it simple
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'foundry'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install foundry
+
+## Usage
+
+Loading from a local-file:
+
+```ruby
+Foundry::Configurator.configure(:file_name => 'path-to-local-file')
+```
+
+Loading from a HTTP/HTTPS endpoint:
+
+```ruby
+Foundry::Configurator.configure(:uri => 'http-or-https-endpoint')
+```
+
+Loading from a HTTP/HTTPS endpoint using "Basic Authentication":
+
+```ruby
+Foundry::Configurator.configure(
+  :uri => 'http-or-https-endpoint',
+  :username => 'basic-auth-username',
+  :password => 'basic-auth-password'
+)
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/jzaleski/foundry/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 new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = %w[--format progress]
+end
+
+task :test => :spec
+
+task :default => :test

data/TODO

@@ -0,0 +1,2 @@
+* Consider using `Hashie` instead of `OpenStruct`
+* Add support for other source-file types (JSON? XML (::shiver::)?)

data/foundry.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'foundry/version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'foundry'
+  gem.version = Foundry::VERSION
+  gem.authors = ['Jonathan W. Zaleski']
+  gem.email = ['JonathanZaleski@gmail.com']
+  gem.summary = %{An application configuration gem that aims to keep it simple}
+  gem.description = <<-EOL
+  Let's face it, there are a number of problems when application/environment
+  configuration logic is too tightly coupled with the configuration-data itself.
+  This gem aims to keep it simple and fully decouple the two concerns.
+
+  Features:
+
+  * Can load YAML from a local-file
+  * Can load YAML from a HTTP/HTTPS endpoint
+  * Supports Basic Authentication for HTTP{,S} endpoints
+  * Supports ERB interpolation
+  * Returns an easy to navigate object-graph
+  EOL
+  gem.homepage = 'https://github.com/jzaleski/foundry'
+  gem.license = 'MIT'
+
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}) { |file| File.basename(file) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.6'
+  gem.add_development_dependency 'pry', '~> 0.10'
+  gem.add_development_dependency 'rake', '~> 10.3'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/foundry/configurator.rb

@@ -0,0 +1,52 @@
+module Foundry
+  class Configurator
+    class << self
+      def configure(opts={})
+        ostructify(
+          load_yaml(
+            evaluate_erb(
+              load_by_filename_or_uri(opts)
+            )
+          )
+        )
+      end
+
+      private
+
+      def evaluate_erb(str)
+        ERB.new(str).result
+      end
+
+      def load_by_filename_or_uri(opts)
+        if file_name = opts.delete(:file_name)
+          Foundry::Loaders::File.load(file_name, opts)
+        elsif uri = opts.delete(:uri)
+          Foundry::Loaders::Uri.load(uri, opts)
+        else
+          raise NotImplementedError
+        end
+      end
+
+      def load_yaml(str)
+        YAML.load(str)
+      end
+
+      def ostructify(object)
+        case object
+        when Array
+          object.map do |value|
+            ostructify(value)
+          end
+        when Hash
+          OpenStruct.new.tap do |ostruct|
+            object.each do |key, value|
+              ostruct.public_send("#{key}=", ostructify(value))
+            end
+          end
+        else
+          object
+        end
+      end
+    end
+  end
+end

data/lib/foundry/loaders/file.rb

@@ -0,0 +1,9 @@
+module Foundry
+  module Loaders
+    class File
+      def self.load(file_name, opts)
+        ::File.read(file_name)
+      end
+    end
+  end
+end

data/lib/foundry/loaders/uri.rb

@@ -0,0 +1,19 @@
+module Foundry
+  module Loaders
+    class Uri
+      def self.load(uri, opts)
+        parsed_uri = URI.parse(uri)
+        http = Net::HTTP.new(parsed_uri.host, parsed_uri.port)
+        if parsed_uri.scheme == 'https'
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        request = Net::HTTP::Get.new(parsed_uri.request_uri)
+        if username = opts.delete(:username) && password = opts.delete(:password)
+          request.basic_auth(username, password)
+        end
+        http.request(request).body
+      end
+    end
+  end
+end

data/lib/foundry/version.rb

@@ -0,0 +1,3 @@
+module Foundry
+  VERSION = '0.1.0'
+end

data/lib/foundry.rb

@@ -0,0 +1,11 @@
+require 'erb'
+require 'net/http'
+require 'openssl'
+require 'ostruct'
+require 'uri'
+require 'yaml'
+
+require 'foundry/configurator'
+require 'foundry/loaders/file'
+require 'foundry/loaders/uri'
+require 'foundry/version'

data/spec/configurator_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'foundry/configurator'
+
+describe Foundry::Configurator do
+  subject { Foundry::Configurator }
+
+  it 'must be passed either a "file_name" or "uri"' do
+    expect { subject.configure }.to raise_error
+  end
+
+  it 'will attempt to load from a file' do
+    expect(Foundry::Loaders::File).to receive(:load) { '' }
+    subject.configure(:file_name => '')
+  end
+
+  it 'will attempt to load from a uri' do
+    expect(Foundry::Loaders::Uri).to receive(:load) { '' }
+    subject.configure(:uri => '')
+  end
+
+  it 'will fail-fast if the YAML is invalid' do
+    expect(Foundry::Loaders::File).to receive(:load)
+    expect { subject.configure(:file_name => '') }.to raise_error
+  end
+
+  it 'will fail-fast if the ERB raises an error' do
+    expect(Foundry::Loaders::File).to receive(:load) { 'foo: <%= 1/0 %>' }
+    expect { subject.configure(:file_name => '') }.to raise_error
+  end
+
+  it 'can parse [nested] YAML/ERB' do
+    expect(Foundry::Loaders::File).to receive(:load) { <<-YAML
+      root:
+        erb: <%= 1 * 2 * 3 %>
+        float: 123.0
+        integer: 42
+        list:
+          - uno
+          - dos
+          - tres
+        string: hello world
+    YAML
+    }
+    expect(subject.configure(:file_name => '')).to eq(
+      OpenStruct.new(
+        'root' => OpenStruct.new(
+          'erb' => 6,
+          'float' => 123.0,
+          'integer' =>  42,
+          'list' => %w[uno dos tres],
+          'string' => 'hello world'
+        )
+      )
+    )
+  end
+end

data/spec/loaders/file_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'foundry/loaders/file'
+
+describe Foundry::Loaders::File do
+  subject { Foundry::Loaders::File }
+
+  it 'can load a file' do
+    expect(File).to receive(:read)
+    subject.load('', {})
+  end
+
+  it 'will raise an error if the file does not exist' do
+    expect { subject.load('', {}) }.to raise_error
+  end
+end

data/spec/loaders/uri_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'foundry/loaders/uri'
+
+describe Foundry::Loaders::Uri do
+  subject { Foundry::Loaders::Uri }
+  let(:request) { double }
+  let(:response_body) { 'response_body' }
+  let(:response) { double(:body => response_body) }
+  let(:http) { double(:request => response) }
+  let(:http_url) { 'http://foo.bar.com' }
+  let(:https_url) { http_url.gsub(/\Ahttp:/, 'https:') }
+
+  before do
+    expect(Net::HTTP).to receive(:new) { http }
+    expect(Net::HTTP::Get).to receive(:new) { request }
+  end
+
+  it 'can load from a HTTP endpoint' do
+    expect(subject.load(http_url, {})).to eq(response_body)
+  end
+
+  it 'can load from a HTTPS endpoint' do
+    expect(http).to receive_messages([:use_ssl=, :verify_mode=])
+    expect(subject.load(https_url, {})).to eq(response_body)
+  end
+
+  it 'can load from a endpoint using basic-auth' do
+    expect(request).to receive(:basic_auth)
+    expect(subject.load(
+      http_url, {
+        :username => 'basic_auth_username',
+        :password => 'basic_auth_password',
+      }
+    )).to eq(response_body)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require File.expand_path('../../lib/foundry.rb', __FILE__)
+
+RSpec.configure do |config|
+  config.color_enabled = true if config.respond_to?(:color_enabled)
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: foundry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan W. Zaleski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-08 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: 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !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: |2
+    Let's face it, there are a number of problems when application/environment
+    configuration logic is too tightly coupled with the configuration-data itself.
+    This gem aims to keep it simple and fully decouple the two concerns.
+
+    Features:
+
+    * Can load YAML from a local-file
+    * Can load YAML from a HTTP/HTTPS endpoint
+    * Supports Basic Authentication for HTTP{,S} endpoints
+    * Supports ERB interpolation
+    * Returns an easy to navigate object-graph
+email:
+- JonathanZaleski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- foundry.gemspec
+- lib/foundry.rb
+- lib/foundry/configurator.rb
+- lib/foundry/loaders/file.rb
+- lib/foundry/loaders/uri.rb
+- lib/foundry/version.rb
+- spec/configurator_spec.rb
+- spec/loaders/file_spec.rb
+- spec/loaders/uri_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jzaleski/foundry
+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: An application configuration gem that aims to keep it simple
+test_files:
+- spec/configurator_spec.rb
+- spec/loaders/file_spec.rb
+- spec/loaders/uri_spec.rb
+- spec/spec_helper.rb