Metaforce - A Ruby gem for interacting with the SFDC Metadata API

I’d like to introduce you to a little pet project I’ve been working on in my spare time; Metaforce. Metaforce is a Ruby gem that abstracts the Salesforce Metadata API, which is a Soap based API for CRUD’ing metadata on Salesforce organizations.

Why, you ask? Mainly because I don’t like Ant or the Migration tool. I’d much rather use Rake for migrations than bother with Java based tools. And hey, it’s fun. Not only that, but because it’s a gem, other developers can build awesome tools on top of it, whether that’s in Rails, Sinatra, or whatever you please, without having to delve into the nitty gritty of the Soap API.

You can get started with Metaforce by installing it:

gem install metaforce --pre

Once installed, using it is as simple as configuring your credentials:

Metaforce.configure do |config|
  config.username = ""
  config.password = "mypassword"
  config.security_token = "mysecuritytoken"
  config.test = true # if you're on a sandbox org

client =

And then performing the task you want to do. For example, if you want to list all metadata types on your organization, you can call .describe.


And it will return a hash with the results.

Or if you want to list the members of a particular metadata type, you can call .list.

client.list :type => "ApexClass"

You can even deploy code to an organization:

deployment = client.deploy File.dirname(__FILE__)
puts deployment.result :wait_until_done => true

Metaforce is currently under active development and there’s a lot of features I’d like to add. You should only use it for testing right now.

For more information, check out the project on GitHub, and don’t be afraid to browse through the specs for example usage.