xfrtuc

A Ruby client for the Transferatu API, used to manage data transfers, schedules, and groups.

Installation

gem 'xfrtuc'

Usage

client = Xfrtuc::Client.new(user: "user", password: "secret", url: "https://transferatu.example.com")

group = client.group.create("my-group", "https://log-input.example.com")
client.group("my-group").transfer.create(from_url: "postgres:///source", to_url: "postgres:///target")
client.group("my-group").transfer.list
client.group("my-group").schedule.create(name: "nightly", callback_url: "https://example.com/callback")

Development

bundle install
bundle exec rspec

Releasing

1. Bump the version in lib/xfrtuc/version.rb

2. Update CHANGELOG.md — move entries from [Unreleased] into a new versioned section and update the comparison links at the bottom

3. Commit the changes

   git add lib/xfrtuc/version.rb CHANGELOG.md
   git commit -m "version -> x.y.z"

1. Create and push a git tag

   git tag vx.y.z
   git push origin main --tags

1. Build and push the gem to RubyGems.org

   gem build
   gem push xfrtuc-x.y.z.gem

License

MIT