Project

xfrtuc

0.0
A long-lived project that still receives updates
Transferatu client
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies
 Project Readme

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"
  4. Create and push a git tag

    git tag vx.y.z
    git push origin main --tags
  5. Build and push the gem to RubyGems.org

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

License

MIT