xfrtuc 0.0.13 → 1.0.0

data/.rubocop_standardrb_overrides.yml

@@ -0,0 +1,31 @@
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Lint/NumberConversion:
+  Enabled: true
+
+RSpec/ExampleLength:
+  Max: 12
+
+RSpec/MultipleExpectations:
+  Max: 3
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 8

data/.ruby-version

@@ -0,0 +1 @@
+3.4.9

data/CHANGELOG.md

@@ -0,0 +1,142 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [Unreleased]
+
+### Added
+
+-
+
+### Changed
+
+-
+
+## [1.0.0] - 2026-04-30
+
+### Added
+
+- `Xfrtuc::HTTP::Error` exception hierarchy. See: lib/xfrtuc/errors.rb
+- Support for testing against multiple Ruby versions in GitHub Actions.
+- SimpleCov for code coverage reporting.
+
+### Changed
+
+- Replaced `sham_rack` / `FakeTransferatu` test fake with WebMock stubs.
+- Updated rspec configuration.
+- Switched from CircleCI to GitHub Actions for CI.
+
+### Removed
+
+- **Breaking Change:** Replace `RestClient` with stdlib `Net::HTTP` - Gem-specific errors are raised rather than Excon-specific errors. See: lib/xfrtuc/errors.rb
+- Dropped support for Ruby < 3.2.
+
+## [0.0.13] - 2021-03-04
+
+### Added
+
+- CircleCI configuration for running specs and linting.
+
+### Fixed
+
+- Deprecation warning for obsolete `URI.escape` usage.
+
+### Changed
+
+- Updated to Ruby 3 compatibility.
+- Updated to Ruby 2.7.
+
+## [0.0.12] - 2020-05-29
+
+### Changed
+
+- Upgraded rest-client dependency to ~> 2.0.
+
+## [0.0.11] - 2017-12-12
+
+### Removed
+
+- Bastion support.
+
+### Changed
+
+- Updated Ruby version and all gem dependencies.
+
+## [0.0.10] - 2017-03-14
+
+### Added
+
+- Bastion support for connecting through a bastion host.
+
+## [0.0.9] - 2016-02-04
+
+### Added
+
+- `num` parameter support for transfer scheduling.
+
+## [0.0.8] - 2015-08-07
+
+### Added
+
+- `delete_transfer` method for removing transfers.
+- `transfer_action` method for performing actions on transfers.
+
+## [0.0.7] - 2015-06-15
+
+### Changed
+
+- Updated transfer and group listing to use verbose output.
+
+## [0.0.6] - 2015-04-15
+
+### Added
+
+- `schedule` and `schedule_list` methods for managing transfer schedules.
+
+## [0.0.5] - 2015-04-02
+
+### Added
+
+- Transfer group support with `group_list` and `group_create` methods.
+
+## [0.0.4] - 2015-02-05
+
+### Added
+
+- Public URL support in transfer creation.
+
+## [0.0.3] - 2015-02-05
+
+### Added
+
+- Transfer log retrieval via `transfer_log` method.
+
+## [0.0.2] - 2014-09-04
+
+### Added
+
+- Transfer listing and creation via Transferatu API.
+
+## [0.0.1] - 2014-09-03
+
+### Added
+
+- Initial release with basic Transferatu client structure.
+
+[Unreleased]: https://github.com/heroku/xfrtuc/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/heroku/xfrtuc/compare/v0.0.13...v1.0.0
+[0.0.13]: https://github.com/heroku/xfrtuc/compare/v0.0.12...v0.0.13
+[0.0.12]: https://github.com/heroku/xfrtuc/compare/v0.0.11...v0.0.12
+[0.0.11]: https://github.com/heroku/xfrtuc/compare/v0.0.10...v0.0.11
+[0.0.10]: https://github.com/heroku/xfrtuc/compare/v0.0.9...v0.0.10
+[0.0.9]: https://github.com/heroku/xfrtuc/compare/v0.0.8...v0.0.9
+[0.0.8]: https://github.com/heroku/xfrtuc/compare/v0.0.7...v0.0.8
+[0.0.7]: https://github.com/heroku/xfrtuc/compare/v0.0.6...v0.0.7
+[0.0.6]: https://github.com/heroku/xfrtuc/compare/v0.0.5...v0.0.6
+[0.0.5]: https://github.com/heroku/xfrtuc/compare/v0.0.4...v0.0.5
+[0.0.4]: https://github.com/heroku/xfrtuc/compare/v0.0.3...v0.0.4
+[0.0.3]: https://github.com/heroku/xfrtuc/compare/v0.0.2...v0.0.3
+[0.0.2]: https://github.com/heroku/xfrtuc/compare/v0.0.1...v0.0.2
+[0.0.1]: https://github.com/heroku/xfrtuc/releases/tag/v0.0.1

data/CODEOWNERS

