grate-handle 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,59 @@
+= grate-handle
+
+Grate Handle is a ruby library and a CLI tool which simplify work with [GoGrid](www.gogrid.com). It is built on top of [GoGrid REST API](http://wiki.gogrid.com/wiki/index.php/API).
+
+Currently Grate Handle is under lazy development, but I hope that it will become usable in a couple of weeks.
+
+== Getting Started
+
+First install grate-handle.
+
+<pre>
+<code>
+sudo gem install grate-handle
+</code>
+</pre>
+
+Then create a .ghrc file in your home directory. This file will store the GoGrid's API credentials. It's a YAML file, so the structure will look like this:
+
+<pre>
+<code>
+% cat ~/.ghrc
+---
+- account: default
+  apikey: YOUR_APIKEY
+  secret: YOUR_SECRET
+</code>
+</pre>
+
+After putting correct credentials into config file it's good to synchronize the time with internet, cause GoGrid uses timestamps in API
+
+<pre>
+<code>
+% cat ~/.ghrc
+---
+- account: kishanov
+  apikey: 12d957fd52ac93e7
+  secret: bebebe
+</code>
+</pre>
+
+Finally, you can run gh command to see the usage. Now you are ready to work with GoGrid using CLI!
+
+<pre>
+<code>
+% gh
+usage: gh ACTION ENTITY [ARGS]
+
+Note that not all ACTIONs applicable to every ENTITY.
+Available combinations are:
+	list servers        Shows all servers in all states
+	list images         Shows all available server images (both legacy and MyGSI)
+	list passwords      Shows root login credentials for all servers
+	list ips            Shows all all ips in all states of all types.
+</code>
+</pre>
+
+== Copyright
+
+Copyright (c) 2009 Kirill Ishanov. See LICENSE for details.

data/README.rdoc

@@ -4,6 +4,56 @@ Grate Handle is a ruby library and a CLI tool which simplify work with [GoGrid](
 
 Currently Grate Handle is under lazy development, but I hope that it will become usable in a couple of weeks.
 
+== Getting Started
+
+First install grate-handle.
+
+<pre>
+<code>
+sudo gem install grate-handle
+</code>
+</pre>
+
+Then create a .ghrc file in your home directory. This file will store the GoGrid's API credentials. It's a YAML file, so the structure will look like this:
+
+<pre>
+<code>
+% cat ~/.ghrc
+---
+- account: default
+  apikey: YOUR_APIKEY
+  secret: YOUR_SECRET
+</code>
+</pre>
+
+After putting correct credentials into config file it's good to synchronize the time with internet, cause GoGrid uses timestamps in API
+
+<pre>
+<code>
+% cat ~/.ghrc
+---
+- account: kishanov
+  apikey: 12d957fd52ac93e7
+  secret: bebebe
+</code>
+</pre>
+
+Finally, you can run gh command to see the usage. Now you are ready to work with GoGrid using CLI!
+
+<pre>
+<code>
+% gh
+usage: gh ACTION ENTITY [ARGS]
+
+Note that not all ACTIONs applicable to every ENTITY.
+Available combinations are:
+	list servers        Shows all servers in all states
+	list images         Shows all available server images (both legacy and MyGSI)
+	list passwords      Shows root login credentials for all servers
+	list ips            Shows all all ips in all states of all types.
+</code>
+</pre>
+
 == Copyright
 
 Copyright (c) 2009 Kirill Ishanov. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/grate-handle.gemspec

@@ -5,23 +5,25 @@
 
 Gem::Specification.new do |s|
   s.name = %q{grate-handle}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kirill Ishanov"]
-  s.date = %q{2009-08-25}
+  s.date = %q{2009-08-26}
   s.default_executable = %q{gh}
   s.description = %q{ Grate Handle is a small gem which simplifies the with GoGrid's API from ruby code. Also ships with a CLI tool called 'gh' which allows to perform most of the actions from http://my.gogrid.com but using true Unix CLI way. }
   s.email = %q{kirill.ishanov@gmail.com}
   s.executables = ["gh"]
   s.extra_rdoc_files = [
     "LICENSE",
+     "README.md",
      "README.rdoc"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
+     "README.md",
      "README.rdoc",
      "Rakefile",
      "VERSION",

data/lib/cli_processor.rb

@@ -2,36 +2,84 @@ require 'gogrid_manager'
 
 module GrateHandle
   class CLIProcessor
+    #{{{1 Initialization and accessors
     attr_writer :manager
 
-    def initialize(args, out=STDOUT, manager=GoGridManager.new)
+    def initialize(args, manager=GoGridManager.new, out=STDOUT)
       @args = args
+      @extra_params = {}
       @out = out
       @manager = manager
     end
-
+    #}}}
+    #{{{1 Ugly Options processing
     def process
       case @args.shift(1).first
-      when 'list':
-        list
-      else
-        @out.puts "unknown action"
+      when 'list'      then list_action
+      when 'help', nil then print_usage
+      else             @out.puts "unknown action"
       end
     end
 
-    def list
+    def list_action
       case @args.shift(1).first
-      when 'servers':
-        @manager.list_servers.each do |server|
-          @out.puts(sprintf("%-10s\t%-20s\t%-20s\t%s", server.id, server.name, server.ip.ip, server.state.name))
-        end
-      when 'images':
-        @manager.list_images.each do |image|
-          @out.puts(sprintf("%-5s\t%s", image.id, image.friendlyName))
-        end
-      else
-        @out.puts "Unknown command"
+      when 'servers'    then print_servers
+      when 'images'     then print_images
+      when 'ips'        then print_ips
+      when 'passwords'  then print_passwords
+      when 'help', nil  then print_usage
+      else                   print_list_error
+      end
+    end
+    #}}}
+    #{{{1 Help Messages
+    def print_list_error
+      @out.puts "Unknown command. Please check gh help for the list of available commands"
+    end
+
+    def print_usage
+      # don't like multilines strings, sorry
+      usage = []
+      usage << 'usage: gh ACTION ENTITY [ARGS]'
+      usage << ''
+      usage << 'Note that not all ACTIONs applicable to every ENTITY.'
+      usage << 'Available combinations are:'
+
+      actions = []
+      actions << ['list servers',   'Shows all servers in all states']
+      actions << ['list images',    'Shows all available server images (both legacy and MyGSI)']
+      actions << ['list passwords', 'Shows root login credentials for all servers']
+      actions << ['list ips',       'Shows all all ips in all states of all types.']
+
+      actions.map! { |action| sprintf("\t%-20s%s", action[0], action[1]) }
+
+      (usage + actions).each { |line| @out.puts line }
+    end
+    #}}}
+    #{{{1 listings print
+    def print_images
+      @manager.list_images.each do |image|
+        @out.puts(sprintf("%-5s\t%s", image.id, image.name))
+      end
+    end
+
+    def print_servers
+      @manager.list_servers.each do |server|
+        @out.puts(sprintf("%-6s\t%-20s\t%-15s\t%s", server.id, server.name, server.ip.ip, server.state.name))
+      end
+    end
+
+    def print_ips
+      @manager.list_ips.each do |ip|
+        @out.puts(sprintf("%-15s\t%-7s\t%s", ip.ip, (ip.public ? "Public" : "Private"), ip.state.name))
+      end
+    end
+
+    def print_passwords
+      @manager.list_passwords.each do |passwd|
+        @out.puts(sprintf("%-20s\t%s@%-15s\t%s", passwd.server.name, passwd.username, passwd.server.ip.ip, passwd.password)) if passwd.has_key?('server') # hack against CloudStorage
       end
     end
+    #}}}
   end
 end

data/lib/gogrid_manager.rb

@@ -32,11 +32,27 @@ module GrateHandle
 
     public
 
-    %w(server ip image).each do |entity|
-      define_method("list_#{entity}s".to_sym) do
-        response = @client.send_api_request("grid/#{entity}/list")
-        JSON.parse(response).list
-      end
+    def list_servers
+      list_request_for 'grid/server/list'
+    end
+
+    def list_images
+      list_request_for 'grid/image/list'
+    end
+
+    def list_ips
+      list_request_for 'grid/ip/list'
+    end
+
+    def list_passwords
+      list_request_for 'support/password/list'
+    end
+
+    private
+
+    def list_request_for(url, extra_params={})
+      response = @client.send_api_request(url, extra_params)
+      JSON.parse(response).list
     end
 
     # }}}

data/spec/cli_processor_spec.rb

@@ -1,13 +1,61 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe CLIProcessor do
+  #{{{1 list servers
   describe "list servers" do
-    #before do
-      #@cli = CLIProcessor.new(%w(list servers), mock!, mock!.list_servers.subject { SERVERS } )
-    #end
+    before do
+      stub(STDOUT).puts
+      @servers = [{
+        'id' => '123',
+        'name' => 'myserver',
+        'ip' => { 'ip' => '1.1.1.1' },
+        'state' => { 'name' => 'started' }
+      }]
+    end
 
-    #it "should call list_servers on GoGridManager" do
-      #@cli.process
-    #end
+    it "should call list_servers on GoGridManager" do
+      manager = mock!.list_servers { @servers }.subject
+      command = %w(list servers)
+      cli = CLIProcessor.new(command, manager)
+      cli.process
+    end
   end
+  #}}}
+  #{{{1 list ips
+  describe "list ips" do
+    before do
+      stub(STDOUT).puts
+      @ips = [{
+        'ip' => '1.1.1.1',
+        'public' => true,
+        'state' => { 'name' => 'assigned' }
+      }]
+    end
+
+    it "should call list_ips on GoGridManager" do
+      manager = mock!.list_ips { @ips }.subject
+      command = %w(list ips)
+      cli = CLIProcessor.new(command, manager)
+      cli.process
+    end
+  end
+  #}}}
+  #{{{1 list images
+  describe "list ips" do
+    before do
+      stub(STDOUT).puts
+      @images = [{
+        'id' => '123',
+        'name' => 'my super image'
+      }]
+    end
+
+    it "should call list_images on GoGridManager" do
+      manager = mock!.list_images { @images }.subject
+      command = %w(list images)
+      cli = CLIProcessor.new(command, manager)
+      cli.process
+    end
+  end
+  #}}}
 end

data/spec/gogrid_manager_spec.rb

@@ -17,8 +17,8 @@ describe GoGridManager do
     it "should load config for 1st account from ~/.ghrc if no params given" do
       mock(File).read(File.expand_path("~/.ghrc")) { "config dump" }
       mock(YAML).load("config dump") { config_data }
-      mock(GoGridClient).new("key", "secret")
-      manager = GoGridManager.new(nil, nil)
+      mock(GoGridClient).new('key', 'secret')
+      manager = GoGridManager.new()
     end
 
     it "should load config for given account if this data presents in config" do
@@ -30,9 +30,9 @@ describe GoGridManager do
 
   def config_data
     [
-      {:account => "acc", :apikey => "key", :secret => "secret"},
-      {:account => "acc2", :apikey => "key2", :secret => "secret2"},
-      {:account => "acc3", :apikey => "key3", :secret => "secret3"}
+      {'account' => "acc",  'apikey' => "key",  'secret' => "secret"},
+      {'account' => "acc2", 'apikey' => "key2", 'secret' => "secret2"},
+      {'account' => "acc3", 'apikey' => "key3", 'secret' => "secret3"}
     ]
   end
 
@@ -41,11 +41,11 @@ describe GoGridManager do
   describe "when calling list_servers" do
     before do
       @manager = GoGridManager.new("key", "secret")
-      stub(@manager.client).send_api_request("grid/server/list") { SERVERS }
+      stub(@manager.client).send_api_request("grid/server/list", {}) { SERVERS }
     end
 
     it "should send grid/server/list request" do
-      mock(@manager.client).send_api_request("grid/server/list") { SERVERS }
+      mock(@manager.client).send_api_request("grid/server/list", {}) { SERVERS }
       @manager.list_servers
     end
 
@@ -56,7 +56,7 @@ describe GoGridManager do
       @manager.list_servers
     end
 
-    it "should return an array of servers of servers" do
+    it "should return an array of servers" do
       @manager.list_servers.should be_instance_of(Array)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grate-handle
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Kirill Ishanov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-25 00:00:00 +04:00
+date: 2009-08-26 00:00:00 +04:00
 default_executable: gh
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,11 +50,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
+- README.md
 - README.rdoc
 files: 
 - .document
 - .gitignore
 - LICENSE
+- README.md
 - README.rdoc
 - Rakefile
 - VERSION