Mellon

Speak, Friend, and enter.

Mellon is four things:

I built Mellon because I wanted Yet Another Way of Managing Application Secrets™. Frankly, I am fed up with passing around some secret file not included in our source code repository that runs out of sync every time we add or change values during development.

Mellon, together with Econfig, solves this problem.

Mellon is sponsored by Elabs.

elabs logo

Usage

Mellon is intended for usage during development only. The recommended workflow is:

  1. Create an OSX keychain using Keychain Access, name it something hip and clever, like thanks-a-latte.
  2. Share your keychain with your colleagues, through iCloud sync, Dropbox or similar.
  3. Hook up Mellon with your application according to the instructions below.

Using with Econfig (recommended) and Rails

Add to your Gemfile:

gem "econfig", require: "econfig/rails"
gem "mellon", require: "mellon/econfig"

And create an initializer config/initializers/econfig.rb:

if Rails.env.development?
  Econfig.instance.backends << Econfig::Mellon.new(Rails.application.name, keychain: "thanks-a-latte")

  MyRailsApplication.extend(Econfig::Shortcut)
end

Now you’ll be able look up, and change, your shared configuration as such:

MyRailsApplication.some_configuration_key # => some value
MyRailsApplication.some_configuration_key = "new value" # automatically synced to keychain

Documentation

Mellon::Keychain

Mellon::Keychain allows you to read and write notes in OSX keychains.

keychain = Mellon::Keychain.default
keychain["ruby note"] # => nil
keychain["ruby note"] = "Hello from Ruby!" # creates keychain note `ruby note`
keychain["ruby note"] # => "Hello from Ruby!"
keychain["ruby note"] = nil # deletes keychain note `ruby note`

Mellon::Store

Mellon::Store is a layer above Mellon::Keychain, allowing you to use a single keychain note as hash storage. Notes are serialized as YAML by default.

project_name = "ruby note"
store = Mellon::Store.new(project_name, keychain: Mellon::Keychain.default)
store["some key"] # => nil
store["some key"] = "Hello from Ruby!" # creates keychain note "ruby note", and puts value for "some key" in it
store["some key"] # => "Hello from Ruby!"

# Have a peek at the data, which is serialized as YAML
store.keychain[store.project_name] # => "---\nsome key: Hello from Ruby!\n"

Command-line interface

When you install the Mellon gem you also get an executable called mellon. See mellon -h for usage information.

License

See MIT-LICENSE.txt.