heroku-api-postgres 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '068c61e088f38f3f0aabf5e4a5d9778a3385e36f55602b96e284eddba4421529'
-  data.tar.gz: 4dd38fedf703df59c5817fadc0c8aba30ba5f8079fd3aa522229f6ba640a8bc4
+  metadata.gz: c3e288c214dd07ce53ec130af58ba3c9ecb29fde19862f80f6ede9e1d8b844ff
+  data.tar.gz: 6ffb07ca048f339b2563e8e07b2611589d1785ff0ba51e12f5f543753d0f078d
 SHA512:
-  metadata.gz: e213229069ed6becccfb9507a7fab2802bb99fc6011d44d1e38bced810ca4fd2fb95e0ff32a13f7fb4cc7c5d7d4223f91a48301709459e4e24aa51079fb8bd89
-  data.tar.gz: 065a0a1a12b149eb87147685de8c9ef013d89dcd4f4d830aec56295c2504d7c6b812b5b8bca0af646b0a0d4df20494022d7666105c327864cd8c666d11dd7b51
+  metadata.gz: 8e543d935c8f2bf2412894ff8eae50cdc33a18ca725b87a59f32f05b8ff9f859c0817f201c759509f7c35df5557eab3e58bd9d413bb64487ee810aad76d88c93
+  data.tar.gz: 9ac5dcc55c561c545d9ae74e1274f2c6c2574d7692c52a7928642312a99fdb4004461ac46f763ff752cf22cf590f4f5b727bad43e6b929f3093033e64a8132c0

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.14.0
+
+* [#24](https://github.com/coorasse/heroku-api-postgres/pull/24): **Breaking change**: Remove `app_id` from the following methods ([@hunchr]):
+  * `client.backups.capture(database_id)`
+  * `client.backups.restore(database_id, backup_url)`
+  * `client.backups.schedule(database_id)`
+  * `client.backups.schedules(database_id)`
+  * `client.credentials.rotate(database_id)`
+  * `client.databases.info(database_id)`
+  * `client.databases.wait(database_id)`
+
 ## 0.13.0
 
 * Update of dependencies and minimum ruby version set to 3.2.7. ([@coorasse][])
@@ -13,4 +24,5 @@
 [@avokhmin]: https://github.com/avokhmin
 [@deepakmahakale]: https://github.com/deepakmahakale
 [@louism517]: https://github.com/louism517
+[@hunchr]: https://github.com/hunchr
 [@coorasse]: https://github.com/coorasse

data/README.md

@@ -60,7 +60,7 @@ databases_client = postgres_api_client.databases
 ---
 
 ```ruby
-database_info = databases_client.info(app_id, database_id)
+database_info = databases_client.info(database_id)
 ```
 
 returns a [Database](docs/models.md#database).
@@ -68,7 +68,7 @@ returns a [Database](docs/models.md#database).
 ---
 
 ```ruby
-database = postgres_api_client.databases.wait(app_id, database_id, wait_interval: 5)
+database = postgres_api_client.databases.wait(database_id, wait_interval: 5)
 ```
 
 Waits for the given database to be ready.
@@ -84,7 +84,7 @@ credentials_client = postgres_api_client.credentials
 ---
 
 ```ruby
-credentials_client.rotate(app_id, database_id)
+credentials_client.rotate(database_id)
 ```
 
 Rotate the database credentials.
@@ -121,7 +121,7 @@ To retrieve the APP_ID and DATABASE_ID needed to run the tests you can use the n
 ---
 
 ```ruby
-schedules = backups_client.schedules(app_id, database_id)
+schedules = backups_client.schedules(database_id)
 ```
 
 Returns all the backup schedules associated with the database.
@@ -131,7 +131,7 @@ Returns an array of [Schedule](docs/models.md#schedule)
 ---
 
 ```ruby
-schedule = backups_client.schedule(app_id, database_id)
+schedule = backups_client.schedule(database_id)
 ```
 
 Schedules the backups at 00:00 UTC.
@@ -142,7 +142,7 @@ Returns a [Schedule](docs/models.md#schedule)
 
 
 ```ruby
-backup = backups_client.capture(app_id, database_id)
+backup = backups_client.capture(database_id)
 ```
 Captures a new backup for the given database
 
@@ -160,7 +160,7 @@ Returns a [BackupUrl](docs/models.md#backup_url)
 ---
 
 ```ruby
-backup = backups_client.restore(app_id, database_id, dump_url)
+backup = backups_client.restore(database_id, dump_url)
 ```
 Restores a dump from a public URL.
 

data/docs/services.md

@@ -3,98 +3,56 @@
 This list contains all postgres commands supported by the official CLI.
 Source: https://devcenter.heroku.com/articles/heroku-cli-commands
 
-- [x] pg --> `client.databases.info(app_id, database_id)`
-
+- [x] pg --> `client.databases.info(database_id)`
 - [x] pg:backups --> `client.backups.list(app_id)`
-
 - [ ] pg:backups:cancel
-
-- [x] pg:backups:capture ---> `client.backups.capture(app_id, database_id)`
+- [x] pg:backups:capture ---> `client.backups.capture(database_id)`
 The command returns immediately, without waiting for the capture to be completed.
 `--wait-interval` not implemented. `--snapshot` not implemented.
 
 - [ ] pg:backups:delete
-
 - [ ] pg:backups:download
-
 - [x] pg:backups:info --> `client.backups.info(app_id, backup_id)`
-
-- [x] pg:backups:restore --> `client.backups.restore(app_id, database_id, dump_url)`
+- [x] pg:backups:restore --> `client.backups.restore(database_id, backup_url)`
 The command works only with public URLs. It does not support all the features of the original
 `heroku pg:backups:restore` command, like restoring directly from another database.
 The command returns immediately, without waiting for the capture to be completed.
 You can use the command `client.backups.wait(app_id, restore[:num])` to wait for it to be ready.
 
-- [x] pg:backups:schedule --> `client.backups.schedule(app_id, database_id)`
-
-
-- [x] pg:backups:schedules --> `client.backups.schedules(app_id, database_id)`
-
+- [x] pg:backups:schedule --> `client.backups.schedule(database_id)`
+- [x] pg:backups:schedules --> `client.backups.schedules(database_id)`
 - [ ] pg:backups:unschedule
-
 - [x] pg:backups:url --> `client.backups.url(app_id, backup_num)`
-
 - [ ] pg:connection-pooling:attach
-
 - [ ] pg:copy
-
 - [ ] pg:credentials
-
 - [ ] pg:credentials:create
-
 - [ ] pg:credentials:destroy
-
 - [ ] pg:credentials:repair-default
-
-- [x] pg:credentials:rotate --> `client.credentials.rotate(app_id, database_id)`
-
+- [x] pg:credentials:rotate --> `client.credentials.rotate(database_id)`
 - [ ] pg:credentials:url
-
 - [ ] pg:diagnose
-
-- [x] pg:info --> `client.databases.info(app_id, database_id)`
-
+- [x] pg:info --> `client.databases.info(database_id)`
 - [ ] pg:kill
-
 - [ ] pg:killall
-
 - [ ] pg:links
-
 - [ ] pg:links:create
-
 - [ ] pg:links:destroy
-
 - [ ] pg:maintenance
-
 - [ ] pg:maintenance:run
-
 - [ ] pg:maintenance:window
-
 - [ ] pg:outliers
-
 - [ ] pg:promote
-
 - [ ] pg:ps
-
 - [ ] pg:psql
-
 - [ ] pg:pull
-
 - [ ] pg:push
-
 - [ ] pg:reset
-
 - [ ] pg:settings
-
 - [ ] pg:settings:log-lock-waits
-
 - [ ] pg:settings:log-min-duration-statement
-
 - [ ] pg:settings:log-statement
-
 - [ ] pg:unfollow
-
 - [ ] pg:upgrade
-
 - [x] pg:wait --> `client.wait(app_id, database_id)`
 Waits for a database to be ready.

data/lib/heroku/api/postgres/backups.rb

@@ -23,22 +23,19 @@ module Heroku
           @client.perform_get_request("/client/v11/apps/#{app_id}/transfers/#{backup_id}")
         end
 
-        def schedules(app_id, database_id)
-          @client.perform_get_request("/client/v11/databases/#{database_id}/transfer-schedules",
-                                      host: db_host(app_id, database_id))
+        def schedules(database_id)
+          @client.perform_get_request("/client/v11/databases/#{database_id}/transfer-schedules")
         end
 
-        def schedule(app_id, database_id, hour: 0o0, timezone: 'UTC')
+        def schedule(database_id, hour: 0, timezone: 'UTC')
           @client.perform_post_request("/client/v11/databases/#{database_id}/transfer-schedules",
                                        { hour: hour,
                                          timezone: timezone,
-                                         schedule_name: 'DATABASE_URL' }, host: db_host(app_id, database_id))
+                                         schedule_name: 'DATABASE_URL' })
         end
 
-        def capture(app_id, database_id, options = {})
-          @client.perform_post_request("/client/v11/databases/#{database_id}/backups",
-                                       options,
-                                       host: db_host(app_id, database_id))
+        def capture(database_id, options = {})
+          @client.perform_post_request("/client/v11/databases/#{database_id}/backups", options)
         end
 
         def url(app_id, backup_num = nil)
@@ -64,15 +61,9 @@ module Heroku
           backup
         end
 
-        def restore(app_id, database_id, backup_url)
+        def restore(database_id, backup_url)
           @client.perform_post_request("/client/v11/databases/#{database_id}/restores",
-                                       { backup_url: backup_url }, host: db_host(app_id, database_id))
-        end
-
-        private
-
-        def db_host(app_id, database_id)
-          @client.db_host(app_id, database_id)
+                                       { backup_url: backup_url })
         end
       end
     end

data/lib/heroku/api/postgres/client.rb

@@ -4,26 +4,24 @@ module Heroku
   module Api
     module Postgres
       def self.connect(api_key = ENV.fetch('HEROKU_API_KEY', nil))
-        Client.new(api_key).tap do |c|
+        Client.new.tap do |c|
+          c.api_key = api_key
           c.heroku_client = PlatformAPI.connect(api_key)
         end
       end
 
       def self.connect_oauth(oauth_client_key = ENV.fetch('HEROKU_OAUTH_TOKEN', nil))
-        Client.new(oauth_client_key).tap do |c|
+        Client.new.tap do |c|
+          c.oauth_client_key = oauth_client_key
           c.heroku_client = PlatformAPI.connect_oauth(oauth_client_key)
         end
       end
 
       class Client
-        STARTER_HOST = 'https://postgres-starter-api.heroku.com'
-        PRO_HOST = 'https://postgres-api.heroku.com'
+        attr_accessor :api_key, :api_host, :oauth_client_key, :heroku_client
 
-        attr_accessor :client_key, :heroku_client
-
-        def initialize(client_key)
-          @client_key = client_key
-          @basic_url = STARTER_HOST
+        def initialize
+          @api_host = 'https://postgres-api.heroku.com'
         end
 
         def backups
@@ -38,17 +36,6 @@ module Heroku
           @credentials ||= Credentials.new(self)
         end
 
-        # the database id matches the field `id` in pro plans and the field addon_service.id in free plans
-        def db_host(app_id, database_id)
-          all_addons = heroku_client.addon.list_by_app(app_id)
-          database_json = all_addons.find do |addon|
-            [addon['id'], addon['addon_service']['id']].include?(database_id)
-          end
-          return STARTER_HOST if database_json.nil?
-
-          host_for(database_json)
-        end
-
         def perform_get_request(path, options = {})
           url = build_uri(path, **options)
           req = Net::HTTP::Get.new(url)
@@ -68,21 +55,13 @@ module Heroku
 
         private
 
-        def host_for(database_json)
-          starter_plan?(database_json) ? STARTER_HOST : PRO_HOST
-        end
-
-        def starter_plan?(database)
-          database['plan']['name'].match(/(dev|basic)$/)
-        end
-
-        def build_uri(path, host: @basic_url)
+        def build_uri(path, host: api_host)
           URI.join(host, path)
         end
 
         def add_auth_headers(req)
           req['Accept'] = 'application/vnd.heroku+json; version=3'
-          req.basic_auth '', @client_key
+          req.basic_auth '', @oauth_client_key
         end
 
         def start_request(req, url)

data/lib/heroku/api/postgres/credentials.rb

@@ -17,16 +17,11 @@ module Heroku
         # @param app_id [String] the application name.
         # @param database_id [String] the database UUID.
         # @param name [String] the credential name to be rotated (default: `default`).
-        def rotate(app_id, database_id, name: 'default')
+        def rotate(database_id, name: 'default')
           path = "/postgres/v0/databases/#{database_id}/credentials" \
                  "/#{URI.encode_www_form_component(name)}/credentials_rotation"
-          @client.perform_post_request(path, {}, host: db_host(app_id, database_id))
-        end
-
-        private
 
-        def db_host(app_id, database_id)
-          @client.db_host(app_id, database_id)
+          @client.perform_post_request(path, {})
         end
       end
     end

data/lib/heroku/api/postgres/databases.rb

@@ -13,10 +13,10 @@ module Heroku
 
         # original call returns simply a database object, therefore I call the info API.
         # perform_get_request "/client/v11/databases/#{database_id}/wait_status"
-        def wait(app_id, database_id, options = { wait_interval: 3 })
+        def wait(database_id, options = { wait_interval: 3 })
           waiting = true
           while waiting
-            database = info(app_id, database_id)
+            database = info(database_id)
             break unless database[:waiting?]
 
             sleep(options[:wait_interval])
@@ -24,14 +24,8 @@ module Heroku
           database
         end
 
-        def info(app_id, database_id)
-          @client.perform_get_request("/client/v11/databases/#{database_id}", host: db_host(app_id, database_id))
-        end
-
-        private
-
-        def db_host(app_id, database_id)
-          @client.db_host(app_id, database_id)
+        def info(database_id)
+          @client.perform_get_request("/client/v11/databases/#{database_id}")
         end
       end
     end

data/lib/heroku/api/postgres/version.rb

@@ -3,7 +3,7 @@
 module Heroku
   module Api
     module Postgres
-      VERSION = '0.13.1'
+      VERSION = '0.14.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku-api-postgres
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-13 00:00:00.000000000 Z
+date: 2026-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: platform-api