ROM-Firebase Adapter
This project builds on the excellent rom-http and firebase libraries to provide an interface for communicating with a Firebase Realtime Database.
How this works
To start using this, create a ROM::Configuration like so:
require 'rom-firebase'
configuration = ROM::Configuration.new(
:firebase,
uri: 'https://your-firebase-db-name.firebaseio.com',
headers: { Accept: 'application/json' },
request_handler: ROM::Firebase::RequestHandler.new(
File.expand_path('../config/your-firebase-db-name.json', __dir__)
), # or your own class
response_handler: ROM::Firebase::ResponseHandler # or your own class
)Notes:
- You'll need to change the path to your Firebase JSON file to match where it is stored for you.
- You can use your own RequestHandler or ResponseHandler class if you want customised interactions.
This configuration can be passed to a repository class which mirrors a schema inside your Firebase Realtime Database's key value store, e.g. let's say we are storing Pages, here is a working example. Note the use of key as the primary key.
class PageRepository < ROM::Firebase::Repository[:pages]
end
class Pages < ROM::Relation[:firebase]
schema do
attribute :createdAt, ROM::Firebase::Types::Timestamp
attribute :title, Types::Strict::String
attribute :description, Types::Strict::String
attribute :key, Types::Strict::String.meta(primary_key: true)
end
end
configuration.register_relation(Pages)
container = ROM.container(configuration)
repo = PageRepository.new(container)Now you can query it:
page = repo.create(
createdAt: Time.now.to_i * 1000, # Firebase stores in milliseconds
title: 'Hello World',
description: 'A wild page appears'
)This should return a ROM::Struct::Page with the created attributes:
=> #<ROM::Struct::Page createdAt=1552999123000 title="Hello World" description="A wild page appears" key="-LaKxW4D8LTpwIWN3N9J">And, in your Firebase Database console, you'll see a new pages node with one record.
To query this, you can use some of the built in functionality:
repo.where { |page| page.title == 'Hello World' }
=> [#<ROM::Struct::Page createdAt="1552999123000" title="Hello World" description="A wild page appears" key="-LaKxW4D8LTpwIWN3N9J">]To update it, call update passing the key and a hash of the attributes to change:
repo.update(page.key, description: 'A wild page is updated')
=> [#<ROM::Struct::Page createdAt="1552999123000" title="Hello World" description="A wild page is updated " key="-LaKxW4D8LTpwIWN3N9J">]To delete our page is simple:
repo.delete(page.key)
=> nil
