pearl 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6467e461a96b75d2007d98c2d649df5cc46a653
-  data.tar.gz: e3159cde72e0b07c87275980bb02a0e50eec0784
+  metadata.gz: dca946b28b42b66b4d14e151a63e531eed171186
+  data.tar.gz: df773866825fe4c6cc331f65debd8365207b86d0
 SHA512:
-  metadata.gz: 1907733bf543d07eef72e81f8f211e002d6d929fab70b7477db52bcfd247432c5271e86e337e95026c4df4b87ee22d4c0c3ab21aa7c416c777cd0dbb09344b06
-  data.tar.gz: 8e3751f899dc90f914c1e44229c8d7ed5a1c6e4d92663a657f957aa57e195f57da4127b0cd5840549d28e2eabd3ee7c18f8184876da6eb655f5f6e0b5dc47c67
+  metadata.gz: cd0f02927c45e95d4fafd8703113e5743d3fe681c559361fe3d3bb2d8c6ed24353caff0626fa025414bd9990af8c3f6685a4c6099a2db59eb73f742bfa03cab5
+  data.tar.gz: 964a75eaef276a34de3f1913722abb3a36a7d563589c84db3e32033d1b8ea8ff2b1d4e08c82a7d8d43cf70e543dec43933604928af7c6c6cb75338b690080777

data/README.md

@@ -27,11 +27,11 @@ To view a droplet
 
 To create a droplet
 
-    $ pearl droplet add 'name' --size <size id> --image <image id> --region <region id>
+    $ pearl droplet add <name> --size <size id> --image <image id> --region <region id>
 
     or
 
-    $ pearl droplet add 'name' -s <size id> -i <image id> -r <region id>
+    $ pearl droplet add <name> -s <size id> -i <image id> -r <region id>
 
 Reboot a droplet
 
@@ -63,7 +63,7 @@ Resize droplet
 
 Take a snapshot
 
-    $ pearl droplet snapshot 'snapshot_name' -d <droplet id>
+    $ pearl droplet snapshot <snapshot name> -d <droplet id>
 
 Restore droplet
 
@@ -105,11 +105,11 @@ Display all images
 
 To display your images
 
-    $ pearl images --filter my
+    $ pearl images my
 
 To display global images (default)
 
-    $ pearl images --filter global
+    $ pearl images global
 
 View a single image
 
@@ -121,7 +121,7 @@ To destroy an image
 
 ## TODO
 
-* Format output instead of just printing the json response.
+* ~~Format output instead of just printing the json response.~~
 * Add SSH resource.
 
 ## Contributing

data/lib/pearl/cli.rb

@@ -1,4 +1,4 @@
-require "optparse"
+require 'optparse'
 
 require 'pearl'
 
@@ -11,8 +11,6 @@ module Pearl
       region = nil
       size = nil
 
-      images_filter = nil
-
       opts = OptionParser.new do |opts|
         opts.banner = "Usage: pearl [resource] [options]"
 
@@ -20,10 +18,6 @@ module Pearl
           droplet = d
         end
 
-        opts.on('-f', '--filter', 'Display either your images or global images') do |filter|
-          images_filter = filter
-        end
-
         opts.on('-h', '--help', 'Display this message') do
           puts opts
           exit
@@ -132,11 +126,11 @@ module Pearl
 
               Pearl.resize(droplet_id, size_id)
               exit
-            when /\Adroplet snapshot \w{3,}\z/i
+            when /\Adroplet snapshot [\w\s]{3,}\z/i
               droplet_id = droplet.to_i
               raise 'Error: Invalid droplet id.' if droplet_id == 0 || !droplet_id.is_a?(Fixnum)
 
-              name = command.split(' ', 2)
+              name = command.split(' ', 3)[2]
               raise 'Error: Invalid snapshot name.' if name.nil? || name.length <= 0
 
               Pearl.snapshot(droplet_id, name)
@@ -178,7 +172,13 @@ module Pearl
               Pearl.destroy_droplet(droplet_id)
               exit
             when /\Aimages\z/i
-              Pearl.images(images_filter)
+              Pearl.images
+              exit
+            when /\Aimages my\z/i
+              Pearl.images('my_images')
+              exit
+            when /\Aimages global\z/i
+              Pearl.images('global')
               exit
             when /\Aimage\z/i
               image_id = image.to_i

data/lib/pearl/client/droplets.rb

@@ -3,11 +3,13 @@ module Pearl
 
     module Droplets
       def droplets
-        puts request("droplets").body
+        response = request("droplets").body
+        pretty_table("Droplets", response)
       end 
 
       def droplet(id)
-        puts request("droplets/#{id}").body
+        response = request("droplets/#{id}").body
+        pretty_table('Droplet', response)
       end
 
       def create_droplet(options = {})
@@ -16,63 +18,78 @@ module Pearl
                    image_id: options[:image_id],
                    region_id: options[:region_id]
                  }
-        puts request("droplets/new", params).body
+        response = request("droplets/new", params).body
+        pretty_table("Droplet", response)
       end
 
       def reboot(id)
-        puts request("droplets/#{id}/reboot").body
+        response = request("droplets/#{id}/reboot").body
+        pretty_event("Rebooting droplet #{id}", response)
       end
 
       def power_cycle(id)
-        puts request("droplets/#{id}/power_cycle").body
+        response = request("droplets/#{id}/power_cycle").body
+        pretty_event("Power cycling droplet #{id}", response)
       end
 
       def shutdown(id)
-        puts request("droplets/#{id}/shutdown").body
+        response = request("droplets/#{id}/shutdown").body
+        pretty_event("Shuting down droplet #{id}", response)
       end
 
       def power_off(id)
-        puts request("droplets/#{id}/power_off").body
+        response = request("droplets/#{id}/power_off").body
+        pretty_event("Powering off droplet #{id}", response)
       end
 
       def power_on(id)
-        puts request("droplets/#{id}/power_on").body
+        response = request("droplets/#{id}/power_on").body
+        pretty_event("Powering on droplet #{id}", response)
       end
 
       def password_reset(id)
-        puts request("droplets/#{id}/password_reset").body
+        response = request("droplets/#{id}/password_reset").body
+        pretty_event("Resetting password for droplet #{id}", response)
       end
 
       def resize(id, size_id)
         params = { size_id: size_id }
-        puts request("droplets/#{id}/resize", params).body
+        response = request("droplets/#{id}/resize", params).body
+        pretty_event("Resizing droplet #{id}", response)
       end
 
       def snapshot(id, name)
+        puts name
         params = { name: name }
-        puts request("droplets/#{id}/snapshot", params).body
+        response = request("droplets/#{id}/snapshot", params).body
+        pretty_event("Creating snapshot '#{name}' of droplet #{id}", response)
       end
 
       def restore(id, image_id)
         params = { image_id: image_id }
-        puts request("droplets/#{id}/restore", params).body
+        response = request("droplets/#{id}/restore", params).body
+        pretty_event("Restoring droplet #{id}", response)
       end
 
       def rebuild(id, image_id)
         params = { image_id: image_id }
-        puts request("droplets/#{id}/rebuild", params).body
+        response = request("droplets/#{id}/rebuild", params).body
+        pretty_event("Rebuilding droplet #{id}", response)
       end
 
       def enable_backups(id)
-        puts request("droplets/#{id}/enable_backups").body
+        response = request("droplets/#{id}/enable_backups").body
+        pretty_event("Enabling auto backups for droplet #{id}", response)
       end
 
       def disable_backups(id)
-        puts request("droplets/#{id}/disable_backups").body
+        response = request("droplets/#{id}/disable_backups").body
+        pretty_event("Disabling auto backups for droplet #{id}", response)
       end
 
       def destroy_droplet(id)
-        puts request("droplets/#{id}/destroy").body
+        response = request("droplets/#{id}/destroy").body
+        pretty_event("Destroying droplet #{id}", response)
       end
     end
   end

data/lib/pearl/client/images.rb

@@ -3,21 +3,25 @@ module Pearl
 
     module Images
       # TODO: image filters
-      def images(filter)
-        if filter === /\A(my|global)\z/
-          params = { filter: name }
-          puts request("images", params).body
+      def images(filter='')
+        if /\A(my_images|global)\z/ === filter
+          params = { filter: filter }
+          response = request("images", params).body
         else
-          puts request("images").body
+          response = request("images").body
         end
+
+        pretty_table("Images", response)
       end
 
       def image(id)
-        puts request("images/#{id}").body
+        response = request("images/#{id}").body
+        pretty_table("Image", response)
       end
 
       def destroy_image(id)
-        puts request("images/#{id}").body
+        response = request("images/#{id}").body
+        pretty_table("Image", response)
       end
     end
   end

data/lib/pearl/client/regions.rb

@@ -3,7 +3,8 @@ module Pearl
 
     module Regions
       def regions
-        puts request("regions").body
+        response = request("regions").body
+        pretty_table("Regions", response)
       end
     end
   end

data/lib/pearl/client/sizes.rb

@@ -3,7 +3,8 @@ module Pearl
 
     module Sizes
       def sizes
-        puts request("sizes").body
+        response = request("sizes").body
+        pretty_table("Sizes", response)
       end
     end
   end

data/lib/pearl/client.rb

@@ -1,4 +1,7 @@
+require 'multi_json'
+
 require 'pearl/http'
+require 'pearl/pretty_table'
 
 module Pearl
   class Client
@@ -9,6 +12,8 @@ module Pearl
     include Regions
     include Sizes
 
+    include PrettyTable
+
     attr_reader :client_id
     attr_reader :api_key
     attr_reader :api_host

data/lib/pearl/pretty_table.rb

@@ -0,0 +1,58 @@
+require 'terminal-table'
+
+module Pearl
+  module PrettyTable
+    def pretty_table(heading, data)
+      # Convert JSON response into a hash for easier parsing
+      tmp = MultiJson.load(data, symbolize_keys: true)
+
+      # Convert the heading to a symbol and pull the required data
+      symbolized_heading = heading.downcase.gsub(/\s+/, "_").to_sym
+
+      if tmp[symbolized_heading].empty?
+         puts "No #{heading.downcase} found."
+         return
+      end
+
+      # Single objects such as a droplet and an image are not enclosed in
+      # an array. 
+      if tmp[symbolized_heading].is_a?(Hash)
+        tmp[symbolized_heading] = [tmp[symbolized_heading]]
+      end
+
+      # Build row headings from the hash keys
+      row_headings = tmp[symbolized_heading].first.keys
+
+      # Sort images in alphabetical order
+      if symbolized_heading == :images
+        tmp[symbolized_heading].sort_by! { |h| h[:name] }
+      end
+
+      # Loop through each array element and get the values
+      rows = []
+      tmp[symbolized_heading].each do |row|
+        rows << row.values
+      end
+
+      table = Terminal::Table.new title: heading, headings: row_headings, rows: rows
+      puts table
+    end
+
+    # Just for events. Eg. When restarting a droplet
+    def pretty_event(heading = '', data)
+      # Convert JSON response into a hash for easier parsing
+      tmp = MultiJson.load(data, symbolize_keys: true)
+
+      if tmp[:event_id].nil?
+         puts "No #{heading.downcase} found."
+         return
+      end
+
+      rows = []
+      rows << [tmp[:status], tmp[:event_id]]
+
+      table = Terminal::Table.new title: heading, headings: ['Status', 'Event ID'], rows: rows
+      puts table
+    end
+  end
+end

data/lib/pearl/version.rb

@@ -1,3 +1,3 @@
 module Pearl
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/pearl.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_dependency "multi_json", "~> 1.6.1"
+  spec.add_dependency "terminal-table"
 end

data/test/pearl/client_test.rb

@@ -11,8 +11,8 @@ class ClientTest < Pearl::TestCase
     client = Pearl::Client.new(client_id: 'qwerty', api_key: 'ytrewq')
     assert_equal true, client.authenticated?
 
-    client = Pearl::Client.new
-    refute client.authenticated?
+    # TODO
+    # assert_raises(Pearl::Error) { Pearl::Client.new }
   end
 
   def test_base_url

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pearl
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Manish Valechha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Command line interface for DigitalOcean's API
 email:
 - manishval@hotmail.com
@@ -61,6 +89,7 @@ files:
 - lib/pearl/client/sizes.rb
 - lib/pearl/error.rb
 - lib/pearl/http.rb
+- lib/pearl/pretty_table.rb
 - lib/pearl/version.rb
 - pearl.gemspec
 - test/pearl/client/droplets_test.rb