droplet_kit 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4472877cc1bfc802ea73e98933fe24bab2adddf4c1eafc6f0f36a0a82acea0f7
-  data.tar.gz: 88cc28e10a85151390521ad93482e758f83068139c4eeef17d84974f9989a01a
+  metadata.gz: 1bcc722fe43dcbe1053885290daaaa4760b68a24c0e5906a9c7a4bb5da3b76c5
+  data.tar.gz: a99ad56fff825502d3b22e610a3066f518e93c1a6a9dac5a323924492ad55ce6
 SHA512:
-  metadata.gz: 27521d0b8fd97888f25b7c18d716d70075e5f354ac66b1400fadbb0ad1be5c069ddc0555a893af4091d67593c37290e3db24c3d21f34dcf1b218e7be41a7254f
-  data.tar.gz: a0755dd5ed486a294b0f7ce8cb1fb8e9ae7c313c6c26162650fca966fd593dd0c37153270bbe007b52bb9045b9d036f3cd41348610a4019148e543038ac24c3f
+  metadata.gz: 2734100b49139ba6a695b23c81f86eaee262355db026e2c801334a55b3994b74f0711ea68b8c61d887f13f19ade1d21639251f1c6d6d03a97f5e8fa2ab72848d
+  data.tar.gz: 82ccd08bd1af12596baf0523c394aa019ec4fa00842cbfe69a145d97aa46f463ff6efef97761bec90cea8eb1e9584f8beec7b037dbe06fe20b7f4b4d8cd4bfe0

data/README.md

@@ -20,9 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-You'll need to generate an access token in Digital Ocean's control panel at https://cloud.digitalocean.com/settings/applications
+You'll need to generate an access token in DigitalOcean's control panel at https://cloud.digitalocean.com/settings/applications
 
