ionoscloud-dbaas-postgres 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3810993a5be1481231747c0377fbc70f4aae591d1bda0fddb68d25bbe453cdb2
+  data.tar.gz: 991b5e19058c36248090c37ec6f8504f8fca80bf967fcab52ac7e05803363532
+SHA512:
+  metadata.gz: 8fc750c4d1fde1351dd22df0efd5d48c6a9e07575cb37b7b437f7dd8fed923540a2faf7855e65ded90d01cea2c8b6ebcf5b79326be504e7c2a37af019eb79487
+  data.tar.gz: c49cd74140ddd263f5a80f49abcc633c731d6bf960f29cf35c559f8c34fec2270022feaf5094fb9df876b38d85443d6de2c6fb874514b404ebb55fa7a76bc738

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    ionoscloud-dbaas-postgres (1.0.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.4)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (4.0.3)
+      stringio
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.11.0)
+    stringio (3.0.1)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  ionoscloud-dbaas-postgres!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.3.4

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,65 @@
+![CI Ruby DBaaS Postgres](https://github.com/ionos-cloud/sdk-resources/workflows/[%20CI%20]%20DBaaS%20Postgres%20/%20Ruby/badge.svg)
+[![Gem Version](https://img.shields.io/gem/v/ionoscloud-dbaas-postgres)](https://rubygems.org/gems/ionoscloud-dbaas-postgres) 
+[![Gitter](https://badges.gitter.im/ionos-cloud/sdk-general.png)](https://gitter.im/ionos-cloud/sdk-general)
+
+![Alt text](.github/IONOS.CLOUD.BLU.svg?raw=true "Title")
+
+# ionoscloud-dbaas-postgres
+
+IonoscloudDbaasPostgres - the Ruby gem for the IONOS DBaaS REST API
+
+An enterprise-grade Database is provided as a Service (DBaaS) solution that
+can be managed through a browser-based \"Data Center Designer\" (DCD) tool or
+via an easy to use API.
+
+The API allows you to create additional database clusters or modify existing
+ones. It is designed to allow users to leverage the same power and
+flexibility found within the DCD visual tool. Both tools are consistent with
+their concepts and lend well to making the experience smooth and intuitive.
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.0.1
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build ionoscloud-dbaas-postgres.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./ionoscloud-dbaas-postgres-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./ionoscloud-dbaas-postgres-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'ionoscloud-dbaas-postgres', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres, then add the following in the Gemfile:
+
+    gem 'ionoscloud-dbaas-postgres', :git => 'https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Our latest, most up to date documentation is available [here](https://docs.ionos.com/ruby-sdk-dbaas-postgres/)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/README.md

@@ -0,0 +1,163 @@
+# Introduction
+
+## Overview
+
+An enterprise-grade Database is provided as a Service (DBaaS) solution that
+can be managed through a browser-based \"Data Center Designer\" (DCD) tool or
+via an easy to use API.
+
+The API allows you to create additional database clusters or modify existing
+ones. It is designed to allow users to leverage the same power and
+flexibility found within the DCD visual tool. Both tools are consistent with
+their concepts and lend well to making the experience smooth and intuitive.
+
+## Getting Started
+
+### Instalation
+
+### 1. Build a gem
+
+To build the Ruby code into a gem:
+
+```text
+gem build ionoscloud-dbaas-postgres.gemspec
+```
+
+Then either install the gem locally:
+
+```text
+gem install ./ionoscloud-dbaas-postgres-<gem-version>.gem
+```
+
+\(for development, run `gem install --dev ./ionoscloud-dbaas-postgres-<gem-version>.gem` to install the development dependencies\)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+```text
+gem 'ionoscloud-dbaas-postgres', '~> <gem-version>'
+```
+
+### 2. Install from Git
+
+If the Ruby gem is hosted at a git repository: [https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres](https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres), then add the following in the Gemfile:
+
+```text
+gem 'ionoscloud-dbaas-postgres', :git => 'https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres.git'
+```
+
+### 3. Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```text
+ruby -Ilib script.rb
+```
+
+### 4. Install from RubyGems
+
+Just add this to the Gemfile:
+
+```text
+gem 'ionoscloud-dbaas-postgres', '~> <gem-version>'
+```
+
+### After installing please run the following code:
+
+```ruby
+# Load the gem
+require 'ionoscloud-dbaas-postgres'
+
+# Setup authorization
+IonoscloudDbaasPostgres.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = IonoscloudDbaasPostgres::DefaultApi.new
+opts = {
+  pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
+  depth: 56, # Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
+  x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+}
+
+begin
+  #Display API information
+  result = api_instance.api_info_get(opts)
+  p result
+rescue IonoscloudDbaasPostgres::ApiError => e
+  puts "Exception when calling DefaultApi->api_info_get: #{e}"
+end
+```
+
+### Authentication
+
+The username and password or the authentication token can be manually specified when initializing the SDK client:
+
+```ruby
+IonoscloudDbaasPostgres.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+```
+
+Environment variables can also be used for initialization. For example:
+
+```ruby
+IonoscloudDbaasPostgres.configure do |config|
+  config.username = ENV['IONOS_USERNAME']
+  config.password = ENV['IONOS_PASSWORD']
+  config.api_key['Authorization'] = ENV['IONOS_TOKEN']
+end
+```
+
+{% hint style="danger" %}
+**Warning**: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.
+{% endhint %}
+
+### Changing the base URL
+
+Base URL for the HTTP operation can be changed in the following way:
+
+```ruby
+IonoscloudDbaasPostgres.configure do |config|
+  config.username = ENV['IONOS_USERNAME']
+  config.password = ENV['IONOS_PASSWORD']
+
+  # Configure the url used by the SDK
+  config.host = 'https://api.ionos.com/databases/postgresql'
+  # This must be set as well because of the way the API works, otherwise the set url will not be used
+  condif.server_index = nil
+end
+```
+
+## Feature Reference
+
+The IONOS Cloud SDK for Ruby aims to offer access to all resources in the IONOS Cloud API and also offers some additional features that make the integration easier:
+
+* authentication for API calls
+* handling of asynchronous requests 
+
+## FAQ
+
+1. How can I open a bug/feature request? 
+
+Bugs & feature requests can be open on the repository issues: [https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres/issues/new/choose](https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres/issues/new/choose)
+
+2. Can I contribute to the Ruby SDK?
+
+Pure SDKs are automatically generated using OpenAPI Generator and don’t support manual changes. If you need changes please open an issue and we’ll try to take care of it.
+