droplet_kit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e43efb48656febf1baf2550b520d7c0c2a7b39d2
+  data.tar.gz: 1e5a17558dd524315f33b1ce62f525d5d6bd7564
+SHA512:
+  metadata.gz: 5ea1044a5bfdb6c3a778a23f5c16410a13b51772ea0071de14e786a3661d684d8115934f71ccfbdd1b59f479e01e10cf0acf94f0eead04b5d0397d7b11508267
+  data.tar.gz: 460b7344ce21709ea9e6af3353d529b7620e61c0f1dda18ca04d10a2bcb3de69fb2804b0baf122d1700bc0e64337fec7e3abc0e3d4cb972c6bf75a0627848529

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in droplet_kit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Ross
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,70 @@
+# DropletKit
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'droplet_kit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install droplet_kit
+
+## Usage
+
+You'll need to generate an access token in Digital Oceans control panel at https://cloud.digitalocean.com/settings/applications
+
+With your access token, retrieve a client instance with it.
+
+```ruby
+client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
+```
+
+## Design
+
+DropletKit follows a strict design of resoures as methods on your client. For examples, for droplets, you will call your client like this:
+
+```ruby
+client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
+client.droplets #=> DropletsResource
+```
+
+DropletKit will return Plain Old Ruby objects(tm) that contain the information provided by the API. For example:
+
+```ruby
+client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
+client.droplets.all
+# => [ DropletKit::Dropet(id: 123, name: 'something.com', ...), DropletKit::Dropet(id: 1066, name: 'bunk.com', ...) ]
+```
+
+When you'd like to save objects, it's your responsibility to instantiate the objects and persist them using the resource objects. Lets use creating a Droplet as an example:
+
+```ruby
+client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
+droplet = DropletKit::Droplet.new(name: 'mysite.com', region: 'nyc2', image: 'ubuntu-14-04-x64', size: '512mb')
+created = client.droplets.create(droplet)
+# => DropletKit::Droplet(id: 1231, name: 'something.com', ...)
+```
+
+To retrieve objects, you can perform this type of action on the resource (if the API supports it):
+
+```ruby
+client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
+droplet = client.droplets.find(id: 123)
+# => DropletKit::Droplet(id: 1231, name: 'something.com', ...)
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/digitaloceancloud/droplet_kit/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/droplet_kit.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'droplet_kit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "droplet_kit"
+  spec.version       = DropletKit::VERSION
+  spec.authors       = ["Robert Ross"]
+  spec.email         = ["rross@digitalocean.com"]
+  spec.summary       = %q{Droplet Kit is the official Ruby library for Digital Ocean's API}
+  spec.description   = %q{Droplet Kit is the official Ruby library for Digital Ocean's API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'virtus', '~> 1.0.3'
+  spec.add_dependency "resource_kit", '~> 0.0.5'
+  spec.add_dependency "kartograph", '~> 0.0.5'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+  spec.add_development_dependency "pry"
+
+  # FakeServe
+  spec.add_development_dependency 'sinatra', '~> 1.4'
+  spec.add_development_dependency 'webmock', '~> 1.18'
+end

data/lib/droplet_kit.rb

@@ -0,0 +1,63 @@
+require "droplet_kit/version"
+require 'resource_kit'
+require 'kartograph'
+
+module DropletKit
+  autoload :Client, 'droplet_kit/client'
+
+  # Models
+  autoload :BaseModel, 'droplet_kit/models/base_model'
+  autoload :Droplet, 'droplet_kit/models/droplet'
+  autoload :Region, 'droplet_kit/models/region'
+  autoload :Image, 'droplet_kit/models/image'
+  autoload :ImageAction, 'droplet_kit/models/image_action'
+  autoload :Size, 'droplet_kit/models/size'
+  autoload :NetworkHash, 'droplet_kit/models/network_hash'
+  autoload :Network, 'droplet_kit/models/network'
+  autoload :Kernel, 'droplet_kit/models/kernel'
+  autoload :Snapshot, 'droplet_kit/models/snapshot'
+  autoload :Backup, 'droplet_kit/models/backup'
+  autoload :Action, 'droplet_kit/models/action'
+  autoload :Domain, 'droplet_kit/models/domain'
+  autoload :DomainRecord, 'droplet_kit/models/domain_record'
+  autoload :SSHKey, 'droplet_kit/models/ssh_key'
+  autoload :MetaInformation, 'droplet_kit/models/meta_information'
+
+  # Resources
+  autoload :DropletResource, 'droplet_kit/resources/droplet_resource'
+  autoload :ActionResource, 'droplet_kit/resources/action_resource'
+  autoload :DomainResource, 'droplet_kit/resources/domain_resource'
+  autoload :DomainRecordResource, 'droplet_kit/resources/domain_record_resource'
+  autoload :DropletActionResource, 'droplet_kit/resources/droplet_action_resource'
+  autoload :ImageResource, 'droplet_kit/resources/image_resource'
+  autoload :ImageActionResource, 'droplet_kit/resources/image_action_resource'
+  autoload :SSHKeyResource, 'droplet_kit/resources/ssh_key_resource'
+  autoload :RegionResource, 'droplet_kit/resources/region_resource'
+  autoload :SizeResource, 'droplet_kit/resources/size_resource'
+
+  # JSON Maps
+  autoload :DropletMapping, 'droplet_kit/mappings/droplet_mapping'
+  autoload :ImageMapping, 'droplet_kit/mappings/image_mapping'
+  autoload :RegionMapping, 'droplet_kit/mappings/region_mapping'
+  autoload :SizeMapping, 'droplet_kit/mappings/size_mapping'
+  autoload :NetworkMapping, 'droplet_kit/mappings/network_mapping'
+  autoload :NetworkDetailMapping, 'droplet_kit/mappings/network_detail_mapping'
+  autoload :KernelMapping, 'droplet_kit/mappings/kernel_mapping'
+  autoload :SnapshotMapping, 'droplet_kit/mappings/snapshot_mapping'
+  autoload :BackupMapping, 'droplet_kit/mappings/backup_mapping'
+  autoload :ActionMapping, 'droplet_kit/mappings/action_mapping'
+  autoload :DomainMapping, 'droplet_kit/mappings/domain_mapping'
+  autoload :DomainRecordMapping, 'droplet_kit/mappings/domain_record_mapping'
+  autoload :DropletActionMapping, 'droplet_kit/mappings/droplet_action_mapping'
+  autoload :ImageActionMapping, 'droplet_kit/mappings/image_action_mapping'
+  autoload :SSHKeyMapping, 'droplet_kit/mappings/ssh_key_mapping'
+
+
+  # Utils
+  autoload :PaginatedResource, 'droplet_kit/paginated_resource'
+
+  # Errors
+  autoload :ErrorMapping, 'droplet_kit/mappings/error_mapping'
+  FailedCreate = Class.new(StandardError)
+  FailedUpdate = Class.new(StandardError)
+end

data/lib/droplet_kit/client.rb

@@ -0,0 +1,58 @@
+require 'faraday'
+
+module DropletKit
+  class Client
+    DIGITALOCEAN_API = 'https://api.digitalocean.com'
+
+    attr_reader :access_token
+
+    def initialize(options = {})
+      @access_token = options[:access_token]
+    end
+
+    def connection
+      Faraday.new(connection_options) do |req|
+        req.adapter :net_http
+      end
+    end
+
+    def self.resources
+      {
+        droplets: DropletResource,
+        domains: DomainResource,
+        domain_records: DomainRecordResource,
+        droplet_actions: DropletActionResource,
+        images: ImageResource,
+        image_actions: ImageActionResource,
+        regions: RegionResource,
+        sizes: SizeResource,
+        ssh_keys: SSHKeyResource,
+      }
+    end
+
+    def method_missing(name, *args, &block)
+      if self.class.resources.keys.include?(name)
+        resources[name] ||= self.class.resources[name].new(connection)
+        resources[name]
+      else
+        super
+      end
+    end
+
+    def resources
+      @resources ||= {}
+    end
+
+    private
+
+    def connection_options
+      {
+        url: DIGITALOCEAN_API,
+        headers: {
+          content_type: 'application/json',
+          authorization: "Bearer #{access_token}"
+        }
+      }
+    end
+  end
+end

data/lib/droplet_kit/mappings/action_mapping.rb

@@ -0,0 +1,19 @@
+module DropletKit
+  class ActionMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Action
+      root_key plural: 'actions', singular: 'action', scopes: [:read]
+
+      property :id, scopes: [:read]
+      property :status, scopes: [:read]
+      property :type, scopes: [:read]
+      property :started_at, scopes: [:read]
+      property :completed_at, scopes: [:read]
+      property :resource_id, scopes: [:read]
+      property :resource_type, scopes: [:read]
+      property :region, scopes: [:read]
+    end
+  end
+end

data/lib/droplet_kit/mappings/backup_mapping.rb

@@ -0,0 +1,19 @@
+module DropletKit
+  class BackupMapping
+    include Kartograph::DSL
+
+    kartograph do
+      root_key plural: 'backups', singular: 'backup', scopes: [:read]
+      mapping Backup
+
+      property :id, scopes: [:read]
+      property :name, scopes: [:read]
+      property :distribution, scopes: [:read]
+      property :slug, scopes: [:read]
+      property :public, scopes: [:read]
+      property :regions, scopes: [:read]
+      property :action_ids, scopes: [:read]
+      property :created_at, scopes: [:read]
+    end
+  end
+end

data/lib/droplet_kit/mappings/domain_mapping.rb

@@ -0,0 +1,15 @@
+module DropletKit
+  class DomainMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Domain
+      root_key plural: 'domains', singular: 'domain', scopes: [:read]
+
+      property :name, scopes: [:read, :create]
+      property :ttl, scopes: [:read]
+      property :zone_file, scopes: [:read]
+      property :ip_address, scopes: [:create]
+    end
+  end
+end

data/lib/droplet_kit/mappings/domain_record_mapping.rb

@@ -0,0 +1,18 @@
+module DropletKit
+  class DomainRecordMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping DomainRecord
+      root_key plural: 'domain_records', singular: 'domain_record', scopes: [:read]
+
+      property :id, scopes: [:read]
+      property :type, scopes: [:read, :create]
+      property :name, scopes: [:read, :create, :update]
+      property :data, scopes: [:read, :create]
+      property :priority, scopes: [:read, :create]
+      property :port, scopes: [:read, :create]
+      property :weight, scopes: [:read, :create]
+    end
+  end
+end

data/lib/droplet_kit/mappings/droplet_mapping.rb

@@ -0,0 +1,38 @@
+module DropletKit
+  class DropletMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Droplet
+      root_key plural: 'droplets', singular: 'droplet', scopes: [:read]
+
+      property :id, scopes: [:read]
+      property :name, scopes: [:read]
+      property :memory, scopes: [:read]
+      property :vcpus, scopes: [:read]
+      property :disk, scopes: [:read]
+      property :locked, scopes: [:read]
+      property :created_at, scopes: [:read]
+      property :status, scopes: [:read]
+      property :backup_ids, scopes: [:read]
+      property :snapshot_ids, scopes: [:read]
+      property :action_ids, scopes: [:read]
+      property :features, scopes: [:read]
+
+      property :region, scopes: [:read], include: RegionMapping
+      property :image, scopes: [:read], include: ImageMapping
+      property :size, scopes: [:read], include: SizeMapping
+      property :networks, scopes: [:read], include: NetworkMapping
+      property :kernel, scopes: [:read], include: KernelMapping
+
+      # Create properties arent quite the same
+      property :name, scopes: [:create]
+      property :region, scopes: [:create]
+      property :size, scopes: [:create]
+      property :image, scopes: [:create]
+      property :ssh_keys, scopes: [:create]
+      property :backups, scopes: [:create]
+      property :ipv6, scopes: [:create]
+    end
+  end
+end

data/lib/droplet_kit/mappings/error_mapping.rb

@@ -0,0 +1,19 @@
+module DropletKit
+  class ErrorMapping
+    Error = Struct.new(:message, :id)
+
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Error
+
+      property :id, scopes: [:read]
+      property :message, scopes: [:read]
+    end
+
+    def self.fail_with(klass, content)
+      error = extract_single(content, :read)
+      raise klass, error.message
+    end
+  end
+end

data/lib/droplet_kit/mappings/image_action_mapping.rb

@@ -0,0 +1,19 @@
+module DropletKit
+  class ImageActionMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping ImageAction
+      root_key singular: 'action', plural: 'actions', scopes: [:read]
+
+      property :id, scopes: [:read]
+      property :status, scopes: [:read]
+      property :type, scopes: [:read]
+      property :started_at, scopes: [:read]
+      property :completed_at, scopes: [:read]
+      property :resource_id, scopes: [:read]
+      property :resource_type, scopes: [:read]
+      property :region, scopes: [:read]
+    end
+  end
+end