oceanic 0.0.0a

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'faraday'
+gem 'faraday_middleware'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Vince Salinas
+
+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,11 @@
+        )                                  
+     ( /(                                  
+     )\())         (     )        (        
+    ((_)\    (    ))\ ( /(   (    )\   (   
+      ((_)   )\  /((_))(_))  )\ )((_)  )\  
+     / _ \  ((_)(_)) ((_)_  _(_/( (_) ((_) 
+    | (_) |/ _| / -_)/ _` || ' \))| |/ _|  
+     \___/ \__| \___|\__,_||_||_| |_|\__|  
+-----
+# Oceanic
+Oceanic makes it simple to utilize the DigitalCloud API from Ruby. More documentation to follow.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/oceanic.rb

@@ -0,0 +1,82 @@
+# Public: This is the main namespace for Oceanic.  You can either use it to
+# create Oceanic::Client objects, or access it directly.
+#
+# Examples
+#
+#   Oceanic.client_id = 'TSQbHoqi771ivc17S1ksp'
+#   Oceanic.api_key = 'efdejo4W5BIGsWmqEOQbJmxQNis4tNoQ75jWZJMw1'
+#   Oceanic.droplets
+#
+#   client = Oceanic.new 'TSQbHoqi771ivc17S1ksp', 'efdejo4W5BIGsWmqEOQbJmxQNis4tNoQ75jWZJMw1'
+#   client.droplets
+#
+module Oceanic
+  VERSION = "0.0.0a"
+
+  class << self
+    # Public: Gets or sets the API Key that Oceanic uses for requests.
+    # This is provided by DigitalOcean.
+    attr_accessor :api_key
+
+    # Public: Gets or sets the Client ID that Oceanic uses for requests.
+    # This is provided by DigitalOcean.
+    attr_accessor :client_id
+
+    # Public: Gets or sets the path that Oceanic libs are loaded from.
+    attr_accessor :lib_path
+
+    # Public: Sets the default Oceanic::Client for simple scripts that
+    # access the Oceanic constant directly.
+    #
+    #   Oceanic.droplets
+    attr_writer :default_client
+
+    # Public: Initializes a new Oceanic::Client.
+    #
+    # client_id - Your Client ID provided by DigitalOcean.
+    # api_key   - Your API Key provided by DigitalOcean.
+    #
+    # Example
+    #
+    #   Oceanic.new 'TSQbHoqi771ivc17S1ksp', 'efdejo4W5BIGsWmqEOQbJmxQNis4tNoQ75jWZJMw1'
+    #
+    # Returns a Oceanic::Client.
+    def new(client_id = nil, api_key = nil)
+      client_id ||= @client_id
+      api_key ||= @api_key
+      Oceanic::Client.new(client_id, api_key)
+    end
+
+    # Internal: Requires internal Oceanic libraries.
+    #
+    # *libs - One or more relative String names to Oceanic classes.
+    #
+    # Returns nothing.
+    def require_libs(*libs)
+      libs.each do |lib|
+        require "#{lib_path}/#{lib}"
+      end
+    end
+
+    alias require_lib require_libs
+
+    private
+    # Internal: Proxies method calls on the Oceanic constant to
+    # #default_client.
+    def method_missing(name, *args, &block)
+      default_client.send(name, *args, &block)
+    end
+  end
+
+  self.lib_path = File.expand_path "../oceanic", __FILE__
+
+  # Gets the default client used for simple scripts.
+  #
+  # Returns an Oceanic::Client, configured with #client_id and
+  # #api_key
+  def self.default_client
+    @default_client ||= Connection.new(@client_id, @api_key)
+  end
+
+  require_libs 'image', 'size', 'region', 'ssh_key', 'droplet', 'client'
+end

data/lib/oceanic/client.rb

@@ -0,0 +1,210 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Oceanic
+  # Public: Client objects manage the API requests made to DigitalOcean.
+  #
+  # Examples
+  #
+  #   client = Oceanic.new 'TSQbHoqi771ivc17S1ksp', 'efdejo4W5BIGsWmqEOQbJmxQNis4tNoQ75jWZJMw1'
+  #   # List droplets in account
+  #   client.droplets
+  #   # => {"status" => "OK",
+  #         "droplets" => [{"backups_active" => nil,
+  #                         "id" => 100823,
+  #                         "image_id" => 420,
+  #                         "name" => "test222",
+  #                         "region_id" => 1,
+  #                         "size_id" => 33,
+  #                         "status" => "active"}]}
+  #
+  class Client
+    # Public: Gets the Client ID for this Client.
+    attr_reader :client_id
+
+    # Public: Gets the API Key for this Client.
+    attr_reader :api_key
+
+    def initialize(client_id, api_key)
+      raise ArgumentError, "An Oceanic::Client requires a Client ID." unless client_id
+      raise ArgumentError, "An Oceanic::Client requires an API Key." unless api_key
+
+      @client_id = client_id
+      @api_key = api_key
+      fd_options = {
+        headers: {'Accept' => 'application/json'},
+        ssl: {verify: false},
+        url: 'https://api.digitalocean.com/',
+        params: {client_id: @client_id, api_key: @api_key}
+      }
+      @responses = []
+      @connection = Faraday.new(fd_options) do |fd|
+        fd.request :url_encoded
+        fd.use FaradayMiddleware::ParseJson
+        fd.use FaradayMiddleware::FollowRedirects
+        fd.adapter :net_http
+      end
+    end
+
+    def droplets
+      res = request 'droplets'
+      if ok?
+        Droplets.new(self, @response['droplets'].map{|x| Droplet.new(self, x)})
+      end
+    end
+
+    def droplet(id)
+      request("droplets/#{id}")
+      if ok?
+        Droplet.new(self, @response['droplet'])
+      end
+    end
+
+    def droplet_create(name, size_id, image_id, region_id, ssh_key_ids = nil)
+      params = {name: name, size_id: size_id, image_id: image_id, region_id: region_id}
+      if ssh_key_ids
+        if ssh_key_ids.is_a?(String)
+          params[:ssh_key_ids] = ssh_key_ids
+        elsif ssh_key_ids.is_a?(Array)
+          params[:ssh_key_ids] = ssh_key_ids.join(',')
+        end
+      end
+      request 'droplets/new', params
+    end
+
+    def droplet_reboot(id)
+      request "droplets/#{id}/reboot"
+    end
+
+    def droplet_cycle(id)
+      request "droplets/#{id}/power_cycle"
+    end
+
+    def droplet_shutdown(id)
+      request "droplets/#{id}/shutdown"
+    end
+
+    def droplet_off(id)
+      request "droplets/#{id}/power_off"
+    end
+
+    def droplet_on(id)
+      request "droplets/#{id}/power_on"
+    end
+
+    def droplet_password_reset(id)
+      request "droplets/#{id}/password_reset"
+    end
+
+    def droplet_resize(id, size_id)
+      request "droplets/#{id}/reboot", {size_id: size_id}
+    end
+
+    def droplet_snapshot(id, snapshot_name)
+      request "droplets/#{id}/snapshot", {name: snapshot_name}
+    end
+
+    def droplet_restore(id, image_id)
+      request "droplets/#{id}/restore", {image_id: image_id}
+    end
+
+    def droplet_rebuild(id, image_id)
+      request "droplets/#{id}/rebuild", {image_id: image_id}
+    end
+
+    def droplet_enable_backups(id)
+      request "droplets/#{id}/enable_backups"
+    end
+
+    def droplet_disable_backups(id)
+      request "droplets/#{id}/disable_backups"
+    end
+
+    def droplet_destroy(id)
+      request "droplets/#{id}/destroy"
+    end
+
+    def regions
+      request 'regions'
+      if ok?
+        @response['regions'].map{|x| Region.new(self, x)}
+      end
+    end
+
+    def images
+      request 'images'
+      if ok?
+        @response['images'].map{|x| Image.new(self, x)}
+      end
+    end
+
+    def image(id)
+      request "images/#{id}"
+      if ok?
+        Image.new(self, @response['image'])
+      end
+    end
+
+    def image_destroy(id)
+      request "images/#{id}/destroy"
+    end
+
+    def ssh_keys
+      res = request 'ssh_keys'
+      if ok?
+        SshKeys.new(self, @response['ssh_keys'].map{|x| SshKey.new(self, x)})
+      end
+    end
+
+    def ssh_key(id)
+      request "ssh_keys/#{id}"
+      SshKey.new(self, @response['ssh_key'])
+    end
+
+    def ssh_key_create(name, public_key)
+      request 'ssh_keys/new', {name: name, ssh_pub_key: public_key}
+    end
+
+    def ssh_key_edit(id, new_public_key)
+      request "ssh_keys/#{id}/edit", {ssh_pub_key: new_public_key}
+    end
+
+    def ssh_key_destroy(id)
+      request "ssh_keys/#{id}/destroy"
+    end
+
+    def sizes
+      request 'sizes'
+      if ok?
+        @response['sizes'].map{|x| Size.new(self, x)}
+      end
+    end
+
+    def to_s
+      "(Oceanic::Client client_id: '#{@client_id}', api_key: '#{@api_key}')"
+    end
+
+    private
+    def ok?
+      @response || @response['status'] == 'OK'
+    end
+
+    def request(endpoint, params = {})
+      params[:client_id] = @client_id
+      params[:api_key] = @api_key
+      params.each do |k,v|
+        if v.is_a?(Image) or v.is_a?(Size) or v.is_a?(Region)
+          params[k] = v.id
+        end
+      end
+      resp = @connection.get "/#{endpoint}/"
+      if resp.body
+        @response = resp.body
+        @responses << @response
+      else
+        @response = nil
+        @responses << @response
+      end
+    end
+  end
+end

data/lib/oceanic/droplet.rb

@@ -0,0 +1,100 @@
+module Oceanic
+  class Droplets < Array
+    def initialize(client, array)
+      super()
+      @client = client
+      array.each{|x| self << x}
+    end
+
+    def new(name, size_id, image_id, region_id, ssh_key_ids = nil)
+      @client.droplet_create(name, size_id, image_id, region_id, ssh_key_ids)
+    end
+  end
+
+  class Droplet
+    attr_reader :id
+    attr_reader :name
+    attr_reader :size_id
+    attr_reader :image_id
+    attr_reader :region_id
+    attr_reader :ip_address
+    attr_reader :status
+    attr_reader :ssh_key_ids
+
+    def initialize(client, hash)
+      @client = client
+      @id = hash['id']
+      @name = hash['name']
+      @size_id = hash['size_id']
+      @image_id = hash['image_id']
+      @region_id = hash['region_id']
+      @ip_address = hash['ip_address']
+      @status = hash['status']
+      @ssh_key_ids = hash['ssh_key_ids']
+    end
+
+    def size_id= value
+      resize(value)
+    end
+
+    def image_id= value
+      rebuild(value)
+    end
+
+    def reboot
+      @client.droplet_reboot(@id)
+    end
+
+    def cycle
+      @client.droplet_cycle(@id)
+    end
+
+    def shutdown
+      @client.droplet_shutdown(@id)
+    end
+
+    def off
+      @client.droplet_off(@id)
+    end
+
+    def on
+      @client.droplet_on(@id)
+    end
+
+    def password_reset
+      @client.droplet_password_reset(@id)
+    end
+
+    def resize(size_id)
+      @client.droplet_resize(@id, size_id)
+    end
+
+    def snapshot(snapshot_name)
+      @client.droplet_snapshot(@id, snapshot_name)
+    end
+
+    def restore(image_id)
+      @client.droplet_restore(@id, image_id)
+    end
+
+    def rebuild(image_id)
+      @client.droplet_rebuild(@id, image_id)
+    end
+
+    def enable_backups
+      @client.droplet_enable_backups(@id)
+    end
+
+    def disable_backups
+      @client.droplet_disable_backups(@id)
+    end
+
+    def destroy
+      @client.droplet_destroy(@id)
+    end
+
+    def to_s
+      "(Oceanic::Droplet id: #{id}, name: '#{@name}', ip_address: '#{@ip_address}', status: '#{@status}', size_id: #{@size_id}, image_id: #{@image_id}, region_id: #{@region_id}, ssh_key_ids: #{@ssh_key_ids.to_s})"
+    end
+  end
+end

data/lib/oceanic/image.rb

@@ -0,0 +1,22 @@
+module Oceanic
+  class Image
+    attr_reader :id
+    attr_reader :name
+    attr_reader :distribution
+
+    def initialize(client, hash)
+      @client = client
+      @id = hash['id']
+      @name = hash['name']
+      @distribution = hash['distribution']
+    end
+
+    def destroy
+      @client.image_destroy(@id)
+    end
+
+    def to_s
+      "(Oceanic::Image id: #{id}, name: '#{@name}', distribution: '#{@distribution}')"
+    end
+  end
+end

data/lib/oceanic/region.rb

@@ -0,0 +1,16 @@
+module Oceanic
+  class Region
+    attr_reader :id
+    attr_reader :name
+
+    def initialize(client, hash)
+      @client = client
+      @id = hash['id']
+      @name = hash['name']
+    end
+
+    def to_s
+      "(Oceanic::Region id: #{id}, name: '#{@name}')"
+    end
+  end
+end

data/lib/oceanic/size.rb

@@ -0,0 +1,16 @@
+module Oceanic
+  class Size
+    attr_reader :id
+    attr_reader :name
+
+    def initialize(client, hash)
+      @client = client
+      @id = hash['id']
+      @name = hash['name']
+    end
+
+    def to_s
+      "(Oceanic::Size id: #{id}, name: '#{@name}')"
+    end
+  end
+end

data/lib/oceanic/ssh_key.rb

@@ -0,0 +1,46 @@
+module Oceanic
+  class SshKeys < Array
+    def initialize(client, array)
+      super()
+      @client = client
+      array.each{|x| self << x}
+    end
+
+    def new(name, public_key)
+      @client.ssh_key_create(name, public_key)
+      # check result...
+      # self << SshKey.new(@client, result['id'], result['name'], result['public_key']
+    end
+  end
+
+  class SshKey
+    attr_reader :id
+    attr_reader :name
+    attr_reader :public_key
+
+    def initialize(client, hash)
+      @client = client
+      @id = hash['id']
+      @name = hash['name']
+      @public_key = hash['public_key']
+    end
+
+    def public_key= value
+      edit(value)
+    end
+
+    def edit(new_public_key)
+      @client.ssh_key_edit(@id, new_public_key)
+      # check result...
+      # @public_key = new_public_key
+    end
+
+    def destroy
+      @client.droplet_destroy(@id)
+    end
+
+    def to_s
+      "(Oceanic::SshKey id: #{id}, name: '#{@name}', public_key: '#{@public_key.slice(0,20)}...')"
+    end
+  end
+end

data/oceanic.gemspec

@@ -0,0 +1,32 @@
+lib = 'oceanic'
+lib_file = File.expand_path("../lib/#{lib}.rb", __FILE__)
+File.read(lib_file) =~ /\bVERSION\s*=\s*["'](.+?)["']/
+version = $1
+
+Gem::Specification.new do |spec|
+  spec.specification_version = 1 if spec.respond_to? :specification_version=
+  spec.required_rubygems_version = '>= 1.3.6'
+
+  spec.name          = lib
+  spec.version       = version
+
+  spec.summary       = %q{DigitalOcean API library}
+  spec.description   = %q{Library for interaction with the DigitalOcean API.}
+
+  spec.authors       = ["Vince Salinas"]
+  spec.email         = ["kojul@kojul.com"]
+  spec.homepage      = "https://github.com/kojul/oceanic"
+  spec.licenses      = ['MIT']
+
+  spec.add_dependency "faraday", '>= 0.8.6'
+  spec.add_dependency "faraday_middleware", '>= 0.9.0'
+
+  spec.files  = %w(README.md LICENSE.md Gemfile Rakefile)
+  spec.files << "#{lib}.gemspec"
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.files += Dir.glob("test/**/*.rb")
+
+  dev_null           = File.exist?('/dev/null') ? '/dev/null' : 'NUL'
+  git_files          = `git ls-files -z 2>#{dev_null}`
+  spec.files        &= git_files.split("\0") if $?.success?
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: oceanic
+version: !ruby/object:Gem::Version
+  version: 0.0.0a
+  prerelease: 5
+platform: ruby
+authors:
+- Vince Salinas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Library for interaction with the DigitalOcean API.
+email:
+- kojul@kojul.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE.md
+- Gemfile
+- Rakefile
+- oceanic.gemspec
+- lib/oceanic/client.rb
+- lib/oceanic/droplet.rb
+- lib/oceanic/image.rb
+- lib/oceanic/region.rb
+- lib/oceanic/size.rb
+- lib/oceanic/ssh_key.rb
+- lib/oceanic.rb
+homepage: https://github.com/kojul/oceanic
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 1
+summary: DigitalOcean API library
+test_files: []