heroku-api-postgres 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 994386180c6760b3296b0dca9340a474d4fbe82ff098520a21f901726b19f1f5
-  data.tar.gz: 3e007bb67207195fb2146c65413e9295815db7751f76ff853dcca6a4e96da424
+  metadata.gz: c7a09cc3fbeffddb666ebaf4aea6bcbaba6484444324fea9a9e1ebae90cdd60d
+  data.tar.gz: 37b4d464d7aa946682746bd681d249b734c25c7af135765a5918f1d602871b5b
 SHA512:
-  metadata.gz: f3a8cdfddbfcc463f30058487aa1dcaa271245b169e2f558de0e689e287c3bc57dda924ed77c88d151c7282a5392270d1d0cdbdf314efc13fa6d7d7747579a14
-  data.tar.gz: 94b4d88e580171e0edefc346207cc8e5a48fb47259c2e1930b49275cc4cdc1e0527c6cd75f542221085c97d49b9e9e065d51d4c39358515c4022a8eec2475097
+  metadata.gz: c993332ae8a356df764756757fcedf7d49aa434c8798272ace192615efe69df3af8e02ecc7e7d0d0ea6f9f44ca5a83d77ec1acaef728f3a8ab24e1ee3270bf0b
+  data.tar.gz: 0cf779f3a5dc93ce0b908d1cdc02e086fae30c993d71b1c5020ae2ab27f4ca22f11832ee2e71e2a2e7dcc3ecb9acca33fb90358ddfec769e623f97cda2e2607e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    heroku-api-postgres (0.7.0)
+    heroku-api-postgres (0.8.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -39,7 +39,6 @@ Even if this gem does not require `platform-api` to be installed, you probably w
 ```ruby
 # from platform api gem
 platform_api_client = PlatformAPI.connect_oauth(ENV['HEROKU_OAUTH_TOKEN'])
-
 ```
 
 this gem client needs to be instantiated as well in a similar way
@@ -51,28 +50,29 @@ postgres_api_client = Heroku::Api::Postgres.connect_oauth(ENV['HEROKU_OAUTH_TOKE
 Look into [Models](docs/models.rb) for a detailed description of the JSON objects returned by the APIs.
 Those are the bare objects returned by the official Heroku API.
 
-#### Wait
+### Databases
 
 ```ruby
-databases = postgres_api_client.wait(database_id, wait_interval: 5)
+databases_client = postgres_api_client.databases
 ```
 
-Waits for the given database to be ready. Polls every `wait_interval` seconds (default 3).
-
-
-### Databases
+---
 
 ```ruby
-databases_client = postgres_api_client.database
+database_info = databases_client.info(database_id)
 ```
 
-#### Info
+returns a [Database](docs/models.md#database).
+
+---
 
 ```ruby
-database_info = databases_client.info(database_id)
+database = postgres_api_client.databases.wait(database_id, wait_interval: 5)
 ```
+Waits for the given database to be ready.
+
+Polls every `wait_interval` seconds (default 3).
 
-returns a [Database](docs/models.md#database).
 
 ### Backups
 
@@ -80,7 +80,7 @@ returns a [Database](docs/models.md#database).
 backups_client = postgres_api_client.backups
 ```
 
-#### Info
+---
 
 ```ruby
 backups = backups_client.info(app_id, backup_id)
@@ -88,7 +88,7 @@ backups = backups_client.info(app_id, backup_id)
 
 returns a [Backup](docs/models.md#backup).
 
-#### List
+---
 
 ```ruby
 backups = backups_client.list(app_id)
@@ -100,15 +100,17 @@ The app_id can be either the name of your heroku app or the id.
 
 [Check official API](https://devcenter.heroku.com/articles/platform-api-reference#app)
 
-#### Schedules
+---
 
 ```ruby
 schedules = backups_client.schedules(database_id)
 ```
 
-returns an array of [Schedule](docs/models.md#schedule)
+Returns all the backup schedules associated with the database.
 
-### Schedule
+Returns an array of [Schedule](docs/models.md#schedule)
+
+---
 
 ```ruby
 schedule = backups_client.schedule(database_id)
@@ -118,25 +120,33 @@ Schedules the backups at 00:00 UTC.
 
 Returns a [Schedule](docs/models.md#schedule)
 
+---
 
-#### Capture
-Captures a new backup for the given database
 
 ```ruby
 backup = backups_client.capture(database_id)
 ```
+Captures a new backup for the given database
 
-returns a [Backup](docs/models.md#backup)
+Returns a [Backup](docs/models.md#backup)
 
-#### Url
+
+```ruby
+backup_url = backups_client.url(app_id, backup_num)
+```
 Returns a temporary, public accessible URL to download a backup.
 Needs the `num` attribute of a Backup.
 
+Returns a [BackupUrl](docs/models.md#backup_url)
+
+---
+
 ```ruby
-backup_url = backups_client.url(app_id, backup_num)
+backup = postgres_api_client.backups.wait(app_id, backup_id, wait_interval: 5)
 ```
+Waits for the given backup to be ready.
 
-returns a [BackupUrl](docs/models.md#backup_url)
+Polls every `wait_interval` seconds (default 3).
 
 
 ### How do I get the database_id ?

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

@@ -38,6 +38,16 @@ module Heroku
         def url(app_id, backup_num)
           @client.perform_post_request("/client/v11/apps/#{app_id}/transfers/#{backup_num}/actions/public-url")
         end
+
+        def wait(app_id, backup_id, options = { wait_interval: 3 })
+          waiting = true
+          while waiting do
+            backup = info(app_id, backup_id)
+            break if backup[:finished_at] && backup[:succeeded]
+            sleep(options[:wait_interval])
+          end
+          backup
+        end
       end
     end
   end

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

@@ -11,18 +11,6 @@ module Heroku
           @basic_url = 'https://postgres-starter-api.heroku.com'
         end
 
-        # 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(database_id, options = { wait_interval: 3 })
-          waiting = true
-          while waiting do
-            database = databases.info(database_id)
-            break unless database[:waiting?]
-            sleep(options[:wait_interval])
-          end
-          database
-        end
-
         def backups
           @backups ||= Backups.new(self)
         end

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

@@ -9,6 +9,18 @@ module Heroku
           @client = client
         end
 
+        # 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(database_id, options = { wait_interval: 3 })
+          waiting = true
+          while waiting do
+            database = info(database_id)
+            break unless database[:waiting?]
+            sleep(options[:wait_interval])
+          end
+          database
+        end
+
         def info(database_id)
           @client.perform_get_request("/client/v11/databases/#{database_id}")
         end

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

@@ -1,7 +1,7 @@
 module Heroku
   module Api
     module Postgres
-      VERSION = '0.7.0'.freeze
+      VERSION = '0.8.0'.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku-api-postgres
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler