oceanarium 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95524a489a1f806147f12e0eff8ae1fe1d69b83a
-  data.tar.gz: fd164db5e292eb6a42d6b947ec7ca1c3d874f899
+  metadata.gz: a4b32f0940005c2be645d5a3d1c484bb4ccf5d1b
+  data.tar.gz: b0ccc326251d4aaf6745c7908e6fdd16e38ec2e7
 SHA512:
-  metadata.gz: b51e657f17dd1c58b788b8f9fd73c5781833d6a4835b9854c609093970424d71fbe8c87d76c7f7e2dcce3154c48bb27e068cc2cf1406828ce9c0786ed36a285d
-  data.tar.gz: d3495ef8e913d93b044b11045bbf74f78852e56b18aca160ebf69bc833f109d413a5021cbb5f497d22c4e592c87520d6320f2115e3977038ee81d4fdbdbf3365
+  metadata.gz: 80ddc350fb123972558594b31dc1753c6c22e47854549f9b59df2f401a9d33dae5b5e5552b2c22b36222fad7527c8c4431eb80b6514065d9bd1935071a63ee4c
+  data.tar.gz: 488d9ebda15d936246d26378297af84842f264dbc0f6bc52e0889728821b6086465a28a569c958397370036ef2fbfcc097a0af50bf396ba96671fe7a12a2f923

data/README.md

@@ -2,27 +2,56 @@
 
 Digital Ocean is good SSD cloud hosting and we love it. So, we wrote this gem for the great justice :) It will help your Ruby/Rails application communicate with Digital Ocean's API.
 
-Warning: there is much work in progress...
-
 Warning: We're not affiliated with Digital Ocean, so we can't guarantee that API, used by this gem, still valid. If you experiencing errors, just ping us (and Digital Ocean).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'oceanarium'
+~~~ruby
+gem 'oceanarium'
+~~~
 
 And then execute:
 
-    $ bundle
+~~~bash
+$ bundle
+~~~
 
 Or install it yourself as:
 
-    $ gem install oceanarium
+~~~bash
+$ gem install oceanarium
+~~~
 
 ## Usage
 
-TODO: Write usage instructions here
+DigitalOcean uses for authentication two keys: API key and Client ID. Before any action you must provide it to current ruby process. In command line you must enter this:
+
+~~~ruby
+Oceanarium::Config.api_key = "your_api_key"
+Oceanarium::Config.client_id = "your_client_id"
+~~~
+
+Now you're ready to use Digital Ocean API. If you using Oceanarium with Rails, you must add file config/initializers/oceanarium.rb with same two lines, as above.
+
+After this, you can use any Digital Ocean API with this gem. All API callers are mnemonic, so you don't need to remember anything -- official Digital Ocean API will be your friend.
+
+For example:
+
+~~~ruby
+Oceanarium::droplet(100500)
+~~~
+
+will return you all droplet information, and
+
+~~~ruby
+Oceanarium::droplet(100500).reboot
+~~~
+
+will reboot it.
+
+And so on, and so on, and so on, and... read the official gem documentation at http://oceanarium.so for more verbose help.
 
 ## Contributing
 

data/lib/oceanarium/resources/region.rb

@@ -1,6 +1,6 @@
 module Oceanarium
   class Region
-    attr_accessor :id, :name
+    attr_accessor :id, :name, :slug
 
     def initialize(option, api_key, client_id)
       if api_key.nil? || client_id.nil?
@@ -14,6 +14,7 @@ module Oceanarium
         else
           self.id = @object['id']
           self.name = @object['name']
+          self.slug = @object['slug']
         end
       end
     end

data/lib/oceanarium/version.rb

@@ -1,3 +1,3 @@
 module Oceanarium
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/oceanarium.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["iam@toofat.ru"]
   spec.description   = %q{Digital Ocean API wrapper for Ruby/Rails applications}
   spec.summary       = %q{Smart and tiny Digital Ocean API wrapper for Ruby/Rails. For all dirty work used httparty.}
-  spec.homepage      = "http://delta-zet.com"
+  spec.homepage      = "http://oceanarium.so"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oceanarium
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Valdos Sine
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,7 +92,7 @@ files:
 - lib/oceanarium/resources/sshkey.rb
 - lib/oceanarium/version.rb
 - oceanarium.gemspec
-homepage: http://delta-zet.com
+homepage: http://oceanarium.so
 licenses:
 - MIT
 metadata: {}