centroid 0.1.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 442b6a1b3ee53454896410af8438283629427be9
+  data.tar.gz: 43a912b02506d5c43ec2c1a0cb8ae21014645d3e
+SHA512:
+  metadata.gz: f0c33f1d345b44f5923382210ead37c2e7c0d151dc48c839a002c0d6fe32e607c43cc7833d93c862ed3eacd58ec5135233057c7e425a95067efdfad4d87c0727
+  data.tar.gz: 45c336c21d6e93275cbac3704bc42f0f47e18b9814325d06f5c91888e8f80629af7785b8a224e7940f5c790cc4a18921df9efe2345e72e94f434aea60ba233bd

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,91 @@
+# Centroid - Ruby
+
+## Installation
+
+The Centroid Ruby package is hosted at [rubygems.org](https://rubygems.org/gems/centroid).
+
+You can install Centroid using gem with `gem install centroid`, or you can download, unpack, then `bundle install` and `rake install` from the `/ruby` directory.
+
+## Usage
+
+Begin by declaring your application's configuration values in JSON. The following example stores the database's server address.
+
+```json
+{
+    "database": {
+        "serverAddress": "my-server.local"
+    }
+}
+```
+
+With Centroid's API, Ruby applications can then use the configuration values in this JSON.
+
+### Ruby API
+
+The Ruby API is available through the `Centroid::Config` class, an instance of which is used to consume the JSON.
+
+The `Config` class exposes the `from_file` class method, an initializer, and the instance method `for_environment`.
+
+#### from_file(filename)
+
+You can create an instance of `Config` from a JSON file using the `Centroid::Config.from_file(filename)` class method.
+
+In the example below, note the `serverAddress` configuration value is retrieved using the snake_case `server_address` method even though the value is specified as camelCase in the JSON.
+
+```rb
+# from_file.rb
+config = Centroid::Config.from_file("config.json")
+server = config.database.server_address # => "my-server.local"
+```
+
+### Config(json)
+
+Alternatively, you can create an instance of `Config` by passing a JSON string to the `Config` initializer.
+
+```rb
+# from_string.rb
+json = '{ "database": { "serverAddress": "my-server.local" } }'
+config = Centroid::Config(json)
+server = config.database.server_address # => "my-server.local"
+```
+
+### for_enviroment(environment)
+
+Typically, real-world applications have different configuration values depending on the environment. For example, you might have *dev* and *prod* environments that use different servers, user accounts, etc. However, applications usually have other configuration values that are the same across all environments. Centroid makes it easy to retrieve all the configuration values you need for a specific environment.
+
+In environment-based configuration, the top-level objects in the JSON represent the various environments. Place the configuration values that are the same across all environments within the *all* environment.
+
+```json
+{
+    "dev": {
+        "someResource": {
+            "server": "resource-dev.local"
+        }
+    },
+    "prod": {
+        "someResource": {
+            "server": "resource-prod.local"
+        }
+    },
+    "all": {
+        "keys": {
+            "ssh": "path/to/id_rsa.pub"
+        }
+    }
+}
+```
+
+Then, in the `Config` instance, use the instance method `for_environment` to retrieve the environment-based configuration. Centroid merges the requested environment's configuration values with the *all* environment configuration values.
+
+In the following example, the configuration for `prod` is merged with the configuration from `all`; the result is then available from a new instance of `Config`.
+
+```rb
+# for_enviroment.rb
+config = Centroid::Config.from_file("config.json").for_environment("prod")
+server = config.some_resource.server # => "resource-prod.local"
+solution_path = config.keys.ssh # => "path/to/id_rsa.pub"
+```
+
+## Contributing
+
+See the [contributing section of the main README](../README.md#contributing)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/centroid.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name = 'centroid'
+  s.version = '0.1.0.beta'
+  s.summary = 'A centralizaed paradigm to configuration management.'
+  s.description = 'Centroid is a tool for loading configuration values declared in JSON, and accessing those configuration values using object properties.'
+  s.author = 'Resource Data, Inc'
+  s.email = 'oss@resdat.com'
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/ResourceDataInc/Centroid'
+  s.license = 'MIT'
+end

data/lib/centroid.rb

@@ -0,0 +1,63 @@
+require "json"
+
+module Centroid
+  class Config
+    attr_reader :raw_config
+
+    def initialize(config)
+      if config.is_a?(Hash)
+        @raw_config = config
+      else
+        @raw_config = JSON.parse(config)
+      end
+    end
+
+    def method_missing(attrib, *)
+      self[attrib]
+    end
+
+    def [](key)
+      value = find_value(key, raw_config)
+
+      raise Exception.new("Key not found in collection.") if value.nil?
+
+      if value.is_a?(Hash)
+        Config.new(value)
+      else
+        value
+      end
+    end
+
+    def to_s
+      JSON.dump(raw_config)
+    end
+
+    def for_environment(env)
+      env_json = raw_config[env]
+      all_key = actual_key("all", raw_config)
+      if all_key.nil?
+        Config.new(env_json)
+      else
+        all_json = raw_config[all_key]
+        Config.new(all_json.merge(env_json))
+      end
+    end
+
+    def self.from_file(filename)
+      str_json = File.read(filename)
+      self.new(str_json)
+    end
+
+    def normalised_key(unnormalised_key)
+      unnormalised_key.to_s.gsub("_", "").downcase
+    end
+
+    def find_value(key, hashtable)
+      hashtable[actual_key(key, hashtable)]
+    end
+
+    def actual_key(key, hashtable)
+      hashtable.keys.find { |k| normalised_key(key) == normalised_key(k) }
+    end
+  end
+end

data/test/centroid_test.rb

@@ -0,0 +1,71 @@
+require_relative "../lib/centroid"
+require "test/unit"
+require "json"
+
+class ConfigTests < Test::Unit::TestCase
+  def json_config
+    '{"Environment":{"TheKey":"TheValue"}}'
+  end
+
+  def shared_file_path
+    'config.json'
+  end
+
+  def test_create_from_string
+    config = Centroid::Config.new(json_config)
+    assert_equal(config.environment.the_key, "TheValue")
+  end
+
+  def test_create_from_file
+    config = Centroid::Config.from_file(shared_file_path)
+    assert_equal(config.dev.database.server, "sqldev01.centroid.local")
+  end
+
+  def test_raises_if_key_not_found
+    config = Centroid::Config.new(json_config)
+    assert_raise Exception do
+      config = config.does_not_exist
+    end
+  end
+
+  def test_readable_using_snake_case_property
+    config = Centroid::Config.new(json_config)
+    assert_equal(config.environment.the_key, "TheValue")
+  end
+
+  def test_environment_specific_config_is_included
+    config = Centroid::Config.new(json_config)
+    environment_config = config.for_environment("Environment")
+    assert_equal(environment_config.the_key, "TheValue")
+  end
+
+  def test_shared_config_is_included
+    config = Centroid::Config.from_file(shared_file_path)
+    config = config.for_environment("Dev")
+    assert_equal(config.ci.repo, "https://github.com/ResourceDataInc/Centroid")
+  end
+
+  def test_to_string_returns_json
+    config = Centroid::Config.new(json_config)
+    assert_equal(config.to_s, json_config)
+  end
+
+  def test_iterating_raw_config
+    config = Centroid::Config.from_file(shared_file_path)
+    keyCount = 0
+    config.raw_config.each { |k| keyCount += 1 }
+    assert_equal(keyCount, 4)
+  end
+
+  def test_modifying_raw_config
+    config = Centroid::Config.new(json_config)
+    config.raw_config["Environment"]["TheKey"] = "NotTheValue"
+    assert_equal(config.environment.the_key, "NotTheValue")
+  end
+
+  def test_environment_specific_config_overrides_all
+    config = Centroid::Config.new('{"Prod": {"Shared": "production!"}, "All": {"Shared": "none"}}')
+    config = config.for_environment("Prod")
+    assert_equal(config.shared, "production!")
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: centroid
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta
+platform: ruby
+authors:
+- Resource Data, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-19 00:00:00.000000000 Z
+dependencies: []
+description: Centroid is a tool for loading configuration values declared in JSON,
+  and accessing those configuration values using object properties.
+email: oss@resdat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- centroid.gemspec
+- lib/centroid.rb
+- test/centroid_test.rb
+homepage: https://github.com/ResourceDataInc/Centroid
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A centralizaed paradigm to configuration management.
+test_files: []