heroku-api-postgres 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c90ef28a844e1ea19534eeb565472875bbb8c049c19075bad257198a2ec00a5
-  data.tar.gz: 7d185232a2d4667c267326948ada22bddf479b196825e7a67e1398f789626d66
+  metadata.gz: c56338fe1245b0057948e9e73ae0acc50189c919179ff5a14b639acc65c70107
+  data.tar.gz: 1a9f93ce79cb56ee9acf15cabcd6801b5ae40799be3b8edf14c46f7ad54470d4
 SHA512:
-  metadata.gz: f776c9d1aeb9e6fc4bae092a6b11d9d5db88376a33932fc1e3b315262a44d5b762a971cc0ab0945c53fad4ae421bfce14629d9e0d01457aefdb2fab7c730190f
-  data.tar.gz: b05b444642bca56f8d69f2bb09a109c87c080a761b7fa85f13376c0a139689a4a3689f461a72af9bb345c761282f9bbc2651d5b20e3ab2990b94247135083c74
+  metadata.gz: 549f65ec6c17141d3c1c819ec125112ef739df449f2a9cefdf61bf7f4af11346cda3ab939d99712171192c6a6a6d3b7aa8412096d43c1f1b5f98dda8534e281e
+  data.tar.gz: 124fc6dfcbef2aca4476ad24f6c5aaf00e8a5236e2a0fa9fe4e0bce0bc31018de78ed9531104dc91545eb7b6e378ba853c65888499a1bc50ee1b69de0dea65c0

data/.example.env

@@ -1,5 +1,6 @@
 HEROKU_OAUTH_TOKEN=a_valid_oauth_token
 VALID_APP_ID_WITH_DATABASE=valid_app_id_with_database
 VALID_DATABASE_ID_WITH_SCHEDULES=a_valid_database_id_with_a_schedule
+VALID_DATABASE_ID_WITH_PRO_PLAN=a_valid_database_id_with_a_pro_plan
 VALID_APP_ID=valid_app_id
 VALID_DUMP_URL=valid_dump_public_url

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    heroku-api-postgres (0.9.0)
+    heroku-api-postgres (0.10.0)
+      platform-api
 
 GEM
   remote: https://rubygems.org/
@@ -12,38 +13,52 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    dotenv (2.2.1)
+    dotenv (2.5.0)
+    erubis (2.7.0)
+    excon (0.62.0)
     hashdiff (0.3.7)
+    heroics (0.0.25)
+      erubis (~> 2.0)
+      excon
+      moneta
+      multi_json (>= 1.9.2)
+    jaro_winkler (1.5.1)
+    moneta (1.0.0)
+    multi_json (1.13.1)
     parallel (1.12.1)
-    parser (2.5.0.2)
+    parser (2.5.3.0)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
-    public_suffix (3.0.2)
+    platform-api (2.2.0)
+      heroics (~> 0.0.25)
+      moneta (~> 1.0.0)
+    powerpack (0.1.2)
+    public_suffix (3.0.3)
     rainbow (3.0.0)
     rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.52.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.4.0.2, < 3.0)
+      parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
     safe_yaml (1.0.4)
-    unicode-display_width (1.3.0)
+    unicode-display_width (1.4.0)
     vcr (4.0.0)
     webmock (3.3.0)
       addressable (>= 2.3.6)
@@ -54,14 +69,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 1.17)
   dotenv
   heroku-api-postgres!
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop (= 0.52.1)
+  rubocop (= 0.60.0)
   vcr (~> 4.0.0)
   webmock (~> 3.3.0)
 
 BUNDLED WITH
-   1.16.2
+   1.17.1

data/README.md

@@ -34,20 +34,13 @@ Or install it yourself as:
 
 ## Usage
 
-Even if this gem does not require `platform-api` to be installed, you probably want to have it installed as well.
-
-```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
+This gem client needs to be instantiated in a similar way to the PlatformAPI
 
 ```ruby
 postgres_api_client = Heroku::Api::Postgres.connect_oauth(ENV['HEROKU_OAUTH_TOKEN'])
 ```
 
-Look into [Models](docs/models.rb) for a detailed description of the JSON objects returned by the APIs.
+Look into [Models](docs/models.md) for a detailed description of the JSON objects returned by the APIs.
 Those are the bare objects returned by the official Heroku API.
 
 ### Databases
@@ -69,11 +62,11 @@ returns a [Database](docs/models.md#database).
 ```ruby
 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).
 
