envconfig 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ae15014bb2a42caac46541701ad0eeedecf4945
-  data.tar.gz: 291af5950eae465a0ebe2a411374ddcde9ddff16
+  metadata.gz: 3ab09a9d9d16863e549d99b9e6d4e98185e66ed2
+  data.tar.gz: b679e231ef2f5c3287ab1673210bd982d921145b
 SHA512:
-  metadata.gz: 5d227e3a0307aad586efe1dc3c81ee7f089920fbea191ff6e0f00a9659f7c6c8089745e1fda711d56316e299446b4c307d8eb7db809d1077a6033deaaf02265b
-  data.tar.gz: 9ef22e14457b7fc0297061d0a9a97fb1f1cf1bf45701d8dbb4c5135772cc3082cf1aa2ede4163a99699e9c0e0fc544c3fd76eaff034bc462a7f4b558c8cf5fc4
+  metadata.gz: 98ddb30963a62b3f0b0a6f45e400843df574675b6dedaf228e3fa710efb648182f34b28672eef8246bd5f9d172bae526efb31df220c33053aa0888ef6ece6ac5
+  data.tar.gz: a2fca7e29c93c0302c62aa4d2d98e25a448bedce4088f72357a722c930fa918972791913a3377b5b1f5ef2f526a5e43fc9fab6fd5439990e230f81ab0142d0d5

data/README.md

@@ -1,33 +1,65 @@
 # envconfig
 
-Connect your Rails app to backing services via ENV vars such as those
-provided by [Broadstack][broadstack] or [Heroku Addons][heroku_addons].
+Easily configure your Ruby / Rails app to use the backing services specified in
+environment variables such as those provided by [Broadstack][broadstack] or
+[Heroku][heroku_addons] add-ons.
 
-envconfig gathers ENV configuration from known add-on providers, exposes them
-as a consistent configuration interface, and configures your Rails application
-via initializers.
+This lets you easily switch between providers, or between development and production,
+without having configuration conditionals in your code.
 
-For example if your ENV contains the follow:
+For more on why this makes a lot of sense, read the [Config][12config] and
+[Backing Services][12bs] sections of the excellent [Twelve-Factor App][12factor]
+written by Heroku co-founder Adam Wiggins.
 
-```
+
+## Services and Providers
+
+* [Database](#database): generic `DATABASE_URL`.
+* [memcached](#memcached): MemCachier.
+* [MongoDB](#mongodb): MongoHQ, MongoLab.
+* [Redis](#redis): openredis, RedisCloud, RedisGreen, Redis To Go.
+* [SMTP](#smtp): generic, Mailgun, Mandrill, Postmark, Sendgrid.
+
+
+## Examples
+
+Given the following ENV vars:
+
+```sh
 POSTMARK_SMTP_SERVER="smtp.example.org"
 POSTMARK_API_KEY="bcca0a78abbaed6533f3c8017b804bda"
+MONGOHQ_URL="mongodb://user:pass@mongo.example.com:2468/stack618"
 ```
 
-Then envconfig's SMTP configuration will look like this:
+Envconfig will look like this:
 
 ```ruby
-Envconfig.load.smtp.to_h # =>
-{
+config = Envconfig.load
+
+# Individual keys:
+config.smtp[:address] # => "smtp.example.org"
+config.mongodb[:host] # => "mongo.example.com"
+
+# Service configuration:
+config.smtp.to_h # => {
   port: "25",
   authentication: :plain,
   address: "smtp.example.org",
   user_name: "bcca0a78abbaed6533f3c8017b804bda",
   password: "bcca0a78abbaed6533f3c8017b804bda"
 }
+config.mongodb.to_h # => {
+  url: "mongodb://user:pass@mongo.example.com:2468/stack618",
+  database: "stack618",
+  username: "user",
+  password: "pass",
+  host: "mongo.example.com",
+  port: 2468
+}
 ```
 
-And `ActionMailer` will be auto-configured accordingly.
+And if you're using Rails, ActionMailer will be automatically configured
+to use those SMTP details via `Rails.application.config.action_mailer.smtp_settings`.
 
 
 ## Installation
@@ -39,16 +71,22 @@ or `gem install envconfig`.
 
 ## Usage
 
-Add `envconfig-rails` to your `Gemfile` and go.
+### envconfig
 
-If you're not using Rails, add the base `envconfig` gem, and access the
-configuration like this:
+The `envconfig` gem exposes your `ENV` configuration as a consistent interface,
+using its knowledge of many add-on providers.
 
 ```ruby
 Envconfig.load.smtp[:address]  => "example.org"
 Envconfig.load.smtp.to_h  # => {address: "example.org", ...}
 ```
 
+### envconfig-rails
+
+The `envconfig-rails` gem adds Rails integration, pushing certain configuration
+into the Rails application where it makes sense. Currently this is limited to
+configuring ActionMailer for SMTP; feel free to open issues discussing others.
+
 
 ## Supported Add-ons
 
@@ -121,6 +159,28 @@ Envconfig.load.memcached.to_h # =>
 ```
 
 
+### MongoDB
+
+* MongoHQ ([Broadstack](https://broadstack.com/addons/mongohq), [Heroku](https://addons.heroku.com/mongohq))
+* MongoLab ([Heroku](https://addons.heroku.com/mongolab))
+
+MongoDB example:
+
+```ruby
+ENV["MONGOHQ_URL"] = "mongodb://user:pass@mhq.example.org:2468/stack618"
+
+Envconfig.load.mongodb.to_h # =>
+{
+  url: "mongodb://user:secret@mhq.example.org:2468/stack618",
+  username: "user",
+  password: "secret",
+  host: "mhq.example.org",
+  port: 2468,
+  database: "stack618"
+}
+```
+
+
 ### Redis
 
 * openredis ([Heroku](https://addons.heroku.com/openredis))
@@ -156,3 +216,6 @@ Envconfig.load.redis.to_h # =>
 [backing_services]: http://12factor.net/backing-services
 [broadstack]: https://broadstack.com
 [heroku_addons]: https://addons.heroku.com/
+[12factor]: http://12factor.net/
+[12config]: http://12factor.net/config
+[12bs]: http://12factor.net/backing-services

data/lib/envconfig.rb

@@ -4,6 +4,7 @@ require "envconfig/url_parser"
 
 require "envconfig/database"
 require "envconfig/memcached"
+require "envconfig/mongodb"
 require "envconfig/redis"
 require "envconfig/smtp"
 
@@ -26,6 +27,7 @@ module Envconfig
       [
         :database,
         :memcached,
+        :mongodb,
         :redis,
         :smtp,
       ].inject({}) do |hash, service|
@@ -49,6 +51,14 @@ module Envconfig
       predicate_for(:memcached)
     end
 
+    def mongodb
+      service_for(:mongodb, Mongodb)
+    end
+
+    def mongodb?
+      predicate_for(:mongodb)
+    end
+
     def redis
       service_for(:redis, Redis)
     end

data/lib/envconfig/mongodb.rb

@@ -0,0 +1,44 @@
+module Envconfig
+  class Mongodb
+
+    include Service
+
+    def self.providers
+      [
+        Mongohq,
+        Mongolab,
+      ]
+    end
+
+    module ConfigFilter
+      def filter_config(config)
+        url = UrlParser.new(config[:url])
+        parts = url.extract_as(
+          database: ->(u){ (u.path || "").split("/")[1] },
+          username: :user,
+          password: :password,
+          host: :host,
+          port: :port,
+        )
+        config.merge!(parts).merge!(url.query_values)
+      end
+    end
+
+    class Mongohq
+      include Provider
+      include ConfigFilter
+      def mapping
+        {url: "MONGOHQ_URL"}
+      end
+    end
+
+    class Mongolab
+      include Provider
+      include ConfigFilter
+      def mapping
+        {url: "MONGOLAB_URI"}
+      end
+    end
+
+  end
+end

data/lib/envconfig/version.rb

@@ -1,3 +1,3 @@
 module Envconfig
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end

data/spec/mongodb_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe "MongoDB configuration" do
+
+  let(:env) { {} }
+  let(:config) { Envconfig.load(env).mongodb }
+
+  context "with nothing relevant in ENV" do
+    it_behaves_like "empty configuration"
+  end
+
+  %w{
+    MONGOHQ_URL
+    MONGOLAB_URI
+  }.each do |env_key|
+    it_behaves_like "mongodb configuration", env_key
+  end
+
+end

data/spec/root_spec.rb

@@ -10,6 +10,7 @@ describe Envconfig::Root do
     service_methods = [
       :database,
       :memcached,
+      :mongodb,
       :redis,
       :smtp,
     ]
@@ -43,6 +44,7 @@ describe Envconfig::Root do
         expect(root.to_h).to eq(
           database: {},
           memcached: {},
+          mongodb: {},
           redis: {},
           smtp: {},
         )
@@ -100,6 +102,8 @@ describe Envconfig::Root do
           password: "mcpass",
           server_strings: ["mc.example.org:11211"]
         },
+        mongodb: {
+        },
         redis: {
           url: "redis://:orpass@or.example.org:2345",
           host: "or.example.org",

data/spec/shared_examples.rb

@@ -17,7 +17,7 @@ shared_examples "empty configuration" do
 end
 
 shared_examples "redis configuration" do |env_key|
-  context "with openredis in ENV" do
+  context "with #{env_key} in ENV" do
     before do
       env[env_key] = "redis://:secrettoken@127.0.0.1:1234"
     end
@@ -35,3 +35,26 @@ shared_examples "redis configuration" do |env_key|
     end
   end
 end
+
+shared_examples "mongodb configuration" do |env_key|
+  context "with #{env_key} in ENV" do
+    before do
+      env[env_key] = "mongodb://user:pass@example.org:2468/db?a=b&c=d"
+    end
+
+    {
+      url: "mongodb://user:pass@example.org:2468/db?a=b&c=d",
+      database: "db",
+      username: "user",
+      password: "pass",
+      host: "example.org",
+      port: 2468,
+      a: "b",
+      c: "d",
+    }.each do |key, value|
+      it "sets :#{key} to #{value.inspect}" do
+        expect(config[key]).to eq(value)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envconfig
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Paul Annesley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2013-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ files:
 - lib/envconfig.rb
 - lib/envconfig/database.rb
 - lib/envconfig/memcached.rb
+- lib/envconfig/mongodb.rb
 - lib/envconfig/provider.rb
 - lib/envconfig/railtie.rb
 - lib/envconfig/redis.rb
@@ -82,6 +83,7 @@ files:
 - spec/database_spec.rb
 - spec/envconfig_spec.rb
 - spec/memcached_spec.rb
+- spec/mongodb_spec.rb
 - spec/provider_resolver_spec.rb
 - spec/redis_spec.rb
 - spec/root_spec.rb
@@ -109,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Connect your app to backing services via Broadstack/Heroku-style ENV vars.
@@ -117,6 +119,7 @@ test_files:
 - spec/database_spec.rb
 - spec/envconfig_spec.rb
 - spec/memcached_spec.rb
+- spec/mongodb_spec.rb
 - spec/provider_resolver_spec.rb
 - spec/redis_spec.rb
 - spec/root_spec.rb
@@ -124,4 +127,3 @@ test_files:
 - spec/smtp_spec.rb
 - spec/spec_helper.rb
 - spec/url_parser_spec.rb
-has_rdoc: