envconfig 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fff31b686ded3d76596b2b14c6ebd4237e596d34
+  data.tar.gz: 2ef7f44560eaae47bd7c3e83f2f6a58d2fd2f733
+SHA512:
+  metadata.gz: 7db87aea796a5b24fed2e68ca338e65c3ea0788f266b0fbd6213900eb7b85e99a02701907f32ae07ad87e89571334055274dc2040facc4c0425bbd2598542a03
+  data.tar.gz: 14ce9eb3c94e044c61bc57c058c7cef00d5c3605b514adfe14fe773a36069a3ce7391d6493e4e23c9571a34c7c00dd2b9f8c51cf415f8a32d389aef6f1112b09

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode # Rubinius in 1.9 mode
+
+script: bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Annesley
+
+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,67 @@
+# envconfig
+
+Connect your Rails app to backing services via ENV vars such as those
+provided by [Broadstack][broadstack] or [Heroku Addons][heroku_addons].
+
+envconfig gathers ENV configuration from known add-on providers, exposes them
+as a consistent configuration interface, and configures your Rails application
+via initializers.
+
+For example if your ENV contains the follow:
+
+```
+POSTMARK_SMTP_SERVER="smtp.example.org"
+POSTMARK_API_KEY="bcca0a78abbaed6533f3c8017b804bda"
+```
+
+Then envconfig's SMTP configuration will look like this:
+
+```ruby
+Envconfig.load(ENV).smtp.to_h # =>
+{
+  "address" => "smtp.example.org",
+  "port" => 25,
+  "username" => "bcca0a78abbaed6533f3c8017b804bda",
+  "password" => "bcca0a78abbaed6533f3c8017b804bda",
+}
+```
+
+And `ActionMailer` will be auto-configured accordingly.
+
+
+## Installation
+
+Add `gem "envconfig"` to your Gemfile and run `bundle`,
+or `gem install envconfig`.
+
+
+## Usage
+
+Add `envconfig-rails` to your `Gemfile` and go.
+
+If you're not using Rails, add the base `envconfig` gem, and access the
+normalized configuration directly.
+
+
+## Supported Add-ons
+
+### SMTP
+
+* Postmark ([Broadstack](https://broadstack.com/addons/postmark), [Heroku](https://addons.heroku.com/postmark))
+* Mandrill ([Heroku](https://addons.heroku.com/mandrill))
+* SendGrid ([Heroku](https://addons.heroku.com/sendgrid))
+* Custom (`SMTP_HOST`, `SMTP_PORT`, `SMTP_USERNAME`, `SMTP_PASSWORD` in `ENV`)
+
+
+## Contributing
+
+1. Fork it
+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
+
+
+[backing_services]: http://12factor.net/backing-services
+[broadstack]: https://broadstack.com
+[heroku_addons]: https://addons.heroku.com/

data/Rakefile

@@ -0,0 +1,32 @@
+# This entire Rakefile (at time of writing), and the general model
+# of multiple gemspecs in one project, was lifted from bkeepers/dotenv.
+# See: https://github.com/bkeepers/dotenv/blob/master/Rakefile
+
+require "bundler/gem_helper"
+
+namespace "envconfig" do
+  Bundler::GemHelper.install_tasks :name => "envconfig"
+end
+
+namespace "envconfig-rails" do
+  class EnvconfigRailsGemHelper < Bundler::GemHelper
+    def guard_already_tagged; end # noop
+    def tag_version; end # noop
+  end
+
+  EnvconfigRailsGemHelper.install_tasks :name => "envconfig-rails"
+end
+
+task :build => ["envconfig:build", "envconfig-rails:build"]
+task :install => ["envconfig:install", "envconfig-rails:install"]
+task :release => ["envconfig:release", "envconfig-rails:release"]
+
+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/envconfig-rails.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'envconfig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "envconfig-rails"
+  spec.version       = Envconfig::VERSION
+  spec.authors       = ["Paul Annesley"]
+  spec.email         = ["paul@annesley.cc"]
+  spec.summary       = %q{Auto-configure Rails from ENV vars via envconfig.}
+  spec.homepage      = "https://github.com/broadstack/envconfig"
+  spec.license       = "MIT"
+
+  spec.files         = ["lib/envconfig-rails.rb"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "envconfig", Envconfig::VERSION
+end

data/envconfig.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'envconfig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "envconfig"
+  spec.version       = Envconfig::VERSION
+  spec.authors       = ["Paul Annesley"]
+  spec.email         = ["paul@annesley.cc"]
+  spec.summary       = %q{Connect your app to backing services via Broadstack/Heroku-style ENV vars.}
+  spec.homepage      = "https://github.com/broadstack/envconfig"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/envconfig/provider.rb

@@ -0,0 +1,65 @@
+module Envconfig
+  module Provider
+
+    def self.find(env, providers)
+      providers.map { |k| k.new(env) }.detect(&:valid?) ||
+        NullProvider.new
+    end
+
+    def initialize(env)
+      @env = env
+    end
+
+    # A mapping of configuration keys to environment keys.
+    # e.g.
+    # {
+    #   address: "PROVIDER_HOSTNAME",
+    #   password: "PROVIDER_API_KEY",
+    # }
+    def mapping
+      raise "Mapping must be implemented by subclass."
+    end
+
+    # Static configuration which doesn't vary by environment.
+    # e.g. hostname / port.
+    def static
+      {}
+    end
+
+    def name
+      self.class.name.split("::").last
+    end
+
+    # Whether the environment is valid for this provider.
+    def valid?
+      env_keys.all? { |k| env.key?(k) }
+    end
+
+    # Which ENV keys are used by this provider.
+    def env_keys
+      mapping.values
+    end
+
+    # The configuration derived from the environment for this provider.
+    def config
+      static.merge(dynamic)
+    end
+
+    private
+
+    attr_reader :env
+
+    def dynamic
+      mapping.inject({}) do |result, (result_key, env_key)|
+        result[result_key] = env[env_key] if env.key?(env_key)
+        result
+      end
+    end
+
+    class NullProvider
+      def config; {} end
+      def name; nil; end
+    end
+
+  end
+end

data/lib/envconfig/railtie.rb

@@ -0,0 +1,22 @@
+require "envconfig"
+
+module Envconfig
+  class Railtie < Rails::Railtie
+
+    envconfig = Envconfig.load(ENV)
+
+    initializer "envconfig.smtp" do |app|
+      if envconfig.smtp?
+        envconfig_log "Using #{envconfig.smtp.provider.name} for SMTP"
+        app.config.action_mailer.smtp_settings = envconfig.smtp.to_h
+      else
+        envconfig_log "SMTP not configured"
+      end
+    end
+
+    def envconfig_log(message)
+      Rails.logger.info("Envconfig: #{message}")
+    end
+
+  end
+end

data/lib/envconfig/service.rb

@@ -0,0 +1,31 @@
+module Envconfig
+  module Service
+
+    def initialize(env)
+      @env = env
+    end
+
+    # The configuration for the service, as a Hash.
+    def to_h
+      config
+    end
+
+    # A single key from the configuration.
+    def [](key)
+      config[key]
+    end
+
+    def provider
+      @_provider ||= Provider.find(env, self.class.providers)
+    end
+
+    private
+
+    attr_reader :env
+
+    def config
+      @_config ||= provider.config
+    end
+
+  end
+end

data/lib/envconfig/smtp.rb

@@ -0,0 +1,84 @@
+module Envconfig
+  class Smtp
+
+    include Service
+
+    def self.providers
+      [
+        Custom,
+        Mandrill,
+        Postmark,
+        Sendgrid,
+      ]
+    end
+
+    # A custom configuration, for local or self-managed SMTP servers.
+    class Custom
+      include Provider
+      def valid?
+        mapping.values.any? { |k| env.key?(k) } #any? instead of #all?
+      end
+      def mapping
+        {
+          address: "SMTP_HOST",
+          port: "SMTP_PORT",
+          user_name: "SMTP_USERNAME",
+          password: "SMTP_PASSWORD",
+        }
+      end
+    end
+
+    class Mandrill
+      include Provider
+      def mapping
+        {
+          user_name: "MANDRILL_USERNAME",
+          password: "MANDRILL_APIKEY",
+        }
+      end
+      def static
+        {
+          address: "smtp.mandrillapp.com",
+          port: "25",
+        }
+      end
+    end
+
+    class Postmark
+      include Provider
+      def mapping
+        {
+          address: "POSTMARK_SMTP_SERVER",
+          user_name: "POSTMARK_API_KEY",
+          password: "POSTMARK_API_KEY",
+        }
+      end
+      def static
+        {
+          port: "25",
+          authentication: :plain,
+        }
+      end
+    end
+
+    class Sendgrid
+      include Provider
+      def name; "SendGrid" end
+      def mapping
+        {
+          user_name: "SENDGRID_USERNAME",
+          password: "SENDGRID_PASSWORD",
+        }
+      end
+      def static
+        {
+          address: "smtp.sendgrid.net",
+          port: "587",
+          authentication: :plain,
+          enable_starttls_auto: true
+        }
+      end
+    end
+
+  end
+end

data/lib/envconfig/version.rb

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

data/lib/envconfig-rails.rb

@@ -0,0 +1,3 @@
+# This file should only be loaded by `envconfig-rails`, not `envconfig`.
+# Loading `envconfig-rails` via Bundler auto-loads this due to the filename.
+require "envconfig/railtie"

data/lib/envconfig.rb

@@ -0,0 +1,28 @@
+require "envconfig/provider"
+require "envconfig/service"
+require "envconfig/smtp"
+require "envconfig/version"
+
+module Envconfig
+
+  def self.load(env)
+    Root.new(env)
+  end
+
+  class Root
+
+    def initialize(env)
+      @env = env
+    end
+
+    def smtp
+      @_smtp ||= ::Envconfig::Smtp.new(@env)
+    end
+
+    def smtp?
+      smtp.to_h.any?
+    end
+
+  end
+
+end

data/spec/provider_resolver_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+module Envconfig
+  describe "finding a provider" do
+
+    let(:env) { {} }
+    let(:providers) { [] }
+
+    subject(:provider) do
+      Provider.find(env, providers)
+    end
+
+    context "with assorted providers" do
+      class InvalidProvider
+        def initialize(env); end
+        def valid?; false end
+      end
+      class ValidProvider < InvalidProvider
+        def valid?; true; end
+        def config; {key: "value"}; end
+      end
+      class ValidProviderB < ValidProvider
+      end
+
+      let(:providers) do
+        [InvalidProvider, ValidProvider, ValidProviderB]
+      end
+
+      it "resolves to an instance of ValidProvider" do
+        expect(provider.class).to eq(ValidProvider)
+      end
+
+      it "provides ValidProvider's config" do
+        expect(provider.config).to eq(key: "value")
+      end
+
+    end
+
+    context "when no providers are valid" do
+      it "resolves to a null-provider with empty config" do
+        expect(provider.config).to eq({})
+      end
+    end
+
+  end
+end

data/spec/root_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Envconfig::Root do
+
+  let(:env) { {} }
+  subject(:root) { Envconfig.load(env) }
+
+  context "with nothing in ENV" do
+
+    describe "#smtp?" do
+      it "is false" do
+        expect(root.smtp?).to eq(false)
+      end
+    end
+
+    describe "#smtp" do
+      [:to_h, :provider, :[]].each do |m|
+        it "responds to :#{m}" do
+          expect(root.smtp.respond_to?(m)).to eq(true)
+        end
+      end
+      it "has an empty #to_h result" do
+        expect(root.smtp.to_h).to eq({})
+      end
+    end
+
+  end
+
+end

data/spec/smtp_spec.rb

@@ -0,0 +1,91 @@
+require "spec_helper"
+
+describe "SMTP configuration" do
+
+  let(:env) { {} }
+  subject(:config) { Envconfig.load(env).smtp }
+
+  context "with nothing relevant in ENV" do
+    it "returns nil for keys" do
+      [:address, :port, :user_name, :password].each do |k|
+        expect(config[k]).to eq(nil)
+      end
+    end
+    it "responds to #to_h with empty hash" do
+      expect(config.to_h).to eq({})
+    end
+    it "has nil provider name" do
+      expect(config.provider.name).to eq(nil)
+    end
+  end
+
+  context "with Mandrill in ENV" do
+    before {
+      env["MANDRILL_USERNAME"] = "mandrilluser"
+      env["MANDRILL_APIKEY"] = "mandrillkey"
+    }
+    it "sets address, port, user_name, password" do
+      expect(config.to_h).to eq(
+        address: "smtp.mandrillapp.com",
+        port: "25",
+        user_name: "mandrilluser",
+        password: "mandrillkey",
+      )
+    end
+    it "identifies as Mandrill" do
+      expect(config.provider.name).to eq("Mandrill")
+    end
+  end
+
+  context "with Postmark in ENV" do
+    before {
+      env["POSTMARK_SMTP_SERVER"] = "postmark.example.org"
+      env["POSTMARK_API_KEY"] = "b6ebafbec9a31661f6247f21ff4a68d9"
+    }
+    it "sets address, user_name, password" do
+      expect(config.to_h).to eq(
+        address: "postmark.example.org",
+        user_name: "b6ebafbec9a31661f6247f21ff4a68d9",
+        password: "b6ebafbec9a31661f6247f21ff4a68d9",
+        port: "25",
+        authentication: :plain,
+      )
+    end
+    it "identifies as Postmark" do
+      expect(config.provider.name).to eq("Postmark")
+    end
+  end
+
+  context "with SendGrid in ENV" do
+    before {
+      env["SENDGRID_USERNAME"] = "sendgriduser"
+      env["SENDGRID_PASSWORD"] = "sendgridpassword"
+    }
+    it "sets address, user_name, password" do
+      expect(config.to_h).to eq(
+        user_name: "sendgriduser",
+        password: "sendgridpassword",
+        address: "smtp.sendgrid.net",
+        port: "587",
+        authentication: :plain,
+        enable_starttls_auto: true
+      )
+    end
+    it "identifies as SendGrid" do
+      expect(config.provider.name).to eq("SendGrid")
+    end
+  end
+
+  context "with only SMTP_PORT=2525 in env" do
+    before { env["SMTP_PORT"] = "2525" }
+    it "has port 2525" do
+      expect(config[:port]).to eq("2525")
+    end
+    it "only has port 2525" do
+      expect(config.to_h).to eq(
+        port: "2525",
+      )
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "envconfig"

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: envconfig
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Annesley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- paul@annesley.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- envconfig-rails.gemspec
+- envconfig.gemspec
+- lib/envconfig-rails.rb
+- lib/envconfig.rb
+- lib/envconfig/provider.rb
+- lib/envconfig/railtie.rb
+- lib/envconfig/service.rb
+- lib/envconfig/smtp.rb
+- lib/envconfig/version.rb
+- spec/provider_resolver_spec.rb
+- spec/root_spec.rb
+- spec/smtp_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/broadstack/envconfig
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Connect your app to backing services via Broadstack/Heroku-style ENV vars.
+test_files:
+- spec/provider_resolver_spec.rb
+- spec/root_spec.rb
+- spec/smtp_spec.rb
+- spec/spec_helper.rb
+has_rdoc: