heroku-api-postgres 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33fc320b5b73a7a140e6af276b8f7f69b9ae4ef97170edf19e462fab253991db
-  data.tar.gz: 14d7757c4b7a78e5f9a5cc7da37143c808d83622374fd333303eebedeecbe5b5
+  metadata.gz: 96105ebed19f8f800dfb2dc71a8ce22d58feac51f07e7ea6963b64558c7eaea9
+  data.tar.gz: 34aea14eb3bf6b0639f3f66f93b9a42862e564e8d106b4c1de7fa8fb00c2561c
 SHA512:
-  metadata.gz: bfaaa61d427515bec615afb3bc59dfe7950238654e497e9784fd6965a0bc4b5ca2fec3a9388648644fa94d7f9dd7a1bbee4e2c05b47f02bbc115fe965262beef
-  data.tar.gz: 5503f7c5feda7c5cddbad119efccba8370e2a90117ffa30101f90317871c04cb501b715febbdf1f3e215788d3850d0e888434b261c7605a0f39fa56386f8ac23
+  metadata.gz: 9006afb4de11724c4f3b57fb9ecb19cc09b51361cdc1dd9d157fd3123f339f83321bbc8be1ce9f2dc1ee17d2398ca9f23edbe67cec940caa1b8a63bd262568cb
+  data.tar.gz: 80e566c5ee325a112cec56a3af719ef996759482f165122b059d743389dbf1292b0f30c41d2c70f1625fa09a678778f80f3eca54240fe47c05ff55cdaa527911

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  push:
+
+jobs:
+  lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+
+      - name: Setup env variables
+        run: cp .example.env .env
+
+      - name: Tests
+        run: bin/check

data/.rubocop.yml

@@ -1,7 +1,11 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
 Style/Documentation:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 Metrics/BlockLength:

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+3.2.7

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.13.0
+
+* Update of dependencies and minimum ruby version set to 3.2.7. ([@coorasse][])
+* Allow to connect using an API Key. ([@coorasse][])
+
 ## 0.12.0
 
 * [#18](https://github.com/coorasse/heroku-api-postgres/pull/18): Support ruby 3.0. ([@louism517][])
@@ -8,3 +13,4 @@
 [@avokhmin]: https://github.com/avokhmin
 [@deepakmahakale]: https://github.com/deepakmahakale
 [@louism517]: https://github.com/louism517
+[@coorasse]: https://github.com/coorasse

data/Gemfile

@@ -6,3 +6,12 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in heroku-api-postgres.gemspec
 gemspec
+
+gem 'bundler', '~> 2'
+gem 'dotenv'
+gem 'pry'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '1.74.0'
+gem 'vcr', '~> 6.3'
+gem 'webmock', '~> 3.25'

data/README.md

@@ -7,9 +7,6 @@
 Ruby library to invoke Heroku Postgres APIs.
 An extension to the official [Platform API](https://github.com/heroku/platform-api) gem to introduce the missing APIs for Postgres.
 
-[![Build Status](https://travis-ci.org/coorasse/heroku-api-postgres.svg?branch=master)](https://travis-ci.org/coorasse/heroku-api-postgres)
-[![Maintainability](https://api.codeclimate.com/v1/badges/4eead5d8263c37498953/maintainability)](https://codeclimate.com/github/coorasse/heroku-api-postgres/maintainability)
-
 **This gem is not officialy supported**. We use the same APIs that the offical Heroku Toolbelt uses,
 therefore is unrealistic that a breaking change in the APIs would break it, since it means it would break
 both this gem and the official Heroku CLI.
@@ -40,7 +37,12 @@ Or install it yourself as:
 ## Usage
 
 This gem client needs to be instantiated in a similar way to the [PlatformAPI](https://github.com/heroku/platform-api).
-You can use the same oauth key that you use for the PlatformAPI.
+You can use the same oauth key or API key that you use for the PlatformAPI.
+
+```ruby
+postgres_api_client = Heroku::Api::Postgres.connect(ENV['HEROKU_API_KEY'])
+```
+
 
 ```ruby
 postgres_api_client = Heroku::Api::Postgres.connect_oauth(ENV['HEROKU_OAUTH_TOKEN'])
@@ -113,6 +115,9 @@ 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)
 
+To retrieve the APP_ID and DATABASE_ID needed to run the tests you can use the name of the app as APP_ID and execute:
+`heroku addons --json --app YOUR_APP` to retrieve the DATABASE_ID.
+
 ---
 
 ```ruby
@@ -209,14 +214,7 @@ and push the `.gem` file to [rubygems.org](https://rubygems.org).
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/coorasse/heroku-api-postgres.
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
-the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## 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/coorasse/heroku-api-postgres/blob/master/CODE_OF_CONDUCT.md).

data/heroku-api-postgres.gemspec

@@ -15,25 +15,20 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/coorasse/heroku-api-postgres'
   spec.license       = 'MIT'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/coorasse/heroku-api-postgres"
-  spec.metadata["changelog_uri"] = "https://github.com/coorasse/heroku-api-postgres/blob/main/CHANGELOG.md"
-  spec.metadata["funding_uri"] = "https://github.com/sponsors/coorasse"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/coorasse/heroku-api-postgres'
+  spec.metadata['changelog_uri'] = 'https://github.com/coorasse/heroku-api-postgres/blob/main/CHANGELOG.md'
+  spec.metadata['funding_uri'] = 'https://github.com/sponsors/coorasse'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 3.2.0'
 
   spec.add_dependency 'platform-api'
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'dotenv'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '0.60.0'
-  spec.add_development_dependency 'vcr', '~> 4.0.0'
-  spec.add_development_dependency 'webmock', '~> 3.3.0'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

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

@@ -35,9 +35,9 @@ module Heroku
                                          schedule_name: 'DATABASE_URL' }, host: db_host(app_id, database_id))
         end
 
-        def capture(app_id, database_id)
+        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))
         end
 

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

@@ -3,20 +3,28 @@
 module Heroku
   module Api
     module Postgres
-      def self.connect_oauth(oauth_client_key = ENV['HEROKU_OAUTH_TOKEN'])
-        Client.new(oauth_client_key)
+      def self.connect(api_key = ENV.fetch('HEROKU_API_KEY', nil))
+        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.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_reader :oauth_client_key, :heroku_client
+        attr_accessor :api_key, :oauth_client_key, :heroku_client
 
-        def initialize(oauth_client_key)
-          @oauth_client_key = oauth_client_key
+        def initialize
           @basic_url = STARTER_HOST
-          @heroku_client = PlatformAPI.connect_oauth(oauth_client_key)
         end
 
         def backups

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

@@ -3,7 +3,7 @@
 module Heroku
   module Api
     module Postgres
-      VERSION = '0.12.0'
+      VERSION = '0.13.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku-api-postgres
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-23 00:00:00.000000000 Z
+date: 2025-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: platform-api
@@ -24,118 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.60.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.60.0
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.3.0
 description: Ruby library to invoke Heroku Postgres APIs
 email:
 - coorasse@gmail.com
@@ -145,15 +33,13 @@ extra_rdoc_files: []
 files:
 - ".example.env"
 - ".github/FUNDING.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/check
@@ -176,6 +62,7 @@ metadata:
   source_code_uri: https://github.com/coorasse/heroku-api-postgres
   changelog_uri: https://github.com/coorasse/heroku-api-postgres/blob/main/CHANGELOG.md
   funding_uri: https://github.com/sponsors/coorasse
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -184,14 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Ruby library to invoke Heroku Postgres APIs

data/.travis.yml

@@ -1,7 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.0
-before_install: gem install bundler -v 1.16.1
-before_script:
-  - cp .example.env .env

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at alessandro.rodi@renuo.ch. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 Alessandro Rodi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.