Mio Config

This simple rubygem will allow for a codified build out of mio resources and configuration.

The builders are largely based on rails migrations, though they're closer in concept to configuration management tools like chef and puppet. Thus they should contain nothing new to most developers, ruby or not.

Installation

In your Gemfile:

gem 'mio-config', github: 'financial-times/mio-config.git'

source 'https://rubygems.org'
gem 'mio-config'

Configuration

mio-config relies on the config file: ./config/mio.yml, which must live in the root of your project. It looks like:

----
base_url: https://my-mio.example.com
username: admin
password: passwd

Note: this may also be templated- it uses ERB under the hood.

----
base_url: <%= ENV.fetch('MIO_URL', 'https://my-mio.example.com' %>
username: admin
password: <%= File.read( "#{ENV.fetch('HOME')}/.passwd" ) %>

Usage

We expose a couple of rake tasks:

$ bundle exec rake -T
rake mio:migrate                     # Handle migrations (via mio:migrate:up)
rake mio:migrate:create[model,desc]  # Create a new migration
rake mio:migrate:up                  # Run migrations

Create migrations

You're more than welcome to handcraft these- they're pretty simple. You may, though, use the skeleton we create:

$ bundle exec rake mio:migrate:create[s3,'create an s3 bucket for ingestion']

NOTE: There is a lack of spaces around stuff on purpose. Rake gets a bit funny with them in.

This rake taks will look at the model and pre-populate the necessary arguments. From there any Plain Ol' Ruby will work. Probably.

Handcrafting

Models have a series of fields they expect to exist; a developer may see these by looking in the directory lib/mio/model. To create an s3 bucket resource as above, and after looking in this file, we end up with something similar to:

migrate 'create an s3 bucket for ingestion' do
  s3 do |s|
    s.name = 'My S3 Bucket'
    s.visibility = [32444]
    s.key = 'S3-KEY'
    # Snip
  end
end

Development

This project was built and tested with ruby 2.3.0.

To install this via rbenv:

OSX

$ # Install rbenv if not installed
$ brew install rbenv
$ echo 'eval "$(rbenv init -)" ' >> ~/.bash_proile
$ Install ruby 2.3.0
$ rbenv install 2.3.0
$ # Either set as global version:
$ rbenv global 2.3.0
$ # Or install as local to this project:
$ rbenv local 2.3.0

Other environments

rbenv may be installed via your package manager or from github

Building etc

$ bundle install

Adding models

Any model added to lib/mio/model will be autoloaded. The final class name becomes the caller method:

A model called:

class Mio
  class Model
    class Foo
    end
  end
end

will, then, be accessible by the helper method foo.

A migration would look like:

migrate 'a simple test` do
  foo do
    #blah
  end
end

Helper methods

Models define a resource and a set of fields. The resource is the path appended to base_uri; with example.com/api/workflows example.com is the base_uri and workflows is the resource. (The /api path is added in the gem).

The s3 model, for example, looks a little like:

class Mio
  class Model
    class S3 < Model
      set_resource :resources
      field :name, String, /^(?!\s*$).+/
# SNIP

#field has the signature:

def field key, type, desc, default=nil, matcher=nil

Licence

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.