kylichuku-grate-handle 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kirill Ishanov
+
+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,54 @@
+= 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>
+sudo ntpdate pool.ntp.org
+</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

@@ -0,0 +1,9 @@
+= 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.
+
+== Copyright
+
+Copyright (c) 2009 Kirill Ishanov. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "grate-handle"
+    gem.summary = %Q{A ruby library and a CLI client to GoGrid API }
+    gem.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. }
+    gem.email = "kirill.ishanov@gmail.com"
+    gem.homepage = "http://github.com/kylichuku/grate-handle"
+    gem.authors = ["Kirill Ishanov"]
+
+    %w(rspec jeweler json).each do |dependency|
+      gem.add_development_dependency dependency
+    end
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "grate-handle #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/gh

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'grate-handle'
+
+GrateHandle::CLIProcessor.new(ARGV).process
+

data/grate-handle.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{grate-handle}
+  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-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",
+     "bin/gh",
+     "grate-handle.gemspec",
+     "lib/cli_processor.rb",
+     "lib/gogrid_client.rb",
+     "lib/gogrid_manager.rb",
+     "lib/grate-handle.rb",
+     "lib/monkey_patches.rb",
+     "spec/cli_processor_spec.rb",
+     "spec/fixtures/all.rb",
+     "spec/fixtures/grid_server_list.json",
+     "spec/fixtures/grid_server_list.xml",
+     "spec/gogrid_manager_spec.rb",
+     "spec/monkey_patches_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kylichuku/grate-handle}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{A ruby library and a CLI client to GoGrid API}
+  s.test_files = [
+    "spec/gogrid_manager_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/monkey_patches_spec.rb",
+     "spec/fixtures/all.rb",
+     "spec/cli_processor_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end

data/lib/cli_processor.rb

@@ -0,0 +1,85 @@
+require 'gogrid_manager'
+
+module GrateHandle
+  class CLIProcessor
+    #{{{1 Initialization and accessors
+    attr_writer :manager
+
+    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'      then list_action
+      when 'help', nil then print_usage
+      else             @out.puts "unknown action"
+      end
+    end
+
+    def list_action
+      case @args.shift(1).first
+      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_client.rb

@@ -0,0 +1,44 @@
+require 'digest/md5'
+require 'cgi'
+require 'open-uri'
+
+module GrateHandle
+  class GoGridClient
+
+    def initialize(apikey  = 'YOUR API KEY',
+                   secret  = 'YOUR SHARED SECRET',
+                   format  = 'json',
+                   version = '1.2')
+      @server = 'https://api.gogrid.com/api'
+      @secret = secret
+      @default_params = { 'format' => format,
+                          'v' => version,
+                          'api_key' => apikey }
+    end
+
+    def credentials(apikey, secret)
+      @default_params['api_key'] = apikey
+      @secret = secret
+    end
+
+    def send_api_request(method, params={})
+      open(request_url(method, params)).read
+    end
+
+    private
+
+    def request_url(method, params)
+      call_params = @default_params.merge(params).merge(signature)
+      url = "#{@server}/#{method}?#{encoded(call_params)}"
+    end
+
+    def signature
+      { 'sig' => Digest::MD5.hexdigest(@default_params['api_key'] + @secret + "%.0f"%Time.new.to_f) }
+    end
+
+    def encoded(params)
+      params.map {|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join("&")
+    end
+
+  end
+end

data/lib/gogrid_manager.rb

@@ -0,0 +1,61 @@
+module GrateHandle
+  class GoGridManager
+    # {{{1 Attributes
+
+    attr_accessor :client
+
+    #}}}
+    # {{{1 Initialization
+
+    def initialize(arg1=nil, arg2=nil)
+      if (arg1 && arg2)
+        from_params(arg1, arg2)
+      else
+        from_config(arg1)
+      end
+    end
+
+    private
+
+    def from_config(account=nil)
+      configs = YAML::load(File.read(File.expand_path('~/.ghrc')))
+      config = (account ? configs.select { |conf| conf['account'] == account }.first : configs.first)
+      from_params(config['apikey'], config['secret'])
+    end
+
+    def from_params(apikey, secret)
+      @client = GoGridClient.new(apikey, secret)
+    end
+
+    # }}}
+    # {{{1 GoGrid Request Wrappers
+
+    public
+
+    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
+
+    # }}}
+  end
+end
+

data/lib/grate-handle.rb

@@ -0,0 +1,11 @@
+require 'gogrid_client'
+require 'monkey_patches'
+require 'gogrid_manager'
+require 'cli_processor'
+
+# gems
+require 'rubygems'
+require 'yaml'
+require 'json'
+
+include GrateHandle

data/lib/monkey_patches.rb

@@ -0,0 +1,17 @@
+class Hash
+  undef_method :id
+
+  def method_missing(methodname, *args)
+    humps = methodname.to_s.split('_')
+    key = humps.shift(1).first
+    key = key + humps.map { |hump| hump.capitalize }.join if humps.length
+
+    if self.include?(key)
+      self[key]
+    elsif key == 'id'
+      "N/A"
+    else
+      super
+    end
+  end
+end

data/spec/cli_processor_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CLIProcessor do
+  #{{{1 list servers
+  describe "list servers" do
+    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
+      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/fixtures/all.rb

@@ -0,0 +1,2 @@
+SERVERS = File.read('spec/fixtures/grid_server_list.json')
+

data/spec/fixtures/grid_server_list.json

@@ -0,0 +1,60 @@
+{
+    "list": [{
+        "description": "Test Sandbox Server",
+        "image": {
+            "description": "Windows 2008 (32-bit) w/ IIS 7.0 + PHP 5.2 + MySQL 5.0",
+            "id": 57,
+            "name": "w2k8_32_iis_php_mysql",
+            "object": "option"
+        },
+        "ip": {
+            "id": 499,
+            "ip": "111.111.11.111",
+            "object": "ip",
+            "public": true,
+            "state": {
+                "description": "IP is reserved or in use",
+                "id": 2,
+                "name": "Assigned",
+                "object": "option"
+            },
+            "subnet": "111.111.11.110/255.255.255.240"
+        },
+        "isSandbox": true,
+        "name": "Sandbox Server",
+        "object": "server",
+        "os": {
+            "description": "Windows 2008 Server (32-bit)",
+            "id": 11,
+            "name": "Windows 2008 Server (32-bit)",
+            "object": "option"
+        },
+        "ram": {
+            "description": "SandBox Server with 2GB RAM",
+            "id": 7,
+            "name": "2GB",
+            "object": "option"
+        },
+        "state": {
+            "description": null,
+            "id": 3,
+            "name": "Off",
+            "object": "option"
+        },
+        "type": {
+            "description": "This server has a public connection to the Internet.",
+            "id": 1,
+            "name": "Web Server",
+            "object": "option"
+        }
+    }],
+    "method": "/grid/server/list",
+    "status": "success",
+    "summary": {
+        "numpages": 0,
+        "returned": 1,
+        "start": 0,
+        "total": 1
+    }
+}
+