-
 ### Backups
 
 ```ruby
@@ -103,7 +96,7 @@ The app_id can be either the name of your heroku app or the id.
 ---
 
 ```ruby
-schedules = backups_client.schedules(database_id)
+schedules = backups_client.schedules(app_id, database_id)
 ```
 
 Returns all the backup schedules associated with the database.
@@ -113,7 +106,7 @@ Returns an array of [Schedule](docs/models.md#schedule)
 ---
 
 ```ruby
-schedule = backups_client.schedule(database_id)
+schedule = backups_client.schedule(app_id, database_id)
 ```
 
 Schedules the backups at 00:00 UTC.
@@ -124,7 +117,7 @@ Returns a [Schedule](docs/models.md#schedule)
 
 
 ```ruby
-backup = backups_client.capture(database_id)
+backup = backups_client.capture(app_id, database_id)
 ```
 Captures a new backup for the given database
 
@@ -142,7 +135,7 @@ Returns a [BackupUrl](docs/models.md#backup_url)
 ---
 
 ```ruby
-backup = backups_client.restore(database_id, dump_url)
+backup = backups_client.restore(app_id, database_id, dump_url)
 ```
 Restores a dump from a public URL.
 
@@ -180,7 +173,9 @@ Check also the [Offical API](https://devcenter.heroku.com/articles/platform-api-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
-Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Then, run `rake spec` to run the tests. 
+You can run `bin/check` to run linter and the tests together.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
@@ -200,4 +195,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Heroku::Api::Postgres project’s codebases, issue trackers, chat rooms and mailing lists is
-expected to follow the [code of conduct](https://github.com/[USERNAME]/heroku-api-postgres/blob/master/CODE_OF_CONDUCT.md).
+expected to follow the [code of conduct](https://github.com/coorasse/heroku-api-postgres/blob/master/CODE_OF_CONDUCT.md).

data/bin/check

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -e
+
+bundle exec rubocop -a
+
+bundle exec rake spec

data/heroku-api-postgres.gemspec

@@ -1,5 +1,4 @@
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'heroku/api/postgres/version'
 
@@ -21,11 +20,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_dependency 'platform-api'
+  spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '0.52.1'
+  spec.add_development_dependency 'rubocop', '0.60.0'
   spec.add_development_dependency 'vcr', '~> 4.0.0'
   spec.add_development_dependency 'webmock', '~> 3.3.0'
 end

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

@@ -1,5 +1,6 @@
 require 'net/http'
 require 'json'
+require 'platform-api'
 
 module Heroku
   module Api
@@ -20,19 +21,20 @@ module Heroku
           @client.perform_get_request("/client/v11/apps/#{app_id}/transfers/#{backup_id}")
         end
 
-        def schedules(database_id)
-          @client.perform_get_request("/client/v11/databases/#{database_id}/transfer-schedules")
+        def schedules(app_id, database_id)
+          @client.perform_get_request("/client/v11/databases/#{database_id}/transfer-schedules",
+                                      host: db_host(app_id))
         end
 
-        def schedule(database_id)
+        def schedule(app_id, database_id)
           @client.perform_post_request("/client/v11/databases/#{database_id}/transfer-schedules",
-                                       hour: 00,
-                                       timezone: 'UTC',
-                                       schedule_name: 'DATABASE_URL')
+                                       { hour: 0o0,
+                                         timezone: 'UTC',
+                                         schedule_name: 'DATABASE_URL' }, host: db_host(app_id))
         end
 
-        def capture(database_id)
-          @client.perform_post_request("/client/v11/databases/#{database_id}/backups")
+        def capture(app_id, database_id)
+          @client.perform_post_request("/client/v11/databases/#{database_id}/backups", {}, host: db_host(app_id))
         end
 
         def url(app_id, backup_num)
@@ -40,17 +42,37 @@ module Heroku
         end
 
         def wait(app_id, backup_id, options = { wait_interval: 3 })
-          while true do
+          backup = nil
+          loop do
             backup = info(app_id, backup_id)
             yield(backup) if block_given?
-            break if backup[:finished_at] && backup[:succeeded]
+            break if backup[:finished_at]
+
             sleep(options[:wait_interval])
           end
           backup
         end
 
-        def restore(database_id, backup_url)
-          @client.perform_post_request("/client/v11/databases/#{database_id}/restores", backup_url: backup_url)
+        def restore(app_id, database_id, backup_url)
+          @client.perform_post_request("/client/v11/databases/#{database_id}/restores",
+                                       { backup_url: backup_url }, host: db_host(app_id))
+        end
+
+        private
+
+        def databases
+          @databases ||= Databases.new(@client)
+        end
+
+        def db_host(app_id)
+          database = heroku_client.addon.list_by_app(app_id).find do |addon|
+            addon['addon_service']['name'] == 'heroku-postgresql'
+          end
+          databases.host_for(database)
+        end
+
+        def heroku_client
+          @heroku_client ||= PlatformAPI.connect_oauth(@client.oauth_client_key)
         end
       end
     end

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

@@ -6,9 +6,11 @@ module Heroku
       end
 
       class Client
+        attr_reader :oauth_client_key
+
         def initialize(oauth_client_key)
           @oauth_client_key = oauth_client_key
-          @basic_url = 'https://postgres-starter-api.heroku.com'
+          @basic_url = Databases::STARTER_HOST
         end
 
         def backups
@@ -19,38 +21,30 @@ module Heroku
           @databases ||= Databases.new(self)
         end
 
-        def perform_get_request(path)
-          url = build_uri(path)
+        def perform_get_request(path, options = {})
+          url = build_uri(path, options)
           req = Net::HTTP::Get.new(url)
-          set_headers(req)
+          add_auth_headers(req)
           response = start_request(req, url)
           parse_response(response)
         end
 
-        def perform_post_request(path, params = {})
-          url = build_uri(path)
+        def perform_post_request(path, params = {}, options = {})
+          url = build_uri(path, options)
           req = Net::HTTP::Post.new(url)
-          set_headers(req)
+          add_auth_headers(req)
           req.body = params.to_json
           response = start_request(req, url)
           parse_response(response)
         end
 
-        def host_for(database)
-          starter_plan?(database) ? 'https://postgres-starter-api.heroku.com' : 'https://postgres-api.heroku.com'
-        end
-
-        def starter_plan?(database)
-          database[:plan].match(/(dev|basic)$/)
-        end
-
         private
 
         def build_uri(path, host: @basic_url)
           URI.join(host, path)
         end
 
-        def set_headers(req)
+        def add_auth_headers(req)
           req['Accept'] = 'application/vnd.heroku+json; version=3'
           req.basic_auth '', @oauth_client_key
         end
@@ -58,7 +52,7 @@ module Heroku
         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) }
+          http_new.start { |http| http.request(req) }
         end
 
         def parse_response(response)

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

@@ -5,6 +5,9 @@ module Heroku
   module Api
     module Postgres
       class Databases
+        STARTER_HOST = 'https://postgres-starter-api.heroku.com'.freeze
+        PRO_HOST = 'https://postgres-api.heroku.com'.freeze
+
         def initialize(client)
           @client = client
         end
@@ -13,9 +16,10 @@ module Heroku
         # perform_get_request "/client/v11/databases/#{database_id}/wait_status"
         def wait(database_id, options = { wait_interval: 3 })
           waiting = true
-          while waiting do
+          while waiting
             database = info(database_id)
             break unless database[:waiting?]
+
             sleep(options[:wait_interval])
           end
           database
@@ -24,6 +28,14 @@ module Heroku
         def info(database_id)
           @client.perform_get_request("/client/v11/databases/#{database_id}")
         end
+
+        def host_for(database)
+          starter_plan?(database) ? STARTER_HOST : PRO_HOST
+        end
+
+        def starter_plan?(database)
+          database['plan']['name'].match(/(dev|basic)$/)
+        end
       end
     end
   end

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

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

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: heroku-api-postgres
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-07 00:00:00.000000000 Z
+date: 2019-01-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: platform-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: 0.60.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: 0.60.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +140,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/check
 - bin/console
 - bin/setup
 - docs/models.md
@@ -156,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby library to invoke Heroku Postgres APIs