Airrecord

Airrecord is an alternative to airtable-ruby. Airrecord takes an approach to approaching Airtable more like a database from Ruby's point of view, inviting inspiration from ActiveRecord's API.

gem 'airrecord'

This library is provided to enforce a mental model of a database, as described in this post. Furthermore as an alternative to the official library.

Examples

There's a simple API that allows more ad-hoc querying of Airtable:

teas = Airrecord.table("key1", "app1", "Teas")

teas.records.each do |record|
  puts "#{record.id}: #{record[:name]}"
end

p teas.find(teas.records.first.id)

Then there's the API which allows you to define tables as classes and relationships between them. This maps with ActiveRecord models. This makes working with relationships much easier, and allows you to define domain-specific logic on the models.

class Brew < Airrecord::Table
  self.api_key = "key1"
  self.base_key = "app1"
  self.table_name = "Hot Brews"

  belongs_to :tea, class: 'Tea', column: 'Tea'
end

class Tea < Airrecord::Table
  self.api_key = "key1"
  self.base_key = "app1"
  self.table_name = "Teas"

  has_many :hot_brews, class: 'Brew', column: "Hot Brews"

  def location
    [self[:village], self[:country], self[:region]].compact.join(", ")
  end
end

tea = Tea.all[2]
brew = tea[:hot_brews].first
brew[:tea].id == tea.id

tea = Tea.new(Name: "omg tea", Type: ["Oolong"])
tea.create

tea[:name] = "super omg tea"
tea.save

tea = Tea.find(tea.id)
puts tea[:name]
# => "super omg tea"

brew = Brew.new(Tea: [tea], Rating: "3 - Fine")
brew.create

tea = Tea.find(tea.id)
puts tea[:hot_brews].first[:rating]
# => "3 - Fine"

Contributing

Contributions will be happily accepted in the form of Github Pull Requests!

• Please ensure CI is passing before submitting your pull request for review.
• Please provide tests that fail without your change.