barge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3508385a65f762c38891540ba2c37544e4ab89f
+  data.tar.gz: 69b2373c7d80246b12f180f531d65f95c6a6ad85
+SHA512:
+  metadata.gz: 4aeeeb86c1a73d8a91c443df99c3eb41242d42b8ad431c845bb3b6c01f6f1c047880e03f293cffa68dd4d417d6e0ba68a8cd708d0c0246f980e00696b3c23bc4
+  data.tar.gz: d5f51677663b6f0598db96b64cdf3d6f5b019b7659629186d74ffa486e0a71bb648eb5797f811a133c6884d75376120aa27e694c95f0b3b5bf026dacf9f49dfe

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Ørjan Blom
+
+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,332 @@
+Barge
+=====
+
+[![Build Status](http://img.shields.io/travis/boats/barge.svg)][travis]
+[![Coverage Status](http://img.shields.io/coveralls/boats/barge.svg)][coveralls]
+[![Code Climate](http://img.shields.io/codeclimate/github/boats/barge.svg)][codeclimate]
+[![Dependency Status](http://img.shields.io/gemnasium/boats/barge.svg)][gemnasium]
+
+[travis]: https://travis-ci.org/boats/barge
+[coveralls]: https://coveralls.io/r/boats/barge
+[codeclimate]: https://codeclimate.com/github/boats/barge
+[gemnasium]: https://gemnasium.com/boats/barge
+
+Ruby library for version 2 of
+[DigitalOcean's API](https://developers.digitalocean.com/).
+
+**Please note that version 2 of DigitalOcean's API is in beta, and is still
+being developed. Everything is subject to change.**
+
+### Installation
+
+``` sh
+gem install barge
+```
+
+Ruby 1.9 and up is required. See the [.travis.yml](.travis.yml) file for a list
+of supported rubies.
+
+### Initialize
+
+``` ruby
+barge = Barge::Client.new(access_token: 'token')
+```
+
+*or*
+
+``` ruby
+barge = Barge::Client.new do |config|
+  config.access_token = 'token'
+end
+```
+
+Resources
+=========
+
+General
+-------
+
+### Hashie::Mash
+
+[Hashie::Mash](https://github.com/intridea/hashie) is used so that attributes
+can be accessed using dot notation:
+
+``` ruby
+droplet = barge.droplet.show(droplet_id)
+droplet.name        # => "foo"
+droplet.image.id    # => 123
+droplet.size!.vcpus # => 1
+```
+
+Notice that `size!` and not `size` was used. This is because `size` already is
+a method, and Hashie::Mash will not override it. You can also use square
+brackets:
+
+``` ruby
+droplet[:size][:vcpus]   # => 1
+droplet['size']['vcpus'] # => 1
+```
+
+### success?
+
+You can use `success?` to check if a successful HTTP status code was returned:
+
+``` ruby
+barge.droplet.create(options).success? # => true
+```
+
+Droplet
+-------
+
+### Create droplet
+
+``` ruby
+barge.droplet.create(options)
+```
+
+See the [API documentation][droplet-create] for options.
+
+[droplet-create]: https://github.com/digitaloceancloud/api-v2-docs#droplet-create-post
+
+### Show all droplets
+
+``` ruby
+barge.droplet.all
+```
+
+### Show droplet
+
+``` ruby
+barge.droplet.show(droplet_id)
+```
+
+### Destroy droplet
+
+``` ruby
+barge.droplet.destroy(droplet_id)
+```
+
+### Rename droplet
+
+``` ruby
+barge.droplet.rename(droplet_id, 'new name')
+```
+
+### Reboot droplet
+
+``` ruby
+barge.droplet.reboot(droplet_id)
+```
+
+### Shutdown droplet
+
+``` ruby
+barge.droplet.shutdown(droplet_id)
+```
+
+### Power off droplet
+
+``` ruby
+barge.droplet.power_off(droplet_id)
+```
+
+### Power cycle droplet
+
+``` ruby
+barge.droplet.power_cycle(droplet_id)
+```
+
+### Power on droplet
+
+``` ruby
+barge.droplet.power_on(droplet_id)
+```
+
+### Resize droplet
+
+``` ruby
+barge.droplet.resize(droplet_id, 'size slug')
+```
+
+Where *size slug* is for example `1024mb`.
+
+### Rebuild droplet
+
+``` ruby
+barge.droplet.rebuild(droplet_id, image_id)
+```
+
+### Restore droplet
+
+``` ruby
+barge.droplet.restore(droplet_id, image_id)
+```
+
+### Reset a droplet's password
+
+``` ruby
+barge.droplet.password_reset(droplet_id)
+```
+
+Image
+-----
+
+### Show all images
+
+``` ruby
+barge.image.all
+```
+
+### Show image
+
+By ID:
+
+``` ruby
+barge.image.show(image_id)
+```
+
+By image slug (public images):
+
+``` ruby
+barge.image.show('image slug')
+```
+
+Where *image slug* is for example `ubuntu-13-10-x64`.
+
+### Update image
+
+``` ruby
+barge.image.update(image_id, options)
+```
+
+See the [API documentation][image-update] for options.
+
+[image-update]: https://github.com/digitaloceancloud/api-v2-docs#images-update-put
+
+### Destroy image
+
+``` ruby
+barge.image.destroy(image_id)
+```
+
+### Transfer image
+
+``` ruby
+barge.image.transfer(image_id, 'region slug')
+```
+
+Where *region slug* is for example `sfo1`.
+
+Domain
+------
+
+### Create domain
+
+``` ruby
+barge.domain.create(options)
+```
+
+See the [API documentation][domain-create] for options.
+
+[domain-create]: https://github.com/digitaloceancloud/api-v2-docs#domain-records-create-post
+
+### Show all domains
+
+``` ruby
+barge.domain.all
+```
+
+### Show domain
+
+``` ruby
+barge.domain.show(domain_name)
+```
+
+### Destroy domain
+
+``` ruby
+barge.domain.destroy(domain_name)
+```
+
+### Create domain record
+
+``` ruby
+barge.domain.create_record(domain_name, options)
+```
+
+See the [API documentation][domain-create-record] for options.
+
+[domain-create-record]: https://github.com/digitaloceancloud/api-v2-docs#domain-records-create-post
+
+### Show all domain records
+
+``` ruby
+barge.domain.records
+```
+
+### Show domain record
+
+``` ruby
+barge.domain.show_record(domain_name, record_id)
+```
+
+### Update domain record
+
+``` ruby
+barge.domain.update_record(domain_name, record_id, options)
+```
+
+### Destroy domain record
+
+``` ruby
+barge.domain.destroy_record(domain_name, record_id)
+```
+
+Key
+---
+
+### Create key
+
+``` ruby
+barge.key.create(options)
+```
+
+See the [API documentation][key-create] for options.
+
+[key-create]: https://github.com/digitaloceancloud/api-v2-docs#keys-create-post
+
+### Show all keys
+
+``` ruby
+barge.key.all
+```
+
+### Show key
+
+``` ruby
+barge.key.show(key_id_or_fingerprint)
+```
+
+### Destroy key
+
+``` ruby
+barge.key.destroy(key_id)
+```
+
+Region
+------
+
+### Show all regions
+
+``` ruby
+barge.region.all
+```
+
+Size
+----
+
+### Show all sizes
+
+``` ruby
+barge.size.all
+```

data/lib/barge/client.rb

@@ -0,0 +1,62 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Barge
+  class Client
+    attr_accessor :access_token
+
+    attr_reader :domain
+    attr_reader :droplet
+    attr_reader :image
+    attr_reader :key
+    attr_reader :region
+    attr_reader :size
+
+    DEFAULT_OPTIONS = {}
+    DIGITAL_OCEAN_URL = 'https://api.digitalocean.com/v2'
+    TIMEOUTS = 10
+
+    def initialize(options = DEFAULT_OPTIONS)
+      self.access_token = options.fetch(:access_token, nil)
+      yield(self) if block_given?
+      fail ArgumentError, 'missing access_token' unless access_token
+      initialize_resources
+    end
+
+    private
+
+    def initialize_resources
+      @domain  = Resource::Domain.new(faraday)
+      @droplet = Resource::Droplet.new(faraday)
+      @image   = Resource::Image.new(faraday)
+      @key     = Resource::Key.new(faraday)
+      @region  = Resource::Region.new(faraday)
+      @size    = Resource::Size.new(faraday)
+    end
+
+    def faraday
+      @faraday ||= Faraday.new faraday_options do |f|
+        f.adapter :net_http
+
+        f.request :json
+
+        f.response :follow_redirects
+        f.response :mashify
+        f.response :json
+
+        f.options.open_timeout = TIMEOUTS
+        f.options.timeout = TIMEOUTS
+      end
+    end
+
+    def faraday_options
+      {
+        headers: {
+          authorization: "Bearer #{access_token}",
+          content_type: 'application/json'
+        },
+        url: DIGITAL_OCEAN_URL
+      }
+    end
+  end
+end

data/lib/barge/resource/base.rb

@@ -0,0 +1,27 @@
+module Barge
+  module Resource
+    module Base
+      attr_reader :faraday
+
+      def initialize(faraday)
+        @faraday = faraday
+      end
+
+      private
+
+      [:delete, :get, :head, :post, :put].each do |verb|
+        define_method verb do |*args|
+          request(__method__, *args)
+        end
+      end
+
+      def request(verb, *args)
+        response = faraday.public_send(verb, *args)
+        response.body.tap do |r|
+          r.define_singleton_method(:response) { response }
+          r.define_singleton_method(:success?) { response.success? }
+        end
+      end
+    end
+  end
+end

data/lib/barge/resource/domain.rb

@@ -0,0 +1,43 @@
+module Barge
+  module Resource
+    class Domain
+      include Resource::Base
+
+      def create(options)
+        post('domains', options.to_json)
+      end
+
+      def all
+        get('domains')
+      end
+
+      def show(domain_name)
+        get("domains/#{domain_name}")
+      end
+
+      def destroy(domain_name)
+        delete("domains/#{domain_name}")
+      end
+
+      def create_record(domain_name, options)
+        post("domains/#{domain_name}/records", options.to_json)
+      end
+
+      def records(domain_name)
+        get("domains/#{domain_name}/records")
+      end
+
+      def show_record(domain_name, record_id)
+        get("domains/#{domain_name}/records/#{record_id}")
+      end
+
+      def update_record(domain_name, record_id, options)
+        put("domains/#{domain_name}/records/#{record_id}", options.to_json)
+      end
+
+      def destroy_record(domain_name, record_id)
+        delete("domains/#{domain_name}/records/#{record_id}")
+      end
+    end
+  end
+end

data/lib/barge/resource/droplet.rb

@@ -0,0 +1,70 @@
+module Barge
+  module Resource
+    class Droplet
+      include Resource::Base
+
+      def create(options)
+        post('droplets', options.to_json)
+      end
+
+      def all
+        get('droplets')
+      end
+
+      def show(droplet_id)
+        get("droplets/#{droplet_id}")
+      end
+
+      def destroy(droplet_id)
+        delete("droplets/#{droplet_id}")
+      end
+
+      def rename(droplet_id, name)
+        action(droplet_id, __method__, name: name)
+      end
+
+      def reboot(droplet_id)
+        action(droplet_id, __method__)
+      end
+
+      def shutdown(droplet_id)
+        action(droplet_id, __method__)
+      end
+
+      def power_off(droplet_id)
+        action(droplet_id, __method__)
+      end
+
+      def power_cycle(droplet_id)
+        action(droplet_id, __method__)
+      end
+
+      def power_on(droplet_id)
+        action(droplet_id, __method__)
+      end
+
+      def resize(droplet_id, size)
+        action(droplet_id, __method__, size: size)
+      end
+
+      def rebuild(droplet_id, image_id)
+        action(droplet_id, __method__, image: image_id)
+      end
+
+      def restore(droplet_id, image_id)
+        action(droplet_id, __method__, image: image_id)
+      end
+
+      def password_reset(droplet_id)
+        action(droplet_id, __method__)
+      end
+
+      private
+
+      def action(droplet_id, type, params = {})
+        post("droplets/#{droplet_id}/actions",
+             { type: type, params: params }.to_json)
+      end
+    end
+  end
+end

data/lib/barge/resource/image.rb

@@ -0,0 +1,34 @@
+module Barge
+  module Resource
+    class Image
+      include Resource::Base
+
+      def all
+        get('images')
+      end
+
+      def show(image_id)
+        get("images/#{image_id}")
+      end
+
+      def update(image_id, options)
+        put("images/#{image_id}", options.to_json)
+      end
+
+      def destroy(image_id)
+        delete("images/#{image_id}")
+      end
+
+      def transfer(image_id, region)
+        action(image_id, __method__, region: region)
+      end
+
+      private
+
+      def action(image_id, type, params = {})
+        post("images/#{image_id}/actions",
+             { type: type, params: params }.to_json)
+      end
+    end
+  end
+end

data/lib/barge/resource/key.rb

@@ -0,0 +1,23 @@
+module Barge
+  module Resource
+    class Key
+      include Resource::Base
+
+      def create(options)
+        post('account/keys', options.to_json)
+      end
+
+      def all
+        get('account/keys')
+      end
+
+      def show(key_id)
+        get("account/keys/#{key_id}")
+      end
+
+      def destroy(key_id)
+        delete("account/keys/#{key_id}")
+      end
+    end
+  end
+end

data/lib/barge/resource/region.rb

@@ -0,0 +1,11 @@
+module Barge
+  module Resource
+    class Region
+      include Resource::Base
+
+      def all
+        get('regions')
+      end
+    end
+  end
+end

data/lib/barge/resource/size.rb

@@ -0,0 +1,11 @@
+module Barge
+  module Resource
+    class Size
+      include Resource::Base
+
+      def all
+        get('sizes')
+      end
+    end
+  end
+end

data/lib/barge/resource.rb

@@ -0,0 +1,13 @@
+require 'barge/resource/base'
+
+require 'barge/resource/domain'
+require 'barge/resource/droplet'
+require 'barge/resource/image'
+require 'barge/resource/key'
+require 'barge/resource/region'
+require 'barge/resource/size'
+
+module Barge
+  module Resource
+  end
+end

data/lib/barge/version.rb

@@ -0,0 +1,11 @@
+module Barge
+  class Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+
+    def self.to_s
+      [MAJOR, MINOR, PATCH].join '.'
+    end
+  end
+end

data/lib/barge.rb

@@ -0,0 +1,8 @@
+require 'hashie'
+
+require 'barge/client'
+require 'barge/resource'
+require 'barge/version'
+
+module Barge
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: barge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "Ørjan Blom"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby library for version 2 of DigitalOcean's API
+email:
+- blom@blom.tv
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/barge.rb
+- lib/barge/client.rb
+- lib/barge/resource.rb
+- lib/barge/resource/base.rb
+- lib/barge/resource/domain.rb
+- lib/barge/resource/droplet.rb
+- lib/barge/resource/image.rb
+- lib/barge/resource/key.rb
+- lib/barge/resource/region.rb
+- lib/barge/resource/size.rb
+- lib/barge/version.rb
+homepage: https://github.com/boats/barge
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby library for DigitalOcean
+test_files: []
+has_rdoc: