droplet_kit 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ecbe9de2e2f4c7fc8678c9c3e997208d79b3b8f
-  data.tar.gz: 6a9e211e1303f9c226d3d039789308c047340bcd
+  metadata.gz: 84d6ad636a505caf049b0c9bcf8c38ff0aedda28
+  data.tar.gz: a447e68783fce91d0eeaa1ecbefaf1ce1752ed57
 SHA512:
-  metadata.gz: 3a762b334cf6b65390ad5551ebae8286499f82aa49e996e16772609046904261e2c52c1dbe2b9926f244cd88f694053cba74e1805ec007ceb83d250bd4e3c460
-  data.tar.gz: d43a3564498375614861eb2416de54e3182879130efd71a7321ae04205f01e7e9e92a73088cb4a9d044149ee8ba0bd49b57c2e08292c6a0c751c673d18d16128
+  metadata.gz: d592ec69dd61e597c02a7ab9e737b42b58fa62189024ee745f27fa77d22e8fb99de448d7c09eae4d98325d813b7e5d2671ff669ef8b1b4721fb00b65f746afed
+  data.tar.gz: 7ab6c9ae7ea96cabdc6b03be3abae4e4f559039bba48f4062dbce3f9763c153f9953b5dd77ce36a96783314622585c0fa3cae38e8514de2c8764609f1a2b46b6

data/.travis.yml

@@ -7,9 +7,10 @@ before_install:
 rvm:
   - "2.0.0"
   - "2.1.10"
-  - "2.2.7"
-  - "2.3.4"
-  - "2.4.1"
+  - "2.2.10"
+  - "2.3.7"
+  - "2.4.4"
+  - "2.5.1"
 
 matrix:
   exclude:

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### Version 2.4.0
+* Added CDN resource.
+
 ### Version 2.3.0
 * Added support for Let's Encrypt certificates.
 
@@ -11,7 +14,7 @@
 * Added Firewall resource.
 * Added support for updating TTLs for DomainRecord resource.
 * Added support of all Rails 5 releases.
-* Added depreciation for Tag resource rename.
+* Added deprecation for Tag resource rename.
 
 ### Version 2.1.0
 * Added monitoring to the Droplet resource.

data/README.md

@@ -1,9 +1,9 @@
 # DropletKit
+[![Build Status](https://travis-ci.org/digitalocean/droplet_kit.svg?branch=master)](https://travis-ci.org/digitalocean/droplet_kit)
+[![Gem Version](https://badge.fury.io/rb/droplet_kit.svg)](https://badge.fury.io/rb/droplet_kit)
 
 DropletKit is the official [DigitalOcean V2 API](https://developers.digitalocean.com/v2/) client. It supports everything the API can do with a simple interface written in Ruby.
 
-[![Build Status](https://travis-ci.org/digitalocean/droplet_kit.svg?branch=master)](https://travis-ci.org/digitalocean/droplet_kit)
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,6 +25,7 @@ You'll need to generate an access token in Digital Ocean's control panel at http
 With your access token, retrieve a client instance with it.
 
 ```ruby
+require 'droplet_kit'
 client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
 ```
 
@@ -64,6 +65,26 @@ droplet = client.droplets.find(id: 123)
 
 # All Resources and actions.
 
+## CDN resource
+
+```ruby
+client = DropletKit::Client.new(access_token: 'TOKEN')
+client.cdns #=> DropletKit::CertificateResource
+cdn = DropletKit::CDN.new(
+  origin: 'myspace.nyc3.digitaloceanspaces.com',
+  ttl: 1800
+)
+```
+
+Actions supported:
+
+* `client.cdns.find(id: 'id')`
+* `client.cdns.all()`
+* `client.cdns.create(cdn)`
+* `client.cdns.update_ttl(id: 'id', ttl: 3600)`
+* `client.cdns.flush_cache(id: 'id', files: ['*', 'path/to/css/*'])`
+* `client.cdns.delete(id: 'id')`
+
 ## Certificate resource
 
 ```ruby

data/lib/droplet_kit.rb

@@ -38,6 +38,7 @@ module DropletKit
   autoload :FirewallInboundRule, 'droplet_kit/models/firewall_inbound_rule'
   autoload :FirewallOutboundRule, 'droplet_kit/models/firewall_outbound_rule'
   autoload :FirewallPendingChange, 'droplet_kit/models/firewall_pending_change'
+  autoload :CDN, 'droplet_kit/models/cdn'
 
   # Resources
   autoload :DropletResource, 'droplet_kit/resources/droplet_resource'
@@ -61,6 +62,7 @@ module DropletKit
   autoload :LoadBalancerResource, 'droplet_kit/resources/load_balancer_resource'
   autoload :CertificateResource, 'droplet_kit/resources/certificate_resource'
   autoload :FirewallResource, 'droplet_kit/resources/firewall_resource'
+  autoload :CDNResource, 'droplet_kit/resources/cdn_resource'
 
   # JSON Maps
   autoload :DropletMapping, 'droplet_kit/mappings/droplet_mapping'
@@ -94,6 +96,7 @@ module DropletKit
   autoload :FirewallInboundRuleMapping, 'droplet_kit/mappings/firewall_inbound_rule_mapping'
   autoload :FirewallOutboundRuleMapping, 'droplet_kit/mappings/firewall_outbound_rule_mapping'
   autoload :FirewallPendingChangeMapping, 'droplet_kit/mappings/firewall_pending_change_mapping'
+  autoload :CDNMapping, 'droplet_kit/mappings/cdn_mapping'
 
   # Utils
   autoload :PaginatedResource, 'droplet_kit/paginated_resource'

data/lib/droplet_kit/client.rb

@@ -19,6 +19,7 @@ module DropletKit
     def self.resources
       {
         actions: ActionResource,
+        cdns: CDNResource,
         certificates: CertificateResource,
         droplets: DropletResource,
         domains: DomainResource,

data/lib/droplet_kit/mappings/cdn_mapping.rb

@@ -0,0 +1,31 @@
+module DropletKit
+  class CDNMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping CDN
+      root_key singular: 'endpoint', plural: 'endpoints', scopes: [:read]
+
+      scoped :read do
+        property :id
+        property :ttl
+        property :origin
+        property :endpoint
+        property :created_at
+      end
+
+      scoped :create do
+        property :origin
+        property :ttl
+      end
+
+      scoped :update do
+        property :ttl
+      end
+
+      scoped :delete_cache do
+        property :files
+      end
+    end
+  end
+end

data/lib/droplet_kit/models/cdn.rb

@@ -0,0 +1,9 @@
+module DropletKit
+  class CDN < BaseModel
+    attribute :id
+    attribute :ttl
+    attribute :origin
+    attribute :endpoint
+    attribute :created_at
+  end
+end

data/lib/droplet_kit/resources/cdn_resource.rb

@@ -0,0 +1,42 @@
+module DropletKit
+  class CDNResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
+    resources do
+      action :find, 'GET /v2/cdn/endpoints/:id' do
+        handler(200) { |response| CDNMapping.extract_single(response.body, :read) }
+      end
+
+      action :all, 'GET /v2/cdn/endpoints' do
+        query_keys :per_page, :page
+        handler(200) { |response| CDNMapping.extract_collection(response.body, :read) }
+      end
+
+      action :create, 'POST /v2/cdn/endpoints' do
+        body { |cdn| CDNMapping.representation_for(:create, cdn) }
+        handler(201) { |response| CDNMapping.extract_single(response.body, :read) }
+        handler(422) { |response| ErrorMapping.fail_with(FailedCreate, response.body) }
+      end
+
+      action :update_ttl, 'PUT /v2/cdn/endpoints/:id' do
+        body { |hash| { ttl: hash[:ttl] }.to_json }
+        handler(200) { |response| CDNMapping.extract_single(response.body, :read) }
+        handler(422) { |response| ErrorMapping.fail_with(FailedUpdate, response.body) }
+      end
+
+      action :flush_cache, 'DELETE /v2/cdn/endpoints/:id/cache' do
+        body { |hash| { files: hash[:files] }.to_json }
+        handler(204) { |_| true }
+        handler(422) { |response| ErrorMapping.fail_with(FailedUpdate, response.body) }
+      end
+
+      action :delete, 'DELETE /v2/cdn/endpoints/:id' do
+        handler(204) { |_| true }
+      end
+    end
+
+    def all(*args)
+      PaginatedResource.new(action(:all), self, *args)
+    end
+  end
+end

data/lib/droplet_kit/version.rb

@@ -1,3 +1,3 @@
 module DropletKit
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

data/spec/fixtures/cdns/all.json

@@ -0,0 +1,16 @@
+{
+  "endpoints": [
+    {
+      "id": "7724db7c-e098-11e5-b522-000f53304e51",
+      "origin": "my-space-cdn.nyc3.digitaloceanspaces.com",
+      "endpoint": "my-space-cdn.nyc3.cdn.digitaloceanspaces.com",
+      "ttl": 3600,
+      "created_at": "2016-03-02T17:00:49Z"
+    }
+  ],
+  "links": {
+  },
+  "meta": {
+    "total": 1
+  }
+}

data/spec/fixtures/cdns/create.json

@@ -0,0 +1,9 @@
+{
+  "endpoint": {
+    "id": "7724db7c-e098-11e5-b522-000f53304e51",
+    "origin": "my-space-cdn.nyc3.digitaloceanspaces.com",
+    "endpoint": "my-space-cdn.nyc3.cdn.digitaloceanspaces.com",
+    "ttl": 3600,
+    "created_at": "2016-03-02T17:00:49Z"
+  }
+}

data/spec/fixtures/cdns/find.json

@@ -0,0 +1,9 @@
+{
+  "endpoint": {
+    "id": "7724db7c-e098-11e5-b522-000f53304e51",
+    "origin": "my-space-cdn.nyc3.digitaloceanspaces.com",
+    "endpoint": "my-space-cdn.nyc3.cdn.digitaloceanspaces.com",
+    "ttl": 3600,
+    "created_at": "2016-03-02T17:00:49Z"
+  }
+}

data/spec/fixtures/cdns/update_ttl.json

@@ -0,0 +1,9 @@
+{
+  "endpoint": {
+    "id": "7724db7c-e098-11e5-b522-000f53304e51",
+    "origin": "my-space-cdn.nyc3.digitaloceanspaces.com",
+    "endpoint": "my-space-cdn.nyc3.cdn.digitaloceanspaces.com",
+    "ttl": 60,
+    "created_at": "2016-03-02T17:00:49Z"
+  }
+}

data/spec/lib/droplet_kit/resources/cdn_resource_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+RSpec.describe DropletKit::CDNResource do
+  subject(:resource) { described_class.new(connection: connection) }
+  include_context 'resources'
+
+  let(:id) { '7724db7c-e098-11e5-b522-000f53304e51' }
+  let(:origin) { 'my-space-cdn.nyc3.digitaloceanspaces.com' }
+  let(:endpoint) { 'my-space-cdn.nyc3.cdn.digitaloceanspaces.com' }
+  let(:ttl) { 3600 }
+  let(:created_at) { '2016-03-02T17:00:49Z' }
+
+  let(:path) { '/v2/cdn/endpoints' }
+  let(:path_with_id) { "#{path}/#{id}" }
+
+  RSpec::Matchers.define :match_cdn_fixture do
+    match do |cdn|
+      expect(cdn).to be_kind_of(DropletKit::CDN)
+
+      expect(cdn.id).to eq(id)
+      expect(cdn.origin).to eq(origin)
+      expect(cdn.endpoint).to eq(endpoint)
+      expect(cdn.ttl).to eq(ttl)
+      expect(cdn.created_at).to eq(created_at)
+    end
+  end
+
+  describe '#all' do
+    it 'returns all of the cdns' do
+      stub_do_api(path, :get).to_return(body: api_fixture('cdns/all'))
+      cdns = resource.all
+
+      expect(cdns).to all(be_kind_of(DropletKit::CDN))
+      expect(cdns.first).to match_cdn_fixture
+    end
+
+    it_behaves_like 'a paginated index' do
+      let(:fixture_path) { 'cdns/all' }
+      let(:api_path) { '/v2/cdn/endpoints' }
+    end
+  end
+
+  describe '#find' do
+    it 'returns a singular cdn' do
+      stub_do_api(path_with_id, :get).to_return(body: api_fixture('cdns/find'))
+      cdn = resource.find(id: id)
+
+      expect(cdn).to match_cdn_fixture
+    end
+  end
+
+  describe '#create' do
+    it 'returns the created cdn' do
+      cdn = DropletKit::CDN.new(
+        origin: origin,
+        ttl: ttl
+      )
+
+      as_string = DropletKit::CDNMapping.representation_for(:create, cdn)
+      stub_do_api(path, :post).with(body: as_string).to_return(body: api_fixture('cdns/create'), status: 201)
+      created_cdn = resource.create(cdn)
+
+      expect(created_cdn).to match_cdn_fixture
+    end
+
+    it_behaves_like 'an action that handles invalid parameters' do
+      let(:action) { 'create' }
+      let(:arguments) { DropletKit::CDN.new }
+    end
+  end
+
+  describe '#update_ttl' do
+    let(:exception) { DropletKit::FailedUpdate }
+
+    it 'returns the updated cdn' do
+      as_string = { ttl: 60 }.to_json
+      stub_do_api(path_with_id, :put).with(body: as_string).to_return(body: api_fixture('cdns/update_ttl'))
+      updated_cdn = resource.update_ttl(id: id, ttl: 60)
+
+      expect(updated_cdn).to be_kind_of(DropletKit::CDN)
+
+      expect(updated_cdn.id).to eq(id)
+      expect(updated_cdn.ttl).to eq(60)
+    end
+
+    it "fails if ttl is invalid" do
+      as_string = { ttl: 0 }.to_json
+      response_body = { id: :unprocessable_entity, message: 'invalid ttl' }
+      stub_do_api(path_with_id, :put).with(body: as_string).to_return(body: response_body.to_json, status: 422)
+
+      expect { resource.update_ttl(id: id, ttl: 0) }.to raise_exception(exception).with_message(response_body[:message])
+    end
+  end
+
+  describe '#flush_cache' do
+    let(:cache_path) { "/v2/cdn/endpoints/#{id}/cache" }
+    let(:exception) { DropletKit::FailedUpdate }
+
+    it 'sends a delete request to cdn cache' do
+      as_string = { files: ["*"] }.to_json
+      request = stub_do_api(cache_path, :delete).with(body: as_string)
+      resource.flush_cache(id: id, files: ["*"])
+
+      expect(request).to have_been_made
+    end
+
+    it "fails if files are not passed in" do
+      as_string = { files: [] }.to_json
+      response_body = { id: :unprocessable_entity, message: 'invalid request body' }
+      stub_do_api(cache_path, :delete).with(body: as_string).to_return(body: response_body.to_json, status: 422)
+
+      expect { resource.flush_cache(id: id, files: []) }.to raise_exception(exception).with_message(response_body[:message])
+    end
+  end
+
+  describe '#delete' do
+    it 'sends a delete request for the cdn' do
+      request = stub_do_api(path_with_id, :delete)
+      resource.delete(id: id)
+
+      expect(request).to have_been_made
+    end
+  end
+end

data/spec/lib/droplet_kit/resources/certificate_resource_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'pry'
 
 RSpec.describe DropletKit::CertificateResource do
   include_context 'resources'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: droplet_kit
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Robert Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -205,6 +205,7 @@ files:
 - lib/droplet_kit/error_handling_resourcable.rb
 - lib/droplet_kit/mappings/account_mapping.rb
 - lib/droplet_kit/mappings/action_mapping.rb
+- lib/droplet_kit/mappings/cdn_mapping.rb
 - lib/droplet_kit/mappings/certificate_mapping.rb
 - lib/droplet_kit/mappings/domain_mapping.rb
 - lib/droplet_kit/mappings/domain_record_mapping.rb
@@ -236,6 +237,7 @@ files:
 - lib/droplet_kit/models/account.rb
 - lib/droplet_kit/models/action.rb
 - lib/droplet_kit/models/base_model.rb
+- lib/droplet_kit/models/cdn.rb
 - lib/droplet_kit/models/certificate.rb
 - lib/droplet_kit/models/domain.rb
 - lib/droplet_kit/models/domain_record.rb
@@ -268,6 +270,7 @@ files:
 - lib/droplet_kit/paginated_resource.rb
 - lib/droplet_kit/resources/account_resource.rb
 - lib/droplet_kit/resources/action_resource.rb
+- lib/droplet_kit/resources/cdn_resource.rb
 - lib/droplet_kit/resources/certificate_resource.rb
 - lib/droplet_kit/resources/domain_record_resource.rb
 - lib/droplet_kit/resources/domain_resource.rb
@@ -292,6 +295,10 @@ files:
 - spec/fixtures/account/info.json
 - spec/fixtures/actions/all.json
 - spec/fixtures/actions/find.json
+- spec/fixtures/cdns/all.json
+- spec/fixtures/cdns/create.json
+- spec/fixtures/cdns/find.json
+- spec/fixtures/cdns/update_ttl.json
 - spec/fixtures/certificates/all.json
 - spec/fixtures/certificates/find.json
 - spec/fixtures/certificates/lets_encrypt.json
@@ -379,6 +386,7 @@ files:
 - spec/lib/droplet_kit/paginated_resource_spec.rb
 - spec/lib/droplet_kit/resources/account_resource_spec.rb
 - spec/lib/droplet_kit/resources/action_resource_spec.rb
+- spec/lib/droplet_kit/resources/cdn_resource_spec.rb
 - spec/lib/droplet_kit/resources/certificate_resource_spec.rb
 - spec/lib/droplet_kit/resources/domain_record_resource_spec.rb
 - spec/lib/droplet_kit/resources/domain_resource_spec.rb
@@ -425,7 +433,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Droplet Kit is the official Ruby library for DigitalOcean's API
@@ -433,6 +441,10 @@ test_files:
 - spec/fixtures/account/info.json
 - spec/fixtures/actions/all.json
 - spec/fixtures/actions/find.json
+- spec/fixtures/cdns/all.json
+- spec/fixtures/cdns/create.json
+- spec/fixtures/cdns/find.json
+- spec/fixtures/cdns/update_ttl.json
 - spec/fixtures/certificates/all.json
 - spec/fixtures/certificates/find.json
 - spec/fixtures/certificates/lets_encrypt.json
@@ -520,6 +532,7 @@ test_files:
 - spec/lib/droplet_kit/paginated_resource_spec.rb
 - spec/lib/droplet_kit/resources/account_resource_spec.rb
 - spec/lib/droplet_kit/resources/action_resource_spec.rb
+- spec/lib/droplet_kit/resources/cdn_resource_spec.rb
 - spec/lib/droplet_kit/resources/certificate_resource_spec.rb
 - spec/lib/droplet_kit/resources/domain_record_resource_spec.rb
 - spec/lib/droplet_kit/resources/domain_resource_spec.rb