-With your access token, retrieve a client instance with it.
+Using your access token, retrieve a client instance.
 
 ```ruby
 require 'droplet_kit'
@@ -125,6 +125,37 @@ Actions supported:
 * `client.certificates.create(certificate)`
 * `client.certificates.delete(id: 'id')`
 
+## Database resource
+
+```ruby
+client = DropletKit::Client.new(access_token: 'TOKEN')
+client.databases #=> DropletKit::DatabaseResource
+database_cluster = DropletKit::DatabaseCluster.new(
+  name: 'backend',
+  engine: 'pg',
+  version: '10',
+  region: 'nyc3',
+  size: 'db-s-2vcpu-4gb',
+  num_nodes: 2,
+  tags: ['production']
+)
+```
+
+Actions supported:
+
+* `client.databases.create_cluster(database_cluster)`
+* `client.databases.find_cluster(id: 'id')`
+* `client.databases.all_clusters()`
+* `client.databases.resize_cluster(database_cluster, id: 'id')`
+* `client.databases.migrate_cluster(database_cluster, id: 'id')`
+* `client.databases.update_maintenance_window(database_maintenance_window, id: 'id')`
+* `client.databases.list_backups(id: 'id')`
+* `client.databases.restore_from_backup(database_backup)`
+* `client.databases.delete_cluster()`
+* `client.database.create_db(database, id: 'id')`
+* `client.databases.find_db(id: 'id', name: 'name')`
+* `client.databases.all_dbs(id: 'id')`
+* `client.databases.delete_db(id: 'id', name: 'name')`
 
 ## Droplet resource
 

data/lib/droplet_kit/client.rb

@@ -32,6 +32,7 @@ module DropletKit
         cdns: CDNResource,
         certificates: CertificateResource,
         container_registry: ContainerRegistryResource,
+        databases: DatabaseResource,
         droplets: DropletResource,
         kubernetes_clusters: KubernetesClusterResource,
         kubernetes_options: KubernetesOptionsResource,

data/lib/droplet_kit/mappings/database_backup_mapping.rb

@@ -0,0 +1,13 @@
+module DropletKit
+  class DatabaseBackupMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping DatabaseBackup
+      root_key singular: 'backup', plural: 'backups', scopes: [:read]
+
+      property :created_at, scopes: [:read]
+      property :size_gigabytes, scopes: [:read]
+    end
+  end
+end

data/lib/droplet_kit/mappings/database_backup_restore_mapping.rb

@@ -0,0 +1,13 @@
+module DropletKit
+  class DatabaseBackupRestoreMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping DatabaseBackup
+      root_key singular: 'backup_restore', scopes: [:read]
+
+      property :database_name, scopes: [:restore]
+      property :backup_created_at, scopes: [:restore]
+    end
+  end
+end

data/lib/droplet_kit/mappings/database_cluster_mapping.rb

@@ -0,0 +1,28 @@
+module DropletKit
+  class DatabaseClusterMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping DatabaseCluster
+      root_key singular: 'database', plural: 'databases', scopes: [:read]
+
+      property :id, scopes: [:read]
+      property :name, scopes: [:read, :create, :restore]
+      property :engine, scopes: [:read, :create, :restore]
+      property :version, scopes: [:read, :create, :restore]
+      property :connection, scopes: [:read], include: DatabaseConnectionMapping
+      property :private_connection, scopes: [:read], include: DatabaseConnectionMapping
+      property :users, plural: true, scopes: [:read], include: DatabaseUserMapping
+      property :backup_restore, scopes: [:restore], include: DatabaseBackupRestoreMapping
+      property :num_nodes, scopes: [:read, :create, :resize, :restore]
+      property :size, scopes: [:read, :create, :resize, :restore]
+      property :db_names, plural: true, scopes: [:read]
+      property :region, scopes: [:read, :create, :migrate, :restore]
+      property :status, scopes: [:read]
+      property :maintenance_window, scopes: [:read], include: DatabaseMaintenanceWindowMapping
+      property :created_at, scopes: [:read]
+      property :private_network_uuid, scopes: [:read, :create]
+      property :tags, plural: true, scopes: [:read, :create]
+    end
+  end
+end

data/lib/droplet_kit/mappings/database_connection_mapping.rb

@@ -0,0 +1,18 @@
+module DropletKit
+  class DatabaseConnectionMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping DatabaseConnection
+      root_key singular: 'connection', plural: 'connections', scopes: [:read]
+
+      property :uri, scopes: [:read]
+      property :database, scopes: [:read]
+      property :host, scopes: [:read]
+      property :port, scopes: [:read]
+      property :user, scopes: [:read]
+      property :password, scopes: [:read]
+      property :ssl, scopes: [:read]
+    end
+  end
+end

data/lib/droplet_kit/mappings/database_maintenance_window_mapping.rb

@@ -0,0 +1,15 @@
+module DropletKit
+  class DatabaseMaintenanceWindowMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping DatabaseMaintenanceWindow
+      root_key singular: 'database_maintenance_window', plural: 'database_maintenance_windows', scopes: [:read]
+
+      property :day, scopes: [:read, :update]
+      property :hour, scopes: [:read, :update]
+      property :pending, scopes: [:read]
+      property :description, scopes: [:read]
+    end
+  end
+end

data/lib/droplet_kit/mappings/database_mapping.rb

@@ -0,0 +1,12 @@
+module DropletKit
+  class DatabaseMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Database
+      root_key singular: 'db', plural: 'dbs', scopes: [:read]
+
+      property :name, scopes: [:read, :create]
+    end
+  end
+end

data/lib/droplet_kit/mappings/database_user_mapping.rb

@@ -0,0 +1,14 @@
+module DropletKit
+  class DatabaseUserMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping DatabaseUser
+      root_key singular: 'database_user', plural: 'database_users', scopes: [:read]
+
+      property :name, scopes: [:read]
+      property :role, scopes: [:read, :create, :update]
+      property :password, scopes: [:read, :create, :update]
+    end
+  end
+end

data/lib/droplet_kit/models/database.rb

@@ -0,0 +1,5 @@
+module DropletKit
+  class Database < BaseModel
+    attribute :name
+  end
+end

data/lib/droplet_kit/models/database_backup.rb

@@ -0,0 +1,8 @@
+module DropletKit
+  class DatabaseBackup < BaseModel
+    attribute :created_at
+    attribute :size_gigabytes
+    attribute :database_name
+    attribute :backup_created_at
+  end
+end

data/lib/droplet_kit/models/database_cluster.rb

@@ -0,0 +1,21 @@
+module DropletKit
+  class DatabaseCluster < BaseModel
+    attribute :id
+    attribute :name
+    attribute :engine
+    attribute :version
+    attribute :connection
+    attribute :private_connection
+    attribute :backup_restore
+    attribute :users
+    attribute :num_nodes
+    attribute :size
+    attribute :db_names
+    attribute :region
+    attribute :status
+    attribute :maintenance_window
+    attribute :created_at
+    attribute :private_network_uuid
+    attribute :tags
+  end
+end

data/lib/droplet_kit/models/database_connection.rb

@@ -0,0 +1,11 @@
+module DropletKit
+  class DatabaseConnection < BaseModel
+    attribute :uri
+    attribute :database
+    attribute :host
+    attribute :port
+    attribute :user
+    attribute :password
+    attribute :ssl
+  end
+end

data/lib/droplet_kit/models/database_maintenance_window.rb

@@ -0,0 +1,8 @@
+module DropletKit
+  class DatabaseMaintenanceWindow < BaseModel
+    attribute :day
+    attribute :hour
+    attribute :pending
+    attribute :description
+  end
+end

data/lib/droplet_kit/models/database_user.rb

@@ -0,0 +1,7 @@
+module DropletKit
+  class DatabaseUser < BaseModel
+    attribute :name
+    attribute :role
+    attribute :password
+  end
+end

data/lib/droplet_kit/resources/database_resource.rb

@@ -0,0 +1,70 @@
+module DropletKit
+  class DatabaseResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
+    resources do
+      action :find_cluster, 'GET /v2/databases/:id' do
+        handler(200) { |response| DatabaseClusterMapping.extract_single(response.body, :read) }
+      end
+
+      action :all_clusters, 'GET /v2/databases' do
+        handler(200) { |response| DatabaseClusterMapping.extract_collection(response.body, :read) }
+      end
+
+      action :create_cluster, 'POST /v2/databases' do
+        body { |object| DatabaseClusterMapping.representation_for(:create, object) }
+        handler(202) { |response, database| DatabaseClusterMapping.extract_into_object(database, response.body, :read) }
+        handler(422) { |response| ErrorMapping.fail_with(FailedCreate, response.body) }
+      end
+
+      action :resize_cluster, 'PUT /v2/databases/:id/resize' do
+        body { |object| DatabaseClusterMapping.representation_for(:resize, object) }
+        handler(202) { |response| true }
+        handler(422) { |response| ErrorMapping.fail_with(FailedUpdate, response.body) }
+      end
+
+      action :migrate_cluster, 'PUT /v2/databases/:id/migrate' do
+        body { |object| DatabaseClusterMapping.representation_for(:migrate, object) }
+        handler(202) { |response| true }
+        handler(422) { |response| ErrorMapping.fail_with(FailedUpdate, response.body) }
+      end
+
+      action :update_maintenance_window, 'PUT /v2/databases/:id/maintenance' do
+        body { |object| DatabaseMaintenanceWindowMapping.representation_for(:update, object) }
+        handler(204) { |response| true }
+      end
+
+      action :list_backups, 'GET /v2/databases/:id/backups' do
+        handler(200) { |response| DatabaseBackupMapping.extract_collection(response.body, :read) }
+      end
+
+      action :restore_from_backup, 'POST /v2/databases' do
+        body { |object| DatabaseClusterMapping.representation_for(:restore, object) }
+        handler(201) { |response, database| DatabaseClusterMapping.extract_into_object(database, response.body, :read) }
+        handler(422) { |response| ErrorMapping.fail_with(FailedCreate, response.body) }
+      end
+
+      action :delete_cluster, 'DELETE /v2/databases/:id' do
+        handler(204) { |response| true }
+      end
+
+      action :create_db, 'POST /v2/databases/:id/dbs' do
+        body { |object| DatabaseMapping.representation_for(:create, object) }
+        handler(201) { |response, database| DatabaseMapping.extract_into_object(database, response.body, :read) }
+        handler(422) { |response| ErrorMapping.fail_with(FailedCreate, response.body) }
+      end
+
+      action :find_db, 'GET /v2/databases/:id/dbs/:name' do
+        handler(200) { |response| DatabaseMapping.extract_single(response.body, :read) }
+      end
+
+      action :all_dbs, 'GET /v2/databases/:id/dbs' do
+        handler(200) { |response| DatabaseMapping.extract_collection(response.body, :read) }
+      end
+
+      action :delete_db, 'DELETE /v2/databases/:id/dbs/:name' do
+        handler(204) { |response| true }
+      end
+    end
+  end
+end

data/lib/droplet_kit/version.rb

@@ -1,3 +1,3 @@
 module DropletKit
-  VERSION = "3.3.1"
+  VERSION = "3.4.0"
 end

data/lib/droplet_kit.rb

@@ -32,6 +32,12 @@ module DropletKit
   autoload :TaggedDropletsResources, 'droplet_kit/models/tagged_droplets_resources'
   autoload :TaggedImagesResources, 'droplet_kit/models/tagged_images_resources'
   autoload :Volume, 'droplet_kit/models/volume'
+  autoload :Database, 'droplet_kit/models/database'
+  autoload :DatabaseBackup, 'droplet_kit/models/database_backup'
+  autoload :DatabaseCluster, 'droplet_kit/models/database_cluster'
+  autoload :DatabaseConnection, 'droplet_kit/models/database_connection'
+  autoload :DatabaseUser, 'droplet_kit/models/database_user'
+  autoload :DatabaseMaintenanceWindow, 'droplet_kit/models/database_maintenance_window'
   autoload :LoadBalancer, 'droplet_kit/models/load_balancer'
   autoload :StickySession, 'droplet_kit/models/sticky_session'
   autoload :HealthCheck, 'droplet_kit/models/health_check'
@@ -71,6 +77,7 @@ module DropletKit
   autoload :VolumeResource, 'droplet_kit/resources/volume_resource'
   autoload :VolumeActionResource, 'droplet_kit/resources/volume_action_resource'
   autoload :SnapshotResource, 'droplet_kit/resources/snapshot_resource'
+  autoload :DatabaseResource, 'droplet_kit/resources/database_resource'
   autoload :LoadBalancerResource, 'droplet_kit/resources/load_balancer_resource'
   autoload :CertificateResource, 'droplet_kit/resources/certificate_resource'
   autoload :FirewallResource, 'droplet_kit/resources/firewall_resource'
@@ -106,6 +113,13 @@ module DropletKit
   autoload :TaggedDropletsResourcesMapping, 'droplet_kit/mappings/tagged_droplets_resources_mapping'
   autoload :TaggedImagesResourcesMapping, 'droplet_kit/mappings/tagged_images_resources_mapping'
   autoload :VolumeMapping, 'droplet_kit/mappings/volume_mapping'
+  autoload :DatabaseMapping, 'droplet_kit/mappings/database_mapping'
+  autoload :DatabaseBackupMapping, 'droplet_kit/mappings/database_backup_mapping'
+  autoload :DatabaseBackupRestoreMapping, 'droplet_kit/mappings/database_backup_restore_mapping'
+  autoload :DatabaseClusterMapping, 'droplet_kit/mappings/database_cluster_mapping'
+  autoload :DatabaseConnectionMapping, 'droplet_kit/mappings/database_connection_mapping'
+  autoload :DatabaseUserMapping, 'droplet_kit/mappings/database_user_mapping'
+  autoload :DatabaseMaintenanceWindowMapping, 'droplet_kit/mappings/database_maintenance_window_mapping'
   autoload :LoadBalancerMapping, 'droplet_kit/mappings/load_balancer_mapping'
   autoload :StickySessionMapping, 'droplet_kit/mappings/sticky_session_mapping'
   autoload :HealthCheckMapping, 'droplet_kit/mappings/health_check_mapping'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: droplet_kit
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Robert Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -167,6 +167,13 @@ files:
 - lib/droplet_kit/mappings/cdn_mapping.rb
 - lib/droplet_kit/mappings/certificate_mapping.rb
 - lib/droplet_kit/mappings/container_registry_mapping.rb
+- lib/droplet_kit/mappings/database_backup_mapping.rb
+- lib/droplet_kit/mappings/database_backup_restore_mapping.rb
+- lib/droplet_kit/mappings/database_cluster_mapping.rb
+- lib/droplet_kit/mappings/database_connection_mapping.rb
+- lib/droplet_kit/mappings/database_maintenance_window_mapping.rb
+- lib/droplet_kit/mappings/database_mapping.rb
+- lib/droplet_kit/mappings/database_user_mapping.rb
 - lib/droplet_kit/mappings/domain_mapping.rb
 - lib/droplet_kit/mappings/domain_record_mapping.rb
 - lib/droplet_kit/mappings/droplet_mapping.rb
@@ -211,6 +218,12 @@ files:
 - lib/droplet_kit/models/cdn.rb
 - lib/droplet_kit/models/certificate.rb
 - lib/droplet_kit/models/container_registry.rb
+- lib/droplet_kit/models/database.rb
+- lib/droplet_kit/models/database_backup.rb
+- lib/droplet_kit/models/database_cluster.rb
+- lib/droplet_kit/models/database_connection.rb
+- lib/droplet_kit/models/database_maintenance_window.rb
+- lib/droplet_kit/models/database_user.rb
 - lib/droplet_kit/models/domain.rb
 - lib/droplet_kit/models/domain_record.rb
 - lib/droplet_kit/models/droplet.rb
@@ -256,6 +269,7 @@ files:
 - lib/droplet_kit/resources/cdn_resource.rb
 - lib/droplet_kit/resources/certificate_resource.rb
 - lib/droplet_kit/resources/container_registry_resource.rb
+- lib/droplet_kit/resources/database_resource.rb
 - lib/droplet_kit/resources/domain_record_resource.rb
 - lib/droplet_kit/resources/domain_resource.rb
 - lib/droplet_kit/resources/droplet_action_resource.rb
@@ -300,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Droplet Kit is the official Ruby library for DigitalOcean's API