@@ -0,0 +1,4 @@
+# Comment line immediately above ownership line is reserved for related gus information. Please be careful while editing.
+#ECCN:Open Source
+#GUSINFO:Heroku Data Operations,Heroku Data Intake
+* @heroku/data

data/Gemfile

@@ -1,4 +1,13 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in xfrtuc.gemspec
 gemspec
+
+gem "rspec", "~> 3.0"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rspec"
+gem "simplecov"
+gem "webmock"

data/README.md

@@ -0,0 +1,58 @@
+# xfrtuc
+
+A Ruby client for the [Transferatu](https://github.com/heroku/transferatu) API, used to manage data transfers, schedules, and groups.
+
+## Installation
+
+```ruby
+gem 'xfrtuc'
+```
+
+## Usage
+
+```ruby
+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
+
+```shell
+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**
+
+   ```shell
+   git add lib/xfrtuc/version.rb CHANGELOG.md
+   git commit -m "version -> x.y.z"
+   ```
+
+4. **Create and push a git tag**
+
+   ```shell
+   git tag vx.y.z
+   git push origin main --tags
+   ```
+
+5. **Build and push the gem to RubyGems.org**
+
+   ```shell
+   gem build
+   gem push xfrtuc-x.y.z.gem
+   ```
+
+## License
+
+MIT

data/lib/xfrtuc/errors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Xfrtuc
+  module HTTP
+    class Error < StandardError; end
+
+    class ClientError < Error; end
+    class BadRequest < ClientError; end
+    class NotFound < ClientError; end
+    class Conflict < ClientError; end
+    class Gone < ClientError; end
+
+    class ServerError < Error; end
+    class ServiceUnavailable < ServerError; end
+
+    class ConnectionResetError < Error; end
+    class SocketError < Error; end
+  end
+end

data/lib/xfrtuc/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Xfrtuc
-  VERSION = "0.0.13"
+  VERSION = "1.0.0"
 end

data/lib/xfrtuc.rb

@@ -1,19 +1,19 @@
-require 'json'
-require 'rest_client'
+# frozen_string_literal: true
+
+require "cgi"
+require "json"
+require "net/http"
+require "uri"
+require "xfrtuc/errors"
 
 module Xfrtuc
   class Client
     attr_reader :base_url
 
-    def initialize(username, password, base_url='https://transferatu.heroku.com')
+    def initialize(username, password, base_url = "https://transferatu.heroku.com")
       @base_url = base_url
       @username = username
       @password = password
-      @resource = RestClient::Resource.new(base_url,
-                                           user: username,
-                                           password: password,
-                                           headers: { content_type: 'application/json',
-                                                     accept: 'application/json' })
     end
 
     def transfer
@@ -24,29 +24,77 @@ module Xfrtuc
       @sched_client ||= Xfrtuc::Schedule.new(self)
     end
 
-    def group(name=nil)
+    def group(name = nil)
       if name.nil?
         @group_client ||= Xfrtuc::Group.new(self)
       else
         self.class.new(@username, @password,
-                       @base_url + "/groups/#{CGI.escape(name)}")
+          @base_url + "/groups/#{CGI.escape(name)}",)
       end
     end
 
-    def get(path, params={})
-      JSON.parse(@resource[path].get(params))
+    def get(path, params = {})
+      uri = build_uri(path)
+      uri.query = URI.encode_www_form(params[:params]) if params[:params]
+      request = Net::HTTP::Get.new(uri)
+      execute(uri, request)
     end
 
-    def post(path, data={})
-      JSON.parse(@resource[path].post(JSON.generate(data)))
+    def post(path, data = {})
+      uri = build_uri(path)
+      request = Net::HTTP::Post.new(uri)
+      request.body = JSON.generate(data)
+      execute(uri, request)
     end
 
-    def put(path, data={})
-      JSON.parse(@resource[path].put(JSON.generate(data)))
+    def put(path, data = {})
+      uri = build_uri(path)
+      request = Net::HTTP::Put.new(uri)
+      request.body = JSON.generate(data)
+      execute(uri, request)
     end
 
     def delete(path)
-      JSON.parse(@resource[path].delete)
+      uri = build_uri(path)
+      request = Net::HTTP::Delete.new(uri)
+      execute(uri, request)
+    end
+
+    private
+
+    def build_uri(path)
+      URI.parse("#{@base_url}#{path}")
+    end
+
+    HTTP_ERROR_MAP = {
+      400 => HTTP::BadRequest,
+      404 => HTTP::NotFound,
+      409 => HTTP::Conflict,
+      410 => HTTP::Gone,
+      503 => HTTP::ServiceUnavailable,
+    }.freeze
+
+    def execute(uri, request)
+      request.basic_auth(@username, @password)
+      request["Content-Type"] = "application/json"
+      request["Accept"] = "application/json"
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      response = http.request(request)
+      status = Integer(response.code)
+      unless (200..299).cover?(status)
+        error_class = HTTP_ERROR_MAP.fetch(status) do
+          (status >= 500) ? HTTP::ServerError : HTTP::ClientError
+        end
+        raise error_class, "Expected 2xx, got #{response.code}"
+      end
+      return nil if response.body.nil? || response.body.empty?
+      JSON.parse(response.body)
+    rescue Errno::ECONNRESET => e
+      raise HTTP::ConnectionResetError, e.message
+    rescue ::SocketError, Errno::ECONNREFUSED, Errno::EHOSTUNREACH,
+      Errno::ENETUNREACH, Net::OpenTimeout, Net::ReadTimeout => e
+      raise HTTP::SocketError, e.message
     end
   end
 
@@ -61,7 +109,9 @@ module Xfrtuc
   end
 
   class Group < ApiEndpoint
-    def initialize(client); super; end
+    def initialize(client)
+      super
+    end
 
     def info(name)
       client.get("/groups/#{CGI.escape(name)}")
@@ -71,7 +121,7 @@ module Xfrtuc
       client.get("/groups")
     end
 
-    def create(name, log_input_url=nil)
+    def create(name, log_input_url = nil)
       client.post("/groups", { name: name, log_input_url: log_input_url })
     end
 
@@ -81,9 +131,11 @@ module Xfrtuc
   end
 
   class Transfer < ApiEndpoint
-    def initialize(client); super; end
+    def initialize(client)
+      super
+    end
 
-    def info(id, opts={})
+    def info(id, opts = {})
       verbose = opts.delete(:verbose) || false
       unless opts.empty?
         raise ArgumentError, "Unsupported option(s): #{opts.keys}"
@@ -100,7 +152,7 @@ module Xfrtuc
       from_url = opts.fetch :from_url
       to_type = opts.fetch :to_type
       to_url = opts.fetch :to_url
-      [ :from_type, :from_url, :to_type, :to_url ].each { |key| opts.delete key }
+      [:from_type, :from_url, :to_type, :to_url].each { |key| opts.delete key }
       from_name = opts.delete :from_name
       to_name = opts.delete :to_name
       log_input_url = opts.delete :log_input_url
@@ -110,15 +162,15 @@ module Xfrtuc
         raise ArgumentError, "Unsupported option(s): #{opts.keys}"
       end
       payload = {
-                 from_type: from_type,
-                 from_url: from_url,
-                 from_name: from_name,
-                 to_type: to_type,
-                 to_url: to_url,
-                 to_name: to_name
-                }
-      payload.merge!(log_input_url: log_input_url) unless log_input_url.nil?
-      payload.merge!(num_keep: num_keep) unless num_keep.nil?
+        from_type: from_type,
+        from_url: from_url,
+        from_name: from_name,
+        to_type: to_type,
+        to_url: to_url,
+        to_name: to_name,
+      }
+      payload[:log_input_url] = log_input_url unless log_input_url.nil?
+      payload[:num_keep] = num_keep unless num_keep.nil?
       client.post("/transfers", payload)
     end
 
@@ -130,13 +182,15 @@ module Xfrtuc
       client.post("/transfers/#{CGI.escape(id)}/actions/cancel")
     end
 
-    def public_url(id, opts={})
+    def public_url(id, opts = {})
       client.post("/transfers/#{CGI.escape(id)}/actions/public-url", opts)
     end
   end
 
   class Schedule < ApiEndpoint
-    def initialize(client); super; end
+    def initialize(client)
+      super
+    end
 
     def info(id)
       client.get("/schedules/#{id}")
@@ -151,11 +205,11 @@ module Xfrtuc
       callback_url = opts.fetch :callback_url
       hour = opts.fetch :hour
       days = opts.fetch(:days, Date::DAYNAMES)
-      timezone = opts.fetch(:timezone, 'UTC')
+      timezone = opts.fetch(:timezone, "UTC")
       retain_weeks = opts.delete(:retain_weeks)
       retain_months = opts.delete(:retain_months)
 
-      [ :name, :callback_url, :hour, :days, :timezone ].each { |key| opts.delete key }
+      [:name, :callback_url, :hour, :days, :timezone].each { |key| opts.delete key }
       unless opts.empty?
         raise ArgumentError, "Unsupported option(s): #{opts.keys}"
       end
@@ -164,7 +218,7 @@ module Xfrtuc
                      callback_url: callback_url,
                      hour: hour,
                      days: days,
-                     timezone: timezone }
+                     timezone: timezone, }
       sched_opts[:retain_weeks] = retain_weeks unless retain_weeks.nil?
       sched_opts[:retain_months] = retain_months unless retain_months.nil?
 

data/spec/spec_helper.rb

@@ -1,24 +1,26 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+# frozen_string_literal: true
 
-require 'bundler'
-require 'xfrtuc'
+require "simplecov"
+SimpleCov.start
 
-RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
+require "bundler"
+require "date"
+require "xfrtuc"
+require "webmock/rspec"
 
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = 'random'
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
 
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
   end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.disable_monkey_patching!
+  config.warnings = true
+  config.order = :random
+  Kernel.srand config.seed
 end