blinkbox-common_config 0.4.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmMzMTM2YmJmY2I5OWIyM2Y4YWJhMTY1M2QxMGZhZGRiY2U4NmNmYQ==
+  data.tar.gz: !binary |-
+    MzI5NmJiZjFmMjFiNmUzNmE3NWM2Yzc5MmZlZWUzM2NkNzhkM2EwZQ==
+SHA512:
+  metadata.gz: !binary |-
+    NGUzYTcxNjY5OTg1ZTI0NWRkNWIwYmRmZGZkMjI3NDgyZWI3MDYzODUxOWVk
+    NTQ0YThkNWY2NWIwNzM0Y2QzNjAyYWYzNDA1NDY4ZGNhN2I5NTJlMzk4NmRk
+    MDUwZmY1OTU4M2YwNTE1NGE3N2M3ZmEyMjgzMjhlMTkyZTdkMDQ=
+  data.tar.gz: !binary |-
+    Njc1ZGIxNzBhZGExMzAxNTNmNWM5NDU0OThkZjcxZjRmZjI5MTk0NTJlY2Uy
+    YWM3NzMwMDM0MmY2YjgzMGFhOTkyYmQ5MDc1NTJhOGExZDk3MmJhNjdlY2Ey
+    OGYzYjA5MDc0NjY2MjkxYmU2ZjcyNGRmMjZjN2U0MGM5NTU2Yjk=

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+## Open Source release (2015-01-28 14:11:21)
+
+Today we have decided to publish parts of our codebase on Github under the [MIT licence](LICENCE). The licence is very permissive, but we will always appreciate hearing if and where our work is used!
+
+## 0.4.0 ([#6](https://git.mobcastdev.com/Platform/common_config.rb/pull/6) 2014-10-03 15:41:55)
+
+No deep setting
+
+### Breaking change
+
+- Should not have changed this to using deep setting (other apps depend on it being single keys, and this is more flexible)
+
+## 0.3.1 ([#3](https://git.mobcastdev.com/Platform/common_config.rb/pull/3) 2014-08-18 09:46:37)
+
+Depth
+
+### Clarification
+
+- Made improvements to the tests and code so that the form of nested properties when using the `tree` method is well defined.
+
+## 0.3.0 ([#4](https://git.mobcastdev.com/Platform/common_config.rb/pull/4) 2014-09-25 10:00:48)
+
+Symbols and booleans
+
+### New feature
+
+- Converts `"true"` and `"false"` to boolean values.
+- Converts `":thing"` to `:thing` symbols.
+
+## 0.2.0 ([#2](https://git.mobcastdev.com/Platform/common_config.rb/pull/2) 2014-08-13 16:33:04)
+
+Use units in properties
+
+### New Feature
+
+- Properties in the format `5 seconds` will be converted to [Unit](https://github.com/olbrich/ruby-units) objects so that they can be easily manipulated:
+
+```ruby
+property = Unit("6 minutes")
+
+p property.convert_to("seconds").scalar
+### => 360
+```
+
+## 0.1.0
+
+Initial release
+
+### New features
+
+- Reads `config/reference.properties`, overwrites with `config/application.properties` (if it exists) then overwrites with contents of the file or URL at `ENV['CONFIG_URL']` (if it exists/responds with HTTP 200)

data/README.md

@@ -0,0 +1,17 @@
+# Blinkbox::CommonConfig
+
+Put your reference properties in `config/reference.properties` and any environmental stuff which makes sense for a development environment in `config/application.properties`, then load them and access them with:
+
+```ruby
+# $ gem install blinkbox-common_config
+require "blinkbox/common_config"
+
+properties = Blinkbox::CommonConfig.new
+
+# Accessible with symbols
+properties[:'rabbitmq.url']
+# Or strings
+properties["rabbitmq.url"]
+```
+
+It will also load the properties file referenced in the environment variable `CONFIG_URL` so long as the file exists, or the http(s) URI responds with a 200 status code.

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/lib/blinkbox/common_config.rb

@@ -0,0 +1,98 @@
+require "java_properties"
+require "java_properties/data_types"
+require "net/http"
+require "tempfile"
+
+module Blinkbox
+  class CommonConfig
+    # List of sources where properties have been loaded, with the most important first
+    attr_reader :sources
+
+    # Generates a CommonConfig object assuming that there is a `reference.properties` in the `config_fir` specified. If
+    # an `application.properties` is also present it will load that too (overwriting any repeated property keys) and finally
+    # if the environment variable `CONFIG_URL` is set it will load the properties from that (overwriting the others) whether
+    # the URL is an absolute, relative (to the working directory, not the `config_dir`) or an HTTP URI.
+    #
+    # @param [String] config_dir The directory where a `reference.properties` exists and optionally an `application.conf` exists. Relative paths are taken from the working directory.
+    # @param [#info, NilClass] logger A logger to which information about what properties have been loaded will be sent. Must respond to #info, can also be `nil`.
+    def initialize(config_dir: "config", logger: nil)
+      raise ArgumentError, "The logger given doesn't respond to #info." unless logger.nil? || logger.respond_to?(:info)
+
+      reference_prop_file = File.expand_path(File.join(config_dir, "reference.properties"))
+      application_prop_file = File.expand_path(File.join(config_dir, "application.properties"))
+      raise RuntimeError, "No reference file at #{reference_prop_file}" unless File.exist?(reference_prop_file)
+
+      @options = JavaProperties::Properties.new(reference_prop_file)
+      logger.info "Loaded configuration from #{reference_prop_file}" unless logger.nil?
+      @sources = [reference_prop_file]
+
+      if File.exist?(application_prop_file)
+        @options.load(application_prop_file)
+        logger.info "Loaded configuration from #{application_prop_file}" unless logger.nil?
+        @sources.unshift(application_prop_file)
+      end
+
+      if ENV['CONFIG_URL']
+        if ENV['CONFIG_URL'] =~ %r{^https?://}
+          res = Net::HTTP.get_response(URI.parse(ENV['CONFIG_URL']))
+          raise "The CONFIG_URL points to a resource that returns an HTTP Status code of #{res.code}, not a 200." unless res.code == "200"
+
+          remote_props = Tempfile.new('remote_properties')
+          begin
+            remote_props.write(res.body)
+            remote_props.close
+            @options.load(remote_props)
+          ensure
+            remote_props.unlink
+          end
+        else
+          @options.load(ENV['CONFIG_URL'])
+        end
+        logger.info "Loaded configuration from #{ENV['CONFIG_URL']}" unless logger.nil?
+        @sources.unshift(ENV['CONFIG_URL'])
+      end
+    end
+
+    # Creates a CommonConfig object from a hash.
+    #
+    # @params [Hash] hash The hash which will become the config. Symbol or string key values are cool.
+    def self.from_hash(hash)
+      config = self.allocate
+      config.instance_variable_set(:'@options', hash)
+      config
+    end
+
+    # Accessor for the properties stored in the instance. Accepts strings or symbols indifferently.
+    #
+    # @params [String, Symbol] key The name of the property to retrieve.
+    def [](key)
+      @options[key]
+    end
+    alias :get :[]
+
+    # Retrieves a hash of all properties which are beneath this starting element in the tree.
+    #
+    # # logging.udp.host = "127.0.0.1"
+    # # logging.udp.port = 1234
+    # # logging = this won't be returned
+    #
+    # properties.tree(:logging)
+    # # => { :'udp.host' => "127.0.0.1", :'udp.port' => 1234 }
+    #
+    # properties.tree(:log)
+    # # => {}
+    #
+    # @params [String, Symbol] root The root key to look underneath.
+    # @returns [Hash] Returns a has
+    def tree(root)
+      hash = {}
+      @options.each { |key, value|
+        len = root.length + 1
+        if key.to_s.slice(0, len) == root.to_s + '.'
+          hash[key.to_s[len..-1].to_sym] = value
+        end
+      }
+      hash
+    end
+  end
+end

data/lib/java_properties/data_types.rb

@@ -0,0 +1,29 @@
+require "ruby_units"
+
+module JavaProperties
+  module Encoding
+    class << self
+      alias :raw_decode :decode
+      def decode(string)
+        string = raw_decode(string)
+
+        case string
+        when /^:(\w+)$/
+          Regexp.last_match[1].to_sym
+        when /^(?:true|false)$/i
+          string.downcase == "true"
+        when /^\d+\ .+$/
+          Unit(string)
+        when /^\d+$/
+          string.to_i
+        when /^\d+\.\d+$/
+          string.to_f
+        when /^"(.*)"$/
+          Regexp.last_match[1]
+        else
+          string
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: blinkbox-common_config
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- JP Hastings-Spital
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: java_properties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-units
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Simple helper for loading configuration in the blinkbox Books format
+email:
+- jphastings@blinkbox.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- README.md
+files:
+- CHANGELOG.md
+- README.md
+- VERSION
+- lib/blinkbox/common_config.rb
+- lib/java_properties/data_types.rb
+homepage: ''
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple helper for loading configuration in the blinkbox Books format
+test_files: []