digital_ocean 0.0.1alpha1 → 0.0.1

data/.travis.yml

@@ -7,3 +7,6 @@ rvm:
   - ruby-head
   - jruby-head
 script: bundle exec rake test
+matrix:
+  allow_failures:
+    - rvm: 1.8.7

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Roland Moriz
+Copyright (c) 2013 Moriz GmbH
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,8 +1,13 @@
 # DigitalOcean
+[![Build Status](https://travis-ci.org/rmoriz/digital_ocean.png)](https://travis-ci.org/rmoriz/digital_ocean)
 
-TODO: Write a gem description
+DigitalOcean provides simple cloud hosting. Create and delete
+SSD-based virtual machines within seconds for a very affordable price.
 
-[![Build Status](https://travis-ci.org/rmoriz/digital_ocean.png)](https://travis-ci.org/rmoriz/digital_ocean)
+Go to https://www.digitalocean.com/ for more information.
+
+This gem is a simple ruby wrapper for the HTTP API of DigitalOcean using
+the great [Faraday](https://github.com/lostisland/faraday) library.
 
 
 ## Installation
@@ -19,9 +24,76 @@ Or install it yourself as:
 
     $ gem install digital_ocean
 
+## Prerequisite: Create an account and API credentials
+
+[![Create API credentials](http://i.imgur.com/1iYdSFF.png)](https://www.digitalocean.com/login)
+
 ## Usage
 
-TODO: Write usage instructions here
+### Examples
+
+```ruby
+require 'digital_ocean'
+
+# 1. create a client instance
+#
+dc = DigitalOcean::API.new :client_id => 'YOUR_CLIENT_ID', 
+                           :api_key   => 'YOUR_API_KEY'
+
+# 2. get all regions (server locations)
+#
+res = dc.regions.list
+res.regions.size # => 2
+res.regions.first.name # => "New York 1"
+
+# 3. get all available machine types (sizes)
+#
+res = dc.sizes.list
+res.sizes
+# => [#<Hashie::Rash id=66 name="512MB">, 
+#     #<Hashie::Rash id=63 name="1GB">, 
+#     #<Hashie::Rash id=62 name="2GB">, 
+#     #<Hashie::Rash id=64 name="4GB">, 
+#     #<Hashie::Rash id=65 name="8GB">, 
+#     #<Hashie::Rash id=61 name="16GB">, 
+#     #<Hashie::Rash id=60 name="32GB">, 
+#     #<Hashie::Rash id=70 name="48GB">, 
+#     #<Hashie::Rash id=69 name="64GB">, 
+#     #<Hashie::Rash id=68 name="96GB">]
+
+# 4. get all available images (e.g. OS-Images, snapshots, backups)
+#
+res = dc.images.list
+res.images
+# => [#<Hashie::Rash distribution="CentOS" id=1601 name="CentOS 5.8 x64">, 
+#     #<Hashie::Rash distribution="CentOS" id=1602 name="CentOS 5.8 x32">, 
+#     ...
+#     #<Hashie::Rash distribution="Ubuntu" id=2676 name="Ubuntu 12.04 x64 Server">, 
+#     ...
+#     #<Hashie::Rash distribution="Ubuntu" id=25306 name="Ubuntu 12.10 x32 Server">,
+#     ...]
+
+# 5. start a new instance (called droplet)
+# 
+res = dc.droplets.create :name      => 'new_hostname',
+                         :size_id   => 64,
+                         :image_id  => 2676,
+                         :region_id => 1
+
+# 6. query droplet status (e.g. to get the IP of a droplet)
+#
+res = dc.droplets.list
+res.droplets
+# => [#<Hashie::Rash backups_active=false id=123456 
+#                    image_id=25306 ip_address="123.123.123.123" 
+#                    name="new_hostname" region_id=1 size_id=64 
+#                    status="active">]
+
+```
+
+see ```spec/api_spec.rb``` for more details and all implemented
+resources.
+
 
 ## Contributing
 
@@ -30,3 +102,12 @@ TODO: Write usage instructions here
 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
+
+## License
+
+MIT
+
+## Copyright
+
+2013 Moriz GmbH, https://moriz.de/
+

data/digital_ocean.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{A Ruby gem to interact with DigitalOcean, a cloud hosting provider}
   gem.summary       = %q{This gem wraps the DigitalOcean API documented at https://api.digitalocean.com/}
   gem.homepage      = 'https://github.com/rmoriz/digital_ocean'
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/digital_ocean/version.rb

@@ -1,3 +1,3 @@
 module DigitalOcean
-  VERSION = '0.0.1alpha1'
+  VERSION = '0.0.1'
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: digital_ocean
 version: !ruby/object:Gem::Version
-  version: 0.0.1alpha1
-  prerelease: 5
+  version: 0.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Roland Moriz
@@ -277,7 +277,8 @@ files:
 - spec/vcr/cassettes/DigitalOcean_API/_ssh_keys/_show/valid/should_return_a_list_of_all_SSH_keys.yml
 - spec/vcr/cassettes/DigitalOcean_API/_ssh_keys/_show/valid/should_return_the_public_keykey.yml
 homepage: https://github.com/rmoriz/digital_ocean
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -290,13 +291,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -831541192267422241
+      hash: -4331574479850875147
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: -4331574479850875147
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23