dorb 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60ba017e4aaa0670f9debe6271fd0a4934b88a76
+  data.tar.gz: 1032b5218896c4007081a48f0af4ac0a6977c1c7
+SHA512:
+  metadata.gz: 06f866a53ccacdba53dcf965c56acc7b32f725be954eb8b0bcd736ef1daa18b9310306c6fcff8efb1284e4b046dd6f5c331c5f03a631e1299dc31342e09fb238
+  data.tar.gz: 209117c4efc5527a2f1a1777953b47c456840cad55c7389f5bc4fe7e12f28d3f990dda08712e67f8efc5a474c150df6a2e755f748c36596808a5dfdda48386dc

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+env:
+  - DIGITAL_OCEAN_CLIENT_ID=123456789 DIGITAL_OCEAN_API_KEY=fedcba9876543210
+before_install:
+  - gem install bundler
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Darrin Wortlehock
+
+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,198 @@
+[![Build Status](https://travis-ci.org/exempla/dorb.png)](https://travis-ci.org/exempla/dorb)
+[![Code Climate](https://codeclimate.com/github/exempla/dorb.png)](https://codeclimate.com/github/exempla/dorb)
+
+# DORB - Digital Ocean Ruby Bindings
+
+Interact with the [Digital Ocean](http://www.digitalocean.com) [API](http://www.digitalocean.com/api) in an idiomatic ruby way.
+
+DORB exposes the Digital Ocean API as Ruby objects, has a comprehensive test suite and supports the entire API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dorb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dorb
+
+## Usage
+
+Require the library in your code as
+
+    require 'dorb'
+
+## Configuration
+
+Set your client key and API key
+
+    # This should be in an initializer or similar
+    DORB::Config.setup \
+      :client_key => 'YOUR_CLIENT_KEY_HERE',
+      :api_key => 'YOUR_API_KEY_HERE'
+
+Any method that calls the Digital Ocean API will raise DORB::ConfigurationError if either Client Key or API Key are not configured
+
+## Getting Started
+
+### Droplets
+
+##### Show all active droplets
+This method returns all active droplets that are currently running in your account.
+
+    DORB::Droplet.all
+
+##### Show droplet
+This method returns a droplet for a specific droplet id.
+
+    DORB::Droplet.find id
+
+    DORB::Droplet.find_by_ip ip_address
+
+    DORB::Droplet.find_all_by_name name
+    
+#####  New droplet
+This method allows you to create a new droplet.
+
+    DORB::Droplet.new :name => name, :size => size, :image => image, :region => region, :ssh_keys => [keys]
+
+##### Reboot droplet
+This method allows you to reboot a droplet. This is the preferred method to use if a server is not responding
+
+    droplet.reboot
+
+##### Power cycle droplet
+This method will turn off the droplet and then turn it back on
+
+    droplet.power_cycle
+
+##### Shut down droplet
+This method allows you to shutdown a running droplet. The droplet will remain in your account
+
+    droplet.shutdown
+
+##### Power off droplet
+This method allows you to power off a running droplet. The droplet will remain in your account
+
+    droplet.power_off
+
+##### Power on droplet
+This method allows you to power on a powered off droplet
+
+    droplet.power_on
+
+##### Reset root password
+This method will reset the root password for a droplet. Please be aware that this will reboot the droplet to allow resetting the password.
+
+    droplet.password_reset
+
+##### Resize droplet
+This method allows you to resize a specific droplet to a different size. This will affect the number of processors and memory allocated to the droplet.
+
+    droplet.resize size
+
+##### Take a snapshot
+This method allows you to take a snapshot of the running droplet, which can later be restored or used to create a new droplet from the same image. Please be aware this may cause a reboot.
+
+    droplet.snapshot
+
+##### Restore droplet
+This method allows you to restore a droplet with a previous image or snapshot. This will be a mirror copy of the image or snapshot to your droplet. Be sure you have backed up any necessary information prior to restore.
+
+    droplet.restore image
+
+##### Rebuild droplet
+This method allows you to reinstall a droplet with a default image. This is useful if you want to start again but retain the same IP address for your droplet.
+
+    droplet.rebuild image
+
+##### Enable automatic backups
+This method enables automatic backups which run in the background daily to backup your droplet's data.
+
+    droplet.enable_backups
+
+##### Disable automatic backups
+This method disables automatic backups from running to backup your droplet's data.
+
+    droplet.disable_backups
+
+##### Destroy droplet
+This method destroys one of your droplets - this is irreversible.
+
+    droplet.destroy
+
+### Images
+
+##### All images
+This method returns all the available images that can be accessed by your client ID. You will have access to all public images by default, and any snapshots or backups that you have created in your own account.
+
+    DORB::Image.all
+
+##### Find image
+This method returns an image instance
+
+    DORB::Image.find id
+    
+    DORB::Image.find_all_by_name name
+
+##### Destroy image
+This method allows you to destroy an image. There is no way to restore a deleted image so be careful and ensure your data is properly backed up.
+
+    image.destroy
+
+### SSH Keys
+
+##### All SSH keys
+This method lists all the available public SSH keys in your account that can be added to a droplet.
+
+    DORB::SSHKey.all
+
+##### Find SSH key
+This method returns an SSHKey instance
+
+    DORB::SSHKey.find id
+    
+    DORB::SSHKey.find_all_by_name name
+
+##### Add SSH key
+This method allows you to add a new public SSH key to your account.
+
+    DORB::SSHKey.add name, ssh_key_pub
+
+##### Edit SSH key
+This method allows you to modify an existing public SSH key in your account.
+
+    ssh_key.edit ssh_key_pub
+
+##### Destroy SSH Key
+This method will delete the SSH key from your account.
+
+    ssh_key.destroy
+
+### Sizes
+
+##### All Sizes
+This method returns all the available sizes that can be used to create a droplet.
+
+    DORB::Size.all
+
+### Regions
+
+##### All Regions
+This method will return all the available regions within the Digital Ocean cloud.
+
+    DORB::Region.all
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/dorb.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dorb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dorb"
+  spec.version       = DORB::VERSION
+  spec.authors       = ["Darrin Wortlehock"]
+  spec.email         = ["darrin@exempla.co.uk"]
+  spec.description   = %q{Interact with the Digital Ocean API in an idiomatic ruby way.}
+  spec.summary       = %q{DORB exposes the Digital Ocean API as Ruby objects, has 100% test coverage and supports the entire API.}
+  spec.homepage      = "https://github.com/exempla/dorb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "rest-client"
+  spec.add_dependency "json"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+end

data/lib/dorb.rb

@@ -0,0 +1,18 @@
+require 'rest-client'
+
+require 'dorb/core_ext/hash'
+require 'dorb/version'
+require 'dorb/config'
+require 'dorb/resource'
+require 'dorb/region'
+require 'dorb/size'
+require 'dorb/image'
+require 'dorb/ssh_key'
+require 'dorb/droplet'
+
+module DORB
+  API_ENDPOINT = 'https://api.digitalocean.com'
+  APIError = Class.new StandardError
+  ConfigurationError = Class.new StandardError
+  InvalidStateError = Class.new StandardError
+end

data/lib/dorb/config.rb

@@ -0,0 +1,36 @@
+module DORB
+  module Config
+    attr_writer :client_id, :api_key
+
+    def client_id
+      if @client_id
+        @client_id
+      else
+        raise DORB::ConfigurationError.new \
+          "Cannot complete request. Please set client_id with DORB::Config.setup first!"
+      end
+    end
+
+    def api_key
+      if @api_key
+        @api_key
+      else
+        raise DORB::ConfigurationError.new \
+          "Cannot complete request. Please set api_key with DORB::Config.setup first!"
+      end
+    end
+
+    def setup opts={}
+      opts.map do |k,v|
+        send("#{k}=", v)
+      end
+    end
+
+#    def method_missing(meth, *args, &blk)
+#      const = meth.to_s.upcase
+#      DORB.const_set(const, args.first) unless DORB.const_defined? const
+#    end
+
+    extend self
+  end
+end

data/lib/dorb/core_ext/hash.rb

@@ -0,0 +1,24 @@
+class Hash
+
+  def stringify_keys
+    dup.stringify_keys!
+  end
+
+  def stringify_keys!
+    keys.each do |key|
+      self[key.to_s] = delete(key)
+    end
+  end
+
+  def symbolize_keys
+    dup.symbolize_keys!
+  end
+
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+
+end

data/lib/dorb/droplet.rb

@@ -0,0 +1,10 @@
+module DORB
+  class Droplet
+
+    include Resource
+
+    self.collection_resource_name = 'droplets'
+    self.singular_resource_name = 'droplet'
+
+  end
+end

data/lib/dorb/image.rb

@@ -0,0 +1,10 @@
+module DORB
+  class Image
+
+    include Resource
+
+    self.collection_resource_name = 'images'
+    self.singular_resource_name = 'image'
+
+  end
+end

data/lib/dorb/region.rb

@@ -0,0 +1,10 @@
+module DORB
+  class Region
+
+    include Resource
+
+    self.singular_resource_name = 'region'
+    self.collection_resource_name = 'regions'
+
+  end
+end

data/lib/dorb/resource.rb

@@ -0,0 +1,126 @@
+require 'json'
+require 'rest_client'
+
+module DORB
+  module Resource
+
+    def self.included klass
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      attr_accessor :collection_resource_name
+      attr_accessor :singular_resource_name
+      attr_accessor :attribute_names
+      attr_accessor :extended_attributes
+      alias :extended_attributes? :extended_attributes
+
+      def define_attribute names
+        [names].flatten.each do |name|
+          self.attribute_names = [self.attribute_names].flatten.compact << name
+          attr_accessor(name)
+        end
+      end
+
+      def all(options={})
+        all_attributes = index(options)
+        all_attributes.map do |attributes|
+          if self.extended_attributes?
+            find(attributes['id'])
+          else
+            new(attributes)
+          end
+        end
+      end
+
+      def find(id, options={})
+        api_response = show(id, options)
+        new(api_response)
+      end
+
+      private
+
+      def index(options={}) 
+        call_api
+      end
+
+      def show(id, options={})
+        call_api(id)
+      end
+
+      def create(params={})
+        raise NotImplementedError
+      end
+
+      def update(params={})
+        raise NotImplementedError
+      end
+
+      def delete(params={})
+        raise NotImplementedError
+      end
+
+      def call_api(action=nil, extra_params={})
+        url = url_for_action(action)
+        params = extra_params.merge(credentials)
+        response = RestClient.get url, :params => params do |response, request, result, &block|
+          raise APIError.new(api_call_error_message(request,response)) unless response.code < 400
+          response.return!(request, result, &block)
+        end
+        parse_api_response(response)
+      end
+
+      def api_call_error_message(request, response)
+        "API Call to #{request.method} #{request.url} failed. Response was #{response.description}"
+      end
+
+      def url_for_action(action=nil)
+        uri = URI.parse(DORB::API_ENDPOINT)
+        uri.path << "/#{self.collection_resource_name}"
+        uri.path << "/#{action}" unless action.nil?
+        uri.path.gsub!(/\/\/+/, '/')
+        uri.to_s
+      end
+      
+      def credentials
+        { :client_id => DORB::Config.client_id, :api_key => DORB::Config.api_key }
+      end
+
+      def parse_api_response(response)
+        parsed_response = JSON.parse(response.to_str)
+        unless parsed_response['status'] == 'OK'
+          message = "API call failed."
+          parsed_response.each do |key, value|
+            message << " #{key.gsub('_',' ').capitalize} was '#{value}'."
+          end
+          raise APIError.new(message) 
+        end
+        parsed_response[self.collection_resource_name] || parsed_response[self.singular_resource_name]
+      end
+
+    end
+    
+    attr_accessor :id, :name
+
+    def initialize( attributes={} )
+      required, optional = split_required_attributes(attributes, [:id, :name])
+      self.id = required[:id]
+      self.name = required[:name]
+    end
+
+    private
+
+    def split_required_attributes(attributes, required)
+      optional_attributes = attributes.symbolize_keys
+      required_attributes = {}
+      required.each do |key|
+        required_attributes[key] = optional_attributes.delete(key) do |missing_key|
+          raise ArgumentError.new("Attribute #{missing_key.inspect} is required")
+        end
+      end
+      [required_attributes, optional_attributes]
+    end
+
+  end
+end