heroku-api-postgres 0.1.0.alpha1 → 0.1.0.alpha5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70ef3b3e8b9dcbb7ff26bb3ab2955139c37b2ac033d42659ebe5171b64a71b93
-  data.tar.gz: 3dd3c311b97514fd01d402f243714f5882586cf4043ee9fcaca9fc78cd2e86cb
+  metadata.gz: 35ae932c7a584955c98c5e5bd156f49fa6d99216700e6b8f7ea6c55d00977328
+  data.tar.gz: 061e27956266ba1cc8e6598ca5b9b38302fb793fe174e6128319ee797d91b295
 SHA512:
-  metadata.gz: 948656e81085acabfef33754d325d2c2d25cfecb58ecf921f07f83451909aa05d53bca1c64cde4e2803cfa1da3ae426739501b4c106a7c8fa566365d2bb844d0
-  data.tar.gz: 27d7e102d98ea4fd8eccd7d920d942014232a193c3c88294a13fe75f2cbe018dfc51212e20dbc6de0c4886949275857144904b67b0431b32ab0ed288f97328a7
+  metadata.gz: 17edfb6515f870a5094783950afefeab465a12a64921115e484def72d896f7e523afe21bf09d6df531e9d3cde1dfe0604660e255a8a6399a90b9cd92004e5e59
+  data.tar.gz: 92370ca4f9d1d7d13f05f12c03d703fd9e41d21af543eb16cd025dc02ab3cc6c9f1738f4f924787fc859c78c3ab8dc0d5ea5709511a7ccbc0d8bf203789b338d

data/Gemfile.lock

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

data/README.md

@@ -12,7 +12,9 @@ both this gem and the official Heroku CLI.
 
 Not all APIs are implemented at the moment but we are working hard on implementing all of them.
 
-Contributes and Pull Requests are welcome.
+Please check the [list of implemented and not implemented services](docs/services.md).
+
+Contributes and Pull Requests are welcome!
 
 ## Installation
 
@@ -49,6 +51,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
+
+```ruby
+databases = postgres_api_client.wait(database_id, wait_interval: 5)
+```
+
+Waits for the given database to be ready. Polls every `wait_interval` seconds (default 3).
+
+
+### Databases
+
+```ruby
+databases_client = postgres_api_client.database
+```
+
+#### Info
+
+```ruby
+database_info = databases_client.info(database_id)
+```
+
+returns a [Database](docs/models.md#database).
+
 ### Backups
 
 ```ruby
@@ -63,7 +88,9 @@ backups = backups_client.list(app_id)
 
 returns an array of [Backup](docs/models.md#backup).
 
-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)
+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
 
@@ -73,8 +100,29 @@ schedules = backups_client.schedules(database_id)
 
 returns an array of [Schedule](docs/models.md#schedule)
 
+### Schedule
+
+```ruby
+schedule = backups_client.schedule(database_id)
+```
+
+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)
+```
+
+returns a [Backup](docs/models.md#backup)
+
 
-To get the backup schedules of a database you need a database id. You can obtain a database id by calling the Heroku Platform API
+### How do I get the database_id ?
+You can obtain a database id by calling the Heroku Platform API
 
 ```ruby
 addons = heroku.addon.list

data/docs/models.md

@@ -28,6 +28,7 @@
     :waiting?=>false,
     :num_bytes=>959652012 }
 ```
+
 ## Backup
 
 ```ruby

data/docs/services.md

@@ -0,0 +1,96 @@
+# Heroku CLI Postgres commands
+
+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(database_id)`
+
+- [x] pg:backups --> `client.backups.list(app_id)`
+
+- [ ] pg:backups:cancel
+
+- [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
+
+- [ ] pg:backups:info
+
+- [ ] pg:backups:restore
+
+- [x] pg:backups:schedule --> `client.backups.schedule(database_id)`
+
+
+- [x] pg:backups:schedules --> `client.backups.schedules(database_id)`
+
+- [ ] pg:backups:unschedule
+
+- [ ] pg:backups:url
+
+- [ ] pg:connection-pooling:attach
+
+- [ ] pg:copy
+
+- [ ] pg:credentials
+
+- [ ] pg:credentials:create
+
+- [ ] pg:credentials:destroy
+
+- [ ] pg:credentials:repair-default
+
+- [ ] pg:credentials:rotate
+
+- [ ] pg:credentials:url
+
+- [ ] pg:diagnose
+
+- [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(database_id)`
+Waits for a database to be ready.

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

@@ -19,6 +19,17 @@ module Heroku
         def schedules(database_id)
           @client.perform_get_request("/client/v11/databases/#{database_id}/transfer-schedules")
         end
+
+        def schedule(database_id)
+          @client.perform_post_request("/client/v11/databases/#{database_id}/transfer-schedules",
+                                       hour: 00,
+                                       timezone: 'UTC',
+                                       schedule_name: 'DATABASE_URL')
+        end
+
+        def capture(database_id)
+          @client.perform_post_request("/client/v11/databases/#{database_id}/backups")
+        end
       end
     end
   end

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

@@ -1,7 +1,6 @@
 module Heroku
   module Api
     module Postgres
-
       def self.connect_oauth(oauth_client_key = ENV['HEROKU_OAUTH_TOKEN'])
         Client.new(oauth_client_key)
       end
@@ -12,29 +11,61 @@ 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
 
         def databases
-          @backups ||= Databases.new(self)
+          @databases ||= Databases.new(self)
         end
 
         def perform_get_request(path)
-          url = URI.join(@basic_url, path)
+          url = build_uri(path)
           req = Net::HTTP::Get.new(url)
+          set_headers(req)
+          response = start_request(req, url)
+          parse_response(response)
+        end
+
+        def perform_post_request(path, params = {})
+          url = build_uri(path)
+          req = Net::HTTP::Post.new(url)
+          set_headers(req)
+          req.body = params.to_json
+          response = start_request(req, url)
+          parse_response(response)
+        end
+
+        private
+        def build_uri(path)
+          URI.join(@basic_url, path)
+        end
+
+        def set_headers(req)
           req['Accept'] = 'application/vnd.heroku+json; version=3'
           req.basic_auth '', @oauth_client_key
+        end
+
+        def start_request(req, url)
           http_new = Net::HTTP.new(url.hostname, url.port)
           http_new.use_ssl = true
           response = http_new.start { |http| http.request(req) }
-          parse_response(response)
         end
 
-        private
-
         def parse_response(response)
-          if response.code == '200'
+          if %w[200 201].include? response.code
             JSON.parse(response.body, symbolize_names: true)
           else
             { error: { status: response.code.to_i } }

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

@@ -1,7 +1,7 @@
 module Heroku
   module Api
     module Postgres
-      VERSION = '0.1.0.alpha1'.freeze
+      VERSION = '0.1.0.alpha5'.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku-api-postgres
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha1
+  version: 0.1.0.alpha5
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-03 00:00:00.000000000 Z
+date: 2018-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,6 +129,7 @@ files:
 - bin/console
 - bin/setup
 - docs/models.md
+- docs/services.md
 - heroku-api-postgres.gemspec
 - lib/heroku/api/postgres.rb
 - lib/heroku/api/postgres/backups.rb